rodauth-rails 1.2.2 → 1.4.0

data/lib/generators/rodauth/templates/app/mailers/rodauth_mailer.rb

@@ -1,14 +1,22 @@
 class RodauthMailer < ApplicationMailer
   def verify_account(account_id, key)
     @email_link = rodauth.verify_account_url(key: email_token(account_id, key))
+<% if defined?(ActiveRecord::Railtie) -%>
     @account = Account.find(account_id)
+<% else -%>
+    @account = Account.with_pk!(account_id)
+<% end -%>
 
     mail to: @account.email, subject: rodauth.verify_account_email_subject
   end
 
   def reset_password(account_id, key)
     @email_link = rodauth.reset_password_url(key: email_token(account_id, key))
+<% if defined?(ActiveRecord::Railtie) -%>
     @account = Account.find(account_id)
+<% else -%>
+    @account = Account.with_pk!(account_id)
+<% end -%>
 
     mail to: @account.email, subject: rodauth.reset_password_email_subject
   end
@@ -17,27 +25,43 @@ class RodauthMailer < ApplicationMailer
     @old_login  = old_login
     @new_login  = new_login
     @email_link = rodauth.verify_login_change_url(key: email_token(account_id, key))
+<% if defined?(ActiveRecord::Railtie) -%>
     @account = Account.find(account_id)
+<% else -%>
+    @account = Account.with_pk!(account_id)
+<% end -%>
 
     mail to: new_login, subject: rodauth.verify_login_change_email_subject
   end
 
   def password_changed(account_id)
+<% if defined?(ActiveRecord::Railtie) -%>
     @account = Account.find(account_id)
+<% else -%>
+    @account = Account.with_pk!(account_id)
+<% end -%>
 
     mail to: @account.email, subject: rodauth.password_changed_email_subject
   end
 
   # def email_auth(account_id, key)
   #   @email_link = rodauth.email_auth_url(key: email_token(account_id, key))
+<% if defined?(ActiveRecord::Railtie) -%>
   #   @account = Account.find(account_id)
+<% else -%>
+  #   @account = Account.with_pk!(account_id)
+<% end -%>
 
   #   mail to: @account.email, subject: rodauth.email_auth_email_subject
   # end
 
   # def unlock_account(account_id, key)
   #   @email_link = rodauth.unlock_account_url(key: email_token(account_id, key))
+<% if defined?(ActiveRecord::Railtie) -%>
   #   @account = Account.find(account_id)
+<% else -%>
+  #   @account = Account.with_pk!(account_id)
+<% end -%>
 
   #   mail to: @account.email, subject: rodauth.unlock_account_email_subject
   # end

data/lib/generators/rodauth/templates/app/misc/rodauth_main.rb

@@ -35,7 +35,7 @@ class RodauthMain < Rodauth::Rails::Auth
     account_status_column :status
 
     # Store password hash in a column instead of a separate table.
-    # account_password_hash_column :password_digest
+    account_password_hash_column :password_hash
 
     # Set password when creating account instead of when verifying.
     verify_account_set_password? false
@@ -138,6 +138,9 @@ class RodauthMain < Rodauth::Rails::Auth
 
     # Redirect to login page after password reset.
     reset_password_redirect { login_path }
+
+    # Ensure requiring login follows login route changes.
+    require_login_redirect { login_path }
 <% end -%>
 
     # ==> Deadlines

data/lib/generators/rodauth/templates/app/models/account.rb

@@ -1,4 +1,15 @@
+<% if defined?(ActiveRecord::Railtie) -%>
 class Account < ApplicationRecord
   include Rodauth::Rails.model
+<% if ActiveRecord.version >= Gem::Version.new("7.0") -%>
   enum :status, unverified: 1, verified: 2, closed: 3
+<% else -%>
+  enum status: { unverified: 1, verified: 2, closed: 3 }
+<% end -%>
 end
+<% else -%>
+class Account < Sequel::Model
+  plugin :enum
+  enum :status, unverified: 1, verified: 2, closed: 3
+end
+<% end -%>

data/lib/generators/rodauth/templates/db/migrate/create_rodauth.rb

@@ -1,5 +1,13 @@
+<% if defined?(::ActiveRecord::Railtie) -%>
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
 <%= migration_content -%>
   end
 end
+<% else -%>
+Sequel.migration do
+  change do
+<%= migration_content -%>
+  end
+end
+<% end -%>

data/lib/rodauth/rails/app.rb

@@ -5,17 +5,21 @@ module Rodauth
   module Rails
     # The superclass for creating a Rodauth middleware.
     class App < Roda
-      require "rodauth/rails/app/middleware"
-      plugin Middleware
+      plugin :middleware, forward_response_headers: true do |middleware|
+        middleware.class_eval do
+          def self.inspect
+            "#{superclass}::Middleware"
+          end
+
+          def inspect
+            "#<#{self.class.inspect} request=#{request.inspect} response=#{response.inspect}>"
+          end
+        end
+      end
 
       plugin :hooks
       plugin :render, layout: false
 
-      unless Rodauth::Rails.api_only?
-        require "rodauth/rails/app/flash"
-        plugin Flash
-      end
-
       def self.configure(*args, **options, &block)
         auth_class = args.shift if args[0].is_a?(Class)
         name       = args.shift if args[0].is_a?(Symbol)
@@ -35,6 +39,14 @@ module Rodauth
         end
       end
 
+      after do
+        rails_request.commit_flash
+      end unless ActionPack.version < Gem::Version.new("5.0")
+
+      def flash
+        rails_request.flash
+      end
+
       def rails_routes
         ::Rails.application.routes.url_helpers
       end

data/lib/rodauth/rails/controller_methods.rb

@@ -18,6 +18,15 @@ module Rodauth
 
       private
 
+      # Adds response status to instrumentation payload for logging,
+      # when calling a halting rodauth method inside a controller.
+      def append_info_to_payload(payload)
+        super
+        if request.env["rodauth.rails.status"]
+          payload[:status] = request.env.delete("rodauth.rails.status")
+        end
+      end
+
       def rodauth_response
         res = catch(:halt) { return yield }
 

data/lib/rodauth/rails/feature/associations.rb

@@ -0,0 +1,54 @@
+module Rodauth
+  module Rails
+    module Feature
+      module Associations
+        def associations
+          list = []
+
+          features.each do |feature|
+            case feature
+            when :remember
+              list << { name: :remember_key, type: :one, table: remember_table, foreign_key: remember_id_column }
+            when :verify_account
+              list << { name: :verification_key, type: :one, table: verify_account_table, foreign_key: verify_account_id_column }
+            when :reset_password
+              list << { name: :password_reset_key, type: :one, table: reset_password_table, foreign_key: reset_password_id_column }
+            when :verify_login_change
+              list << { name: :login_change_key, type: :one, table: verify_login_change_table, foreign_key: verify_login_change_id_column }
+            when :lockout
+              list << { name: :lockout, type: :one, table: account_lockouts_table, foreign_key: account_lockouts_id_column }
+              list << { name: :login_failure, type: :one, table: account_login_failures_table, foreign_key: account_login_failures_id_column }
+            when :email_auth
+              list << { name: :email_auth_key, type: :one, table: email_auth_table, foreign_key: email_auth_id_column }
+            when :account_expiration
+              list << { name: :activity_time, type: :one, table: account_activity_table, foreign_key: account_activity_id_column }
+            when :active_sessions
+              list << { name: :active_session_keys, type: :many, table: active_sessions_table, foreign_key: active_sessions_account_id_column }
+            when :audit_logging
+              list << { name: :authentication_audit_logs, type: :many, table: audit_logging_table, foreign_key: audit_logging_account_id_column }
+            when :disallow_password_reuse
+              list << { name: :previous_password_hashes, type: :many, table: previous_password_hash_table, foreign_key: previous_password_account_id_column }
+            when :jwt_refresh
+              list << { name: :jwt_refresh_keys, type: :many, table: jwt_refresh_token_table, foreign_key: jwt_refresh_token_account_id_column }
+            when :password_expiration
+              list << { name: :password_change_time, type: :one, table: password_expiration_table, foreign_key: password_expiration_id_column }
+            when :single_session
+              list << { name: :session_key, type: :one, table: single_session_table, foreign_key: single_session_id_column }
+            when :otp
+              list << { name: :otp_key, type: :one, table: otp_keys_table, foreign_key: otp_keys_id_column }
+            when :sms_codes
+              list << { name: :sms_code, type: :one, table: sms_codes_table, foreign_key: sms_id_column }
+            when :recovery_codes
+              list << { name: :recovery_codes, type: :many, table: recovery_codes_table, foreign_key: recovery_codes_id_column }
+            when :webauthn
+              list << { name: :webauthn_user_id, type: :one, table: webauthn_user_ids_table, foreign_key: webauthn_user_ids_account_id_column }
+              list << { name: :webauthn_keys, type: :many, table: webauthn_keys_table, foreign_key: webauthn_keys_account_id_column }
+            end
+          end
+
+          list
+        end
+      end
+    end
+  end
+end

data/lib/rodauth/rails/feature/base.rb

@@ -54,6 +54,16 @@ module Rodauth
 
         private
 
+        unless ActionPack.version < Gem::Version.new("5.0")
+          # When calling a Rodauth method that redirects inside the Rails
+          # router, Roda's after hook that commits the flash would never get
+          # called, so we make sure to commit the flash beforehand.
+          def redirect(*)
+            rails_request.commit_flash
+            super
+          end
+        end
+
         def instantiate_rails_account
           if defined?(ActiveRecord::Base) && rails_account_model < ActiveRecord::Base
             rails_account_model.instantiate(account.stringify_keys)

data/lib/rodauth/rails/feature/instrumentation.rb

@@ -10,6 +10,14 @@ module Rodauth
 
         def redirect(*)
           rails_instrument_redirection { super }
+        ensure
+          request.env["rodauth.rails.status"] = response.status
+        end
+
+        def return_response(*)
+          super
+        ensure
+          request.env["rodauth.rails.status"] = response.status
         end
 
         def rails_render(*)

data/lib/rodauth/rails/feature.rb

@@ -11,6 +11,7 @@ module Rodauth
     require "rodauth/rails/feature/email"
     require "rodauth/rails/feature/instrumentation"
     require "rodauth/rails/feature/internal_request"
+    require "rodauth/rails/feature/associations"
 
     include Rodauth::Rails::Feature::Base
     include Rodauth::Rails::Feature::Callbacks
@@ -19,5 +20,6 @@ module Rodauth
     include Rodauth::Rails::Feature::Email
     include Rodauth::Rails::Feature::Instrumentation
     include Rodauth::Rails::Feature::InternalRequest
+    include Rodauth::Rails::Feature::Associations
   end
 end

data/lib/rodauth/rails/middleware.rb

@@ -9,6 +9,8 @@ module Rodauth
       end
 
       def call(env)
+        return @app.call(env) if asset_request?(env)
+
         app = Rodauth::Rails.app.new(@app)
 
         # allow the Rails app to call Rodauth methods that throw :halt
@@ -16,6 +18,13 @@ module Rodauth
           app.call(env)
         end
       end
+
+      # Check whether it's a request to an asset managed by Sprockets or Propshaft.
+      def asset_request?(env)
+        return false unless ::Rails.application.config.respond_to?(:assets)
+
+        env["PATH_INFO"] =~ %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+      end
     end
   end
 end

data/lib/rodauth/rails/model.rb

@@ -1,7 +1,7 @@
 module Rodauth
   module Rails
     class Model < Module
-      require "rodauth/rails/model/associations"
+      ASSOCIATION_TYPES = { one: :has_one, many: :has_many }
 
       def initialize(auth_class, association_options: {})
         @auth_class = auth_class
@@ -46,8 +46,8 @@ module Rodauth
       def define_associations(model)
         define_password_hash_association(model) unless rodauth.account_password_hash_column
 
-        feature_associations.each do |association|
-          define_association(model, **association)
+        rodauth.associations.each do |association|
+          define_association(model, **association, type: ASSOCIATION_TYPES.fetch(association[:type]))
         end
       end
 
@@ -74,19 +74,19 @@ module Rodauth
 
         model.const_set(name.to_s.singularize.camelize, associated_model)
 
+        unless name == :authentication_audit_logs
+          dependent = type == :has_many ? :delete_all : :delete
+        end
+
         model.public_send type, name, scope,
           class_name: associated_model.name,
           foreign_key: foreign_key,
-          dependent: type == :has_many ? :delete_all : :delete,
+          dependent: dependent,
           inverse_of: :account,
           **options,
           **association_options(name)
       end
 
-      def feature_associations
-        Rodauth::Rails::Model::Associations.call(rodauth)
-      end
-
       def association_options(name)
         options = @association_options
         options = options.call(name) if options.respond_to?(:call)

data/lib/rodauth/rails/railtie.rb

@@ -1,5 +1,6 @@
 require "rodauth/rails/middleware"
 require "rodauth/rails/controller_methods"
+require "rodauth/rails/test"
 
 require "rails"
 
@@ -21,6 +22,14 @@ module Rodauth
       initializer "rodauth.test" do
         # Rodauth uses RACK_ENV to set the default bcrypt hash cost
         ENV["RACK_ENV"] = "test" if ::Rails.env.test?
+
+        if ActionPack.version >= Gem::Version.new("5.0")
+          ActiveSupport.on_load(:action_controller_test_case) do
+            include Rodauth::Rails::Test::Controller
+          end
+        else
+          ActionController::TestCase.include Rodauth::Rails::Test::Controller
+        end
       end
 
       rake_tasks do

data/lib/rodauth/rails/test/controller.rb

@@ -0,0 +1,41 @@
+require "active_support/concern"
+
+module Rodauth
+  module Rails
+    module Test
+      module Controller
+        extend ActiveSupport::Concern
+
+        included do
+          setup :setup_rodauth
+        end
+
+        def process(*)
+          catch_rodauth { super }
+        end
+        ruby2_keywords(:process) if respond_to?(:ruby2_keywords, true)
+
+        private
+
+        def setup_rodauth
+          Rodauth::Rails.app.opts[:rodauths].each do |name, auth_class|
+            scope = auth_class.roda_class.new(request.env)
+            request.env[["rodauth", *name].join(".")] = auth_class.new(scope)
+          end
+        end
+
+        def catch_rodauth(&block)
+          result = catch(:halt, &block)
+
+          if result.is_a?(Array) # rodauth response
+            response.status = result[0]
+            response.headers.merge! result[1]
+            response.body = result[2]
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/rodauth/rails/test.rb

@@ -0,0 +1,7 @@
+module Rodauth
+  module Rails
+    module Test
+      autoload :Controller, "rodauth/rails/test/controller"
+    end
+  end
+end

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "1.2.2"
+    VERSION = "1.4.0"
   end
 end

data/rodauth-rails.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 4.2", "< 8"
-  spec.add_dependency "rodauth", "~> 2.19"
+  spec.add_dependency "rodauth", "~> 2.23"
+  spec.add_dependency "roda", "~> 3.55"
   spec.add_dependency "sequel-activerecord_connection", "~> 1.1"
   spec.add_dependency "tilt"
   spec.add_dependency "bcrypt"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -36,14 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.23'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.55'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.55'
 - !ruby/object:Gem::Dependency
   name: sequel-activerecord_connection
   requirement: !ruby/object:Gem::Requirement
@@ -153,26 +167,43 @@ files:
 - LICENSE.txt
 - README.md
 - lib/generators/rodauth/install_generator.rb
-- lib/generators/rodauth/migration/account_expiration.erb
-- lib/generators/rodauth/migration/active_sessions.erb
-- lib/generators/rodauth/migration/audit_logging.erb
-- lib/generators/rodauth/migration/base.erb
-- lib/generators/rodauth/migration/disallow_password_reuse.erb
-- lib/generators/rodauth/migration/email_auth.erb
-- lib/generators/rodauth/migration/jwt_refresh.erb
-- lib/generators/rodauth/migration/lockout.erb
-- lib/generators/rodauth/migration/otp.erb
-- lib/generators/rodauth/migration/password_expiration.erb
-- lib/generators/rodauth/migration/recovery_codes.erb
-- lib/generators/rodauth/migration/remember.erb
-- lib/generators/rodauth/migration/reset_password.erb
-- lib/generators/rodauth/migration/single_session.erb
-- lib/generators/rodauth/migration/sms_codes.erb
-- lib/generators/rodauth/migration/verify_account.erb
-- lib/generators/rodauth/migration/verify_login_change.erb
-- lib/generators/rodauth/migration/webauthn.erb
+- lib/generators/rodauth/migration/active_record/account_expiration.erb
+- lib/generators/rodauth/migration/active_record/active_sessions.erb
+- lib/generators/rodauth/migration/active_record/audit_logging.erb
+- lib/generators/rodauth/migration/active_record/base.erb
+- lib/generators/rodauth/migration/active_record/disallow_password_reuse.erb
+- lib/generators/rodauth/migration/active_record/email_auth.erb
+- lib/generators/rodauth/migration/active_record/jwt_refresh.erb
+- lib/generators/rodauth/migration/active_record/lockout.erb
+- lib/generators/rodauth/migration/active_record/otp.erb
+- lib/generators/rodauth/migration/active_record/password_expiration.erb
+- lib/generators/rodauth/migration/active_record/recovery_codes.erb
+- lib/generators/rodauth/migration/active_record/remember.erb
+- lib/generators/rodauth/migration/active_record/reset_password.erb
+- lib/generators/rodauth/migration/active_record/single_session.erb
+- lib/generators/rodauth/migration/active_record/sms_codes.erb
+- lib/generators/rodauth/migration/active_record/verify_account.erb
+- lib/generators/rodauth/migration/active_record/verify_login_change.erb
+- lib/generators/rodauth/migration/active_record/webauthn.erb
+- lib/generators/rodauth/migration/sequel/account_expiration.erb
+- lib/generators/rodauth/migration/sequel/active_sessions.erb
+- lib/generators/rodauth/migration/sequel/audit_logging.erb
+- lib/generators/rodauth/migration/sequel/base.erb
+- lib/generators/rodauth/migration/sequel/disallow_password_reuse.erb
+- lib/generators/rodauth/migration/sequel/email_auth.erb
+- lib/generators/rodauth/migration/sequel/jwt_refresh.erb
+- lib/generators/rodauth/migration/sequel/lockout.erb
+- lib/generators/rodauth/migration/sequel/otp.erb
+- lib/generators/rodauth/migration/sequel/password_expiration.erb
+- lib/generators/rodauth/migration/sequel/recovery_codes.erb
+- lib/generators/rodauth/migration/sequel/remember.erb
+- lib/generators/rodauth/migration/sequel/reset_password.erb
+- lib/generators/rodauth/migration/sequel/single_session.erb
+- lib/generators/rodauth/migration/sequel/sms_codes.erb
+- lib/generators/rodauth/migration/sequel/verify_account.erb
+- lib/generators/rodauth/migration/sequel/verify_login_change.erb
+- lib/generators/rodauth/migration/sequel/webauthn.erb
 - lib/generators/rodauth/migration_generator.rb
-- lib/generators/rodauth/migration_helpers.rb
 - lib/generators/rodauth/templates/INSTRUCTIONS
 - lib/generators/rodauth/templates/app/controllers/rodauth_controller.rb
 - lib/generators/rodauth/templates/app/mailers/rodauth_mailer.rb
@@ -230,11 +261,10 @@ files:
 - lib/rodauth-rails.rb
 - lib/rodauth/rails.rb
 - lib/rodauth/rails/app.rb
-- lib/rodauth/rails/app/flash.rb
-- lib/rodauth/rails/app/middleware.rb
 - lib/rodauth/rails/auth.rb
 - lib/rodauth/rails/controller_methods.rb
 - lib/rodauth/rails/feature.rb
+- lib/rodauth/rails/feature/associations.rb
 - lib/rodauth/rails/feature/base.rb
 - lib/rodauth/rails/feature/callbacks.rb
 - lib/rodauth/rails/feature/csrf.rb
@@ -244,9 +274,10 @@ files:
 - lib/rodauth/rails/feature/render.rb
 - lib/rodauth/rails/middleware.rb
 - lib/rodauth/rails/model.rb
-- lib/rodauth/rails/model/associations.rb
 - lib/rodauth/rails/railtie.rb
 - lib/rodauth/rails/tasks.rake
+- lib/rodauth/rails/test.rb
+- lib/rodauth/rails/test/controller.rb
 - lib/rodauth/rails/version.rb
 - rodauth-rails.gemspec
 homepage: https://github.com/janko/rodauth-rails

data/lib/generators/rodauth/migration_helpers.rb

@@ -1,77 +0,0 @@
-require "erb"
-
-module Rodauth
-  module Rails
-    module Generators
-      module MigrationHelpers
-        attr_reader :migration_class_name
-
-        def migration_template(source, destination = File.basename(source))
-          @migration_class_name = destination.chomp(".rb").camelize
-
-          super source, File.join(db_migrate_path, destination)
-        end
-
-        private
-
-        def migration_content
-          migration_features
-            .select { |feature| File.exist?("#{__dir__}/migration/#{feature}.erb") }
-            .map { |feature| File.read("#{__dir__}/migration/#{feature}.erb") }
-            .map { |content| erb_eval(content) }
-            .join("\n")
-            .indent(4)
-        end
-
-        def activerecord_adapter
-          if ActiveRecord::Base.respond_to?(:connection_db_config)
-            ActiveRecord::Base.connection_db_config.adapter
-          else
-            ActiveRecord::Base.connection_config.fetch(:adapter)
-          end
-        end
-
-        def migration_version
-          return unless ActiveRecord.version >= Gem::Version.new("5.0")
-
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
-
-        def db_migrate_path
-          return "db/migrate" unless ActiveRecord.version >= Gem::Version.new("5.0")
-
-          super
-        end
-
-        def primary_key_type(key = :id)
-          generators  = ::Rails.application.config.generators
-          column_type = generators.options[:active_record][:primary_key_type]
-
-          return unless column_type
-
-          if key
-            ", #{key}: :#{column_type}"
-          else
-            column_type
-          end
-        end
-
-        def erb_eval(content)
-          if ERB.version[/\d+\.\d+\.\d+/].to_s >= "2.2.0"
-            ERB.new(content, trim_mode: "-").result(binding)
-          else
-            ERB.new(content, 0, "-").result(binding)
-          end
-        end
-
-        def current_timestamp
-          if ActiveRecord.version >= Gem::Version.new("5.0")
-            %(-> { "CURRENT_TIMESTAMP" })
-          else
-            %(OpenStruct.new(quoted_id: "CURRENT_TIMESTAMP"))
-          end
-        end
-      end
-    end
-  end
-end