rodauth-select-account 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90895ef37a108c15a07ad95b7e7e834a792e495dfc6a5b00e95f5cba0e8f5641
-  data.tar.gz: e9e436f0e30f7a96e296c9ddb6059cfcf23ad4b1ea0a764d9345669cf82633a7
+  metadata.gz: 54558f068bac6c32c070a056d1b4ffbc6b86878fbbedd2b5b4561b97233a169e
+  data.tar.gz: ae04cf2fedd5df579a98969ad6ca2e8154e78a2451ebabf244fc0015a34c3ae9
 SHA512:
-  metadata.gz: 6f27e0dec0e492dfb2de6b50edb469d10a913702a86e823428b5db7e37e9bc01884cc7f8c9f36d81158fec1514f8953b74a07ea646c40b727c80f5cdd3b839da
-  data.tar.gz: 6e79144222edfd09428c7f679036a4306d9ee51a03cd9e40ce2892908066ab60f7f6c59cb06fd9625391bbfd189a68ed0d828bda4b9282f04ee12878be721ea1
+  metadata.gz: 82210732ab64e6ce8c418767daebd2e69833f224c068c594725c12f171eed0871f955079ebcfa6c93a35f7eeee7e49e779d293ad4fa6b45f66b0d6acf90bdd90
+  data.tar.gz: 14d2ec75e8f69e4e160e016d6b50a95f4697e05739e4edf9f74bcd5406dc3c3f274592afc6c036390a3596415116bd15490b358cd92a87842ea0ce98b58ffed7

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.1.3
+
+* allow setting `require_selected_account_cookie_interval` and `accounts_cookie_interval` to `nil` in order to set the managed cookies as "Session Cookies" (i.e. getting wiped out on browser close).
+
 ## 0.1.2
 
 point release to update project links in rubygems.

data/doc/select_account.rdoc

@@ -0,0 +1,47 @@
+= Documentation for Select Account
+
+The +select_account+ feature allows for maintaining and switching across multiple accounts in the same session.
+
+== Auth Value Methods
+
+selected_account_key :: session key where the selected account state is stored.
+accounts_key :: session key where the logged-in accounts state is stored.
+add_account_redirect_session_key :: session key where the url to redirect to after adding an account is stored.
+select_account_redirect_session_key :: session key where the url to redirect to after selecting an account is stored.
+require_selected_account_cookie_key :: cookie key storing whether a selected account is required.
+require_selected_account_cookie_interval :: duration for the require selected account cookie (5 minutes by default); can be set to <tt>nil</tt> in order not to set cookie "Expires".
+accounts_cookie_key :: cookie key where the selected accounts are stored.
+accounts_cookie_options :: cookie options for the selected accounts cookie
+accounts_cookie_interval :: duration for the selected accounts cookie (14 days by default); can be set to <tt>nil</tt> in order not to set cookie "Expires".
+no_account_error_status :: http status code for the response when the account to switch to does not exist anymore.
+select_account_required_error_status :: http status code for the response when a selected account is required.
+add_account_required_error_status :: http status code for the response when addig an account is required.
+no_account_message :: error description when no account was found, <tt>"could not select account"</tt> by default.
+
+
+add_account_button :: Label of add account button.
+add_account_error_flash :: The flash error message to display when there was an error adding an account.
+add_account_notice_flash :: The flash success message to display after adding an account.
+require_add_account_error_flash ::  he flash error message to display when adding an account is required.
+add_account_page_title :: Title for the Add Account form.
+add_account_redirect :: URL to redirect to after adding an account.
+add_account_route :: the route for adding an account, +add-account+ by default.
+
+select_account_error_flash :: The flash error message to display when there was an error selecting an account.
+select_account_notice_flash :: The flash success message to display after selecting an account.
+require_select_account_error_flash ::  he flash error message to display when selecting an account is required.
+select_account_page_title :: Title for the Select Account form.
+select_account_redirect :: URL to redirect to after selecting an account.
+select_account_route :: the route for selecting an account, +select-account+ by default.
+
+
+== Auth Methods
+
+add_account_view :: The HTML template of the Add Account form.
+before_add_account_route :: Run arbitrary code before the add account route.
+before_add_account :: Run arbitrary code before adding an account.
+after_add_account :: Run arbitrary code after adding an account.
+select_account_view :: The HTML template of the Select Account form.
+before_select_account_route :: Run arbitrary code before the add account route.
+before_select_account :: Run arbitrary code before selecting an account.
+after_select_account :: Run arbitrary code after selecting an account.

data/lib/rodauth/features/select_account.rb

@@ -62,7 +62,7 @@ module Rodauth
       end
 
       opts[:value] = true
-      opts[:expires] = Time.now + require_selected_account_cookie_interval
+      opts[:expires] = Time.now + require_selected_account_cookie_interval if require_selected_account_cookie_interval
       opts[:httponly] = true unless opts.key?(:httponly)
       opts[:secure] = true unless opts.key?(:secure) || !request.ssl?
 
@@ -177,7 +177,7 @@ module Rodauth
 
       opts = Hash[accounts_cookie_options]
       opts[:value] = accounts_cookie.join(",")
-      opts[:expires] = Time.now + accounts_cookie_interval
+      opts[:expires] = Time.now + accounts_cookie_interval if accounts_cookie_interval
       opts[:path] = "/" unless opts.key?(:path)
       opts[:httponly] = true unless opts.key?(:httponly)
       opts[:secure] = true unless opts.key?(:secure) || !request.ssl?

data/lib/rodauth/select-account/version.rb

@@ -2,6 +2,6 @@
 
 module Rodauth
   module SelectAccount
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-select-account
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -33,10 +33,12 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 - CHANGELOG.md
+- doc/select_account.rdoc
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- doc/select_account.rdoc
 - lib/rodauth/features/select_account.rb
 - lib/rodauth/select-account.rb
 - lib/rodauth/select-account/version.rb
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Multiple authenticated accounts per session in rodauth.