devise_g5_authenticatable 0.3.0 → 1.0.0.pre.1

data/spec/g5/auth_user_updater_spec.rb

@@ -1,12 +1,17 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Devise::G5::AuthUserUpdater do
+require 'rails_helper'
+
+RSpec.describe Devise::G5::AuthUserUpdater do
   let(:updater) { described_class.new(model) }
 
-  let(:auth_client) { double(:g5_authentication_client, update_user: auth_user) }
+  let(:auth_client) do
+    double(:g5_authentication_client, update_user: auth_user)
+  end
   let(:auth_user) { double(:auth_user, id: model.uid, email: model.email) }
   before do
-    allow(G5AuthenticationClient::Client).to receive(:new).and_return(auth_client)
+    allow(G5AuthenticationClient::Client).to receive(:new)
+      .and_return(auth_client)
   end
 
   let(:model) { create(:user, updated_by: updated_by) }
@@ -28,7 +33,6 @@ describe Devise::G5::AuthUserUpdater do
       before { model.email = updated_email }
       let(:updated_email) { 'updated.email@test.host' }
 
-
       context 'when user has been updated by another user' do
         let(:updated_by) { create(:user) }
 
@@ -36,13 +40,13 @@ describe Devise::G5::AuthUserUpdater do
           before { update }
 
           it 'should use the token for updated_by to call g5 auth' do
-            expect(G5AuthenticationClient::Client).to have_received(:new).
-              with(access_token: updated_by.g5_access_token)
+            expect(G5AuthenticationClient::Client).to have_received(:new)
+              .with(access_token: updated_by.g5_access_token)
           end
 
           it 'should update the email' do
-            expect(auth_client).to have_received(:update_user).
-              with(hash_including(email: updated_email))
+            expect(auth_client).to have_received(:update_user)
+              .with(hash_including(email: updated_email))
           end
 
           it 'should reset the password' do
@@ -64,7 +68,7 @@ describe Devise::G5::AuthUserUpdater do
           end
 
           it 'should raise an exception' do
-            expect { update }.to raise_error
+            expect { update }.to raise_error('Error!')
           end
         end
       end
@@ -73,8 +77,8 @@ describe Devise::G5::AuthUserUpdater do
         before { update }
 
         it 'should use the user token to call g5 auth' do
-          expect(G5AuthenticationClient::Client).to have_received(:new).
-            with(access_token: model.g5_access_token)
+          expect(G5AuthenticationClient::Client).to have_received(:new)
+            .with(access_token: model.g5_access_token)
         end
       end
     end
@@ -91,14 +95,17 @@ describe Devise::G5::AuthUserUpdater do
       before { update }
 
       it 'should update the password' do
-        expect(auth_client).to have_received(:update_user).
-          with(hash_including(password: updated_password))
+        expect(auth_client).to have_received(:update_user)
+          .with(hash_including(password: updated_password))
         update
       end
 
       it 'should update the password_confirmation' do
-        expect(auth_client).to have_received(:update_user).
-          with(hash_including(password_confirmation: updated_password_confirmation))
+        updated_attribute = {
+          password_confirmation: updated_password_confirmation
+        }
+        expect(auth_client).to have_received(:update_user)
+          .with(hash_including(updated_attribute))
       end
 
       it 'should reset the password' do

data/spec/g5/user_exporter_spec.rb

@@ -1,14 +1,16 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe G5::UserExporter do
+require 'rails_helper'
+
+RSpec.describe G5::UserExporter do
   let(:exporter) { G5::UserExporter.new(options) }
 
   let(:options) do
-    {client_id: 'my_client_id',
-     client_secret: 'soopersekrit',
-     redirect_uri: 'https://app.host/my/callback',
-     endpoint: 'https://auth.host',
-     authorization_code: 'abc123'}
+    { client_id: 'my_client_id',
+      client_secret: 'soopersekrit',
+      redirect_uri: 'https://app.host/my/callback',
+      endpoint: 'https://auth.host',
+      authorization_code: 'abc123' }
   end
 
   describe '#export' do
@@ -31,55 +33,56 @@ describe G5::UserExporter do
     let(:auth_user) { double(:auth_user, id: uid, email: email) }
     let(:auth_client) { double(:auth_client, create_user: auth_user) }
     before do
-      allow(G5AuthenticationClient::Client).to receive(:new).and_return(auth_client)
+      allow(G5AuthenticationClient::Client).to receive(:new)
+        .and_return(auth_client)
     end
 
     it 'should initialize the auth client with the correct client_id' do
-      expect(G5AuthenticationClient::Client).to receive(:new).
-        with(hash_including(client_id: options[:client_id])).
-        and_return(auth_client)
+      expect(G5AuthenticationClient::Client).to receive(:new)
+        .with(hash_including(client_id: options[:client_id]))
+        .and_return(auth_client)
       export
     end
 
     it 'should initialize the auth client with the correct client_secret' do
-      expect(G5AuthenticationClient::Client).to receive(:new).
-        with(hash_including(client_secret: options[:client_secret])).
-        and_return(auth_client)
+      expect(G5AuthenticationClient::Client).to receive(:new)
+        .with(hash_including(client_secret: options[:client_secret]))
+        .and_return(auth_client)
       export
     end
 
     it 'should initialize the auth client with the correct redirect_uri' do
-      expect(G5AuthenticationClient::Client).to receive(:new).
-        with(hash_including(redirect_uri: options[:redirect_uri])).
-        and_return(auth_client)
+      expect(G5AuthenticationClient::Client).to receive(:new)
+        .with(hash_including(redirect_uri: options[:redirect_uri]))
+        .and_return(auth_client)
       export
     end
 
     it 'should initialize the auth client with the correct endpoint' do
-      expect(G5AuthenticationClient::Client).to receive(:new).
-        with(hash_including(endpoint: options[:endpoint])).
-        and_return(auth_client)
+      expect(G5AuthenticationClient::Client).to receive(:new)
+        .with(hash_including(endpoint: options[:endpoint]))
+        .and_return(auth_client)
       export
     end
 
-    it 'should initialize the auth client with the correct authorization code' do
-      expect(G5AuthenticationClient::Client).to receive(:new).
-        with(hash_including(authorization_code: options[:authorization_code])).
-        and_return(auth_client)
+    it 'initializes the auth client with the correct authorization code' do
+      expect(G5AuthenticationClient::Client).to receive(:new)
+        .with(hash_including(authorization_code: options[:authorization_code]))
+        .and_return(auth_client)
       export
     end
 
     it 'should create the auth user with the correct email' do
-      expect(auth_client).to receive(:create_user).
-        with(hash_including(email: email)).
-        and_return(auth_user)
+      expect(auth_client).to receive(:create_user)
+        .with(hash_including(email: email))
+        .and_return(auth_user)
       export
     end
 
     it 'should create the auth user with the correct default password' do
-      expect(auth_client).to receive(:create_user).
-        with(hash_including(password: encrypted_password)).
-        and_return(auth_user)
+      expect(auth_client).to receive(:create_user)
+        .with(hash_including(password: encrypted_password))
+        .and_return(auth_user)
       export
     end
 
@@ -99,7 +102,9 @@ describe G5::UserExporter do
     end
 
     it 'should return the SQL update statement with the encrypted password' do
-      expect(export).to match(/update users set encrypted_password='#{encrypted_password}' where id=#{uid};/i)
+      expect(export).to match(
+        /update users set encrypted_password='#{encrypted_password}' where id=#{uid};/i
+      )
     end
   end
 end

data/spec/models/g5_authenticatable_spec.rb

@@ -1,11 +1,13 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Devise::Models::G5Authenticatable do
+require 'rails_helper'
+
+RSpec.describe Devise::Models::G5Authenticatable do
   subject { model }
 
   let(:model_class) { User }
   let(:model) { model_class.new(attributes) }
-  let(:attributes) { Hash.new }
+  let(:attributes) { {} }
 
   describe '#save!' do
     subject(:save) { model.save! }
@@ -34,7 +36,8 @@ describe Devise::Models::G5Authenticatable do
       let(:auth_id) { 1 }
 
       before do
-        allow(Devise::G5::AuthUserCreator).to receive(:new).and_return(auth_user_creator)
+        allow(Devise::G5::AuthUserCreator).to receive(:new)
+          .and_return(auth_user_creator)
       end
 
       context 'when model is valid' do
@@ -100,7 +103,8 @@ describe Devise::Models::G5Authenticatable do
           let(:error_body) { 'problems' }
 
           it 'should raise a RecordNotSaved error with the OAuth error code' do
-            expect { save }. to raise_error(ActiveRecord::RecordNotSaved, error_code)
+            expect { save }.to raise_error(ActiveRecord::RecordNotSaved,
+                                           error_code)
           end
         end
 
@@ -109,7 +113,8 @@ describe Devise::Models::G5Authenticatable do
           let(:error_message) { 'problems' }
 
           it 'should raise a RecordNotSaved error' do
-            expect { save }.to raise_error(ActiveRecord::RecordNotSaved, error_message)
+            expect { save }.to raise_error(ActiveRecord::RecordNotSaved,
+                                           error_message)
           end
         end
       end
@@ -122,7 +127,8 @@ describe Devise::Models::G5Authenticatable do
       let(:auth_user) { double(:auth_user, id: auth_id) }
       let(:auth_id) { 'remote-auth-id-42' }
       before do
-        allow(Devise::G5::AuthUserUpdater).to receive(:new).and_return(auth_user_updater)
+        allow(Devise::G5::AuthUserUpdater).to receive(:new)
+          .and_return(auth_user_updater)
       end
 
       context 'with successful auth user update' do
@@ -144,7 +150,7 @@ describe Devise::Models::G5Authenticatable do
         let(:error_message) { 'problems' }
 
         it 'should raise an error' do
-          expect { save }.to raise_error
+          expect { save }.to raise_error(error_message)
         end
       end
     end
@@ -168,7 +174,10 @@ describe Devise::Models::G5Authenticatable do
     let(:updated_email) { 'update@email.com' }
 
     let(:auth_updater) { double(:auth_user_updater, update: true) }
-    before { allow(Devise::G5::AuthUserUpdater).to receive(:new).and_return(auth_updater) }
+    before do
+      allow(Devise::G5::AuthUserUpdater).to receive(:new)
+        .and_return(auth_updater)
+    end
 
     let(:password_validator) { double(:auth_password_validator) }
     before do
@@ -178,7 +187,9 @@ describe Devise::Models::G5Authenticatable do
     end
 
     context 'with valid current password' do
-      before { allow(password_validator).to receive(:valid_password?).and_return(true) }
+      before do
+        allow(password_validator).to receive(:valid_password?).and_return(true)
+      end
 
       before { update_with_password }
 
@@ -218,7 +229,9 @@ describe Devise::Models::G5Authenticatable do
     end
 
     context 'with invalid current password' do
-      before { allow(password_validator).to receive(:valid_password?).and_return(false) }
+      before do
+        allow(password_validator).to receive(:valid_password?).and_return(false)
+      end
 
       before { update_with_password }
 
@@ -284,9 +297,12 @@ describe Devise::Models::G5Authenticatable do
     let(:model) { create(:user) }
     let(:password) { 'foobarbaz' }
 
-    let(:password_validator) { double(:password_validator, valid_password?: valid) }
+    let(:password_validator) do
+      double(:password_validator, valid_password?: valid)
+    end
     before do
-      allow(Devise::G5::AuthPasswordValidator).to receive(:new).and_return(password_validator)
+      allow(Devise::G5::AuthPasswordValidator).to receive(:new)
+        .and_return(password_validator)
     end
 
     before { valid_password? }
@@ -299,11 +315,13 @@ describe Devise::Models::G5Authenticatable do
       end
 
       it 'should initialize the validator with the model' do
-        expect(Devise::G5::AuthPasswordValidator).to have_received(:new).with(model)
+        expect(Devise::G5::AuthPasswordValidator).to have_received(:new)
+          .with(model)
       end
 
       it 'should check the password against the auth server' do
-        expect(password_validator).to have_received(:valid_password?).with(password)
+        expect(password_validator).to have_received(:valid_password?)
+          .with(password)
       end
     end
 
@@ -315,22 +333,27 @@ describe Devise::Models::G5Authenticatable do
       end
 
       it 'should initialize the validator with the model' do
-        expect(Devise::G5::AuthPasswordValidator).to have_received(:new).with(model)
+        expect(Devise::G5::AuthPasswordValidator).to have_received(:new)
+          .with(model)
       end
 
       it 'should check the password against the auth server' do
-        expect(password_validator).to have_received(:valid_password?).with(password)
+        expect(password_validator).to have_received(:valid_password?)
+          .with(password)
       end
     end
   end
 
   describe '.find_and_update_for_g5_oauth' do
-    subject(:find_and_update) { model_class.find_and_update_for_g5_oauth(auth_data) }
+    subject(:find_and_update) do
+      model_class.find_and_update_for_g5_oauth(auth_data)
+    end
 
     let(:auth_data) do
       OmniAuth::AuthHash.new(provider:    'g5',
                              uid:         '123999',
-                             info:        { name: 'Foo Bar', email: 'foo@bar.com' },
+                             info:        { name: 'Foo Bar',
+                                            email: 'foo@bar.com' },
                              credentials: { token: 'abc123' })
     end
 
@@ -358,7 +381,8 @@ describe Devise::Models::G5Authenticatable do
       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)
+        expect_any_instance_of(model_class).to receive(:update_roles_from_auth)
+          .with(auth_data)
         find_and_update
       end
     end
@@ -369,7 +393,8 @@ describe Devise::Models::G5Authenticatable do
       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)
+        expect_any_instance_of(model_class)
+          .to_not receive(:update_roles_from_auth)
         find_and_update
       end
     end
@@ -381,7 +406,8 @@ describe Devise::Models::G5Authenticatable do
     let(:auth_data) do
       OmniAuth::AuthHash.new(provider:    'g5',
                              uid:         uid,
-                             info:        { name: 'Foo Bar', email: 'foo@bar.com' },
+                             info:        { name: 'Foo Bar',
+                                            email: 'foo@bar.com' },
                              credentials: { token: 'abc123' })
     end
 
@@ -464,7 +490,8 @@ describe Devise::Models::G5Authenticatable do
     let(:auth_data) do
       OmniAuth::AuthHash.new(provider:    'g5',
                              uid:         '123999',
-                             info:        { name: 'Foo Bar', email: 'foo@bar.com' },
+                             info:        { name: 'Foo Bar',
+                                            email: 'foo@bar.com' },
                              credentials: { token: 'abc123' })
     end
 
@@ -475,7 +502,8 @@ describe Devise::Models::G5Authenticatable do
     end
 
     it 'should update the g5_access_token' do
-      expect { update_g5_credentials }.to change { model.g5_access_token }.to(auth_data.credentials.token)
+      expect { update_g5_credentials }.to change { model.g5_access_token }
+        .to(auth_data.credentials.token)
     end
 
     it 'should not save the changes' do
@@ -488,7 +516,10 @@ describe Devise::Models::G5Authenticatable do
     subject(:revoke_g5_credentials!) { model.revoke_g5_credentials! }
 
     let(:auth_updater) { double(:auth_user_updater, update: nil) }
-    before { allow(Devise::G5::AuthUserUpdater).to receive(:new).and_return(auth_updater) }
+    before do
+      allow(Devise::G5::AuthUserUpdater).to receive(:new)
+        .and_return(auth_updater)
+    end
 
     let(:model) { create(:user, g5_access_token: g5_token) }
     before { model.password = model.password_confirmation = nil }
@@ -523,11 +554,14 @@ describe Devise::Models::G5Authenticatable do
     let(:auth_data) do
       OmniAuth::AuthHash.new(provider:    'g5',
                              uid:         '123999',
-                             info:        { name: 'Foo Bar', email: 'foo@bar.com' },
+                             info:        { name: 'Foo Bar',
+                                            email: 'foo@bar.com' },
                              credentials: { token: 'abc123' })
     end
 
-    before { allow_any_instance_of(model_class).to receive(:update_roles_from_auth) }
+    before do
+      allow_any_instance_of(model_class).to receive(:update_roles_from_auth)
+    end
 
     context 'with params' do
       let(:params) do
@@ -553,12 +587,13 @@ describe Devise::Models::G5Authenticatable do
         end
 
         it 'executes the callback to update role data' do
-          expect(new_with_session).to have_received(:update_roles_from_auth).with(auth_data)
+          expect(new_with_session).to have_received(:update_roles_from_auth)
+            .with(auth_data)
         end
       end
 
       context 'without session data' do
-        let(:session) { Hash.new }
+        let(:session) { {} }
 
         it { is_expected.to be_new_record }
 
@@ -575,14 +610,15 @@ describe Devise::Models::G5Authenticatable do
         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)
+          expect_any_instance_of(model_class)
+            .not_to receive(:update_roles_from_auth)
           new_with_session
         end
       end
     end
 
     context 'without params' do
-      let(:params) { Hash.new }
+      let(:params) { {} }
 
       context 'with session data' do
         let(:session) do
@@ -604,12 +640,13 @@ describe Devise::Models::G5Authenticatable do
         end
 
         it 'executes the callback to update role data' do
-          expect(new_with_session).to have_received(:update_roles_from_auth).with(auth_data)
+          expect(new_with_session).to have_received(:update_roles_from_auth)
+            .with(auth_data)
         end
       end
 
       context 'without session data' do
-        let(:session) { Hash.new }
+        let(:session) { {} }
 
         it { is_expected.to be_new_record }
 
@@ -626,7 +663,8 @@ describe Devise::Models::G5Authenticatable do
         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)
+          expect_any_instance_of(model_class)
+            .not_to receive(:update_roles_from_auth)
           new_with_session
         end
       end
@@ -642,10 +680,10 @@ describe Devise::Models::G5Authenticatable do
                              info:        { first_name: 'Foo',
                                             last_name: 'Bar',
                                             email: 'foo@bar.com',
-                                            phone: '123-555-1212 x42'},
+                                            phone: '123-555-1212 x42' },
                              credentials: { token: 'abc123' },
                              extra: { title: 'Minister of Funny Walks',
-                                      organization_name: 'Dept of Redundancy Dept' })
+                                      organization_name: 'Sales' })
     end
 
     it 'has the correct uid' do
@@ -668,8 +706,10 @@ describe Devise::Models::G5Authenticatable do
       OmniAuth::AuthHash.new(provider: 'g5',
                              uid: '123456',
                              extra: { roles: [
-                               { name: 'Admin', type: 'GLOBAL', urn: nil }
-                             ]})
+                               { name: 'Admin',
+                                 type: 'GLOBAL',
+                                 urn: nil }
+                             ] })
     end
 
     it 'does not change anything on the model' do

data/spec/models/protected_attributes_spec.rb

@@ -1,25 +1,30 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe DeviseG5Authenticatable::Models::ProtectedAttributes do
-  before do
-    Dummy::Application.config.active_record.whitelist_attributes = true
-  end
+require 'rails_helper'
 
-  after do
-    Dummy::Application.config.active_record.whitelist_attributes = false
-  end
+# Protected attributes are not supported by rails 5
+if Rails.version.starts_with?('4')
+  RSpec.describe DeviseG5Authenticatable::Models::ProtectedAttributes do
+    before do
+      Dummy::Application.config.active_record.whitelist_attributes = true
+    end
 
-  subject { model }
+    after do
+      Dummy::Application.config.active_record.whitelist_attributes = false
+    end
 
-  let(:model_class) { User }
-  let(:model) { model_class.new }
+    subject { model }
 
-  it { should allow_mass_assignment_of(:email) }
-  it { should allow_mass_assignment_of(:password) }
-  it { should allow_mass_assignment_of(:password_confirmation) }
-  it { should allow_mass_assignment_of(:provider) }
-  it { should allow_mass_assignment_of(:uid) }
-  it { should_not allow_mass_assignment_of(:g5_access_token) }
-  it { should allow_mass_assignment_of(:current_password) }
-  it { should allow_mass_assignment_of(:updated_by) }
+    let(:model_class) { User }
+    let(:model) { model_class.new }
+
+    it { is_expected.to allow_mass_assignment_of(:email) }
+    it { is_expected.to allow_mass_assignment_of(:password) }
+    it { is_expected.to allow_mass_assignment_of(:password_confirmation) }
+    it { is_expected.to allow_mass_assignment_of(:provider) }
+    it { is_expected.to allow_mass_assignment_of(:uid) }
+    it { is_expected.not_to allow_mass_assignment_of(:g5_access_token) }
+    it { is_expected.to allow_mass_assignment_of(:current_password) }
+    it { is_expected.to allow_mass_assignment_of(:updated_by) }
+  end
 end

data/spec/rails_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# Load rails dummy application
+ENV['RAILS_ENV'] = 'test'
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+
+require 'rspec/rails'
+require 'capybara/rspec'
+require 'webmock/rspec'
+require 'shoulda-matchers'
+require 'factory_girl_rails'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Checks for pending migration and applies them before tests are run
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.use_transactional_fixtures = true
+
+  config.infer_spec_type_from_file_location!
+
+  # The integration tests can be run with:
+  # rspec -t type:feature
+  # config.filter_run_excluding type: 'feature'
+
+  # Filter lines from Rails gems in backtraces
+  # config.filter_rails_from_backtrace!
+
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace('gem name')
+
+  config.after(:suite) { WebMock.disable! }
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end