brevio-session 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe6f0b7a1308fc36fc7af2653b213a467243d0ad33425f19e07d212434601b04
-  data.tar.gz: b4260b34995a0d3be0fee13a39e6bfa4fca2da00998f00831d457f9735ccec11
+  metadata.gz: 7047e1a58ab4d8ece1f39bf73cc37ef0a4c3165da08ab14aa5a8faeb1390f3a5
+  data.tar.gz: 7f26b113da04eeb3bdd80f32335e34463f8c2adc02dd82ffbf8d7d20fd4fe8fa
 SHA512:
-  metadata.gz: 613c235b33dd2333ec2bf8e0239a669f55c047efa550e7a3145bb07aa9cdf32dea980c00e5c54577e6db90aa7c792bde203709ff156971faf7f4c2b493db047b
-  data.tar.gz: 92c6e7374afa7ec52a57a6b6485b18140f40bd260856cff26aec3c2cb0349d038dd6ee06dae416fcfffe6567f22b142751df9877521abc828c9f82477405939a
+  metadata.gz: 6d2e276acc65d46467c83645a708083cad3baf72a462db39319ccdb34bddb9b31686238a9344bcab4a721a0a77aed318d64eb7dec49978bf9c00557ce95af842
+  data.tar.gz: 46a43dae2ab5e18601dabec3b68952141610d31b1788780c8c4726eabd7e6f39bf14a8b61b2c5c2bf871a39a9414f6689e33b57385a05611a3e2f6a29eac5ad1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brevio-session (0.2.0)
+    brevio-session (0.2.1)
       actionpack (~> 7.0.3)
       redis (~> 5.0)
       zeitwerk (~> 2.6.7)

data/brevio-session.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'brevio-session'
-  spec.version       = '0.2.0'
+  spec.version       = '0.2.1'
   spec.authors       = ['Brevio AS']
   spec.email         = ['support@brevio.com']
   spec.files = `git ls-files -z`.split("\0")

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,101 +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?
-    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
-
-  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brevio-session
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Brevio AS
@@ -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: