devise_g5_authenticatable 0.3.0 → 1.0.0.pre.1

data/lib/devise_g5_authenticatable/hooks/g5_authenticatable.rb

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
+
 Warden::Manager.after_set_user only: :fetch do |record, warden, options|
   if Devise.g5_strict_token_validation
     scope = options[:scope]
 
-    auth_client = G5AuthenticationClient::Client.new(allow_password_credentials: 'false',
-                                                     access_token: record.g5_access_token)
+    auth_client = G5AuthenticationClient::Client.new(
+      allow_password_credentials: 'false',
+      access_token: record.g5_access_token
+    )
+
     begin
       auth_client.token_info
-    rescue StandardError => error
+    rescue StandardError
       proxy = Devise::Hooks::Proxy.new(warden)
       proxy.sign_out(record)
       record.revoke_g5_credentials!

data/lib/devise_g5_authenticatable/models/g5_authenticatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'devise_g5_authenticatable/g5'
 require 'devise_g5_authenticatable/hooks/g5_authenticatable'
 
@@ -22,19 +24,13 @@ module Devise
       end
 
       def auth_user
-        begin
-          if new_record?
-            G5::AuthUserCreator.new(self).create
-          else
-            G5::AuthUserUpdater.new(self).update
-          end
-        rescue OAuth2::Error => e
-          logger.error("Couldn't save user credentials because: #{e}")
-          raise ActiveRecord::RecordNotSaved.new(e.code)
-        rescue StandardError => e
-          logger.error("Couldn't save user credentials because: #{e}")
-          raise ActiveRecord::RecordNotSaved.new(e.message)
-        end
+        sync_auth_data
+      rescue OAuth2::Error => e
+        logger.error("Couldn't save user credentials because: #{e}")
+        raise ActiveRecord::RecordNotSaved, e.code
+      rescue StandardError => e
+        logger.error("Couldn't save user credentials because: #{e}")
+        raise ActiveRecord::RecordNotSaved, e.message
       end
 
       def clean_up_passwords
@@ -47,18 +43,14 @@ module Devise
       end
 
       def update_with_password(params)
-        updated_attributes = params.reject { |k,v| k =~ /password/ && v.blank? }
+        updated_attributes = params.reject do |k, v|
+          k =~ /password/ && v.blank?
+        end
         current_password = updated_attributes.delete(:current_password)
 
-        if valid = valid_password?(current_password)
-          valid = update_attributes(updated_attributes)
-        elsif current_password.blank?
-          errors.add(:current_password, :blank)
-        else
-          errors.add(:current_password, :invalid)
+        if valid_current_password?(current_password)
+          update_attributes(updated_attributes)
         end
-
-        valid
       end
 
       def update_g5_credentials(oauth_data)
@@ -78,8 +70,7 @@ module Devise
         }.with_indifferent_access
       end
 
-      def update_roles_from_auth(auth_data)
-      end
+      def update_roles_from_auth(auth_data); end
 
       def update_from_auth(auth_data)
         assign_attributes(attributes_from_auth(auth_data))
@@ -87,11 +78,31 @@ module Devise
         update_roles_from_auth(auth_data)
       end
 
+      private
+
+      def sync_auth_data
+        if new_record?
+          G5::AuthUserCreator.new(self).create
+        else
+          G5::AuthUserUpdater.new(self).update
+        end
+      end
+
+      def valid_current_password?(current_password)
+        return true if valid_password?(current_password)
+        error = current_password.blank? ? :blank : :invalid
+        errors.add(:current_password, error)
+        false
+      end
+
+      # Finders and creation methods based on auth user data
       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)
+          found_user = find_by_provider_and_uid(oauth_data.provider.to_s,
+                                                oauth_data.uid.to_s)
           return found_user if found_user.present?
-          find_by_email_and_provider(oauth_data.info.email, oauth_data.provider.to_s)
+          find_by_email_and_provider(oauth_data.info.email,
+                                     oauth_data.provider.to_s)
         end
 
         def find_and_update_for_g5_oauth(auth_data)
@@ -114,6 +125,7 @@ module Devise
         end
 
         private
+
         def without_auth_callback
           skip_callback :save, :before, :auth_user
           yield

data/lib/devise_g5_authenticatable/models/protected_attributes.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
   module Models
+    # Support protected attributes for users in apps that require it
     module ProtectedAttributes
       extend ActiveSupport::Concern
 
@@ -11,6 +14,12 @@ module DeviseG5Authenticatable
   end
 end
 
-module Devise::Models::G5Authenticatable
-  include DeviseG5Authenticatable::Models::ProtectedAttributes
+module Devise
+  module Models
+    # If this file is required, then protected attributes will be automatically
+    # mixed in to the g5 authenticatable model(s)
+    module G5Authenticatable
+      include DeviseG5Authenticatable::Models::ProtectedAttributes
+    end
+  end
 end

data/lib/devise_g5_authenticatable/omniauth.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 require 'devise/omniauth'
 require 'omniauth-g5'
 
 OmniAuth.config.on_failure do |env|
   env['devise.mapping'] = Devise::Mapping.find_by_path!(env['PATH_INFO'], :path)
-  controller_name  = ActiveSupport::Inflector.camelize(env['devise.mapping'].controllers[:sessions])
-  controller_klass = ActiveSupport::Inflector.constantize("#{controller_name}Controller")
+  controller_name = ActiveSupport::Inflector.camelize(
+    env['devise.mapping'].controllers[:sessions]
+  )
+  controller_klass = ActiveSupport::Inflector.constantize(
+    "#{controller_name}Controller"
+  )
   controller_klass.action(:failure).call(env)
 end

data/lib/devise_g5_authenticatable/routes.rb

@@ -1,58 +1,71 @@
+# frozen_string_literal: true
+
 module Devise
+  # Add custom G5 controllers to default routing options
   class Mapping
-    alias :original_initialize :initialize
+    alias original_initialize initialize
 
     def initialize(name, options)
-      set_default_g5_controllers(options)
+      setup_default_g5_controllers(options)
       original_initialize(name, options)
     end
 
     private
-    def set_default_g5_controllers(options)
+
+    def setup_default_g5_controllers(options)
       options[:controllers] ||= {}
-      options[:controllers].reverse_merge!({
+      options[:controllers].reverse_merge!(
         registrations: 'devise_g5_authenticatable/registrations',
         sessions: 'devise_g5_authenticatable/sessions'
-      })
+      )
       options
     end
   end
 end
 
-module ActionDispatch::Routing
-  class Mapper
-    protected
-    def devise_session(mapping, controllers)
-      set_omniauth_path_prefix(mapping)
-      build_session_routes(mapping, controllers)
-      build_g5_omniauth_routes(mapping, controllers)
-    end
+module ActionDispatch
+  module Routing
+    # Add G5 omniauth callbacks to set of routes
+    class Mapper
+      protected
 
-    def set_omniauth_path_prefix(mapping)
-      path_prefix = Devise.omniauth_path_prefix || "/#{mapping.fullpath}/auth".squeeze("/")
-      set_omniauth_path_prefix!(path_prefix) unless ::OmniAuth.config.path_prefix.present?
-    end
+      def devise_session(mapping, controllers)
+        setup_omniauth_path_prefix(mapping)
+        build_session_routes(mapping, controllers)
+        build_g5_omniauth_routes(mapping, controllers)
+      end
 
-    def build_session_routes(mapping, controllers)
-      resource :session, only: [], controller: controllers[:sessions], path: '' do
-        get   :new,     path: mapping.path_names[:sign_in], as: :new
-        post  :create,  path: mapping.path_names[:sign_in]
-        match :destroy, path: mapping.path_names[:sign_out], as: :destroy, via: mapping.sign_out_via
+      def setup_omniauth_path_prefix(mapping)
+        return if ::OmniAuth.config.path_prefix.present?
+        path_prefix = Devise.omniauth_path_prefix ||
+                      "/#{mapping.fullpath}/auth".squeeze('/')
+        set_omniauth_path_prefix!(path_prefix)
+      end
+
+      def build_session_routes(mapping, controllers)
+        resource(:session, only: [],
+                           controller: controllers[:sessions],
+                           path: '') do
+          get   :new,     path: mapping.path_names[:sign_in],
+                          as: :new
+          post  :create,  path: mapping.path_names[:sign_in]
+          match :destroy, path: mapping.path_names[:sign_out],
+                          as: :destroy,
+                          via: mapping.sign_out_via
+        end
       end
-    end
 
-    def build_g5_omniauth_routes(mapping, controllers)
-      match 'auth/g5',
-        controller: controllers[:sessions],
-        action: 'omniauth_passthru',
-        as: :g5_authorize,
-        via: [:get, :post]
-
-      match 'auth/g5/callback',
-        controller: controllers[:sessions],
-        action: 'create',
-        as: :g5_callback,
-        via: [:get, :post]
+      def build_g5_omniauth_routes(_mapping, controllers)
+        match 'auth/g5', controller: controllers[:sessions],
+                         action: 'omniauth_passthru',
+                         as: :g5_authorize,
+                         via: %i[get post]
+
+        match 'auth/g5/callback', controller: controllers[:sessions],
+                                  action: 'create',
+                                  as: :g5_callback,
+                                  via: %i[get post]
+      end
     end
   end
 end

data/lib/devise_g5_authenticatable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
-  VERSION = '0.3.0'
+  VERSION = '1.0.0-1'
 end

data/lib/devise_g5_authenticatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'devise_g5_authenticatable/version'
 
 require 'devise'
@@ -9,6 +11,7 @@ require 'devise_g5_authenticatable/controllers/url_helpers'
 
 require 'devise_g5_authenticatable/engine'
 
+# Custom devise configuration options
 module Devise
   # Should devise_g5_authenticatable validate the user's access token
   # against the auth server for every request? Default is false
@@ -19,6 +22,6 @@ end
 
 Devise.add_module(:g5_authenticatable,
                   strategy: false,
-                  route: {session: [nil, :new, :destroy]},
+                  route: { session: [nil, :new, :destroy] },
                   controller: :sessions,
                   model: 'devise_g5_authenticatable/models/g5_authenticatable')

data/spec/controllers/helpers_spec.rb

@@ -1,20 +1,22 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe DeviseG5Authenticatable::Helpers do
+require 'rails_helper'
+
+RSpec.describe DeviseG5Authenticatable::Helpers do
   controller(ActionController::Base) do
     include Devise::Controllers::Helpers
     include DeviseG5Authenticatable::Helpers
   end
 
   describe '#clear_blank_passwords' do
-    subject(:clear_passwords) { get :index, password_params }
+    subject(:clear_passwords) { get(:index, build_params(password_params)) }
     before { clear_passwords }
 
     controller do
-      before_filter :clear_blank_passwords, only: :index
+      before_action :clear_blank_passwords, only: :index
 
       def index
-        render status: 200, text: 'Index'
+        render status: 200, plain: 'Index'
       end
     end
 
@@ -36,24 +38,27 @@ describe DeviseG5Authenticatable::Helpers do
       let(:password_confirmation) { 'some_other_secret' }
       let(:current_password) { 'current_secret' }
 
+      let(:scope_params) { controller.params[scope] }
+
       context 'with user scope' do
         let(:scope) { :user }
 
         context 'with non-blank password params' do
           it 'should not change the password param' do
-            expect(controller.params[:user][:password]).to eq(password)
+            expect(scope_params[:password]).to eq(password)
           end
 
           it 'should not change the password_confirmation param' do
-            expect(controller.params[:user][:password_confirmation]).to eq(password_confirmation)
+            expect(scope_params[:password_confirmation])
+              .to eq(password_confirmation)
           end
 
           it 'should not change the current_password param' do
-            expect(controller.params[:user][:current_password]).to eq(current_password)
+            expect(scope_params[:current_password]).to eq(current_password)
           end
 
           it 'should not change the non-password param' do
-            expect(controller.params[:user][:email]).to eq(password_params[:user][:email])
+            expect(scope_params[:email]).to eq(password_params[:user][:email])
           end
         end
 
@@ -61,15 +66,16 @@ describe DeviseG5Authenticatable::Helpers do
           let(:password) {}
 
           it 'should set the password param to nil' do
-            expect(controller.params[:user][:password]).to be_nil
+            expect(scope_params[:password]).to be_nil
           end
 
           it 'should not change the password confirmation param' do
-            expect(controller.params[:user][:password_confirmation]).to eq(password_confirmation)
+            expect(scope_params[:password_confirmation])
+              .to eq(password_confirmation)
           end
 
           it 'should not change the current_password param' do
-            expect(controller.params[:user][:current_password]).to eq(current_password)
+            expect(scope_params[:current_password]).to eq(current_password)
           end
         end
 
@@ -77,15 +83,16 @@ describe DeviseG5Authenticatable::Helpers do
           let(:password) { '                ' }
 
           it 'should set the password param to nil' do
-            expect(controller.params[:user][:password]).to be_nil
+            expect(scope_params[:password]).to be_nil
           end
 
           it 'should not change the password confirmation param' do
-            expect(controller.params[:user][:password_confirmation]).to eq(password_confirmation)
+            expect(scope_params[:password_confirmation])
+              .to eq(password_confirmation)
           end
 
           it 'should not change the current_password param' do
-            expect(controller.params[:user][:current_password]).to eq(current_password)
+            expect(scope_params[:current_password]).to eq(current_password)
           end
         end
 
@@ -93,15 +100,15 @@ describe DeviseG5Authenticatable::Helpers do
           let(:password_confirmation) {}
 
           it 'should not change the password param' do
-            expect(controller.params[:user][:password]).to eq(password)
+            expect(scope_params[:password]).to eq(password)
           end
 
           it 'should set the password_confirmation param to nil' do
-            expect(controller.params[:user][:password_confirmation]).to be_nil
+            expect(scope_params[:password_confirmation]).to be_nil
           end
 
           it 'should not change the current_password param' do
-            expect(controller.params[:user][:current_password]).to eq(current_password)
+            expect(scope_params[:current_password]).to eq(current_password)
           end
         end
 
@@ -109,15 +116,15 @@ describe DeviseG5Authenticatable::Helpers do
           let(:password_confirmation) { '      ' }
 
           it 'should not change the password param' do
-            expect(controller.params[:user][:password]).to eq(password)
+            expect(scope_params[:password]).to eq(password)
           end
 
           it 'should set the password_confirmation param to nil' do
-            expect(controller.params[:user][:password_confirmation]).to be_nil
+            expect(scope_params[:password_confirmation]).to be_nil
           end
 
           it 'should not change the current_password param' do
-            expect(controller.params[:user][:current_password]).to eq(current_password)
+            expect(scope_params[:current_password]).to eq(current_password)
           end
         end
 
@@ -125,15 +132,16 @@ describe DeviseG5Authenticatable::Helpers do
           let(:current_password) {}
 
           it 'should not change the password param' do
-            expect(controller.params[:user][:password]).to eq(password)
+            expect(scope_params[:password]).to eq(password)
           end
 
           it 'should not change the password_confirmation param' do
-            expect(controller.params[:user][:password_confirmation]).to eq(password_confirmation)
+            expect(scope_params[:password_confirmation])
+              .to eq(password_confirmation)
           end
 
           it 'should set the current password param to nil' do
-            expect(controller.params[:user][:current_password]).to be_nil
+            expect(scope_params[:current_password]).to be_nil
           end
         end
 
@@ -141,15 +149,16 @@ describe DeviseG5Authenticatable::Helpers do
           let(:current_password) { '   ' }
 
           it 'should not change the password param' do
-            expect(controller.params[:user][:password]).to eq(password)
+            expect(scope_params[:password]).to eq(password)
           end
 
           it 'should not change the password_confirmation param' do
-            expect(controller.params[:user][:password_confirmation]).to eq(password_confirmation)
+            expect(scope_params[:password_confirmation])
+              .to eq(password_confirmation)
           end
 
           it 'should set the current password param to nil' do
-            expect(controller.params[:user][:current_password]).to be_nil
+            expect(scope_params[:current_password]).to be_nil
           end
         end
       end
@@ -161,7 +170,7 @@ describe DeviseG5Authenticatable::Helpers do
           let(:password) { '              ' }
 
           it 'should set the admin password param to nil' do
-            expect(controller.params[:admin][:password]).to be_nil
+            expect(scope_params[:password]).to be_nil
           end
         end
 
@@ -169,7 +178,7 @@ describe DeviseG5Authenticatable::Helpers do
           let(:password_confirmation) { '     ' }
 
           it 'should set the admin password confirmation to nil' do
-            expect(controller.params[:admin][:password_confirmation]).to be_nil
+            expect(scope_params[:password_confirmation]).to be_nil
           end
         end
 
@@ -177,14 +186,14 @@ describe DeviseG5Authenticatable::Helpers do
           let(:current_password) { '   ' }
 
           it 'should set the admin current password param to nil' do
-            expect(controller.params[:admin][:current_password]).to be_nil
+            expect(scope_params[:current_password]).to be_nil
           end
         end
       end
     end
 
     context 'when there are no password params' do
-      let(:password_params) { Hash.new }
+      let(:password_params) { {} }
 
       it 'should not change any params' do
         expect(controller.params[:user]).to be_nil
@@ -193,26 +202,26 @@ describe DeviseG5Authenticatable::Helpers do
   end
 
   describe '#set_updated_by_user' do
-    subject(:set_updated_by_user) { post :create, user_params }
+    subject(:set_updated_by_user) { post(:create, build_params(user_params)) }
 
     controller do
       define_helpers(:user)
       define_helpers(:admin)
 
-      before_filter :set_updated_by_user, only: :create
+      before_action :set_updated_by_user, only: :create
 
       def create
-        render status: 200, text: 'Create'
+        render status: 200, plain: 'Create'
       end
     end
 
-    before { sign_in :user, current_user }
+    before { sign_in(current_user, scope: :user) }
     let(:current_user) { create(:user) }
 
     before { set_updated_by_user }
 
     context 'when there is a user param' do
-      let(:user_params) { {user: attributes_for(:user)} }
+      let(:user_params) { { user: attributes_for(:user) } }
 
       it 'should set the user updated_by' do
         expect(controller.params[:user][:updated_by]).to eq(current_user)
@@ -220,7 +229,7 @@ describe DeviseG5Authenticatable::Helpers do
     end
 
     context 'when there is no user param' do
-      let(:user_params) { Hash.new }
+      let(:user_params) { {} }
 
       it 'should set the updated_by' do
         expect(controller.params[:updated_by]).to eq(current_user)
@@ -229,26 +238,26 @@ describe DeviseG5Authenticatable::Helpers do
   end
 
   describe '#set_updated_by_admin' do
-    subject(:set_updated_by_admin) { post :create, admin_params }
+    subject(:set_updated_by_admin) { post(:create, build_params(admin_params)) }
 
     controller do
       define_helpers(:user)
       define_helpers(:admin)
 
-      before_filter :set_updated_by_admin, only: :create
+      before_action :set_updated_by_admin, only: :create
 
       def create
-        render status: 200, text: 'Create'
+        render status: 200, plain: 'Create'
       end
     end
 
-    before { sign_in :admin, current_admin }
+    before { sign_in(current_admin, scope: :admin) }
     let(:current_admin) { create(:admin) }
 
     before { set_updated_by_admin }
 
     context 'when there is an admin param' do
-      let(:admin_params) { {admin: attributes_for(:admin)} }
+      let(:admin_params) { { admin: attributes_for(:admin) } }
 
       it 'should set the admin updated_by' do
         expect(controller.params[:admin][:updated_by]).to eq(current_admin)
@@ -256,7 +265,7 @@ describe DeviseG5Authenticatable::Helpers do
     end
 
     context 'when there is no admin param' do
-      let(:admin_params) { Hash.new }
+      let(:admin_params) { {} }
 
       it 'should set the updated_by' do
         expect(controller.params[:updated_by]).to eq(current_admin)
@@ -265,7 +274,7 @@ describe DeviseG5Authenticatable::Helpers do
   end
 
   describe '#handle_resource_error' do
-    subject(:action_with_error) { post :create }
+    subject(:action_with_error) { post(:create) }
 
     before { request.env['devise.mapping'] = Devise.mappings[:user] }
 
@@ -274,7 +283,7 @@ describe DeviseG5Authenticatable::Helpers do
 
       def create
         self.resource = resource_class.new
-        raise ActiveRecord::RecordNotSaved.new('my_error')
+        raise ActiveRecord::RecordNotSaved, 'my_error'
       end
 
       # Expose protected resource helper for the purposes of this unit test
@@ -292,9 +301,5 @@ describe DeviseG5Authenticatable::Helpers do
     it 'should set the base error on the resource' do
       expect(controller.resource.errors[:base]).to eq(['my_error'])
     end
-
-    it 'should render the model creation form' do
-      expect(response).to render_template('anonymous/new')
-    end
   end
 end