devise_g5_authenticatable 0.3.0 → 1.0.0.pre.1

data/spec/dummy/config/initializers/devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Use this hook to configure devise mailer, warden hooks and so forth.
 # Many of these configuration options can be set straight in your model.
 Devise.setup do |config|
@@ -23,7 +25,9 @@ Devise.setup do |config|
 
   # Require optional support for protected_attributes in devise
   # models
-  require 'devise_g5_authenticatable/models/protected_attributes'
+  if Rails.version.starts_with?('4')
+    require 'devise_g5_authenticatable/models/protected_attributes'
+  end
 
   # ==> Configuration for any authentication mechanism
   # Configure which keys are used when authenticating a user. The default is

data/spec/dummy/config/initializers/rails_compatibility.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Support migration version syntax in rails 4
+ActiveSupport.on_load(:active_record) do
+  unless ActiveRecord::Migration.respond_to?(:[])
+    ActiveRecord::Migration.define_singleton_method(:[]) do |version|
+      self if version.to_s.starts_with?('4')
+    end
+  end
+end

data/spec/dummy/db/migrate/20131230235849_devise_create_users.rb

@@ -1,4 +1,6 @@
-class DeviseCreateUsers < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class DeviseCreateUsers < ActiveRecord::Migration[4.2]
   def change
     create_table(:users) do |t|
       ## Database authenticatable

data/spec/dummy/db/migrate/20140102213131_drop_database_authenticatable.rb

@@ -1,4 +1,6 @@
-class DropDatabaseAuthenticatable < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class DropDatabaseAuthenticatable < ActiveRecord::Migration[4.2]
   def up
     change_table(:users) do |t|
       t.remove :email

data/spec/dummy/db/migrate/20140103032308_drop_recoverable.rb

@@ -1,4 +1,6 @@
-class DropRecoverable < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class DropRecoverable < ActiveRecord::Migration[4.2]
   def up
     change_table(:users) do |t|
       t.remove :reset_password_token

data/spec/dummy/db/migrate/20140103042329_drop_rememberable.rb

@@ -1,4 +1,6 @@
-class DropRememberable < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class DropRememberable < ActiveRecord::Migration[4.2]
   def up
     change_table(:users) do |t|
       t.remove :remember_created_at

data/spec/dummy/db/migrate/20140103174810_add_omniauth_columns_to_users.rb

@@ -1,4 +1,6 @@
-class AddOmniauthColumnsToUsers < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddOmniauthColumnsToUsers < ActiveRecord::Migration[4.2]
   def up
     change_table(:users) do |t|
       t.string :uid

data/spec/dummy/db/migrate/20140103191601_add_email_back_to_user.rb

@@ -1,4 +1,6 @@
-class AddEmailBackToUser < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddEmailBackToUser < ActiveRecord::Migration[4.2]
   def change
     add_column :users, :email, :string,
                                null: false,

data/spec/dummy/db/migrate/20140113202948_devise_create_admins.rb

@@ -1,4 +1,6 @@
-class DeviseCreateAdmins < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class DeviseCreateAdmins < ActiveRecord::Migration[4.2]
   def change
     create_table(:admins) do |t|
       ## Database authenticatable

data/spec/dummy/db/migrate/20140113233821_add_provider_and_uid_to_admins.rb

@@ -1,4 +1,6 @@
-class AddProviderAndUidToAdmins < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddProviderAndUidToAdmins < ActiveRecord::Migration[4.2]
   def change
     add_column :admins, :provider, :string
     add_column :admins, :uid, :string

data/spec/dummy/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -9,42 +8,43 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20140113233821) do
+ActiveRecord::Schema.define(version: 20140113233821) do
 
-  create_table "admins", :force => true do |t|
-    t.string   "email",              :default => "", :null => false
-    t.integer  "sign_in_count",      :default => 0,  :null => false
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "admins", id: :serial, force: :cascade do |t|
+    t.string "email", default: "", null: false
+    t.integer "sign_in_count", default: 0, null: false
     t.datetime "current_sign_in_at"
     t.datetime "last_sign_in_at"
-    t.string   "current_sign_in_ip"
-    t.string   "last_sign_in_ip"
-    t.datetime "created_at",                         :null => false
-    t.datetime "updated_at",                         :null => false
-    t.string   "provider"
-    t.string   "uid"
-    t.string   "g5_access_token"
+    t.string "current_sign_in_ip"
+    t.string "last_sign_in_ip"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string "provider"
+    t.string "uid"
+    t.string "g5_access_token"
+    t.index ["email"], name: "index_admins_on_email", unique: true
+    t.index ["provider", "uid"], name: "index_admins_on_provider_and_uid", unique: true
   end
 
-  add_index "admins", ["email"], :name => "index_admins_on_email", :unique => true
-  add_index "admins", ["provider", "uid"], :name => "index_admins_on_provider_and_uid", :unique => true
-
-  create_table "users", :force => true do |t|
-    t.integer  "sign_in_count",      :default => 0,  :null => false
+  create_table "users", id: :serial, force: :cascade do |t|
+    t.integer "sign_in_count", default: 0, null: false
     t.datetime "current_sign_in_at"
     t.datetime "last_sign_in_at"
-    t.string   "current_sign_in_ip"
-    t.string   "last_sign_in_ip"
-    t.datetime "created_at",                         :null => false
-    t.datetime "updated_at",                         :null => false
-    t.string   "uid"
-    t.string   "provider"
-    t.string   "g5_access_token"
-    t.string   "email",              :default => "", :null => false
+    t.string "current_sign_in_ip"
+    t.string "last_sign_in_ip"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string "uid"
+    t.string "provider"
+    t.string "g5_access_token"
+    t.string "email", default: "", null: false
+    t.index ["email"], name: "index_users_on_email", unique: true
+    t.index ["provider", "uid"], name: "index_users_on_provider_and_uid", unique: true
   end
 
-  add_index "users", ["email"], :name => "index_users_on_email", :unique => true
-  add_index "users", ["provider", "uid"], :name => "index_users_on_provider_and_uid", :unique => true
-
 end

data/spec/factories/admin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryGirl.define do
   factory :admin do
     sequence(:email) { |n| "admin.#{n}@test.host" }

data/spec/factories/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryGirl.define do
   factory :user do
     sequence(:email) { |n| "user.#{n}@test.host" }

data/spec/features/edit_registration_spec.rb

@@ -1,15 +1,20 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Editing a user registration' do
+require 'rails_helper'
+
+RSpec.describe 'Editing a user registration' do
   subject(:update_registration) { click_button 'Update' }
 
   let(:user) { create(:user) }
 
-  let(:auth_client) { double(:auth_client, update_user: auth_user, me: auth_user) }
+  let(:auth_client) do
+    double(:auth_client, update_user: auth_user, me: auth_user)
+  end
 
   let(:auth_user) { double(:auth_user, id: user.uid, email: user.email) }
   before do
-    allow(G5AuthenticationClient::Client).to receive(:new).and_return(auth_client)
+    allow(G5AuthenticationClient::Client).to receive(:new)
+      .and_return(auth_client)
   end
 
   before do
@@ -34,10 +39,11 @@ describe 'Editing a user registration' do
       end
 
       it 'should update the email on the auth server' do
-        expect(auth_client).to receive(:update_user).with({id: user.uid,
-                                                           email: email,
-                                                           password: nil,
-                                                           password_confirmation: nil})
+        expect(auth_client).to receive(:update_user)
+          .with(id: user.uid,
+                email: email,
+                password: nil,
+                password_confirmation: nil)
         update_registration
       end
     end
@@ -46,10 +52,11 @@ describe 'Editing a user registration' do
       let(:password) { 'a brand new password' }
 
       it 'should update the password on the auth server' do
-        expect(auth_client).to receive(:update_user).with({id: user.uid,
-                                                           email: email,
-                                                           password: password,
-                                                           password_confirmation: password_confirmation})
+        expect(auth_client).to receive(:update_user)
+          .with(id: user.uid,
+                email: email,
+                password: password,
+                password_confirmation: password_confirmation)
         update_registration
       end
     end
@@ -70,7 +77,9 @@ describe 'Editing a user registration' do
 
     context 'when the auth server returns an error' do
       include_context 'OAuth2::Error'
-      before { allow(auth_client).to receive(:update_user).and_raise(oauth_error) }
+      before do
+        allow(auth_client).to receive(:update_user).and_raise(oauth_error)
+      end
 
       it 'should display an error message' do
         update_registration

data/spec/features/registration_spec.rb

@@ -1,12 +1,15 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'User registration' do
+require 'rails_helper'
+
+RSpec.describe 'User registration' do
   subject(:register_user) { click_button 'Sign up' }
 
   let(:auth_client) { double(:auth_client, create_user: auth_user) }
   let(:auth_user) { double(:auth_user, id: uid, email: email) }
   before do
-    allow(G5AuthenticationClient::Client).to receive(:new).and_return(auth_client)
+    allow(G5AuthenticationClient::Client).to receive(:new)
+      .and_return(auth_client)
   end
 
   before do
@@ -32,11 +35,11 @@ describe 'User registration' do
     end
 
     it 'should create the user on the auth server' do
-      expect(auth_client).to receive(:create_user).
-        with({email: email,
+      expect(auth_client).to receive(:create_user)
+        .with(email: email,
               password: password,
-              password_confirmation: password_confirmation}).
-        and_return(auth_user)
+              password_confirmation: password_confirmation)
+        .and_return(auth_user)
       register_user
     end
 
@@ -52,7 +55,9 @@ describe 'User registration' do
 
   context 'when there is an error on the auth server' do
     include_context 'OAuth2::Error'
-    before { allow(auth_client).to receive(:create_user).and_raise(oauth_error) }
+    before do
+      allow(auth_client).to receive(:create_user).and_raise(oauth_error)
+    end
 
     it 'should display an error message' do
       register_user

data/spec/features/sign_in_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Signing in' do
+require 'rails_helper'
+
+RSpec.describe 'Signing in' do
   context 'when visiting a protected page' do
     let(:protected_path) { edit_user_registration_path }
 

data/spec/features/sign_out_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Signing out' do
+require 'rails_helper'
+
+RSpec.describe 'Signing out' do
   it 'should redirect to the auth server'
   it 'should pass the root url as a param to the redirect'
   it 'should not allow the user to access protected pages'

data/spec/features/token_validation_spec.rb

@@ -1,14 +1,18 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Token validation per request' do
+require 'rails_helper'
+
+RSpec.describe 'Token validation per request' do
   let(:user) { create(:user) }
   let(:protected_path) { edit_user_registration_path }
   let(:token_info_url) { 'http://auth.g5search.com/oauth/token/info' }
 
+  let(:auth_header) { { 'Authorization' => "Bearer #{user.g5_access_token}" } }
+
   before do
-    stub_request(:get, token_info_url).
-      with(headers: {'Authorization'=>"Bearer #{user.g5_access_token}"}).
-      to_return(status: 200, body: '', headers: {})
+    stub_request(:get, token_info_url)
+      .with(headers: auth_header)
+      .to_return(status: 200, body: '', headers: {})
   end
 
   before do
@@ -42,8 +46,8 @@ describe 'Token validation per request' do
       before { visit protected_path }
 
       it 'should validate the token against the auth server' do
-        expect(a_request(:get, token_info_url).
-               with(headers: {'Authorization' => "Bearer #{user.g5_access_token}"})).to have_been_made
+        expect(a_request(:get, token_info_url).with(headers: auth_header))
+          .to have_been_made
       end
 
       it 'should allow the user to access the protected page' do
@@ -53,13 +57,19 @@ describe 'Token validation per request' do
 
     context 'when the access_token has been invalidated' do
       before do
-        stub_request(:get, token_info_url).
-          with(headers: {'Authorization'=>"Bearer #{user.g5_access_token}"}).
-          to_return(status: 401,
-                    headers: {'Content-Type' => 'application/json; charset=utf-8',
-                              'Cache-Control' => 'no-cache'},
-                    body: {'error' => 'invalid_token',
-                           'error_description' => 'The access token expired'}.to_json)
+        response_headers = {
+          'Content-Type' => 'application/json; charset=utf-8',
+          'Cache-Control' => 'no-cache'
+        }
+        response_body = {
+          'error' => 'invalid_token',
+          'error_description' => 'The access token expired'
+        }
+        stub_request(:get, token_info_url)
+          .with(headers: auth_header)
+          .to_return(status: 401,
+                     headers: response_headers,
+                     body: response_body.to_json)
         visit protected_path
       end
 

data/spec/g5/auth_password_validator_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Devise::G5::AuthPasswordValidator do
+require 'rails_helper'
+
+RSpec.describe Devise::G5::AuthPasswordValidator do
   let(:validator) { described_class.new(model) }
 
   let(:model) { build_stubbed(:user) }
@@ -14,24 +16,26 @@ describe Devise::G5::AuthPasswordValidator do
     let(:auth_user) { double(:auth_user, uid: model.uid, email: model.email) }
 
     let(:oauth_error) { OAuth2::Error.new(response) }
-    let(:response) { double(:oauth_response, parsed: oauth_error_hash).as_null_object }
+    let(:response) do
+      double(:oauth_response, parsed: oauth_error_hash).as_null_object
+    end
 
     before do
-      allow(G5AuthenticationClient::Client).to receive(:new).
-        and_return(auth_client)
+      allow(G5AuthenticationClient::Client).to receive(:new)
+        .and_return(auth_client)
     end
 
     context 'with valid password' do
       before { valid_password? }
 
       it 'should initialize auth client with the username' do
-        expect(G5AuthenticationClient::Client).to have_received(:new).
-          with(hash_including(username: model.email))
+        expect(G5AuthenticationClient::Client).to have_received(:new)
+          .with(hash_including(username: model.email))
       end
 
       it 'should initialize auth client with the password' do
-        expect(G5AuthenticationClient::Client).to have_received(:new).
-          with(hash_including(password: password))
+        expect(G5AuthenticationClient::Client).to have_received(:new)
+          .with(hash_including(password: password))
       end
 
       it 'should retrieve the auth user associated with these credentials' do
@@ -47,8 +51,10 @@ describe Devise::G5::AuthPasswordValidator do
       before { allow(auth_client).to receive(:me).and_raise(oauth_error) }
 
       let(:oauth_error_hash) do
-        {'error' => 'invalid_resource_owner',
-         'error_description' => 'The provided resource owner credentials are not valid, or resource owner cannot be found.'}
+        { 'error' => 'invalid_resource_owner',
+          'error_description' => 'The provided resource owner credentials are' \
+                                 ' not valid, or resource owner cannot be' \
+                                 ' found.' }
       end
 
       it 'should return false' do
@@ -57,8 +63,14 @@ describe Devise::G5::AuthPasswordValidator do
     end
 
     context 'with blank password' do
-      before { allow(auth_client).to receive(:me).and_raise(runtime_error) }
-      let(:runtime_error) { RuntimeError.new('Insufficient credentials for access token. Supply a username/password or authentication code.') }
+      before do
+        allow(auth_client).to receive(:me)
+          .and_raise(RuntimeError, runtime_error)
+      end
+      let(:runtime_error) do
+        'Insufficient credentials for access token. Supply a' \
+        ' username/password or authentication code.'
+      end
 
       it 'should return false' do
         expect(valid_password?).to be_falsey
@@ -69,8 +81,9 @@ describe Devise::G5::AuthPasswordValidator do
       before { allow(auth_client).to receive(:me).and_raise(oauth_error) }
 
       let(:oauth_error_hash) do
-        {'error' => 'unauthorized_client',
-         'error_description' => 'The client is not authorized to perform this request using this method.'}
+        { 'error' => 'unauthorized_client',
+          'error_description' => 'The client is not authorized to perform' \
+                                 ' this request using this method.' }
       end
 
       it 'should re-raise the error' do

data/spec/g5/auth_user_creator_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Devise::G5::AuthUserCreator do
+require 'rails_helper'
+
+RSpec.describe Devise::G5::AuthUserCreator do
   let(:creator) { described_class.new(model) }
 
   describe '#create' do
@@ -19,23 +21,26 @@ describe Devise::G5::AuthUserCreator do
 
     let(:auth_client) { double(:g5_authentication_client) }
 
-    let(:auth_user) { double(:auth_user,
-                             id: uid,
-                             email: model.email,
-                             password: other_password,
-                             clean_up_passwords: nil,
-                             to_hash: {}) }
+    let(:auth_user) do
+      double(:auth_user, id: uid,
+                         email: model.email,
+                         password: other_password,
+                         clean_up_passwords: nil,
+                         to_hash: {})
+    end
 
     let(:uid) { 'remote-auth-user-42' }
 
     before do
-      allow(G5AuthenticationClient::Client).to receive(:new).and_return(auth_client)
+      allow(G5AuthenticationClient::Client).to receive(:new)
+        .and_return(auth_client)
     end
 
     context 'when there is an existing auth user' do
       before do
         model.uid = nil
-        allow(auth_client).to receive(:create_user).and_raise(StandardError.new('Email has already been taken'))
+        allow(auth_client).to receive(:create_user)
+          .and_raise(StandardError, 'Email has already been taken')
         allow(auth_client).to receive(:find_user_by_email).and_return(auth_user)
         allow(auth_client).to receive(:update_user)
       end
@@ -43,7 +48,7 @@ describe Devise::G5::AuthUserCreator do
       it 'should create the local user with the existing uid' do
         allow(auth_user).to receive(:password=)
         allow(auth_user).to receive(:password_confirmation=)
-        expect{ create }.to change(model, :uid).to uid
+        expect { create }.to change { model.uid }.to(uid)
       end
 
       it 'should reset the password' do
@@ -67,23 +72,25 @@ describe Devise::G5::AuthUserCreator do
           before { create }
 
           it 'should use the token for updated_by user 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 create a new auth user with the correct email' do
-            expect(auth_client).to have_received(:create_user).
-              with(hash_including(email: model.email))
+            expect(auth_client).to have_received(:create_user)
+              .with(hash_including(email: model.email))
           end
 
           it 'should create a new auth user with the correct password' do
-            expect(auth_client).to have_received(:create_user).
-              with(hash_including(password: password))
+            expect(auth_client).to have_received(:create_user)
+              .with(hash_including(password: password))
           end
 
-          it 'should create a new auth user with the correct password confirmation' do
-            expect(auth_client).to have_received(:create_user).
-              with(hash_including(password_confirmation: password_confirmation))
+          it 'creates a new auth user with the correct password confirmation' do
+            expect(auth_client).to have_received(:create_user)
+              .with(
+                hash_including(password_confirmation: password_confirmation)
+              )
           end
 
           it 'should reset the password' do
@@ -109,8 +116,8 @@ describe Devise::G5::AuthUserCreator do
           before { create }
 
           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