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

data/lib/g5_authenticatable/test/request_helpers.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module G5Authenticatable
   module Test
+    # Helper methods for login/logout during request specs
     module RequestHelpers
       include Warden::Test::Helpers
 
@@ -14,7 +17,7 @@ module G5Authenticatable
   end
 end
 
-shared_context 'auth request', auth_request: true do
+RSpec.shared_context 'auth request' do
   include G5Authenticatable::Test::RequestHelpers
 
   let(:user) { FactoryGirl.create(:g5_authenticatable_user) }
@@ -30,4 +33,5 @@ end
 RSpec.configure do |config|
   config.include G5Authenticatable::Test::RequestHelpers, type: :request
   config.after { Warden.test_reset! }
+  config.include_context 'auth request', auth_request: true
 end

data/lib/g5_authenticatable/test/token_validation_helpers.rb

@@ -1,20 +1,25 @@
+# frozen_string_literal: true
+
 module G5Authenticatable
   module Test
+    # Helpers for stubbing token validation requests
     module TokenValidationHelpers
       def stub_valid_access_token(token_value)
-        stub_request(:get, "#{ENV['G5_AUTH_ENDPOINT']}/oauth/token/info").
-          with(headers: {'Authorization'=>"Bearer #{token_value}"}).
-          to_return(status: 200, body: '', headers: {})
+        stub_request(:get, "#{ENV['G5_AUTH_ENDPOINT']}/oauth/token/info")
+          .with(headers: { 'Authorization' => "Bearer #{token_value}" })
+          .to_return(status: 200, body: '', headers: {})
       end
 
       def stub_invalid_access_token(token_value)
-        stub_request(:get, "#{ENV['G5_AUTH_ENDPOINT']}/oauth/token/info").
-          with(headers: {'Authorization'=>"Bearer #{token_value}"}).
-          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)
+        stub_request(:get, "#{ENV['G5_AUTH_ENDPOINT']}/oauth/token/info")
+          .with(headers: { 'Authorization' => "Bearer #{token_value}" })
+          .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)
       end
     end
   end

data/lib/g5_authenticatable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module G5Authenticatable
-  VERSION = '0.9.1-2'
+  VERSION = '1.0.0-1'
 end

data/lib/generators/g5_authenticatable/install/install_generator.rb

@@ -1,51 +1,63 @@
-class G5Authenticatable::InstallGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+# frozen_string_literal: true
 
-  source_root File.expand_path('../templates', __FILE__)
+module G5Authenticatable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
 
-  # Required for Rails::Generators::Migrations
-  def self.next_migration_number(dirname)
-    next_migration_number = current_migration_number(dirname) + 1
-    ActiveRecord::Migration.next_migration_number(next_migration_number)
-  end
+    source_root File.expand_path('../templates', __FILE__)
 
-  def mount_engine
-    route "mount G5Authenticatable::Engine => '/g5_auth'"
-  end
+    # Required for Rails::Generators::Migrations
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
 
-  def create_initializer
-    template 'initializer.rb', 'config/initializers/g5_authenticatable.rb'
-  end
+    def mount_engine
+      route "mount G5Authenticatable::Engine => '/g5_auth'"
+    end
 
-  def create_users_migration
-    copy_migration('create_g5_authenticatable_users')
-  end
+    def create_initializer
+      template 'initializer.rb', 'config/initializers/g5_authenticatable.rb'
+    end
 
-  def users_contact_info_migration
-    copy_migration('add_g5_authenticatable_users_contact_info')
-  end
+    def create_users_migration
+      copy_migration('create_g5_authenticatable_users')
+    end
 
-  def create_roles_migration
-    copy_migration('create_g5_authenticatable_roles')
-  end
+    def users_contact_info_migration
+      copy_migration('add_g5_authenticatable_users_contact_info')
+    end
 
-  def include_authorization
-    inject_into_file 'app/controllers/application_controller.rb',
-      after: "class ApplicationController < ActionController::Base\n" do
-      "  include G5Authenticatable::Authorization\n"
+    def create_roles_migration
+      copy_migration('create_g5_authenticatable_roles')
     end
-  end
 
-  def create_application_policy
-    template 'application_policy.rb', 'app/policies/application_policy.rb'
-  end
+    def include_authorization
+      inject_into_file 'app/controllers/application_controller.rb',
+        after: "class ApplicationController < ActionController::Base\n" do
+        "  include G5Authenticatable::Authorization\n"
+      end
+    end
 
-  def create_403_error_page
-    template '403.html', 'public/403.html'
-  end
+    def create_application_policy
+      template 'application_policy.rb', 'app/policies/application_policy.rb'
+    end
 
-  private
-  def copy_migration(name)
-    migration_template "migrate/#{name}.rb", "db/migrate/#{name}.rb"
+    def create_403_error_page
+      template '403.html', 'public/403.html'
+    end
+
+    private
+
+    def copy_migration(name)
+      migration_template("migrate/#{name}.rb",
+                         "db/migrate/#{name}.rb",
+                         migration_version: migration_version)
+    end
+
+    def migration_version
+      return unless Rails.version.starts_with?('5')
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
   end
 end

data/lib/generators/g5_authenticatable/install/templates/application_policy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationPolicy < G5Authenticatable::BasePolicy
   class Scope < BaseScope
   end

data/lib/generators/g5_authenticatable/install/templates/initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Enable strict token validation to guarantee that an authenticated
 # user's access token is still valid on the global auth server, at the
 # cost of performance. When disabled, the user's access token will

data/lib/generators/g5_authenticatable/install/templates/migrate/add_g5_authenticatable_users_contact_info.rb

@@ -1,4 +1,6 @@
-class AddG5AuthenticatableUsersContactInfo < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddG5AuthenticatableUsersContactInfo < ActiveRecord::Migration<%= migration_version %>
   def change
     change_table(:g5_authenticatable_users) do |t|
       t.string :first_name

data/lib/generators/g5_authenticatable/install/templates/migrate/create_g5_authenticatable_roles.rb

@@ -1,4 +1,6 @@
-class CreateG5AuthenticatableRoles < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateG5AuthenticatableRoles < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table(:g5_authenticatable_roles) do |t|
       t.string :name

data/lib/generators/g5_authenticatable/install/templates/migrate/create_g5_authenticatable_users.rb

@@ -1,4 +1,6 @@
-class CreateG5AuthenticatableUsers < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateG5AuthenticatableUsers < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table(:g5_authenticatable_users) do |t|
       # G5 authenticatable

data/lib/tasks/g5_authenticatable/purge_users.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :g5_authenticatable do
   desc 'Purge local user data from the DB'
   task :purge_users do

data/spec/config/application_spec.rb

@@ -1,7 +1,10 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe "Application Configuration" do
-  it "appends access_token to the implementing apps filter_parameters" do
-    expect(Dummy::Application.config.filter_parameters).to include(:access_token)
+require 'rails_helper'
+
+RSpec.describe 'Application Configuration' do
+  it 'appends access_token to the implementing apps filter_parameters' do
+    expect(Dummy::Application.config.filter_parameters)
+      .to include(:access_token)
   end
 end

data/spec/controllers/application_controller_spec.rb

@@ -1,20 +1,25 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe ::ApplicationController do
+require 'rails_helper'
+
+RSpec.describe ::ApplicationController do
   it 'should have the correct new_session_path for users' do
     expect(controller.new_session_path(:user)).to eq('/g5_auth/users/sign_in')
   end
 
   it 'should have the correct destroy_session_path for users' do
-    expect(controller.destroy_session_path(:user)).to eq('/g5_auth/users/sign_out')
+    expect(controller.destroy_session_path(:user))
+      .to eq('/g5_auth/users/sign_out')
   end
 
   it 'should have the correct g5_authorize_path for users' do
-    expect(controller.g5_authorize_path(:user)).to eq('/g5_auth/users/auth/g5')
+    expect(controller.g5_authorize_path(:user))
+      .to eq('/g5_auth/users/auth/g5')
   end
 
   it 'should have the correct g5_callback_path for users' do
-    expect(controller.g5_callback_path(:user)).to eq('/g5_auth/users/auth/g5/callback')
+    expect(controller.g5_callback_path(:user))
+      .to eq('/g5_auth/users/auth/g5/callback')
   end
 
   context 'when strict token validation is enabled' do

data/spec/controllers/concerns/g5_authenticatable/{authorization.rb → authorization_spec.rb}

@@ -1,11 +1,14 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe G5Authenticatable::Authorization, type: :controller do
+require 'rails_helper'
+
+RSpec.describe G5Authenticatable::Authorization, type: :controller do
   controller(ActionController::Base) do
     include G5Authenticatable::Authorization
 
     def index
-      raise Pundit::NotAuthorizedError.new(query: 'index?', record: 'mock_record')
+      raise Pundit::NotAuthorizedError.new(query: 'index?',
+                                           record: 'mock_record')
     end
   end
 
@@ -18,7 +21,7 @@ describe G5Authenticatable::Authorization, type: :controller do
   end
 
   describe '#user_not_authorized' do
-    subject(:user_not_authorized) { get :index, format: format }
+    subject(:user_not_authorized) { safe_get :index, format: format }
 
     context 'when format is json' do
       let(:format) { :json }
@@ -30,7 +33,7 @@ describe G5Authenticatable::Authorization, type: :controller do
 
       it 'renders the json error message' do
         user_not_authorized
-        expect(JSON.parse(response.body)).to eq({'error' => 'Access forbidden'})
+        expect(JSON.parse(response.body)).to eq('error' => 'Access forbidden')
       end
     end
 
@@ -43,7 +46,9 @@ describe G5Authenticatable::Authorization, type: :controller do
 
       it 'renders the static 403.html' do
         user_not_authorized
-        expect(response).to render_template(file: "#{Rails.root}/public/403.html")
+        expect(response.body).to include(
+          '<title>Access forbidden (403)</title>'
+        )
       end
     end
   end

data/spec/dummy/app/controllers/home_controller.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 class HomeController < ApplicationController
-  before_filter :authenticate_user!, only: :show
+  before_action :authenticate_user!, only: :show
 
-  def index
-  end
+  def index; end
 
-  def show
-  end
+  def show; end
 end

data/spec/dummy/app/controllers/rails_api/secure_resources_controller.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module RailsApi
   class SecureResourcesController < ApplicationController
-    before_filter :authenticate_api_user!, unless: :is_navigational_format?
-    before_filter :authenticate_user!, if: :is_navigational_format?
+    before_action :authenticate_api_user!, unless: :is_navigational_format?
+    before_action :authenticate_user!, if: :is_navigational_format?
 
     def create
-      render json: {secure: 'data'}
+      render json: { secure: 'data' }
     end
 
     def show
       respond_to do |format|
         format.html { render }
-        format.json { render json: {secure: 'data'} }
+        format.json { render json: { secure: 'data' } }
       end
     end
   end

data/spec/dummy/app/models/post.rb

@@ -1,3 +1,3 @@
 class Post < ActiveRecord::Base
-  belongs_to :author, class: G5Authenticatable::User
+  belongs_to :author, class_name: 'G5Authenticatable::User'
 end

data/spec/dummy/config/environments/test.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in
+  # config/application.rb
 
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that
@@ -8,8 +11,26 @@ Dummy::Application.configure do
   config.cache_classes = true
 
   # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_files = true
-  config.static_cache_control = "public, max-age=3600"
+  cache_header_value = 'public, max-age=3600'
+
+  if config.respond_to?(:public_file_server)
+    # Rails 5.x
+    config.public_file_server.enabled = true
+    config.public_file_server.headers = {
+      'Cache-Control' => cache_header_value
+    }
+  else
+    # Rails 4.x
+    config.static_cache_control = cache_header_value
+
+    if config.respond_to?(:serve_static_files=)
+      # Rails 4.2
+      config.serve_static_files = true
+    else
+      # Rails 4.1
+      config.serve_static_assets = true
+    end
+  end
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
@@ -19,7 +40,7 @@ Dummy::Application.configure do
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the

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/20140206070137_create_g5_authenticatable_users.rb

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

data/spec/dummy/db/migrate/20150428182339_add_g5_authenticatable_users_contact_info.rb

@@ -1,4 +1,6 @@
-class AddG5AuthenticatableUsersContactInfo < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddG5AuthenticatableUsersContactInfo < ActiveRecord::Migration[4.2]
   def change
     change_table(:g5_authenticatable_users) do |t|
       t.string :first_name

data/spec/dummy/db/migrate/20150429212919_create_g5_authenticatable_roles.rb

@@ -1,4 +1,5 @@
-class CreateG5AuthenticatableRoles < ActiveRecord::Migration
+# frozen_string_literal: true
+class CreateG5AuthenticatableRoles < ActiveRecord::Migration[4.2]
   def change
     create_table(:g5_authenticatable_roles) do |t|
       t.string :name