redis-rack 2.0.5 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 66572ef2577985ef4e66d8eff099b41cd2522452
-  data.tar.gz: 021ff43d18f10505f52187456132922eddea15b8
+SHA256:
+  metadata.gz: 5f2e06d541ce7ff62d7050dc3191e5b975209c558de584ad5f9a5d09d3e837c8
+  data.tar.gz: fe1d5072ca29a096a1e2ee2ea14c6b7cbf1282326c929a499bf90a0e30be51e6
 SHA512:
-  metadata.gz: dd6ac3b843ebadac7e56d802680badd2163ac0320a90377e94f730465c739ee74738e5c2b347a34c4fae1b6d94160a8f988c8e748ab540c820750ed7792b2ae0
-  data.tar.gz: b26ae6bfb3306d19260454d41ce2559e88997365bfc713c10fd33168b8e70ea052b45be7fed5e5370a8c36b0b66c5415935df19d77ae2a6cef1db64fd925e36c
+  metadata.gz: c01e59a29fe6c2d589f7650de251facffbf49915bc91cda3bbf9b1cbabd6b03b574e1d509aea580af214e5aa5d9a395bbc8f6e74359768cc22548de403e47621
+  data.tar.gz: f997ed68a47b214def068eb0ef0d8788af496523da9347dda26022df640dd6375d24a6407d3d6a9f72713c8b2811e28048dc2daf2b0ef493b1ff9e6bcde86235

data/.github/auto-assign-issues.yml

@@ -0,0 +1,2 @@
+assignees:
+  - tubbo

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -1,16 +1,23 @@
 language: ruby
-script: 'bundle exec rake'
+script: bundle exec rake
 rvm:
-  - 2.2.3
-  - 2.3.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
   - jruby-head
-
 matrix:
   allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head
-# Put this in your .travis.yml
-gemfile:
-  - gemfiles/rack_2.gemfile
-  - gemfiles/rack_1.gemfile
+  - rvm: jruby-head
+  - rvm: ruby-head
+deploy:
+  provider: rubygems
+  api_key:
+    secure: VTosVmCdLWUGK8KyzovYri7ySfd7fACtfL8MClEBBHnI+m2cLCpmtCJ7Z1X7z9BXlj974EDaF8V9iRKzfksXIf8aaPfVQw9AW94fLJZbfSB8YGOGyNbPu9YECoZQB1aZ2lw9s/aEdfwCbmqizO/fYpG3YoPKJdm1ZJpNOFR37Xk=
+  gem: redis-rack
+  on:
+    tags: true
+    repo: redis-store/redis-rack

data/CHANGELOG.md

@@ -0,0 +1,246 @@
+v2.1.0 (2020-01-13)
+--------------------------------------------------------------------------------
+
+*   Update version to v2.1.0 final
+    Tom Scott
+
+*   Test against most recent versions of Ruby
+    Tom Scott
+
+*   Update gemspec to remove rubyforge_project
+
+    It is deprecated or removed already
+
+    Original warning message:
+    Gem::Specification#rubyforge_project= is deprecated with no replacement. It will be removed on or after 2019-12-01.
+    PikachuEXE
+
+*   back tests to original state
+    Alexey Vasiliev
+
+*   Fix redis-rack for rack 2.0.8, small improvements
+    Alexey Vasiliev
+
+*   Fix redis-rack for rack 2.0.8, fix generate_unique_sid
+    Alexey Vasiliev
+
+*   Fix redis-rack for rack 2.0.8
+    Alexey Vasiliev
+
+*   v2.1.0.pre: Update Rack Session API, drop support for Rack 1.0
+    Tom Scott
+
+v2.0.6
+--------------------------------------------------------------------------------
+
+*   v2.0.6: Prevent Connection Pool from passing nil options
+    Tom Scott
+
+*   Make bundler dependency more permissive to support future ruby versions
+    Tom Scott
+
+*   Drop support for Rack v1
+    Tom Scott
+
+*   Update Rack::Session API Compatibility
+
+    The latest version of Rack [deprecated subclassing Rack::Session::ID](https://github.com/rack/rack/blob/master/lib/rack/session/abstract/id.rb#L412-L419),
+    replacing it instead with `Rack::Session::Persisted`. Update the method
+    implementations in this gem to support the new API. Shoutouts to @onk
+    for actually writing this code, we're pulling it in from his fork.
+    Tom Scott
+
+*   Automatically assign issues to @tubbo when they are created
+    Tom Scott
+
+*   Automatically release to RubyGems when new tags are pushed to GitHub
+    Tom Scott
+
+*   Raise Error when `:redis_store` is Incorrect Type
+
+    Passing an object that isn't a `Redis::Store` into the session storage
+    configuration can cause errors when methods are called with more
+    arguments than the default Redis client can handle. These additional
+    arguments are used by `Rack::Session::Redis` to configure the key
+    namespace and TTL globally in the main configuration, and pass them down
+    to `Redis::Store` to be appended to the key. An `ArgumentError` will now
+    be thrown when a `:redis_store` is of a type that isn't a `Redis::Store`
+    (or a subclass thereof).
+
+    Resolves #46
+    Tom Scott
+
+*   Add code owners
+    Tom Scott
+
+*   Do not provide nil values for missing connection pool options
+
+    Fixes #44
+    Jake Goulding
+
+v2.0.5
+--------------------------------------------------------------------------------
+
+*   v2.0.5 release
+    Tom Scott
+
+*   add spec to validate blank sessions are not stored in redis
+    mstruve
+
+*   dont store a blank session in redis
+    mstruve
+
+*   Add documentation for options
+    Daniel M Barlow
+
+v2.0.4
+--------------------------------------------------------------------------------
+
+*   Release 2.0.4
+    Tom Scott
+
+*   Remove .ruby-version
+    Tom Scott
+
+*   Remove rake, appraisal from gemspec executables
+
+    The contents of the bin directory are binstubs to assist development.
+    They are not intended to be shipped with the gem itself. This commit
+    updates the gemspec to ensure that they are not exposed to rubygems as
+    executables for redis-rack, which will fix conflicts with the legitimate
+    rake and appraisal executables provided by those other gems.
+    Matt Brictson
+
+v2.0.3
+--------------------------------------------------------------------------------
+
+*   v2.0.3: Avoid mutex locking with global option
+    Tom Scott
+
+*   Restore default_options in #generate_unique_sid
+    Tom Scott
+
+*   Refactor connection_pool code
+
+    Adds a `Redis::Rack::Connection` object for handling the instantiation
+    of a `Redis::Store` or a `ConnectionPool` if pool configuration is
+    given. Restores the purpose of `Rack::Session::Redis` to only implement
+    the session ID abstract API provided by Rack.
+    Tom Scott
+
+*   Rename :use_global_lock option to :threadsafe to match Rails
+    Garrett Thornburg
+
+*   Use mocha mocks to assert the mutex is never locked
+    Garrett Thornburg
+
+*   Allow redis-store v1.4
+    Shane O'Grady
+
+*   Create a :use_global_lock option that avoids the global lock
+    Garrett Thornburg
+
+*   Rake task for running all tests on all gem versions
+    Tom Scott
+
+*   Install Appraisal so we can test against multiple versions of Rack
+    Tom Scott
+
+v2.0.2
+--------------------------------------------------------------------------------
+
+*   v2.0.2: Resolve regression forcing Rack 2.x and above
+    Tom Scott
+
+v2.0.1
+--------------------------------------------------------------------------------
+
+*   v2.0.1: Relax gem dependencies
+    Tom Scott
+
+*   smoothen redis-store dependency
+    Mathieu Jobin
+
+*   Drop support for Rubinius 1.9 mode
+
+    1.9.x is EOL in MRI Ruby Land, and Rubinius 1.9 mode isn't really used
+    much anymore. This should make the builds pass again.
+    Tom Scott
+
+*   Update README.md (#20)
+    Nicolas
+
+*   Remove jruby 1.9 mode from the build matrix
+    Tom Scott
+
+*   Remove test because why
+    Tom Scott
+
+v2.0.0
+--------------------------------------------------------------------------------
+
+*   v2.0: Drop support for Ruby below 2.2 (thanks @connorshea)
+
+    Fixes #17, major shoutouts to @connorshea for getting this off the
+    ground. This also edits the CI config to drop support for older Ruby
+    versions.
+    Tom Scott
+
+*   Fix gem dependency versions
+    Tom Scott
+
+*   v2.0.0.pre Add support for Rails 5 and Rack 2.
+    Tom Scott
+
+*   v2.0.0: Upgrade to Rack 2.0
+
+    This release includes some backwards-incompatible changes that pertain
+    to Rails' upgrade to Rack 2.x.
+    Tom Scott
+
+*   Update README
+    Tom Scott
+
+*   Fix readme
+    Tom Scott
+
+*   travis.yml add Ruby 2.3.0
+    shiro16
+
+*   add 2.1 and 2.2 rubies to travis
+    Marc Roberts
+
+*   Remove support for Ruby 1.9
+    Marc Roberts
+
+*   Loosen dependancy on Rack to allow 1.5 and 2.x
+
+    Rails 5 beta requires Rack 2.x and this gem is unusable unless can use Rack 2.x
+    Marc Roberts
+
+*   Update README.md
+    Ryan Bigg
+
+*   add support for ConnectionPool
+    Roman Usherenko
+
+*   Introduce redis_store option (closes #1)
+    Kurakin Alexander
+
+*   Atomically lock session id and implement skip support.
+    W. Andrew Loe III
+
+v1.5.0
+------
+
+*   Enable CI
+    Luca Guidi
+
+*   Update README.md
+    Luca Guidi
+
+*   Moved back from jodosha/redis-store
+    Luca Guidi
+
+*   Moved
+    Luca Guidi

data/CODEOWNERS

@@ -0,0 +1 @@
+* @tubbo

data/Gemfile

@@ -1,2 +1,5 @@
 source 'https://rubygems.org'
 gemspec
+gem 'redis-store-testing', github: 'redis-store/testing'
+
+gem "appraisal", "~> 2.2"

data/lib/rack/session/redis.rb

@@ -5,7 +5,7 @@ require 'redis/rack/connection'
 
 module Rack
   module Session
-    class Redis < Abstract::ID
+    class Redis < Abstract::PersistedSecure
       attr_reader :mutex
 
       DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(
@@ -24,18 +24,18 @@ module Rack
         loop do
           sid = generate_sid
           first = with do |c|
-            [*c.setnx(sid, session, @default_options)].first
+            [*c.setnx(sid.private_id, session, @default_options.to_hash)].first
           end
           break sid if [1, true].include?(first)
         end
       end
 
-      def get_session(env, sid)
-        if env['rack.session.options'][:skip]
+      def find_session(req, sid)
+        if req.session.options[:skip]
           [generate_sid, {}]
         else
-          with_lock(env, [nil, {}]) do
-            unless sid and session = with { |c| c.get(sid) }
+          with_lock(req, [nil, {}]) do
+            unless sid and session = get_session_with_fallback(sid)
               session = {}
               sid = generate_unique_sid(session)
             end
@@ -44,16 +44,19 @@ module Rack
         end
       end
 
-      def set_session(env, session_id, new_session, options)
-        with_lock(env, false) do
-          with { |c| c.set session_id, new_session, options }
-          session_id
+      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 destroy_session(env, session_id, options)
-        with_lock(env) do
-          with { |c| c.del(session_id) }
+      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
@@ -62,8 +65,8 @@ module Rack
         @default_options.fetch(:threadsafe, true)
       end
 
-      def with_lock(env, default=nil)
-        @mutex.lock if env['rack.multithread'] && threadsafe?
+      def with_lock(req, default = nil)
+        @mutex.lock if req.multithread? && threadsafe?
         yield
       rescue Errno::ECONNREFUSED
         if $VERBOSE
@@ -78,6 +81,12 @@ module Rack
       def with(&block)
         @conn.with(&block)
       end
+
+      private
+
+      def get_session_with_fallback(sid)
+        with { |c| c.get(sid.private_id) || c.get(sid.public_id) }
+      end
     end
   end
 end

data/lib/redis/rack/connection.rb

@@ -9,6 +9,10 @@ class Redis
         if @pool && !@pool.is_a?(ConnectionPool)
           raise ArgumentError, "pool must be an instance of ConnectionPool"
         end
+
+        if @store && !@store.is_a?(Redis::Store)
+          raise ArgumentError, "redis_store must be an instance of Redis::Store (currently #{@store.class.name})"
+        end
       end
 
       def with(&block)
@@ -35,7 +39,7 @@ class Redis
         {
           size: @options[:pool_size],
           timeout: @options[:pool_timeout]
-        }
+        }.reject { |key, value| value.nil? }.to_h
       end
     end
   end

data/lib/redis/rack/version.rb

@@ -1,6 +1,5 @@
 class Redis
   module Rack
-    VERSION = '2.0.5'
+    VERSION = '2.1.3'
   end
 end
-

data/redis-rack.gemspec

@@ -12,22 +12,18 @@ Gem::Specification.new do |s|
   s.description = %q{Redis Store for Rack applications}
   s.license     = 'MIT'
 
-  s.rubyforge_project = 'redis-rack'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'redis-store',   ['< 2', '>= 1.2']
-  s.add_runtime_dependency 'rack',          '>= 1.5', '< 3'
+  s.add_runtime_dependency 'rack',          '>= 2.0.8', '< 3'
 
-  s.add_development_dependency 'rake',     '~> 10'
-  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'rake',     '>= 12.3.3'
+  s.add_development_dependency 'bundler',  '> 1', '< 3'
   s.add_development_dependency 'mocha',    '~> 0.14.0'
   s.add_development_dependency 'minitest', '~> 5'
-  s.add_development_dependency 'redis-store-testing'
   s.add_development_dependency 'connection_pool',     '~> 1.2.0'
-  s.add_development_dependency 'appraisal'
 end
 

data/test/rack/session/redis_test.rb

@@ -93,7 +93,7 @@ describe Rack::Session::Redis do
   it "does not store a blank session" do
     session_store = Rack::Session::Redis.new(incrementor)
     sid = session_store.generate_unique_sid({})
-    session_store.with { |c| c.get(sid).must_be_nil }
+    session_store.with { |c| c.get(sid.private_id).must_be_nil }
   end
 
   it "locks the store mutex" do
@@ -102,7 +102,9 @@ describe Rack::Session::Redis do
     sesion_store = Rack::Session::Redis.new(incrementor)
     sesion_store.instance_variable_set(:@mutex, mutex)
     was_yielded = false
-    sesion_store.with_lock({'rack.multithread' => true}) { was_yielded = true}
+    request = Minitest::Mock.new
+    request.expect(:multithread?, true)
+    sesion_store.with_lock(request) { was_yielded = true}
     was_yielded.must_equal(true)
   end
 
@@ -118,7 +120,9 @@ describe Rack::Session::Redis do
       sesion_store = Rack::Session::Redis.new(incrementor, :threadsafe => false)
       sesion_store.instance_variable_set(:@mutex, mutex)
       was_yielded = false
-      sesion_store.with_lock({'rack.multithread' => true}) { was_yielded = true}
+      request = Minitest::Mock.new
+      request.expect(:multithread?, true)
+      sesion_store.with_lock(request) { was_yielded = true}
       was_yielded.must_equal(true)
     end
   end
@@ -295,10 +299,11 @@ describe Rack::Session::Redis do
 
       res0 = req.get("/")
       session_id = (cookie = res0["Set-Cookie"])[session_match, 1]
-      ses0 = pool.with { |c| c.get(session_id) }
+      sid = Rack::Session::SessionId.new(session_id)
+      ses0 = pool.with { |c| c.get(sid.private_id) }
 
       req.get("/", "HTTP_COOKIE" => cookie)
-      ses1 = pool.with { |c| c.get(session_id) }
+      ses1 = pool.with { |c| c.get(sid.private_id) }
 
       ses1.wont_equal(ses0)
     end
@@ -318,6 +323,7 @@ describe Rack::Session::Redis do
       res.body.must_equal('{"counter"=>1}')
       cookie = res["Set-Cookie"]
       session_id = cookie[session_match, 1]
+      sid = Rack::Session::SessionId.new(session_id)
 
       delta_incrementor = lambda do |env|
         # emulate disconjoinment of threading
@@ -339,7 +345,7 @@ describe Rack::Session::Redis do
         request.body.must_include('"counter"=>2')
       end
 
-      session = pool.with { |c| c.get(session_id) }
+      session = pool.with { |c| c.get(sid.private_id) }
       session.size.must_equal(tnum+1) # counter
       session['counter'].must_equal(2) # meeeh
 
@@ -356,7 +362,7 @@ describe Rack::Session::Redis do
         request.body.must_include('"counter"=>3')
       end
 
-      session = pool.with { |c| c.get(session_id) }
+      session = pool.with { |c| c.get(sid.private_id) }
       session.size.must_equal(tnum+1)
       session['counter'].must_equal(3)
 
@@ -378,7 +384,7 @@ describe Rack::Session::Redis do
         request.body.must_include('"foo"=>"bar"')
       end
 
-      session = pool.with { |c| c.get(session_id) }
+      session = pool.with { |c| c.get(sid.private_id) }
       session.size.must_equal(r.size+1)
       session['counter'].must_be_nil
       session['foo'].must_equal('bar')

data/test/redis/rack/connection_test.rb

@@ -56,12 +56,29 @@ class Redis
         conn.store.must_equal(store)
       end
 
+      it "throws an error when provided Redis store is not the expected type" do
+        assert_raises ArgumentError do
+          Connection.new(redis_store: ::Redis.new)
+        end
+      end
+
       it "uses the specified Redis server when provided" do
         conn = Connection.new(redis_server: 'redis://127.0.0.1:6380/1')
 
         conn.pooled?.must_equal false
         conn.store.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
       end
+
+      it "does not include nil options for the connection pool" do
+        conn = Connection.new
+        conn.pool_options.must_be_empty
+
+        conn = Connection.new(pool_size: nil)
+        conn.pool_options.must_be_empty
+
+        conn = Connection.new(pool_timeout: nil)
+        conn.pool_options.must_be_empty
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-rack
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.3
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-store
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.0.8
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.0.8
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -54,30 +54,36 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -106,20 +112,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: redis-store-testing
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -134,20 +126,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Redis Store for Rack applications
 email:
 - me@lucaguidi.com
@@ -155,17 +133,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/auto-assign-issues.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
-- Appraisals
+- CHANGELOG.md
+- CODEOWNERS
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
 - bin/appraisal
 - bin/rake
-- gemfiles/rack_1.gemfile
-- gemfiles/rack_2.gemfile
 - lib/rack/session/redis.rb
 - lib/redis-rack.rb
 - lib/redis/rack/connection.rb
@@ -178,7 +157,7 @@ homepage: http://redis-store.org/redis-rack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: redis-rack
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Redis Store for Rack
 test_files:

data/Appraisals

@@ -1,7 +0,0 @@
-appraise 'rack-2' do
-  gem 'rack', '~> 2'
-end
-
-appraise 'rack-1' do
-  gem 'rack', '~> 1'
-end

data/gemfiles/rack_1.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rack", "~> 1"
-
-gemspec :path => "../"

data/gemfiles/rack_2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rack", "~> 2"
-
-gemspec :path => "../"