octoauth 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9aa2e61a7ffe64cb1ca0a5c992a62afad06ba3f2
-  data.tar.gz: 3eea475acbea688c561c178afd6418f83695618a
+  metadata.gz: a2fc370fac48f586e3832626f1979f7cea1b5649
+  data.tar.gz: e0cd4359ebe9fb0d4a06c9e1544edb2bd1cd3b72
 SHA512:
-  metadata.gz: 34b473862aff7ce51daf7f2d3c17c2dfd98bd01bba08a521e9a93bac0fcbfa81ffa80b39f00baf17fb1fe56bbf024b80adc0017383aeea609ff60284745675ef
-  data.tar.gz: c9d43a74f10613864ec54a04382465f80772a5ecd463cb6277648fd44d6d0b0f46c866727757d46f2fb970a287bfcf1f76ab34bc5f0707794799f9fb3608e69a
+  metadata.gz: fce5750ecd54f28ab452f227a6ac685ee251619e1f0e76e1620add2b6c4d64d84cb7943f0fcd195abcb6f24ae3760088eca66205783a69b420c3280d66eae752
+  data.tar.gz: 0abe260a1a69248c6f0c7d086a6db8c267fef7e3a97000a94ba5b0e6b747ff6b0e9ad77815381ecc3f5307ff23d26a3d7104550d6a43b1fbb9582756f3e1c6ac

data/.gitignore

@@ -6,3 +6,4 @@ Gemfile.lock
 spec/examples/tmp.yml
 spec/examples/priv_test.yml
 spec/examples/autosave.yml
+spec/examples/nil.yml

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0 / 2015-05-03
+
+* [FEATURE] Support hierarchy of file paths for configs
+
 # 1.0.2 / 2015-05-03
 
 * [ENHANCEMENT] Fix option/param handling to be cleaner

data/README.md

@@ -35,6 +35,12 @@ puts "The other token is #{other_auth.token}"
 other_auth.save
 ```
 
+Multiple files can be specified, and it will try them in order looking for a valid token. If this fails, it will use the first file listed for any future saving of tokens:
+
+```
+auth = Octoauth.new note: 'my_app', files: ['./.octoauth.yml', '/etc/octoauth', :default]
+```
+
 The above examples get us the basic scope, which means some read-only public access. For other scopes, specify them when creating the token:
 
 ```

data/lib/octoauth/auth.rb

@@ -21,15 +21,14 @@ module Octoauth
   class Auth
     def initialize(params = {})
       parse_params!(params)
-      @config = ConfigFile.new file: @options[:file], note: config_note
       save if @options[:autosave]
     end
 
     def save
       fail 'No token to save' unless token
-      fail 'No file given for config' unless @config.file
-      @config.token = @token
-      @config.write
+      fail 'No file given for config' unless config.file
+      config.token = token
+      config.write
     end
 
     def token
@@ -38,9 +37,21 @@ module Octoauth
 
     private
 
+    def config
+      return @config if @config
+      configs = config_files.map do |file|
+        ConfigFile.new file: file, note: config_note
+      end
+      @config = configs.find(&:token) || configs.first
+    end
+
+    def config_files
+      @options[:files] ||= [@options[:file]]
+    end
+
     def parse_params!(params)
       @options = params.subset(
-        :file, :note, :autosave, :scopes,
+        :file, :files, :note, :autosave, :scopes,
         :login, :password, :twofactor, :api_endpoint
       )
     end
@@ -60,7 +71,7 @@ module Octoauth
     end
 
     def load_token(needs2fa = false)
-      return @config.token if @config.token
+      return config.token if config.token
       prompt!(needs2fa)
       authenticate
     end

data/octoauth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'octoauth'
-  s.version     = '1.0.2'
+  s.version     = '1.1.0'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = 'Auth token helper for GitHub API'

data/spec/octoauth/auth_spec.rb

@@ -139,6 +139,61 @@ describe Octoauth do
         expect(new_auth.token).to eql random
       end
     end
+    context 'when given multiple file paths' do
+      context 'when the first file exists' do
+        it 'reads the first file' do
+          auth = Octoauth::Auth.new(
+            note: 'foo',
+            files: ['spec/examples/conf_a.yml', 'spec/examples/bogus.yml']
+          )
+          expect(auth.token).to eql 'bcdebcdebcdebcdebcdebcdebcde'
+        end
+      end
+      context 'when the first file does not exist' do
+        context 'when the second file exists' do
+          it 'reads the second file' do
+            FileUtils.rm_f 'spec/examples/nil.yml'
+            auth = Octoauth::Auth.new(
+              note: 'foo',
+              files: ['spec/examples/bogus.yml', 'spec/examples/conf_a.yml']
+            )
+            expect(auth.token).to eql 'bcdebcdebcdebcdebcdebcdebcde'
+          end
+        end
+        context 'when the second file does not exist' do
+          it 'reads nil' do
+            FileUtils.rm_f ['spec/examples/nil.yml', 'spec/examples/nil2.yml']
+            auth = Octoauth::Auth.new(
+              note: 'foo',
+              files: ['spec/examples/nil.yml', 'spec/examples/nil2.yml']
+            )
+            expect(auth.send(:config).token).to be_nil
+          end
+          it 'writes to the first file' do
+            random = rand(36**30).to_s(30)
+            stub_request(:post, 'https://user:pw@api.github.com/authorizations')
+              .with(body: "{\"note\":\"foo\",\"scopes\":[]}")
+              .to_return(
+                status: 200,
+                body: AuthShim.new('foo', random)
+              )
+            FileUtils.rm_f ['spec/examples/nil.yml', 'spec/examples/nil2.yml']
+            auth = Octoauth::Auth.new(
+              note: 'foo',
+              files: ['spec/examples/nil.yml', 'spec/examples/nil2.yml'],
+              login: 'user',
+              password: 'pw'
+            )
+            auth.save
+            new_auth = Octoauth::Auth.new(
+              note: 'foo',
+              file: 'spec/examples/nil.yml'
+            )
+            expect(new_auth.token).to eql random
+          end
+        end
+      end
+    end
 
     describe '#save' do
       it 'saves the config to disk' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octoauth
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Les Aker