plutonium 0.5.0

data/lib/generators/pu/rodauth/migration/active_record/reset_password.erb

@@ -0,0 +1,8 @@
+# Used by the password reset feature
+create_table :<%= table_prefix %>_password_reset_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
+  t.foreign_key :<%= table_prefix.pluralize %>, column: :id
+  t.string :key, null: false
+  t.datetime :deadline, null: false
+  t.datetime :email_last_sent, null: false, default: -> { "<%= current_timestamp %>" }
+end

data/lib/generators/pu/rodauth/migration/active_record/separate_passwords.erb

@@ -0,0 +1,5 @@
+# Stores password hashes separate from the account table
+create_table :<%= table_prefix %>_password_hashes do |t|
+  t.references :<%= table_prefix %>, foreign_key: true<%= primary_key_type(:type) %>
+  t.string :password_hash, null: false
+end

data/lib/generators/pu/rodauth/migration/active_record/single_session.erb

@@ -0,0 +1,6 @@
+# Used by the single session feature
+create_table :<%= table_prefix %>_session_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
+  t.foreign_key :<%= table_prefix.pluralize %>, column: :id
+  t.string :key, null: false
+end

data/lib/generators/pu/rodauth/migration/active_record/sms_codes.erb

@@ -0,0 +1,9 @@
+# Used by the sms codes feature
+create_table :<%= table_prefix %>_sms_codes, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
+  t.foreign_key :<%= table_prefix.pluralize %>, column: :id
+  t.string :phone_number, null: false
+  t.integer :num_failures
+  t.string :code
+  t.datetime :code_issued_at, null: false, default: -> { "<%= current_timestamp %>" }
+end

data/lib/generators/pu/rodauth/migration/active_record/verify_account.erb

@@ -0,0 +1,8 @@
+# Used by the account verification feature
+create_table :<%= table_prefix %>_verification_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
+  t.foreign_key :<%= table_prefix.pluralize %>, column: :id
+  t.string :key, null: false
+  t.datetime :requested_at, null: false, default: -> { "<%= current_timestamp %>" }
+  t.datetime :email_last_sent, null: false, default: -> { "<%= current_timestamp %>" }
+end

data/lib/generators/pu/rodauth/migration/active_record/verify_login_change.erb

@@ -0,0 +1,8 @@
+# Used by the verify login change feature
+create_table :<%= table_prefix %>_login_change_keys, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
+  t.foreign_key :<%= table_prefix.pluralize %>, column: :id
+  t.string :key, null: false
+  t.string :login, null: false
+  t.datetime :deadline, null: false
+end

data/lib/generators/pu/rodauth/migration/active_record/webauthn.erb

@@ -0,0 +1,13 @@
+# Used by the webauthn feature
+create_table :<%= table_prefix %>_webauthn_user_ids, id: false do |t|
+  t.<%= primary_key_type(nil) %> :id, primary_key: true
+  t.foreign_key :<%= table_prefix.pluralize %>, column: :id
+  t.string :webauthn_id, null: false
+end
+create_table :<%= table_prefix %>_webauthn_keys, primary_key: [:<%= table_prefix %>_id, :webauthn_id] do |t|
+  t.references :<%= table_prefix %>, foreign_key: true<%= primary_key_type(:type) %>
+  t.string :webauthn_id
+  t.string :public_key, null: false
+  t.integer :sign_count, null: false
+  t.datetime :last_use, null: false, default: -> { "<%= current_timestamp %>" }
+end

data/lib/generators/pu/rodauth/migration/sequel/account_expiration.erb

@@ -0,0 +1,7 @@
+# Used by the account expiration feature
+create_table :<%= table_prefix %>_activity_times do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  DateTime :last_activity_at, null: false
+  DateTime :last_login_at, null: false
+  DateTime :expired_at
+end

data/lib/generators/pu/rodauth/migration/sequel/active_sessions.erb

@@ -0,0 +1,8 @@
+# Used by the active sessions feature
+create_table :<%= table_prefix %>_active_session_keys do
+  foreign_key :<%= table_prefix %>_id, :<%= table_prefix.pluralize %>, type: :Bignum
+  String :session_id
+  Time :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+  Time :last_use, null: false, default: Sequel::CURRENT_TIMESTAMP
+  primary_key [:<%= table_prefix %>_id, :session_id]
+end

data/lib/generators/pu/rodauth/migration/sequel/audit_logging.erb

@@ -0,0 +1,17 @@
+# Used by the audit logging feature
+create_table :<%= table_prefix %>_authentication_audit_logs do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= table_prefix.pluralize %>, null: false, type: :Bignum
+  DateTime :at, null: false, default: Sequel::CURRENT_TIMESTAMP
+  String :message, null: false
+<% case db.database_type -%>
+<% when :postgres -%>
+  jsonb :metadata
+<% when :sqlite, :mysql -%>
+  json :metadata
+<% else -%>
+  String :metadata
+<% end -%>
+  index [:<%= table_prefix %>_id, :at], name: :audit_<%= table_prefix %>_at_idx
+  index :at, name: :audit_at_idx
+end

data/lib/generators/pu/rodauth/migration/sequel/base.erb

@@ -0,0 +1,25 @@
+<% if db.database_type == :postgres -%>
+begin
+  run "CREATE EXTENSION IF NOT EXISTS citext"
+rescue NoMethodError # migration is being reverted
+end
+
+<% end -%>
+create_table :<%= table_prefix.pluralize %> do
+  primary_key :id, type: :Bignum
+<% if db.database_type == :postgres -%>
+  citext :email, null: false
+  constraint :valid_email, email: /^[^,;@ \r\n]+@[^,@; \r\n]+\.[^,@; \r\n]+$/
+<% else -%>
+  String :email, null: false
+<% end -%>
+  Integer :status, null: false, default: 1
+<% if db.supports_partial_indexes? -%>
+  index :email, unique: true, where: { status: [1, 2] }
+<% else -%>
+  index :email, unique: true
+<% end -%>
+<% unless separate_passwords? -%>
+  String :password_hash
+<% end -%>
+end

data/lib/generators/pu/rodauth/migration/sequel/disallow_password_reuse.erb

@@ -0,0 +1,6 @@
+# Used by the disallow password reuse feature
+create_table :<%= table_prefix %>_previous_password_hashes do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= table_prefix.pluralize %>, type: :Bignum
+  String :password_hash, null: false
+end

data/lib/generators/pu/rodauth/migration/sequel/email_auth.erb

@@ -0,0 +1,7 @@
+# Used by the email auth feature
+create_table :<%= table_prefix %>_email_auth_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, null: false
+  DateTime :email_last_sent, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/generators/pu/rodauth/migration/sequel/jwt_refresh.erb

@@ -0,0 +1,8 @@
+# Used by the jwt refresh feature
+create_table :<%= table_prefix %>_jwt_refresh_keys do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= table_prefix.pluralize %>, null: false, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, null: false
+  index :<%= table_prefix %>_id, name: :<%= table_prefix %>_jwt_rk_<%= table_prefix %>_id_idx
+end

data/lib/generators/pu/rodauth/migration/sequel/lockout.erb

@@ -0,0 +1,11 @@
+# Used by the lockout feature
+create_table :<%= table_prefix %>_login_failures do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  Integer :number, null: false, default: 1
+end
+create_table :<%= table_prefix %>_lockouts do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, null: false
+  DateTime :email_last_sent
+end

data/lib/generators/pu/rodauth/migration/sequel/otp.erb

@@ -0,0 +1,7 @@
+# Used by the otp feature
+create_table :<%= table_prefix %>_otp_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  Integer :num_failures, null: false, default: 0
+  Time :last_use, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/generators/pu/rodauth/migration/sequel/password_expiration.erb

@@ -0,0 +1,5 @@
+# Used by the password expiration feature
+create_table :<%= table_prefix %>_password_change_times do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  DateTime :changed_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/generators/pu/rodauth/migration/sequel/recovery_codes.erb

@@ -0,0 +1,6 @@
+# Used by the recovery codes feature
+create_table :<%= table_prefix %>_recovery_codes do
+  foreign_key :id, :<%= table_prefix.pluralize %>, type: :Bignum
+  String :code
+  primary_key [:id, :code]
+end

data/lib/generators/pu/rodauth/migration/sequel/remember.erb

@@ -0,0 +1,6 @@
+# Used by the remember me feature
+create_table :<%= table_prefix %>_remember_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, null: false
+end

data/lib/generators/pu/rodauth/migration/sequel/reset_password.erb

@@ -0,0 +1,7 @@
+# Used by the password reset feature
+create_table :<%= table_prefix %>_password_reset_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, null: false
+  DateTime :email_last_sent, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/generators/pu/rodauth/migration/sequel/separate_passwords.erb

@@ -0,0 +1,6 @@
+# Stores password hashes separate from the account table
+create_table :<%= table_prefix %>_password_hashes do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= table_prefix.pluralize %>, type: :Bignum
+  String :password_hash, null: false
+end

data/lib/generators/pu/rodauth/migration/sequel/single_session.erb

@@ -0,0 +1,5 @@
+# Used by the single session feature
+create_table :<%= table_prefix %>_session_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+end

data/lib/generators/pu/rodauth/migration/sequel/sms_codes.erb

@@ -0,0 +1,8 @@
+# Used by the sms codes feature
+create_table :<%= table_prefix %>_sms_codes do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :phone_number, null: false
+  Integer :num_failures
+  String :code
+  DateTime :code_issued_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/generators/pu/rodauth/migration/sequel/verify_account.erb

@@ -0,0 +1,7 @@
+# Used by the account verification feature
+create_table :<%= table_prefix %>_verification_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :requested_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+  DateTime :email_last_sent, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/generators/pu/rodauth/migration/sequel/verify_login_change.erb

@@ -0,0 +1,7 @@
+# Used by the verify login change feature
+create_table :<%= table_prefix %>_login_change_keys do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  String :login, null: false
+  DateTime :deadline, null: false
+end

data/lib/generators/pu/rodauth/migration/sequel/webauthn.erb

@@ -0,0 +1,13 @@
+# Used by the webauthn feature
+create_table :<%= table_prefix %>_webauthn_user_ids do
+  foreign_key :id, :<%= table_prefix.pluralize %>, primary_key: true, type: :Bignum
+  String :webauthn_id, null: false
+end
+create_table :<%= table_prefix %>_webauthn_keys do
+  foreign_key :<%= table_prefix %>_id, :<%= table_prefix.pluralize %>, type: :Bignum
+  String :webauthn_id
+  String :public_key, null: false
+  Integer :sign_count, null: false
+  Time :last_use, null: false, default: Sequel::CURRENT_TIMESTAMP
+  primary_key [:<%= table_prefix %>_id, :webauthn_id]
+end

data/lib/generators/pu/rodauth/migration_generator.rb

@@ -0,0 +1,190 @@
+return unless defined?(Rodauth::Rails)
+
+require "rails/generators/base"
+require "rails/generators/active_record/migration"
+require "erb"
+require "digest"
+
+require "#{__dir__}/concerns/configuration"
+require "#{__dir__}/concerns/account_selector"
+
+module Pu
+  module Rodauth
+    class MigrationGenerator < ::Rails::Generators::Base
+      include Concerns::Configuration
+      include Concerns::AccountSelector
+
+      source_root "#{__dir__}/templates"
+
+      desc "Generate migrations for supported features\n\n" \
+           "Supported Features\n" \
+           "=========================================\n" \
+           "#{MIGRATION_CONFIG.keys.sort.map(&:to_s).join "\n"}\n\n\n\n"
+
+      class_option :features, required: true, type: :array,
+        desc: "Rodauth features to create tables for (otp, sms_codes, single_session, account_expiration etc.)"
+
+      def validate_selected_features
+        if selected_features.empty?
+          say "No migration features specified!", :yellow
+          exit(1)
+        elsif (selected_features - valid_features).any?
+          say "No available migration for feature(s): #{(selected_features - valid_features).join(", ")}", :red
+          exit(1)
+        end
+      end
+
+      def create_rodauth_migration
+        migration_template "db/migrate/create_rodauth.rb", File.join(db_migrate_path, "#{migration_name}.rb")
+      end
+
+      def configure_rodauth_plugin_tables
+        in_root do
+          break unless table_prefix != "account" && File.exist?(plugin_filename)
+
+          gsub_file plugin_filename, /.*# accounts_table.*\n/, "" if selected_features.include? :base
+
+          migration_overrides.sort.reverse_each do |key, value|
+            override = indent "#{key} :#{value}\n", 4
+            insert_into_file plugin_filename, override,
+              after: /.*# Change prefix of table and.*\n/
+          end
+        end
+      end
+
+      def show_instructions
+        in_root do
+          break if table_prefix == "account" || File.exist?(plugin_filename)
+
+          configuration = migration_overrides
+            .map { |config, format| "#{config} :#{format}" }
+            .join("\n")
+            .indent(2)
+
+          say "\n\nAdd the following to your Rodauth plugin configure block:", :blue
+          say "\n\n#{configuration}\n\n\n\n", :magenta
+        end
+      end
+
+      private
+
+      def plugin_filename
+        "app/misc/#{table_prefix}_rodauth_plugin.rb"
+      end
+
+      def migration_name
+        @migration_name ||= begin
+          max_len = 150
+          migration_name = options[:migration_name] || ["create_rodauth", table_prefix, *selected_features].join("_")
+          if migration_name.length <= max_len
+            migration_name
+          else
+            [migration_name.first(max_len), Digest::SHA256.hexdigest(migration_name).first(10)].join("_")
+          end
+        end
+      end
+
+      def selected_features
+        @selected_features ||= begin
+          features = options[:features]
+          features.unshift "base" if features.delete "base"
+          features.map(&:to_sym)
+        end
+      end
+
+      def migration_overrides
+        @migration_overrides ||= migration_config.values_at(*selected_features)
+          .flat_map(&:to_a)
+          .filter { |config, format| config.ends_with? "_table" }
+          .map { |config, format| [config, (format % {plural: table_prefix.pluralize, singular: table_prefix})] }
+          .to_h
+          .compact
+      end
+
+      def migration_content
+        selected_features
+          .map { |feature| File.read(migration_chunk(feature)) }
+          .map { |content| erb_eval(content) }
+          .join("\n")
+          .indent(4)
+      end
+
+      def erb_eval(content)
+        ERB.new(content, trim_mode: "-").result(binding)
+      end
+
+      def separate_passwords?
+        selected_features.include? :separate_passwords
+      end
+
+      def migration_chunk(feature)
+        "#{MIGRATION_DIR}/#{feature}.erb"
+      end
+
+      def valid_features
+        Dir["#{MIGRATION_DIR}/*.erb"].map { |filename| File.basename(filename, ".erb").to_sym }
+      end
+
+      if defined?(::ActiveRecord::Railtie) # Active Record
+        include ::ActiveRecord::Generators::Migration
+
+        MIGRATION_DIR = "#{__dir__}/migration/active_record"
+
+        def activerecord_adapter
+          if ActiveRecord::Base.respond_to?(:connection_db_config)
+            ActiveRecord::Base.connection_db_config.adapter
+          else
+            ActiveRecord::Base.connection_config.fetch(:adapter)
+          end
+        end
+
+        def primary_key_type(key = :id)
+          generators = ::Rails.application.config.generators
+          column_type = generators.options[:active_record][:primary_key_type]
+
+          if key
+            ", #{key}: :#{column_type}" if column_type
+          else
+            column_type || default_primary_key_type
+          end
+        end
+
+        def default_primary_key_type
+          if ActiveRecord.version >= Gem::Version.new("5.1") && activerecord_adapter != "sqlite3"
+            :bigint
+          else
+            :integer
+          end
+        end
+
+        # Active Record 7+ sets default precision to 6 for timestamp columns,
+        # so we need to ensure we match this when setting the default value.
+        def current_timestamp
+          if ActiveRecord.version >= Gem::Version.new("7.0") && ["mysql2", "trilogy"].include?(activerecord_adapter) && ActiveRecord::Base.connection.supports_datetime_with_precision?
+            "CURRENT_TIMESTAMP(6)"
+          else
+            "CURRENT_TIMESTAMP"
+          end
+        end
+      else # Sequel
+        include ::Rails::Generators::Migration
+
+        MIGRATION_DIR = "#{__dir__}/migration/sequel"
+
+        def self.next_migration_number(dirname)
+          next_migration_number = current_migration_number(dirname) + 1
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), format("%.14d", next_migration_number)].max
+        end
+
+        def db_migrate_path
+          "db/migrate"
+        end
+
+        def db
+          db = ::Sequel::DATABASES.first if defined?(::Sequel)
+          db or fail Rodauth::Rails::Error, "missing Sequel database connection"
+        end
+      end
+    end
+  end
+end

data/lib/generators/pu/rodauth/templates/INSTRUCTIONS

@@ -0,0 +1,52 @@
+===============================================================================
+
+Depending on your application's configuration some manual setup may be required:
+
+  1. Ensure you have defined default url options in your environments files. Here
+     is an example of default_url_options appropriate for a development environment
+     in config/environments/development.rb:
+
+       config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+
+     In production, :host should be set to the actual host of your application.
+
+     * Required for all applications. *
+
+  2. Ensure you have defined root_url to *something* in your config/routes.rb.
+     For example:
+
+       root to: "home#index"
+
+     * Not required for API-only Applications *
+
+  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+     For example:
+
+       <% if notice %>
+         <div class="alert alert-success"><%= notice %></div>
+       <% end %>
+       <% if alert %>
+         <div class="alert alert-danger"><%= alert %></div>
+       <% end %>
+
+     * Not required for API-only Applications *
+
+  4. Titles for Rodauth pages are available via @page_title instance variable
+     by default, you can use it in your layout file:
+
+       <head>
+         <title><%= @page_title || "Default title" %></title>
+         ...
+       </head>
+
+    * Not required *
+
+  5. You can copy Rodauth views (for customization) to your app by running:
+
+       rails g rodauth:views # default bootstrap views
+
+       rails g rodauth:views --css=tailwind # tailwind views (requires @tailwindcss/forms plugin)
+
+      * Not required *
+
+===============================================================================

data/lib/generators/pu/rodauth/templates/app/controllers/plugin_controller.rb.tt

@@ -0,0 +1,6 @@
+module Rodauth
+  class <%= table_prefix.classify %>Controller < RodauthController
+    # used by Rodauth for rendering views, CSRF protection, and running any
+    # registered action callbacks and rescue_from handlers
+  end
+end

data/lib/generators/pu/rodauth/templates/app/controllers/rodauth_controller.rb.tt

@@ -0,0 +1,3 @@
+class RodauthController < ApplicationController
+  # Base rodauth controller
+end

data/lib/generators/pu/rodauth/templates/app/mailers/account_mailer.rb.tt

@@ -0,0 +1,4 @@
+module Rodauth
+  class <%= table_prefix.classify %>Mailer < RodauthMailer
+  end
+end

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

@@ -0,0 +1,62 @@
+class RodauthMailer < ApplicationMailer
+  default to: -> { @rodauth.email_to }
+
+  def verify_account(name, account_id, key)
+    @rodauth = rodauth(name, account_id) { @verify_account_key_value = key }
+    @account = @rodauth.rails_account
+
+    mail subject: @rodauth.email_subject_prefix + @rodauth.verify_account_email_subject
+  end
+
+  def reset_password(name, account_id, key)
+    @rodauth = rodauth(name, account_id) { @reset_password_key_value = key }
+    @account = @rodauth.rails_account
+
+    mail subject: @rodauth.email_subject_prefix + @rodauth.reset_password_email_subject
+  end
+
+  def verify_login_change(name, account_id, key)
+    @rodauth = rodauth(name, account_id) { @verify_login_change_key_value = key }
+    @account = @rodauth.rails_account
+    @new_email = @account.login_change_key.login
+
+    mail to: @new_email, subject: @rodauth.email_subject_prefix + @rodauth.verify_login_change_email_subject
+  end
+
+  def change_password_notify(name, account_id)
+    @rodauth = rodauth(name, account_id)
+    @account = @rodauth.rails_account
+
+    mail subject: @rodauth.email_subject_prefix + @rodauth.password_changed_email_subject
+  end
+
+  def reset_password_notify(name, account_id)
+    @rodauth = rodauth(name, account_id)
+    @account = @rodauth.rails_account
+
+    mail subject: @rodauth.email_subject_prefix + @rodauth.reset_password_notify_email_subject
+  end
+
+  def email_auth(name, account_id, key)
+    @rodauth = rodauth(name, account_id) { @email_auth_key_value = key }
+    @account = @rodauth.rails_account
+
+    mail subject: @rodauth.email_subject_prefix + @rodauth.email_auth_email_subject
+  end
+
+  def unlock_account(name, account_id, key)
+    @rodauth = rodauth(name, account_id) { @unlock_account_key_value = key }
+    @account = @rodauth.rails_account
+
+    mail subject: @rodauth.email_subject_prefix + @rodauth.unlock_account_email_subject
+  end
+
+  private
+
+  def rodauth(name, account_id, &block)
+    instance = RodauthApp.rodauth(name).allocate
+    instance.instance_eval { @account = account_ds(account_id).first! }
+    instance.instance_eval(&block) if block
+    instance
+  end
+end