brevio-session 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cba1f34cb1c21a2b40226dd174a9de1a9263fa0a30365e9621fc181baffb98d0
-  data.tar.gz: 4bafca01227c5ed4704d3cfdba571c4a063939203876860c8dadac46a125ba4f
+  metadata.gz: 7047e1a58ab4d8ece1f39bf73cc37ef0a4c3165da08ab14aa5a8faeb1390f3a5
+  data.tar.gz: 7f26b113da04eeb3bdd80f32335e34463f8c2adc02dd82ffbf8d7d20fd4fe8fa
 SHA512:
-  metadata.gz: 8173f7928ce6e54c1f0bfeec4a5b76bd4088c5fb1ef5622b8b17a076689da5e709e16d31f0b24867ad8ce805d5304b81bcaf00b0d09d82b6d03f1924c4edc3d8
-  data.tar.gz: 452279a03c727a0ccb0bacf0acd302c7699f2873e5c1851893e58cfb3cb4751426244d4c0ccc54ff0ff1790840fdc368a0667c2c75fb397615505cb9fa9aae5b
+  metadata.gz: 6d2e276acc65d46467c83645a708083cad3baf72a462db39319ccdb34bddb9b31686238a9344bcab4a721a0a77aed318d64eb7dec49978bf9c00557ce95af842
+  data.tar.gz: 46a43dae2ab5e18601dabec3b68952141610d31b1788780c8c4726eabd7e6f39bf14a8b61b2c5c2bf871a39a9414f6689e33b57385a05611a3e2f6a29eac5ad1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brevio-session (0.1)
+    brevio-session (0.2.1)
       actionpack (~> 7.0.3)
       redis (~> 5.0)
       zeitwerk (~> 2.6.7)
@@ -9,63 +9,63 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.4)
-      actionview (= 7.0.4)
-      activesupport (= 7.0.4)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.4)
-      activesupport (= 7.0.4)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.4)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    connection_pool (2.4.0)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crass (1.0.6)
     debug (1.5.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
-    erubi (1.11.0)
-    i18n (1.12.0)
+    erubi (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     io-console (0.6.0)
     irb (1.6.1)
       reline (>= 0.3.0)
     json (2.6.2)
-    loofah (2.19.0)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mini_portile2 (2.8.1)
-    minitest (5.16.3)
-    nokogiri (1.13.9)
-      mini_portile2 (~> 2.8.0)
+      nokogiri (>= 1.12.0)
+    minitest (5.20.0)
+    nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    racc (1.6.1)
-    rack (2.2.4)
-    rack-test (2.0.2)
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
     rainbow (3.1.1)
-    redis (5.0.6)
+    redis (5.0.7)
       redis-client (>= 0.9.0)
-    redis-client (0.14.1)
+    redis-client (0.17.0)
       connection_pool
     regexp_parser (2.5.0)
     reline (0.3.2)
@@ -84,10 +84,10 @@ GEM
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21

data/brevio-session.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'brevio-session'
-  spec.version       = '0.1.1'
+  spec.version       = '0.2.1'
   spec.authors       = ['Brevio AS']
   spec.email         = ['support@brevio.com']
   spec.files = `git ls-files -z`.split("\0")
 
   spec.homepage               = 'https://github.com/team-brevio/brevio-session'
   spec.summary                = 'Brevio session wrapper'
-  spec.required_ruby_version  = '3.2'
+  spec.required_ruby_version  = '~> 3.2'
   spec.description            = 'Wrapper around HTTP session set by Brevio ID'
   spec.license                = 'MIT'
 

data/lib/brevio/session/testing.rb

@@ -26,6 +26,22 @@ module Brevio::Session
       set_cookie(redis_key)
     end
 
+    def brevio_login_new_user(user_brevio_id, audit_company:)
+      redis_key = SecureRandom.hex(6)
+
+      session_hash = { user_id: user_brevio_id,
+                       audit_company_id: audit_company.brevio_id,
+                       user_stamp: Time.current.yesterday }
+
+      Testing.config.logger.info "setting Brevio session to #{session_hash}"
+
+      Testing.config.gem_config.redis.set(
+        redis_key,
+        session_hash
+      )
+      set_cookie(redis_key)
+    end
+
     def brevio_logout
       cookies[Testing.config.gem_config.session_cookie] = nil
     end

data/lib/brevio/session/with_session_login.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Brevio::Session
+  module WithSessionLogin
+    extend ActiveSupport::Concern
+
+    # By including this module into a Rails controller you will have access to the convenience methods
+    # fetch_brevio_session(!) and brevio_logged_in? which acts as a wrapper around the decrypting of
+    # predefined session cookies and sessions stored in Redis.
+    #
+    # We also require access to instance attributes like #request and the cookie jar, which are only
+    # available in the context of a controller.
+    #
+    included do
+      unless self <= ActionController::Base || instance_methods.include?(:session)
+        raise 'Included Brevio::Session outside of controller'
+      end
+    end
+
+    # Fetches the Brevio session from Redis, based on the encrypted key stored in the client's cookie.
+    # Returns *nil* if there's no session present.
+    #
+    def fetch_brevio_session
+      brevio_session, redis_key = fetch_session
+      return nil if brevio_session.nil?
+      if brevio_config.debug?
+        brevio_config.logger.info "[brevio-session] Found session #{brevio_session.inspect}"
+      end
+      refresh_session(redis_key) unless params.transform_keys(&:underscore)[:no_session].present?
+      brevio_session
+    rescue RuntimeError => e
+      brevio_config.logger.error "[brevio-session] #{e.message}"
+      nil
+    end
+
+    # Calls the above function, but raises an exception if the session isn't present.
+    def fetch_brevio_session!
+      brevio_session, redis_key = fetch_session
+      raise NilSession, 'Brevio session was nil' if brevio_session.nil?
+      refresh_session(redis_key) unless params.transform_keys(&:underscore)[:no_session].present?
+      brevio_session
+    end
+
+    # Returns a boolean flag indicating whether the current client has a Brevio session cookie set,
+    # and whether this cookie contains a user ID.
+    #
+    def brevio_logged_in?
+      brevio_session, = fetch_session
+      brevio_session&.dig(:user_id).present?
+    end
+
+    private
+
+    def brevio_config
+      Config.config
+    end
+
+    def fetch_session
+      brevio_config.logger.info '[brevio-session] Fetching Brevio session'
+      cookie = request.cookie_jar[brevio_config.session_cookie]
+      redis_key = Cookies::Parse.perform!(cookie)
+      brevio_session = Redis.get(redis_key)
+      raise NilSession if brevio_session.nil?
+      [brevio_session.with_indifferent_access, redis_key]
+    rescue RuntimeError => e
+      brevio_config.logger.error "[brevio-session] --- 💣 Couldn't fetch Brevio session 💣 ---"
+      brevio_config.logger.error "[brevio-session] #{e.message}"
+      nil
+    end
+
+    # Refreshes the Brevio session cookie, avoding its expiry. This is helpful to
+    # ensure the user stays logged in through interacting with the application.
+    #
+    def refresh_session(redis_key)
+      brevio_config.logger.info '[brevio-session] Refreshing Brevio session' if brevio_config.debug?
+      cookies[brevio_config.session_cookie] = {
+        value: request.cookie_jar[brevio_config.session_cookie],
+        domain: :all,
+        expires: brevio_config.session_expire,
+        httponly: true,
+        secure: true
+      }
+      Redis.expire(redis_key, brevio_config.session_expire)
+    rescue RuntimeError => e
+      brevio_config.logger.error "[brevio-session] --- 💣 Couldn't refresh Brevio session 💣 ---"
+      brevio_config.logger.error "[brevio-session] #{e.message}"
+    end
+
+  end
+end

data/lib/brevio/session.rb

@@ -1,100 +1,14 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Brevio::Session
-  extend ActiveSupport::Concern
-
-  # By including this module into a Rails controller you will have access to the convenience methods
-  # fetch_brevio_session(!) and brevio_logged_in? which acts as a wrapper around the decrypting of
-  # predefined session cookies and sessions stored in Redis.
-  #
-  # We also require access to instance attributes like #request and the cookie jar, which are only
-  # available in the context of a controller.
-  #
-  included do
-    unless self <= ActionController::Base || instance_methods.include?(:session)
-      raise 'Included Brevio::Session outside of controller'
-    end
-  end
-
-  # Fetches the Brevio session from Redis, based on the encrypted key stored in the client's cookie.
-  # Returns *nil* if there's no session present.
-  #
-  def fetch_brevio_session
-    brevio_session, redis_key = fetch_session
-    return nil if brevio_session.nil?
-    if brevio_config.debug?
-      brevio_config.logger.info "[brevio-session] Found session #{brevio_session.inspect}"
-    end
-    refresh_session(redis_key) unless params.transform_keys(&:underscore)[:no_session].present?
-    brevio_session
-  rescue RuntimeError => e
-    brevio_config.logger.error "[brevio-session] #{e.message}"
-    nil
-  end
-
-  # Calls the above function, but raises an exception if the session isn't present.
-  def fetch_brevio_session!
-    brevio_session, redis_key = fetch_session
-    raise NilSession, 'Brevio session was nil' if brevio_session.nil?
-    refresh_session(redis_key) unless params.transform_keys(&:underscore)[:no_session].present?
-    brevio_session
-  end
-
-  # Returns a boolean flag indicating whether the current client has a Brevio session cookie set,
-  # and whether this cookie contains a user ID.
-  #
-  def brevio_logged_in?
-    fetch_session&.dig(:user_id).present?
-  end
-
-  private
-
-  def brevio_config
-    Config.config
-  end
-
-  def fetch_session
-    brevio_config.logger.info '[brevio-session] Fetching Brevio session'
-    cookie = request.cookie_jar[brevio_config.session_cookie]
-    redis_key = Cookies::Parse.perform!(cookie)
-    brevio_session = Redis.get(redis_key)
-    raise NilSession if brevio_session.nil?
-    [brevio_session.with_indifferent_access, redis_key]
-  rescue RuntimeError => e
-    brevio_config.logger.error "[brevio-session] --- 💣 Couldn't fetch Brevio session 💣 ---"
-    brevio_config.logger.error "[brevio-session] #{e.message}"
-    nil
-  end
-
-  # Refreshes the Brevio session cookie, avoding its expiry. This is helpful to
-  # ensure the user stays logged in through interacting with the application.
-  #
-  def refresh_session(redis_key)
-    brevio_config.logger.info '[brevio-session] Refreshing Brevio session' if brevio_config.debug?
-    cookies[brevio_config.session_cookie] = {
-      value: request.cookie_jar[brevio_config.session_cookie],
-      domain: :all,
-      expires: brevio_config.session_expire,
-      httponly: true,
-      secure: true
-    }
-    Redis.expire(redis_key, brevio_config.session_expire)
-  rescue RuntimeError => e
-    brevio_config.logger.error "[brevio-session] --- 💣 Couldn't refresh Brevio session 💣 ---"
-    brevio_config.logger.error "[brevio-session] #{e.message}"
-  end
-
-  class << self
-    # Function used to fetch the current audit company session for a given Brevio ID.
-    # This session contains information about an audit company shared by any number of
-    # users. If the audit company has been updated in ID (e.g. changed logo or name), the
-    # database record of the local service (e.g. Confirm/Sign) will fetch the updates if
-    # the timestamp in this session is greater than their own local timestamps.
-    #
-    def audit_company_updated_at(brevio_id)
-      Config.config.redis.get("#{Config::Redis::Prefixes::AUDIT_COMPANY}:#{brevio_id}")
-    end
+  extend self
+  # Function used to fetch the current audit company session for a given Brevio ID.
+  # This session contains information about an audit company shared by any number of
+  # users. If the audit company has been updated in ID (e.g. changed logo or name), the
+  # database record of the local service (e.g. Confirm/Sign) will fetch the updates if
+  # the timestamp in this session is greater than their own local timestamps.
+  #
+  def audit_company_updated_at(brevio_id)
+    Config.config.redis.get("#{Config::Redis::Prefixes::AUDIT_COMPANY}:#{brevio_id}")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brevio-session
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Brevio AS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - lib/brevio/session/cookies/parse.rb
 - lib/brevio/session/redis.rb
 - lib/brevio/session/testing.rb
+- lib/brevio/session/with_session_login.rb
 - lib/brevio_session.rb
 homepage: https://github.com/team-brevio/brevio-session
 licenses:
@@ -133,7 +134,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '='
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement