multi_session_store 0.1.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b649eeeeb5c3a7664b5150d21a3298b1e6aa01f6a12acfff10d948decd446a9
-  data.tar.gz: 72de55c4116b17e9adfd9af8d182b9fae01614d4a8eeb367665bd54790ee28cd
+  metadata.gz: 3901d210eb5e3f7b8bc360475fbff5aebe3f3e3dffcd9d1e5e3f617eacb8f51a
+  data.tar.gz: edf3697da991dfc54201a2ddbd42bb1c5d23aea1f0d195de6c59c841ae74edfe
 SHA512:
-  metadata.gz: 8ce98ad8fa45122300bd79569dee41e0d491b39b0626ee315adccc8018bf77336766f0e0fa1b9b69701c4d5e9c0a5bed913ff4b58b1fe309c5ba16cb438e1ab5
-  data.tar.gz: 9bfe13213d26b635ca339566b73ea11c5b6c7cb951716867dd74d8a9cdbb0cdacd4909bcefb35d0ccb7e12a63f87e8b0f9b8b59473f1a9d3037ea602d5c5eeda
+  metadata.gz: bb5c11d4cb0b2e0e43351bdad10b7fc9201149d78011a6873f0430ba663f33cd707433539e1fe9c5b64674f381dad509c6e9a56016fdd1af7166aab98efad430
+  data.tar.gz: b9842a6bacdc0663a540ea04e4e4027ff690ccc5e009eab95002104c479a2c836fc9f9cbc0aacfa198d28b1c3a314a336d5aa3e253945d7b62c95df53730ce5e

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 /Gemfile.lock
+.ruby-version

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "multi/session/store"
+require "multi_session_store"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/multi_session_store.rb

@@ -1,49 +1,75 @@
 require "multi_session_store/version"
+require "multi_session_store/subsession_generator_middleware"
+require "multi_session_store/default_url_options"
+require "multi_session_store/railtie" if defined? Rails
 require "action_dispatch"
+require 'json'
 
 module ActionDispatch
   module Session
     class MultiSessionStore < AbstractStore
+      DEFAULT_SESSION_EXPIRATION = 24 * 60 * 60
+      DEFAULT_PARAM_NAME = 'subsession_id'.freeze
+
       def initialize(app, options = {})
-        @cache = options[:cache]
-        options[:expire_after] ||= @cache.options[:expires_in]
-        @param = options[:param]
+        options[:expire_after] ||= DEFAULT_SESSION_EXPIRATION
+        options[:param_name] ||= DEFAULT_PARAM_NAME
+        options[:serializer] ||= JSON
+        @redis = options[:redis]
+        @param_name = options[:param_name]
         @serializer = options[:serializer]
-
         super
       end
 
       def find_session(env, sid)
-        sid ||= generate_sid
-        session = @serializer.parse(@cache.read(cache_key(env, sid)) || "{}")
-
-        [sid, session]
+        if sid
+          serialized_session_data = @redis.get session_store_key(env, sid)
+          session_data = serialized_session_data ? @serializer.parse(serialized_session_data) : {}
+          [sid, session_data]
+        else
+          [generate_sid, {}]
+        end
       end
 
       def write_session(env, sid, session, options)
-        key = cache_key(env, sid)
-
+        key = session_store_key env, sid
         if session
-          @cache.write(key, @serializer.dump(session), expires_in: options[:expire_after])
+          @redis.set key, @serializer.dump(session), ex: options[:expire_after]
         else
-          @cache.delete(key)
+          @redis.del key
         end
-
         sid
       end
 
       def delete_session(env, sid, options)
-        @cache.delete(cache_key(env, sid))
-
+        @redis.del session_store_key(env, sid)
         sid
       end
 
-    private
+      def validate_sessions(&block)
+        all_sessions.each do |key, session|
+          @redis.del key unless block.call session
+        end
+      end
 
-      def cache_key(env, sid)
-        subsession_id = env.params[@param] || "no_subsession"
+      private
+
+      def session_store_key(env, sid)
+        subsession_id = env.params[@param_name] || 'no_subsession'
         "_session_id:#{sid}:#{subsession_id}"
       end
+
+      def all_sessions
+        session_store_keys.each_with_object({}) do |key, memo|
+          serialized_value = @redis.get key
+          next if serialized_value.nil?
+          memo[key] = @serializer.parse serialized_value
+        end
+      end
+
+      def session_store_keys
+        @redis.keys "_session_id:*"
+      end
     end
   end
 end

data/lib/multi_session_store/default_url_options.rb

@@ -0,0 +1,12 @@
+module MultiSessionStore
+  module DefaultUrlOptions
+    def default_url_options
+      options = params[:subsession_id] ? {subsession_id: params[:subsession_id]} : {}
+      begin
+        super.merge options
+      rescue NoMethodError
+        options
+      end
+    end
+  end
+end

data/lib/multi_session_store/railtie.rb

@@ -0,0 +1,15 @@
+module MultiSessionStore
+  class Railtie < Rails::Railtie
+    config.multi_session_store = ActiveSupport::OrderedOptions.new
+
+    initializer 'multi_session_store.add_middleware' do |app|
+      app.config.middleware.insert_before ActionDispatch::Session::MultiSessionStore,
+                                          MultiSessionStore::SubsessionGeneratorMiddleware,
+                                          exclude_paths: app.config.multi_session_store.exclude_paths
+    end
+
+    config.to_prepare do
+      ApplicationController.prepend MultiSessionStore::DefaultUrlOptions unless ApplicationController.ancestors.include? MultiSessionStore::DefaultUrlOptions
+    end
+  end
+end

data/lib/multi_session_store/subsession_generator_middleware.rb

@@ -0,0 +1,45 @@
+require 'securerandom'
+
+module MultiSessionStore
+  class SubsessionGeneratorMiddleware
+    def initialize(app, config = {})
+      @app = app
+      @config = config
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      set_subsession_id_from_header(request)
+      generate_subsession_id_if_needed(request)
+      @app.call(env)
+    end
+
+    private
+
+    SUBSESSION_ID_HEADER = 'HTTP_X_SUBSESSIONID'.freeze
+
+    def set_subsession_id_from_header(request)
+      request.update_param 'subsession_id', request.get_header(SUBSESSION_ID_HEADER) if request.has_header?(SUBSESSION_ID_HEADER)
+    end
+
+    def generate_subsession_id_if_needed(request)
+      request.update_param 'subsession_id', new_subsession_id if subsession_id_is_needed?(request)
+    end
+
+    def new_subsession_id
+      SecureRandom.hex
+    end
+
+    def subsession_id_is_needed?(request)
+      !request.params['subsession_id'] && !path_excluded?(request.path)
+    end
+
+    def path_excluded?(current_path)
+      excluded_paths.any? { |excluded_path| excluded_path.match? current_path }
+    end
+
+    def excluded_paths
+      @config[:exclude_paths] ||= []
+    end
+  end
+end

data/lib/multi_session_store/version.rb

@@ -1,3 +1,3 @@
 module MultiSessionStore
-  VERSION = "0.1.0"
+  VERSION = "0.2.5"
 end

data/multi_session_store.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "redis", "~> 4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_session_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Emarsys Smart Insight developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 description: This gem provides a means to support multiple sessions across different
   tabs in the same browser window.
 email:
@@ -98,6 +98,9 @@ files:
 - bin/console
 - bin/setup
 - lib/multi_session_store.rb
+- lib/multi_session_store/default_url_options.rb
+- lib/multi_session_store/railtie.rb
+- lib/multi_session_store/subsession_generator_middleware.rb
 - lib/multi_session_store/version.rb
 - multi_session_store.gemspec
 homepage: https://github.com/emartech/multi_session_store