devise_g5_authenticatable 0.3.0 → 1.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d88c2b75b20608b04708cd0ce1d48f90a0c6ee
-  data.tar.gz: 470beef996c9d67de0dee57eaf7efaf5e009034a
+  metadata.gz: a11e733f9faf284c0658f3db8ddc5274801adc24
+  data.tar.gz: 1f581b95a86073de698cf08447006fd64799b05d
 SHA512:
-  metadata.gz: 58013eb741a22fe0bf9bd388aee212596b4257a2a73aca75870c60f248d171c92afb37b595c9530eefcb4f6dfb4e5575862f3919e8bb929b4c525027aa808e32
-  data.tar.gz: 90df8abd423ddff26f7cf60bd7cdfc4eb0957ac07981beb96fa6ef37f505488c87ac6f945ad4bd69af9c0dda73403e0b9ea5036767121a906c2a90b7aca45329
+  metadata.gz: 026e2a728bf15e6903536c7c81f4470a3fe224a2f357b64b496b1dd3776b73d5adcec266275eced538552913430259b46c3f41ebc2ab2d8dd726c1bd67645e84
+  data.tar.gz: 47e3a3d42727b2333b2b0260baee1bfeab0c02e6a8c83b3a653636f5f7657ad9cd6d9b8cb6e97e5f3339e8d5af462dd54756c4b574d05b10a413c32a4aeff0fa

data/.gitignore

@@ -5,6 +5,7 @@
 .config
 coverage
 Gemfile.lock
+gemfiles/*.gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format progress
+--require spec_helper

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.3.4

data/.travis.yml

@@ -1,13 +1,35 @@
 language: ruby
+cache:
+  bundler: true
 rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+gemfile:
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+matrix:
+  exclude:
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails_4.1.gemfile
+  allow_failures:
+    - rvm: 2.4.1
+dist: trusty
+sudo: false
+cache:
+  bundler: true
 before_install:
   - gem update bundler
-script:
-  - RAILS_ENV=test bundle exec rake app:db:setup
-  - bundle exec rspec spec
 before_script:
   - cp spec/dummy/config/database.yml.ci spec/dummy/config/database.yml
-  - psql -c 'create database g5_authenticatable_test;' -U postgres
+  - RAILS_ENV=test bundle exec rake app:db:create app:db:migrate
+script:
+  - bundle exec rspec
+after_script:
+  - bundle exec codeclimate-test-reporter
+addons:
+  code_climate:
+    repo_token:
+      secure: "jbxU8cHiS9V0vEndXRhMmteIYSyy2oq/V6S0HEqezA5nrAAnOPcLHaVhEM2Ji81G5V/k/Wda3xJ+4mXG2VU71RWCpMkWuB4M/KzAozmvxUxM7YwSfZvdYDL4AsWO+2Nvz7jDLiSTYYLigSAF5tQiD8Q6/KywcBJsXTuC5b9PTgg="

data/Appraisals

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+appraise 'rails-4.1' do
+  gem 'protected_attributes'
+  gem 'rails', '~> 4.1.16'
+end
+
+appraise 'rails-4.2' do
+  gem 'protected_attributes'
+  gem 'rails', '~> 4.2.8'
+end
+
+appraise 'rails-5.0' do
+  gem 'rails', '~> 5.0.3'
+  gem 'rails-controller-testing', group: :test
+end
+
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1.1'
+  gem 'rails-controller-testing', group: :test
+end

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## v1.0.0.pre.1 (TBD)
+
+* **Backwards incompatible changes**
+  * Dropped support for rails < 4.1
+  * Dropped support for ruby < 2.2 (older versions *may* continue to work for
+  now, but there are no guarantees)
+  * Dropped support for devise < 4.3. The breaking change most likely to affect
+  users of this gem is the removal of omniauth route helpers with a wildcard
+  `:provider` parameter. However, the other forms of omniauth route helpers
+  still work. For example, `user_omniauth_authorize_path(:g5)` is no longer
+  valid, but you can still use `user_g5_omniauth_authorize_path` (preferred)
+  or `omniauth_authorize_path(:user, :g5)`
+* Enhancements
+  * Added support for ruby 2.3 and 2.4
+  * Added support for rails 5.0 and 5.1
+* Bug fixes
+  * The devise upgrade picked up a number of bug fixes, most notably the
+  `FailureApp` nil `script_name` issue introduced in devise 3.5.2, which broke
+  route generation within mounted engines (see
+  [plataformatec/devise#3705](https://github.com/plataformatec/devise/issues/3705))
+
 ## v0.3.0 (2016-11-03)
 
 * Exposes callbacks for more fine-grained control over mapping auth user
@@ -5,12 +26,15 @@
   ([#25](https://github.com/G5/devise_g5_authenticatable/pull/25))
 
 ## v0.2.4 (2015-12-09)
+
 * Same as v0.2.4.beta but not is a stable version!
 
 ## v0.2.4.beta (2015-12-03)
+
 * Enforces uniqueness of email address in when looking for an email without UID
 
 ## v0.2.3 (2015-11-30)
+
 * Pins version of devise to 3.5.1 due - https://github.com/plataformatec/devise/issues/3705
 * Pins version of omniauth-g5 to v0.3.1 due - https://github.com/G5/omniauth-g5/pull/10
 

data/Gemfile

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in devise_g5_authenticatable.gemspec
 gemspec
 
 # Dependencies for the dummy test app
-gem 'rails', '4.1.4'
 gem 'jquery-rails'
 gem 'pg'
-gem 'protected_attributes'
+
+# See the Appraisals file for all supported rails versions
+gem 'rails', '~> 5.1.1'
 
 group :test, :development do
-  gem 'rspec-rails', '~> 2.14'
-  gem 'rspec-activemodel-mocks'
+  gem 'appraisal'
   gem 'pry-byebug'
+  gem 'rspec-rails', '~> 3.6'
 end
 
 group :test do
   gem 'capybara'
+  gem 'codeclimate-test-reporter', '~> 1.0'
+  gem 'factory_girl_rails', '~> 4.8', require: false
+  gem 'rspec-activemodel-mocks'
+  gem 'shoulda-matchers', '~> 3.1'
   gem 'simplecov'
-  gem 'codeclimate-test-reporter'
   gem 'webmock'
-  gem 'shoulda-matchers', '~> 2.6'
-  gem 'factory_girl_rails', '~> 4.3', require: false
 end

data/README.md

@@ -10,13 +10,13 @@ G5 users.
 
 ## Current Version
 
-0.3.0
+1.0.0.pre.1
 
 ## Requirements
 
-* [Ruby](https://github.com/ruby/ruby) >= 2.0.0
-* [Rails](https://github.com/rails/rails) >= 3.2
-* [Devise](https://github.com/plataformatec/devise) ~> 3.5
+* [Ruby](https://github.com/ruby/ruby) >= 2.2
+* [Rails](https://github.com/rails/rails) >= 4.1
+* [Devise](https://github.com/plataformatec/devise) ~> 4.3
 
 ## Installation
 
@@ -90,10 +90,10 @@ end
 ### Controller filters and helpers
 
 To require authentication for a controller, use one of devise's generated
-before_filters. For example:
+before_actions. For example:
 
 ```ruby
-before_filter :authenticate_user!
+before_action :authenticate_user!
 ```
 
 All of [devise's controller helpers](https://github.com/plataformatec/devise#controller-filters-and-helpers)

data/Rakefile

@@ -1,11 +1,12 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
@@ -15,6 +16,6 @@ Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
-task :default => :spec
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+task default: :spec

data/app/controllers/devise_g5_authenticatable/registrations_controller.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
+  # Registrations controller with custom error handling
   class RegistrationsController < Devise::RegistrationsController
     rescue_from ActiveRecord::RecordNotSaved, with: :handle_resource_error
   end

data/app/controllers/devise_g5_authenticatable/sessions_controller.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
+  # Custom sessions controller to require sign-in through the G5 auth server
   class SessionsController < Devise::OmniauthCallbacksController
-    prepend_before_filter :require_no_authentication, only: [:new, :create]
+    prepend_before_action :require_no_authentication, only: %i[new create]
 
     def new
       redirect_to g5_authorize_path(resource_name)
     end
 
     def omniauth_passthru
-      render status: 404, text: 'Authentication passthru.'
+      render status: 404, plain: 'Authentication passthru.'
     end
 
     def create
@@ -22,6 +25,7 @@ module DeviseG5Authenticatable
     end
 
     protected
+
     def auth_data
       @auth_data ||= request.env['omniauth.auth']
       session['omniauth.auth'] = @auth_data
@@ -42,8 +46,8 @@ module DeviseG5Authenticatable
     end
 
     def remote_sign_out
-      redirect_url =  URI.join(request.base_url,
-                               after_sign_out_path_for(resource_name))
+      redirect_url = URI.join(request.base_url,
+                              after_sign_out_path_for(resource_name))
       redirect_to auth_client.sign_out_url(redirect_url.to_s)
     end
 
@@ -51,7 +55,7 @@ module DeviseG5Authenticatable
       G5AuthenticationClient::Client.new
     end
 
-    def after_omniauth_failure_path_for(scope)
+    def after_omniauth_failure_path_for(_scope)
       main_app.root_path
     end
 

data/config/initializers/devise_g5_authenticatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unless defined?(ActionController::StrongParameters)
   require 'devise_g5_authenticatable/models/protected_attributes'
 end

data/devise_g5_authenticatable.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'devise_g5_authenticatable/version'
@@ -6,6 +8,7 @@ require 'devise_g5_authenticatable/version'
 Gem::Specification.new do |spec|
   spec.name          = 'devise_g5_authenticatable'
   spec.version       = DeviseG5Authenticatable::VERSION
+  spec.platform      = Gem::Platform::RUBY
   spec.authors       = ['Maeve Revels']
   spec.email         = ['maeve.revels@getg5.com']
   spec.description   = 'Devise extension for the G5 Auth service'
@@ -13,15 +16,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/G5/devise_g5_authenticatable'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  # Pinned to version 3.5.1 due https://github.com/plataformatec/devise/issues/3705
-  # "`FailureApp`s `script_name: nil` breaks route generation within mounted engines #3705"
-  spec.add_dependency 'devise', '= 3.5.1'
-  spec.add_dependency 'g5_authentication_client', '~> 0.5', '>= 0.5.4'
+  spec.add_dependency 'devise', '~> 4.3'
+  spec.add_dependency 'g5_authentication_client', '1.0.0.pre.4'
 
   # Pinned to version 0.3.1 due https://github.com/G5/omniauth-g5/pull/10
   # Omniauth-auth2 removed 'callback_url' which broke our auth workflow

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,26 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jquery-rails"
+gem "pg"
+gem "rails", "~> 4.1.16"
+gem "protected_attributes"
+
+group :test, :development do
+  gem "appraisal"
+  gem "pry-byebug"
+  gem "rspec-rails", "~> 3.6"
+end
+
+group :test do
+  gem "capybara"
+  gem "codeclimate-test-reporter", "~> 1.0"
+  gem "factory_girl_rails", "~> 4.8", require: false
+  gem "rspec-activemodel-mocks"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov"
+  gem "webmock"
+end
+
+gemspec path: "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,26 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jquery-rails"
+gem "pg"
+gem "rails", "~> 4.2.8"
+gem "protected_attributes"
+
+group :test, :development do
+  gem "appraisal"
+  gem "pry-byebug"
+  gem "rspec-rails", "~> 3.6"
+end
+
+group :test do
+  gem "capybara"
+  gem "codeclimate-test-reporter", "~> 1.0"
+  gem "factory_girl_rails", "~> 4.8", require: false
+  gem "rspec-activemodel-mocks"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov"
+  gem "webmock"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,26 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jquery-rails"
+gem "pg"
+gem "rails", "~> 5.0.3"
+gem "rails-controller-testing", group: :test
+
+group :test, :development do
+  gem "appraisal"
+  gem "pry-byebug"
+  gem "rspec-rails", "~> 3.6"
+end
+
+group :test do
+  gem "capybara"
+  gem "codeclimate-test-reporter", "~> 1.0"
+  gem "factory_girl_rails", "~> 4.8", require: false
+  gem "rspec-activemodel-mocks"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov"
+  gem "webmock"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,26 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jquery-rails"
+gem "pg"
+gem "rails", "~> 5.1.1"
+gem "rails-controller-testing", group: :test
+
+group :test, :development do
+  gem "appraisal"
+  gem "pry-byebug"
+  gem "rspec-rails", "~> 3.6"
+end
+
+group :test do
+  gem "capybara"
+  gem "codeclimate-test-reporter", "~> 1.0"
+  gem "factory_girl_rails", "~> 4.8", require: false
+  gem "rspec-activemodel-mocks"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov"
+  gem "webmock"
+end
+
+gemspec path: "../"

data/lib/devise_g5_authenticatable/controllers/helpers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
+  # Utility helper methods to mixin to controllers
   module Helpers
     extend ActiveSupport::Concern
 
@@ -23,6 +26,8 @@ module DeviseG5Authenticatable
       respond_with(resource)
     end
 
+    # Dynamically generate helper methods with devise resource name
+    # e.g. `set_updated_by_user` or `set_updated_by_admin`
     module ClassMethods
       def define_helpers(mapping)
         class_eval <<-METHODS, __FILE__, __LINE__ + 1

data/lib/devise_g5_authenticatable/controllers/url_helpers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
+  # Routing helpers for G5 omniuath routes
   module UrlHelpers
     def g5_authorize_path(resource_or_scope, *args)
       scope = Devise::Mapping.find_scope!(resource_or_scope)

data/lib/devise_g5_authenticatable/engine.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module DeviseG5Authenticatable
+  # The main class for initializing the rails engine
   class Engine < Rails::Engine
-    initializer "devise_g5_authenticatable.helpers" do
+    initializer 'devise_g5_authenticatable.helpers' do
       Devise.include_helpers(DeviseG5Authenticatable)
     end
 

data/lib/devise_g5_authenticatable/g5/auth_password_validator.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'g5_authentication_client'
 
 module Devise
   module G5
+    # Validate a user's G5 Auth credentials
     class AuthPasswordValidator
       attr_reader :model
 
@@ -22,8 +25,10 @@ module Devise
       end
 
       private
+
       def auth_client(password)
-        G5AuthenticationClient::Client.new(username: model.email, password: password)
+        G5AuthenticationClient::Client.new(username: model.email,
+                                           password: password)
       end
     end
   end

data/lib/devise_g5_authenticatable/g5/auth_user_creator.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'g5_authentication_client'
 
 module Devise
   module G5
+    # Create a new user account on the G5 Auth server
     class AuthUserCreator
       attr_reader :model
 
@@ -14,20 +17,16 @@ module Devise
       end
 
       private
+
       def create_auth_user
-        set_auth_attributes(auth_user)
+        update_auth_attributes(auth_user)
       end
 
       def auth_user
-        begin
-          auth_client.create_user(auth_user_args)
-        rescue  StandardError => e
-          if e.message =~ /Email has already been taken/
-            existing_auth_user
-          else
-            raise e
-          end
-        end
+        auth_client.create_user(auth_user_args)
+      rescue StandardError => error
+        raise error unless error.message =~ /Email has already been taken/
+        existing_auth_user
       end
 
       def existing_auth_user
@@ -43,7 +42,9 @@ module Devise
       end
 
       def auth_client
-        G5AuthenticationClient::Client.new(access_token: updated_by.g5_access_token)
+        G5AuthenticationClient::Client.new(
+          access_token: updated_by.g5_access_token
+        )
       end
 
       def updated_by
@@ -51,12 +52,12 @@ module Devise
       end
 
       def auth_user_args
-        {email: model.email,
-         password: model.password,
-         password_confirmation: model.password_confirmation}
+        { email: model.email,
+          password: model.password,
+          password_confirmation: model.password_confirmation }
       end
 
-      def set_auth_attributes(auth_user)
+      def update_auth_attributes(auth_user)
         model.provider = 'g5'
         model.uid = auth_user.id
         model.clean_up_passwords

data/lib/devise_g5_authenticatable/g5/auth_user_updater.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'g5_authentication_client'
 
 module Devise
   module G5
+    # Update user data on G5 Auth server
     class AuthUserUpdater
       attr_reader :model
 
@@ -14,6 +17,7 @@ module Devise
       end
 
       private
+
       def update_auth_user
         auth_user = auth_client.update_user(auth_user_args)
         model.clean_up_passwords
@@ -25,7 +29,9 @@ module Devise
       end
 
       def auth_client
-        G5AuthenticationClient::Client.new(access_token: updated_by.g5_access_token)
+        G5AuthenticationClient::Client.new(
+          access_token: updated_by.g5_access_token
+        )
       end
 
       def updated_by
@@ -33,10 +39,10 @@ module Devise
       end
 
       def auth_user_args
-        {id: model.uid,
-         email: model.email,
-         password: model.password,
-         password_confirmation: model.password_confirmation}
+        { id: model.uid,
+          email: model.email,
+          password: model.password,
+          password_confirmation: model.password_confirmation }
       end
     end
   end

data/lib/devise_g5_authenticatable/g5/user_exporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'g5_authentication_client'
 
 module G5
@@ -11,7 +13,7 @@ module G5
     # @option options [String] :redirect_uri the redirect URI registered with G5
     # @option options [String] :endpoint the endpoint for the G5 Auth server
     # @option options [String] :authorization_code the G5 authorization code to obtain an access token
-    def initialize(options={})
+    def initialize(options = {})
       @client_id = options[:client_id]
       @client_secret = options[:client_secret]
       @redirect_uri = options[:redirect_uri]
@@ -40,6 +42,7 @@ module G5
     end
 
     private
+
     def update_local_user(local_user, auth_user)
       local_user.uid = auth_user.id
       local_user.provider = 'g5'
@@ -51,11 +54,13 @@ module G5
     end
 
     def auth_client
-      @oauth_client ||= G5AuthenticationClient::Client.new(client_id: @client_id,
-                                        client_secret: @client_secret,
-                                        redirect_uri: @redirect_uri,
-                                        endpoint: @endpoint,
-                                        authorization_code: @authorization_code)
+      @oauth_client ||= G5AuthenticationClient::Client.new(
+        client_id: @client_id,
+        client_secret: @client_secret,
+        redirect_uri: @redirect_uri,
+        endpoint: @endpoint,
+        authorization_code: @authorization_code
+      )
     end
   end
 end

data/lib/devise_g5_authenticatable/g5.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'devise_g5_authenticatable/g5/auth_user_creator'
 require 'devise_g5_authenticatable/g5/auth_user_updater'
 require 'devise_g5_authenticatable/g5/auth_password_validator'