redi_sesh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3742948ebd92791a925900f4429c9b1d608b66e6aeba1e25559d1ddef00c10ce
+  data.tar.gz: fd3aabd31233da84f89dfda73a04813ffe8d2e62306f09431a1566d8c3948f64
+SHA512:
+  metadata.gz: 4d38609c4528be9ae8ba62845df5a79f9b56bd795e37f227810df013504a1d60b054e0b9d5463800680fa59f485557242540935ec9eaae47e6fd3c77167cc5a4
+  data.tar.gz: a8166a9d4902d56783d2af0289908ed6585b883b95c3163f9d0009c85b55f10662f699819611af8ceb5976118f5297a2c226aede6449840f544db02f5aa76300

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+require: rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - vendor/**/*
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Metrics/AbcSize:
+  Max: 25
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - redi_sesh.gemspec
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Max: 20
+Metrics/PerceivedComplexity:
+  Max: 10
+
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/ExpectInHook:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/StubbedMock:
+  Enabled: false
+
+# NOTE: we need to replicate existing functionality of redis-store
+Security/MarshalLoad:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redi_sesh.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'
+
+gem 'byebug'
+gem 'mock_redis'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kenneth Teh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# RediSesh
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redi_sesh`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add redi_sesh
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install redi_sesh
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redi_sesh.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new
+
+task default: %i[rubocop spec]

data/lib/rack/session/redis.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'rack/session/abstract/id'
+require_relative '../../redi_sesh/connection_wrapper'
+require_relative '../../redi_sesh/store'
+
+module Rack
+  module Session
+    class Redis < Abstract::PersistedSecure
+      attr_reader :mutex
+
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(
+        redis_server: 'redis://127.0.0.1:6379/0/rack:session'
+      )
+
+      def initialize(app, options = {})
+        super
+
+        @mutex = Mutex.new
+        @conn = RediSesh::ConnectionWrapper.new(@default_options)
+      end
+
+      def find_session(req, sid)
+        if req.session.options[:skip]
+          [generate_sid, {}]
+        else
+          with_lock(req, [nil, {}]) do
+            if sid && (session = get_session_with_fallback(sid))
+              [sid, session]
+            else
+              [generate_sid, {}]
+            end
+          end
+        end
+      end
+
+      def write_session(req, sid, new_session, options = {})
+        with_lock(req, false) do
+          with { |c| c.set(sid.private_id, new_session, options.to_hash) }
+          sid
+        end
+      end
+
+      def delete_session(req, sid, options)
+        with_lock(req) do
+          with do |c|
+            c.del(sid.public_id)
+            c.del(sid.private_id)
+          end
+          generate_sid unless options[:drop]
+        end
+      end
+
+      def threadsafe?
+        @default_options.fetch(:threadsafe, true)
+      end
+
+      private
+
+      def get_session_with_fallback(sid)
+        with { |c| c.get(sid.private_id) || c.get(sid.public_id) }
+      end
+
+      def with_lock(_req, default = nil)
+        @mutex.lock if threadsafe?
+        yield
+      rescue Errno::ECONNREFUSED
+        if $VERBOSE
+          warn "#{self} is unable to find Redis server."
+          warn $ERROR_INFO.inspect
+        end
+        default
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+
+      def with(&block)
+        @conn.with(&block)
+      end
+    end
+  end
+end

data/lib/redi_sesh/connection_wrapper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RediSesh
+  class ConnectionWrapper
+    POOL_KEYS = %i[pool pool_size pool_timeout].freeze
+
+    def initialize(options = {})
+      @options = options
+      @store = options[:redis_store]
+      @pool = options[:pool]
+
+      raise ArgumentError, 'pool must be an instance of ConnectionPool' if @pool && !@pool.is_a?(ConnectionPool)
+
+      return unless @store && !@store.is_a?(RediSesh::Store)
+
+      raise ArgumentError, "redis_store must be an instance of RediSesh::Store (currently #{@store.class.name})"
+    end
+
+    def with(&block)
+      if pooled?
+        pool.with(&block)
+      else
+        block.call(store)
+      end
+    end
+
+    def pooled?
+      return @pooled if defined?(@pooled)
+
+      @pooled = POOL_KEYS.any? { |key| @options.key?(key) }
+    end
+
+    def pool
+      @pool ||= ConnectionPool.new(pool_options) { store } if pooled?
+    end
+
+    def store
+      @store ||= Store.create(@options[:redis_server])
+    end
+
+    def pool_options
+      {
+        size: @options[:pool_size],
+        timeout: @options[:pool_timeout]
+      }.compact.to_h
+    end
+  end
+end

data/lib/redi_sesh/store.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+module RediSesh
+  class Store
+    DEFAULT_EXPIRES_IN = 60 * 60 * 24 # 1 day
+
+    def self.create(url)
+      uri = URI.parse(url)
+      parts = uri.path.split('/')
+
+      parts.shift if parts.first.empty?
+
+      if parts.size > 1
+        path, prefix = parts
+        uri.path = "/#{path}"
+      else
+        prefix = 'sessions'
+      end
+
+      redis = Redis.new(url: uri)
+      new(redis: redis, prefix: prefix)
+    end
+
+    def initialize(redis:, prefix:)
+      @redis = redis
+      @prefix = prefix
+    end
+
+    def info
+      redis.info
+    end
+
+    def set(key, value, options = {})
+      key = build_key(key)
+      expires_in = options.fetch(:expires_in, DEFAULT_EXPIRES_IN)
+      value = serialize(value)
+      redis.set(key, value, ex: expires_in)
+    end
+
+    def get(key)
+      data = redis.get(build_key(key))
+      deserialize(data)
+    end
+
+    def del(*keys)
+      redis.del(*keys.map { |key| build_key(key) })
+    end
+
+    def keys
+      redis.keys("#{prefix}:*").map do |key|
+        key.delete_prefix("#{prefix}:")
+      end
+    end
+
+    private
+
+    attr_reader :redis, :prefix
+
+    def build_key(key)
+      "#{prefix}:#{key}"
+    end
+
+    def serialize(data)
+      Marshal.dump(data)
+    end
+
+    def deserialize(data)
+      data ? Marshal.load(data) : nil
+    end
+  end
+end

data/lib/redi_sesh/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RediSesh
+  VERSION = '0.1.0'
+end

data/lib/redi_sesh.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'redi_sesh/version'
+require_relative 'rack/session/redis'
+
+module RediSesh
+end

data/redi_sesh.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/redi_sesh/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'redi_sesh'
+  spec.version = RediSesh::VERSION
+  spec.authors = ['Hieu Nguyen', 'Kenneth Teh']
+  spec.email = ['hieu.nguyen@kaligo.com', 'kenneth.teh@kaligo.com']
+
+  spec.summary = 'Modified version of Rack::Session::Redis to support Redis 4.6.0 and 5.0.0'
+  spec.homepage = 'https://github.com/Kaligo/redi_sesh'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Kaligo/redi_sesh'
+  spec.metadata['changelog_uri'] = 'https://github.com/Kaligo/redi_sesh/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'connection_pool'
+  spec.add_runtime_dependency 'rack-session', '>= 0.2.0'
+  spec.add_runtime_dependency 'redis', '>= 4.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: redi_sesh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hieu Nguyen
+- Kenneth Teh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-session
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description:
+email:
+- hieu.nguyen@kaligo.com
+- kenneth.teh@kaligo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/session/redis.rb
+- lib/redi_sesh.rb
+- lib/redi_sesh/connection_wrapper.rb
+- lib/redi_sesh/store.rb
+- lib/redi_sesh/version.rb
+- redi_sesh.gemspec
+homepage: https://github.com/Kaligo/redi_sesh
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Kaligo/redi_sesh
+  source_code_uri: https://github.com/Kaligo/redi_sesh
+  changelog_uri: https://github.com/Kaligo/redi_sesh/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: Modified version of Rack::Session::Redis to support Redis 4.6.0 and 5.0.0
+test_files: []