any_login 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777c2dc1222aba1d6d6ea85b46dfb1b47da43e449e6522426756ffcbf7e965f7
-  data.tar.gz: 91c5e4da0d91ecf7d7ebe3cd2eb77cf05fcd8e6ac17bc88ee54b2ef5cb08f7cc
+  metadata.gz: e0dc9ff7dec47ebdcb17659928d9506d65ba25a8c42291a9f15f38bb71503a69
+  data.tar.gz: 72d8bb2f965b20a3aa10d0008f0ce46034064f8218dc0fc23e78ff1c9cde37ab
 SHA512:
-  metadata.gz: f4bde15aaec63b378218426637df030bf262256ef4450fad4d9d51e71fb36e4694ef9fde3965e1f64b19cc3f9d78b59172977f6a37d27c61454bf0eff4bb52f8
-  data.tar.gz: 759e08b870d934eec9dc94da2cb6632c555010ddee5a46558d7513f48ba895a1612803536f959c1ac2b58edf7044f0898a4616b7b1b77d2ba76b505274ece7dc
+  metadata.gz: b4a8c6731ce47c9493e7cfd9b2d2689132243ebb8e8709e1958bd2fd25b41ebe1ea435dd941a030671638425e5cf69ac496e9a8ee2892b4fb88aef1d1fb4d213
+  data.tar.gz: e43dc1fb5665cbc16e3bbc90cc49f4553b840f6c4cd1d91927b5fd1d2a441e4c5fb3aed47de089036192537c86f61541632b9c95191aa63b94730e32919bd438

data/Rakefile

@@ -14,24 +14,39 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../test/rails_apps/devise/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-
 load 'rails/tasks/statistics.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new(:test_devise) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = ['test/devise/**/*_test.rb']
+  t.verbose = false
+end
+
+Rake::TestTask.new(:test_authlogic) do |t|
   t.libs << 'lib'
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.pattern = ['test/authlogic/**/*_test.rb']
   t.verbose = false
 end
 
+Rake::TestTask.new(:test_clearance) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = ['test/clearance/**/*_test.rb']
+  t.verbose = false
+end
 
-task default: :test
+Rake::TestTask.new(:test_sorcery) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = ['test/sorcery/**/*_test.rb']
+  t.verbose = false
+end

data/app/controllers/any_login/application_controller.rb

@@ -1,5 +1,7 @@
 module AnyLogin
   class ApplicationController < ActionController::Base
+    include AnyLogin.provider.constantize::Controller
+    include ::Clearance::Controller if AnyLogin.provider.eql?("AnyLogin::Provider::Clearance")
 
     if AnyLogin.enabled
       if AnyLogin.http_basic_authentication_enabled
@@ -12,7 +14,7 @@ module AnyLogin
       try_not_to_leak_any_login_is_installed
       head 403 && return unless AnyLogin.verify_access_proc.call(self)
       add_to_previous
-      AnyLogin.provider::Controller.instance_method(:any_login_sign_in).bind(self).call
+      AnyLogin.provider.constantize::Controller.instance_method(:any_login_sign_in).bind(self).call
     end
 
     private

data/lib/any_login/engine.rb

@@ -8,46 +8,41 @@ module AnyLogin
 
     initializer 'any_login.helpers' do
       load_provider
-
       ActiveSupport.on_load :action_controller do
-        if Rails::VERSION::MAJOR >= 6
-          AnyLogin.provider::Controller.send :include, Rails.application.routes.url_helpers
-        end
-
-        AnyLogin::ApplicationController.send :include, AnyLogin.provider::Controller
+        AnyLogin.provider.constantize::Controller.send :include, Rails.application.routes.url_helpers
       end
 
       ActiveSupport.on_load :action_view do
-        ActionView::Base.send :include, AnyLogin::ApplicationHelper
+        include AnyLogin::Helpers
       end
     end
 
     private
 
     def load_provider
-      case AnyLogin.provider || provider
-      when :authlogic
-        require 'any_login/providers/authlogic'
-      when :devise
-        require 'any_login/providers/devise'
-      when :clearance
-        require 'any_login/providers/clearance'
-      when :sorcery
-        require 'any_login/providers/sorcery'
+      if (selected_provider = AnyLogin.provider || provider)
+        provider_with_module = "AnyLogin::Provider::#{selected_provider.to_s.capitalize}"
+        if Object.const_defined?(provider_with_module)
+          AnyLogin.provider = provider_with_module
+        else
+          AnyLogin.provider = selected_provider.to_s
+        end
       else
-        throw 'Please use this gem with any of the following gems: Devise, Authlogic or Clearance'
+        throw 'Please use this gem with Devise, Authlogic or Clearance or provide a custom handler class'
       end
     end
 
     def provider
-      if AnyLogin.provider.nil? && Object.const_defined?('Authlogic')
-        :authlogic
-      elsif AnyLogin.provider.nil? && Object.const_defined?('Devise')
-        :devise
-      elsif AnyLogin.provider.nil? && Object.const_defined?('Clearance')
-        :clearance
-      elsif AnyLogin.provider.nil? && Object.const_defined?('Sorcery')
-        :sorcery
+      if AnyLogin.provider.nil?
+        if Object.const_defined?('Authlogic')
+          :authlogic
+        elsif Object.const_defined?('Devise')
+          :devise
+        elsif Object.const_defined?('Clearance')
+          :clearance
+        elsif Object.const_defined?('Sorcery')
+          :sorcery
+        end
       end
     end
 

data/{app/helpers/any_login/application_helper.rb → lib/any_login/helpers.rb}

@@ -1,5 +1,5 @@
 module AnyLogin
-  module ApplicationHelper
+  module Helpers
     extend ActiveSupport::Concern
 
     def any_login_here
@@ -9,7 +9,7 @@ module AnyLogin
     if AnyLogin.enabled
 
       def any_login_id_input
-        text_field_tag :id, '', :placeholder => 'ID', :id => 'any_login_id_input'
+        text_field_tag :id, '', :placeholder => 'ID', :id => 'any_login_id_input', :required => true
       end
 
       def any_login_submit
@@ -66,8 +66,8 @@ module AnyLogin
       end
 
       def current_user_information
-        if respond_to?(AnyLogin.provider::Controller.any_login_current_user_method) &&
-           user = send(AnyLogin.provider::Controller.any_login_current_user_method)
+        if respond_to?(AnyLogin.provider.constantize::Controller.any_login_current_user_method) &&
+           user = send(AnyLogin.provider.constantize::Controller.any_login_current_user_method)
           content_tag :span, :class => 'any_login_user_information' do
             if AnyLogin.name_method.is_a?(Symbol)
               raw("Current #{AnyLogin.klass_name}: #{h(user.send(AnyLogin.name_method)[0])} — ID: #{user.id}")
@@ -77,8 +77,6 @@ module AnyLogin
           end
         end
       end
-
     end
-
   end
 end

data/lib/any_login/providers/authlogic.rb

@@ -5,7 +5,7 @@ module AnyLogin
       module Controller
 
         def self.any_login_current_user_method
-          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.underscore}".to_sym
+          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.parameterize.underscore}".to_sym
         end
 
         def any_login_sign_in
@@ -20,5 +20,3 @@ module AnyLogin
     end
   end
 end
-
-AnyLogin.provider = AnyLogin::Provider::Authlogic

data/lib/any_login/providers/clearance.rb

@@ -5,7 +5,7 @@ module AnyLogin
       module Controller
 
         def self.any_login_current_user_method
-          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.underscore}".to_sym
+          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.parameterize.underscore}".to_sym
         end
 
         def any_login_sign_in
@@ -20,7 +20,3 @@ module AnyLogin
     end
   end
 end
-
-AnyLogin.provider = AnyLogin::Provider::Clearance
-
-AnyLogin::ApplicationController.send(:include, ::Clearance::Controller)

data/lib/any_login/providers/devise.rb

@@ -6,11 +6,11 @@ module AnyLogin
 
         DEFAULT_SIGN_IN = proc do |loginable|
           reset_session
-          sign_in AnyLogin.klass.to_s.underscore.to_sym, loginable
+          sign_in AnyLogin.klass.to_s.parameterize.underscore.to_sym, loginable
         end
 
         def self.any_login_current_user_method
-          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.underscore}".to_sym
+          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.parameterize.underscore}".to_sym
         end
 
         def any_login_sign_in
@@ -27,5 +27,3 @@ module AnyLogin
     end
   end
 end
-
-AnyLogin.provider = AnyLogin::Provider::Devise

data/lib/any_login/providers/sorcery.rb

@@ -5,7 +5,7 @@ module AnyLogin
       module Controller
 
         def self.any_login_current_user_method
-          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.underscore}".to_sym
+          @@any_login_current_user_method ||= "current_#{AnyLogin.klass.to_s.parameterize.underscore}".to_sym
         end
 
         def any_login_sign_in
@@ -20,5 +20,3 @@ module AnyLogin
     end
   end
 end
-
-AnyLogin.provider = AnyLogin::Provider::Sorcery

data/lib/any_login/version.rb

@@ -1,3 +1,3 @@
 module AnyLogin
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end

data/lib/any_login.rb

@@ -1,6 +1,9 @@
 require 'any_login/engine'
 
 module AnyLogin
+  extend ActiveSupport::Autoload
+
+  autoload :Helpers
 
   module Provider
     autoload :Devise,    'any_login/providers/devise'

data/test/authlogic/integration/navigation_test.rb

@@ -0,0 +1,25 @@
+require_relative '../test_helper_authlogic'
+
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  setup do
+    @user = User.create(name: "test", email: "test@test.com", password: "password123", role: "user")
+  end
+
+  test "user cannot navigate to about page without login" do
+    visit "/about"
+
+    assert_no_text("This is secret page available only for logged in users")
+  end
+
+  test "it properly logs users in and allows access to the secret page" do
+    visit "/"
+
+    find("#any_login_form").click
+    find('#selected_id option:last-of-type').select_option
+
+    visit "/about"
+
+    assert_text("This is secret page available only for logged in users")
+  end
+end

data/test/authlogic/test_helper_authlogic.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] = "test"
+
+require_relative "../rails_apps/authlogic/config/environment"
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../rails_apps/authlogic/db/migrate", __dir__)]
+require "test_helper_common"

data/test/clearance/integration/navigation_test.rb

@@ -0,0 +1,24 @@
+require_relative '../test_helper_clearance'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  setup do
+    @user = User.create(name: "test", email: "test@test.com", password: "password123", role: "user")
+  end
+
+  test "user cannot navigate to about page without login" do
+    visit "/about"
+
+    assert_no_text("This is secret page available only for logged in users")
+  end
+
+  test "it properly logs users in and allows access to the secret page" do
+    visit "/"
+
+    find("#any_login_form").click
+    find('#selected_id option:last-of-type').select_option
+
+    visit "/about"
+
+    assert_text("This is secret page available only for logged in users")
+  end
+end

data/test/clearance/test_helper_clearance.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] = "test"
+
+require_relative "../rails_apps/clearance/config/environment"
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../rails_apps/clearance/db/migrate", __dir__)]
+require "test_helper_common"

data/test/devise/integration/navigation_test.rb

@@ -0,0 +1,26 @@
+require_relative "../test_helper_devise"
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  setup do
+    @user = User.create(name: "test", email: "test@test.com", password: "password123", role: "user")
+  end
+
+  test "user cannot navigate to about page without login" do
+    visit "/about"
+
+    assert_no_text("This is secret page available only for logged in users")
+  end
+
+  test "it properly logs users in and allows access to the secret page" do
+    visit "/"
+
+    find("#any_login_form").click
+    # There is an instability in the test suite where the option on the dropdown sometimes shows
+    # up as `1` and sometimes shows up as `test@test.com`. This works around the issue.
+    find('#selected_id option:last-of-type').select_option
+
+    visit "/about"
+
+    assert_text("This is secret page available only for logged in users")
+  end
+end

data/test/devise/test_helper_devise.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] = "test"
+
+require_relative "../rails_apps/devise/config/environment"
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../rails_apps/devise/db/migrate", __dir__)]
+require_relative "../test_helper_common"

data/test/{any_login_test.rb → devise/unit/any_login_test.rb}

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative "../test_helper_devise"
 
 class AnyLoginTest < ActiveSupport::TestCase
   test "truth" do

data/test/{any_login → devise/unit}/collection_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "../test_helper_devise"
 
 module AnyLogin
   class CollectionTest < ActiveSupport::TestCase

data/test/{dummy-authlogic → rails_apps/authlogic}/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative "config/application"
 
 Rails.application.load_tasks

data/test/rails_apps/authlogic/app/assets/config/manifest.js

@@ -0,0 +1 @@
+{}

data/test/{dummy-authlogic → rails_apps/authlogic}/app/controllers/home_controller.rb

@@ -1,5 +1,5 @@
 class HomeController < ApplicationController
-  before_filter :require_user, :only => [:about]
+  before_action :require_user, :only => [:about]
 
   def index
   end

data/test/rails_apps/authlogic/app/views/layouts/application.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>AnyLogin Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <!-- Latest compiled and minified CSS -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.4.1/dist/css/bootstrap.min.css" integrity="sha384-HSMxcRTRxnN+Bdg0JdbxYKrThecOKuH5zCYotlSAcp1+c8xmyTe9GYg1l9a69psu" crossorigin="anonymous">
+
+    <!-- Optional theme -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.4.1/dist/css/bootstrap-theme.min.css" integrity="sha384-6pzBo3FDv/PJ8r2KRkGHifhEocL+1X2rVCTTkUfGk7/0pbek5mMa1upzvWbrUbOZ" crossorigin="anonymous">
+
+    <!-- Include JQuery as required by bootstrap -->
+    <script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" crossorigin="anonymous"></script>
+
+    <!-- Latest compiled and minified JavaScript -->
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@3.4.1/dist/js/bootstrap.min.js" integrity="sha384-aJ21OjlMXNL5UyIl/XNwTMqvzeRMZH2w8c5cRVpzpU8Y5bApTppSuUkhZXN0VxHd" crossorigin="anonymous"></script>
+
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+  </head>
+
+  <body role="document">
+    <%= render '/shared/header' %>
+    <div class="container theme-showcase" role="main">
+      <%= yield %>
+    </div>
+    <%= render '/shared/footer' %>
+  </body>
+</html>

data/test/rails_apps/authlogic/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/test/rails_apps/authlogic/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/test/rails_apps/authlogic/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/test/rails_apps/authlogic/config/application.rb

@@ -0,0 +1,25 @@
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require "any_login"
+
+module DummyAuthlogic
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # For compatibility with applications that use this config
+    config.action_controller.include_all_helpers = false
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/test/rails_apps/authlogic/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)

data/test/{dummy-sorcery → rails_apps/authlogic}/config/database.yml

@@ -1,12 +1,12 @@
-# SQLite version 3.x
+# SQLite. Versions 3.8.0 and up are supported.
 #   gem install sqlite3
 #
 #   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
+#   gem "sqlite3"
 #
 default: &default
   adapter: sqlite3
-  pool: 5
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
   timeout: 5000
 
 development:

data/test/{dummy-authlogic → rails_apps/authlogic}/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the Rails application.
-require File.expand_path('../application', __FILE__)
+require_relative "application"
 
 # Initialize the Rails application.
 Rails.application.initialize!

data/test/rails_apps/authlogic/config/environments/development.rb

@@ -0,0 +1,70 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing
+  config.server_timing = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end