redis-session-store 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56bc245a6348c77dc89fd0f9cafcb190ce55bf0a
-  data.tar.gz: 39c2e4dacfb2bdf3ffdb2ab661199cca1f41bac8
+  metadata.gz: 9148a3bedfc1ab56951717dccdaed7c30e33e356
+  data.tar.gz: ca00490849f6276f4262ddfa100fa8d90c819087
 SHA512:
-  metadata.gz: 3c3766b71ff8e0c3d1e1e89497a6cf7e7b59c2cba3a199e7e94f59cd246deb9762df2e3d78fc420cd835cacebfb9eaeeae7cb7809262211fcb4c0aecb7b992a9
-  data.tar.gz: 3dcf04844ab54396592dbae1ac820f600fa73d0147b6695582dc6ae0c4596ab8bedfef2a7c0dc89a4c7c42a73e8a833292a7d11401520c55a5c4737be16ad670
+  metadata.gz: fdbe30259d8e8eb71a650a73c59f613f830276f913d0e5bd062b5212db29704aa3ff56d7b5d443e95fabdd441085065a5ca8b02aa0c4b998264c3efeb4685cd9
+  data.tar.gz: ad31abd62bb1eb5b093aa03ba1e0f2c11bc197e3e3ff395bb78dabfb1d7659ef2a06f05435cd03a3db060510700a8a1f4ca509cd6561849e017de2014f2e068c

data/CHANGELOG.md

@@ -0,0 +1,103 @@
+redis-session-store history
+===========================
+
+## v0.5.0 (2014-03-16)
+
+* Keep generating session IDs until one is found that doesn't collide
+  with existing session IDs
+* Add support for `on_sid_collision` handler option
+* Add support for `on_redis_down` handler option
+* **BACKWARD INCOMPATIBLE** Drop support for `:raise_errors` option
+
+## v0.4.2 (2014-03-14)
+
+* Renaming `load_session` method to not conflict with AbstractStore
+
+## v0.4.1 (yanked) (2014-03-13)
+
+* Regenerate session ID when session is missing
+
+## v0.4.0 (2014-02-19)
+
+* Add support for `ENV_SESSION_OPTIONS_KEY` rack env option
+* Add support for `:raise_errors` session option (kinda like Dalli)
+* Increasing test coverage
+
+## v0.3.1 (2014-02-19)
+
+* Add `#destroy_session` method
+* Clean up remaining RuboCop offenses
+* Documentation updates
+
+## v0.3.0 (2014-02-13)
+
+* Rails 3 compatibility
+* Switch from minitest to rspec
+* Add test coverage
+* RuboCop cleanup
+
+## v0.2.4 (2014-03-16)
+
+* Keep generating session IDs until one is found that doesn't collide
+  with existing session IDs
+
+## v0.2.3 (2014-03-14)
+
+* Renaming `load_session` method to not conflict with AbstractStore
+
+## v0.2.2 (yanked) (2014-03-13)
+
+* Regenerate session ID when session is missing
+
+## v0.2.1 (2013-09-17)
+
+* Add explicit MIT license metadata in gemspec
+
+## v0.2.0 (2013-09-13)
+
+* Use `@redis.setex` when expiry provided, else `@redis.set`
+* Gemfile, gemspec, and git updates
+* Nest redis-specific options inside a `:redis` key of session options
+* Add `#destroy` method
+* Rescue only `Errno::ECONNREFUSED` exceptions
+* Handle `nil` cookies during `#destroy`
+* Add Travis integration
+* Add some minimal tests to ensure backward compatibility session options
+
+## v0.1.9 (2012-03-06)
+
+## v0.1.8 (2010-12-09)
+
+* Remove use of `@redis.pipelined`
+
+## v0.1.7 (2010-12-08)
+
+* Using latest redis gem API
+
+## v0.1.6 (2010-04-18)
+
+* Using pipelined format with `set` and `expire`
+* Changing default port from 6370 to 6379
+
+## v0.1.5 (2010-04-07)
+
+## v0.1.4 (2010-03-26)
+
+* Changed redis parameter from `:server` to `:host`
+
+## v0.1.3 (2009-12-30)
+
+* Documentation updates
+
+## v0.1.2 (2009-12-30)
+
+* Documentation updates
+
+## v0.1.1 (2009-12-30)
+
+* library file renamed to `redis-session-store.rb` to play nicely with
+  rails require
+
+## v0.1 (2009-12-30)
+
+* first working version

data/README.md

@@ -19,8 +19,8 @@ only suitable for Rails applications. For other frameworks or
 drop-in support for caching, check out
 [redis-store](http://github.com/jodosha/redis-store/)
 
-Compatibility
--------------
+Rails 2 Compatibility
+---------------------
 
 This gem is currently only compatible with Rails 3+.  If you need
 Rails 2 compatibility, be sure to pin to a lower version like so:
@@ -44,17 +44,41 @@ In your Rails app, throw in an initializer with the following contents:
 
 ``` ruby
 My::Application.config.session_store = :redis_session_store, {
-  :key          => 'your_session_key',
-  :redis        => {
-    :db => 2,
-    :expire_after => 120.minutes,
-    :key_prefix => "myapp:session:",
-    :host    => 'host', # Redis host name, default is localhost
-    :port    => 12345   # Redis port, default is 6379
+  key: 'your_session_key',
+  redis: {
+    db: 2,
+    expire_after: 120.minutes,
+    key_prefix: 'myapp:session:',
+    host: 'host', # Redis host name, default is localhost
+    port: 12345   # Redis port, default is 6379
   }
 }
 ```
-    
+
+### Session ID collision handling
+
+If you want to handle cases where the generated session ID (sid)
+collides with an existing session ID, a custom callable handler may be
+provided as `on_sid_collision`:
+
+``` ruby
+My::Application.config.session_store = :redis_session_store, {
+  # ... other options ...
+  on_sid_collision: ->(sid) { Rails.logger.warn("SID collision! #{sid}") }
+}
+```
+
+### Redis unavailability handling
+
+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, {
+  # ... other options ...
+  on_redis_down: ->(e, env, sid) { do_something_will_ya!(e) }
+}
+```
 
 Contributing, Authors, & License
 --------------------------------

data/lib/redis-session-store.rb

@@ -4,7 +4,7 @@ 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.4.2'
+  VERSION = '0.5.0'
 
   # ==== Options
   # * +:key+ - Same as with the other cookie stores, key name
@@ -14,18 +14,22 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
   #   * +:db+ - Database number, defaults to 0.
   #   * +:key_prefix+ - Prefix for keys used in Redis, e.g. +myapp:+
   #   * +:expire_after+ - A number in seconds for session timeout
+  # * +:on_sid_collision:+ - Called with SID string when generated SID collides
+  # * +:on_redis_down:+ - Called with err, env, and SID on Errno::ECONNREFUSED
   #
   # ==== Examples
   #
   #     My::Application.config.session_store = :redis_session_store, {
-  #       :key          => 'your_session_key',
-  #       :redis        => {
-  #         :db => 2,
-  #         :expire_after => 120.minutes,
-  #         :key_prefix => "myapp:session:",
-  #         :host    => 'host', # Redis host name, default is localhost
-  #         :port    => 12345   # Redis port, default is 6379
-  #       }
+  #       key: 'your_session_key',
+  #       redis: {
+  #         db: 2,
+  #         expire_after: 120.minutes,
+  #         key_prefix: 'myapp:session:',
+  #         host: 'host', # Redis host name, default is localhost
+  #         port: 12345   # Redis port, default is 6379
+  #       },
+  #       on_sid_collision: ->(sid) { logger.warn("SID collision! #{sid}") },
+  #       on_redis_down: ->(*a) { logger.error("Redis down! #{a.inspect}") }
   #     }
   #
   def initialize(app, options = {})
@@ -36,17 +40,33 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
     @default_options.merge!(namespace: 'rack:session')
     @default_options.merge!(redis_options)
     @redis = Redis.new(redis_options)
-    @raise_errors = !options[:raise_errors].nil?
+    @on_sid_collision = options[:on_sid_collision]
+    @on_redis_down = options[:on_redis_down]
   end
 
+  attr_accessor :on_sid_collision, :on_redis_down
+
   private
 
-  attr_reader :redis, :key, :default_options, :raise_errors
+  attr_reader :redis, :key, :default_options
 
   def prefixed(sid)
     "#{default_options[:key_prefix]}#{sid}"
   end
 
+  def generate_sid
+    loop do
+      sid = super
+      break sid unless sid_collision?(sid)
+    end
+  end
+
+  def sid_collision?(sid)
+    !!redis.get(prefixed(sid)).tap do |value| # rubocop: disable DoubleNegation
+      on_sid_collision.call(sid) if value && on_sid_collision
+    end
+  end
+
   def get_session(env, sid)
     unless sid && (session = load_session_from_redis(sid))
       sid = generate_sid
@@ -55,7 +75,7 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
 
     [sid, session]
   rescue Errno::ECONNREFUSED => e
-    raise e if raise_errors
+    on_redis_down.call(e, env, sid) if on_redis_down
     [generate_sid, {}]
   end
 
@@ -73,7 +93,7 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
     end
     return sid
   rescue Errno::ECONNREFUSED => e
-    raise e if raise_errors
+    on_redis_down.call(e, env, sid) if on_redis_down
     return false
   end
 
@@ -84,12 +104,12 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
   end
 
   def destroy(env)
-    if env['rack.request.cookie_hash'] && env['rack.request.cookie_hash'][key]
-      redis.del(prefixed(env['rack.request.cookie_hash'][key]))
+    if env['rack.request.cookie_hash'] &&
+        (sid = env['rack.request.cookie_hash'][key])
+      redis.del(prefixed(sid))
     end
   rescue Errno::ECONNREFUSED => e
-    raise e if raise_errors
-    Rails.logger.warn("RedisSessionStore#destroy: #{e.message}")
+    on_redis_down.call(e, env, sid) if on_redis_down
     false
   end
 end

data/spec/redis_session_store_spec.rb

@@ -135,15 +135,23 @@ describe RedisSessionStore do
     end
 
     context 'when redis is down' do
-      before { store.stub(:redis).and_raise(Errno::ECONNREFUSED) }
+      before do
+        store.stub(:redis).and_raise(Errno::ECONNREFUSED)
+        store.on_redis_down = ->(*a) { @redis_down_handled = true }
+      end
 
       it 'returns false' do
         store.send(:set_session, env, session_id, session_data, options)
           .should eq(false)
       end
 
-      context 'when :raise_errors option is truthy' do
-        let(:options) { { raise_errors: true } }
+      it 'calls the on_redis_down handler' do
+        store.send(:set_session, env, session_id, session_data, options)
+        expect(@redis_down_handled).to be_true
+      end
+
+      context 'when :on_redis_down re-raises' do
+        before { store.on_redis_down = ->(e, *) { fail e } }
 
         it 'explodes' do
           expect do
@@ -160,11 +168,13 @@ describe RedisSessionStore do
         key_prefix: 'customprefix::'
       }
     end
+
     let(:fake_key) { 'thisisarediskey' }
 
     it 'should retrieve the prefixed key from redis' do
       redis = double('redis')
       store.stub(redis: redis)
+      store.stub(generate_sid: fake_key)
       expect(redis).to receive(:get).with("#{options[:key_prefix]}#{fake_key}")
 
       store.send(:get_session, double('env'), fake_key)
@@ -186,8 +196,8 @@ describe RedisSessionStore do
           .to eq('foop')
       end
 
-      context 'when :raise_errors option is truthy' do
-        let(:options) { { raise_errors: true } }
+      context 'when :on_redis_down re-raises' do
+        before { store.on_redis_down = ->(e, *) { fail e } }
 
         it 'explodes' do
           expect do
@@ -224,8 +234,8 @@ describe RedisSessionStore do
           expect(store.send(:destroy, env)).to be_false
         end
 
-        context 'when :raise_errors option is truthy' do
-          let(:options) { { raise_errors: true } }
+        context 'when :on_redis_down re-raises' do
+          before { store.on_redis_down = ->(e, *) { fail e } }
 
           it 'explodes' do
             expect do
@@ -238,13 +248,40 @@ describe RedisSessionStore do
 
     context 'when destroyed via #destroy_session' do
       it 'deletes the prefixed key from redis' do
-        redis = double('redis')
-        sid = store.send(:generate_sid)
+        redis = double('redis', get: nil)
         store.stub(redis: redis)
+        sid = store.send(:generate_sid)
         expect(redis).to receive(:del).with("#{options[:key_prefix]}#{sid}")
 
         store.send(:destroy_session, {}, sid, nil)
       end
     end
   end
+
+  describe 'generating a sid' do
+    before { store.on_sid_collision = ->(sid) { @sid = sid } }
+
+    context 'when the generated sid is unique' do
+      before do
+        redis = double('redis', get: nil)
+        store.stub(redis: redis)
+      end
+
+      it 'returns the sid' do
+        expect(store.send(:generate_sid)).to_not be_nil
+      end
+    end
+
+    context 'when there is a generated sid collision' do
+      before do
+        redis = double('redis', get: 'herp a derp')
+        store.stub(redis: redis)
+      end
+
+      it 'passes the colliding sid to the collision handler' do
+        store.send(:sid_collision?, 'whatever')
+        expect(@sid).to eql('whatever')
+      end
+    end
+  end
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: redis-session-store
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Mathias Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   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: fakeredis
   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: rake
   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: rspec
   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: rubocop
   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: simplecov
   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: A drop-in replacement for e.g. MemCacheStore to store Rails sessions
@@ -105,12 +105,13 @@ extra_rdoc_files:
 - AUTHORS.md
 - CONTRIBUTING.md
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .simplecov
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
 - AUTHORS.md
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -131,17 +132,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and