github-auth 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a80039ae01d2be44d806515ea21ee9270f9df4e6
-  data.tar.gz: bff60b5a1c3c03a0d52d43b2e95d6ab3526262f6
+  metadata.gz: 352463830e9bd640ff3d636b5ee5053b0be27518
+  data.tar.gz: 9f2ccad8abf686958c2c0a49b99bf838b271ffc2
 SHA512:
-  metadata.gz: 71a7d658f2ce80eef39916981c7c9e6011e73d4cf4b2d036dffd500ba8c05ffbb0f74d3748c999d95864ef5954205633319562bc063fcb23783ac38525a2f4e9
-  data.tar.gz: ee721cd67304276cd695cb3939b362fb1ae887dd96f4fa938ace3ca3f684a41a4e32b1f08b8ad286ed3848d445cc7e32161323626cd84ba43d6beab66cc00e9b
+  metadata.gz: 059b81934b81695ba445ba47427c6058c6a1c9e4d185ef7de8674df0c104820544e3d9d100899a7d738bd867cebbaaced781faff952e8c0c15aed3ed2d1b97fa
+  data.tar.gz: ac44f88144f64084e91f1ef74c69bf1ba8e731bd821063583f5886516910740576f0242f628d505db4ab6b3bd6a02bdba94401acdd1491414094a9b91ed078c9

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog
+
+##v1.1.0
+*2013-05-29*
+
+[\[13 commits\]](https://github.com/chrishunt/github-auth/compare/v1.0.0...v1.1.0)
+
+- Add link to user's GitHub profile as comment on SSH keys
+- Add VPN/tunneling solutions to README
+- Add CHANGELOG
+
+##v1.0.0
+*2013-05-18*
+
+[\[2 commits\]](https://github.com/chrishunt/github-auth/compare/v0.6.1...v1.0.0)
+
+Nobody is complaining about bugs, so we're ready to call it **v1.0.0**
+
+##v0.6.1
+*2013-05-10*
+
+[\[7 commits\]](https://github.com/chrishunt/github-auth/compare/v0.6.0...v0.6.1)
+
+- Add License information to README
+
+##v0.6.0
+*2013-05-09*
+
+[\[6 commits\]](https://github.com/chrishunt/github-auth/compare/v0.5.0...v0.6.0)
+
+- Only insert blank line if inserting a key
+- Don't leave blank lines when writing keys
+
+##v0.5.0
+*2013-05-08*
+
+[\[13 commits\]](https://github.com/chrishunt/github-auth/compare/v0.4.1...v0.5.0)
+
+- Remove line break as well when deleting keys
+- Enforce Ruby 1.9 hash syntax with Cane
+- Move contributing instructions to separate doc
+
+##v0.4.1
+*2013-04-28*
+
+[\[15 commits\]](https://github.com/chrishunt/github-auth/compare/v0.4.0...v0.4.1)
+
+- Check code quality by default when running specs
+- Add cane as development dependency
+
+##v0.4.0
+*2013-04-25*
+
+[\[3 commits\]](https://github.com/chrishunt/github-auth/compare/v0.3.0...v0.4.0)
+
+- Add `--version` option to command line client
+
+##v0.3.0
+*2013-04-25*
+
+[\[5 commits\]](https://github.com/chrishunt/github-auth/compare/v0.2.0...v0.3.0)
+
+- Send github-auth user agent to GitHub when making requests
+
+##v0.2.0
+*2013-04-22*
+
+[\[8 commits\]](https://github.com/chrishunt/github-auth/compare/v0.1.1...v0.2.0)
+
+- Correctly remove keys with comments in keys file
+
+##v0.1.1
+*2013-04-15*
+
+[\[6 commits\]](https://github.com/chrishunt/github-auth/compare/v0.1.0...v0.1.1)
+
+- Adjustments to README
+
+##v0.1.0
+*2013-04-15*
+
+Initial release

data/README.md

@@ -47,6 +47,24 @@ $ gh-auth remove zachmargolis
 Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 ```
 
+## Sections
+
+  1. [Usage](#usage)
+     - [Command Line](#command-line)
+     - [In Your Project](#in-your-project)
+  1. [Installation](#installation)
+     - [SSH Public Key Authentication](#ssh-public-key-authentication-mac-os-x)
+     - [Verification](#verification)
+  1. [Troubleshooting](#troubleshooting)
+     - [How do people actually connect to my machine?](#how-do-people-actually-connect-to-my-machine)
+     - [What username do I use?](#what-username-do-i-use)
+     - [How do I get my external IP?](#how-do-i-get-my-external-ip)
+     - [It's still not working!](#its-still-not-working-)
+     - [I can't enable port forwarding](#i-cant-enable-port-forwarding-my-boss-wont-let-me-can-i-still-pair)
+  1. [Contributing](#contributing)
+  1. [Changelog](#changelog)
+  1. [License](#license)
+
 ## Usage
 
 ### Command Line
@@ -57,7 +75,7 @@ Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 usage: gh-auth [--version] [add|remove] <username>
 ```
 
-### In You Project
+### In Your Project
 
 Want to add/remove keys in your project, but not on the command line? That's ok
 too.
@@ -199,12 +217,19 @@ ability to forward ports. Maybe this machine is at home, a friend's house, or
 at a company your worked for in the past that forgot to turn it off.
 
 If this isn't possible, then you can use a VPS provider like
-[Linode](http://www.linode.com) to setup a pairing machine in the cloud.
+[Linode](http://www.linode.com) to setup a pairing machine in the cloud or a
+tunneling solution like [PageKite](https://pagekite.net) or
+[Hamachi](https://secure.logmein.com/products/hamachi) to make your machine
+accessible without forwarding ports.
 
 ## Contributing
 Please see the [Contributing
 Document](https://github.com/chrishunt/github-auth/blob/master/CONTRIBUTING.md)
 
+## Changelog
+Please see the [Changelog
+Document](https://github.com/chrishunt/github-auth/blob/master/CHANGELOG.md)
+
 ## License
 Copyright (C) 2013 Chris Hunt, [MIT
 License](https://github.com/chrishunt/github-auth/blob/master/LICENSE.txt)

data/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'

data/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

data/lib/github/auth/keys_client.rb

@@ -26,7 +26,9 @@ module Github::Auth
     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

data/lib/github/auth/keys_file.rb

@@ -14,7 +14,7 @@ module Github::Auth
 
     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 @@ module Github::Auth
 
     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

data/lib/github/auth/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Auth
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/spec/acceptance/github/auth/cli_spec.rb

@@ -22,8 +22,8 @@ describe Github::Auth::CLI do
     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

data/spec/acceptance/github/auth/keys_file_spec.rb

@@ -6,7 +6,11 @@ describe Github::Auth::KeysFile do
   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 @@ describe Github::Auth::KeysFile do
 
     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

data/spec/support/mock_github_server.rb

@@ -2,9 +2,14 @@ require 'httparty'
 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 @@ module Github::Auth
       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

data/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 @@ describe Github::Auth::KeysClient do
 
     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

data/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 Github::Auth::KeysFile do
 
   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 @@ describe Github::Auth::KeysFile do
     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 @@ describe Github::Auth::KeysFile do
       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 @@ describe Github::Auth::KeysFile do
 
       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 @@ describe Github::Auth::KeysFile do
   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 @@ describe Github::Auth::KeysFile do
       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 @@ describe Github::Auth::KeysFile do
       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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-auth
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -156,6 +157,7 @@ files:
 - img/mac-os-ssh-sharing.jpg
 - lib/github/auth.rb
 - lib/github/auth/cli.rb
+- lib/github/auth/key.rb
 - lib/github/auth/keys_client.rb
 - lib/github/auth/keys_file.rb
 - lib/github/auth/version.rb