github-auth 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae6c8829c44543ade8a4ee209b00af812e1282d4
-  data.tar.gz: b01479f59d0ee0626f6b8d53b0d5271b0c8d5115
+  metadata.gz: 8ed96df336ef90a6312aace8d6c3e2aa33be4bbe
+  data.tar.gz: ed9ff502f8ff004a45d1026fb4061035932031a0
 SHA512:
-  metadata.gz: 7292a8368140bce7bac19bc704d0cccc0ddada1dbe3eeeb8603ac93907b1d294fd7facfac30069ff86776e2da31597bd025b1b15d10934ef701004633fa4bdcd
-  data.tar.gz: f79c42a9d9c078e168111a3ade0ada1362362c167dbaa793c5702ce297a4bcb72d230af3a1f1fbeceb483a318603ba63aa5991b5753a95cf17b11bf81f7c8f48
+  metadata.gz: 928de18477f4ab0ed074741d2045594733175fa803bd0240429555012f1ea8ef03884fae4545c6f4208a80960663c618999cb3168b29d5d86034821d4f9a0a30
+  data.tar.gz: cdcf7345687a26546cff7980bc625721b41db2f7b81af0ced07f5e133007eaa6d372990f4e60e234fcb8715cc45c58196ca743670755fcbedb88d21247f103cf

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+Want to contribute? Awesome! Thank you so much.
+
+## How?
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo)
+2. Create a feature branch (`git checkout -b my-new-feature`)
+3. Commit changes, **with tests** (`git commit -am 'Add some feature'`)
+4. Run the tests (`bundle exec rake`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new [Pull
+   Request](https://help.github.com/articles/using-pull-requests)

data/README.md

@@ -46,10 +46,33 @@ Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 
 ## Usage
 
+### Command Line
+
+`gh-auth` can be used from the command line after the gem has been installed.
+
 ```bash
 usage: gh-auth [--version] [add|remove] <username>
 ```
 
+### In You Project
+
+Want to add/remove keys in your project, but not on the command line? That's ok
+too.
+
+```ruby
+require 'github/auth'
+
+# Add keys for GitHub user 'chrishunt'
+Github::Auth::CLI.new(%w(
+  add chrishunt
+)).execute
+
+# Remove keys for GitHub user 'chrishunt'
+Github::Auth::CLI.new(%w(
+  remove chrishunt
+)).execute
+```
+
 ## Installation
 
 Install the `github-auth` gem:
@@ -176,10 +199,5 @@ 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.
 
 ## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes, with tests (`git commit -am 'Add some feature'`)
-4. Run the tests (`bundle exec rake spec`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+Please see the [Contributing
+Document](https://github.com/chrishunt/github-auth/blob/master/CONTRIBUTING.md)

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'cane/rake_task'
+require 'cane/hashcheck'
 
 desc 'Run all tests'
 RSpec::Core::RakeTask.new(:spec) do |task|
@@ -10,6 +11,7 @@ end
 desc 'Check code quality'
 Cane::RakeTask.new(:quality) do |task|
   task.abc_max = 9
+  task.use Cane::HashCheck
 end
 
 task default: :spec

data/github-auth.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'cane-hashcheck'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'thin'

data/lib/github/auth/keys_file.rb

@@ -50,7 +50,7 @@ module Github::Auth
 
     def keys_file_content_without(keys)
       keys_file_content.tap do |content|
-        Array(keys).each { |k| content.gsub! /#{Regexp.escape(k)}( .*)?/, '' }
+        Array(keys).each {|k| content.gsub! /#{Regexp.escape k}( .*)?$\n?/, '' }
         content.strip!
       end
     end

data/lib/github/auth/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Auth
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

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

@@ -5,7 +5,7 @@ require 'github/auth/keys_file'
 describe Github::Auth::KeysFile do
   subject { described_class.new path: path }
 
-  let(:keys) { %w(abc123 def456) }
+  let(:keys) { %w(abc123 def456 ghi789) }
   let(:keys_file) { Tempfile.new 'authorized_keys' }
   let(:path) { keys_file.path }
 
@@ -40,8 +40,10 @@ describe Github::Auth::KeysFile do
   describe '#write!' do
     it 'writes each key to the keys file' do
       subject.write! keys
-      file_content = keys_file.read
-      keys.each { |key| expect(file_content).to include key }
+
+      keys_file.read.tap do |keys_file_content|
+        keys.each { |key| expect(keys_file_content).to include key }
+      end
     end
 
     context 'with a single key' do
@@ -100,60 +102,75 @@ describe Github::Auth::KeysFile do
       keys_file.rewind
     end
 
-    context 'when the keys file has the key' do
-      let(:key) { keys[0] }
-      let(:other_key) { keys[1] }
-
+    shared_examples_for 'a successful key removal' do
       it 'removes the key from the keys file' do
         subject.delete! key
+
         expect(keys_file.read).to_not include key
       end
 
-      it 'does not remove the other key from the keys file' do
+      it 'does not remove the other keys from the keys file' do
         subject.delete! key
-        expect(keys_file.read).to include other_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
+          end
+        end
       end
 
-      it 'does not leave blank lines' do
-        subject.delete! [key, other_key]
-        blank_lines = keys_file.readlines.select { |line| line =~ /^$\n/ }
+      it 'does not leave a blank line' do
+        subject.delete! key
 
-        expect(blank_lines).to be_empty
+        expect(
+          keys_file.readlines.select { |line| line =~ /^$\n/ }
+        ).to be_empty
       end
     end
 
-    context 'when the keys file does not have the key' do
-      let(:key) { 'not-in-the-keys-file' }
+    context 'when the key is at the beginning of the keys file' do
+      let(:key) { keys.first }
 
-      it 'does not modify the keys file' do
-        original_keys_file = keys_file.read
-        keys_file.rewind
+      it_should_behave_like 'a successful key removal'
+    end
 
-        subject.delete! key
+    context 'when the key is in the middle of the keys file' do
+      let(:key) { keys[1] }
 
-        expect(keys_file.read).to eq original_keys_file
-      end
+      it_should_behave_like 'a successful key removal'
+    end
+
+    context 'when the key is at the end of the keys file' do
+      let(:key) { keys.last }
+
+      it_should_behave_like 'a successful key removal'
     end
 
     context 'when the key has a comment' do
-      let(:key)     { 'WW6dx9mW/paKl9pznYypl+X617WHP' }
+      let(:keys)    {[ 'abc123', "#{key} #{comment}", 'ghi789' ]}
+      let(:key)     { 'def456' }
       let(:comment) { 'this is a comment' }
-      let(:keys)    { ["#{key} #{comment}", 'def456'] }
-      let(:other_key) { keys[1] }
 
-      it 'removes the key from the keys file' do
-        subject.delete! key
-        expect(keys_file.read).to_not include key
-      end
+      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
 
-      it 'does not remove the other key from the keys file' do
-        subject.delete! key
-        expect(keys_file.read).to include other_key
+    context 'when the keys file does not have the key' do
+      let(:key) { 'not-in-the-keys-file' }
+
+      it 'does not modify the keys file' do
+        keys_file.read.tap do |original_keys_file_content|
+          keys_file.rewind
+
+          subject.delete! key
+
+          expect(keys_file.read).to eq original_keys_file_content
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-auth
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane-hashcheck
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md