rodauth-rails 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dac2131f831b908d4bfd7a3367b310bd04b4141202b16f5e98d80e769972e32
-  data.tar.gz: 1742fb2bb8fb16c221a4f09d5a5f53bdc898475383f91311100571e4902c8700
+  metadata.gz: f56967000d0a2cc64e51a707783fc541d4ff37dbb3e68f1fc519ef02a0a83e65
+  data.tar.gz: dfe189f65d18781e42058e133f0e403ed769421fb8682e4a63078b1f7e39cb8a
 SHA512:
-  metadata.gz: 53dc0c219dc640431b553c8e843cc728ee1aff0c57a759dfebb0254a9e885a193ab1c3dff8d6fba6ba8423abdc49e9d6e38c14125a48a82954c42942b4a16838
-  data.tar.gz: 07ea61d890bb27ae8cbaed4c203366ddb07c152b5f76272e2acec9865e1c7ec72472aef8b20e2a112ad831ab3bc69602f443fc80ffcb0f6b1754f1b3d317cff4
+  metadata.gz: f582926f90ab796d491210e28705585e166047c3b3f093e27ad556fb5271041e5c0a34ce78a42d9ec84c5b074958938527b233b750ec944043611df6f1bf7112
+  data.tar.gz: 04e475c871440131db6c42c1eabcecc95a34e323cfdd2ce045f59b196439d404321ee27e64b857321df642e362168e146b15ed354a3710d3fff5160ad23f18d1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.13.0 (2023-12-25) :christmas_tree:
+
+* Add `#rodauth` method to controller test helpers (@janko)
+
+* When session middleware is required by Rodauth but missing, point to Rails docs instead of Roda (@janko)
+
+* Set `login_confirm_param` to `"email-confirm"` in default configuration for consistency (@janko)
+
+* Set `convert_token_id_to_integer?` in default configuration to avoid DB queries on boot (@janko)
+
 ## 1.12.0 (2023-10-20)
 
 * Allow generating view template for `confirm_password` feature (igor-alexandrov)

data/README.md

@@ -10,6 +10,7 @@ Provides Rails integration for the [Rodauth] authentication framework.
 * [Rails demo](https://github.com/janko/rodauth-demo-rails)
 * [JSON API guide](https://github.com/janko/rodauth-rails/wiki/JSON-API)
 * [OmniAuth guide](https://github.com/janko/rodauth-rails/wiki/OmniAuth)
+* [JSON Request Documentation for Rodauth](https://documenter.getpostman.com/view/26686011/2s9YC7SWn9)
 
 🎥 Screencasts:
 
@@ -22,7 +23,7 @@ Provides Rails integration for the [Rodauth] authentication framework.
 * [Rodauth: A Refreshing Authentication Solution for Ruby](https://janko.io/rodauth-a-refreshing-authentication-solution-for-ruby/)
 * [Rails Authentication with Rodauth](https://janko.io/adding-authentication-in-rails-with-rodauth/)
 * [Multifactor Authentication in Rails with Rodauth](https://janko.io/adding-multifactor-authentication-in-rails-with-rodauth/)
-* [How to build an OIDC provider using rodauth-oauth on Rails](https://honeyryderchuck.gitlab.io/httpx/2021/03/15/oidc-provider-on-rails-using-rodauth-oauth.html)
+* [How to build an OIDC provider using rodauth-oauth on Rails](https://honeyryderchuck.gitlab.io/2021/03/15/oidc-provider-on-rails-using-rodauth-oauth.html)
 * [What It Took to Build a Rails Integration for Rodauth](https://janko.io/what-it-took-to-build-a-rails-integration-for-rodauth/)
 * [Social Login in Rails with Rodauth](https://janko.io/social-login-in-rails-with-rodauth/)
 * [Passkey Authentication with Rodauth](https://janko.io/passkey-authentication-with-rodauth/)
@@ -281,7 +282,7 @@ class RodauthMain < Rodauth::Rails::Auth
     after_login { rails_cookies.permanent[:last_account_id] = account_id }
   end
 end
-``` 
+```
 
 ## Views
 
@@ -592,7 +593,7 @@ class ArticlesControllerTest < ActionDispatch::IntegrationTest
     post "/logout"
     assert_redirected_to "/"
   end
-  
+
   test "required authentication" do
     get :index
 
@@ -616,7 +617,7 @@ end
 ```
 
 For more examples and information about testing with rodauth, see
-[this wiki page about testing](https://github.com/janko/rodauth-rails/wiki/Testing). 
+[this wiki page about testing](https://github.com/janko/rodauth-rails/wiki/Testing).
 
 ## Configuring
 
@@ -643,7 +644,7 @@ Rodauth::Rails.configure do |config|
   config.middleware = false # disable auto-insertion
 end
 
-Rails.application.config.middleware.insert_before AnotherMiddleware, Rodauth::Rails::Middleware
+Rails.configuration.middleware.insert_before AnotherMiddleware, Rodauth::Rails::Middleware
 ```
 
 ## How it works

data/lib/generators/rodauth/install_generator.rb

@@ -66,7 +66,7 @@ module Rodauth
         end
 
         def create_fixtures
-          generator_options = ::Rails.application.config.generators.options
+          generator_options = ::Rails.configuration.generators.options
           if generator_options[:test_unit][:fixture] && generator_options[:test_unit][:fixture_replacement].nil?
             test_dir = generator_options[:rails][:test_framework] == :rspec ? "spec" : "test"
             template "test/fixtures/accounts.yml", "#{test_dir}/fixtures/#{table_prefix.pluralize}.yml"
@@ -101,17 +101,21 @@ module Rodauth
           options[:argon2]
         end
 
+        def primary_key_integer?
+          !::Rails.configuration.generators.options.dig(:active_record, :primary_key_type)
+        end
+
         def sequel_activerecord_integration?
           defined?(ActiveRecord::Railtie) &&
             (!defined?(Sequel) || Sequel::DATABASES.empty?)
         end
 
         def session_store?
-          !!::Rails.application.config.session_store
+          !!::Rails.configuration.session_store
         end
 
         def api_only?
-          ::Rails.application.config.api_only
+          ::Rails.configuration.api_only
         end
 
         def sequel_adapter

data/lib/generators/rodauth/migration_generator.rb

@@ -120,7 +120,7 @@ module Rodauth
           end
 
           def primary_key_type(key = :id)
-            generators  = ::Rails.application.config.generators
+            generators  = ::Rails.configuration.generators
             column_type = generators.options[:active_record][:primary_key_type]
 
             if key

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

@@ -20,6 +20,9 @@ class RodauthMain < Rodauth::Rails::Auth
     db Sequel.<%= sequel_adapter %>(extensions: :activerecord_connection, keep_reference: false)
 <% end -%>
 
+    # Avoid DB query that checks accounts table schema at boot time.
+    convert_token_id_to_integer? <%= primary_key_integer? %>
+
 <% end -%>
     # Change prefix of table and foreign key column names from default "account"
 <% if table -%>
@@ -86,6 +89,7 @@ class RodauthMain < Rodauth::Rails::Auth
 
     # Change some default param keys.
     login_param "email"
+    login_confirm_param "email-confirm"
     # password_confirm_param "confirm_password"
 
     # Redirect back to originally requested location after authentication.

data/lib/generators/rodauth/views_generator.rb

@@ -121,7 +121,7 @@ module Rodauth
         end
 
         def tailwind?
-          ::Rails.application.config.generators.options[:rails][:template_engine] == :tailwindcss ||
+          ::Rails.configuration.generators.options[:rails][:template_engine] == :tailwindcss ||
             options[:css]&.downcase&.start_with?("tailwind")
         end
       end

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

@@ -32,7 +32,7 @@ module Rodauth
         end
 
         def rails_controller
-          if only_json? && ::Rails.application.config.api_only
+          if only_json? && ::Rails.configuration.api_only
             ActionController::API
           else
             ActionController::Base
@@ -49,6 +49,12 @@ module Rodauth
 
         delegate :rails_routes, :rails_cookies, :rails_request, to: :scope
 
+        def session
+          super
+        rescue Roda::RodaError
+          fail Rodauth::Rails::Error, "There is no session middleware configured, see instructions on how to add it: https://guides.rubyonrails.org/api_app.html#using-session-middlewares"
+        end
+
         private
 
         def instantiate_rails_account

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

@@ -47,7 +47,7 @@ module Rodauth
         def rails_url_options
           return nil unless defined?(ActionMailer)
 
-          ::Rails.application.config.action_mailer.default_url_options or
+          ::Rails.configuration.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
       end

data/lib/rodauth/rails/middleware.rb

@@ -21,9 +21,9 @@ module Rodauth
 
       # 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)
+        return false unless ::Rails.configuration.respond_to?(:assets)
 
-        env["PATH_INFO"] =~ %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+        env["PATH_INFO"] =~ %r(\A/{0,2}#{::Rails.configuration.assets.prefix})
       end
     end
   end

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

@@ -35,6 +35,10 @@ module Rodauth
 
           response
         end
+
+        def rodauth(name = nil)
+          @controller.rodauth(name)
+        end
       end
     end
   end

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "1.12.0"
+    VERSION = "1.13.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-20 00:00:00.000000000 Z
+date: 2023-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties