brevio-session 0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c515c318b1b9d9dcc8f157a9fd507511d2462d43ddb62de9f439ce55e21c5da3
-  data.tar.gz: d104172c65410bf4e52d8087a2e8bcb30220cf1ef18d75d7d3f0a5eeaba2cb7d
+  metadata.gz: fe6f0b7a1308fc36fc7af2653b213a467243d0ad33425f19e07d212434601b04
+  data.tar.gz: b4260b34995a0d3be0fee13a39e6bfa4fca2da00998f00831d457f9735ccec11
 SHA512:
-  metadata.gz: 5cfcdc09b39e5162e49d1ae0f386dfa59a5e5c62a6a80c7e763d5b67fd029bea0b422efba229caf6c525e1e9011f4d84bdf48ada003d92b5918c7a00da80b244
-  data.tar.gz: f2deb2e307e1bdcf2f91744bffd969ef5a48dd34638079b22693ca6ba0ac38cdbe342a7ecd525b12b666faff15338ec682add782738693f1ddf0ad0e69288e2e
+  metadata.gz: 613c235b33dd2333ec2bf8e0239a669f55c047efa550e7a3145bb07aa9cdf32dea980c00e5c54577e6db90aa7c792bde203709ff156971faf7f4c2b493db047b
+  data.tar.gz: 92c6e7374afa7ec52a57a6b6485b18140f40bd260856cff26aec3c2cb0349d038dd6ee06dae416fcfffe6567f22b142751df9877521abc828c9f82477405939a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brevio-session (0.1)
+    brevio-session (0.2.0)
       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'
+  spec.version       = '0.2.0'
   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.rb

@@ -13,7 +13,9 @@ module Brevio::Session
   # available in the context of a controller.
   #
   included do
-    raise 'Included Brevio::Session outside of controller' unless self <= ActionController::Base
+    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.
@@ -44,7 +46,8 @@ module Brevio::Session
   # and whether this cookie contains a user ID.
   #
   def brevio_logged_in?
-    fetch_session&.dig(:user_id).present?
+    brevio_session, _ = fetch_session
+    brevio_session&.dig(:user_id).present?
   end
 
   private

data/lib/brevio_session.rb

@@ -11,6 +11,8 @@ loader.setup # ready!
 
 require 'action_dispatch'
 
+module BrevioSession; end # Necessary for reasons
+
 module Brevio::Session
   class NilSession < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brevio-session
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.2.0
 platform: ruby
 authors:
 - Brevio AS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,11 +122,6 @@ files:
 - lib/brevio/session/redis.rb
 - lib/brevio/session/testing.rb
 - lib/brevio_session.rb
-- test/brevio_session_integration_test.rb
-- test/redis_json_wrapper.rb
-- test/stubs.rb
-- test/test_app.rb
-- test/test_helper.rb
 homepage: https://github.com/team-brevio/brevio-session
 licenses:
 - MIT
@@ -138,7 +133,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

data/test/brevio_session_integration_test.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class BrevioSessionIntegrationTest < Minitest::Test
-  include Rack::Test::Methods
-  include Brevio::Session::Testing
-
-  def brevio_redis
-    Brevio::Session::Config.config.redis
-  end
-
-  def user
-    UserStub.new(brevio_id: 1)
-  end
-
-  def test_sets_brevio_session_in_redis
-    session = brevio_login(user)
-    get '/', nil, cookie: "brevio_session=#{session}"
-    assert last_response.ok?
-    assert current_session.cookie_jar['brevio_session']
-    assert_equal user.brevio_id, brevio_redis.get("brevio-id:session:#{session}")[:user_id]
-    json_body = JSON.parse(last_response.body)
-    assert_equal user.brevio_id, json_body['user_id']
-  end
-
-  def test_user_stamp
-    time = Time.current
-    session = brevio_login(user, updated_at: time)
-    get '/', nil, cookie: "brevio_session=#{session}"
-    assert last_response.ok?
-    json_body = JSON.parse(last_response.body)
-    # ceil ceils the subsecond to a default decimal (0) by default. We don't really care about
-    # microsecond precision here during the JSON parsing/dumping
-    assert_equal time.ceil, Time.parse(json_body['user_stamp']).ceil
-  end
-
-end

data/test/redis_json_wrapper.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-# Brevio ID stores its session using redis-session-store, which stores all values as JSON.
-# The returned value is a JSON string, which needs to be parsed by the redis client. The native
-# Redis.get would simply return the JSON string, so we need to wrap it.
-#
-# The services consuming the Brevio::Session (e.g. Confirm/Sign) already assume the values
-# in Redis are all JSON (see domain/brevio/redis/client.rb).
-#
-#
-class RedisJSONWrapper
-  def set(key, value)
-    redis.set(key, value.to_json)
-  end
-
-  def get(key)
-    raw = redis.get(key)
-    return nil if raw.nil?
-
-    value = JSON.parse(raw)
-    return value if value.empty?
-
-    value.with_indifferent_access
-  end
-
-  def del(keys)
-    redis.del(keys)
-  end
-
-  def expire(key, expiry)
-    redis.expire(key, expiry)
-  end
-
-  private
-
-  def redis
-    @redis ||= ::Redis.new
-  end
-end

data/test/stubs.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-class UserStub
-  attr_accessor :brevio_id, :audit_company
-
-  def initialize(attrs)
-    @brevio_id = attrs[:brevio_id]
-    @audit_company = AuditCompanyStub.new(brevio_id: @brevio_id + 1)
-  end
-end
-
-class AuditCompanyStub
-  attr_accessor :brevio_id
-
-  def initialize(attrs)
-    @brevio_id = attrs[:brevio_id]
-  end
-end

data/test/test_app.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# Based on https://github.com/rails/rails/blob/6-0-stable/guides/bug_report_templates/action_controller_master.rb
-
-require 'action_controller/railtie'
-require 'rack/test'
-require 'brevio-session'
-
-class TestApp < Rails::Application
-  config.root = __dir__
-  config.hosts << 'example.org'
-  config.session_store :cookie_store, key: 'brevio_session'
-  secrets.secret_key_base = 'secret_key_base'
-
-  config.logger     = Logger.new($stdout)
-  config.log_level  = :info
-  Rails.logger      = config.logger
-
-  routes.draw do
-    get '/' => 'test#index'
-  end
-end
-
-class TestController < ActionController::Base
-  include Brevio::Session
-  include Rails.application.routes.url_helpers
-
-  def logger
-    Rails.logger
-  end
-
-  def index
-    brevio_session = fetch_brevio_session
-    render json: brevio_session.to_json
-  end
-end

data/test/test_helper.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require 'rack/test'
-
-require 'debug'
-require 'fakeredis'
-require 'priscilla'
-require 'brevio-session'
-require 'brevio_session/testing'
-
-require 'redis_json_wrapper'
-require 'stubs'
-require 'test_app'
-
-Brevio::Session::Config.configure do |config|
-  config.debug          = true
-  config.production     = false
-  config.redis          = RedisJSONWrapper.new
-  config.secret_key     = 'secret_key_base'
-  config.session_cookie = 'brevio_session'
-  config.session_expire = 45.minutes
-end
-
-Brevio::Session::Testing.setup!(logger: Rails.logger)
-
-module Minitest
-  class Test
-    include Rack::Test::Methods
-    include TestApp.routes.url_helpers
-
-    def app
-      TestApp
-    end
-  end
-end