g5_authenticatable 0.9.1.pre.2 → 1.0.0.pre.1

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,28 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "active_model_serializers", "<= 0.10.0"
+gem "grape"
+gem "jquery-rails"
+gem "pg"
+gem "rails", "~> 5.1.1"
+
+group :test, :development do
+  gem "appraisal"
+  gem "dotenv-rails"
+  gem "pry-byebug"
+  gem "rspec-rails", "~> 3.6"
+  gem "web-console", "~> 2.0"
+end
+
+group :test do
+  gem "capybara"
+  gem "codeclimate-test-reporter"
+  gem "generator_spec"
+  gem "rspec-activemodel-mocks"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov", require: false
+end
+
+gemspec path: "../"

data/lib/g5_authenticatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'g5_authenticatable/engine'
 
 require 'devise_g5_authenticatable'
@@ -15,6 +17,6 @@ module G5Authenticatable
   def self.strict_token_validation=(validate)
     @@strict_token_validation =
       G5AuthenticatableApi.strict_token_validation =
-      Devise.g5_strict_token_validation = validate
+        Devise.g5_strict_token_validation = validate
   end
 end

data/lib/g5_authenticatable/engine.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'rolify'
 require 'pundit'
 
 module G5Authenticatable
+  # Rails engine for authentication/authorization against G5 Auth server
   class Engine < ::Rails::Engine
     isolate_namespace G5Authenticatable
 
@@ -11,8 +14,8 @@ module G5Authenticatable
       g.fixture_replacement :factory_girl, dir: 'spec/factories'
     end
 
-    initializer "g5_authenticatable.filter_access_token" do |app|
-      app.config.filter_parameters += [ :access_token ]
+    initializer 'g5_authenticatable.filter_access_token' do |app|
+      app.config.filter_parameters += [:access_token]
     end
   end
 end

data/lib/g5_authenticatable/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'g5_authenticatable/test/env_helpers'
 require 'g5_authenticatable/test/factory'
 require 'g5_authenticatable/test/token_validation_helpers'

data/lib/g5_authenticatable/test/controller_helpers.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module G5Authenticatable
   module Test
+    # Helper methods for controller tests
     module ControllerHelpers
       def login_user(user)
-        @request.env["devise.mapping"] = Devise.mappings[:user]
+        @request.env['devise.mapping'] = Devise.mappings[:user]
         sign_in user
       end
 
@@ -13,12 +16,12 @@ module G5Authenticatable
   end
 end
 
-shared_context 'auth controller', auth_controller: true do
+RSpec.shared_context 'auth controller' do
   let(:user) { FactoryGirl.create(:g5_authenticatable_user) }
   include_context 'authorization controller'
 end
 
-shared_context 'super admin auth controller' do
+RSpec.shared_context 'super admin auth controller' do
   let(:user) do
     user = FactoryGirl.create(:g5_authenticatable_user)
     user.add_role(:super_admin)
@@ -27,7 +30,7 @@ shared_context 'super admin auth controller' do
   include_context 'authorization controller'
 end
 
-shared_context 'admin auth controller' do
+RSpec.shared_context 'admin auth controller' do
   let(:user) do
     user = FactoryGirl.create(:g5_authenticatable_user)
     user.add_role(:admin)
@@ -36,7 +39,7 @@ shared_context 'admin auth controller' do
   include_context 'authorization controller'
 end
 
-shared_context 'authorization controller' do
+RSpec.shared_context 'authorization controller' do
   include G5Authenticatable::Test::ControllerHelpers
 
   before do
@@ -47,12 +50,12 @@ shared_context 'authorization controller' do
   after { logout_user(user) }
 end
 
-shared_examples 'a secure controller' do
+RSpec.shared_examples 'a secure controller' do
   controller do
-    before_filter :authenticate_user!
+    before_action :authenticate_user!
 
     def index
-      render text: 'content'
+      render plain: 'content'
     end
   end
 
@@ -72,6 +75,8 @@ shared_examples 'a secure controller' do
 end
 
 RSpec.configure do |config|
-  config.include Devise::TestHelpers, type: :controller
+  config.include Devise::Test::ControllerHelpers, type: :controller
   config.include G5Authenticatable::Test::ControllerHelpers, type: :controller
+
+  config.include_context 'auth controller', auth_controller: true
 end

data/lib/g5_authenticatable/test/env_helpers.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module G5Authenticatable
   module Test
+    # Helper methods for stubbing environment variables
     module EnvHelpers
       def stub_env_var(name, value)
         stub_const('ENV', ENV.to_hash.merge(name => value))

data/lib/g5_authenticatable/test/factories/client_users.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :g5_authenticatable_client_user, parent: :g5_authenticatable_user do
+    transient do
+      clients nil
+      client_count 1
+      role_factory :g5_authenticatable_client_role
+    end
+
+    after(:create) do |user, evaluator|
+      user.roles.clear
+
+      user.roles << if evaluator.clients
+                      evaluator.clients.collect do |client|
+                        create(evaluator.role_factory, resource: client)
+                      end
+                    else
+                      create_list(evaluator.role_factory,
+                                  evaluator.client_count)
+                    end
+    end
+  end
+
+  factory :g5_authenticatable_client_admin,
+          parent: :g5_authenticatable_client_user do
+    transient do
+      role_factory :g5_authenticatable_client_admin_role
+    end
+  end
+
+  factory :g5_authenticatable_client_editor,
+          parent: :g5_authenticatable_client_user do
+    transient do
+      role_factory :g5_authenticatable_client_editor_role
+    end
+  end
+
+  factory :g5_authenticatable_client_viewer,
+          parent: :g5_authenticatable_client_user do
+    transient do
+      role_factory :g5_authenticatable_client_viewer_role
+    end
+  end
+end

data/lib/g5_authenticatable/test/factories/global_users.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :g5_authenticatable_user, class: 'G5Authenticatable::User' do
+    sequence(:email) { |n| "test.user#{n}@test.host" }
+    provider 'g5'
+    sequence(:uid) { |n| "abc123-#{n}" }
+    sequence(:g5_access_token) { |n| "secret_token_#{n}" }
+    first_name 'Jane'
+    last_name 'Doe'
+    phone_number '(555) 867-5309'
+    title 'Minister of Funny Walks'
+    organization_name 'Department of Redundancy Department'
+  end
+
+  factory :g5_authenticatable_super_admin, parent: :g5_authenticatable_user do
+    after(:build) do |user|
+      user.roles.clear
+      user.roles << FactoryGirl.build(:g5_authenticatable_super_admin_role)
+    end
+  end
+
+  factory :g5_authenticatable_admin, parent: :g5_authenticatable_user do
+    after(:build) do |user|
+      user.roles.clear
+      user.roles << FactoryGirl.build(:g5_authenticatable_admin_role)
+    end
+  end
+
+  factory :g5_authenticatable_editor, parent: :g5_authenticatable_user do
+    after(:build) do |user|
+      user.roles.clear
+      user.roles << FactoryGirl.build(:g5_authenticatable_editor_role)
+    end
+  end
+
+  factory :g5_authenticatable_viewer, parent: :g5_authenticatable_user do
+    after(:build) do |user|
+      user.roles.clear
+      user.roles << FactoryGirl.build(:g5_authenticatable_viewer_role)
+    end
+  end
+end

data/lib/g5_authenticatable/test/factories/location_users.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :g5_authenticatable_location_user, parent: :g5_authenticatable_user do
+    transient do
+      locations nil
+      location_count 1
+      role_factory :g5_authenticatable_location_role
+    end
+
+    after(:create) do |user, evaluator|
+      user.roles.clear
+
+      user.roles << if evaluator.locations
+                      evaluator.locations.collect do |location|
+                        create(evaluator.role_factory, resource: location)
+                      end
+                    else
+                      user.roles << create_list(evaluator.role_factory,
+                                                evaluator.location_count)
+                    end
+    end
+  end
+
+  factory :g5_authenticatable_location_admin,
+          parent: :g5_authenticatable_location_user do
+    transient do
+      role_factory :g5_authenticatable_location_admin_role
+    end
+  end
+
+  factory :g5_authenticatable_location_editor,
+          parent: :g5_authenticatable_location_user do
+    transient do
+      role_factory :g5_authenticatable_location_editor_role
+    end
+  end
+
+  factory :g5_authenticatable_location_viewer,
+          parent: :g5_authenticatable_location_user do
+    transient do
+      role_factory :g5_authenticatable_location_viewer_role
+    end
+  end
+end

data/lib/g5_authenticatable/test/factories/roles.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :g5_authenticatable_role, class: 'G5Authenticatable::Role' do
+    sequence(:name) { |n| "role_#{n}" }
+  end
+
+  factory :g5_authenticatable_super_admin_role,
+          parent: :g5_authenticatable_role do
+    name 'super_admin'
+  end
+
+  factory :g5_authenticatable_admin_role, parent: :g5_authenticatable_role do
+    name 'admin'
+  end
+
+  factory :g5_authenticatable_editor_role, parent: :g5_authenticatable_role do
+    name 'editor'
+  end
+
+  factory :g5_authenticatable_viewer_role, parent: :g5_authenticatable_role do
+    name 'viewer'
+  end
+
+  factory :g5_authenticatable_client_role, parent: :g5_authenticatable_role do
+    association :resource, factory: :g5_updatable_client
+  end
+
+  factory :g5_authenticatable_client_admin_role,
+          parent: :g5_authenticatable_client_role do
+    name 'admin'
+  end
+
+  factory :g5_authenticatable_client_editor_role,
+          parent: :g5_authenticatable_client_role do
+    name 'editor'
+  end
+
+  factory :g5_authenticatable_client_viewer_role,
+          parent: :g5_authenticatable_client_role do
+    name 'viewer'
+  end
+
+  factory :g5_authenticatable_location_role,
+          parent: :g5_authenticatable_role do
+    association :resource, factory: :g5_updatable_location
+  end
+
+  factory :g5_authenticatable_location_admin_role,
+          parent: :g5_authenticatable_location_role do
+    name 'admin'
+  end
+
+  factory :g5_authenticatable_location_editor_role,
+          parent: :g5_authenticatable_location_role do
+    name 'editor'
+  end
+
+  factory :g5_authenticatable_location_viewer_role,
+          parent: :g5_authenticatable_location_role do
+    name 'viewer'
+  end
+end

data/lib/g5_authenticatable/test/factory.rb

@@ -1,60 +1,8 @@
-require 'factory_girl_rails'
-
-FactoryGirl.define do
-  factory :g5_authenticatable_user, class: 'G5Authenticatable::User' do
-    sequence(:email) { |n| "test.user#{n}@test.host" }
-    provider 'g5'
-    sequence(:uid) { |n| "abc123-#{n}" }
-    sequence(:g5_access_token) { |n| "secret_token_#{n}" }
-    first_name 'Jane'
-    last_name 'Doe'
-    phone_number '(555) 867-5309'
-    title 'Minister of Funny Walks'
-    organization_name 'Department of Redundancy Department'
-
-    after(:build) do |user|
-      user.roles << FactoryGirl.build(:g5_authenticatable_viewer_role)
-    end
-  end
-
-  factory :g5_authenticatable_super_admin, parent: :g5_authenticatable_user do
-    after(:build) do |user|
-      user.roles.clear
-      user.roles << FactoryGirl.build(:g5_authenticatable_super_admin_role)
-    end
-  end
-
-  factory :g5_authenticatable_admin, parent: :g5_authenticatable_user do
-    after(:build) do |user|
-      user.roles.clear
-      user.roles << FactoryGirl.build(:g5_authenticatable_admin_role)
-    end
-  end
-
-  factory :g5_authenticatable_editor, parent: :g5_authenticatable_user do
-    after(:build) do |user|
-      user.roles.clear
-      user.roles << FactoryGirl.build(:g5_authenticatable_editor_role)
-    end
-  end
+# frozen_string_literal: true
 
-  factory :g5_authenticatable_role, class: 'G5Authenticatable::Role' do
-    sequence(:name) { |n| "role_#{n}" }
-  end
-
-  factory :g5_authenticatable_super_admin_role, parent: :g5_authenticatable_role do
-    name 'super_admin'
-  end
-
-  factory :g5_authenticatable_admin_role, parent: :g5_authenticatable_role do
-    name 'admin'
-  end
-
-  factory :g5_authenticatable_editor_role, parent: :g5_authenticatable_role do
-    name 'editor'
-  end
-
-  factory :g5_authenticatable_viewer_role, parent: :g5_authenticatable_role do
-    name 'viewer'
-  end
-end
+require 'factory_girl_rails'
+require 'g5_updatable/factories'
+require 'g5_authenticatable/test/factories/roles'
+require 'g5_authenticatable/test/factories/global_users'
+require 'g5_authenticatable/test/factories/client_users'
+require 'g5_authenticatable/test/factories/location_users'

data/lib/g5_authenticatable/test/feature_helpers.rb

@@ -1,25 +1,16 @@
+# frozen_string_literal: true
+
 module G5Authenticatable
   module Test
+    # Helpers for feature specs
     module FeatureHelpers
-      def stub_g5_omniauth(user, options={})
+      def stub_g5_omniauth(user, options = {})
         OmniAuth.config.mock_auth[:g5] = OmniAuth::AuthHash.new({
           uid: user.uid,
           provider: 'g5',
-          info: {
-            email: user.email,
-            first_name: user.first_name,
-            last_name: user.last_name,
-            phone: user.phone_number
-          },
-          credentials: {token: user.g5_access_token},
-          extra: {
-            title: user.title,
-            organization_name: user.organization_name,
-            roles: user.roles.collect do |role|
-              {name: role.name, type: 'GLOBAL', urn: nil}
-            end,
-            raw_info: {}
-          }
+          info: basic_auth_info(user),
+          credentials: { token: user.g5_access_token },
+          extra: extra_auth_info(user)
         }.merge(options))
       end
 
@@ -32,11 +23,33 @@ module G5Authenticatable
         stub_valid_access_token(user.g5_access_token)
         visit path
       end
+
+      private
+
+      def basic_auth_info(user)
+        {
+          email: user.email,
+          first_name: user.first_name,
+          last_name: user.last_name,
+          phone: user.phone_number
+        }
+      end
+
+      def extra_auth_info(user)
+        {
+          title: user.title,
+          organization_name: user.organization_name,
+          roles: user.roles.collect do |role|
+            { name: role.name, type: 'GLOBAL', urn: nil }
+          end,
+          raw_info: {}
+        }
+      end
     end
   end
 end
 
-shared_context 'auth', auth: true do
+RSpec.shared_context 'auth' do
   include G5Authenticatable::Test::FeatureHelpers
 
   let(:user) { FactoryGirl.create(:g5_authenticatable_user) }
@@ -52,4 +65,5 @@ RSpec.configure do |config|
   config.after(:each) { OmniAuth.config.test_mode = false }
 
   config.include G5Authenticatable::Test::FeatureHelpers, type: :feature
+  config.include_context 'auth', auth: true
 end