Merge branch 'add-github-username-to-key'

* add-github-username-to-key:
  Add github profile link as comment on ssh key

Author: chrishunt

lib/github/auth.rb

@@ -1,4 +1,5 @@
 require 'github/auth/version'
+require 'github/auth/key'
 require 'github/auth/keys_client'
 require 'github/auth/keys_file'
 require 'github/auth/cli'

lib/github/auth/key.rb

@@ -0,0 +1,16 @@
+module Github::Auth
+  # Represents a username/key pair from GitHub
+  Key = Struct.new(:username, :key) do
+    def to_a
+      [self]
+    end
+
+    def to_s
+      "#{key} #{url}"
+    end
+
+    def url
+      "https://github.com/#{username}"
+    end
+  end
+end

lib/github/auth/keys_client.rb

@@ -26,7 +26,9 @@ def initialize(options = {})
     end
 
     def keys
-      @keys ||= Array(github_response).map { |entry| entry.fetch 'key' }
+      @keys ||= Array(github_response).map do |entry|
+        Github::Auth::Key.new username, entry.fetch('key')
+      end
     end
 
     private

lib/github/auth/keys_file.rb

@@ -14,7 +14,7 @@ def initialize(options = {})
 
     def write!(keys)
       Array(keys).each do |key|
-        unless keys_file_content.include? key
+        unless keys_file_content.include? key.key
           append_keys_file do |keys_file|
             keys_file.write "\n" unless keys_file_content.empty?
             keys_file.write key
@@ -53,7 +53,10 @@ def with_keys_file(mode, block)
 
     def keys_file_content_without(keys)
       keys_file_content.tap do |content|
-        Array(keys).each {|k| content.gsub! /#{Regexp.escape k}( .*)?$\n?/, '' }
+        Array(keys).each do |key|
+          content.gsub! /#{Regexp.escape key.key}( .*)?$\n?/, ''
+        end
+
         content.strip!
       end
     end

spec/acceptance/github/auth/cli_spec.rb

@@ -22,8 +22,8 @@ def cli(argv)
     it 'adds and removes keys from the keys file' do
       cli(%w(add chrishunt)).execute
 
-      keys_file.read.tap do |content|
-        keys.each { |key| expect(content).to include key }
+      keys_file.read.tap do |keys_file_content|
+        keys.each { |key| expect(keys_file_content).to include key.to_s }
       end
 
       cli(%w(remove chrishunt)).execute

spec/acceptance/github/auth/keys_file_spec.rb

@@ -6,7 +6,11 @@
   it 'writes and deletes keys from the keys file' do
     tempfile  = Tempfile.new 'authorized_keys'
     keys_file = described_class.new path: tempfile.path
-    keys      = %w(abc123 def456)
+
+    keys = [
+      Github::Auth::Key.new('chris', 'abc123'),
+      Github::Auth::Key.new('doug', 'def456')
+    ]
 
     keys_file.write! keys
     expect(tempfile.read).to include keys.join("\n")
@@ -15,8 +19,8 @@
 
     keys_file.delete! keys.first
     tempfile.read.tap do |tempfile_content|
-      expect(tempfile_content).to_not include keys.first
-      expect(tempfile_content).to include keys.last
+      expect(tempfile_content).to_not include keys.first.to_s
+      expect(tempfile_content).to include keys.last.to_s
     end
 
     tempfile.rewind

spec/support/mock_github_server.rb

@@ -2,9 +2,14 @@
 require 'sinatra/base'
 require 'json'
 
+require 'github/auth/key'
+
 module Github::Auth
   class MockGithubServer < Sinatra::Base
-    KEYS = %w(abc234 def456)
+    KEYS = [
+      Github::Auth::Key.new('chrishunt', 'abc123'),
+      Github::Auth::Key.new('chrishunt', 'def456')
+    ]
 
     set :port, 8001
 
@@ -16,8 +21,8 @@ class MockGithubServer < Sinatra::Base
       content_type :json
 
       [
-        { 'id' => 123, 'key' => KEYS[0] },
-        { 'id' => 456, 'key' => KEYS[1] }
+        { 'id' => 123, 'key' => KEYS[0].key },
+        { 'id' => 456, 'key' => KEYS[1].key }
       ].to_json
     end
   end

spec/unit/github/auth/keys_client_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'github/auth/key'
 require 'github/auth/keys_client'
 
 describe Github::Auth::KeysClient do
@@ -50,12 +51,15 @@
 
     context 'when the github user has keys' do
       let(:parsed_response) {[
-        { 'id' => 123, 'key' => 'BLAHBLAH' },
-        { 'id' => 456, 'key' => 'FLARBBLU' }
+        { 'id' => 123, 'key' => 'abc123' },
+        { 'id' => 456, 'key' => 'def456' }
       ]}
 
       it 'returns the keys' do
-        expected_keys = parsed_response.map { |entry| entry.fetch 'key' }
+        expected_keys = parsed_response.map do |entry|
+          Github::Auth::Key.new username, entry.fetch('key')
+        end
+
         expect(subject.keys).to eq expected_keys
       end
     end

spec/unit/github/auth/keys_file_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'tempfile'
+require 'github/auth/key'
 require 'github/auth/keys_file'
 
 describe Github::Auth::KeysFile do
@@ -38,11 +39,13 @@
 
   describe '#write!' do
     shared_examples_for 'a successful key addition' do
-      it 'writes the key to the keys file' do
+      it 'writes the key and github url to the keys file' do
         subject.write! keys
 
         keys_file.read.tap do |keys_file_content|
-          keys.each { |key| expect(keys_file_content).to include key }
+          keys.each do |key|
+            expect(keys_file_content).to include "#{key.key} #{key.url}"
+          end
         end
       end
 
@@ -56,20 +59,24 @@
     end
 
     context 'with many keys' do
-      let(:keys) { %w(abc123 def456 ghi789) }
+      let(:keys) {[
+        Github::Auth::Key.new('chris', 'abc123'),
+        Github::Auth::Key.new('chris', 'def456'),
+        Github::Auth::Key.new('doug', 'ghi789')
+      ]}
 
       it_should_behave_like 'a successful key addition'
     end
 
     context 'with a single key' do
-      let(:keys) { %w(abc123) }
+      let(:keys) {[ Github::Auth::Key.new('chris', 'abc123') ]}
 
       it_should_behave_like 'a successful key addition'
     end
 
     context 'with existing keys in the keys file' do
       let(:existing_keys) { %w(abc123 def456 ghi789) }
-      let(:keys) { %w(jkl012) }
+      let(:keys) {[ Github::Auth::Key.new('chris', 'jkl012') ]}
 
       before do
         keys_file.write existing_keys.join("\n")
@@ -89,7 +96,7 @@
       end
 
       it 'does not write duplicate keys into the keys file' do
-        subject.write! existing_keys.first
+        subject.write! Github::Auth::Key.new('chris', existing_keys.first)
 
         expect(keys_file.readlines.count).to eq existing_keys.count
       end
@@ -100,7 +107,7 @@
 
       it 'raises PermissionDeniedError' do
         expect {
-          subject.write! %w(abc123 def456)
+          subject.write! Github::Auth::Key.new('chris', 'abc123')
         }.to raise_error Github::Auth::KeysFile::PermissionDeniedError
       end
     end
@@ -117,7 +124,11 @@
   end
 
   describe '#delete!' do
-    let(:keys) { %w(abc123 def456 ghi789) }
+    let(:keys) {[
+      Github::Auth::Key.new('chris', 'abc123'),
+      Github::Auth::Key.new('chris', 'def456'),
+      Github::Auth::Key.new('doug', 'ghi789')
+    ]}
 
     before do
       keys_file.write keys.join("\n")
@@ -128,15 +139,15 @@
       it 'removes the key from the keys file' do
         subject.delete! key
 
-        expect(keys_file.read).to_not include key
+        expect(keys_file.read).to_not include key.to_s
       end
 
       it 'does not remove the other keys from the keys file' do
         subject.delete! key
 
         keys_file.read.tap do |keys_file_content|
-          keys.reject { |other_key| other_key =~ /#{key}/ }.each do |key|
-            expect(keys_file_content).to include key
+          keys.reject { |other_key| other_key == key }.each do |key|
+            expect(keys_file_content).to include key.to_s
           end
         end
       end
@@ -168,22 +179,8 @@
       it_should_behave_like 'a successful key removal'
     end
 
-    context 'when the key has a comment' do
-      let(:keys)    {[ 'abc123', "#{key} #{comment}", 'ghi789' ]}
-      let(:key)     { 'def456' }
-      let(:comment) { 'this is a comment' }
-
-      it_should_behave_like 'a successful key removal'
-
-      it 'removes the comment from the keys file' do
-        subject.delete! key
-
-        expect(keys_file.read).to_not include comment
-      end
-    end
-
     context 'when the keys file does not have the key' do
-      let(:key) { 'not-in-the-keys-file' }
+      let(:key) { Github::Auth::Key.new('sallie', 'not-in-the-keys-file') }
 
       it 'does not modify the keys file' do
         keys_file.read.tap do |original_keys_file_content|