rodauth-rails 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd5d6b153ae21b024570d612aff57a2c0d6f090f2215723b25bbc362ee743c9b
-  data.tar.gz: e6aac1fe20d00bd4c94559c74dbc56bd971da4404d086ec3193db8e06fe2a3bd
+  metadata.gz: 9805b35cefee7e30cc6f7190e2ace9e7ea75c20f40651eb364edafea2f2382f7
+  data.tar.gz: 503b821866aaf2b6aa108265ed8015869a8c8a6a73e910aa3c38b35c5a542ac1
 SHA512:
-  metadata.gz: 83a5c386eaf39c7aa9b0536e9aed25e8a61bc069e2388bee556b28e9ee00941528fd5431199711d77a28212d281376258ecf0b914d6aa928954d8d99543b827b
-  data.tar.gz: 815d7fee34954d2f512e4532d02bb9d183ad9bde92fc622d522c517cd9db575c8fef98c857dce81c8329cd1798481b8e2f4609390b2472d83825d393886a3576
+  metadata.gz: 5a3e69b6d62f20ee5bc5a13c89acd2974401830a4f0f8917cc7716c9a5ccaad021a20c0f3269a211336b648bd8eb65ae60094c90a039fa1d3968eaf322ec2e47
+  data.tar.gz: 567cf154e656f7062029e207d92149fa8cf2c87404d1ba72fef6327cb31f928d0bcf453a4a0d55f71740251cb74f8b6829b8c775373daec4fe638690cd702104

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+## 0.6.1 (2020-11-25)
+
+* Generate the Rodauth controller for API-only Rails apps as well (@janko)
+
+* Fix remember cookie deadline not extending in remember feature (@janko)
+
+## 0.6.0 (2020-11-22)
+
+* Add `Rodauth::Rails.rodauth` method for retrieving Rodauth instance outside of request context (@janko)
+
+* Add default Action Dispatch response headers in Rodauth responses (@janko)
+
+* Run controller rescue handlers around Rodauth actions (@janko)
+
+* Run controller action callbacks around Rodauth actions (@janko)
+
+## 0.5.0 (2020-11-16)
+
+* Support more Active Record adapters in `rodauth:install` generator (@janko)
+
+* Add `rodauth:migration` generator for creating tables of specified features (@janko)
+
+* Use UUIDs for primary keys if so configured in Rails generators (@janko)
+
+* Add `rodauth:routes` rake task for printing routes handled by Rodauth middleware (@janko)
+
+## 0.4.2 (2020-11-08)
+
+* Drop support for Ruby 2.2 (@janko)
+
+* Bump `sequel-activerecord_connection` dependency to 1.1+ (@janko)
+
+* Set default bcrypt hash cost to `1` in tests (@janko)
+
+* Call `AR::Base.connection_db_config` on Rails 6.1+ in `rodauth:install` generator (@janko)
+
+## 0.4.1 (2020-11-02)
+
+* Don't generate `RodauthController` in API-only mode (@janko)
+
+* Pass `test: false` to Sequel in the `sequel.rb` initializer (@janko)
+
 ## 0.4.0 (2020-11-02)
 
 * Support Rails API-only mode (@janko)

data/README.md

@@ -4,16 +4,22 @@ Provides Rails integration for the [Rodauth] authentication framework.
 
 ## Resources
 
+Useful links:
+
 * [Rodauth documentation](http://rodauth.jeremyevans.net/documentation.html)
-* [rodauth-rails wiki](https://github.com/janko/rodauth-rails/wiki)
 * [Rails demo](https://github.com/janko/rodauth-demo-rails)
 
+Articles:
+
+* [Rodauth: A Refreshing Authentication Solution for Ruby](https://janko.io/rodauth-a-refreshing-authentication-solution-for-ruby/)
+* [Adding Authentication in Rails 6 with Rodauth](https://janko.io/adding-authentication-in-rails-with-rodauth/)
+
 ## Installation
 
 Add the gem to your Gemfile:
 
 ```rb
-gem "rodauth-rails", "~> 0.3"
+gem "rodauth-rails", "~> 0.6"
 
 # gem "jwt",      require: false # for JWT feature
 # gem "rotp",     require: false # for OTP feature
@@ -54,7 +60,6 @@ class CreateRodauth < ActiveRecord::Migration
     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
 ```
@@ -88,7 +93,7 @@ ActiveRecord connection.
 require "sequel/core"
 
 # initialize Sequel and have it reuse Active Record's database connection
-DB = Sequel.postgres(extensions: :activerecord_connection)
+DB = Sequel.connect("postgresql://", extensions: :activerecord_connection)
 ```
 
 ### Rodauth app
@@ -112,8 +117,9 @@ end
 
 ### Controller
 
-Your Rodauth app will by default use `RodauthController` for view rendering
-and CSRF protection.
+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
@@ -121,7 +127,7 @@ class RodauthController < ApplicationController
 end
 ```
 
-### Account Model
+### Account model
 
 Rodauth stores user accounts in the `accounts` table, so the generator will
 also create an `Account` model for custom use.
@@ -132,10 +138,34 @@ class Account < ApplicationRecord
 end
 ```
 
-## Getting started
+## Usage
+
+### Routes
+
+We can see the list of routes our Rodauth middleware handles:
 
-Let's start by adding some basic authentication navigation links to our home
-page:
+```sh
+$ rails rodauth:routes
+```
+```
+Routes handled by RodauthApp:
+
+  /login                   rodauth.login_path
+  /create-account          rodauth.create_account_path
+  /verify-account-resend   rodauth.verify_account_resend_path
+  /verify-account          rodauth.verify_account_path
+  /change-password         rodauth.change_password_path
+  /change-login            rodauth.change_login_path
+  /logout                  rodauth.logout_path
+  /remember                rodauth.remember_path
+  /reset-password-request  rodauth.reset_password_request_path
+  /reset-password          rodauth.reset_password_path
+  /verify-login-change     rodauth.verify_login_change_path
+  /close-account           rodauth.close_account_path
+```
+
+Using this information, we could add some basic authentication links to our
+navigation header:
 
 ```erb
 <ul>
@@ -148,43 +178,48 @@ page:
 </ul>
 ```
 
-These links are fully functional, feel free to visit them and interact with the
+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.
 
-Let's also load the account record for authenticated requests and expose it via
-`#current_account`:
+### Current account
+
+To be able to fetch currently authenticated account, let's define a
+`#current_account` method that fetches the account id from session and
+retrieves the corresponding account record:
 
 ```rb
 # app/controllers/application_controller.rb
 class ApplicationController < ActionController::Base
-  before_action :load_account, if: -> { rodauth.authenticated? }
+  before_action :current_account, if: -> { rodauth.authenticated? }
 
   private
 
-  def load_account
-    @current_account = Account.find(rodauth.session_value)
+  def current_account
+    @current_account ||= Account.find(rodauth.session_value)
   rescue ActiveRecord::RecordNotFound
     rodauth.logout
     rodauth.login_required
   end
-
-  attr_reader   :current_account
   helper_method :current_account
 end
 ```
+
+This allows us to access the current account in controllers and views:
+
 ```erb
 <p>Authenticated as: <%= current_account.email %></p>
 ```
 
 ### Requiring authentication
 
-Next, we'll likely want to require authentication for certain sections/pages of
-our app. We can do this in our Rodauth app's routing block, which helps keep
-the authentication logic encapsulated:
+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
+encapsulated:
 
 ```rb
-# lib/rodauth_app.rb
+# app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
   # ...
   route do |r|
@@ -239,9 +274,9 @@ end
 
 ### Views
 
-The templates built into Rodauth are useful when getting started, but at some
-point we'll probably want more control over the markup. For that we can run the
-following command:
+The templates built into Rodauth are useful when getting started, but soon
+you'll want to start editing the markup. You can run the following command to
+copy Rodauth templates into your Rails app:
 
 ```sh
 $ rails generate rodauth:views
@@ -265,7 +300,7 @@ $ rails generate rodauth:views --all
 ```
 
 You can also tell the generator to create views into another directory (in this
-case don't forget to rename the Rodauth controller accordingly).
+case make sure to rename the Rodauth controller accordingly):
 
 ```sh
 # generates views into app/views/authentication
@@ -300,11 +335,11 @@ end
 
 ### Mailer
 
-Rodauth may send emails as part of the authentication flow. Most email settings
-can be customized:
+Depending on the features you've enabled, Rodauth may send emails as part of
+the authentication flow. Most email settings can be customized:
 
 ```rb
-# lib/rodauth_app.rb
+# app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
   # ...
   configure do
@@ -345,46 +380,117 @@ end
 ```
 
 You can then uncomment the lines in your Rodauth configuration to have it call
-your mailer. If you've enabled additional authentication features, make sure to
-override their `send_*_email` methods as well.
+your mailer. If you've enabled additional authentication features that send
+emails, make sure to override their `create_*_email` methods as well.
 
 ```rb
-# lib/rodauth_app.rb
+# app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
   # ...
   configure do
     # ...
-    send_reset_password_email do
-      mailer_send(:reset_password, email_to, reset_password_email_link)
+    create_reset_password_email do
+      RodauthMailer.reset_password(email_to, reset_password_email_link)
     end
-    send_verify_account_email do
-      mailer_send(:verify_account, email_to, verify_account_email_link)
+    create_verify_account_email do
+      RodauthMailer.verify_account(email_to, verify_account_email_link)
     end
-    send_verify_login_change_email do |login|
-      mailer_send(:verify_login_change, login, verify_login_change_old_login, verify_login_change_new_login, verify_login_change_email_link)
+    create_verify_login_change_email do |login|
+      RodauthMailer.verify_login_change(login, verify_login_change_old_login, verify_login_change_new_login, verify_login_change_email_link)
     end
-    send_password_changed_email do
-      mailer_send(:password_changed, email_to)
+    create_password_changed_email do
+      RodauthMailer.password_changed(email_to)
     end
-    # send_email_auth_email do
-    #   mailer_send(:email_auth, email_to, email_auth_email_link)
+    # create_email_auth_email do
+    #   RodauthMailer.email_auth(email_to, email_auth_email_link)
     # end
-    # send_unlock_account_email do
-    #   mailer_send(:unlock_account, email_to, unlock_account_email_link)
+    # create_unlock_account_email do
+    #   RodauthMailer.unlock_account(email_to, unlock_account_email_link)
     # end
-    auth_class_eval do
+    send_email do |email|
       # queue email delivery on the mailer after the transaction commits
-      def mailer_send(type, *args)
-        db.after_commit do
-          RodauthMailer.public_send(type, *args).deliver_later
-        end
-      end
+      db.after_commit { email.deliver_later }
     end
     # ...
   end
 end
 ```
 
+This approach can be used even if you're using a 3rd-party service for
+transactional emails, where emails are sent via API requests instead of
+SMTP. Whatever the `create_*_email` block returns will be passed to
+`send_email`, so you can be creative.
+
+### Migrations
+
+The install generator will create a migration for tables used by the Rodauth
+features enabled by default. For any additional features, you can use the
+migration generator to create the corresponding tables:
+
+```sh
+$ rails generate rodauth:migration otp sms_codes recovery_codes
+```
+```rb
+# db/migration/*_create_rodauth_otp_sms_codes_recovery_codes.rb
+class CreateRodauthOtpSmsCodesRecoveryCodes < ActiveRecord::Migration
+  def change
+    create_table :account_otp_keys do |t| ... end
+    create_table :account_sms_codes do |t| ... end
+    create_table :account_recovery_codes do |t| ... end
+  end
+end
+```
+
+### JSON API
+
+JSON API support in Rodauth is provided by the [JWT feature]. First you'll need
+to add the [JWT gem] to your Gemfile:
+
+```rb
+gem "jwt"
+```
+
+The following configuration will enable the Rodauth endpoints to be accessed
+via JSON requests (in addition to HTML requests):
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure(json: true) do
+    # ...
+    enable :jwt
+    jwt_secret "...your secret key..."
+    # ...
+  end
+end
+```
+
+If you want the endpoints to be only accessible via JSON requests, or if your
+Rails app is in API-only mode, instead of `json: true` pass `json: :only` to
+the configure method.
+
+Make sure to store the `jwt_secret` in a secure place, such as Rails
+credentials or environment variables.
+
+### Rodauth instance
+
+In some cases you might need to use Rodauth more programmatically, and perform
+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.login_url #=> "https://example.com/login"
+rodauth.account_from_login("user@example.com") # loads user by email
+rodauth.password_match?("secret") #=> true
+rodauth.setup_account_verification
+rodauth.close_account
+```
+
+This Rodauth instance will be initialized with basic Rack env that allows is it
+to generate URLs, using `config.action_mailer.default_url_options` options.
+
 ## How it works
 
 ### Middleware
@@ -429,11 +535,12 @@ end
 The `Rodauth::Rails::App` class is a [Roda] subclass that provides Rails
 integration for Rodauth:
 
-* uses Rails' flash instead of Roda's
-* uses Rails' CSRF protection instead of Roda's
+* uses Action Dispatch flash instead of Roda's
+* uses Action Dispatch CSRF protection instead of Roda's
 * sets [HMAC] secret to Rails' secret key base
-* uses ActionController for rendering templates
-* uses ActionMailer for sending emails
+* uses Action Controller for rendering templates
+* runs Action Controller callbacks & rescue handlers around Rodauth actions
+* uses Action Mailer for sending emails
 
 The `configure { ... }` method wraps configuring the Rodauth plugin, forwarding
 any additional [plugin options].
@@ -490,28 +597,6 @@ Rodauth::Rails.configure do |config|
 end
 ```
 
-## Working with JWT
-
-To use Rodauth's [JWT feature], you'll need to load Roda's JSON support in
-`configure`:
-
-```rb
-# lib/rodauth_app.rb
-class RodauthApp < Rodauth::Rails::App
-  configure(json: true) do
-    enable :jwt
-    jwt_secret "...your secret key..."
-    # your configuration
-  end
-end
-```
-
-Make sure to store the `jwt_secret` in a secure place, such as Rails
-credentials or environment variables.
-
-Rodauth's JWT feature depends on the [JWT gem], so make sure to add it to your
-Gemfile.
-
 ## Testing
 
 If you're writing system tests, it's generally better to go through the actual
@@ -579,6 +664,22 @@ disables the use of database functions, though you can always turn it back on.
 use_database_authentication_functions? true
 ```
 
+To create the database functions, pass the Sequel database object into the
+Rodauth method for creating database functions:
+
+```rb
+# db/migrate/*_create_rodauth_database_functions.rb
+class CreateRodauthDatabaseFunctions < ActiveRecord::Migration
+  def up
+    Rodauth.create_database_authentication_functions(DB)
+  end
+
+  def down
+    Rodauth.drop_database_authentication_functions(DB)
+  end
+end
+```
+
 ### Account statuses
 
 The recommended [Rodauth migration] stores possible account status values in a
@@ -631,7 +732,6 @@ conduct](https://github.com/janko/rodauth-rails/blob/master/CODE_OF_CONDUCT.md).
 
 [Rodauth]: https://github.com/jeremyevans/rodauth
 [Sequel]: https://github.com/jeremyevans/sequel
-[rendering views outside of controllers]: https://blog.bigbinary.com/2016/01/08/rendering-views-outside-of-controllers-in-rails-5.html
 [feature documentation]: http://rodauth.jeremyevans.net/documentation.html
 [JWT feature]: http://rodauth.jeremyevans.net/rdoc/files/doc/jwt_rdoc.html
 [JWT gem]: https://github.com/jwt/ruby-jwt