rodauth-rails 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63496f359a15bb061b6b419a609cbe63c24991e156731721d9f077ecf9deac4
-  data.tar.gz: 68212d9c722391c8c79f8bf8c48f8a05a39410ea0d97396876a6c2f5e92f103a
+  metadata.gz: 879be6e1bbb5238e3f469002e1152d727948f970d2cda658b6ed0348a26f4b46
+  data.tar.gz: 79042f44b03bb8ab7f2225b79697b3399f79de272dc1c414de5ddc91b788b1cb
 SHA512:
-  metadata.gz: 3632843dbd0214b73fa23134a0f2b42ec3b8f1c33430af1c776c685956ccf50e475840993299bff9863491456a369ad42b7e688e3ed03b783e51f4585d6be621
-  data.tar.gz: 6c123e024a51d3c2ba6b224b64c1f21d3b46363523d5b498e93fbe659052489660a61a3dd83da5080a07067d9052a82450da17a7bf156e9c905b2aa81ca861f6
+  metadata.gz: 9cb9d96c3e60c64a3f8367dd122f3eff3448f0c9a147510173a8d781483d7de6a88c264a717db14864e26a830a153c09bcbf6bad4865be97d3be248fcd0265d0
+  data.tar.gz: 422b0db632d1e0317d0f38c10d60405f2e53daf083919b460fcb29157e238ac0c2e6249660e09dc4a7f452718629d604c7a1211e073d32e4884a0b6ab4fea32a

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.6.0 (2022-09-14)
+
+* Avoid creating IDENTITY columns for primary foreign keys on SQL Server with Active Record (@janko)
+
+* Make configuration name argument required in generated `RodauthMailer` (@janko)
+
+* Make the Rails integration work without Action Mailer loaded (@janko)
+
+* Don't redirect to login page when account is missing in `current_account` method (@janko)
+
+## 1.5.5 (2022-08-04)
+
+* Don't raise `ArgumentError` when calling `#current_account` without being logged in (@benkoshy)
+
+* Abort `rodauth:views` generator when unknown feature was specified (@janko)
+
+* Abort `rodauth:migration` generator when unknown feature was specified (@janko)
+
 ## 1.5.4 (2022-07-21)
 
 * Generate account fixtures in `spec/fixtures` directory when using RSpec (@benkoshy)

data/README.md

@@ -14,7 +14,7 @@ Provides Rails integration for the [Rodauth] authentication framework.
 🎥 Screencasts:
 
 * [Rails Authentication with Rodauth](https://www.youtube.com/watch?v=2hDpNikacf0)
-* [Multifactor Authentication via TOTP with Rodauth](https://www.youtube.com/watch?v=9ON-kgXpz2A)
+* [Multifactor Authentication with Rodauth](https://www.youtube.com/watch?v=9ON-kgXpz2A&list=PLkGQXZLACDTGKsaRWstkHQdm2CUmT3SZ-) ([TOTP](https://youtu.be/9ON-kgXpz2A), [Recovery Codes](https://youtu.be/lkFCcE1Q5-w))
 
 📚 Articles:
 
@@ -194,7 +194,7 @@ class RodauthApp < Rodauth::Rails::App
 
     # require authentication for /dashboard/* and /account/* routes
     if r.path.start_with?("/dashboard") || r.path.start_with?("/account")
-      rodauth.require_authentication # redirect to login page if not authenticated
+      rodauth.require_account # redirect to login page if not authenticated
     end
   end
 end
@@ -208,7 +208,7 @@ class ApplicationController < ActionController::Base
   private
 
   def authenticate
-    rodauth.require_authentication # redirect to login page if not authenticated
+    rodauth.require_account # redirect to login page if not authenticated
   end
 end
 ```
@@ -727,7 +727,7 @@ For controller tests, you can log in accounts by modifying the session:
 ```rb
 # app/controllers/articles_controller.rb
 class ArticlesController < ApplicationController
-  before_action -> { rodauth.require_authentication }
+  before_action -> { rodauth.require_account }
 
   def index
     # ...
@@ -951,7 +951,7 @@ end
 
 In addition to Zeitwerk compatibility, this extra layer catches Rodauth redirects
 that happen on the controller level (e.g. when calling
-`rodauth.require_authentication` in a `before_action` filter).
+`rodauth.require_account` in a `before_action` filter).
 
 ### Roda app
 
@@ -1180,7 +1180,7 @@ License](https://opensource.org/licenses/MIT).
 
 Everyone interacting in the rodauth-rails project's codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/janko/rodauth-rails/blob/master/CODE_OF_CONDUCT.md).
+conduct](CODE_OF_CONDUCT.md).
 
 [Rodauth]: https://github.com/jeremyevans/rodauth
 [Sequel]: https://github.com/jeremyevans/sequel

data/lib/generators/rodauth/install_generator.rb

@@ -63,6 +63,8 @@ module Rodauth
         end
 
         def create_mailer
+          return unless defined?(ActionMailer)
+
           template "app/mailers/rodauth_mailer.rb"
 
           MAILER_VIEWS.each do |view|
@@ -88,8 +90,8 @@ module Rodauth
         private
 
         def migration_features
-          features = [:base, :reset_password, :verify_account, :verify_login_change]
-          features << :remember unless jwt?
+          features = ["base", "reset_password", "verify_account", "verify_login_change"]
+          features << "remember" unless jwt?
           features
         end
 

data/lib/generators/rodauth/migration/active_record/account_expiration.erb

@@ -1,5 +1,6 @@
 # Used by the account expiration feature
-create_table :account_activity_times<%= primary_key_type %> do |t|
+create_table :account_activity_times, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.datetime :last_activity_at, null: false
   t.datetime :last_login_at, null: false

data/lib/generators/rodauth/migration/active_record/email_auth.erb

@@ -1,6 +1,6 @@
 # Used by the email auth feature
-create_table :account_email_auth_keys<%= primary_key_type %> do |t|
-  t.foreign_key :accounts, column: :id
+create_table :account_email_auth_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.string :key, null: false
   t.datetime :deadline, null: false
   t.datetime :email_last_sent, null: false, default: <%= current_timestamp %>

data/lib/generators/rodauth/migration/active_record/lockout.erb

@@ -1,9 +1,11 @@
 # Used by the lockout feature
-create_table :account_login_failures<%= primary_key_type %> do |t|
+create_table :account_login_failures, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.integer :number, null: false, default: 1
 end
-create_table :account_lockouts<%= primary_key_type %> do |t|
+create_table :account_lockouts, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
   t.datetime :deadline, null: false

data/lib/generators/rodauth/migration/active_record/otp.erb

@@ -1,5 +1,6 @@
 # Used by the otp feature
-create_table :account_otp_keys<%= primary_key_type %> do |t|
+create_table :account_otp_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
   t.integer :num_failures, null: false, default: 0

data/lib/generators/rodauth/migration/active_record/password_expiration.erb

@@ -1,5 +1,6 @@
 # Used by the password expiration feature
-create_table :account_password_change_times<%= primary_key_type %> do |t|
+create_table :account_password_change_times, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.datetime :changed_at, null: false, default: <%= current_timestamp %>
 end

data/lib/generators/rodauth/migration/active_record/recovery_codes.erb

@@ -1,6 +1,6 @@
 # Used by the recovery codes feature
 create_table :account_recovery_codes, primary_key: [:id, :code] do |t|
-  t.column :id, :<%= primary_key_type(nil) || :bigint %>
+  t.<%= primary_key_type(nil) %> :id
   t.foreign_key :accounts, column: :id
   t.string :code
 end

data/lib/generators/rodauth/migration/active_record/remember.erb

@@ -1,5 +1,6 @@
 # Used by the remember me feature
-create_table :account_remember_keys<%= primary_key_type %> do |t|
+create_table :account_remember_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
   t.datetime :deadline, null: false

data/lib/generators/rodauth/migration/active_record/reset_password.erb

@@ -1,5 +1,6 @@
 # Used by the password reset feature
-create_table :account_password_reset_keys<%= primary_key_type %> do |t|
+create_table :account_password_reset_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
   t.datetime :deadline, null: false

data/lib/generators/rodauth/migration/active_record/single_session.erb

@@ -1,5 +1,6 @@
 # Used by the single session feature
-create_table :account_session_keys<%= primary_key_type %> do |t|
+create_table :account_session_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
 end

data/lib/generators/rodauth/migration/active_record/sms_codes.erb

@@ -1,5 +1,6 @@
 # Used by the sms codes feature
-create_table :account_sms_codes<%= primary_key_type %> do |t|
+create_table :account_sms_codes, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :phone_number, null: false
   t.integer :num_failures

data/lib/generators/rodauth/migration/active_record/verify_account.erb

@@ -1,5 +1,6 @@
 # Used by the account verification feature
-create_table :account_verification_keys<%= primary_key_type %> do |t|
+create_table :account_verification_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
   t.datetime :requested_at, null: false, default: <%= current_timestamp %>

data/lib/generators/rodauth/migration/active_record/verify_login_change.erb

@@ -1,5 +1,6 @@
 # Used by the verify login change feature
-create_table :account_login_change_keys<%= primary_key_type %> do |t|
+create_table :account_login_change_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :key, null: false
   t.string :login, null: false

data/lib/generators/rodauth/migration/active_record/webauthn.erb

@@ -1,5 +1,6 @@
 # Used by the webauthn feature
-create_table :account_webauthn_user_ids<%= primary_key_type %> do |t|
+create_table :account_webauthn_user_ids, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
   t.foreign_key :accounts, column: :id
   t.string :webauthn_id, null: false
 end

data/lib/generators/rodauth/migration_generator.rb

@@ -17,7 +17,7 @@ module Rodauth
           desc: "Name of the generated migration file"
 
         def create_rodauth_migration
-          return if features.empty?
+          validate_features or return
 
           migration_template "db/migrate/create_rodauth.rb", File.join(db_migrate_path, "#{migration_name}.rb")
         end
@@ -30,7 +30,6 @@ module Rodauth
 
         def migration_content
           features
-            .select { |feature| File.exist?(migration_chunk(feature)) }
             .map { |feature| File.read(migration_chunk(feature)) }
             .map { |content| erb_eval(content) }
             .join("\n")
@@ -45,19 +44,37 @@ module Rodauth
           end
         end
 
+        def migration_chunk(feature)
+          "#{MIGRATION_DIR}/#{feature}.erb"
+        end
+
+        def validate_features
+          if features.empty?
+            say "No features specified!", :yellow
+            false
+          elsif (features - valid_features).any?
+            say "No available migration for feature(s): #{(features - valid_features).join(", ")}", :red
+            false
+          else
+            true
+          end
+        end
+
+        def valid_features
+          Dir["#{MIGRATION_DIR}/*.erb"].map { |filename| File.basename(filename, ".erb") }
+        end
+
         if defined?(::ActiveRecord::Railtie) # Active Record
           include ::ActiveRecord::Generators::Migration
 
+          MIGRATION_DIR = "#{__dir__}/migration/active_record"
+
           def db_migrate_path
             return "db/migrate" unless ActiveRecord.version >= Gem::Version.new("5.0")
 
             super
           end
 
-          def migration_chunk(feature)
-            "#{__dir__}/migration/active_record/#{feature}.erb"
-          end
-
           def migration_version
             return unless ActiveRecord.version >= Gem::Version.new("5.0")
 
@@ -76,12 +93,18 @@ module Rodauth
             generators  = ::Rails.application.config.generators
             column_type = generators.options[:active_record][:primary_key_type]
 
-            return unless column_type
-
             if key
-              ", #{key}: :#{column_type}"
+              ", #{key}: :#{column_type}" if column_type
             else
-              column_type
+              column_type || default_primary_key_type
+            end
+          end
+
+          def default_primary_key_type
+            if ActiveRecord.version >= Gem::Version.new("5.1") && activerecord_adapter != "sqlite3"
+              :bigint
+            else
+              :integer
             end
           end
 
@@ -95,6 +118,8 @@ module Rodauth
         else # Sequel
           include ::Rails::Generators::Migration
 
+          MIGRATION_DIR = "#{__dir__}/migration/sequel"
+
           def self.next_migration_number(dirname)
             next_migration_number = current_migration_number(dirname) + 1
             [Time.now.utc.strftime('%Y%m%d%H%M%S'), format('%.14d', next_migration_number)].max
@@ -104,10 +129,6 @@ module Rodauth
             "db/migrate"
           end
 
-          def migration_chunk(feature)
-            "#{__dir__}/migration/sequel/#{feature}.erb"
-          end
-
           def db
             db = ::Sequel::DATABASES.first if defined?(::Sequel)
             db or fail Rodauth::Rails::Error, "missing Sequel database connection"

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

@@ -1,19 +1,19 @@
 class RodauthMailer < ApplicationMailer
-  def verify_account(name = nil, account_id, key)
+  def verify_account(name, account_id, key)
     @email_link = email_link(name, :verify_account, account_id, key)
     @account = find_account(name, account_id)
 
     mail to: @account.email, subject: rodauth(name).verify_account_email_subject
   end
 
-  def reset_password(name = nil, account_id, key)
+  def reset_password(name, account_id, key)
     @email_link = email_link(name, :reset_password, account_id, key)
     @account = find_account(name, account_id)
 
     mail to: @account.email, subject: rodauth(name).reset_password_email_subject
   end
 
-  def verify_login_change(name = nil, account_id, key)
+  def verify_login_change(name, account_id, key)
     @email_link = email_link(name, :verify_login_change, account_id, key)
     @account = find_account(name, account_id)
     @new_email = @account.login_change_key.login
@@ -21,20 +21,20 @@ class RodauthMailer < ApplicationMailer
     mail to: @new_email, subject: rodauth(name).verify_login_change_email_subject
   end
 
-  def password_changed(name = nil, account_id)
+  def password_changed(name, account_id)
     @account = find_account(name, account_id)
 
     mail to: @account.email, subject: rodauth(name).password_changed_email_subject
   end
 
-  # def email_auth(name = nil, account_id, key)
+  # def email_auth(name, account_id, key)
   #   @email_link = email_link(name, :email_auth, account_id, key)
   #   @account = find_account(name, account_id)
 
   #   mail to: @account.email, subject: rodauth(name).email_auth_email_subject
   # end
 
-  # def unlock_account(name = nil, account_id, key)
+  # def unlock_account(name, account_id, key)
   #   @email_link = email_link(name, :unlock_account, account_id, key)
   #   @account = find_account(name, account_id)
 

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

@@ -13,12 +13,12 @@ class RodauthApp < Rodauth::Rails::App
     r.rodauth # route rodauth requests
 
     # ==> Authenticating requests
-    # Call `rodauth.require_authentication` for requests that you want to
+    # Call `rodauth.require_account` for requests that you want to
     # require authentication for. For example:
     #
     # # authenticate /dashboard/* and /account/* requests
     # if r.path.start_with?("/dashboard") || r.path.start_with?("/account")
-    #   rodauth.require_authentication
+    #   rodauth.require_account
     # end
 
     # ==> Secondary configurations

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

@@ -56,6 +56,7 @@ class RodauthMain < Rodauth::Rails::Auth
     # Redirect to the app from login and registration pages if already logged in.
     # already_logged_in { redirect login_redirect }
 
+<% if defined?(ActionMailer) -%>
     # ==> Emails
     # Use a custom mailer for delivering authentication emails.
     create_reset_password_email do
@@ -81,6 +82,7 @@ class RodauthMain < Rodauth::Rails::Auth
       db.after_commit { email.deliver_later }
     end
 
+<% end -%>
     # ==> Flash
 <% unless json? || jwt? -%>
     # Match flash keys with ones already used in the Rails app.

data/lib/generators/rodauth/views_generator.rb

@@ -46,10 +46,7 @@ module Rodauth
         }
 
         def create_views
-          views = features.inject([]) do |list, feature|
-            list |= VIEWS[feature] || []
-            list |= VIEWS[DEPENDENCIES[feature]] || []
-          end
+          validate_features or return
 
           views.each do |view|
             copy_file "app/views/rodauth/#{view}.html.erb", "app/views/#{directory}/#{view}.html.erb" do |content|
@@ -63,13 +60,29 @@ module Rodauth
 
         private
 
+        def views
+          features.inject([]) do |list, feature|
+            list |= VIEWS.fetch(feature)
+            list |= VIEWS[DEPENDENCIES[feature]] || []
+          end
+        end
+
+        def validate_features
+          if (features - VIEWS.keys).any?
+            say "No available view template for feature(s): #{(features - VIEWS.keys).join(", ")}", :error
+            false
+          else
+            true
+          end
+        end
+
         def features
           if options[:all]
             VIEWS.keys
           elsif selected_features
             selected_features.map(&:to_sym)
           else
-            rodauth_configuration.features
+            rodauth_configuration.features & VIEWS.keys
           end
         end
 

data/lib/rodauth/rails/controller_methods.rb

@@ -9,7 +9,7 @@ module Rodauth
       end
 
       def current_account(name = nil)
-        rodauth(name).rails_account || rodauth(name).login_required
+        rodauth(name).rails_account
       end
 
       def rodauth(name = nil)

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

@@ -9,10 +9,12 @@ module Rodauth
         end
 
         def rails_account
+          return unless logged_in?
+
           account_from_session unless account
 
           unless account
-            clear_session if logged_in?
+            clear_session
             return
           end
 

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

@@ -3,13 +3,13 @@ module Rodauth
     module Feature
       module InternalRequest
         def domain
-          return super unless missing_host?
+          return super unless missing_host? && rails_url_options
 
           rails_url_options.fetch(:host)
         end
 
         def base_url
-          return super unless missing_host? && domain
+          return super unless missing_host? && domain && rails_url_options
 
           scheme = rails_url_options[:protocol] || "http"
           port = rails_url_options[:port]
@@ -43,6 +43,8 @@ module Rodauth
         end
 
         def rails_url_options
+          return nil unless defined?(ActionMailer)
+
           ::Rails.application.config.action_mailer.default_url_options or
             fail Error, "There is no information to set the URL host from. Please set config.action_mailer.default_url_options in your Rails application, or configure #domain and #base_url in your Rodauth configuration."
         end

data/lib/rodauth/rails/feature.rb

@@ -8,7 +8,7 @@ module Rodauth
     require "rodauth/rails/feature/callbacks"
     require "rodauth/rails/feature/csrf"
     require "rodauth/rails/feature/render"
-    require "rodauth/rails/feature/email"
+    require "rodauth/rails/feature/email" if defined?(ActionMailer)
     require "rodauth/rails/feature/instrumentation"
     require "rodauth/rails/feature/internal_request"
 
@@ -16,7 +16,7 @@ module Rodauth
     include Rodauth::Rails::Feature::Callbacks
     include Rodauth::Rails::Feature::Csrf
     include Rodauth::Rails::Feature::Render
-    include Rodauth::Rails::Feature::Email
+    include Rodauth::Rails::Feature::Email if defined?(ActionMailer)
     include Rodauth::Rails::Feature::Instrumentation
     include Rodauth::Rails::Feature::InternalRequest
   end

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "1.5.4"
+    VERSION = "1.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties