octoauth 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f18a1e0fb13d72ba6e6280673831a2e6e855a42
-  data.tar.gz: b59375a0a2a198e939a55306f75edf9d1eb5c603
+  metadata.gz: e662d2be3726ad6da9d18f4404199106052aa599
+  data.tar.gz: f139f60f766463b2ee0ecdd0aa17ae6464e18573
 SHA512:
-  metadata.gz: 209f5e8f5a68cd9ae9d3c993d4bb74021d61bf10dad180e778da96c2d32b1a578abb4c464cb8bd5a7646a784fb3c6534cd8be9a9f16bb76ddaf456c178e1876e
-  data.tar.gz: 6994adcdf5e62c89d0a8b218ae14a4f5d9ef5d2acfbea00acd23e0ca9d067ecee3cd2cc5efcfc386ceacc72fd6d4e77cecf12295c3bf4c01aa1e0390f23b4102
+  metadata.gz: 5a9e4b20659320da55cc9f913be5e7fd151dfd2bbff4328716555e1e393b343bea4e0eae16e784785c9daea172039dbc5846697a8b881bf6fd60c3bd3d254980
+  data.tar.gz: 8344027f6637f8f54cc4691ea7b171e6511a11f82b2ff6e922b8a250883b9f5262b579a1c3f82f3d9f7f12facd698d8575500b762284a8c31c58f24dbcb4fd6f

data/.gitignore

@@ -3,3 +3,5 @@ coverage/
 .coveralls.yml
 .bundle
 Gemfile.lock
+spec/examples/tmp.yml
+spec/examples/priv_test.yml

data/README.md

@@ -8,10 +8,47 @@ octoauth
 [![Build Status](https://img.shields.io/travis/akerl/octoauth.svg)](https://travis-ci.org/akerl/octoauth)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
-SHORT_DESCRIPTION
+Authentication wrapper for GitHub's API
 
 ## Usage
 
+Get your authentication token quickly and simply:
+
+```
+require 'octoauth'
+
+auth = Octoauth.new note: 'my_cool_app'
+puts "My token is #{auth.token}"
+```
+
+This will prompt the user for a username/password and potentially 2FA token using [userinput](https://github.com/akerl/userinput). A note is required, and is what the token will appear as in the user's GitHub tokens list.
+
+If you want to store this token and reuse it, just drop it into a file. The default file is ~/.octoauth.yml. Subsequent runs with the same file and note will load the same token without prompting the user:
+
+```
+auth = Octoauth.new note: 'my_cooler_app', file: :default
+puts "My token is #{auth.token}"
+auth.save
+
+other_auth = Octoauth.new note: 'other_nice_app', file: '~/.other_app_config.yml'
+puts "The other token is #{other_auth.token}"
+other_auth.save
+```
+
+The above examples get us the basic scope, which means some read-only public access. For other scopes, specify them when creating the token:
+
+```
+auth = Octoauth.new note: 'my_app', scopes: ['gist', 'delete_repo']
+```
+
+If you're trying to use this with a GitHub Enterprise deployment, you can specify an alternate API endpoint:
+
+```
+auth = Octoauth.new note: 'enterprise_app', api_endpoint: 'https://sekrit.codez.com/api/v3/'
+```
+
+If an alternate endpoint is provided, that string is included as part of the saved config, so you can generate a token for GitHub and multiple alternate endpoints with the same note in the same config file.
+
 ## Installation
 
     gem install octoauth

data/lib/octoauth.rb

@@ -1,6 +1,3 @@
-require 'octokit'
-require 'userinput'
-
 ##
 # Octokit wrapper for simplifying authentication
 module Octoauth
@@ -11,38 +8,7 @@ module Octoauth
       self::Auth.new(*args)
     end
   end
-
-  ##
-  # Define some sane defaults
-  DEFAULTS = {
-    file: '~/.octoauth.yml'
-  }
-
-  ##
-  # Authentication object
-  class Auth
-    attr_reader :user, :note, :file
-
-    def initialize(params = {})
-      @user = nil
-      @file = params.delete(:file) || DEFAULTS[:file]
-      @note = params.delete(:note)
-      fail ArgumentError, 'Must provide a note for GitHub token' if @note.nil?
-      @api = Octokit::Client.new params
-    end
-
-    def authenticate!(params = {})
-    end
-
-    private
-
-    def login
-    end
-
-    def password
-    end
-
-    def twofactor
-    end
-  end
 end
+
+require 'octoauth/configfile'
+require 'octoauth/auth'

data/lib/octoauth/auth.rb

@@ -0,0 +1,74 @@
+require 'octokit'
+require 'userinput'
+
+##
+# Define Auth object and related info for Octoauth
+module Octoauth
+  ##
+  # Default OAuth scopes for tokens
+  DEFAULT_SCOPES = []
+
+  ##
+  # Prompt information for collecting user info
+  PROMPTS = {
+    login: UserInput.new(message: 'GitHub username', validation: /\w+/),
+    password: UserInput.new(message: 'Password', secret: true),
+    twofactor: UserInput.new(message: '2FA token', validation: /\d+/)
+  }
+
+  ##
+  # Authentication object
+  class Auth
+    attr_reader :token
+
+    def initialize(params = {})
+      params[:config_note] = params[:note].dup
+      if params.include? :api_endpoint
+        params[:config_note] << "--#{params[:api_endpoint]}"
+      end
+      @config = ConfigFile.new file: params[:file], note: params[:config_note]
+      @token = load_token params
+    end
+
+    def save
+      fail 'No token to save' unless @token
+      @config.token = @token
+      @config.write
+    end
+
+    private
+
+    def load_token(params = {})
+      return @config.token if @config.token
+      params[:login] ||= PROMPTS[:login].ask
+      params[:password] ||= PROMPTS[:password].ask
+      params[:twofactor] ||= PROMPTS[:twofactor].ask if params[:needs2fa]
+      params[:scopes] ||= DEFAULT_SCOPES
+      if params[:twofactor]
+        params[:headers] = { 'X-GitHub-OTP' => params[:twofactor] }
+      end
+      authenticate! params
+    end
+
+    def authenticate!(params = {})
+      client = Octokit::Client.new(
+        params.subset(:login, :password, :api_endpoint)
+      )
+      client.create_authorization(
+        params.subset(:note, :scopes, :headers)
+      ).token
+    rescue Octokit::OneTimePasswordRequired
+      load_token params.merge(needs2fa: true)
+    rescue Octokit::UnprocessableEntity
+      client.authorizations.find { |x| x[:note] == params[:note] }.token
+    end
+  end
+end
+
+##
+# Add .subset to Hash for selecting a subhash
+class Hash
+  def subset(*keys)
+    select { |k| keys.include? k }
+  end
+end

data/lib/octoauth/configfile.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+##
+# Define Config spec
+module Octoauth
+  ##
+  # Define default file path
+  DEFAULT_FILE = '~/.octoauth.yml'
+
+  ##
+  # Configuration object
+  class ConfigFile
+    attr_reader :file
+    attr_accessor :token
+
+    ##
+    # Create new Config object, either ephemerally or from a file
+    def initialize(params = {})
+      @file = params[:file] == :default ? DEFAULT_FILE : params[:file]
+      @note = params[:note] || fail(ArgumentError, 'A note must be provided')
+      @token = parse
+    end
+
+    def write
+      new = get
+      new[@note] = @token
+      File.open(@file, 'w', 0400) { |fh| fh.write new.to_yaml }
+    end
+
+    private
+
+    def get
+      return {} unless @file && File.exist?(@file)
+      YAML.load File.read(File.expand_path(@file))
+    end
+
+    def parse
+      get[@note]
+    end
+  end
+end

data/octoauth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'octoauth'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = ''
@@ -13,11 +13,11 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split
   s.test_files  = `git ls-files spec/*`.split
 
-  s.add_dependency 'octokit', '~> 3.0.0'
+  s.add_dependency 'octokit', '~> 3.1.0'
   s.add_dependency 'userinput', '~> 0.0.2'
 
   s.add_development_dependency 'rubocop', '~> 0.20.0'
-  s.add_development_dependency 'rake', '~> 10.2.1'
+  s.add_development_dependency 'rake', '~> 10.3.0'
   s.add_development_dependency 'coveralls', '~> 0.7.0'
   s.add_development_dependency 'rspec', '~> 2.14.1'
   s.add_development_dependency 'fuubar', '~> 1.3.2'

data/spec/examples/conf_a.yml

@@ -0,0 +1,3 @@
+---
+foo: 'bcdebcdebcdebcdebcdebcdebcde'
+

data/spec/octoauth/auth_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+require 'fileutils'
+
+##
+# Shim object for mocking auth resources
+AuthShim = Struct.new(:note, :token)
+
+module UserInput
+##
+# Mask prints from UserInput
+  class Prompt
+    def print(*args)
+    end
+
+    def puts(*args)
+    end
+  end
+end
+
+describe Octoauth do
+  describe Octoauth::Auth do
+    describe '#initialize' do
+      context 'if the file and note already exist' do
+        it 'loads the existing token' do
+          auth = Octoauth::Auth.new(
+            note: 'foo',
+            file: 'spec/examples/conf_a.yml'
+          )
+          expect(auth.token).to eql 'bcdebcdebcdebcdebcdebcdebcde'
+        end
+      end
+      context 'if there is a note conflict' do
+        it 'returns the existing token' do
+          stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+            .with(body: "{\"note\":\"existing\",\"scopes\":[]}")
+            .to_return(status: 422)
+          stub_request(:get, 'https://user:pw@api.github.com/authorizations')
+            .to_return(
+              status: 200,
+              body: [
+                AuthShim.new('not_match', 'bad'),
+                AuthShim.new('existing', 'existing_token')
+              ]
+            )
+          auth = Octoauth::Auth.new(
+            note: 'existing',
+            login: 'user',
+            password: 'pw'
+          )
+          expect(auth.token).to eql 'existing_token'
+        end
+      end
+      context 'if the file does not exist' do
+        it 'requests user input to create token' do
+          stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+            .with(body: "{\"note\":\"foo\",\"scopes\":[]}")
+            .to_return(
+              status: 200,
+              body: AuthShim.new('foo', 'qwertyqwertyqwertyqwerty')
+            )
+          auth = Octoauth::Auth.new(
+            note: 'foo',
+            login: 'user',
+            password: 'pw'
+          )
+          expect(auth.token).to eql 'qwertyqwertyqwertyqwerty'
+        end
+        it 'handles users with 2 factor auth enabled' do
+          stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+            .with(body: "{\"note\":\"foo\",\"scopes\":[]}")
+            .to_return(
+              status: 401,
+              headers: { 'X-GitHub-OTP' => 'required; app' }
+            )
+          stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+            .with(
+              body: "{\"note\":\"foo\",\"scopes\":[]}",
+              headers: { 'X-GitHub-OTP' => '1234' }
+            )
+            .to_return(
+              status: 200,
+              body: AuthShim.new('foo', 'qwertyqwertyqwertyqwerty')
+            )
+          allow(STDIN).to receive(:gets).and_return("user\n", "pw\n", "1234\n")
+          auth = Octoauth::Auth.new(note: 'foo')
+          expect(auth.token).to eql 'qwertyqwertyqwertyqwerty'
+        end
+      end
+      it 'supports alternate endpoints' do
+        stub_request(:post, 'https://user:pw@sekrit.com/api/v3/authorizations')
+          .with(body: "{\"note\":\"foo\",\"scopes\":[]}")
+          .to_return(
+            status: 200,
+            body: AuthShim.new('foo', 'qwertyqwertyqwertyqwerty')
+          )
+        auth = Octoauth::Auth.new(
+          note: 'foo',
+          login: 'user',
+          password: 'pw',
+          api_endpoint: 'https://sekrit.com/api/v3/'
+        )
+        expect(auth.token).to eql 'qwertyqwertyqwertyqwerty'
+      end
+      it 'supports requesting scopes' do
+        stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+          .with(body: '{"note":"foo","scopes":["gist","delete_repo"]}')
+          .to_return(
+            status: 200,
+            body: AuthShim.new('foo', 'qwertyqwertyqwertyqwerty')
+          )
+        auth = Octoauth::Auth.new(
+          note: 'foo',
+          login: 'user',
+          password: 'pw',
+          scopes: %w(gist delete_repo)
+        )
+        expect(auth.token).to eql 'qwertyqwertyqwertyqwerty'
+      end
+    end
+
+    describe '#save' do
+      it 'saves the config to disk' do
+        random = rand(36**30).to_s(30)
+        FileUtils.rm_f 'spec/examples/tmp.yml'
+        stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+          .with(body: "{\"note\":\"write_test\",\"scopes\":[]}")
+          .to_return(
+            status: 200,
+            body: AuthShim.new('foo', random)
+          )
+        auth = Octoauth::Auth.new(
+          note: 'write_test',
+          file: 'spec/examples/tmp.yml',
+          login: 'user',
+          password: 'pw'
+        )
+        auth.save
+        new_auth = Octoauth::Auth.new(
+          note: 'write_test',
+          file: 'spec/examples/tmp.yml'
+        )
+        expect(new_auth.token).to eql random
+      end
+    end
+  end
+end

data/spec/octoauth/configfile_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe Octoauth do
+  describe Octoauth::ConfigFile do
+    describe '#initialize' do
+      it 'requires a note' do
+        expect { Octoauth::ConfigFile.new }.to raise_error ArgumentError
+      end
+      context 'when given a file path' do
+        it 'loads that config' do
+          config = Octoauth::ConfigFile.new(
+            note: 'foo',
+            file: 'spec/examples/conf_a.yml'
+          )
+          expect(config.token).to eql 'bcdebcdebcdebcdebcdebcdebcde'
+        end
+        it 'returns nil if the file does not exist' do
+          config = Octoauth::ConfigFile.new(note: 'foo', file: 'wat')
+          expect(config.token).to be_nil
+        end
+      end
+      context 'when give :default' do
+        it 'uses the default file' do
+          config = Octoauth::ConfigFile.new(note: 'foo', file: :default)
+          expect(config.file).to eql Octoauth::DEFAULT_FILE
+        end
+      end
+      context 'when given no file' do
+        it 'returns an empty hash' do
+          config = Octoauth::ConfigFile.new(note: 'foo')
+          expect(config.token).to be_nil
+          expect(config.file).to be_nil
+        end
+      end
+    end
+
+    describe '#write' do
+      it 'saves a config to disk' do
+        FileUtils.rm_f 'spec/examples/tmp.yml'
+        random = rand(36**30).to_s(30)
+        config = Octoauth::ConfigFile.new(
+          note: 'bar',
+          file: 'spec/examples/tmp.yml'
+        )
+        config.token = random
+        config.write
+        new_config = Octoauth::ConfigFile.new(
+          note: 'bar',
+          file: 'spec/examples/tmp.yml'
+        )
+        expect(new_config.token).to eql random
+      end
+      it 'makes the config file owner-readable' do
+        FileUtils.rm_f 'spec/examples/priv_test.yml'
+        random = rand(36**30).to_s(30)
+        config = Octoauth::ConfigFile.new(
+          note: 'bar',
+          file: 'spec/examples/priv_test.yml'
+        )
+        config.token = random
+        config.write
+        privs = File.stat('spec/examples/priv_test.yml').mode.to_s(8)
+        expect(privs).to eql '100400'
+      end
+    end
+  end
+end

data/spec/octoauth_spec.rb

@@ -3,15 +3,13 @@ require 'spec_helper'
 describe Octoauth do
   describe '#new' do
     it 'creates auth objects' do
-      expect(Octoauth.new).to be_an_instance_of Octoauth::Auth
-    end
-  end
-
-  describe Octoauth::Auth do
-    let(:subject) { Octoauth::Auth.new }
-
-    it 'creates an auth object' do
-      expect(subject).to be_an_instance_of Octoauth::Auth
+      stub_request(:post, 'https://good:sekrit@api.github.com/authorizations')
+        .to_return(
+          status: 200,
+          body: Struct.new(:token).new('abcdabcdabcdabcdabcdabcdabcdabcdabcd')
+        )
+      auth = Octoauth.new note: 'testing', login: 'good', password: 'sekrit'
+      expect(auth).to be_an_instance_of Octoauth::Auth
     end
   end
 end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: octoauth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: userinput
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.2.1
+        version: 10.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.2.1
+        version: 10.3.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.4
 description: ''
@@ -128,16 +128,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/octoauth.rb
+- lib/octoauth/auth.rb
+- lib/octoauth/configfile.rb
 - octoauth.gemspec
+- spec/examples/conf_a.yml
+- spec/octoauth/auth_spec.rb
+- spec/octoauth/configfile_spec.rb
 - spec/octoauth_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/akerl/octoauth
@@ -150,12 +155,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -165,5 +170,8 @@ signing_key:
 specification_version: 4
 summary: ''
 test_files:
+- spec/examples/conf_a.yml
+- spec/octoauth/auth_spec.rb
+- spec/octoauth/configfile_spec.rb
 - spec/octoauth_spec.rb
 - spec/spec_helper.rb