rodauth-rails 0.9.1 → 0.14.0

data/lib/generators/rodauth/install_generator.rb

@@ -10,6 +10,15 @@ module Rodauth
         include ::ActiveRecord::Generators::Migration
         include MigrationHelpers
 
+        MAILER_VIEWS = %w[
+          email_auth
+          password_changed
+          reset_password
+          unlock_account
+          verify_account
+          verify_login_change
+        ]
+
         source_root "#{__dir__}/templates"
         namespace "rodauth:install"
 
@@ -47,6 +56,14 @@ module Rodauth
           template "app/models/account.rb"
         end
 
+        def create_mailer
+          template "app/mailers/rodauth_mailer.rb"
+
+          MAILER_VIEWS.each do |view|
+            template "app/views/rodauth_mailer/#{view}.text.erb"
+          end
+        end
+
         private
 
         def sequel_uri_scheme

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

@@ -2,10 +2,10 @@ class RodauthApp < Rodauth::Rails::App
   configure do
     # List of authentication features that are loaded.
     enable :create_account, :verify_account, :verify_account_grace_period,
-      :login, :logout<%= ", :remember" unless jwt? %>,
+      :login, :logout<%= ", :remember" unless jwt? %><%= ", :json" if json? %><%= ", :jwt" if jwt? %>,
       :reset_password, :change_password, :change_password_notify,
       :change_login, :verify_login_change,
-      :close_account<%= ", :json" if json? %><%= ", :jwt" if jwt? %>
+      :close_account
 
     # See the Rodauth documentation for the list of available config options:
     # http://rodauth.jeremyevans.net/documentation.html
@@ -23,6 +23,10 @@ class RodauthApp < Rodauth::Rails::App
 
     # Accept only JSON requests.
     only_json? true
+
+    # Handle login and password confirmation fields on the client side.
+    # require_password_confirmation? false
+    # require_login_confirmation? false
 <% end -%>
 
     # Specify the controller used for view rendering and CSRF verification.
@@ -54,35 +58,29 @@ class RodauthApp < Rodauth::Rails::App
     # already_logged_in { redirect login_redirect }
 
     # ==> Emails
-    # Uncomment the lines below once you've imported mailer views.
-    # create_reset_password_email do
-    #   RodauthMailer.reset_password(email_to, reset_password_email_link)
-    # end
-    # create_verify_account_email do
-    #   RodauthMailer.verify_account(email_to, verify_account_email_link)
-    # end
-    # 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
-    # create_password_changed_email do
-    #   RodauthMailer.password_changed(email_to)
+    # Use a custom mailer for delivering authentication emails.
+    create_reset_password_email do
+      RodauthMailer.reset_password(email_to, reset_password_email_link)
+    end
+    create_verify_account_email do
+      RodauthMailer.verify_account(email_to, verify_account_email_link)
+    end
+    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
+    create_password_changed_email do
+      RodauthMailer.password_changed(email_to)
+    end
+    # create_email_auth_email do
+    #   RodauthMailer.email_auth(email_to, email_auth_email_link)
     # end
-    # # create_email_auth_email do
-    # #   RodauthMailer.email_auth(email_to, email_auth_email_link)
-    # # end
-    # # create_unlock_account_email do
-    # #   RodauthMailer.unlock_account(email_to, unlock_account_email_link)
-    # # end
-    # send_email do |email|
-    #   # queue email delivery on the mailer after the transaction commits
-    #   db.after_commit { email.deliver_later }
+    # create_unlock_account_email do
+    #   RodauthMailer.unlock_account(email_to, unlock_account_email_link)
     # end
-
-    # In the meantime, you can tweak settings for emails created by Rodauth.
-    # email_subject_prefix "[MyApp] "
-    # email_from "noreply@myapp.com"
-    # send_email(&:deliver_later)
-    # reset_password_email_body { "Click here to reset your password: #{reset_password_email_link}" }
+    send_email do |email|
+      # queue email delivery on the mailer after the transaction commits
+      db.after_commit { email.deliver_later }
+    end
 
     # ==> Flash
 <% unless json? || jwt? -%>
@@ -151,14 +149,25 @@ class RodauthApp < Rodauth::Rails::App
     # verify_account_grace_period 3.days
     # reset_password_deadline_interval Hash[hours: 6]
     # verify_login_change_deadline_interval Hash[days: 2]
+<% unless jwt? -%>
     # remember_deadline_interval Hash[days: 30]
+<% end -%>
   end
 
   # ==> Multiple configurations
   # configure(:admin) do
-  #   enable :http_basic_auth # enable different set of features
+  #   # ... enable features ...
   #   prefix "/admin"
   #   session_key_prefix "admin_"
+  #   # remember_cookie_key "_admin_remember" # if using remember feature
+  #
+  #   # search views in `app/views/admin/rodauth` directory
+  #   rails_controller { Admin::RodauthController }
+  #
+  #   # use separate tables (requires creating the new tables)
+  #   methods.grep(/_table$/) do |table_method|
+  #     public_send(table_method) { :"admin_#{super()}" }
+  #   end
   # end
 
   route do |r|
@@ -187,6 +196,8 @@ class RodauthApp < Rodauth::Rails::App
     #   unless rodauth(:admin).logged_in?
     #     rodauth(:admin).require_http_basic_auth
     #   end
+    #
+    #   r.pass # allow the Rails app to handle other "/admin/*" requests
     # end
   end
 end

data/lib/generators/rodauth/templates/app/mailers/rodauth_mailer.rb

@@ -1,4 +1,4 @@
-class <%= options[:name].camelize %>Mailer < ApplicationMailer
+class RodauthMailer < ApplicationMailer
   def verify_account(recipient, email_link)
     @email_link = email_link
 
@@ -25,13 +25,13 @@ class <%= options[:name].camelize %>Mailer < ApplicationMailer
 
   # def email_auth(recipient, email_link)
   #   @email_link = email_link
-
+  #
   #   mail to: recipient
   # end
 
   # def unlock_account(recipient, email_link)
   #   @email_link = email_link
-
+  #
   #   mail to: recipient
   # end
 end

data/lib/generators/rodauth/templates/app/views/rodauth/_email_auth_request_form.html.erb

@@ -1,4 +1,4 @@
-<%%= form_tag rodauth.email_auth_request_path, method: :post do %>
+<%%= form_tag <%= rodauth %>.email_auth_request_path, method: :post do %>
   <%%= render "login_hidden_field" %>
   <%%= render "submit", value: "Send Login Link Via Email" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/_field.html.erb

@@ -4,7 +4,7 @@
   autocomplete: local_assigns[:autocomplete],
   inputmode: local_assigns[:inputmode],
   required: local_assigns[:required] != false,
-  class: "#{local_assigns[:class] || "form-control"} #{"is-invalid" if rodauth.field_error(name)}",
-  aria: ({ invalid: "true", describedby: "#{name}_error_message" } if rodauth.field_error(name)) %>
+  class: "#{local_assigns[:class] || "form-control"} #{"is-invalid" if <%= rodauth %>.field_error(name)}",
+  aria: ({ invalid: "true", describedby: "#{name}_error_message" } if <%= rodauth %>.field_error(name)) %>
 
 <%%= render "field_error", name: name unless local_assigns[:skip_error_message] %>

data/lib/generators/rodauth/templates/app/views/rodauth/_field_error.html.erb

@@ -1,3 +1,3 @@
-<%% if rodauth.field_error(name) %>
-  <div class="invalid-feedback" id="<%%= name %>_error_message"><%%= rodauth.field_error(name) %></div>
+<%% if <%= rodauth %>.field_error(name) %>
+  <div class="invalid-feedback" id="<%%= name %>_error_message"><%%= <%= rodauth %>.field_error(name) %></div>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/_global_logout_field.html.erb

@@ -1,6 +1,6 @@
-<div class="form-group">
+<div class="form-group mb-3">
   <div class="form-check">
-    <%%= check_box_tag rodauth.global_logout_param, "t", false, id: "global-logout", class: "form-check-input" %>
+    <%%= check_box_tag <%= rodauth %>.global_logout_param, "t", false, id: "global-logout", class: "form-check-input" %>
     <%%= label_tag "global-logout", "Logout all Logged In Sessons?", class: "form-check-label" %>
   </div>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_confirm_field.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "login-confirm", "Confirm Login" %>
-  <%%= render "field", name: rodauth.login_confirm_param, id: "login-confirm", type: :email, autocomplete: "email" %>
+<div class="form-group mb-3">
+  <%%= label_tag "login-confirm", "Confirm Login", class: "form-label" %>
+  <%%= render "field", name: <%= rodauth %>.login_confirm_param, id: "login-confirm", type: :email, autocomplete: "email" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_display.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "login", "Login" %>
-  <%%= email_field_tag rodauth.login_param, params[rodauth.login_param], id: "login", readonly: true, class: "form-control-plaintext" %>
+<div class="form-group mb-3">
+  <%%= label_tag "login", "Login", class: "form-label" %>
+  <%%= email_field_tag <%= rodauth %>.login_param, params[<%= rodauth %>.login_param], id: "login", readonly: true, class: "form-control-plaintext" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_field.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "login", "Login" %>
-  <%%= render "field", name: rodauth.login_param, id: "login", type: :email, autocomplete: "email" %>
+<div class="form-group mb-3">
+  <%%= label_tag "login", "Login", class: "form-label" %>
+  <%%= render "field", name: <%= rodauth %>.login_param, id: "login", type: :email, autocomplete: "email" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_form.html.erb

@@ -1,9 +1,9 @@
-<%%= form_tag rodauth.login_path, method: :post do %>
-  <%% if rodauth.skip_login_field_on_login? %>
+<%%= form_tag <%= rodauth %>.login_path, method: :post do %>
+  <%% if <%= rodauth %>.skip_login_field_on_login? %>
     <%%= render "login_display" %>
   <%% else %>
     <%%= render "login_field" %>
   <%% end %>
-  <%%= render "password_field" unless rodauth.skip_password_field_on_login? %>
+  <%%= render "password_field" unless <%= rodauth %>.skip_password_field_on_login? %>
   <%%= render "submit", value: "Login" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_form_footer.html.erb

@@ -1,7 +1,7 @@
-<%% unless rodauth.login_form_footer_links.empty? %>
+<%% unless <%= rodauth %>.login_form_footer_links.empty? %>
   <h2>Other Options</h2>
   <ul>
-    <%% rodauth.login_form_footer_links.sort.each do |_, link, text| %>
+    <%% <%= rodauth %>.login_form_footer_links.sort.each do |_, link, text| %>
       <li><%%= link_to text, link %></li>
     <%% end %>
   </ul>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_form_header.html.erb

@@ -1,3 +1,3 @@
-<%% if rodauth.field_error("password") && rodauth.features.include?(:reset_password) %>
-  <%%= render template: "<%= options[:directory] %>/reset_password_request", layout: false %>
+<%% if <%= rodauth %>.field_error("password") && <%= rodauth %>.features.include?(:reset_password) %>
+  <%%= render template: "<%= directory %>/reset_password_request", layout: false %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/_login_hidden_field.html.erb

@@ -1 +1 @@
-<%%= hidden_field_tag rodauth.login_param, params[rodauth.login_param] %>
+<%%= hidden_field_tag <%= rodauth %>.login_param, params[<%= rodauth %>.login_param] %>

data/lib/generators/rodauth/templates/app/views/rodauth/_new_password_field.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "new-password", "New Password" %>
-  <%%= render "field", name: rodauth.new_password_param, id: "new-password", type: "password", value: "", autocomplete: "new-password" %>
+<div class="form-group mb-3">
+  <%%= label_tag "new-password", "New Password", class: "form-label" %>
+  <%%= render "field", name: <%= rodauth %>.new_password_param, id: "new-password", type: "password", value: "", autocomplete: "new-password" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_otp_auth_code_field.html.erb

@@ -1,8 +1,8 @@
-<div class="form-group">
-  <%%= label_tag "otp-auth-code", "Authentication Code" %>
+<div class="form-group mb-3">
+  <%%= label_tag "otp-auth-code", "Authentication Code", class: "form-label" %>
   <div class="row">
     <div class="col-sm-3">
-      <%%= render "field", name: rodauth.otp_auth_param, id: "otp-auth-code", value: "", autocomplete: "off", inputmode: "numeric" %>
+      <%%= render "field", name: <%= rodauth %>.otp_auth_param, id: "otp-auth-code", value: "", autocomplete: "off", inputmode: "numeric" %>
     </div>
   </div>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_password_confirm_field.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "password-confirm", "Confirm Password" %>
-  <%%= render "field", name: rodauth.password_confirm_param, id: "password-confirm", type: :password, value: "", autocomplete: "new-password" %>
+<div class="form-group mb-3">
+  <%%= label_tag "password-confirm", "Confirm Password", class: "form-label" %>
+  <%%= render "field", name: <%= rodauth %>.password_confirm_param, id: "password-confirm", type: :password, value: "", autocomplete: "new-password" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_password_field.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "password", "Password" %>
-  <%%= render "field", name: rodauth.password_param, id: "password", type: :password, value: "", autocomplete: rodauth.password_field_autocomplete_value %>
+<div class="form-group mb-3">
+  <%%= label_tag "password", "Password", class: "form-label" %>
+  <%%= render "field", name: <%= rodauth %>.password_param, id: "password", type: :password, value: "", autocomplete: <%= rodauth %>.password_field_autocomplete_value %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_recovery_code_field.html.erb

@@ -1,4 +1,4 @@
-<div class="form-group">
-  <%%= label_tag "recovery_code", "Recovery Code" %>
-  <%%= render "field", name: rodauth.recovery_codes_param, id: "recovery_code", value: "", autocomplete: "off" %>
+<div class="form-group mb-3">
+  <%%= label_tag "recovery_code", "Recovery Code", class: "form-label" %>
+  <%%= render "field", name: <%= rodauth %>.recovery_codes_param, id: "recovery_code", value: "", autocomplete: "off" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_recovery_codes_form.html.erb

@@ -1,6 +1,6 @@
-<%%= form_tag rodauth.recovery_codes_path, method: :post do %>
-  <%%= render "password_field" if rodauth.two_factor_modifications_require_password? %>
+<%%= form_tag <%= rodauth %>.recovery_codes_path, method: :post do %>
+  <%%= render "password_field" if <%= rodauth %>.two_factor_modifications_require_password? %>
   <%%= render "submit",
-    value: rodauth.recovery_codes_button || "View Authentication Recovery Codes",
-    name: (rodauth.add_recovery_codes_param if rodauth.recovery_codes_button) %>
+    value: <%= rodauth %>.recovery_codes_button || "View Authentication Recovery Codes",
+    name: (<%= rodauth %>.add_recovery_codes_param if <%= rodauth %>.recovery_codes_button) %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/_sms_code_field.html.erb

@@ -1,8 +1,8 @@
-<div class="form-group">
-  <%%= label_tag "sms-code", "SMS Code" %>
+<div class="form-group mb-3">
+  <%%= label_tag "sms-code", "SMS Code", class: "form-label" %>
   <div class="row">
     <div class="col-sm-3">
-      <%%= render "field", name: rodauth.sms_code_param, id: "sms-code", value: "", autocomplete: "one-time-code", inputmode: "numeric" %>
+      <%%= render "field", name: <%= rodauth %>.sms_code_param, id: "sms-code", value: "", autocomplete: "one-time-code", inputmode: "numeric" %>
     </div>
   </div>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_sms_phone_field.html.erb

@@ -1,8 +1,8 @@
-<div class="form-group">
-  <%%= label_tag "sms-phone", "Phone Number" %>
+<div class="form-group mb-3">
+  <%%= label_tag "sms-phone", "Phone Number", class: "form-label" %>
   <div class="row">
     <div class="col-sm-3">
-      <%%= render "field", name: rodauth.sms_phone_param, id: "sms-phone", type: :tel, autocomplete: "tel" %>
+      <%%= render "field", name: <%= rodauth %>.sms_phone_param, id: "sms-phone", type: :tel, autocomplete: "tel" %>
     </div>
   </div>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/_submit.html.erb

@@ -1,3 +1,3 @@
-<div class="form-group">
+<div class="form-group mb-3">
   <%%= submit_tag local_assigns[:value], name: local_assigns[:name], class: local_assigns[:class] || "btn btn-primary" %>
 </div>

data/lib/generators/rodauth/templates/app/views/rodauth/add_recovery_codes.html.erb

@@ -1,6 +1,6 @@
-<pre id="recovery-codes"><%%= rodauth.recovery_codes.map { |s| h(s) }.join("\n\n") %></pre>
+<pre id="recovery-codes"><%%= <%= rodauth %>.recovery_codes.map { |s| h(s) }.join("\n\n") %></pre>
 
-<%% if rodauth.can_add_recovery_codes? %>
+<%% if <%= rodauth %>.can_add_recovery_codes? %>
   <h2>Add Additional Recovery Codes</h2>
   <%%= render "recovery_codes_form" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/change_login.html.erb

@@ -1,6 +1,6 @@
-<%%= form_tag rodauth.change_login_path, method: :post do %>
+<%%= form_tag <%= rodauth %>.change_login_path, method: :post do %>
   <%%= render "login_field" %>
-  <%%= render "login_confirm_field" if rodauth.require_login_confirmation? %>
-  <%%= render "password_field" if rodauth.change_login_requires_password? %>
+  <%%= render "login_confirm_field" if <%= rodauth %>.require_login_confirmation? %>
+  <%%= render "password_field" if <%= rodauth %>.change_login_requires_password? %>
   <%%= render "submit", value: "Change Login" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/change_password.html.erb

@@ -1,6 +1,6 @@
-<%%= form_tag rodauth.change_password_path, method: :post do %>
-  <%%= render "password_field" if rodauth.change_password_requires_password? %>
+<%%= form_tag <%= rodauth %>.change_password_path, method: :post do %>
+  <%%= render "password_field" if <%= rodauth %>.change_password_requires_password? %>
   <%%= render "new_password_field" %>
-  <%%= render "password_confirm_field" if rodauth.require_password_confirmation? %>
+  <%%= render "password_confirm_field" if <%= rodauth %>.require_password_confirmation? %>
   <%%= render "submit", value: "Change Password" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/close_account.html.erb

@@ -1,4 +1,4 @@
-<%%= form_tag rodauth.close_account_path, method: :post do %>
-  <%%= render "password_field" if rodauth.close_account_requires_password? %>
+<%%= form_tag <%= rodauth %>.close_account_path, method: :post do %>
+  <%%= render "password_field" if <%= rodauth %>.close_account_requires_password? %>
   <%%= render "submit", value: "Close Account", class: "btn btn-danger" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/confirm_password.html.erb

@@ -1,4 +1,4 @@
-<%%= form_tag rodauth.confirm_password_path, method: :post do %>
+<%%= form_tag <%= rodauth %>.confirm_password_path, method: :post do %>
   <%%= render "password_field" %>
   <%%= render "submit", value: "Confirm Password" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/create_account.html.erb

@@ -1,7 +1,7 @@
-<%%= form_tag rodauth.create_account_path, method: :post do %>
+<%%= form_tag <%= rodauth %>.create_account_path, method: :post do %>
   <%%= render "login_field" %>
-  <%%= render "login_confirm_field" if rodauth.require_login_confirmation? %>
-  <%%= render "password_field" if rodauth.create_account_set_password? %>
-  <%%= render "password_confirm_field" if rodauth.create_account_set_password? && rodauth.require_password_confirmation? %>
+  <%%= render "login_confirm_field" if <%= rodauth %>.require_login_confirmation? %>
+  <%%= render "password_field" if <%= rodauth %>.create_account_set_password? %>
+  <%%= render "password_confirm_field" if <%= rodauth %>.create_account_set_password? && <%= rodauth %>.require_password_confirmation? %>
   <%%= render "submit", value: "Create Account" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/email_auth.html.erb

@@ -1,3 +1,3 @@
-<%%= form_tag rodauth.email_auth_path, method: :post do %>
+<%%= form_tag <%= rodauth %>.email_auth_path, method: :post do %>
   <%%= render "submit", value: "Login" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/logout.html.erb

@@ -1,4 +1,4 @@
-<%%= form_tag rodauth.logout_path, method: :post do %>
-  <%%= render "global_logout_field" if rodauth.features.include?(:active_sessions) %>
+<%%= form_tag <%= rodauth %>.logout_path, method: :post do %>
+  <%%= render "global_logout_field" if <%= rodauth %>.features.include?(:active_sessions) %>
   <%%= render "submit", value: "Logout", class: "btn btn-warning" %>
 <%% end %>

data/lib/generators/rodauth/templates/app/views/rodauth/multi_phase_login.html.erb

@@ -1,3 +1,3 @@
 <%%= render "login_form_header" %>
-<%%= rodauth.render_multi_phase_login_forms.html_safe %>
+<%%= <%= rodauth %>.render_multi_phase_login_forms.html_safe %>
 <%%= render "login_form_footer" %>