redis-session-store 0.9.1 → 0.11.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDg2OGU1YjUzMjA1OTgzOWQ3NzdkNDI2YWQ1NGNmZjBjNjQzMmE1Ng==
-  data.tar.gz: !binary |-
-    YzY5NDk0Y2U5ODIwYTIyMzlkZjM0ZDA4MDI0ZTk5ODNkNDNhNTJiNQ==
+SHA256:
+  metadata.gz: 26ff10b9f32cb399a27355db6209d933957bedc5def7e5671bc8491aee0e9114
+  data.tar.gz: b60fcf186f22a116013d17628bd53056505e1cf9fc392ced60b9072e86a95e20
 SHA512:
-  metadata.gz: !binary |-
-    YzZlNTc1MDRhODY3ZmRlM2NmYjQwNjY5NWRkMjgwMzk2MmMwYWRlNTBmOGY2
-    ZTljOGU4ODdlYjU2YTc3ZjdiOWQ3YmJiNTMwYzg5ZDkzMWZlM2E1YjYyNTcy
-    M2Y4ZjMxNWRmMTQyZWY0MGM5ZGM0YmU0OTQ4ZGRjNzRlNmViNTc=
-  data.tar.gz: !binary |-
-    MGEyMGVmZWUyZDkxODMxN2UyM2Y2Y2Y4YWZiMzMwNDZhOTI0NWRkODg4ZjRi
-    NjJjM2I0NWY3YWQ1NGFkNmM1Y2QxZmRiODZiZTMxZGZhZWQ2NzliY2JiY2E0
-    OTczMjBkZjgwNGQyM2FlMjg2NzA1OWVjNmQ0YWY5YTM3YzQ5Yzc=
+  metadata.gz: 977cad8b272aed6334f68ccec5b861262a5fc1a2729b3f86bcb36097278fc5da9837c95f434328c3d421aafcaac3eba2c2b04c6429f20f1d40a324c1e82ab607
+  data.tar.gz: 45f5e777113518ca666417a38e0df124760aaf64d5d0624de16b8b8be03b8c835c5d77e838341e79d90c0564f842975f6adf28a40a3b3bea8faa090ddc51813c

data/.rubocop.yml

@@ -1,7 +1,38 @@
-inherit_from: .rubocop_todo.yml
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'Rakefile'
+    - 'vendor/**/*'
 
-FileName:
+Naming/FileName:
   Enabled: false
 
-DoubleNegation:
+Style/DoubleNegation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 120
+
+Security/MarshalLoad:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/YodaCondition:
+  # temporary work around for rubocop bug 'An error occurred while Style/YodaCondition...' (v0.49.1)
+  Exclude:
+    - 'spec/redis_session_store_spec.rb'

data/.travis.yml

@@ -1,12 +1,16 @@
 language: ruby
-sudo: false
 cache: bundler
 rvm:
-- 2.3.1
-- jruby-9.1.1.0
+- 2.3
+- 2.4
+- 2.5
+- 2.6
+- ruby-head
+- jruby-9.2.9.0
 matrix:
   allow_failures:
-  - rvm: jruby-9.1.1.0
+  - rvm: ruby-head
+  - rvm: jruby-9.2.9.0
 notifications:
   email: false
 deploy:
@@ -17,4 +21,4 @@ deploy:
   on:
     tags: true
     repo: roidrage/redis-session-store
-    rvm: 2.3.1
+    rvm: 2.3.8

data/AUTHORS.md

@@ -7,6 +7,7 @@ Redis Session Store authors
 - Edwin Cruz
 - Gonçalo Silva
 - Ian C. Anderson
+- Jesse Doyle
 - Jorge Pardiñas
 - Justin McNally
 - Mathias Meyer
@@ -15,3 +16,10 @@ Redis Session Store authors
 - Olek Poplavsky
 - Tim Lossen
 - Todd Bealmear
+- Aleksey Dashkevych
+- Olle Jonsson
+- Nicolas Rodriguez
+- Sergey Nebolsin
+- Anton Kolodii
+- Peter Karman
+- Zach Margolis

data/CHANGELOG.md

@@ -4,6 +4,38 @@
 
 ## [Unreleased]
 
+## [0.11.2] - 2020-07-22
+### Changed
+- Silence deprecation warning when using with redis gem v4.2+
+
+## [0.11.1] - 2019-08-22
+### Changed
+- Remove the `has_rdoc` parameter from the `.gemspec` file as it has been deprecated.
+- Actionpack to '>= 3', remove upper dependency
+
+## [0.11.0] - 2018-08-13
+### Changed
+- JRuby to jruby-9.2.0.0
+- Travis Ruby support: 2.3.7, 2.4.4, 2.5.1
+
+### Added
+- :ttl configuration option
+
+## [0.10.0] - 2018-04-14
+### Changed
+- JRuby to jruby-9.1.15.0
+- Redis to '>= 3', '< 5'
+- Actionpack to '>= 3', '< 6'
+- Rake to 12
+
+### Added
+- with_indifferent_access if defined ActiveSupport
+
+## [0.9.2] - 2017-10-31
+### Changed
+- Actionpack to 5.1
+- Travis use jruby 9.1.13.0
+
 ## [0.9.1] - 2016-07-03
 ### Added
 - More specific runtime dependencies
@@ -201,7 +233,11 @@
 ### Added
 - first working version
 
-[Unreleased]: https://github.com/roidrage/redis-session-store/compare/v0.9.1...HEAD
+[Unreleased]: https://github.com/roidrage/redis-session-store/compare/v0.11.1...HEAD
+[0.11.1]: https://github.com/roidrage/redis-session-store/compare/v0.11.0...v0.11.1
+[0.11.0]: https://github.com/roidrage/redis-session-store/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/roidrage/redis-session-store/compare/v0.9.2...v0.10.0
+[0.9.2]: https://github.com/roidrage/redis-session-store/compare/v0.9.1...v0.9.2
 [0.9.1]: https://github.com/roidrage/redis-session-store/compare/v0.9.0...v0.9.1
 [0.9.0]: https://github.com/roidrage/redis-session-store/compare/v0.8.1...v0.9.0
 [0.8.1]: https://github.com/roidrage/redis-session-store/compare/v0.8.0...v0.8.1

data/README.md

@@ -33,12 +33,13 @@ See `lib/redis-session-store.rb` for a list of valid options.
 In your Rails app, throw in an initializer with the following contents:
 
 ``` ruby
-My::Application.config.session_store :redis_session_store, {
+Rails.application.config.session_store :redis_session_store, {
   key: 'your_session_key',
   redis: {
-    expire_after: 120.minutes,
+    expire_after: 120.minutes,  # cookie expiration
+    ttl: 120.minutes,           # Redis expiration, defaults to 'expire_after'
     key_prefix: 'myapp:session:',
-    url: 'redis://host:12345/2',
+    url: 'redis://localhost:6379/0',
   }
 }
 ```
@@ -49,7 +50,7 @@ If you want to handle cases where Redis is unavailable, a custom
 callable handler may be provided as `on_redis_down`:
 
 ``` ruby
-My::Application.config.session_store :redis_session_store, {
+Rails.application.config.session_store :redis_session_store, {
   # ... other options ...
   on_redis_down: ->(e, env, sid) { do_something_will_ya!(e) }
   redis: {
@@ -69,7 +70,7 @@ custom serializer:
 * `CustomClass` - You can just pass the constant name of any class that responds to `.load` and `.dump`
 
 ``` ruby
-My::Application.config.session_store :redis_session_store, {
+Rails.application.config.session_store :redis_session_store, {
   # ... other options ...
   serializer: :hybrid
   redis: {
@@ -88,7 +89,7 @@ custom callable handler may be provided as `on_session_load_error` which
 will be given the error and the session ID.
 
 ``` ruby
-My::Application.config.session_store :redis_session_store, {
+Rails.application.config.session_store :redis_session_store, {
   # ... other options ...
   on_session_load_error: ->(e, sid) { do_something_will_ya!(e) }
   redis: {
@@ -99,6 +100,10 @@ My::Application.config.session_store :redis_session_store, {
 
 **Note** The session will *always* be destroyed when it cannot be loaded.
 
+### Other notes
+
+It returns with_indifferent_access if ActiveSupport is defined
+
 ## Rails 2 Compatibility
 
 This gem is currently only compatible with Rails 3+.  If you need

data/lib/redis-session-store.rb

@@ -3,16 +3,17 @@ require 'redis'
 # Redis session storage for Rails, and for Rails only. Derived from
 # the MemCacheStore code, simply dropping in Redis instead.
 class RedisSessionStore < ActionDispatch::Session::AbstractStore
-  VERSION = '0.9.1'.freeze
+  VERSION = '0.11.2'.freeze
   # Rails 3.1 and beyond defines the constant elsewhere
   unless defined?(ENV_SESSION_OPTIONS_KEY)
-    if Rack.release.split('.').first.to_i > 1
-      ENV_SESSION_OPTIONS_KEY = Rack::RACK_SESSION_OPTIONS
-    else
-      ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
-    end
+    ENV_SESSION_OPTIONS_KEY = if Rack.release.split('.').first.to_i > 1
+                                Rack::RACK_SESSION_OPTIONS
+                              else
+                                Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
+                              end
   end
 
+  USE_INDIFFERENT_ACCESS = defined?(ActiveSupport).freeze
   # ==== Options
   # * +:key+ - Same as with the other cookie stores, key name
   # * +:redis+ - A hash with redis-specific options
@@ -26,12 +27,12 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
   #
   # ==== Examples
   #
-  #     My::Application.config.session_store :redis_session_store, {
+  #     Rails.application.config.session_store :redis_session_store, {
   #       key: 'your_session_key',
   #       redis: {
   #         expire_after: 120.minutes,
   #         key_prefix: 'myapp:session:',
-  #         url: 'redis://host:12345/2'
+  #         url: 'redis://localhost:6379/0'
   #       },
   #       on_redis_down: ->(*a) { logger.error("Redis down! #{a.inspect}") }
   #       serializer: :hybrid # migrate from Marshal to JSON
@@ -66,7 +67,7 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
 
     !!(
       value && !value.empty? &&
-      redis.exists(prefixed(value))
+      key_exists?(value)
     )
   rescue Errno::ECONNREFUSED, Redis::CannotConnectError => e
     on_redis_down.call(e, env, value) if on_redis_down
@@ -74,6 +75,16 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
     true
   end
 
+  def key_exists?(value)
+    if redis.respond_to?(:exists?)
+      # added in redis gem v4.2
+      redis.exists?(prefixed(value))
+    else
+      # older method, will return an integer starting in redis gem v4.3
+      redis.exists(prefixed(value))
+    end
+  end
+
   def verify_handlers!
     %w(on_redis_down on_session_load_error).each do |h|
       next unless (handler = public_send(h)) && !handler.respond_to?(:call)
@@ -86,16 +97,15 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
     "#{default_options[:key_prefix]}#{sid}"
   end
 
-  def get_session(env, sid)
-    unless sid && (session = load_session_from_redis(sid))
-      sid = generate_sid
-      session = {}
-    end
+  def session_default_values
+    [generate_sid, USE_INDIFFERENT_ACCESS ? {}.with_indifferent_access : {}]
+  end
 
-    [sid, session]
+  def get_session(env, sid)
+    sid && (session = load_session_from_redis(sid)) ? [sid, session] : session_default_values
   rescue Errno::ECONNREFUSED, Redis::CannotConnectError => e
     on_redis_down.call(e, env, sid) if on_redis_down
-    [generate_sid, {}]
+    session_default_values
   end
   alias find_session get_session
 
@@ -103,7 +113,7 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
     data = redis.get(prefixed(sid))
     begin
       data ? decode(data) : nil
-    rescue => e
+    rescue StandardError => e
       destroy_session_from_sid(sid, drop: true)
       on_session_load_error.call(e, sid) if on_session_load_error
       nil
@@ -111,23 +121,29 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
   end
 
   def decode(data)
-    serializer.load(data)
+    session = serializer.load(data)
+    USE_INDIFFERENT_ACCESS ? session.with_indifferent_access : session
   end
 
   def set_session(env, sid, session_data, options = nil)
-    expiry = (options || env.fetch(ENV_SESSION_OPTIONS_KEY))[:expire_after]
+    expiry = get_expiry(env, options)
     if expiry
       redis.setex(prefixed(sid), expiry, encode(session_data))
     else
       redis.set(prefixed(sid), encode(session_data))
     end
-    return sid
+    sid
   rescue Errno::ECONNREFUSED, Redis::CannotConnectError => e
     on_redis_down.call(e, env, sid) if on_redis_down
-    return false
+    false
   end
   alias write_session set_session
 
+  def get_expiry(env, options)
+    session_storage_options = options || env.fetch(ENV_SESSION_OPTIONS_KEY, {})
+    session_storage_options[:ttl] || session_storage_options[:expire_after]
+  end
+
   def encode(session_data)
     serializer.dump(session_data)
   end

data/redis-session-store.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |gem|
   gem.homepage = 'https://github.com/roidrage/redis-session-store'
   gem.license = 'MIT'
 
-  gem.has_rdoc = true
   gem.extra_rdoc_files = %w(LICENSE AUTHORS.md CONTRIBUTING.md)
 
   gem.files = `git ls-files -z`.split("\x0")
@@ -16,11 +15,11 @@ Gem::Specification.new do |gem|
   gem.version = File.read('lib/redis-session-store.rb')
                     .match(/^  VERSION = '(.*)'/)[1]
 
-  gem.add_runtime_dependency 'redis', '~> 3'
-  gem.add_runtime_dependency 'actionpack', '>= 3', '< 5.1'
+  gem.add_runtime_dependency 'actionpack', '~> 3'
+  gem.add_runtime_dependency 'redis', '>= 3', '< 5'
 
   gem.add_development_dependency 'fakeredis', '~> 0.5'
-  gem.add_development_dependency 'rake', '~> 11'
+  gem.add_development_dependency 'rake', '~> 12'
   gem.add_development_dependency 'rspec', '~> 3'
   gem.add_development_dependency 'rubocop', '~> 0.41'
   gem.add_development_dependency 'simplecov', '~> 0.11'

data/spec/redis_session_store_spec.rb

@@ -59,6 +59,29 @@ describe RedisSessionStore do
     end
   end
 
+  describe 'when configured with both :ttl and :expire_after' do
+    let(:ttl_seconds) { 60 * 120 }
+    let :options do
+      {
+        key: random_string,
+        secret: random_string,
+        redis: {
+          host: 'hosty.local',
+          port: 16_379,
+          db: 2,
+          key_prefix: 'myapp:session:',
+          ttl: ttl_seconds,
+          expire_after: nil
+        }
+      }
+    end
+
+    it 'assigns the :ttl option to @default_options' do
+      expect(default_options[:ttl]).to eq(ttl_seconds)
+      expect(default_options[:expire_after]).to be_nil
+    end
+  end
+
   describe 'when initializing with top-level redis options' do
     let :options do
       {
@@ -496,7 +519,7 @@ describe RedisSessionStore do
       end
 
       context 'when callable' do
-        let(:options) { { :"#{h}" => ->(*) { !nil } } }
+        let(:options) { { "#{h}": ->(*) { true } } }
 
         it 'does not explode at init' do
           expect { store }.to_not raise_error
@@ -504,7 +527,7 @@ describe RedisSessionStore do
       end
 
       context 'when not callable' do
-        let(:options) { { :"#{h}" => 'herpderp' } }
+        let(:options) { { "#{h}": 'herpderp' } }
 
         it 'explodes at init' do
           expect { store }.to raise_error(ArgumentError)

metadata

@@ -1,117 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: redis-session-store
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Mathias Meyer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-03 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.41'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.41'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
 description: A drop-in replacement for e.g. MemCacheStore to store Rails sessions
@@ -125,12 +125,11 @@ extra_rdoc_files:
 - AUTHORS.md
 - CONTRIBUTING.md
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
-- .simplecov
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
 - AUTHORS.md
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -148,24 +147,23 @@ homepage: https://github.com/roidrage/redis-session-store
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and
   Rails sessions only) in Redis.

data/.rubocop_todo.yml

@@ -1,12 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2016-07-02 09:22:22 -0400 using RuboCop version 0.41.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 108