github-auth 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac13ba0c9755deb71801dffec21aba397f70d81f
-  data.tar.gz: b2fdba9a799045734f7673ee78bd91f00b8e1682
+  metadata.gz: bc5ca2cbe7d8acf279d3b54a335e34432cbce149
+  data.tar.gz: 24ecd142974160d3205ff3da30c823a179fe69d3
 SHA512:
-  metadata.gz: 781c7170d3eee79cb1ceb64fb8a216c09ba23c37c679c26fd0bdb1052c6fa2a3bfb86ff70401a710e123bfb24b3f6c977410a73089300351a4576189e3e6fa8e
-  data.tar.gz: 2cdc629713e926a4ffb4681188c0401df9de7749d582284021451f100f9a2adcbb7fccb537f2da0bbf4a83facdadb0678acd30b0ab90e67af308c835eb669d37
+  metadata.gz: fa37238d36f4d2dc35ee8b51e9b09f34edea0012f00fa5dfe3bf0ac1d934d302d6ace5377f486b9c5ab692c48bf5432463fc6a9b661c71e0315cd60dfc4e26bf
+  data.tar.gz: a650e4290cfd5a0d53cc86896af98909dce3f4bdb5c1019f3331fadbce4e98b1d525ec34045863318f5cc33bff3f9e2fe514167f5c172f7a2e34efc62f13f703

data/.gitignore

@@ -4,7 +4,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+##v2.0.0
+*2013-10-22*
+
+[\[22 commits\]](https://github.com/chrishunt/github-auth/compare/v1.2.0...v2.0.0)
+
+*note:* Option syntax has changed in this release as a result of switching to
+`OptionParser`. See the [`README`](https://github.com/chrishunt/github-auth/blob/master/README.md)
+for usage instructions.
+
+- [Add `--list` command](https://github.com/chrishunt/github-auth/pull/14)
+- [Use `OptionParser` for parsing CLI options](https://github.com/chrishunt/github-auth/pull/16)
+
 ##v1.2.0
 *2013-08-20*
 

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    github-auth (2.0.0)
+      httparty (~> 0.11.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cane (2.6.0)
+      parallel
+    cane-hashcheck (1.2.0)
+      cane
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    daemons (1.1.9)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    mime-types (1.24)
+    multi_json (1.7.9)
+    multi_xml (0.5.5)
+    parallel (0.9.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  cane (~> 2.6.0)
+  cane-hashcheck (~> 1.2.0)
+  coveralls (~> 0.6.7)
+  github-auth!
+  rake (~> 10.1.0)
+  rspec (~> 2.14)
+  sinatra (~> 1.4.3)
+  thin (~> 1.5.1)

data/README.md

@@ -23,28 +23,37 @@ After you've [installed](#installation) `gh-auth`, you can give me ssh access
 with:
 
 ```bash
-$ gh-auth add chrishunt
+$ gh-auth --add chrishunt
 Adding 2 key(s) to '/Users/chris/.ssh/authorized_keys'
 ```
 
 That was easy! When we're done working, you can revoke my access with:
 
 ```bash
-$ gh-auth remove chrishunt
+$ gh-auth --remove chrishunt
 Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 ```
 
 You can add and remove any number of users at the same time.
 
 ```bash
-$ gh-auth add chrishunt zachmargolis
+$ gh-auth --add chrishunt,zachmargolis
 Adding 4 key(s) to '/Users/chris/.ssh/authorized_keys'
 
-$ gh-auth remove chrishunt
+$ gh-auth --list
+Added users: chrishunt, zachmargolis
+
+$ gh-auth --remove chrishunt
 Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 
-$ gh-auth remove zachmargolis
+$ gh-auth --list
+Added users: zachmargolis
+
+$ gh-auth --remove zachmargolis
 Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
+
+$ gh-auth --list
+Added users:
 ```
 
 ## Sections
@@ -72,7 +81,13 @@ Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 `gh-auth` can be used from the command line after the gem has been installed.
 
 ```bash
-usage: gh-auth [--version] [add|remove] <username>
+usage: gh-auth [--version] [--list] [--add|--remove] <username>
+
+options:
+        --add doug,sally             Add GitHub users
+        --remove doug,sally          Remove GitHub users
+        --list                       List all GitHub users added
+        --version                    Show version
 ```
 
 ### In Your Project
@@ -84,14 +99,10 @@ too.
 require 'github/auth'
 
 # Add keys for GitHub user 'chrishunt'
-Github::Auth::CLI.new(%w(
-  add chrishunt
-)).execute
+Github::Auth::CLI.new.execute %w(--add chrishunt)
 
 # Remove keys for GitHub user 'chrishunt'
-Github::Auth::CLI.new(%w(
-  remove chrishunt
-)).execute
+Github::Auth::CLI.new.execute %w(--remove chrishunt)
 ```
 
 ## Installation
@@ -102,7 +113,13 @@ Install the `github-auth` gem:
 $ gem install github-auth
 
 $ gh-auth
-usage: gh-auth [--version] [add|remove] <username>
+usage: gh-auth [--version] [--list] [--add|--remove] <username>
+
+options:
+        --add doug,sally             Add GitHub users
+        --remove doug,sally          Remove GitHub users
+        --list                       List all GitHub users added
+        --version                    Show version
 ```
 
 ### SSH Public Key Authentication (Mac OS X)
@@ -130,7 +147,7 @@ First, authorize yourself for ssh. (Make sure to replace 'chrishunt' with
 *your* GitHub username)
 
 ```bash
-$ gh-auth add chrishunt
+$ gh-auth --add chrishunt
 Adding 2 key(s) to '/Users/chris/.ssh/authorized_keys'
 ```
 
@@ -146,7 +163,7 @@ $ ssh -o PreferredAuthentications=publickey localhost
 Next, remove your public keys from the keys file:
 
 ```bash
-$ gh-auth remove chrishunt
+$ gh-auth --remove chrishunt
 Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 ```
 

data/Rakefile

@@ -12,6 +12,7 @@ desc 'Check code quality'
 Cane::RakeTask.new(:quality) do |task|
   task.abc_max = 9
   task.use Cane::HashCheck
+  task.abc_exclude = %w(Auth::Options#initialize)
 end
 
 task default: :spec

data/bin/gh-auth

@@ -2,4 +2,4 @@
 
 require 'github/auth'
 
-Github::Auth::CLI.new(ARGV).execute
+Github::Auth::CLI.new.execute(ARGV)

data/lib/github/auth.rb

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

data/lib/github/auth/cli.rb

@@ -1,23 +1,11 @@
 module Github::Auth
   # Command Line Interface for parsing and executing commands
   class CLI
-    attr_reader :command, :usernames
+    attr_reader :options
 
-    COMMANDS = %w(add remove)
-
-    def initialize(argv)
-      @command   = argv.shift
-      @usernames = argv
-    end
-
-    def execute
-      if COMMANDS.include?(command) && !usernames.empty?
-        send command
-      elsif command == '--version'
-        print_version
-      else
-        print_usage
-      end
+    def execute(args)
+      @options = Options.new.parse(args)
+      send options.command
     end
 
     private
@@ -32,34 +20,30 @@ module Github::Auth
         "Removing #{keys.count} key(s) from '#{keys_file.path}'"
     end
 
-    def on_keys_file(action, message)
-      puts message
-      rescue_keys_file_errors { keys_file.send action, keys }
+    def list
+      puts "Added users: #{keys_file.github_users.join(', ')}"
     end
 
-    def rescue_keys_file_errors
-      yield
-    rescue KeysFile::PermissionDeniedError
-      print_permission_denied
-    rescue KeysFile::FileDoesNotExistError
-      print_file_does_not_exist
+    def version
+      puts Github::Auth::VERSION
     end
 
-    def print_usage
-      puts "usage: gh-auth [--version] [#{COMMANDS.join '|'}] <username>"
+    def usage
+      puts options.usage
     end
 
-    def print_version
-      puts "gh-auth version #{Github::Auth::VERSION}"
+    def on_keys_file(action, message)
+      puts message
+      rescue_keys_file_errors { keys_file.send action, keys }
     end
 
-    def print_permission_denied
+    def rescue_keys_file_errors
+      yield
+    rescue KeysFile::PermissionDeniedError
       puts 'Permission denied!'
       puts
       puts "Make sure you have write permissions for '#{keys_file.path}'"
-    end
-
-    def print_file_does_not_exist
+    rescue KeysFile::FileDoesNotExistError
       puts "Keys file does not exist!"
       puts
       puts "Create one now and try again:"
@@ -67,18 +51,8 @@ module Github::Auth
       puts "  $ touch #{keys_file.path}"
     end
 
-    def print_github_user_does_not_exist(username)
-      puts "Github user '#{username}' does not exist"
-    end
-
-    def print_github_unavailable
-      puts "Github appears to be unavailable :("
-      puts
-      puts "https://status.github.com"
-    end
-
     def keys
-      @keys ||= usernames.map { |username| keys_for username }.flatten.compact
+      @keys ||= options.usernames.map { |user| keys_for user }.flatten.compact
     end
 
     def keys_for(username)
@@ -87,9 +61,11 @@ module Github::Auth
         username: username
       ).keys
     rescue Github::Auth::KeysClient::GithubUserDoesNotExistError
-      print_github_user_does_not_exist username
+      puts "Github user '#{username}' does not exist"
     rescue Github::Auth::KeysClient::GithubUnavailableError
-      print_github_unavailable
+      puts "Github appears to be unavailable :("
+      puts
+      puts "https://status.github.com"
     end
 
     def keys_file

data/lib/github/auth/keys_file.rb

@@ -31,6 +31,12 @@ module Github::Auth
       write_keys_file { |keys_file| keys_file.write new_content }
     end
 
+    def github_users
+      # http://rubular.com/r/zXCkewmm0i
+      regex = %r{github\.com/(\S+)}
+      keys_file_content.scan(regex).flatten.uniq.sort
+    end
+
     private
 
     def append_keys_file(&block)

data/lib/github/auth/options.rb

@@ -0,0 +1,64 @@
+require 'optparse'
+
+module Github::Auth
+  # Parses command line options
+  class Options
+    attr_reader :parser
+
+    def initialize
+      @parser = OptionParser.new do |opts|
+        opts.banner = [
+          'usage: gh-auth',
+          '[--version]',
+          '[--list]',
+          '[--add|--remove]',
+          '<username>'
+        ].join(' ')
+
+        opts.separator "\noptions:"
+
+        opts.on(
+          '--add doug,sally', Array, 'Add GitHub users'
+        ) do |usernames|
+          raise OptionParser::MissingArgument if usernames.empty?
+          @command = 'add'
+          @usernames = usernames
+        end
+
+        opts.on(
+          '--remove doug,sally', Array, 'Remove GitHub users'
+        ) do |usernames|
+          raise OptionParser::MissingArgument if usernames.empty?
+          @command = 'remove'
+          @usernames = usernames
+        end
+
+        opts.on('--list', 'List all GitHub users added') do
+          @command = 'list'
+        end
+
+        opts.on('--version', 'Show version') do
+          @command = 'version'
+        end
+      end
+    end
+
+    def command
+      @command ||= 'usage'
+    end
+
+    def usernames
+      @usernames ||= []
+    end
+
+    def usage
+      parser.help
+    end
+
+    def parse(args)
+      parser.parse(args)
+    ensure
+      return self
+    end
+  end
+end

data/lib/github/auth/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Auth
-    VERSION = "1.2.0"
+    VERSION = "2.0.0"
   end
 end

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

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'support/capture_stdout'
 require 'support/mock_github_server'
 require 'github/auth'
 
@@ -10,8 +11,8 @@ describe Github::Auth::CLI do
 
     after { keys_file.unlink }
 
-    def cli(argv)
-      described_class.new(argv).tap do |cli|
+    def cli
+      described_class.new.tap do |cli|
         cli.stub(
           github_hostname: hostname,
           keys_file_path: keys_file.path
@@ -20,17 +21,43 @@ describe Github::Auth::CLI do
     end
 
     it 'adds and removes keys from the keys file' do
-      cli(%w(add chrishunt)).execute
+      cli.execute %w(--add chrishunt)
 
       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
+      cli.execute %w(--remove chrishunt)
 
       expect(keys_file.read).to be_empty
 
       keys_file.unlink
     end
+
+    it 'lists users from the keys file' do
+      cli.execute %w(--add chrishunt)
+
+      output = capture_stdout do
+        cli.execute %w(--list)
+      end
+
+      expect(output).to include('chrishunt')
+    end
+
+    it 'prints version information' do
+      output = capture_stdout do
+        cli.execute %w(--version)
+      end
+
+      expect(output).to include Github::Auth::VERSION
+    end
+
+    it 'prints usage for invalid arguments' do
+      [[], %w(invalid), %w(--add)].each do |invalid_arguments|
+        expect(
+          capture_stdout { cli.execute invalid_arguments }
+        ).to include 'usage: gh-auth'
+      end
+    end
   end
 end

data/spec/support/capture_stdout.rb

@@ -0,0 +1,11 @@
+require 'stringio'
+
+def capture_stdout
+  captured_output = StringIO.new
+  real_stdout = $stdout
+  $stdout = captured_output
+  yield
+  captured_output.string
+ensure
+  $stdout = real_stdout
+end

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

@@ -197,4 +197,22 @@ describe Github::Auth::KeysFile do
       end
     end
   end
+
+  describe '#github_users' do
+    let(:keys) {[
+      Github::Auth::Key.new('jay',   'abc123'),
+      Github::Auth::Key.new('chris', 'def456'),
+      Github::Auth::Key.new('chris', 'ghi789'),
+    ]}
+
+    before do
+      keys_file.write keys.join("\n")
+      keys_file.write "\n"
+      keys_file.rewind
+    end
+
+    it 'returns a uniq, ordered list of github users' do
+      expect(subject.github_users).to eq(%w(chris jay))
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-auth
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,7 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -160,13 +161,14 @@ files:
 - lib/github/auth/key.rb
 - lib/github/auth/keys_client.rb
 - lib/github/auth/keys_file.rb
+- lib/github/auth/options.rb
 - lib/github/auth/version.rb
 - spec/acceptance/github/auth/cli_spec.rb
 - spec/acceptance/github/auth/keys_client_spec.rb
 - spec/acceptance/github/auth/keys_file_spec.rb
 - spec/spec_helper.rb
+- spec/support/capture_stdout.rb
 - spec/support/mock_github_server.rb
-- spec/unit/github/auth/cli_spec.rb
 - spec/unit/github/auth/keys_client_spec.rb
 - spec/unit/github/auth/keys_file_spec.rb
 homepage: https://github.com/chrishunt/github-auth
@@ -198,7 +200,7 @@ test_files:
 - spec/acceptance/github/auth/keys_client_spec.rb
 - spec/acceptance/github/auth/keys_file_spec.rb
 - spec/spec_helper.rb
+- spec/support/capture_stdout.rb
 - spec/support/mock_github_server.rb
-- spec/unit/github/auth/cli_spec.rb
 - spec/unit/github/auth/keys_client_spec.rb
 - spec/unit/github/auth/keys_file_spec.rb

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

@@ -1,51 +0,0 @@
-require 'spec_helper'
-require 'github/auth/cli'
-
-describe Github::Auth::CLI do
-  let(:argv) { [] }
-
-  subject { described_class.new argv }
-
-  describe '#execute' do
-    shared_examples_for 'a method that prints usage' do
-      it 'prints the usage' do
-        subject.should_receive(:print_usage)
-        subject.execute
-      end
-    end
-
-    context 'when missing a command' do
-      let(:argv) { [] }
-      it_should_behave_like 'a method that prints usage'
-    end
-
-    context 'with an invalid command' do
-      let(:argv) { ['invalid'] }
-      it_should_behave_like 'a method that prints usage'
-    end
-
-    context 'when no usernames are provide' do
-      let(:argv) { ['add'] }
-      it_should_behave_like 'a method that prints usage'
-    end
-
-    context 'with a valid action and usernames' do
-      let(:action) { 'add' }
-      let(:argv) { [action, 'chrishunt'] }
-
-      it 'calls the method matching the action name' do
-        subject.should_receive(action)
-        subject.execute
-      end
-    end
-
-    context 'with the --version command' do
-      let(:argv) { ['--version'] }
-
-      it 'prints version information' do
-        subject.should_receive(:print_version)
-        subject.execute
-      end
-    end
-  end
-end