redis-session-store 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: add0c6376d9ff344003c7d062c3844bbe2400037
-  data.tar.gz: 7cd9506424bad86542695fc97f4072d91703ab0c
+  metadata.gz: e8c01a4bd8ba08bf7a390925f4dc40f8b9c008d6
+  data.tar.gz: 91efb335e55ba86ee01476a74ab4ed0217b48e85
 SHA512:
-  metadata.gz: 0c3cb9bde3e6cc1b979575615b91a19870c4570d3cc2d543f9d38120574f4275df6eab9fdac52779d5a8ec9432e8b95e3f58642c9f1266d27ff442fab915634e
-  data.tar.gz: 7dc45a9772b50b2b9ee73faa38ea34ae4784f979966d8a034be9a5193c5f34a904f3862563f09894f76bcc172d2534411bc80af6f1ffe795ed453229031a1163
+  metadata.gz: cfb8578cfa2a62b70bf4f79ea3574e26c82b5e439d9df7ea3097f6d4bea98543e10590daf2ecc484922feb5868a409af47d5126a768c4f67ba392771837f144f
+  data.tar.gz: 1b369cf1663b3ba9a581fc0557541b53546762726086ffa0a799d8fd582a45b4c0b73cfd7ee92f50ec74a90f104155422170ab83007c7f15103daf1a8a712dda

data/.rubocop.yml

@@ -1,18 +1 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-02-07 09:24:00 -0500 using RuboCop version 0.18.0.
-# The point is for the user to remove these configuration records
-# one by one as the offences 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.
-
-Documentation:
-  Enabled: false
-
-# Offence count: 6
-LineLength:
-  Max: 124
-
-# Offence count: 2
-# Configuration parameters: CountComments.
-MethodLength:
-  Max: 12
+---

data/lib/redis-session-store.rb

@@ -3,19 +3,31 @@ require 'redis'
 
 # Redis session storage for Rails, and for Rails only. Derived from
 # the MemCacheStore code, simply dropping in Redis instead.
-#
-# Options:
-#  :key     => Same as with the other cookie stores, key name
-#  :redis => {
-#    :host    => Redis host name, default is localhost
-#    :port    => Redis port, default is 6379
-#    :db      => Database number, defaults to 0. Useful to separate your session storage from other data
-#    :key_prefix  => Prefix for keys used in Redis, e.g. myapp-. Useful to separate session storage keys visibly from others
-#    :expire_after => A number in seconds to set the timeout interval for the session. Will map directly to expiry in Redis
-#  }
 class RedisSessionStore < ActionDispatch::Session::AbstractStore
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 
+  # ==== Options
+  # * +:key+ - Same as with the other cookie stores, key name
+  # * +:redis+ - A hash with redis-specific options
+  #   * +:host+ - Redis host name, default is localhost
+  #   * +:port+ - Redis port, default is 6379
+  #   * +: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
+  #
+  # ==== 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
+  #       }
+  #     }
+  #
   def initialize(app, options = {})
     super
 
@@ -57,13 +69,19 @@ class RedisSessionStore < ActionDispatch::Session::AbstractStore
     return false
   end
 
+  def destroy_session(env, sid, options)
+    redis.del(prefixed(sid))
+    generate_sid
+  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]))
     end
   rescue Errno::ECONNREFUSED
     if defined?(Rails)
-      Rails.logger.warn('RedisSessionStore#destroy: Connection to redis refused')
+      Rails.logger.warn('RedisSessionStore#destroy: ' <<
+                        'Connection to redis refused')
     else
       warn('RedisSessionStore#destroy: Connection to redis refused')
     end

data/redis-session-store.gemspec

@@ -1,12 +1,11 @@
 # vim:fileencoding=utf-8
-require 'English'
 
 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 ' <<
-                     'store Rails sessions (and Rails sessions only) in Redis.'
+                'store Rails sessions (and Rails sessions only) in Redis.'
   gem.description = gem.summary
   gem.homepage = 'https://github.com/roidrage/redis-session-store'
   gem.license = 'MIT'
@@ -14,8 +13,8 @@ Gem::Specification.new do |gem|
   gem.has_rdoc = true
   gem.extra_rdoc_files = %w(LICENSE AUTHORS.md CONTRIBUTING.md)
 
-  gem.files = `git ls-files`.split($RS)
-  gem.require_paths = ['lib']
+  gem.files = `git ls-files -z`.split("\x0")
+  gem.require_paths = %w(lib)
   gem.version = File.read('lib/redis-session-store.rb')
                 .match(/^  VERSION = '(.*)'/)[1]
 

data/spec/fake_action_dispatch_session_abstract_store.rb

@@ -1,23 +1,31 @@
 # vim:fileencoding=utf-8
 
 unless defined?(ActionDispatch::Session::AbstractStore)
-  module ActionDispatch
+  module ActionDispatch # rubocop:disable Documentation
     module Session
       class AbstractStore
+        DEFAULT_OPTIONS = {
+          key: '_session_id',
+          path: '/',
+          domain: nil,
+          expire_after: nil,
+          secure: false,
+          httponly: true,
+          cookie_only: true
+        }.freeze
+
         def initialize(app, options = {})
           @app = app
-          @default_options = {
-            key: '_session_id',
-            path: '/',
-            domain: nil,
-            expire_after: nil,
-            secure: false,
-            httponly: true,
-            cookie_only: true
-          }.merge(options)
+          @default_options = DEFAULT_OPTIONS.dup.merge(options)
           @key = @default_options[:key]
           @cookie_only = @default_options[:cookie_only]
         end
+
+        private
+
+        def generate_sid
+          rand(999..9999).to_s(16)
+        end
       end
     end
   end

data/spec/redis_session_store_spec.rb

@@ -98,8 +98,9 @@ describe RedisSessionStore do
   end
 
   describe 'rack 1.45 compatibility' do
-    # Rack 1.45 (which Rails 3.2.x depends on) uses the return value of set_session to set the cookie value
-    # See https://github.com/rack/rack/blob/1.4.5/lib/rack/session/abstract/id.rb
+    # Rack 1.45 (which Rails 3.2.x depends on) uses the return value of
+    # set_session to set the cookie value.  See:
+    # https://github.com/rack/rack/blob/1.4.5/lib/rack/session/abstract/id.rb
 
     let(:env)          { double('env') }
     let(:session_id)   { 12_345 }
@@ -109,7 +110,8 @@ 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)
+        store.send(:set_session, env, session_id, session_data, options)
+          .should eq(session_id)
       end
 
     end
@@ -120,7 +122,8 @@ describe RedisSessionStore do
       end
 
       it 'returns false' do
-        store.send(:set_session, env, session_id, session_data, options).should eq(false)
+        store.send(:set_session, env, session_id, session_data, options)
+          .should eq(false)
       end
     end
 
@@ -147,7 +150,8 @@ describe RedisSessionStore do
       it 'should return an empty session hash' do
         store.stub(:redis).and_raise(Errno::ECONNREFUSED)
 
-        expect(store.send(:get_session, double('env'), fake_key)).to eq([fake_key, {}])
+        expect(store.send(:get_session, double('env'), fake_key))
+          .to eq([fake_key, {}])
       end
     end
   end
@@ -162,15 +166,25 @@ describe RedisSessionStore do
         cookie_hash.stub(:[] => fake_key)
       end
 
-      it 'should delete the prefixed key from redis' do
+      it 'deletes the prefixed key from redis' do
         redis = double('redis')
         store.stub(redis: redis)
-        expect(redis).to receive(:del).with("#{options[:key_prefix]}#{fake_key}")
+        expect(redis).to receive(:del)
+          .with("#{options[:key_prefix]}#{fake_key}")
 
         store.send(:destroy, env)
       end
-
     end
 
+    context 'when destroyed via #destroy_session' do
+      it 'deletes the prefixed key from redis' do
+        redis = double('redis')
+        sid = store.send(:generate_sid)
+        store.stub(redis: redis)
+        expect(redis).to receive(:del).with("#{options[:key_prefix]}#{sid}")
+
+        store.send(:destroy_session, {}, sid, nil)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-session-store
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mathias Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis