rodauth-rails 0.8.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40b75a97a14021dafe773b2585d66d6ceef7498dddcef146498721bf39e57426
-  data.tar.gz: 270bac846036bfd32945e71116e6816db4d51ec752ec6ff354be8f38dd206da9
+  metadata.gz: 27d48e6bf86cf81b33f6b0282048c2fb6f16ec6602136e18de6ede5120cfd808
+  data.tar.gz: 2f79498ff25a42131a5ead77f3d4adf05152bc85f271c8b985f0f9fa8c04b503
 SHA512:
-  metadata.gz: 46e413275b4aca41959f36fb21d5fa3fd55eb6c73f87c6eda42a6eb8e36c5886913ad01e6e80394923f38236810aad4d608064f1f51661367798e8da70a9fd11
-  data.tar.gz: 22779086e32ced89a113d33e6b123c64f7f6094e1e41d0b99a741d38c3bbfc3ed64a0894d5b656754717cd11b50c83cd541039c5a8d094ffa3e37e1ed7f592ff
+  metadata.gz: 8a0c44b54d304d4dfb2a205d41a5ac360e483209229fa49e767f9eaa595434b291661e283110f3ee39a8fbc17a4ad2d82f90a6e4545ca4112852ee50a35aa8da
+  data.tar.gz: 52bb16489dd97777f7ff2359be9014a2c55c7537b8d4449621eb95ef3b7f0030febcd06caa811d406db1fb24fcc884d22c7460a36a94255133ce261a2bbeb68d

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+## 0.12.0 (2021-05-15)
+
+* Include total view render time in logs for Rodauth requests (@janko)
+
+* Instrument redirects (@janko)
+
+* Instrument Rodauth requests on `action_controller` namespace (@janko)
+
+* Update templates for Boostrap 5 compatibility (@janko)
+
+* Log request parameters for Rodauth requests (@janko)
+
+## 0.11.0 (2021-05-06)
+
+* Add controller-like logging for requests to Rodauth endpoints (@janko)
+
+* Add `#rails_routes` to Roda and Rodauth instance for accessing Rails route helpers (@janko)
+
+* Add `#rails_request` to Roda and Rodauth instance for retrieving an `ActionDispatch::Request` instance (@janko)
+
+## 0.10.0 (2021-03-23)
+
+* Add `Rodauth::Rails::Auth` superclass for moving configurations into separate files (@janko)
+
+* Load the `pass` Roda plugin and recommend calling `r.pass` on prefixed routes (@janko)
+
+* Improve Roda middleware inspect output (@janko)
+
+* Create `RodauthMailer` and email templates in `rodauth:install`, and remove `rodauth:mailer` (@janko)
+
+* Raise `KeyError` in `#rodauth` method when the Rodauth instance doesn't exist (@janko)
+
+* Add `Rodauth::Rails.authenticated` routing constraint for requiring authentication (@janko)
+
+## 0.9.1 (2021-02-10)
+
+* Fix flash integration being loaded for API-only apps and causing an error (@dmitryzuev)
+
+* Change account status column default to `unverified` in migration to match Rodauth's default (@basabin54)
+
+## 0.9.0 (2021-02-07)
+
+* Load Roda's JSON support by default, so that enabling `json`/`jwt` feature is all that's needed (@janko)
+
+* Bump Rodauth dependency to 2.9+ (@janko)
+
+* Add `--json` option for `rodauth:install` generator for configuring `json` feature (@janko)
+
+* Add `--jwt` option for `rodauth:install` generator for configuring `jwt` feature (@janko)
+
+* Remove the `--api` option from `rodauth:install` generator (@janko)
+
 ## 0.8.2 (2021-01-10)
 
 * Reset Rails session on `#clear_session`, protecting from potential session fixation attacks (@janko)

data/README.md

@@ -14,15 +14,16 @@ Articles:
 * [Rodauth: A Refreshing Authentication Solution for Ruby](https://janko.io/rodauth-a-refreshing-authentication-solution-for-ruby/)
 * [Adding Authentication in Rails with Rodauth](https://janko.io/adding-authentication-in-rails-with-rodauth/)
 * [Adding 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)
 
 ## Why Rodauth?
 
 There are already several popular authentication solutions for Rails (Devise,
-Sorcery, Clearance, Authlogic), so why would you choose Rodauth? Well, because
-it has many advantages over the mentioned alternatives:
+Sorcery, Clearance, Authlogic), so why would you choose Rodauth? Here are some
+of the advantages that stand out for me:
 
 * multifactor authentication ([TOTP][otp], [SMS codes][sms_codes], [recovery codes][recovery_codes], [WebAuthn][webauthn])
-* standardized [JSON API support][jwt] (for every feature)
+* standardized [JSON API support][json] for every feature (including [JWT][jwt])
 * enterprise security features ([password complexity][password_complexity], [disallow password reuse][disallow_password_reuse], [password expiration][password_expiration], [session expiration][session_expiration], [single session][single_session], [account expiration][account_expiration])
 * [email authentication][email_auth] (aka "passwordless")
 * [audit logging][audit_logging] (for any action)
@@ -32,6 +33,12 @@ it has many advantages over the mentioned alternatives:
 * consistent before/after hooks around everything
 * dedicated object encapsulating all authentication logic
 
+One commmon concern is the fact that, unlike most other authentication
+frameworks for Rails, Rodauth uses [Sequel] for database interaction instead of
+Active Record. There are good reasons for this, and to make Rodauth work
+smoothly alongside Active Record, rodauth-rails configures Sequel to [reuse
+Active Record's database connection][sequel-activerecord_connection].
+
 ## Upgrading
 
 ### Upgrading to 0.7.0
@@ -54,7 +61,7 @@ documentation][hmac] for instructions on how to safely transition, or just set
 Add the gem to your Gemfile:
 
 ```rb
-gem "rodauth-rails", "~> 0.6"
+gem "rodauth-rails", "~> 0.12"
 
 # gem "jwt",      require: false # for JWT feature
 # gem "rotp",     require: false # for OTP feature
@@ -73,118 +80,28 @@ $ rails generate rodauth:install
 Or if you want Rodauth endpoints to be exposed via JSON API:
 
 ```sh
-$ rails generate rodauth:install --api
+$ rails generate rodauth:install --json # regular authentication using the Rails session
+# or
+$ rails generate rodauth:install --jwt # token authentication via the "Authorization" header
 $ bundle add jwt
 ```
 
-The generator will create the following files:
-
-* Rodauth migration at `db/migrate/*_create_rodauth.rb`
-* Rodauth initializer at `config/initializers/rodauth.rb`
-* Sequel initializer at `config/initializers/sequel.rb` for ActiveRecord integration
-* Rodauth app at `app/lib/rodauth_app.rb`
-* Rodauth controller at `app/controllers/rodauth_controller.rb`
-* Account model at `app/models/account.rb`
-
-### Migration
-
-The migration file creates tables required by Rodauth. You're encouraged to
-review the migration, and modify it to only create tables for features you
-intend to use.
-
-```rb
-# db/migrate/*_create_rodauth.rb
-class CreateRodauth < ActiveRecord::Migration
-  def change
-    create_table :accounts do |t| ... end
-    create_table :account_password_hashes do |t| ... end
-    create_table :account_password_reset_keys do |t| ... end
-    create_table :account_verification_keys do |t| ... end
-    create_table :account_login_change_keys do |t| ... end
-    create_table :account_remember_keys do |t| ... end
-  end
-end
-```
+This generator will create a Rodauth app with common authentication features
+enabled, a database migration with tables required by those features, a mailer
+with default templates, and a few other files.
 
-Once you're done, you can run the migration:
+Feel free to remove any features you don't need, along with their corresponding
+tables. Afterwards, run the migration:
 
-```
+```sh
 $ rails db:migrate
 ```
 
-### Rodauth initializer
-
-The Rodauth initializer assigns the constant for your Rodauth app, which will
-be called by the Rack middleware that's added in front of your Rails router.
-
-```rb
-# config/initializers/rodauth.rb
-Rodauth::Rails.configure do |config|
-  config.app = "RodauthApp"
-end
-```
-
-### Sequel initializer
-
-Rodauth uses [Sequel] for database interaction. If you're using ActiveRecord,
-an additional initializer will be created which configures Sequel to use the
-ActiveRecord connection.
-
-```rb
-# config/initializers/sequel.rb
-require "sequel/core"
-
-# initialize Sequel and have it reuse Active Record's database connection
-DB = Sequel.connect("postgresql://", extensions: :activerecord_connection)
-```
-
-### Rodauth app
-
-Your Rodauth app is created in the `app/lib/` directory, and comes with a
-default set of authentication features enabled, as well as extensive examples
-on ways you can configure authentication behaviour.
-
-```rb
-# app/lib/rodauth_app.rb
-class RodauthApp < Rodauth::Rails::App
-  configure do
-    # authentication configuration
-  end
-
-  route do |r|
-    # request handling
-  end
-end
-```
-
-### Controller
-
-Your Rodauth app will by default use `RodauthController` for view rendering,
-CSRF protection, and running controller callbacks and rescue handlers around
-Rodauth actions.
-
-```rb
-# app/controllers/rodauth_controller.rb
-class RodauthController < ApplicationController
-end
-```
-
-### Account model
-
-Rodauth stores user accounts in the `accounts` table, so the generator will
-also create an `Account` model for custom use.
-
-```rb
-# app/models/account.rb
-class Account < ApplicationRecord
-end
-```
-
 ## Usage
 
 ### Routes
 
-We can see the list of routes our Rodauth middleware handles:
+You can see the list of routes our Rodauth middleware handles:
 
 ```sh
 $ rails rodauth:routes
@@ -206,7 +123,7 @@ Routes handled by RodauthApp:
   /close-account           rodauth.close_account_path
 ```
 
-Using this information, we could add some basic authentication links to our
+Using this information, you can add some basic authentication links to your
 navigation header:
 
 ```erb
@@ -222,9 +139,22 @@ These routes are fully functional, feel free to visit them and interact with the
 pages. The templates that ship with Rodauth aim to provide a complete
 authentication experience, and the forms use [Bootstrap] markup.
 
+Inside Rodauth configuration and the `route` block you can access Rails route
+helpers through `#rails_routes`:
+
+```rb
+class RodauthApp < Rodauth::Rails::App
+  configure do
+    # ...
+    login_redirect { rails_routes.activity_path }
+    # ...
+  end
+end
+```
+
 ### Current account
 
-To be able to fetch currently authenticated account, let's define a
+To be able to fetch currently authenticated account, you can define a
 `#current_account` method that fetches the account id from session and
 retrieves the corresponding account record:
 
@@ -241,11 +171,11 @@ class ApplicationController < ActionController::Base
     rodauth.logout
     rodauth.login_required
   end
-  helper_method :current_account
+  helper_method :current_account # skip if inheriting from ActionController::API
 end
 ```
 
-This allows us to access the current account in controllers and views:
+This allows you to access the current account in controllers and views:
 
 ```erb
 <p>Authenticated as: <%= current_account.email %></p>
@@ -253,9 +183,9 @@ This allows us to access the current account in controllers and views:
 
 ### Requiring authentication
 
-We'll likely want to require authentication for certain parts of our app,
-redirecting the user to the login page if they're not logged in. We can do this
-in our Rodauth app's routing block, which helps keep the authentication logic
+You'll likely want to require authentication for certain parts of your app,
+redirecting the user to the login page if they're not logged in. You can do this
+in your Rodauth app's routing block, which helps keep the authentication logic
 encapsulated:
 
 ```rb
@@ -274,7 +204,7 @@ class RodauthApp < Rodauth::Rails::App
 end
 ```
 
-We can also require authentication at the controller layer:
+You can also require authentication at the controller layer:
 
 ```rb
 # app/controllers/application_controller.rb
@@ -299,15 +229,52 @@ class PostsController < ApplicationController
 end
 ```
 
-Or at the Rails router level:
+#### Routing constraints
+
+In some cases it makes sense to require authentication at the Rails router
+level. You can do this via the built-in `authenticated` routing constraint:
 
 ```rb
 # config/routes.rb
 Rails.application.routes.draw do
-  constraints -> (r) { r.env["rodauth"].require_authentication } do
-    namespace :admin do
-      # ...
-    end
+  constraints Rodauth::Rails.authenticated do
+    # ... authenticated routes ...
+  end
+end
+```
+
+If you want additional conditions, you can pass in a block, which is
+called with the Rodauth instance:
+
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  # require multifactor authentication to be setup
+  constraints Rodauth::Rails.authenticated { |rodauth| rodauth.uses_two_factor_authentication? } do
+    # ...
+  end
+end
+```
+
+You can specify the Rodauth configuration by passing the configuration name:
+
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  constraints Rodauth::Rails.authenticated(:admin) do
+    # ...
+  end
+end
+```
+
+If you need something more custom, you can always create the routing constraint
+manually:
+
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  constraints -> (r) { !r.env["rodauth"].logged_in? } do # or "rodauth.admin"
+    # routes when the user is not logged in
   end
 end
 ```
@@ -327,7 +294,7 @@ This will generate views for the default set of Rodauth features into the
 `RodauthController`.
 
 You can pass a list of Rodauth features to the generator to create views for
-these features (this will not remove any existing views):
+these features (this will not remove or overwrite any existing views):
 
 ```sh
 $ rails generate rodauth:views login create_account lockout otp
@@ -375,58 +342,36 @@ end
 
 ### Mailer
 
-Depending on the features you've enabled, Rodauth may send emails as part of
-the authentication flow. Most email settings can be customized:
+The install generator will create `RodauthMailer` with default email templates,
+and configure Rodauth features that send emails as part of the authentication
+flow to use it.
 
 ```rb
-# app/lib/rodauth_app.rb
-class RodauthApp < Rodauth::Rails::App
-  # ...
-  configure do
+# app/mailers/rodauth_mailer.rb
+class RodauthMailer < ApplicationMailer
+  def verify_account(recipient, email_link)
     # ...
-    # general settings
-    email_from "no-reply@myapp.com"
-    email_subject_prefix "[MyApp] "
-    send_email(&:deliver_later)
+  end
+  def reset_password(recipient, email_link)
     # ...
-    # feature settings
-    verify_account_email_subject "Verify your account"
-    verify_account_email_body { "Verify your account by visting this link: #{verify_account_email_link}" }
+  end
+  def verify_login_change(recipient, old_login, new_login, email_link)
     # ...
   end
+  def password_changed(recipient)
+    # ...
+  end
+  # def email_auth(recipient, email_link)
+  # ...
+  # end
+  # def unlock_account(recipient, email_link)
+  # ...
+  # end
 end
 ```
-
-This is convenient when starting out, but eventually you might want to use your
-own mailer. You can start by running the following command:
-
-```sh
-$ rails generate rodauth:mailer
-```
-
-This will create a `RodauthMailer` with the associated mailer views in
-`app/views/rodauth_mailer` directory:
-
-```rb
-# app/mailers/rodauth_mailer.rb
-class RodauthMailer < ApplicationMailer
-  def verify_account(recipient, email_link) ... end
-  def reset_password(recipient, email_link) ... end
-  def verify_login_change(recipient, old_login, new_login, email_link) ... end
-  def password_changed(recipient) ... end
-  # def email_auth(recipient, email_link) ... end
-  # def unlock_account(recipient, email_link) ... end
-end
-```
-
-You can then uncomment the lines in your Rodauth configuration to have it call
-your mailer. If you've enabled additional authentication features that send
-emails, make sure to override their `create_*_email` methods as well.
-
 ```rb
 # app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
-  # ...
   configure do
     # ...
     create_reset_password_email do
@@ -456,10 +401,17 @@ class RodauthApp < Rodauth::Rails::App
 end
 ```
 
-This approach can be used even if you're using a 3rd-party service for
-transactional emails, where emails are sent via HTTP instead of SMTP. Whatever
-the `create_*_email` block returns will be passed to `send_email`, so you can
-be creative.
+This configuration calls `#deliver_later`, which uses Active Job to deliver
+emails in a background job. It's generally recommended to send emails
+asynchronously for better request throughput and the ability to retry
+deliveries. However, if you want to send emails synchronously, modify the
+configuration to call `#deliver_now` instead.
+
+If you're using a background processing library without an Active Job adapter,
+or a 3rd-party service for sending transactional emails, this two-phase API
+might not be suitable. In this case, instead of overriding `#create_*_email`
+and `#send_email`, override the `#send_*_email` methods instead, which are
+required to send the email immediately.
 
 ### Migrations
 
@@ -481,6 +433,143 @@ class CreateRodauthOtpSmsCodesRecoveryCodes < ActiveRecord::Migration
 end
 ```
 
+### Multiple configurations
+
+If you need to handle multiple types of accounts that require different
+authentication logic, you can create additional configurations for them:
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  # primary configuration
+  configure do
+    # ...
+  end
+
+  # alternative configuration
+  configure(:admin) do
+    # ... enable features ...
+    prefix "/admin"
+    session_key_prefix "admin_"
+    remember_cookie_key "_admin_remember" # if using remember feature
+
+    # if you want separate tables
+    accounts_table :admin_accounts
+    password_hash_table :admin_account_password_hashes
+    # ...
+  end
+
+  route do |r|
+    r.rodauth
+
+    r.on "admin" do
+      r.rodauth(:admin)
+      r.pass # allow the Rails app to handle other "/admin/*" requests
+    end
+
+    # ...
+  end
+end
+```
+
+Then in your application you can reference the secondary Rodauth instance:
+
+```rb
+rodauth(:admin).login_path #=> "/admin/login"
+```
+
+#### Named auth classes
+
+A `configure` block inside `Rodauth::Rails::App` will internally create an
+anonymous `Rodauth::Auth` subclass, and register it under the given name.
+However, you can also define the auth classes explicitly, by creating
+subclasses of `Rodauth::Rails::Auth`:
+
+```rb
+# app/lib/rodauth_main.rb
+class RodauthMain < Rodauth::Rails::Auth
+  configure do
+    # ... main configuration ...
+  end
+end
+```
+```rb
+# app/lib/rodauth_admin.rb
+class RodauthAdmin < Rodauth::Rails::Auth
+  configure do
+    # ...
+    prefix "/admin"
+    session_key_prefix "admin_"
+    # ...
+  end
+end
+```
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure RodauthMain
+  configure RodauthAdmin, :admin
+  # ...
+end
+```
+
+This allows having each configuration in a dedicated file, and named constants
+improve introspection and error messages. You can also use inheritance to share
+common settings:
+
+```rb
+# app/lib/rodauth_base.rb
+class RodauthBase < Rodauth::Rails::Auth
+  # common settings that can be shared between multiple configurations
+  configure do
+    enable :login, :logout
+    login_return_to_requested_location? true
+    logout_redirect "/"
+    # ...
+  end
+end
+```
+```rb
+# app/lib/rodauth_main.rb
+class RodauthMain < RodauthBase # inherit common settings
+  configure do
+    # ... customize main ...
+  end
+end
+```
+```rb
+# app/lib/rodauth_admin.rb
+class RodauthAdmin < RodauthBase # inherit common settings
+  configure do
+    # ... customize admin ...
+  end
+end
+```
+
+Another benefit of explicit classes is that you can define custom methods
+directly at the class level instead of inside an `auth_class_eval`:
+
+```rb
+# app/lib/rodauth_admin.rb
+class RodauthAdmin < Rodauth::Rails::Auth
+  configure do
+    # ...
+  end
+
+  def superadmin?
+    Role.where(account_id: session_id, type: "superadmin").any?
+  end
+end
+```
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  constraints Rodauth::Rails.authenticated(:admin) { |rodauth| rodauth.superadmin? } do
+    mount Sidekiq::Web => "sidekiq"
+  end
+end
+```
+
 ### Calling controller methods
 
 When using Rodauth before/after hooks or generally overriding your Rodauth
@@ -514,7 +603,7 @@ Rodauth operations outside of the request context. rodauth-rails gives you the
 ability to retrieve the Rodauth instance:
 
 ```rb
-rodauth = Rodauth::Rails.rodauth # or Rodauth::Rails.rodauth(:secondary)
+rodauth = Rodauth::Rails.rodauth # or Rodauth::Rails.rodauth(:admin)
 
 rodauth.login_url #=> "https://example.com/login"
 rodauth.account_from_login("user@example.com") # loads user by email
@@ -523,7 +612,7 @@ rodauth.setup_account_verification
 rodauth.close_account
 ```
 
-This Rodauth instance will be initialized with basic Rack env that allows is it
+This Rodauth instance will be initialized with basic Rack env that allows it
 to generate URLs, using `config.action_mailer.default_url_options` options.
 
 ## How it works
@@ -545,8 +634,8 @@ The Rodauth app stores the `Rodauth::Auth` instance in the Rack env hash, which
 is then available in your Rails app:
 
 ```rb
-request.env["rodauth"]           #=> #<Rodauth::Auth>
-request.env["rodauth.secondary"] #=> #<Rodauth::Auth> (if using multiple configurations)
+request.env["rodauth"]       #=> #<Rodauth::Auth>
+request.env["rodauth.admin"] #=> #<Rodauth::Auth> (if using multiple configurations)
 ```
 
 For convenience, this object can be accessed via the `#rodauth` method in views
@@ -555,14 +644,14 @@ and controllers:
 ```rb
 class MyController < ApplicationController
   def my_action
-    rodauth             #=> #<Rodauth::Auth>
-    rodauth(:secondary) #=> #<Rodauth::Auth> (if using multiple configurations)
+    rodauth         #=> #<Rodauth::Auth>
+    rodauth(:admin) #=> #<Rodauth::Auth> (if using multiple configurations)
   end
 end
 ```
 ```erb
-<% rodauth             #=> #<Rodauth::Auth> %>
-<% rodauth(:secondary) #=> #<Rodauth::Auth> (if using multiple configurations) %>
+<% rodauth         #=> #<Rodauth::Auth> %>
+<% rodauth(:admin) #=> #<Rodauth::Auth> (if using multiple configurations) %>
 ```
 
 ### App
@@ -584,7 +673,7 @@ any additional [plugin options].
 class RodauthApp < Rodauth::Rails::App
   configure { ... }             # defining default Rodauth configuration
   configure(json: true) { ... } # passing options to the Rodauth plugin
-  configure(:secondary) { ... } # defining multiple Rodauth configurations
+  configure(:admin) { ... }     # defining multiple Rodauth configurations
 end
 ```
 
@@ -619,15 +708,32 @@ function calls).
 
 If ActiveRecord is used in the application, the `rodauth:install` generator
 will have automatically configured Sequel to reuse ActiveRecord's database
-connection (using the [sequel-activerecord_connection] gem).
+connection, using the [sequel-activerecord_connection] gem.
 
 This means that, from the usage perspective, Sequel can be considered just
 as an implementation detail of Rodauth.
 
 ## JSON API
 
-JSON API support in Rodauth is provided by the [JWT feature][jwt]. You'll need
-to install the [JWT gem], enable JSON support and enable the JWT feature:
+To make Rodauth endpoints accessible via JSON API, enable the [`json`][json]
+feature:
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure do
+    # ...
+    enable :json
+    only_json? true # accept only JSON requests (optional)
+    # ...
+  end
+end
+```
+
+This will store account session data into the Rails session. If you rather want
+stateless token-based authentication via the `Authorization` header, enable the
+[`jwt`][jwt] feature (which builds on top of the `json` feature) and add the
+[JWT gem] to the Gemfile:
 
 ```sh
 $ bundle add jwt
@@ -635,23 +741,33 @@ $ bundle add jwt
 ```rb
 # app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
-  configure(json: :only) do
+  configure do
     # ...
     enable :jwt
-    # make sure to store the JWT secret below in a safe place
-    jwt_secret "...your secret key..."
+    jwt_secret "<YOUR_SECRET_KEY>" # store the JWT secret in a safe place
+    only_json? true # accept only JSON requests (optional)
     # ...
   end
 end
 ```
 
-With the above configuration, Rodauth routes will only be accessible via JSON
-requests. If you still want to allow HTML access alongside JSON, change `json:
-:only` to `json: true`.
+If you need Cross-Origin Resource Sharing and/or JWT refresh tokens, enable the
+corresponding Rodauth features and create the necessary tables:
 
-Emails will automatically work in JSON-only mode, because `Rodauth::Rails::App`
-comes with Roda's `render` plugin loaded. They are customized the same as in
-the non-JSON case.
+```sh
+$ rails generate rodauth:migration jwt_refresh
+$ rails db:migrate
+```
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure do
+    # ...
+    enable :jwt, :jwt_cors, :jwt_refresh
+    # ...
+  end
+end
+```
 
 ## OmniAuth
 
@@ -709,7 +825,8 @@ end
 <%= link_to "Login via Facebook", "/auth/facebook" %>
 ```
 
-Let's implement the OmniAuth callback endpoint on our Rodauth controller:
+Finally, let's implement the OmniAuth callback endpoint on our Rodauth
+controller:
 
 ```rb
 # config/routes.rb
@@ -745,7 +862,7 @@ class RodauthController < ApplicationController
 
     # create new account if it doesn't exist
     unless account
-      account = Account.create!(email: auth["info"]["email"])
+      account = Account.create!(email: auth["info"]["email"], status: rodauth.account_open_status_value)
     end
 
     # create new identity if it doesn't exist
@@ -762,11 +879,8 @@ end
 
 ## Configuring
 
-For the list of configuration methods provided by Rodauth, see the [feature
-documentation].
-
-The `rails` feature rodauth-rails loads is customizable as well, here is the
-list of its configuration methods:
+The `rails` feature rodauth-rails loads provides the following configuration
+methods:
 
 | Name                        | Description                                                        |
 | :----                       | :----------                                                        |
@@ -793,21 +907,27 @@ Rodauth::Rails.configure do |config|
 end
 ```
 
+For the list of configuration methods provided by Rodauth, see the [feature
+documentation].
+
 ## Custom extensions
 
 When developing custom extensions for Rodauth inside your Rails project, it's
-better to use plain modules (at least in the beginning), because Rodauth
-feature API doesn't yet support Zeitwerk reloading well.
+probably better to use plain modules, at least in the beginning, as Rodauth
+feature design doesn't yet work well with Zeitwerk reloading.
+
+Here is an example of an LDAP authentication extension that uses the
+[simple_ldap_authenticator] gem.
 
 ```rb
-# app/lib/rodauth_argon2.rb
-module RodauthArgon2
-  def password_hash(password)
-    Argon2::Password.create(password, t_cost: password_hash_cost, m_cost: password_hash_cost)
+# app/lib/rodauth_ldap.rb
+module RodauthLdap
+  def require_bcrypt?
+    false
   end
 
-  def password_hash_match?(hash, password)
-    Argon2::Password.verify_password(password, hash)
+  def password_match?(password)
+    SimpleLdapAuthenticator.valid?(account[:email], password)
   end
 end
 ```
@@ -817,7 +937,7 @@ class RodauthApp < Rodauth::Rails::App
   configure do
     # ...
     auth_class_eval do
-      include RodauthArgon2
+      include RodauthLdap
     end
     # ...
   end
@@ -826,48 +946,156 @@ end
 
 ## Testing
 
-If you're writing system tests, it's generally better to go through the actual
-authentication flow with tools like Capybara, and to not use any stubbing.
-
-In functional and integration tests you can just make requests to Rodauth
-routes:
+System (browser) tests for Rodauth actions could look something like this:
 
 ```rb
-# test/controllers/posts_controller_test.rb
-class PostsControllerTest < ActionDispatch::IntegrationTest
-  test "should require authentication" do
-    get posts_url
-    assert_redirected_to "/login"
+# test/system/authentication_test.rb
+require "test_helper"
+
+class AuthenticationTest < ActionDispatch::SystemTestCase
+  include ActiveJob::TestHelper
+  driven_by :rack_test
+
+  test "creating and verifying an account" do
+    create_account
+    assert_match "An email has been sent to you with a link to verify your account", page.text
+
+    verify_account
+    assert_match "Your account has been verified", page.text
+  end
+
+  test "logging in and logging out" do
+    create_account(verify: true)
+
+    logout
+    assert_match "You have been logged out", page.text
 
     login
-    get posts_url
+    assert_match "You have been logged in", page.text
+  end
+
+  private
+
+  def create_account(email: "user@example.com", password: "secret", verify: false)
+    visit "/create-account"
+    fill_in "Login", with: email
+    fill_in "Password", with: password
+    fill_in "Confirm Password", with: password
+    click_on "Create Account"
+    verify_account if verify
+  end
+
+  def verify_account
+    perform_enqueued_jobs # run enqueued email deliveries
+    email = ActionMailer::Base.deliveries.last
+    verify_account_link = email.body.to_s[/\S+verify-account\S+/]
+    visit verify_account_link
+    click_on "Verify Account"
+  end
+
+  def login(email: "user@example.com", password: "secret")
+    visit "/login"
+    fill_in "Login", with: email
+    fill_in "Password", with: password
+    click_on "Login"
+  end
+
+  def logout
+    visit "/logout"
+    click_on "Logout"
+  end
+end
+```
+
+While request tests in JSON API mode with JWT tokens could look something like
+this:
+
+```rb
+# test/integration/authentication_test.rb
+require "test_helper"
+
+class AuthenticationTest < ActionDispatch::IntegrationTest
+  test "creating and verifying an account" do
+    create_account
     assert_response :success
+    assert_match "An email has been sent to you with a link to verify your account", JSON.parse(body)["success"]
+
+    verify_account
+    assert_response :success
+    assert_match "Your account has been verified", JSON.parse(body)["success"]
+  end
+
+  test "logging in and logging out" do
+    create_account(verify: true)
 
     logout
-    assert_redirected_to "/login"
+    assert_response :success
+    assert_match "You have been logged out", JSON.parse(body)["success"]
+
+    login
+    assert_response :success
+    assert_match "You have been logged in", JSON.parse(body)["success"]
   end
 
   private
 
-  def login(login: "user@example.com", password: "secret")
-    post "/create-account", params: {
-      "login"            => login,
-      "password"         => password,
-      "password-confirm" => password,
-    }
+  def create_account(email: "user@example.com", password: "secret", verify: false)
+    post "/create-account", as: :json, params: { login: email, password: password, "password-confirm": password }
+    verify_account if verify
+  end
 
-    post "/login", params: {
-      "login"    => login,
-      "password" => password,
-    }
+  def verify_account
+    perform_enqueued_jobs # run enqueued email deliveries
+    email = ActionMailer::Base.deliveries.last
+    verify_account_key = email.body.to_s[/verify-account\?key=(\S+)/, 1]
+    post "/verify-account", as: :json, params: { key: verify_account_key }
+  end
+
+  def login(email: "user@example.com", password: "secret")
+    post "/login", as: :json, params: { login: email, password: password }
   end
 
   def logout
-    post "/logout"
+    post "/logout", as: :json, headers: { "Authorization" => headers["Authorization"] }
   end
 end
 ```
 
+If you're delivering emails in the background, make sure to set Active Job
+queue adapter to `:test` or `:inline`:
+
+```rb
+# config/environments/test.rb
+Rails.application.configure do |config|
+  # ...
+  config.active_job.queue_adapter = :test # or :inline
+  # ...
+end
+```
+
+If you need to create an account record with a password directly, you can do it
+as follows:
+
+```rb
+# app/models/account.rb
+class Account < ApplicationRecord
+  has_one :password_hash, foreign_key: :id
+end
+```
+```rb
+# app/models/account/password_hash.rb
+class Account::PasswordHash < ApplicationRecord
+  belongs_to :account, foreign_key: :id
+end
+```
+```rb
+require "bcrypt"
+
+account = Account.create!(email: "user@example.com", status: "verified")
+password_hash = BCrypt::Password.create("secret", cost: BCrypt::Engine::MIN_COST)
+account.create_password_hash!(id: account.id, password_hash: password_hash)
+```
+
 ## Rodauth defaults
 
 rodauth-rails changes some of the default Rodauth settings for easier setup:
@@ -976,6 +1204,7 @@ conduct](https://github.com/janko/rodauth-rails/blob/master/CODE_OF_CONDUCT.md).
 [sms_codes]: http://rodauth.jeremyevans.net/rdoc/files/doc/sms_codes_rdoc.html
 [recovery_codes]: http://rodauth.jeremyevans.net/rdoc/files/doc/recovery_codes_rdoc.html
 [webauthn]: http://rodauth.jeremyevans.net/rdoc/files/doc/webauthn_rdoc.html
+[json]: http://rodauth.jeremyevans.net/rdoc/files/doc/json_rdoc.html
 [jwt]: http://rodauth.jeremyevans.net/rdoc/files/doc/jwt_rdoc.html
 [email_auth]: http://rodauth.jeremyevans.net/rdoc/files/doc/email_auth_rdoc.html
 [audit_logging]: http://rodauth.jeremyevans.net/rdoc/files/doc/audit_logging_rdoc.html
@@ -987,3 +1216,4 @@ conduct](https://github.com/janko/rodauth-rails/blob/master/CODE_OF_CONDUCT.md).
 [session_expiration]: http://rodauth.jeremyevans.net/rdoc/files/doc/session_expiration_rdoc.html
 [single_session]: http://rodauth.jeremyevans.net/rdoc/files/doc/single_session_rdoc.html
 [account_expiration]: http://rodauth.jeremyevans.net/rdoc/files/doc/account_expiration_rdoc.html
+[simple_ldap_authenticator]: https://github.com/jeremyevans/simple_ldap_authenticator