rodauth-model 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59bbf27ffd624fa72ce609fcb9968118bf358e3e3f10893db7d0d73abf356d12
-  data.tar.gz: 2c286827b98cef9f1d593f740375ae2f74c759dee7dd2d7c954380a03659ecd4
+  metadata.gz: aea9e15f1d5a320dba7b2e4cb959b9c8c4358146ac04a09c1bfb2e719a0fb826
+  data.tar.gz: 5765f24048e014d3cefd3b46bd82d08cdcc98ff0c2d362865fa2e6f17597b3f2
 SHA512:
-  metadata.gz: a8ef44bd93fc5cdb4fabaf58544bcf3ddc7ab8084a6a38b73777cb26163fe0ad8ded45978975cf4423b8f44b97e1c49dc9d3d01f6ca7aac71f06d120a7bebf5b
-  data.tar.gz: 9d8067365baec855fed3ad8f2db189d8842e3244b2867ca6b67413715ddd15465aa7f5db1d416f80e4925df2b226f7edda80e68cd40a83a0697e7a1cfe669644
+  metadata.gz: 3cfe79f030285164d1f3fc36fb1be09a3ca067b282b633870af1a17b341fc9be836d1a93d983dbf211f8e78d9416cc0fd808465470b5256e8e4f9a1b31ed03e0
+  data.tar.gz: e6ce5e3c754233554c95609405e512ebcf53ce3a608701bc93ebadd63b9aca994404a25feda89669cf20082d9215710d4d6dcf8d958cff4faa82b4227ff00082

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.4.0 (2024-12-16)
+
+* Add `password?` model method that returns whether a password is set (@janko)
+
+* Drop support for Ruby 2.3 and 2.4 (@janko)
+
+## 0.3.0 (2024-10-12)
+
+* Add support for OTP Unlock feature (@janko)
+
 ## 0.2.1 (2022-10-26)
 
 * Fix `elsif` warning in sequel code (@janko)

data/README.md

@@ -27,14 +27,6 @@ class Account < ActiveRecord::Base # Sequel::Model
 end
 ```
 
-If you have multiple Rodauth configurations, pass the one for which you want associations to be defined.
-
-```rb
-class Account < ActiveRecord::Base # Sequel::Model
-  include Rodauth::Model(RodauthApp.rodauth(:admin))
-end
-```
-
 ### Password attribute
 
 Regardless of whether you're storing the password hash in a column in the accounts table, or in a separate table, the `#password` attribute can be used to set or clear the password hash.
@@ -49,8 +41,12 @@ account.password_hash #=> "$2a$12$k/Ub1I2iomi84RacqY89Hu4.M0vK7klRnRtzorDyvOkVI.
 account.password_hash #=> #<Account::PasswordHash...> (record from `account_password_hashes` table)
 account.password_hash.password_hash #=> "$2a$12$k/Ub1..." (inaccessible when using database authentication functions)
 
+# whether a password is set
+account.password? #=> true
+
 account.password = nil # clears password hash
 account.password_hash #=> nil
+account.password? #=> false
 ```
 
 Note that the password attribute doesn't come with validations, making it unsuitable for forms. It was primarily intended to allow easily creating accounts in development console and in tests.
@@ -91,6 +87,20 @@ Rodauth::Model(RodauthApp.rodauth, association_options: -> (name) {
 })
 ```
 
+### Extending models
+
+When using Zeitwerk autoloading, extending an associated model in a separate file won't work, because Zeitwerk has no reason to load it, since the constant was already defined. You can work around this by extending the model in the parent file:
+
+```rb
+class Account < ActiveRecord::Base
+  include Rodauth::Model(RodauthApp.rodauth) # defines associated models
+
+  class ActiveSessionKey < ActiveRecord::Base
+    # extend the model
+  end
+end
+```
+
 ## Association reference
 
 Below is a list of all associations defined depending on the features loaded:
@@ -106,6 +116,7 @@ Below is a list of all associations defined depending on the features loaded:
 | lockout                 | `:lockout`                   | `has_one`  | `Lockout`                | `account_lockouts`                  |
 | lockout                 | `:login_failure`             | `has_one`  | `LoginFailure`           | `account_login_failures`            |
 | otp                     | `:otp_key`                   | `has_one`  | `OtpKey`                 | `account_otp_keys`                  |
+| otp_unlock              | `:otp_unlock`                | `has_one`  | `OtpUnlock`              | `account_otp_unlocks`               |
 | password_expiration     | `:password_change_time`      | `has_one`  | `PasswordChangeTime`     | `account_password_change_times`     |
 | recovery_codes          | `:recovery_codes`            | `has_many` | `RecoveryCode`           | `account_recovery_codes`            |
 | remember                | `:remember_key`              | `has_one`  | `RememberKey`            | `account_remember_keys`             |
@@ -117,7 +128,8 @@ Below is a list of all associations defined depending on the features loaded:
 | webauthn                | `:webauthn_keys`             | `has_many` | `WebauthnKey`            | `account_webauthn_keys`             |
 | webauthn                | `:webauthn_user_id`          | `has_one`  | `WebauthnUserId`         | `account_webauthn_user_ids`         |
 
-Note that some Rodauth tables use composite primary keys, which Active Record doesn't support out of the box. For associations to work properly in Active Record, you might need to add the [composite_primary_keys] gem to your Gemfile. On Sequel, associations will work without any changes, because Sequel supports composite primary keys.
+> [!NOTE]
+> Some Rodauth tables use composite primary keys, which are supported in Active Record 7.1+. If you're on an older version of Active Record, you might need to add the [composite_primary_keys] gem to your Gemfile. Sequel has always natively supported composite primary keys.
 
 ## Extending associations
 
@@ -131,11 +143,11 @@ module Rodauth
     auth_value_method :foo_id_column, :id
     # ...
   end
+end
 
-  if defined?(Model)
-    Model.register_association(:foo) do
-      { name: :foo, type: :one, table: foo_table, key: foo_id_column }
-    end
+if defined?(Rodauth::Model)
+  Rodauth::Model.register_association(:foo) do
+    { name: :foo, type: :one, table: foo_table, key: foo_id_column }
   end
 end
 ```

data/lib/rodauth/model/active_record.rb

@@ -16,7 +16,7 @@ module Rodauth
 
         define_method(:password=) do |password|
           @password = password
-          password_hash = rodauth.send(:password_hash, password) if password
+          password_hash = rodauth.password_hash(password) if password
           set_password_hash(password_hash)
         end
 
@@ -32,6 +32,14 @@ module Rodauth
             end
           end
         end
+
+        define_method(:password?) do
+          if rodauth.account_password_hash_column
+            !!public_send(rodauth.account_password_hash_column)
+          else
+            !!password_hash
+          end
+        end
       end
 
       def define_associations(model)

data/lib/rodauth/model/associations.rb

@@ -46,6 +46,9 @@ module Rodauth
   Model.register_association(:otp) do
     { name: :otp_key, type: :one, table: otp_keys_table, key: otp_keys_id_column }
   end
+  Model.register_association(:otp_unlock) do
+    { name: :otp_unlock, type: :one, table: otp_unlock_table, key: otp_unlock_id_column }
+  end
   Model.register_association(:sms_codes) do
     { name: :sms_code, type: :one, table: sms_codes_table, key: sms_id_column }
   end

data/lib/rodauth/model/sequel.rb

@@ -23,7 +23,7 @@ module Rodauth
 
         define_method(:password=) do |password|
           @password = password
-          password_hash = rodauth.send(:password_hash, password) if password
+          password_hash = rodauth.password_hash(password) if password
           set_password_hash(password_hash)
         end
 
@@ -42,6 +42,14 @@ module Rodauth
             self.password_hash_attributes = attributes
           end
         end
+
+        define_method(:password?) do
+          if rodauth.account_password_hash_column
+            !!public_send(rodauth.account_password_hash_column)
+          else
+            !!password_hash
+          end
+        end
       end
 
       def define_associations(model)

data/rodauth-model.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-model"
-  spec.version       = "0.2.1"
+  spec.version       = "0.4.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko@hey.com"]
 
@@ -10,19 +10,19 @@ Gem::Specification.new do |spec|
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/janko/rodauth-model"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = ">= 2.5"
 
   spec.metadata["source_code_uri"] = "https://github.com/janko/rodauth-model"
 
   spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*", "*.gemspec"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rodauth", "~> 2.0"
+  spec.add_dependency "rodauth", "~> 2.28"
 
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-hooks"
   spec.add_development_dependency "bcrypt"
-  spec.add_development_dependency "jwt"
+  spec.add_development_dependency "jwt", "< 2.10"
   spec.add_development_dependency "rotp"
   spec.add_development_dependency "rqrcode"
   spec.add_development_dependency "webauthn" unless RUBY_ENGINE == "jruby"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-model
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Janko Marohnić
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.28'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.28'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +69,16 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: rotp
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +143,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/janko/rodauth-model
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,15 +150,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides model mixin for Active Record and Sequel that defines password attribute
   and associations based on Rodauth configuration.