quo_vadis 2.1.8 → 2.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d11498bfa66e0397304c2d9a0f8ac504037f97beac4fd039fe6c8d0299696531
-  data.tar.gz: 2d1e267c7b55740c72087e297960ff6ececb1caee45a17eb588bf7e44ba64d31
+  metadata.gz: f75e1f5d40a86773e5cec5133d3822431d8ed76e581d7e712912481ae56ec29a
+  data.tar.gz: 3789a04b43d20d1c3b4e4aaf6e5c8b88f53c4bc97fce5ee4b546063e1bfa9801
 SHA512:
-  metadata.gz: e4e7c7bb2996556b35b153c56916aef9834dcac2abea08ede8becc14e030d8f4ea1444f9286c1ca9b728c1a13c16d8d9b2e701255d57b769c7dc9abefa84a976
-  data.tar.gz: f466404a5ba44bfd506cbcd2fdc7b2f2d142ecab419363e3c368bb5eca67cfc78829afa698b8b0dc1cc76210b531a32a44c3bfdcd1ae709cf9eafe740861f089
+  metadata.gz: ac21c181a2339c6d515ae2c7defe20ced03c103ac9e144ca4edcf3169d0ea4bafa18f4a2011912c611310e0adf5736285f7d8b2dff5b031468e735940bcbc3b0
+  data.tar.gz: 432bb81c9d8de26a659a718a533579bdd982c4565ae5df96511dc5ec60bf84c4d4665c694e1db9b0837434b6a9d5d43a9db7006b6e278a1b9d1c9d8cf2f54c2e

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 ## HEAD
 
 
+## 2.1.10 (14 September 2022)
+
+* Enable configuration of mailer superclass.
+
+
+## 2.1.9 (13 September 2022)
+
+* Enable code to be run after sign up.
+
+
 ## 2.1.8 (18 June 2022)
 
 * Extract convenience method for has authentication account.
@@ -35,7 +45,7 @@
 
 ## 2.1.3 (30 September 2021)
 
-* Pass IP and timestamp as paramenters to mailer.
+* Pass IP and timestamp as parameters to mailer.
 
 
 ## 2.1.2 (30 September 2021)

data/README.md

@@ -177,7 +177,7 @@ Your new user sign-up form ([example](https://github.com/airblade/quo_vadis/blob
 
 In your controller, use the `#login` method to log in your new user.  The optional second argument sets the length of the session (defaults to the browser session) - see the description above in the Controllers section).
 
-After logging in the user, redirect them to `qv.path_after_authentication` which resolves to a route named `:after_login`, if you have one, or your root route.
+After logging in the user, redirect them wherever you like.  You can use `qv.path_after_signup` which resolves to the first of these routes that exists: `:after_signup`, `:after_login`, the root route.
 
 ```ruby
 class UsersController < ApplicationController
@@ -185,7 +185,7 @@ class UsersController < ApplicationController
     @user = User.new user_params
     if @user.save
       login @user
-      redirect_to qv.path_after_authentication
+      redirect_to qv.path_after_signup
     else
       # ...
     end
@@ -258,10 +258,7 @@ Next, write the page where the user can amend their email address if they made a
 
 Finally, write the page where people can put in their identifier (not their email, unless the identifier is email) again to request another confirmation email ([example](https://github.com/airblade/quo_vadis/blob/master/app/views/quo_vadis/confirmations/new.html.erb)).  It must be in `app/views/quo_vadis/confirmations/new.html.:format`.
 
-After the user has confirmed their account, they will be logged in and redirected to the first of these that exists:
-
-- a route named `:after_login`;
-- your root route.
+After the user has confirmed their account, they will be logged in and redirected to `qv.path_after_signup` which resolves to the first of these routes that exists: `:after_signup`, `:after_login`, the root route.
 
 So add whichever works best for you.
 
@@ -469,6 +466,10 @@ __`account_confirmation_token_lifetime`__ (`ActiveSupport::Duration` | integer)
 
 The `Duration` or number of seconds for which an account-confirmation token is valid.
 
+__`mailer_superclass`__ (string)
+
+The class from which QuoVadis's mailer inherits.
+
 __`mail_headers`__ (hash)
 
 Mail headers which QuoVadis' emails should have.
@@ -518,12 +519,13 @@ end
 
 __Routes__
 
-You can set up your post-authentication and post-password-change routes.  If you don't, you must have a root route.  For example:
+You can set up your post-signup, post-authentication, and post-password-change routes.  If you don't, you must have a root route.  For example:
 
 ```ruby
 # config/routes.rb
-get '/dashboard', to: 'dashboards#show', as: 'after_login'
-get '/profile',   to: 'profiles#show',   as: 'after_password_change'
+get '/signups/confirmed', to: 'dashboards#show', as: 'after_signup'
+get '/dashboard',         to: 'dashboards#show', as: 'after_login'
+get '/profile',           to: 'profiles#show',   as: 'after_password_change'
 ```
 
 ### I18n

data/app/controllers/quo_vadis/confirmations_controller.rb

@@ -51,7 +51,7 @@ module QuoVadis
       session.delete :account_pending_confirmation
 
       login account.model, true
-      redirect_to qv.path_after_authentication, notice: QuoVadis.translate('flash.confirmation.confirmed')
+      redirect_to qv.path_after_signup, notice: QuoVadis.translate('flash.confirmation.confirmed')
     end
 
 

data/app/mailers/quo_vadis/mailer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module QuoVadis
-  class Mailer < ::ActionMailer::Base
+  class Mailer < QuoVadis.mailer_superclass.constantize
 
     def reset_password
       @url = params[:url]

data/lib/quo_vadis/controller.rb

@@ -192,6 +192,13 @@ module QuoVadis
         Log.create account: account, action: action, ip: request.remote_ip, metadata: metadata
       end
 
+      def path_after_signup
+        return main_app.after_signup_path if main_app.respond_to?(:after_signup_path)
+        return main_app.after_login_path  if main_app.respond_to?(:after_login_path)
+        return main_app.root_path         if main_app.respond_to?(:root_path)
+        raise RuntimeError, 'Missing routes: after_signup_path, after_login_path, root_path; define at least one of them.'
+      end
+
       def path_after_authentication
         if (bookmark = rails_session[:qv_bookmark])
           rails_session.delete :qv_bookmark

data/lib/quo_vadis/defaults.rb

@@ -10,6 +10,7 @@ QuoVadis.configure do
   password_reset_token_lifetime         10.minutes
   accounts_require_confirmation         false
   account_confirmation_token_lifetime   10.minutes
+  mailer_superclass                     'ApplicationMailer'
   mail_headers                          ({ from: 'Example App <support@example.com>' })
   enqueue_transactional_emails          true
   app_name                              Rails.app_class.to_s.deconstantize  # for the TOTP QR code

data/lib/quo_vadis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QuoVadis
-  VERSION = '2.1.8'
+  VERSION = '2.1.10'
 end

data/lib/quo_vadis.rb

@@ -25,6 +25,7 @@ module QuoVadis
     :session_lifetime_extend_to_end_of_day,# true | false
     :session_idle_timeout,                 # :lifetime | ActiveSupport::Duration | [integer] seconds
     :password_reset_token_lifetime,        # ActiveSupport::Duration | [integer] seconds
+    :mailer_superclass,                    # string
     :mail_headers,                         # hash
     :accounts_require_confirmation,        # true | false
     :account_confirmation_token_lifetime,  # ActiveSupport::Duration | [integer] seconds

data/test/dummy/app/controllers/sign_ups_controller.rb

@@ -26,6 +26,11 @@ class SignUpsController < ApplicationController
     @user = User.find params[:id]
   end
 
+  def confirmed
+    # Here we could send an email.
+    redirect_to after_login_path
+  end
+
   private
 
   def user_params

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,2 @@
+class ApplicationMailer < ActionMailer::Base
+end

data/test/dummy/config/routes.rb

@@ -1,5 +1,6 @@
 Rails.application.routes.draw do
   resources :users
+  get '/sign_ups/confirmed', to: 'sign_ups#confirmed', as: 'after_signup'
   resources :sign_ups
   resources :articles do
     collection do

data/test/integration/account_confirmation_test.rb

@@ -33,6 +33,8 @@ class AccountConfirmationTest < IntegrationTest
     put action_path
 
     # verify logged in
+    assert_redirected_to '/sign_ups/confirmed'
+    follow_redirect!
     assert_redirected_to '/articles/secret'
     assert_equal 'Thanks for confirming your account.  You are now logged in.', flash[:notice]
     assert controller.logged_in?
@@ -101,6 +103,8 @@ class AccountConfirmationTest < IntegrationTest
 
     put extract_path_from_email
 
+    assert_redirected_to '/sign_ups/confirmed'
+    follow_redirect!
     assert_redirected_to '/articles/secret'
     assert_equal 'Thanks for confirming your account.  You are now logged in.', flash[:notice]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quo_vadis
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.1.10
 platform: ruby
 authors:
 - Andy Stewart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -148,6 +148,7 @@ files:
 - test/dummy/app/controllers/articles_controller.rb
 - test/dummy/app/controllers/sign_ups_controller.rb
 - test/dummy/app/controllers/users_controller.rb
+- test/dummy/app/mailers/application_mailer.rb
 - test/dummy/app/models/application_record.rb
 - test/dummy/app/models/article.rb
 - test/dummy/app/models/person.rb
@@ -224,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Multifactor authentication for Rails 6 and 7.