g5_authentication_client 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c53ebcac18a16bd552178866980fafac5c8a0ae4
-  data.tar.gz: 17ca20696af027a5535bc29e4d3e8d7ef23b7ab6
+  metadata.gz: 7463214386cb26b951d8a2046fc473956679b4af
+  data.tar.gz: e1d54d81273360a07c93795346943ad71e2e21dd
 SHA512:
-  metadata.gz: e8ec55c0c2826bcd192a1920ac3dc53d51df2edea1ef00464ef889b3a4e8cdb079f6e0ff391e19c679cefb1451e661755e64470b79cd0cf045b215288bef81f7
-  data.tar.gz: 088cf07f5d346f9b5de42d412a936fd1b676296d9f734e309f3536b166a43d660e034c70c033563aa9e4a402e5815e940a34d1b303752f2073c4651884c714e7
+  metadata.gz: 51a5fbf9a712e05f1c9ab9e977da28d30d99ae4dbe0ab9d561fea5df207e9ff7ce5569a501f888b2af0db94695494b18e1ca520c9352064079f066bbeed34836
+  data.tar.gz: 71e4dc676d3734ba9b35049506222d2e94b282889bb51e396ec73b404955cdbb86abae0c499e9da15956b67ebfea9611031186935822cfc34ff5a70324ae2c8b

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.1.6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.5.3
+
+* `Client#username_pw_access_token`: raise error when username/password are blank
+  ([#29](https://github.com/G5/g5_authentication_client/pull/29))
+
+## v0.5.2
+
+* convenience method for access tokens
+  ([#27](https://github.com/G5/g5_authentication_client/pull/27))
+
 ## v0.5.1 (2015-08-21)
 
 * Allow user attributes to be selectively updated

data/lib/g5_authentication_client/client.rb

@@ -69,7 +69,7 @@ module G5AuthenticationClient
     # Tells whether a client instance will use the username/password credentials
     # @return [Boolean] whether the client will use username/password
     def allow_password_credentials?
-      allow_password_credentials=='true' && !username.nil? && !password.nil?
+      allow_password_credentials=='true'
     end
 
     # Retrieves the access token as a string
@@ -185,12 +185,22 @@ module G5AuthenticationClient
     end
 
     def username_pw_access_token
+      raise_if_blank('username')
+      raise_if_blank('password')
       raise 'allow_password_credentials must be enabled for username/pw access' unless allow_password_credentials?
       oauth_client.password.get_token(username, password)
     end
 
     private
 
+    def raise_if_blank(client_attribute)
+      attr = send(client_attribute)
+      if attr.nil? || attr.strip == ''
+        raise G5AuthenticationClient::Error.
+          new("#{client_attribute} is blank, provide a #{client_attribute} by setting it in the client instance or adding a G5_AUTH_#{client_attribute.upcase} env variable.")
+      end
+    end
+
     def user_hash(h)
       user_params = h.reject { |k,v| k == 'id' || v.nil? || v.empty? }
       { user: user_params }

data/lib/g5_authentication_client/error.rb

@@ -0,0 +1,5 @@
+module G5AuthenticationClient
+  class Error < StandardError
+
+  end
+end

data/lib/g5_authentication_client/version.rb

@@ -1,3 +1,3 @@
 module G5AuthenticationClient
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

data/lib/g5_authentication_client.rb

@@ -5,6 +5,7 @@ require 'g5_authentication_client/user'
 require 'g5_authentication_client/token_info'
 require 'g5_authentication_client/role'
 require 'g5_authentication_client/auth_token_helper'
+require 'g5_authentication_client/error'
 
 module G5AuthenticationClient
   extend Configuration

data/spec/g5_authentication_client/client_spec.rb

@@ -17,7 +17,8 @@ describe G5AuthenticationClient::Client do
   let(:authorization_code){ 'code' }
   let(:allow_password_credentials){ 'false' }
 
-  let(:options) do
+  let(:options) { default_options }
+  let(:default_options) do
     {
      debug: debug,
      logger: logger,
@@ -128,9 +129,6 @@ describe G5AuthenticationClient::Client do
       expect(client.allow_password_credentials).to eq('true')
     end
 
-    it 'username_pw_access_token raises error when password credentials not enabled' do
-      expect { client.username_pw_access_token }.to raise_error('allow_password_credentials must be enabled for username/pw access')
-    end
   end
 
   context 'with non-default configuration' do
@@ -262,37 +260,12 @@ describe G5AuthenticationClient::Client do
 
     context 'when the allow_password_credentials is set to true' do
       let(:allow_password_credentials) {'true'}
-
-      context 'with non-nil username and password' do
-
-        it 'should be true' do
-          expect(subject).to be true
-        end
-      end
-
-      context 'when username is nil' do
-        let(:username) {}
-
-        it 'should be false' do
-          expect(subject).to be false
-        end
-      end
-
-      context 'when password is nil' do
-        let(:password) {}
-
-        it 'should be false' do
-          expect(subject).to be false
-        end
-      end
+      it { is_expected.to be true }
     end
 
     context 'when the allow_password_credentials is set to false' do
       let(:allow_password_credentials) {'false'}
-
-      it 'should be false' do
-        expect(subject).to be false
-      end
+      it { is_expected.to be false }
     end
   end
 
@@ -523,22 +496,33 @@ describe G5AuthenticationClient::Client do
     end
   end
 
-  context 'stubbed get token' do
+  describe '#username_pw_access_token' do
     let(:token) {'asdf'}
     before do
       oauth_client = double(OAuth2::AccessToken, password: double(:pw, get_token: token))
       allow(client).to receive(:oauth_client).and_return(oauth_client)
+      client.allow_password_credentials = 'true'
     end
 
-    describe '#username_pw_access_token' do
-      let(:returned_token) { {access_token: 'asdf'} }
-      before do
-        client.allow_password_credentials = 'true'
-      end
-
+    context 'allow_password_credentials is `true`' do
       it 'delegates token retrieval to oauth_client' do
         expect(client.username_pw_access_token).to eq(token)
       end
     end
+
+    context 'username is blank' do
+      let(:options) { default_options.merge(username: " ") }
+      it 'raises an error' do
+        expect { client.username_pw_access_token }.to raise_error(G5AuthenticationClient::Error, 'username is blank, provide a username by setting it in the client instance or adding a G5_AUTH_USERNAME env variable.')
+      end
+    end
+
+    context 'password is blank' do
+      let(:options) { default_options.merge(password: " ") }
+      it 'raises an error' do
+        expect { client.username_pw_access_token }.to raise_error(G5AuthenticationClient::Error, 'password is blank, provide a password by setting it in the client instance or adding a G5_AUTH_PASSWORD env variable.')
+      end
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: g5_authentication_client
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Rob Revels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modelish
@@ -215,6 +215,7 @@ files:
 - lib/g5_authentication_client/auth_token_helper.rb
 - lib/g5_authentication_client/client.rb
 - lib/g5_authentication_client/configuration.rb
+- lib/g5_authentication_client/error.rb
 - lib/g5_authentication_client/role.rb
 - lib/g5_authentication_client/token_info.rb
 - lib/g5_authentication_client/user.rb
@@ -248,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: g5_authentication_client
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Client for the G5 Auth service