g5_authentication_client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 475820a142d4fd801168d3e1bc7f5ffca38dd3d1
-  data.tar.gz: 2992ed1d10a40c9bdfc60d34c635b469150d777a
+  metadata.gz: 8f1b72b556d88ccf5d3db877677efbbd8f969c1b
+  data.tar.gz: 21a75a23db8b2e8106999de8e481923701fd9fad
 SHA512:
-  metadata.gz: 810219c6c6824c08aa6fd4b0499606ce94c4fdc70ccd00594b2f8649888946acdced45f6fcd19c76c449a1732f9b36eefc24c5071c831b3bdea325d1a5668a5d
-  data.tar.gz: e114437fc35c187dcc121ef0d39cb5d58eface8ab734f08ab5715a7e06f5f60257892253a6d7431f956820ea1d3b06e6344668a8c7a60b6b358f0fe0e3d92717
+  metadata.gz: 5eb630f56608ad0dda5705d63ee64c9cba567621220c37b7459239c7755d9b4ee3c2bcb12bc36919ee05653ed8073e644773604684f784c662ac3b38a5bfb27a
+  data.tar.gz: b216905352a09469399fa36194e8973cca41a22cb715d810a64af6792b66d75e74469119c4cb2cfcbe325ff1d5c579c42fcf84bd69439b4cc15238ad1afafcd7

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.1.6

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+script:
+  - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.4.0 (2015-05-20)
+
+* Add `G5AuthenticationClient::Client#list_roles`, a new
+  `G5AuthenticationClient::Role` model, and support for retrieving/updating
+  roles in the user data
+  ([#23](https://github.com/G5/g5_authentication_client/pull/23))
+
 ## v0.3.0 (2015-01-08)
 
 * Add `G5AuthenticationClient::Client#list_users`
@@ -14,7 +21,7 @@
 ## v0.1.5 (2014-03-07)
 
 * Add `allow_password_credentials` flag to determine whether client instances
-* will allow use of username/passwored attributes
+  will allow use of username/passwored attributes
 
 ## v0.1.4 (2014-03-06)
 

data/README.md

@@ -4,7 +4,7 @@ A client library for the g5-authentication service.
 
 ## Current version ##
 
-0.3.0
+0.4.0
 
 ## Requirements ##
 
@@ -206,6 +206,28 @@ auth_client.sign_out_url('https://myapp.host/callback')
 # => "https://auth.g5search.com/users/sign_out?redirect_url=https%3A%2F%2Fmyapp.host%2Fcallback"
 ```
 
+### Retrieving user roles ###
+
+A user's assigned roles will be included automatically when you retrieve user
+data via `get_user` or `list_users`.
+
+To retrieve a list of all roles (to which you have access) in the G5 auth
+service:
+
+```ruby
+auth_client = G5AuthenticationClient::Client.new(access_token: 'my_access_token')
+auth_client.list_roles
+# => [#<G5AuthenticationClient::Role id=3 name="editor">, #<G5AuthenticationClient::Role id=4 name="viewer">, ...]
+```
+
+To retrieve information about a particular role:
+
+```ruby
+auth_client = G5AuthenticationClient::Client.new(access_token: 'my_access_token')
+auth_client.get_role(4)
+# => #<G5AuthenticationClient::Role id=4 name="viewer">
+```
+
 ## Examples ##
 
 These examples assume that you have already registered your client application

data/lib/g5_authentication_client.rb

@@ -3,6 +3,7 @@ require 'g5_authentication_client/version'
 require 'g5_authentication_client/configuration'
 require 'g5_authentication_client/user'
 require 'g5_authentication_client/token_info'
+require 'g5_authentication_client/role'
 
 module G5AuthenticationClient
   extend Configuration

data/lib/g5_authentication_client/client.rb

@@ -176,6 +176,13 @@ module G5AuthenticationClient
       response.parsed.collect { |parsed_user| User.new(parsed_user) }
     end
 
+    # Return all user roles from the remote service
+    # @return [Array<G5AuthenticationClient::Role>]
+    def list_roles
+      response = oauth_access_token.get('/v1/roles')
+      response.parsed.collect { |parsed_role| Role.new(parsed_role) }
+    end
+
     private
 
     def user_hash(h)

data/lib/g5_authentication_client/role.rb

@@ -0,0 +1,13 @@
+require 'modelish'
+
+module G5AuthenticationClient
+  # G5 Authentication user role info
+  class Role < Modelish::Base
+    ignore_unknown_properties!
+
+    # @!attribute [rw] name
+    #   @return [String]
+    #   The name associated with this user role
+    property :name, type: String, required: true
+  end
+end

data/lib/g5_authentication_client/user.rb

@@ -1,4 +1,5 @@
 require 'modelish'
+require 'g5_authentication_client/role'
 
 module G5AuthenticationClient
 
@@ -50,10 +51,16 @@ module G5AuthenticationClient
     #   The user's phone number.  Not required to create a user.
     property :phone_number, type: String
 
+    # @!attribute [rw] roles
+    #   @return [Array<G5AuthenticationClient::Role>]
+    #   The user's roles. Not required to create a user.
+    property :roles, default: [],
+      type: proc { |val| val.map { |r| Role.new(r) } },
+      validator: proc { |val| "User roles must be valid" if val && val.detect { |r| !r.valid? } }
+
     def validate_for_create!
       validate!
       raise ArgumentError.new("Password required for new user.") unless !password.nil?
     end
-
   end
 end

data/lib/g5_authentication_client/version.rb

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

data/spec/g5_authentication_client/client_spec.rb

@@ -42,7 +42,8 @@ describe G5AuthenticationClient::Client do
   let(:new_user_options) do
     {email: email,
     password: "#{password}x",
-    id: user_id}
+    id: user_id,
+    roles: [{name: role_name}]}
   end
 
   let(:new_user_request) do
@@ -54,14 +55,17 @@ describe G5AuthenticationClient::Client do
       "password"=>"#{password}x",
       "password_confirmation"=>"",
       "phone_number"=>"",
-      "title"=>""
+      "title"=>"",
+      "roles"=>["name"=>role_name]
     }
   end
 
   let(:email){'foo@blah.com'}
   let(:password){'mybigtestpasswored'}
   let(:user_id){1}
-  let(:returned_user){{id: user_id,email: email}}
+  let(:role_name) { 'my_role' }
+  let(:returned_user){{id: user_id,email: email,roles:[returned_role]}}
+  let(:returned_role) { {'name' => role_name} }
 
   context 'with default configuration' do
     subject(:client) { G5AuthenticationClient::Client.new }
@@ -444,4 +448,26 @@ describe G5AuthenticationClient::Client do
       it_should_behave_like 'an oauth protected resource', G5AuthenticationClient::User
     end
   end
+
+  describe '#list_roles' do
+    subject(:list_roles) { client.list_roles }
+
+    before do
+      stub_request(:get, /#{endpoint}\/v1\/roles/).
+        with(headers: {'Authorization' => auth_header_value}).
+        to_return(status: 200,
+                  body: [returned_role].to_json,
+                  headers: {'Content-Type' => 'application/json'})
+    end
+
+    it 'should return one role' do
+      expect(list_roles.size).to eq(1)
+    end
+
+    describe 'the first role' do
+      subject(:role) { list_roles.first }
+
+      it_should_behave_like 'an oauth protected resource', G5AuthenticationClient::Role
+    end
+  end
 end

data/spec/g5_authentication_client/role_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe G5AuthenticationClient::Role do
+  subject(:role) { G5AuthenticationClient::Role.new(attributes) }
+
+  let(:attributes) { {name: name} }
+  let(:name) { 'awesome_role' }
+
+  context 'with default initialization' do
+    let(:attributes) {}
+
+    it 'should have a nil name' do
+      expect(role.name).to be_nil
+    end
+  end
+
+  context 'with full initialization' do
+    it 'should have the correct name' do
+      expect(role.name).to eq(name)
+    end
+  end
+
+  context 'when attributes include unknown properties' do
+    let(:attributes) { {name: name, resource: 'Application'} }
+
+    it 'should not raise an error' do
+      expect { role }.to_not raise_error
+    end
+
+    it 'should have the correct name' do
+      expect(role.name).to eq(name)
+    end
+
+    it 'should ignore the unknown attribute' do
+      expect(role).to_not respond_to(:resource)
+    end
+  end
+
+  describe '#validate!' do
+    subject(:validate!) { role.validate! }
+
+    context 'when all attributes are set' do
+      it 'should not raise an error' do
+        expect { validate! }.to_not raise_error
+      end
+    end
+
+    context 'when name is not set' do
+      let(:name) {}
+
+      it 'should raise an error' do
+        expect { validate! }.to raise_error
+      end
+    end
+  end
+
+  describe '#to_hash' do
+    subject(:hash) { role.to_hash }
+
+    it 'should have the correct name' do
+      expect(hash['name']).to eq(name)
+    end
+  end
+end

data/spec/g5_authentication_client/user_spec.rb

@@ -12,7 +12,8 @@ describe G5AuthenticationClient::User do
       last_name: last_name,
       title: title,
       organization_name: organization_name,
-      phone_number: phone_number
+      phone_number: phone_number,
+      roles: [{name: role_name}]
     }
   end
 
@@ -25,6 +26,7 @@ describe G5AuthenticationClient::User do
   let(:organization_name) { 'Things, Inc.' }
   let(:phone_number) { '8675309123' }
   let(:title) { 'Developer' }
+  let(:role_name)  { 'Editor' }
 
   context 'with default initialization' do
     let(:attributes){}
@@ -44,10 +46,13 @@ describe G5AuthenticationClient::User do
     it 'should have nil password_confirmation' do
       expect(user.password_confirmation).to be_nil
     end
+
+    it 'should have empty roles' do
+      expect(user.roles).to be_empty
+    end
   end
 
   context 'with full initialization' do
-
     it 'should have correct email' do
       expect(user.email).to eq(email)
     end
@@ -83,6 +88,14 @@ describe G5AuthenticationClient::User do
     it 'should have correct organization_name' do
       expect(user.organization_name).to eq(organization_name)
     end
+
+    it 'should have the correct number of roles' do
+      expect(user.roles.size).to eq(attributes[:roles].size)
+    end
+
+    it 'should have the correct role name' do
+      expect(user.roles.first.name).to eq(role_name)
+    end
   end
 
   describe '#validate!' do
@@ -159,6 +172,22 @@ describe G5AuthenticationClient::User do
         expect { validate! }.to_not raise_error
       end
     end
+
+    context 'without roles' do
+      let(:roles) {}
+
+      it 'should not raise an error' do
+        expect { validate! }.to_not raise_error
+      end
+    end
+
+    context 'with invalid roles' do
+      let(:role_name) {}
+
+      it 'should raise an error' do
+        expect { validate! }.to raise_error
+      end
+    end
   end
 
   describe '#validate_for_create!' do
@@ -212,5 +241,9 @@ describe G5AuthenticationClient::User do
     it 'should have an id' do
       expect(to_hash['id']).to eq(id)
     end
+
+    it 'should have roles' do
+      expect(to_hash['roles']).to eq([{'name' => role_name}])
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: g5_authentication_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rob Revels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modelish
@@ -204,6 +204,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -213,11 +214,13 @@ files:
 - lib/g5_authentication_client.rb
 - lib/g5_authentication_client/client.rb
 - lib/g5_authentication_client/configuration.rb
+- lib/g5_authentication_client/role.rb
 - lib/g5_authentication_client/token_info.rb
 - lib/g5_authentication_client/user.rb
 - lib/g5_authentication_client/version.rb
 - spec/g5_authentication_client/client_spec.rb
 - spec/g5_authentication_client/configuration_spec.rb
+- spec/g5_authentication_client/role_spec.rb
 - spec/g5_authentication_client/token_info_spec.rb
 - spec/g5_authentication_client/user_spec.rb
 - spec/g5_authentication_client_spec.rb
@@ -243,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: g5_authentication_client
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Client for the G5 Auth service