rodauth-rails 1.5.0 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43e0f2c048024645cb8af7e744042187ded20eeca3f685bdf28a959aebf296e0
-  data.tar.gz: 96d02ad057f315a339bc1cda804f71e19cd629a9cb2ca5c574c515d954692673
+  metadata.gz: c63496f359a15bb061b6b419a609cbe63c24991e156731721d9f077ecf9deac4
+  data.tar.gz: 68212d9c722391c8c79f8bf8c48f8a05a39410ea0d97396876a6c2f5e92f103a
 SHA512:
-  metadata.gz: c943289cb0c628b37d89fcc6e2a0b22b190ba0e0c0351ffc53c726ac81b0c9f87b0b6e1f929a823724fa1aed70c5b5601279b24df5b54026cb06bb073c3b284c
-  data.tar.gz: afb5b6523b6c440c9b02255b047cf562dd0122a6abb8d49f7c93671981c75935d6a1a9ab1c27a9e8158578a928b70b3705db24760db803acd79abafa58cdc4ce
+  metadata.gz: 3632843dbd0214b73fa23134a0f2b42ec3b8f1c33430af1c776c685956ccf50e475840993299bff9863491456a369ad42b7e688e3ed03b783e51f4585d6be621
+  data.tar.gz: 6c123e024a51d3c2ba6b224b64c1f21d3b46363523d5b498e93fbe659052489660a61a3dd83da5080a07067d9052a82450da17a7bf156e9c905b2aa81ca861f6

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## 1.5.4 (2022-07-21)
+
+* Generate account fixtures in `spec/fixtures` directory when using RSpec (@benkoshy)
+
+* Generate account fixtures in `test/fixtures` directory instead of `app/test/fixtures` (@benkoshy)
+
+* Use string status column values in generated accounts fixture (@janko)
+
+* Create integer status column in generated Sequel migration (@janko)
+
+* Store password hash in accounts table in generated Sequel migration (@janko)
+
+## 1.5.3 (2022-07-21)
+
+*Yanked*
+
+## 1.5.2 (2022-07-03)
+
+* Bump Rodauth dependency version to 2.25+ (@janko)
+
+* Generate fixture file for accounts on `rodauth:install` (@benkoshy)
+
+* Fix error about undefined `controller_path` method in `newrelic_rpm` gem instrumentation (@janko)
+
+* Don't display disabled routes in `rodauth:routes` (@janko)
+
+* Display HTTP verbs of endpoints in `rodauth:routes` rake task (@janko)
+
+## 1.5.1 (2022-06-19)
+
+* Fix syntax for creating `citext` PG extension in Sequel base migration (@Empact)
+
 ## 1.5.0 (2022-06-11)
 
 * Remove `content_for` calls from generated view templates (@janko)

data/README.md

@@ -14,6 +14,7 @@ Provides Rails integration for the [Rodauth] authentication framework.
 🎥 Screencasts:
 
 * [Rails Authentication with Rodauth](https://www.youtube.com/watch?v=2hDpNikacf0)
+* [Multifactor Authentication via TOTP with Rodauth](https://www.youtube.com/watch?v=9ON-kgXpz2A)
 
 📚 Articles:
 
@@ -66,7 +67,7 @@ Next, run the install generator:
 $ rails generate rodauth:install
 ```
 
-Or if you want Rodauth endpoints to be exposed via JSON API:
+Or if you want Rodauth endpoints to be exposed via [JSON API]:
 
 ```sh
 $ rails generate rodauth:install --json # regular authentication using the Rails session
@@ -110,18 +111,18 @@ $ 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
+  GET/POST  /login                   rodauth.login_path
+  GET/POST  /create-account          rodauth.create_account_path
+  GET/POST  /verify-account-resend   rodauth.verify_account_resend_path
+  GET/POST  /verify-account          rodauth.verify_account_path
+  GET/POST  /change-password         rodauth.change_password_path
+  GET/POST  /change-login            rodauth.change_login_path
+  GET/POST  /logout                  rodauth.logout_path
+  GET/POST  /remember                rodauth.remember_path
+  GET/POST  /reset-password-request  rodauth.reset_password_request_path
+  GET/POST  /reset-password          rodauth.reset_password_path
+  GET/POST  /verify-login-change     rodauth.verify_login_change_path
+  GET/POST  /close-account           rodauth.close_account_path
 ```
 
 Using this information, you can add some basic authentication links to your
@@ -381,6 +382,7 @@ class RodauthController < ApplicationController
     when rodauth.login_path,
          rodauth.create_account_path,
          rodauth.verify_account_path,
+         rodauth.verify_account_resend_path,
          rodauth.reset_password_path,
          rodauth.reset_password_request_path
       "authentication"
@@ -1214,3 +1216,4 @@ conduct](https://github.com/janko/rodauth-rails/blob/master/CODE_OF_CONDUCT.md).
 [custom mailer worker]: https://github.com/janko/rodauth-rails/wiki/Custom-Mailer-Worker
 [Turbo]: https://turbo.hotwired.dev/
 [rodauth-model]: https://github.com/janko/rodauth-model
+[JSON API]: https://github.com/janko/rodauth-rails/wiki/JSON-API

data/lib/generators/rodauth/install_generator.rb

@@ -70,6 +70,17 @@ module Rodauth
           end
         end
 
+        def create_fixtures
+          test_unit_options = ::Rails.application.config.generators.options[:test_unit]
+          if test_unit_options[:fixture] && test_unit_options[:fixture_replacement].nil?
+            if ::Rails.application.config.generators.options[:rails][:test_framework] == :rspec
+              template "test/fixtures/accounts.yml", "spec/fixtures/accounts.yml"
+            else
+              template "test/fixtures/accounts.yml", "test/fixtures/accounts.yml"
+            end
+          end
+        end
+
         def show_instructions
           readme "INSTRUCTIONS" if behavior == :invoke
         end

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

@@ -1,5 +1,8 @@
 <% if db.database_type == :postgres -%>
-enable_extension "citext"
+begin
+  run "CREATE EXTENSION IF NOT EXISTS citext"
+rescue NoMethodError # migration is being reverted
+end
 
 <% end -%>
 create_table :accounts do
@@ -10,16 +13,11 @@ create_table :accounts do
 <% else -%>
   String :email, null: false
 <% end -%>
-  String :status, null: false, default: "unverified"
+  Integer :status, null: false, default: 1
 <% if db.supports_partial_indexes? -%>
-  index :email, unique: true, where: { status: ["unverified", "verified"] }
+  index :email, unique: true, where: { status: [1, 2] }
 <% else -%>
   index :email, unique: true
 <% end -%>
-end
-
-# Used if storing password hashes in a separate table (default)
-create_table :account_password_hashes do
-  foreign_key :id, :accounts, primary_key: true, type: :Bignum
-  String :password_hash, null: false
+  String :password_hash
 end

data/lib/generators/rodauth/templates/test/fixtures/accounts.yml

@@ -0,0 +1,10 @@
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+one:
+  email: freddie@queen.com
+  password_hash: <%%= BCrypt::Password.create("password", cost: BCrypt::Engine::MIN_COST) %>
+  status: verified
+
+two:
+  email: brian@queen.com
+  password_hash: <%%= BCrypt::Password.create("password", cost: BCrypt::Engine::MIN_COST) %>
+  status: verified

data/lib/rodauth/rails/app.rb

@@ -59,6 +59,12 @@ module Rodauth
         rodauth(name) or fail ArgumentError, "unknown rodauth configuration: #{name.inspect}"
       end
 
+      # The newrelic_rpm gem expects this when we pass the roda class as
+      # :controller in instrumentation payload.
+      def self.controller_path
+        name.underscore
+      end
+
       module RequestMethods
         def rodauth(name = nil)
           prefix = scope.rodauth(name).prefix

data/lib/rodauth/rails/feature/instrumentation.rb

@@ -32,7 +32,7 @@ module Rodauth
           request = rails_request
 
           raw_payload = {
-            controller: scope.class.superclass.name,
+            controller: self.class.roda_class.name,
             action: "call",
             request: request,
             params: request.filtered_parameters,

data/lib/rodauth/rails/tasks.rake

@@ -6,20 +6,34 @@ namespace :rodauth do
 
     app.opts[:rodauths].each do |configuration_name, auth_class|
       rodauth = auth_class.allocate
+      only_json = rodauth.method(:only_json?).owner != Rodauth::Base && rodauth.only_json?
+
+      routes = auth_class.route_hash.map do |path, handle_method|
+        file_path, start_line = rodauth.method(:"_#{handle_method}").source_location
+        lines = File.foreach(file_path).to_a
+        indentation = lines[start_line - 1][/^\s+/]
+        verbs = []
+
+        lines[start_line..-1].each do |code|
+          verbs << :GET if code.include?("r.get") && !only_json
+          verbs << :POST if code.include?("r.post")
+          break if code.start_with?("#{indentation}end")
+        end
 
-      routes = auth_class.routes.map do |handle_method|
         path_method = "#{handle_method.to_s.sub(/\Ahandle_/, "")}_path"
 
         [
-          rodauth.public_send(path_method),
+          verbs.join("/"),
+          "#{rodauth.prefix}#{path}",
           "rodauth#{configuration_name && "(:#{configuration_name})"}.#{path_method}",
         ]
       end
 
-      padding = routes.map { |path, _| path.length }.max
+      verbs_padding = routes.map { |verbs, _, _| verbs.length }.max
+      path_padding = routes.map { |_, path, _| path.length }.max
 
-      route_lines = routes.map do |path, code|
-        "#{path.ljust(padding)}  #{code}"
+      route_lines = routes.map do |verbs, path, code|
+        "#{verbs.ljust(verbs_padding)}  #{path.ljust(path_padding)}  #{code}"
       end
 
       puts "\n  #{route_lines.join("\n  ")}" unless route_lines.empty?

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "1.5.0"
+    VERSION = "1.5.4"
   end
 end

data/rodauth-rails.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 4.2", "< 8"
-  spec.add_dependency "rodauth", "~> 2.23"
+  spec.add_dependency "rodauth", "~> 2.25"
   spec.add_dependency "roda", "~> 3.55"
   spec.add_dependency "sequel-activerecord_connection", "~> 1.1"
   spec.add_dependency "rodauth-model", "~> 0.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.4
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-11 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.25'
 - !ruby/object:Gem::Dependency
   name: roda
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +271,7 @@ files:
 - lib/generators/rodauth/templates/config/initializers/rodauth.rb
 - lib/generators/rodauth/templates/config/initializers/sequel.rb
 - lib/generators/rodauth/templates/db/migrate/create_rodauth.rb
+- lib/generators/rodauth/templates/test/fixtures/accounts.yml
 - lib/generators/rodauth/views_generator.rb
 - lib/rodauth-rails.rb
 - lib/rodauth/rails.rb