g5_authentication_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f1b72b556d88ccf5d3db877677efbbd8f969c1b
-  data.tar.gz: 21a75a23db8b2e8106999de8e481923701fd9fad
+  metadata.gz: be1c6787c15da921ae231923ddfc0f5a25cca85c
+  data.tar.gz: 1009843592202ef3931935186427c5a7e9f1c26e
 SHA512:
-  metadata.gz: 5eb630f56608ad0dda5705d63ee64c9cba567621220c37b7459239c7755d9b4ee3c2bcb12bc36919ee05653ed8073e644773604684f784c662ac3b38a5bfb27a
-  data.tar.gz: b216905352a09469399fa36194e8973cca41a22cb715d810a64af6792b66d75e74469119c4cb2cfcbe325ff1d5c579c42fcf84bd69439b4cc15238ad1afafcd7
+  metadata.gz: 0347cb1540549a6e5b8413a37ad09014f81ebd9c7fa9360043343e0f8146eefdc6f473241e9b7d4f6133e4bac830de7f201b85eac6b89b0e879afab725c4b730
+  data.tar.gz: 0d24eed79d02d968579eb2c10860906b663a5180033cd831abc876d44273a81767ba33d0b2606872cca4ff8ab552e14b3cf615898c9f09d575fb11b8ea34c905

data/.gitignore

@@ -7,3 +7,4 @@ pkg/*
 doc/*
 .yardoc
 coverage
+.idea

data/lib/g5_authentication_client/client.rb

@@ -98,7 +98,8 @@ module G5AuthenticationClient
     def create_user(options={})
       user=User.new(options)
       user.validate_for_create!
-      response=oauth_access_token.post('/v1/users', body: user_hash(user.to_hash))
+      body = user_hash(user.to_hash)
+      response=oauth_access_token.post('/v1/users', body: body)
       User.new(response.parsed)
     end
 

data/lib/g5_authentication_client/role.rb

@@ -5,9 +5,27 @@ module G5AuthenticationClient
   class Role < Modelish::Base
     ignore_unknown_properties!
 
+    GLOBAL = 'GLOBAL'
+
     # @!attribute [rw] name
     #   @return [String]
     #   The name associated with this user role
     property :name, type: String, required: true
+
+    # @!attribute [rw] type
+    #   @return [String]
+    #   The role's type. If 'GLOBAL' then not role not associated with a resource
+    property :type, type: String, required: true
+
+    # @!attribute [rw] urn
+    #   @return [String]
+    #   The role's resource urn. Will be nil if type='GLOBAL'
+    property :urn, type: String
+
+    def validate_for_create!
+      validate!
+      raise ArgumentError.new("URN required when type != '#{GLOBAL}'") if urn.nil? && type != GLOBAL
+    end
+
   end
 end

data/lib/g5_authentication_client/user.rb

@@ -55,8 +55,17 @@ module G5AuthenticationClient
     #   @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? } }
+      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!

data/lib/g5_authentication_client/version.rb

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

data/spec/g5_authentication_client/client_spec.rb

@@ -43,29 +43,31 @@ describe G5AuthenticationClient::Client do
     {email: email,
     password: "#{password}x",
     id: user_id,
-    roles: [{name: role_name}]}
+    roles: [{name: role_name, urn: role_urn, type: role_type}]}
   end
 
   let(:new_user_request) do
     {
-      "email"=>email,
-      "first_name"=>"",
-      "last_name"=>"",
-      "organization_name"=>"",
-      "password"=>"#{password}x",
-      "password_confirmation"=>"",
-      "phone_number"=>"",
-      "title"=>"",
-      "roles"=>["name"=>role_name]
+      'email'=>email,
+      'first_name'=>'',
+      'last_name'=>'',
+      'organization_name'=>'',
+      'password'=>"#{password}x",
+      'password_confirmation'=>'',
+      'phone_number'=>'',
+      'title'=>'',
+      'roles'=>['name'=>role_name,'urn'=> role_urn, 'type'=>role_type]
     }
   end
 
   let(:email){'foo@blah.com'}
   let(:password){'mybigtestpasswored'}
   let(:user_id){1}
-  let(:role_name) { 'my_role' }
+  let(:role_name) { 'my_role_1' }
+  let(:role_type) { 'G5Updatable::Client1' }
+  let(:role_urn) { 'someurn1' }
   let(:returned_user){{id: user_id,email: email,roles:[returned_role]}}
-  let(:returned_role) { {'name' => role_name} }
+  let(:returned_role) { {'name' => role_name, 'type' => role_type, 'urn' => role_urn} }
 
   context 'with default configuration' do
     subject(:client) { G5AuthenticationClient::Client.new }
@@ -291,13 +293,19 @@ describe G5AuthenticationClient::Client do
 
     before do
       stub_request(:post, "#{endpoint}/v1/users").
-        with(:body => {"user"=>new_user_request}, headers: {'Authorization' => auth_header_value}).
         to_return(status: 200,
                   body: returned_user.to_json,
                   headers: {'Content-Type' => 'application/json'})
     end
 
     it_should_behave_like 'an oauth protected resource', G5AuthenticationClient::User
+
+    it 'will have the appropriate body and Authorization header' do
+      create_user
+      expect(a_request(:post, "#{endpoint}/v1/users").
+               with(body: Faraday::NestedParamsEncoder.encode({'user'=>new_user_request}), headers: {'Authorization' => auth_header_value})).
+        to have_been_made.once
+    end
   end
 
   describe '#update_user' do
@@ -305,13 +313,19 @@ describe G5AuthenticationClient::Client do
 
     before do
       stub_request(:put, /#{endpoint}\/v1\/users\/#{user_id}/).
-        with(:body => { "user" => new_user_request }, headers: {'Authorization' => auth_header_value}).
         to_return(status: 200,
                   body: returned_user.to_json,
                   headers: {'Content-Type' => 'application/json'})
     end
 
     it_should_behave_like 'an oauth protected resource', G5AuthenticationClient::User
+
+    it 'will have the appropriate body and Authorization header' do
+      update_user
+      expect(a_request(:put, /#{endpoint}\/v1\/users\/#{user_id}/).
+               with(body: Faraday::NestedParamsEncoder.encode({'user'=>new_user_request}), headers: {'Authorization' => auth_header_value})).
+        to have_been_made.once
+    end
   end
 
   describe '#find_user_by_email' do

data/spec/g5_authentication_client/role_spec.rb

@@ -3,8 +3,16 @@ require 'spec_helper'
 describe G5AuthenticationClient::Role do
   subject(:role) { G5AuthenticationClient::Role.new(attributes) }
 
-  let(:attributes) { {name: name} }
+  let(:attributes) do {
+    name: name,
+    type: type,
+    urn: urn,
+  }
+  end
+
   let(:name) { 'awesome_role' }
+  let(:type) { 'SomeClass' }
+  let(:urn)  { 'some_urn' }
 
   context 'with default initialization' do
     let(:attributes) {}
@@ -12,12 +20,24 @@ describe G5AuthenticationClient::Role do
     it 'should have a nil name' do
       expect(role.name).to be_nil
     end
+    it 'has a nil type' do
+      expect(role.type).to be_nil
+    end
+    it 'has a nil urn' do
+      expect(role.urn).to be_nil
+    end
   end
 
   context 'with full initialization' do
     it 'should have the correct name' do
       expect(role.name).to eq(name)
     end
+    it 'should have the correct name' do
+      expect(role.type).to eq(type)
+    end
+    it 'should have the correct name' do
+      expect(role.urn).to eq(urn)
+    end
   end
 
   context 'when attributes include unknown properties' do
@@ -54,6 +74,41 @@ describe G5AuthenticationClient::Role do
     end
   end
 
+  describe '#validate_for_create!' do
+    subject(:validate_for_create) {role.validate_for_create!}
+
+    context 'when type not GLOBAL and no urn' do
+
+      let(:type) { 'not_global' }
+      let(:urn) {  }
+
+      it 'will raise an error' do
+        expect { validate_for_create }.to raise_error
+      end
+    end
+
+    context 'when type GLOBAL and no urn' do
+
+      let(:type) { 'GLOBAL' }
+      let(:urn) {  }
+
+      it 'will raise an error' do
+        expect { validate_for_create }.to_not raise_error
+      end
+    end
+
+    context 'when type not GLOBAL and existing urn' do
+
+      let(:type) { 'NOT_GLOBAL' }
+      let(:urn) { 'some_urn' }
+
+      it 'will raise an error' do
+        expect { validate_for_create }.to_not raise_error
+      end
+    end
+
+  end
+
   describe '#to_hash' do
     subject(:hash) { role.to_hash }
 

data/spec/g5_authentication_client/user_spec.rb

@@ -13,7 +13,7 @@ describe G5AuthenticationClient::User do
       title: title,
       organization_name: organization_name,
       phone_number: phone_number,
-      roles: [{name: role_name}]
+      roles: [{name: role_name, type:'G5Updatable::Client', urn:'someurn'}]
     }
   end
 
@@ -243,7 +243,7 @@ describe G5AuthenticationClient::User do
     end
 
     it 'should have roles' do
-      expect(to_hash['roles']).to eq([{'name' => role_name}])
+      expect(to_hash['roles']).to eq([{'name' => role_name, 'type'=>'G5Updatable::Client', 'urn'=>'someurn'}])
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: g5_authentication_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rob Revels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modelish
@@ -246,9 +246,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: g5_authentication_client
-rubygems_version: 2.2.3
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Client for the G5 Auth service
-test_files: []
+test_files:
+- 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
+- spec/spec_helper.rb
+- spec/support/module_configured_attribute.rb
+- spec/support/oauth_protected_resource.rb
 has_rdoc: