rodauth-select-account 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9496ecf9a3647c6371feef06b8cb81403ff9c076012650f740778f246b66180e
-  data.tar.gz: aeb014bfa0376f53fc34bc4fe7870fc4ac23b080da8b8ce11457c3ca43404765
+  metadata.gz: e1268790cfe1720860c39c93bced3253c0cb1bf83dacec424d21cf7facd2f0a3
+  data.tar.gz: d161bade62b8e1b935fb192ebec45d3641b546b4cf52896cccc3f225a01450ca
 SHA512:
-  metadata.gz: ea5fb45c7bf98c22827756fc9c5b0f684f7a76be9843a1f0a46d0d4088f2f4957161b562b1c4c1fb91ff952e4783f6cde6cdccd456401fb51281a25486e9d317
-  data.tar.gz: 66e79a5a50fc9df83aa63228b8079df3cbee160e56f23c05e84efbb2201c9c1400c48e7eabd9c788d602946aa15e3aa8f215c6519601a9ceb6cfcf9d8c8e2b7b
+  metadata.gz: cd003394cba3aaad1c103ffae1dd008cea6e3788cb9cd96636074021854891a20d2c9d43f83351ba938cd78b923fab171de7d31609d32638a18a0c2202b139d0
+  data.tar.gz: c489337600b4e06912ecf4e650dcf4b58b2ad69524d9acbe6cbe45df6ab8a1c75faa8b23481456eac12b6d4d42fb19779f2b22934e2ac175a84db597b61a687a

data/CHANGELOG.md

@@ -1,3 +1,25 @@
 # CHANGELOG
 
 ## master
+
+## 0.1.0
+
+Support for internationalization (I18n) by hooking up with [rodauth-i18n](https://github.com/janko/rodauth-i18n). Shipping translation for english under `locales/` dir.
+
+## 0.0.4
+
+Cookies used for selected account are now secure by default (httponly on, secure if request is TLS-enabled);
+
+Cookie path is now "/" by default.
+
+## 0.0.3
+
+bugfix: fixing calls to the view helpers when in multi-phase login mode.
+
+## 0.0.2
+
+bugfix: added missing form templates.
+
+## 0.0.1
+
+Initial draft, all features added.

data/README.md

@@ -110,7 +110,7 @@ The following options and methods are also available to override, and names shou
 * `add_account_redirect`
 * `select_account_notice_flash`
 * `select_account_error_flash`
-* `require_select_account_error_flash
+* `require_select_account_error_flash`
 * `before_select_account_route`
 * `before_select_account`
 * `after_select_account`
@@ -125,9 +125,17 @@ These are also available methods:
 * `accounts_in_session`: returns all the available accounts in session
 * `require_select_account`: to be used like `require_account`, as a filter to actions that require a user to explicitly select an account before allowing it.
 
+#### Internationalization (i18n)
+
+`rodauth-select-account` supports translating all user-facing text found in all pages and forms and buttons, by integrating with [rodauth-i18n](https://github.com/janko/rodauth-i18n). Just set it up in your application and `rodauth` configuration.
+
+Default translations shipping with `rodauth-select-account` can be found [in this directory](https://gitlab.com/honeyryderchuck/rodauth-select-account/-/tree/master/locales). If they're not available for the languages you'd like to support, consider getting them translated from the english text, and contributing them to this repository via a Merge Request.
+
+(This feature is available since `v0.1`.)
+
 ## Ruby support policy
 
-The minimum Ruby version required to run `rodauth-select-account` is 2.4 . Besides that, it should support all rubies that rodauth and roda support, including JRuby and (potentially, I don't know yet) truffleruby.
+The minimum Ruby version required to run `rodauth-select-account` is 2.4 . Besides that, it supports all rubies that rodauth and roda support, including JRuby and truffleruby.
 
 ## Development
 
@@ -136,4 +144,3 @@ After checking out the repo, run `bundle install` to install dependencies. Then,
 ## Contributing
 
 Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/honeyryderchuck/rodauth-select-account.
-

data/lib/rodauth/features/select_account.rb

@@ -54,15 +54,18 @@ module Rodauth
     def require_select_account
       # whether an account has been selected for a certain workflow will be driven by a short-lived
       # cookie, which will hopefully be active during the duration of account selection
+      opts = Hash[accounts_cookie_options]
+      opts[:path] = "/" unless opts.key?(:path)
       if request.cookies[require_selected_account_cookie_key]
-        ::Rack::Utils.delete_cookie_header!(response.headers, require_selected_account_cookie_key)
+        ::Rack::Utils.delete_cookie_header!(response.headers, require_selected_account_cookie_key, opts)
         return
       end
 
-      opts = {
-        value: true,
-        expires: Time.now + require_selected_account_cookie_interval
-      }
+      opts[:value] = true
+      opts[:expires] = Time.now + require_selected_account_cookie_interval
+      opts[:httponly] = true unless opts.key?(:httponly)
+      opts[:secure] = true unless opts.key?(:secure) || !request.ssl?
+
       ::Rack::Utils.set_cookie_header!(response.headers, require_selected_account_cookie_key, opts)
 
       # should redirect to the accounts page, and set this as the page to return to
@@ -170,6 +173,9 @@ module Rodauth
       opts = Hash[accounts_cookie_options]
       opts[:value] = accounts_cookie.join(",")
       opts[:expires] = Time.now + 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?
       ::Rack::Utils.set_cookie_header!(response.headers, accounts_cookie_key, opts)
     end
 
@@ -229,7 +235,7 @@ module Rodauth
       r.post do
         # This is a copy of the login routine
         skip_error_flash = false
-        view = :add_account
+        view = :add_account_view
 
         catch_error do
           # this instruction will load the new account
@@ -268,7 +274,7 @@ module Rodauth
         end
 
         set_error_flash add_account_error_flash unless skip_error_flash
-        send("#{view}_view")
+        send(view)
       end
     end
   end

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

@@ -2,6 +2,6 @@
 
 module Rodauth
   module SelectAccount
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/rodauth/select-account.rb

@@ -3,3 +3,5 @@
 require "rodauth"
 
 require "rodauth/select-account/version"
+
+Rodauth::I18n.directories << File.expand_path(File.join(__dir__, "..", "..", "locales")) if defined?(Rodauth::I18n)

data/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  rodauth:
+    add_account_notice_flash: "You have added a new account"
+    add_account_error_flash: "There was an error adding the new account"
+    require_add_account_error_flash: "Please add account to continue"
+    add_account_page_title: "Add Account"
+    add_account_button: "Add Account"
+    select_account_notice_flash: "You have selected an account"
+    select_account_error_flash: "There was an error selecting the account"
+    require_select_account_error_flash: "Please select account to continue"
+    select_account_page_title: "Select Account"
+    no_account_message: "could not select account"

data/templates/add-account-form.str

@@ -0,0 +1,6 @@
+<form method="post" class="rodauth" role="form" id="add-account-form">
+  #{rodauth.csrf_tag}
+  #{rodauth.skip_login_field_on_login? ? rodauth.render('login-display') : rodauth.render('login-field')}
+  #{rodauth.render('password-field') unless rodauth.skip_password_field_on_login?}
+  #{rodauth.button(rodauth.add_account_button)}
+</form>

data/templates/add-account.str

@@ -0,0 +1,3 @@
+#{rodauth.login_form_header}
+#{rodauth.render('add-account-form')}
+#{rodauth.login_form_footer}

data/templates/select-account.str

@@ -0,0 +1,17 @@
+<div class="list-group">
+#{
+rodauth.accounts_in_session.map do |account| 
+  next if account[rodauth.account_id_column] == rodauth.session_value
+
+  <<-OUT
+    <form method="post" class="rodauth" role="form" id="select-account-form">
+      #{rodauth.csrf_tag}
+      <input type="hidden" name="#{rodauth.login_param}" value="#{account[rodauth.login_column]}" />
+      <button type="submit" class="list-group-item list-group-item-action">
+        #{account[rodauth.login_column]}
+      </button>
+    </form>
+  OUT
+end.join
+}
+</div>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-select-account
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
-dependencies: []
+date: 2021-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rodauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Multiple authenticated accounts per session in rodauth.
 email:
 - cardoso_tiago@hotmail.com
@@ -26,6 +40,10 @@ files:
 - lib/rodauth/features/select_account.rb
 - lib/rodauth/select-account.rb
 - lib/rodauth/select-account/version.rb
+- locales/en.yml
+- templates/add-account-form.str
+- templates/add-account.str
+- templates/select-account.str
 homepage: https://gitlab.com/honeyryderchuck/rodauth-select-account
 licenses: []
 metadata:
@@ -47,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Multiple authenticated accounts per session in rodauth.