rodauth 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cc814306a88708a5ade63bfa8288521db20517fdac543217e86a084e8e189f
-  data.tar.gz: ebd02824ee15ede1c58a5ca93c092d2372e953790f7535d0889521bc95b9dfd3
+  metadata.gz: 453992f6df1e1a41e30923334f53146ddd575015f57960dcdadb2b3d4bc496e9
+  data.tar.gz: 29172b14c9a5c6d88e36c827c4fbc9e4f61fbadadf6b656734ef7058e9dd4a13
 SHA512:
-  metadata.gz: 435b51b083c4509626c0699c2298c641134b132e0c08fae0c738823f4230d35d2a714761b7afdb2c9a48bb7c025e653a2bce84ae88b07f21a2bd5b494b52e6cc
-  data.tar.gz: 179b131a07064033a1c934360578f8b7a8703421133179255078063d9bde7621f9865c3bb00f51dceb313255e4d685804ba2f1a0ba2d109198f660802d6eda61
+  metadata.gz: 956d8809e6ba87044e5aeba7712cc4e907604a632d7113084cda074bf675952fb4e3081cca5adf19a191df6d073e2b9068a313d8d26e81534b70f9eaba20688e
+  data.tar.gz: aaa0cde299ba115ea281bc18dfe5f02a0d2b35dd95231d9e69662ec340194569a288be916abb2fe0e258c50599c6ea6ef42791824f986d6dc2e295f5db67645a

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 2.12.0 (2021-04-22)
+
+* Add configuration methods to active_sessions plugin to control the inserting and updating of rows (janko) (#159)
+
 === 2.11.0 (2021-03-22)
 
 * Add same_as_current_login_message and contains_null_byte_message configuration methods to increase translatability (dmitryzuev) (#158)

data/doc/active_sessions.rdoc

@@ -37,9 +37,13 @@ inactive_session_error_status :: The error status to use when a JSON request is
 session_id_session_key :: The session key name to use for storing the session id.
 session_inactivity_deadline :: The number of seconds since last use after which the session will be considered expired (1 day by default).  Can be set to nil to not check session inactivity.
 session_lifetime_deadline :: The number of seconds since session creation after which the session will be considered expired (30 days by default).   Can be set to nil to not check session lifetimes.
+update_current_session? :: Whether the update current session with +active_sessions_update_hash+. By default returns true if +session_inactivity_deadline+ is set.
 
 == Auth Methods
 
+active_sessions_insert_hash :: The hash to insert into the +active_sessions_table+.
+active_sessions_key :: The active session key for the current account.
+active_sessions_update_hash :: The hash to update the currently active session when +update_current_session?+ is true. By default updates last use to current time.
 add_active_session :: Create a session id for the session and populate the session and add the session id to the database.
 currently_active_session? :: Whether the session is currently active, by checking the database table.
 handle_duplicate_active_session_id(exception) :: How to handle the case where a duplicate session id for the account is inserted into the table.  Does nothing by default.  This should only be called if the random number generator is broken.

data/doc/release_notes/2.11.0.txt

@@ -23,7 +23,7 @@
   block.  Previously, you could only call configuration methods in
   the block that added the feature, and enabling a feature in a
   block that was already enabled in a previous block did not allow
-  the use of configuraton methods related to the feature.
+  the use of configuration methods related to the feature.
 
 * Passing a block when loading the rodauth plugin is now optional.
 

data/doc/release_notes/2.12.0.txt

@@ -0,0 +1,17 @@
+= New Features
+
+* The following configuration methods have been added to the
+  active_sessions feature:
+
+  * active_sessions_insert_hash
+  * active_sessions_key
+  * active_sessions_update_hash
+  * update_current_session?
+
+  These methods allow you to control what gets inserted and
+  updated into the active_sessions_table, and to control
+  whether to perform updates.
+
+= Other Improvements
+
+* A typo was fixed in the default unlock account email.

data/lib/rodauth/features/active_sessions.rb

@@ -19,7 +19,12 @@ module Rodauth
     auth_value_method :session_inactivity_deadline, 86400
     auth_value_method(:session_lifetime_deadline, 86400*30)
 
+    auth_value_methods :update_current_session?
+
     auth_methods(
+      :active_sessions_insert_hash,
+      :active_sessions_key,
+      :active_sessions_update_hash,
       :add_active_session,
       :currently_active_session?,
       :handle_duplicate_active_session_id,
@@ -36,8 +41,8 @@ module Rodauth
       ds = active_sessions_ds.
         where(active_sessions_session_id_column => compute_hmac(session_id))
 
-      if session_inactivity_deadline
-        ds.update(active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP) == 1
+      if update_current_session?
+        ds.update(active_sessions_update_hash) == 1
       else
         ds.count == 1
       end
@@ -57,11 +62,9 @@ module Rodauth
     end
 
     def add_active_session
-      key = random_key
+      key = generate_active_sessions_key
       set_session_value(session_id_session_key, key)
-      if e = raises_uniqueness_violation? do
-          active_sessions_ds.insert(active_sessions_account_id_column => session_value, active_sessions_session_id_column => compute_hmac(key))
-        end
+      if e = raises_uniqueness_violation?{active_sessions_ds.insert(active_sessions_insert_hash)}
         handle_duplicate_active_session_id(e)
       end
       nil
@@ -104,7 +107,7 @@ module Rodauth
     def after_refresh_token
       super if defined?(super)
       if prev_key = session[session_id_session_key]
-        key = random_key
+        key = generate_active_sessions_key
         set_session_value(session_id_session_key, key)
         active_sessions_ds.
           where(active_sessions_session_id_column => compute_hmac(prev_key)).
@@ -126,6 +129,20 @@ module Rodauth
       super
     end
 
+    attr_reader :active_sessions_key
+
+    def generate_active_sessions_key
+      @active_sessions_key = random_key
+    end
+
+    def active_sessions_insert_hash
+      {active_sessions_account_id_column => session_value, active_sessions_session_id_column => compute_hmac(active_sessions_key)}
+    end
+
+    def active_sessions_update_hash
+      {active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP}
+    end
+
     def session_inactivity_deadline_condition
       if deadline = session_inactivity_deadline
         Sequel[active_sessions_last_use_column] < Sequel.date_sub(Sequel::CURRENT_TIMESTAMP, seconds: deadline)
@@ -145,6 +162,10 @@ module Rodauth
       Sequel.|(*[cond, cond2].compact)
     end
 
+    def update_current_session?
+      !!session_inactivity_deadline
+    end
+
     def active_sessions_ds
       db[active_sessions_table].
         where(active_sessions_account_id_column=>session_value)

data/lib/rodauth/version.rb

@@ -6,7 +6,7 @@ module Rodauth
   MAJOR = 2
 
   # The minor version of Rodauth, updated for new feature releases of Rodauth.
-  MINOR = 11
+  MINOR = 12
 
   # The patch version of Rodauth, updated only for bug fixes from the last
   # feature release.

data/templates/unlock-account-email.str

@@ -1,4 +1,4 @@
-Someone has requested a that the account with this email be unlocked.
+Someone has requested that the account with this email be unlocked.
 If you did not request the unlocking of this account, please ignore this
 message.  If you requested the unlocking of this account, please go to
 #{rodauth.unlock_account_email_link} 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -322,6 +322,7 @@ extra_rdoc_files:
 - doc/release_notes/2.1.0.txt
 - doc/release_notes/2.10.0.txt
 - doc/release_notes/2.11.0.txt
+- doc/release_notes/2.12.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
@@ -415,6 +416,7 @@ files:
 - doc/release_notes/2.1.0.txt
 - doc/release_notes/2.10.0.txt
 - doc/release_notes/2.11.0.txt
+- doc/release_notes/2.12.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
@@ -568,7 +570,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Authentication and Account Management Framework for Rack Applications