rodauth-rails 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce1121986a4374d0558398dab09f90beb4c37f2c2528485ac52575d7a73ee4c0
-  data.tar.gz: 16aa69606a1ead801e6420cabffa54938b242c133919a85f1573f406fb2f721d
+  metadata.gz: 110cd150534a783ea2919ff38d755e8c224535a99e4c9996a90e5312813f3d5c
+  data.tar.gz: 1c22dce90c915acad83d68f4a9608177a7d7d50b438c8ada95e059b33f45d70d
 SHA512:
-  metadata.gz: c639b7ef0fe225893df040fedc2e204a6896a24329b9b6fe72cb35f3c2a18abd1f8ddd9ed0609c256418fe5ce1124f8e7552c1d89ab52e3432b2e7c987ef7df3
-  data.tar.gz: 8ba7a53f862fd9a6c8a20637b414b030e92608c74c706505191faddb2e6377f3db161512d2be398296488bcb4aff0580768c4d72c612d149ee3f29bd7126fefa
+  metadata.gz: e67abaeaf97360f4faa457d637b1269944dedb90a450c77bffa28e315c5de8aeb8624334ee84478fa68f6d3620e6f48d671f29c73e8ddc6447243839b0517b6d
+  data.tar.gz: 7f6668732ac4325ba61d68aa3dbb7d295162913867f333eb41329c4cfb14c4850906b7bd3109881e34469eba2737c66112705f397217e8a3f9b3a56d99eaf89b

data/README.md

@@ -175,23 +175,7 @@ end
 
 ### Requiring authentication
 
-You can require authentication for routes at the middleware level in in your Rodauth
-app's routing block, which helps keep the authentication logic encapsulated:
-
-```rb
-# app/misc/rodauth_app.rb
-class RodauthApp < Rodauth::Rails::App
-  route do |r|
-    r.rodauth # route rodauth requests
-
-    if r.path.start_with?("/dashboard") # /dashboard/* routes
-      rodauth.require_account # redirect to login page if not authenticated
-    end
-  end
-end
-```
-
-You can also require authentication at the controller layer:
+It's recommended to require authentication at the controller level:
 
 ```rb
 class ApplicationController < ActionController::Base
@@ -208,7 +192,7 @@ class DashboardController < ApplicationController
 end
 ```
 
-Additionally, routes can be authenticated at the Rails router level:
+Alternatively, routes can be authenticated at the Rails router level (useful if you're mounting Rack apps):
 
 ```rb
 # config/routes.rb
@@ -231,6 +215,22 @@ Rails.application.routes.draw do
 end
 ```
 
+If for whatever reason you'd like to require authentication at the *middleware* level, you can do so within Rodauth app's routing block:
+
+```rb
+# app/misc/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  route do |r|
+    r.rodauth # route rodauth requests
+
+    # Avoid using Roda routing matchers like `r.on`, as they can affect paths routed.
+    if r.path.match?(%r{\A/dashboard(\.\w+)?(/|\z)}) # /dashboard/* routes with formats
+      rodauth.require_account # redirect to login page if not authenticated
+    end
+  end
+end
+```
+
 ### Controller
 
 Your Rodauth configuration is linked to a Rails controller, which is primarily used to render views and handle CSRF protection, but will also execute any callbacks and rescue handlers defined on it around Rodauth endpoints.
@@ -464,7 +464,8 @@ class RodauthApp < Rodauth::Rails::App
     r.rodauth         # route primary rodauth requests
     r.rodauth(:admin) # route secondary rodauth requests
 
-    if request.path.start_with?("/admin")
+    # if you're requiring authentication at the middleware level
+    if r.path.match?(%r{\A/admin(\.\w+)?(/|\z)}) # /admin/* routes with format
       rodauth(:admin).require_account
     end
   end

data/lib/generators/rodauth/install_generator.rb

@@ -26,7 +26,9 @@ module Rodauth
         def generate_rodauth_migration
           invoke "rodauth:migration", migration_features,
             name: "create_rodauth",
-            prefix: table_prefix
+            prefix: table_prefix,
+            force: options[:force],
+            skip: options[:skip]
         end
 
         def create_rodauth_initializer

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

@@ -12,15 +12,6 @@ class RodauthApp < Rodauth::Rails::App
 <% end -%>
     r.rodauth # route rodauth requests
 
-    # ==> Authenticating requests
-    # 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_account
-    # end
-
     # ==> Secondary configurations
     # r.rodauth(:admin) # route admin rodauth requests
   end

data/lib/rodauth/rails/auth.rb

@@ -15,7 +15,7 @@ module Rodauth
         set_deadline_values? true
 
         # use HMACs for additional security
-        hmac_secret { Rodauth::Rails.secret_key_base }
+        hmac_secret { ::Rails.application.secret_key_base }
       end
     end
   end

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

@@ -60,6 +60,14 @@ module Rodauth
         def _rails_url_options
           defined?(ActionMailer) ? ActionMailer::Base.default_url_options.dup : {}
         end
+
+        def instance_variables_to_inspect
+          variables = instance_variables
+          if internal_request? && @internal_request_return_value == self
+            variables -= [:@internal_request_block, :@internal_request_return_value, :@internal_request_return_value_set]
+          end
+          variables
+        end
       end
     end
   end

data/lib/rodauth/rails/railtie.rb

@@ -7,6 +7,10 @@ require "rails"
 module Rodauth
   module Rails
     class Railtie < ::Rails::Railtie
+      initializer "rodauth.filter_parameters" do |app|
+        app.config.filter_parameters << /\Akey\z/
+      end
+
       initializer "rodauth.middleware", after: :load_config_initializers do |app|
         if Rodauth::Rails.middleware?
           app.middleware.use Rodauth::Rails::Middleware

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "2.1.2"
+    VERSION = "2.2.0"
   end
 end

data/lib/rodauth/rails.rb

@@ -38,7 +38,7 @@ module Rodauth
           options[:account_id] = account.id
         end
 
-        instance = auth_class.internal_request_eval(options) do
+        auth_class.internal_request_eval(options) do
           if defined?(ActiveRecord::Base) && account.is_a?(ActiveRecord::Base)
             @account = account.attributes_before_type_cast.symbolize_keys
           elsif defined?(Sequel::Model) && account.is_a?(Sequel::Model)
@@ -46,12 +46,6 @@ module Rodauth
           end
           self
         end
-
-        # clean up inspect output
-        instance.remove_instance_variable(:@internal_request_block)
-        instance.remove_instance_variable(:@internal_request_return_value)
-
-        instance
       end
 
       def model(name = nil, **options)
@@ -67,16 +61,6 @@ module Rodauth
         end
       end
 
-      if ::Rails.gem_version >= Gem::Version.new("5.2")
-        def secret_key_base
-          ::Rails.application.secret_key_base
-        end
-      else
-        def secret_key_base
-          ::Rails.application.secrets.secret_key_base
-        end
-      end
-
       def configure
         yield self
       end

data/rodauth-rails.gemspec

@@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/janko/rodauth-rails"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 3.0"
 
   spec.files         = Dir["README.md", "LICENSE.txt", "lib/**/*", "*.gemspec"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 5.1"
+  spec.add_dependency "railties", ">= 5.2"
   spec.add_dependency "rodauth", "~> 2.36"
   spec.add_dependency "roda", "~> 3.76"
   spec.add_dependency "rodauth-model", "~> 0.2"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Janko Marohnić
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rodauth
   requirement: !ruby/object:Gem::Requirement
@@ -350,14 +350,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.13
 specification_version: 4
 summary: Provides Rails integration for Rodauth authentication framework.
 test_files: []