g5_authentication_client 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 631343ac9b439ce2f1e1cbad1e8fa52999ff30ad
-  data.tar.gz: 903d0901198ef0057473475b33eeb74a13b61317
+  metadata.gz: 475820a142d4fd801168d3e1bc7f5ffca38dd3d1
+  data.tar.gz: 2992ed1d10a40c9bdfc60d34c635b469150d777a
 SHA512:
-  metadata.gz: 08bb76c84e52b228ff9790d83dc7282869e7128a72ecd855a97255a396ac8cdf241866dd9a5b194e0d96a7fed589f71eba8cc42ed74faaae35babf8eb90888c8
-  data.tar.gz: 8ab1e14d06f37eb166c15d05b921d8b8be1bb2bfe60dc1a239ae45b035c732f5c8961f0db63c3b6cb77b9abc437d1832df17b56dae10aeac59ca3f2d9bd44eec
+  metadata.gz: 810219c6c6824c08aa6fd4b0499606ce94c4fdc70ccd00594b2f8649888946acdced45f6fcd19c76c449a1732f9b36eefc24c5071c831b3bdea325d1a5668a5d
+  data.tar.gz: e114437fc35c187dcc121ef0d39cb5d58eface8ab734f08ab5715a7e06f5f60257892253a6d7431f956820ea1d3b06e6344668a8c7a60b6b358f0fe0e3d92717

data/CHANGELOG.md

@@ -1,4 +1,10 @@
+## v0.3.0 (2015-01-08)
+
+* Add `G5AuthenticationClient::Client#list_users`
+  ([#22](https://github.com/G5/g5_authentication_client/pull/22))
+
 ## v0.2.3 (2014-07-31)
+
 * remove id from body in create/update user
 
 ## v0.2.0 (2014-03-10)
@@ -7,12 +13,12 @@
 
 ## v0.1.5 (2014-03-07)
 
-* Add allow_password_credentials flag to determine whether client instances
+* Add `allow_password_credentials` flag to determine whether client instances
 * will allow use of username/passwored attributes
 
 ## v0.1.4 (2014-03-06)
 
-* Change configure method namespace to g5_auth from g5_authentication_client
+* Change configure method namespace to `g5_auth` from `g5_authentication_client`
 
 ## v0.1.1 (2013-11-15)
 

data/README.md

@@ -4,7 +4,7 @@ A client library for the g5-authentication service.
 
 ## Current version ##
 
-0.2.0
+0.3.0
 
 ## Requirements ##
 
@@ -38,6 +38,7 @@ environment variable (not all of these will be used concurrently!):
 * `G5_AUTH_USERNAME` - the username for the end user to authenticate as
 * `G5_AUTH_PASSWORD` - the password for the end user to authenticate as
 * `G5_AUTH_ACCESS_TOKEN` - a valid OAuth 2.0 access token (note that tokens do expire)
+* `G5_AUTH_ALLOW_PASSWORD_CREDENTIALS` - set to 'true' to use resource owner password credentials grant
 
 ### Module-level config ###
 
@@ -107,13 +108,20 @@ current_user = auth_client.me
 # => #<G5AuthenticationClient::User email="my.user@test.host" id=1>
 ```
 
-You can also retrieve informatino about any other user by ID:
+You can also retrieve information about any other user by ID:
 
 ```ruby
 user = auth_client.get_user(42)
 # => #<G5AuthenticationClient::User email="another.user@test.host" id=42>
 ```
 
+You can list all users in the remote service:
+
+```ruby
+user = auth_client.list_users
+# => [#<G5AuthenticationClient::User email="another.user@test.host" id=42>, ... ]
+```
+
 ### Retrieving token information ###
 
 You can retrieve information specific to the current access token, including
@@ -266,7 +274,11 @@ module-level configuration or environment variables for those:
 export G5_AUTH_CLIENT_ID='my-client-id'
 export G5_AUTH_CLIENT_SECRET='my-client-secret'
 export G5_AUTH_REDIRECT_URI='https://test.host/callback'
+export G5_AUTH_ALLOW_PASSWORD_CREDENTIALS='true'
 ```
+Warning:  setting G5_AUTH_ALLOW_PASSWORD_CREDENTIALS will cause all client instances
+to use the username/password specified in the absence of an access_token.  Usually, this
+will be used per instance.
 
 If you want to use a different username and password per request, then you
 should configure these on each client instance:

data/lib/g5_authentication_client/client.rb

@@ -169,6 +169,13 @@ module G5AuthenticationClient
       auth_server_url.to_s
     end
 
+    # Return all users from the remote service
+    # @return [Array<G5AuthenticationClient::User>]
+    def list_users
+      response=oauth_access_token.get("/v1/users")
+      response.parsed.collect { |parsed_user| User.new(parsed_user) }
+    end
+
     private
 
     def user_hash(h)

data/lib/g5_authentication_client/version.rb

@@ -1,3 +1,3 @@
 module G5AuthenticationClient
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/spec/g5_authentication_client/client_spec.rb

@@ -166,7 +166,7 @@ describe G5AuthenticationClient::Client do
         context 'when there is no logger configured at the top level' do
           it 'should change the value of the logger to the default' do
             expect { subject }.to change { client.logger }
-            client.logger.should be_an_instance_of(Logger)
+            expect(client.logger).to be_an_instance_of(Logger)
           end
         end
       end
@@ -422,4 +422,26 @@ describe G5AuthenticationClient::Client do
 
     it_should_behave_like 'an oauth protected resource', G5AuthenticationClient::TokenInfo
   end
+
+  describe '#list_users' do
+    subject(:list_users) { client.list_users }
+
+    before do
+      stub_request(:get, /#{endpoint}\/v1\/users/).
+        with(headers: {'Authorization' => auth_header_value}).
+        to_return(status: 200,
+                  body: [returned_user].to_json,
+                  headers: {'Content-Type' => 'application/json'})
+    end
+
+    it 'should return one user' do
+      expect(list_users.size).to eq(1)
+    end
+
+    describe 'the first user' do
+      subject(:user) { list_users.first }
+
+      it_should_behave_like 'an oauth protected resource', G5AuthenticationClient::User
+    end
+  end
 end

data/spec/g5_authentication_client/configuration_spec.rb

@@ -372,7 +372,7 @@ describe G5AuthenticationClient::Configuration do
     subject(:options) { test_module.options }
 
     it "should have correct options" do
-      options.should include(
+      expect(options).to include(
         debug: 'true',
         username: username,
         password: password,

data/spec/g5_authentication_client_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe G5AuthenticationClient do
   it "should have a version" do
-    subject::VERSION.should be
+    expect(subject::VERSION).to be
   end
 
-  it { should respond_to(:configure) }
-  it { should respond_to(:reset) }
-  it { should respond_to(:options) }
+  it { is_expected.to respond_to(:configure) }
+  it { is_expected.to respond_to(:reset) }
+  it { is_expected.to respond_to(:options) }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: g5_authentication_client
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob Revels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modelish
@@ -247,13 +247,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Client for the G5 Auth service
-test_files:
-- spec/g5_authentication_client/client_spec.rb
-- spec/g5_authentication_client/configuration_spec.rb
-- spec/g5_authentication_client/token_info_spec.rb
-- spec/g5_authentication_client/user_spec.rb
-- spec/g5_authentication_client_spec.rb
-- spec/spec_helper.rb
-- spec/support/module_configured_attribute.rb
-- spec/support/oauth_protected_resource.rb
+test_files: []
 has_rdoc: