devise_g5_authenticatable 0.2.5.beta → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50829287e8871d3c12f9c20a23798e441494cbf7
-  data.tar.gz: 8583f26f7ca2bde0128c1d1a4ce6693b5b445a6f
+  metadata.gz: 77d88c2b75b20608b04708cd0ce1d48f90a0c6ee
+  data.tar.gz: 470beef996c9d67de0dee57eaf7efaf5e009034a
 SHA512:
-  metadata.gz: 7bc55fcc451cea4aa8438a23c819205e0ca1f7cc1a6d6f447a2df027c4ec82a6fa785c9956934be06fe77bbeaf828e259c90ed817d0cfda2cf6de5b20ec21a46
-  data.tar.gz: 58a7e018f019c6c8d613ac5c51f405f898506be23e7a65e296fcdad6a4edca6ccdb9e1da0f4113a0217265f77d2facce352cc578e020f551679130cc6751a074
+  metadata.gz: 58013eb741a22fe0bf9bd388aee212596b4257a2a73aca75870c60f248d171c92afb37b595c9530eefcb4f6dfb4e5575862f3919e8bb929b4c525027aa808e32
+  data.tar.gz: 90df8abd423ddff26f7cf60bd7cdfc4eb0957ac07981beb96fa6ef37f505488c87ac6f945ad4bd69af9c0dda73403e0b9ea5036767121a906c2a90b7aca45329

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
+before_install:
+  - gem update bundler
 script:
   - RAILS_ENV=test bundle exec rake app:db:setup
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.3.0 (2016-11-03)
+
+* Exposes callbacks for more fine-grained control over mapping auth user
+  data and roles to local models
+  ([#25](https://github.com/G5/devise_g5_authenticatable/pull/25))
+
 ## v0.2.4 (2015-12-09)
 * Same as v0.2.4.beta but not is a stable version!
 

data/Gemfile

@@ -12,7 +12,7 @@ gem 'protected_attributes'
 group :test, :development do
   gem 'rspec-rails', '~> 2.14'
   gem 'rspec-activemodel-mocks'
-  gem 'pry'
+  gem 'pry-byebug'
 end
 
 group :test do

data/README.md

@@ -10,11 +10,11 @@ G5 users.
 
 ## Current Version
 
-0.2.4
+0.3.0
 
 ## Requirements
 
-* [Ruby](https://github.com/ruby/ruby) >= 1.9.3
+* [Ruby](https://github.com/ruby/ruby) >= 2.0.0
 * [Rails](https://github.com/rails/rails) >= 3.2
 * [Devise](https://github.com/plataformatec/devise) ~> 3.5
 
@@ -150,6 +150,45 @@ class User < ActiveRecord::Base
 end
 ```
 
+Several callbacks are provided in order to hook in your application-specific
+logic for mapping the auth data to your User model. These methods will be
+executed whenever a user logs in.
+
+In order to set simple user attributes based on auth data, override the
+`attributes_from_auth` method. Call `super` when you do so in order to pick
+up the minimum set of required user attributes:
+
+```ruby
+class User < ActiveRecord::Base
+  devise :g5_authenticatable
+
+  def attributes_from_auth(auth_data)
+    super(auth_data).merge({
+      name: "#{auth_data.info.first_name} #{auth_data.info.last_name}"
+    })
+  end
+end
+```
+
+If you want to customize the logic for mapping auth role data (which is
+ignored by default), override the `update_roles_from_auth` method:
+
+```ruby
+class User < ActiveRecord::Base
+  devise :g5_authenticatable
+
+  def update_roles_from_auth(auth_data)
+    auth_data.extra.roles.each do |r|
+      # Your custom logic here, for example...
+      add_role(role.name, role.type, role.urn)
+    end
+  end
+end
+```
+
+See the [omniauth-g5 documentation](https://github.com/G5/omniauth-g5#auth-hash)
+for the structure of the auth data.
+
 ### Configuring a custom controller
 
 You can use `devise_for` to hook in a custom controller in your routes,

data/devise_g5_authenticatable.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
 
   # Pinned to version 3.5.1 due https://github.com/plataformatec/devise/issues/3705
   # "`FailureApp`s `script_name: nil` breaks route generation within mounted engines #3705"
-  spec.add_dependency 'devise', '= 4.1.1'
-  spec.add_dependency 'g5_authentication_client', '~> 0.5'
+  spec.add_dependency 'devise', '= 3.5.1'
+  spec.add_dependency 'g5_authentication_client', '~> 0.5', '>= 0.5.4'
 
   # Pinned to version 0.3.1 due https://github.com/G5/omniauth-g5/pull/10
   # Omniauth-auth2 removed 'callback_url' which broke our auth workflow

data/lib/devise_g5_authenticatable/models/g5_authenticatable.rb

@@ -70,6 +70,23 @@ module Devise
         save!
       end
 
+      def attributes_from_auth(auth_data)
+        {
+          uid: auth_data.uid,
+          provider: auth_data.provider,
+          email: auth_data.info.email
+        }.with_indifferent_access
+      end
+
+      def update_roles_from_auth(auth_data)
+      end
+
+      def update_from_auth(auth_data)
+        assign_attributes(attributes_from_auth(auth_data))
+        update_g5_credentials(auth_data)
+        update_roles_from_auth(auth_data)
+      end
+
       module ClassMethods
         def find_for_g5_oauth(oauth_data)
           found_user = find_by_provider_and_uid(oauth_data.provider.to_s, oauth_data.uid.to_s)
@@ -77,24 +94,30 @@ module Devise
           find_by_email_and_provider(oauth_data.info.email, oauth_data.provider.to_s)
         end
 
-        def find_and_update_for_g5_oauth(oauth_data)
-          resource = find_for_g5_oauth(oauth_data)
+        def find_and_update_for_g5_oauth(auth_data)
+          resource = find_for_g5_oauth(auth_data)
           if resource
-            resource.update_g5_credentials(oauth_data)
-            resource.save!
+            resource.update_from_auth(auth_data)
+            without_auth_callback { resource.save! }
           end
           resource
         end
 
         def new_with_session(params, session)
-          defaults = ActiveSupport::HashWithIndifferentAccess.new
-          if auth_data = session && session['omniauth.auth']
-            defaults[:email] = auth_data.info.email
-            defaults[:provider] = auth_data.provider
-            defaults[:uid] = auth_data.uid
-          end
+          auth_data = session && session['omniauth.auth']
+
+          resource = new
+          resource.update_from_auth(auth_data) if auth_data.present?
+          resource.assign_attributes(params) unless params.empty?
+
+          resource
+        end
 
-          new(defaults.merge(params))
+        private
+        def without_auth_callback
+          skip_callback :save, :before, :auth_user
+          yield
+          set_callback :save, :before, :auth_user
         end
       end
     end

data/lib/devise_g5_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DeviseG5Authenticatable
-  VERSION = '0.2.5.beta'
+  VERSION = '0.3.0'
 end

data/spec/models/g5_authenticatable_spec.rb

@@ -350,12 +350,28 @@ describe Devise::Models::G5Authenticatable do
         model.reload
         expect(model.g5_access_token).to eq(auth_data.credentials.token)
       end
+
+      it 'should save the updated email' do
+        find_and_update
+        model.reload
+        expect(model.email).to eq(auth_data.info.email)
+      end
+
+      it 'executes the callback to update role data' do
+        expect_any_instance_of(model_class).to receive(:update_roles_from_auth).with(auth_data)
+        find_and_update
+      end
     end
 
     context 'when model does not exist' do
       it 'should return nothing' do
         expect(find_and_update).to be_nil
       end
+
+      it 'does not execute the callback to update role data' do
+        expect_any_instance_of(model_class).to_not receive(:update_roles_from_auth)
+        find_and_update
+      end
     end
   end
 
@@ -511,6 +527,8 @@ describe Devise::Models::G5Authenticatable do
                              credentials: { token: 'abc123' })
     end
 
+    before { allow_any_instance_of(model_class).to receive(:update_roles_from_auth) }
+
     context 'with params' do
       let(:params) do
         { 'email' => email_param }
@@ -533,6 +551,10 @@ describe Devise::Models::G5Authenticatable do
         it 'should set the uid from the session' do
           expect(new_with_session.uid).to eq(auth_data.uid)
         end
+
+        it 'executes the callback to update role data' do
+          expect(new_with_session).to have_received(:update_roles_from_auth).with(auth_data)
+        end
       end
 
       context 'without session data' do
@@ -551,6 +573,11 @@ describe Devise::Models::G5Authenticatable do
         it 'should not set the uid' do
           expect(new_with_session.uid).to be_nil
         end
+
+        it 'should not execute the callback to update role data' do
+          expect_any_instance_of(model_class).not_to receive(:update_roles_from_auth)
+          new_with_session
+        end
       end
     end
 
@@ -575,6 +602,10 @@ describe Devise::Models::G5Authenticatable do
         it 'should set the uid from the session' do
           expect(new_with_session.uid).to eq(auth_data.uid)
         end
+
+        it 'executes the callback to update role data' do
+          expect(new_with_session).to have_received(:update_roles_from_auth).with(auth_data)
+        end
       end
 
       context 'without session data' do
@@ -593,7 +624,56 @@ describe Devise::Models::G5Authenticatable do
         it 'should not set the uid' do
           expect(new_with_session.uid).to be_nil
         end
+
+        it 'does not execute the callback to update role data' do
+          expect_any_instance_of(model_class).not_to receive(:update_roles_from_auth)
+          new_with_session
+        end
       end
     end
   end
+
+  describe '#attributes_from_auth' do
+    subject(:attributes_from_auth) { model.attributes_from_auth(auth_data) }
+
+    let(:auth_data) do
+      OmniAuth::AuthHash.new(provider:    'g5',
+                             uid:         '123999',
+                             info:        { first_name: 'Foo',
+                                            last_name: 'Bar',
+                                            email: 'foo@bar.com',
+                                            phone: '123-555-1212 x42'},
+                             credentials: { token: 'abc123' },
+                             extra: { title: 'Minister of Funny Walks',
+                                      organization_name: 'Dept of Redundancy Dept' })
+    end
+
+    it 'has the correct uid' do
+      expect(attributes_from_auth[:uid]).to eq(auth_data.uid)
+    end
+
+    it 'has the correct provider' do
+      expect(attributes_from_auth[:provider]).to eq(auth_data.provider)
+    end
+
+    it 'has the correct email' do
+      expect(attributes_from_auth[:email]).to eq(auth_data.info.email)
+    end
+  end
+
+  describe '#update_roles_from_auth' do
+    subject(:update_roles) { model.update_roles_from_auth(auth_data) }
+
+    let(:auth_data) do
+      OmniAuth::AuthHash.new(provider: 'g5',
+                             uid: '123456',
+                             extra: { roles: [
+                               { name: 'Admin', type: 'GLOBAL', urn: nil }
+                             ]})
+    end
+
+    it 'does not change anything on the model' do
+      expect { update_roles }.to_not change { model }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_g5_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.2.5.beta
+  version: 0.3.0
 platform: ruby
 authors:
 - Maeve Revels
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 3.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: g5_authentication_client
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: omniauth-g5
   requirement: !ruby/object:Gem::Requirement
@@ -194,12 +200,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Devise extension for the G5 Auth service