redis-session-store 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4d846842edbd5ebc0a653e24f80ca303150c390
-  data.tar.gz: be0006a20a902ca97e52e6907b90c9a1dfa22bdb
+  metadata.gz: 43c209eb4dbc6cc3feedd7138dcc6cfbb6e4be35
+  data.tar.gz: e29f05d4800a9bf8453ad3f24504295d5fd21408
 SHA512:
-  metadata.gz: fa7412de4681ecc8646093aaa4920ae8b4b5683a814cbf9ef73d04003995aefa2c2f8a64371cc73c496dbe517b49b9b934cb6b9975cc754ba40403db82a3a0ca
-  data.tar.gz: d250e8895eed17ad83493c0bcab9c92c05c6ca92e88f41f05ae11f06c7c97e51923d39ea1e6b017554453885f8111166ec025b6be4875b3611813f4a8e410a0b
+  metadata.gz: 91de3d098790b0d015bb463ecf28a21d5b84ba1eee2d7a2e8b2b6646231e6265b2c1933d99e825aa0ac8fa03945409b5b3ef03429e1d1599d8239f471f2ce1f0
+  data.tar.gz: 5797ce680e25ccb54e48cb4b5e2720be2287e7facedec7c28940b54a7f8fb1aa1bac91553797a01a02176650058032c3708e89b53b3d8506511472667620f7b7

data/.rubocop.yml

@@ -1,15 +1,7 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-03-13 18:57:37 -0400 using RuboCop version 0.19.0.
-# 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.
+inherit_from: .rubocop_todo.yml
 
-# Offense count: 1
 FileName:
   Enabled: false
 
-# Offense count: 1
-# Configuration parameters: CountComments.
-ClassLength:
-  Max: 110
+DoubleNegation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-08-28 08:17:48 -0400 using RuboCop version 0.25.0.
+# 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: 101

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 redis-session-store history
 ===========================
 
+## v0.8.0 (2014-08-28)
+
+* Allow for injection of custom redis client
+* Explicitly declare actionpack dependency
+* Spec updates for rspec 3
+
 ## v0.7.0 (2014-04-22)
 
 * Fix issue #38, we now delay writing to redis until a session exists. This is

data/Gemfile

@@ -1,3 +1,4 @@
+# vim:fileencoding=utf-8
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -18,12 +18,12 @@ see fit.
 This library doesn't offer anything related to caching, and is
 only suitable for Rails applications. For other frameworks or
 drop-in support for caching, check out
-[redis-store](http://github.com/jodosha/redis-store/)
+[redis-store](http://github.com/jodosha/redis-store/).
 
 Installation
 ------------
 
-For Rails 3+, adding this to your Gemfile will do the trick.
+For Rails 3+, adding this to your `Gemfile` will do the trick.
 
 ``` ruby
 gem 'redis-session-store'
@@ -57,6 +57,9 @@ callable handler may be provided as `on_redis_down`:
 My::Application.config.session_store :redis_session_store, {
   # ... other options ...
   on_redis_down: ->(e, env, sid) { do_something_will_ya!(e) }
+  redis: {
+    # ... redis options ...
+  }
 }
 ```
 
@@ -74,11 +77,14 @@ custom serializer:
 My::Application.config.session_store :redis_session_store, {
   # ... other options ...
   serializer: :hybrid
+  redis: {
+    # ... redis options ...
+  }
 }
 ```
 
 **Note**: Rails 4 is required for using the `:json` and `:hybrid` serializers
-because the `Flash` object doesn't serializer well in 3.2. See [Rails #13945](https://github.com/rails/rails/pull/13945) for more info.
+because the `Flash` object doesn't serialize well in 3.2. See [Rails #13945](https://github.com/rails/rails/pull/13945) for more info.
 
 ### Session load error handling
 
@@ -90,6 +96,9 @@ will be given the error and the session ID.
 My::Application.config.session_store :redis_session_store, {
   # ... other options ...
   on_session_load_error: ->(e, sid) { do_something_will_ya!(e) }
+  redis: {
+    # ... redis options ...
+  }
 }
 ```
 

data/Rakefile

@@ -1,3 +1,4 @@
+# vim:fileencoding=utf-8
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -12,4 +13,4 @@ task :coverage do
   Rake::Task['spec'].invoke
 end
 
-Rubocop::RakeTask.new
+RuboCop::RakeTask.new

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.7.0'
+  VERSION = '0.8.0'
   # Rails 3.1 and beyond defines the constant elsewhere
   unless defined?(ENV_SESSION_OPTIONS_KEY)
     ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
@@ -18,6 +18,7 @@ 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
+  #   * +:client+ - Connect to Redis with given object rather than create one
   # * +:on_redis_down:+ - Called with err, env, and SID on Errno::ECONNREFUSED
   # * +:on_session_load_error:+ - Called with err and SID on Marshal.load fail
   # * +:serializer:+ - Serializer to use on session data, default is :marshal.
@@ -44,7 +45,7 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
 
     @default_options.merge!(namespace: 'rack:session')
     @default_options.merge!(redis_options)
-    @redis = Redis.new(redis_options)
+    @redis = redis_options[:client] || Redis.new(redis_options)
     @on_redis_down = options[:on_redis_down]
     @serializer = determine_serializer(options[:serializer])
     @on_session_load_error = options[:on_session_load_error]
@@ -64,8 +65,10 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
   def session_exists?(env)
     value = current_session_id(env)
 
-    value && !value.empty? &&
-      redis.exists(prefixed(value)) # new behavior
+    !!(
+      value && !value.empty? &&
+      redis.exists(prefixed(value))
+    )
   rescue Errno::ECONNREFUSED => e
     on_redis_down.call(e, env, value) if on_redis_down
 
@@ -74,9 +77,9 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
 
   def verify_handlers!
     %w(on_redis_down on_session_load_error).each do |h|
-      if (handler = public_send(h)) && !handler.respond_to?(:call)
-        fail ArgumentError, "#{h} handler is not callable"
-      end
+      next unless (handler = public_send(h)) && !handler.respond_to?(:call)
+
+      fail ArgumentError, "#{h} handler is not callable"
     end
   end
 

data/redis-session-store.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.name = 'redis-session-store'
   gem.authors = ['Mathias Meyer']
   gem.email = ['meyer@paperplanes.de']
-  gem.summary = 'A drop-in replacement for e.g. MemCacheStore to ' <<
+  gem.summary = 'A drop-in replacement for e.g. MemCacheStore to ' \
                 'store Rails sessions (and Rails sessions only) in Redis.'
   gem.description = gem.summary
   gem.homepage = 'https://github.com/roidrage/redis-session-store'
@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
                 .match(/^  VERSION = '(.*)'/)[1]
 
   gem.add_runtime_dependency 'redis'
+  gem.add_runtime_dependency 'actionpack', '>= 3', '< 5'
 
   gem.add_development_dependency 'fakeredis'
   gem.add_development_dependency 'rake'

data/spec/redis_session_store_spec.rb

@@ -17,7 +17,7 @@ describe RedisSessionStore do
   end
 
   it 'assigns a :namespace to @default_options' do
-    default_options[:namespace].should == 'rack:session'
+    expect(default_options[:namespace]).to eq('rack:session')
   end
 
   describe 'when initializing with the redis sub-hash options' do
@@ -36,27 +36,27 @@ describe RedisSessionStore do
     end
 
     it 'creates a redis instance' do
-      store.instance_variable_get(:@redis).should_not be_nil
+      expect(store.instance_variable_get(:@redis)).to_not be_nil
     end
 
     it 'assigns the :host option to @default_options' do
-      default_options[:host].should == 'hosty.local'
+      expect(default_options[:host]).to eq('hosty.local')
     end
 
     it 'assigns the :port option to @default_options' do
-      default_options[:port].should == 16_379
+      expect(default_options[:port]).to eq(16_379)
     end
 
     it 'assigns the :db option to @default_options' do
-      default_options[:db].should == 2
+      expect(default_options[:db]).to eq(2)
     end
 
     it 'assigns the :key_prefix option to @default_options' do
-      default_options[:key_prefix].should == 'myapp:session:'
+      expect(default_options[:key_prefix]).to eq('myapp:session:')
     end
 
     it 'assigns the :expire_after option to @default_options' do
-      default_options[:expire_after].should == 60 * 120
+      expect(default_options[:expire_after]).to eq(60 * 120)
     end
   end
 
@@ -74,27 +74,59 @@ describe RedisSessionStore do
     end
 
     it 'creates a redis instance' do
-      store.instance_variable_get(:@redis).should_not be_nil
+      expect(store.instance_variable_get(:@redis)).to_not be_nil
     end
 
     it 'assigns the :host option to @default_options' do
-      default_options[:host].should == 'hostersons.local'
+      expect(default_options[:host]).to eq('hostersons.local')
     end
 
     it 'assigns the :port option to @default_options' do
-      default_options[:port].should == 26_379
+      expect(default_options[:port]).to eq(26_379)
     end
 
     it 'assigns the :db option to @default_options' do
-      default_options[:db].should == 4
+      expect(default_options[:db]).to eq(4)
     end
 
     it 'assigns the :key_prefix option to @default_options' do
-      default_options[:key_prefix].should == 'appydoo:session:'
+      expect(default_options[:key_prefix]).to eq('appydoo:session:')
     end
 
     it 'assigns the :expire_after option to @default_options' do
-      default_options[:expire_after].should == 60 * 60
+      expect(default_options[:expire_after]).to eq(60 * 60)
+    end
+  end
+
+  describe 'when initializing with existing redis object' do
+    let :options do
+      {
+        key: random_string,
+        secret: random_string,
+        redis: {
+          client: redis_client,
+          key_prefix: 'myapp:session:',
+          expire_after: 60 * 30
+        }
+      }
+    end
+
+    let(:redis_client) { double('redis_client') }
+
+    it 'assigns given redis object to @redis' do
+      expect(store.instance_variable_get(:@redis)).to be(redis_client)
+    end
+
+    it 'assigns the :client option to @default_options' do
+      expect(default_options[:client]).to be(redis_client)
+    end
+
+    it 'assigns the :key_prefix option to @default_options' do
+      expect(default_options[:key_prefix]).to eq('myapp:session:')
+    end
+
+    it 'assigns the :expire_after option to @default_options' do
+      expect(default_options[:expire_after]).to eq(60 * 30)
     end
   end
 
@@ -110,19 +142,19 @@ describe RedisSessionStore do
 
     context 'when successfully persisting the session' do
       it 'returns the session id' do
-        store.send(:set_session, env, session_id, session_data, options)
-          .should eq(session_id)
+        expect(store.send(:set_session, env, session_id, session_data, options))
+          .to eq(session_id)
       end
     end
 
     context 'when unsuccessfully persisting the session' do
       before do
-        store.stub(:redis).and_raise(Errno::ECONNREFUSED)
+        allow(store).to receive(:redis).and_raise(Errno::ECONNREFUSED)
       end
 
       it 'returns false' do
-        store.send(:set_session, env, session_id, session_data, options)
-          .should eq(false)
+        expect(store.send(:set_session, env, session_id, session_data, options))
+          .to eq(false)
       end
     end
 
@@ -130,25 +162,25 @@ describe RedisSessionStore do
       let(:options) { {} }
 
       it 'sets the session value without expiry' do
-        store.send(:set_session, env, session_id, session_data, options)
-          .should eq(session_id)
+        expect(store.send(:set_session, env, session_id, session_data, options))
+          .to eq(session_id)
       end
     end
 
     context 'when redis is down' do
       before do
-        store.stub(:redis).and_raise(Errno::ECONNREFUSED)
-        store.on_redis_down = ->(*a) { @redis_down_handled = true }
+        allow(store).to receive(: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)
+        expect(store.send(:set_session, env, session_id, session_data, options))
+          .to eq(false)
       end
 
       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
+        expect(@redis_down_handled).to eq(true)
       end
 
       context 'when :on_redis_down re-raises' do
@@ -167,47 +199,52 @@ describe RedisSessionStore do
     let(:session_id) { 'foo' }
 
     before do
-      store.stub(:current_session_id).with(:env).and_return(session_id)
+      allow(store).to receive(:current_session_id)
+        .with(:env).and_return(session_id)
     end
 
     context 'when session id is not provided' do
       context 'when session id is nil' do
         let(:session_id) { nil }
-        it 'should return false' do
-          store.send(:session_exists?, :env).should be_false
+        it 'returns false' do
+          expect(store.send(:session_exists?, :env)).to eq(false)
         end
       end
 
       context 'when session id is empty string' do
         let(:session_id) { '' }
-        it 'should return false' do
-          store.stub(:current_session_id).with(:env).and_return('')
-          store.send(:session_exists?, :env).should be_false
+        it 'returns false' do
+          allow(store).to receive(:current_session_id).with(:env).and_return('')
+          expect(store.send(:session_exists?, :env)).to eq(false)
         end
       end
     end
 
     context 'when session id is provided' do
-      let(:redis) { double('redis').tap { |o| store.stub(redis: o) } }
+      let(:redis) do
+        double('redis').tap do |o|
+          allow(store).to receive(:redis).and_return(o)
+        end
+      end
 
       context 'when session id does not exist in redis' do
-        it 'should return false' do
-          redis.should_receive(:exists).with('foo').and_return(false)
-          store.send(:session_exists?, :env).should be_false
+        it 'returns false' do
+          expect(redis).to receive(:exists).with('foo').and_return(false)
+          expect(store.send(:session_exists?, :env)).to eq(false)
         end
       end
 
       context 'when session id exists in redis' do
-        it 'should return true' do
-          redis.should_receive(:exists).with('foo').and_return(true)
-          store.send(:session_exists?, :env).should be_true
+        it 'returns true' do
+          expect(redis).to receive(:exists).with('foo').and_return(true)
+          expect(store.send(:session_exists?, :env)).to eq(true)
         end
       end
 
       context 'when redis is down' do
-        it 'should return true (fallback to old behavior)' do
-          store.stub(:redis).and_raise(Errno::ECONNREFUSED)
-          store.send(:session_exists?, :env).should be_true
+        it 'returns true (fallback to old behavior)' do
+          allow(store).to receive(:redis).and_raise(Errno::ECONNREFUSED)
+          expect(store.send(:session_exists?, :env)).to eq(true)
         end
       end
     end
@@ -222,10 +259,10 @@ describe RedisSessionStore do
 
     let(:fake_key) { 'thisisarediskey' }
 
-    it 'should retrieve the prefixed key from redis' do
+    it 'retrieves the prefixed key from redis' do
       redis = double('redis')
-      store.stub(redis: redis)
-      store.stub(generate_sid: fake_key)
+      allow(store).to receive(:redis).and_return(redis)
+      allow(store).to receive(:generate_sid).and_return(fake_key)
       expect(redis).to receive(:get).with("#{options[:key_prefix]}#{fake_key}")
 
       store.send(:get_session, double('env'), fake_key)
@@ -233,8 +270,8 @@ describe RedisSessionStore do
 
     context 'when redis is down' do
       before do
-        store.stub(:redis).and_raise(Errno::ECONNREFUSED)
-        store.stub(generate_sid: 'foop')
+        allow(store).to receive(:redis).and_raise(Errno::ECONNREFUSED)
+        allow(store).to receive(:generate_sid).and_return('foop')
       end
 
       it 'returns an empty session hash' do
@@ -266,12 +303,12 @@ describe RedisSessionStore do
       let(:fake_key) { 'thisisarediskey' }
 
       before do
-        cookie_hash.stub(:[] => fake_key)
+        allow(cookie_hash).to receive(:[]).and_return(fake_key)
       end
 
       it 'deletes the prefixed key from redis' do
         redis = double('redis')
-        store.stub(redis: redis)
+        allow(store).to receive(:redis).and_return(redis)
         expect(redis).to receive(:del)
           .with("#{options[:key_prefix]}#{fake_key}")
 
@@ -279,10 +316,12 @@ describe RedisSessionStore do
       end
 
       context 'when redis is down' do
-        before { store.stub(:redis).and_raise(Errno::ECONNREFUSED) }
+        before do
+          allow(store).to receive(:redis).and_raise(Errno::ECONNREFUSED)
+        end
 
-        it 'should return false' do
-          expect(store.send(:destroy, env)).to be_false
+        it 'returns false' do
+          expect(store.send(:destroy, env)).to eq(false)
         end
 
         context 'when :on_redis_down re-raises' do
@@ -300,7 +339,7 @@ describe RedisSessionStore do
     context 'when destroyed via #destroy_session' do
       it 'deletes the prefixed key from redis' do
         redis = double('redis', setnx: true)
-        store.stub(redis: redis)
+        allow(store).to receive(:redis).and_return(redis)
         sid = store.send(:generate_sid)
         expect(redis).to receive(:del).with("#{options[:key_prefix]}#{sid}")
 
@@ -319,12 +358,12 @@ describe RedisSessionStore do
     let(:expected_encoding) { encoded_data }
 
     before do
-      store.stub(:redis).and_return(redis)
+      allow(store).to receive(:redis).and_return(redis)
     end
 
     shared_examples_for 'serializer' do
       it 'encodes correctly' do
-        redis.should_receive(:set).with('12345', expected_encoding)
+        expect(redis).to receive(:set).with('12345', expected_encoding)
         store.send(:set_session, env, session_id, session_data, options)
       end
 
@@ -364,11 +403,11 @@ describe RedisSessionStore do
     context 'custom' do
       let :custom_serializer do
         Class.new do
-          def self.load(value)
+          def self.load(_value)
             { 'some' => 'data' }
           end
 
-          def self.dump(value)
+          def self.dump(_value)
             'somedata'
           end
         end
@@ -384,10 +423,10 @@ describe RedisSessionStore do
   describe 'handling decode errors' do
     context 'when a class is serialized that does not exist' do
       before do
-        store.stub(
-          redis: double('redis', get: "\x04\bo:\nNonExistentClass\x00",
-                                 del: true)
-        )
+        allow(store).to receive(:redis)
+          .and_return(double('redis',
+                             get: "\x04\bo:\nNonExistentClass\x00",
+                             del: true))
       end
 
       it 'returns an empty session' do
@@ -395,7 +434,8 @@ describe RedisSessionStore do
       end
 
       it 'destroys and drops the session' do
-        store.should_receive(:destroy_session_from_sid).with('wut', drop: true)
+        expect(store).to receive(:destroy_session_from_sid)
+          .with('wut', drop: true)
         store.send(:load_session_from_redis, 'wut')
       end
 
@@ -410,16 +450,15 @@ describe RedisSessionStore do
         it 'passes the error and the sid to the handler' do
           store.send(:load_session_from_redis, 'foo')
           expect(@e).to be_kind_of(StandardError)
-          expect(@sid).to eql('foo')
+          expect(@sid).to eq('foo')
         end
       end
     end
 
     context 'when the encoded data is invalid' do
       before do
-        store.stub(
-          redis: double('redis', get: "\x00\x00\x00\x00", del: true)
-        )
+        allow(store).to receive(:redis)
+          .and_return(double('redis', get: "\x00\x00\x00\x00", del: true))
       end
 
       it 'returns an empty session' do
@@ -427,7 +466,8 @@ describe RedisSessionStore do
       end
 
       it 'destroys and drops the session' do
-        store.should_receive(:destroy_session_from_sid).with('wut', drop: true)
+        expect(store).to receive(:destroy_session_from_sid)
+          .with('wut', drop: true)
         store.send(:load_session_from_redis, 'wut')
       end
 
@@ -442,7 +482,7 @@ describe RedisSessionStore do
         it 'passes the error and the sid to the handler' do
           store.send(:load_session_from_redis, 'foo')
           expect(@e).to be_kind_of(StandardError)
-          expect(@sid).to eql('foo')
+          expect(@sid).to eq('foo')
         end
       end
     end
@@ -478,7 +518,7 @@ describe RedisSessionStore do
     it 'allows changing the session' do
       env = { 'rack.session.options' => {} }
       sid = 1234
-      store.stub(:redis).and_return(Redis.new)
+      allow(store).to receive(:redis).and_return(Redis.new)
       data1 = { 'foo' => 'bar' }
       store.send(:set_session, env, sid, data1)
       data2 = { 'baz' => 'wat' }
@@ -490,7 +530,7 @@ describe RedisSessionStore do
     it 'allows changing the session when the session has an expiry' do
       env = { 'rack.session.options' => { expire_after: 60 } }
       sid = 1234
-      store.stub(:redis).and_return(Redis.new)
+      allow(store).to receive(:redis).and_return(Redis.new)
       data1 = { 'foo' => 'bar' }
       store.send(:set_session, env, sid, data1)
       data2 = { 'baz' => 'wat' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-session-store
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mathias Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,6 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        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'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +128,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".simplecov"
 - ".travis.yml"
 - AUTHORS.md
@@ -148,4 +169,3 @@ specification_version: 4
 summary: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and
   Rails sessions only) in Redis.
 test_files: []
-has_rdoc: true