redis-session-store 0.1.9 → 0.2.0

data/AUTHORS.md

@@ -0,0 +1,12 @@
+Redis Session Store authors
+===========================
+
+- Ben Marini
+- Dan Buch
+- Donald Plummer
+- Edwin Cruz
+- Gonçalo Silva
+- Jorge Pardiñas
+- Mathias Meyer
+- Michael Fields
+- Tim Lossen

data/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+Redis Session Store contribution guidelines
+===========================================
+
+- Pull requests welcome!
+- Please add yourself to the [AUTHORS.md](AUTHORS.md) file
+alphabetically by first name.

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-session-store.gemspec
+gemspec
+
+gem 'rake', :group => :test
+gem 'minitest', :group => :test, :platform => :ruby_18

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Mathias Meyer
+Copyright (c) 2013 Mathias Meyer
 
 MIT License
 

data/README.md

@@ -1,12 +1,15 @@
-A simple Redis-based session store for Redis. But why, you ask,
+Redis Session Store
+===================
+
+A simple Redis-based session store for Rails.  But why, you ask,
 when there's [redis-store](http://github.com/jodosha/redis-store/)?
-redis-store is a one-fits-all solution, and I found it not to work
+redis-store is a one-size-fits-all solution, and I found it not to work
 properly with Rails, mostly due to a problem that seemed to lie in
-Rack's Abstract::ID class. I wanted something that worked, so I
-blatantly stole the code from Rails' MemCacheStore and turned it
+Rack's `Abstract::ID` class. I wanted something that worked, so I
+blatantly stole the code from Rails' `MemCacheStore` and turned it
 into a Redis version. No support for fancy stuff like distributed
 storage across several Redis instances. Feel free to add what you
-seem fit.
+see fit.
 
 This library doesn't offer anything related to caching, and is
 only suitable for Rails applications. For other frameworks or
@@ -14,29 +17,40 @@ drop-in support for caching, check out
 [redis-store](http://github.com/jodosha/redis-store/)
 
 Installation
-============
+------------
 
-    gem install redis-session-store
+``` bash
+gem install redis-session-store
+```
 
 Configuration
-=============
+-------------
 
-See lib/redis-session-store.rb for a list of valid options.
+See `lib/redis-session-store.rb` for a list of valid options.
 Set them using:
 
-    ActionController::Base.session = {
-      :db => 2,
-      :expire_after => 120.minutes,
-      :key_prefix => "myapp:session:"
-    }
+``` ruby
+ActionController::Base.session = {
+  :key          => 'your_session_key',
+  :secret       => 'your_long_secret',
+  :redis        => {
+    :db => 2,
+    :expire_after => 120.minutes,
+    :key_prefix => "myapp:session:"
+  }
+}
+```
     
 
 In your Rails app, throw in an initializer with the following contents
 and the configuration above:
 
-    ActionController::Base.session_store = RedisSessionStore
+``` ruby
+ActionController::Base.session_store = RedisSessionStore
+```
 
-Changes
-=======
+Contributing, Authors, & License
+--------------------------------
 
-* Use setex for a single command instead of sending two commands. (Thanks dplummer)
+See [CONTRIBUTING.md](CONTRIBUTING.md), [AUTHORS.md](AUTHORS.md), and
+[LICENSE](LICENSE), respectively.

data/Rakefile

@@ -1,2 +1,11 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.options = '-v'
+end

data/lib/redis-session-store.rb

@@ -6,22 +6,23 @@ require 'redis'
 # Options:
 #  :key     => Same as with the other cookie stores, key name
 #  :secret  => Encryption secret for the key
-#  :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
-
+#  :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 < ActionController::Session::AbstractStore
 
   def initialize(app, options = {})
     super
 
-    @default_options = {
-      :namespace => 'rack:session'
-    }.merge(options)
+    redis_options = options[:redis] || {}
 
-    @redis = Redis.new(@default_options)
+    @default_options.merge!(:namespace => 'rack:session')
+    @default_options.merge!(redis_options)
+    @redis = Redis.new(redis_options)
   end
 
   private
@@ -52,4 +53,12 @@ class RedisSessionStore < ActionController::Session::AbstractStore
     rescue Errno::ECONNREFUSED
       return false
     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
+      Rails.logger.warn("RedisSessionStore#destroy: Connection to redis refused")
+    end
 end

data/test/fake_action_controller_session_abstract_store.rb

@@ -0,0 +1,22 @@
+unless defined?(ActionController::Session::AbstractStore)
+  module ActionController
+    module Session
+      class AbstractStore
+        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)
+          @key = @default_options[:key]
+          @cookie_only = @default_options[:cookie_only]
+        end
+      end
+    end
+  end
+end

data/test/redis_session_store_test.rb

@@ -0,0 +1,103 @@
+require 'minitest/autorun'
+require File.expand_path('../fake_action_controller_session_abstract_store', __FILE__)
+require 'redis-session-store'
+
+describe RedisSessionStore do
+  def random_string
+    "#{rand}#{rand}#{rand}"
+  end
+
+  def options
+    {}
+  end
+
+  def store
+    RedisSessionStore.new(nil, options)
+  end
+
+  def default_options
+    store.instance_variable_get(:@default_options)
+  end
+
+  it 'assigns a :namespace to @default_options' do
+    default_options[:namespace].must_equal 'rack:session'
+  end
+
+  describe 'when initializing with the redis sub-hash options' do
+    def options
+      {
+        :key => random_string,
+        :secret => random_string,
+        :redis => {
+          :host => 'hosty.local',
+          :port => 16379,
+          :db => 2,
+          :key_prefix => 'myapp:session:',
+          :expire_after => 60 * 120
+        }
+      }
+    end
+
+    it 'creates a redis instance' do
+      store.instance_variable_get(:@redis).wont_equal nil
+    end
+
+    it 'assigns the :host option to @default_options' do
+      default_options[:host].must_equal 'hosty.local'
+    end
+
+    it 'assigns the :port option to @default_options' do
+      default_options[:port].must_equal 16379
+    end
+
+    it 'assigns the :db option to @default_options' do
+      default_options[:db].must_equal 2
+    end
+
+    it 'assigns the :key_prefix option to @default_options' do
+      default_options[:key_prefix].must_equal 'myapp:session:'
+    end
+
+    it 'assigns the :expire_after option to @default_options' do
+      default_options[:expire_after].must_equal 60 * 120
+    end
+  end
+
+  describe 'when initializing with top-level redis options' do
+    def options
+      {
+        :key => random_string,
+        :secret => random_string,
+        :host => 'hostersons.local',
+        :port => 26379,
+        :db => 4,
+        :key_prefix => 'appydoo:session:',
+        :expire_after => 60 * 60
+      }
+    end
+
+    it 'creates a redis instance' do
+      store.instance_variable_get(:@redis).wont_equal nil
+    end
+
+    it 'assigns the :host option to @default_options' do
+      default_options[:host].must_equal 'hostersons.local'
+    end
+
+    it 'assigns the :port option to @default_options' do
+      default_options[:port].must_equal 26379
+    end
+
+    it 'assigns the :db option to @default_options' do
+      default_options[:db].must_equal 4
+    end
+
+    it 'assigns the :key_prefix option to @default_options' do
+      default_options[:key_prefix].must_equal 'appydoo:session:'
+    end
+
+    it 'assigns the :expire_after option to @default_options' do
+      default_options[:expire_after].must_equal 60 * 60
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-session-store
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2013-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70198775254380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198775254380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A drop-in replacement for e.g. MemCacheStore to store Rails sessions
   (and Rails sessions only) in Redis.
 email:
@@ -30,12 +35,19 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
+- AUTHORS.md
+- CONTRIBUTING.md
 files:
+- AUTHORS.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/redis-session-store.rb
-- LICENSE
-homepage: http://github.com/mattmatt/redis-session-store
+- test/fake_action_controller_session_abstract_store.rb
+- test/redis_session_store_test.rb
+homepage: https://github.com/roidrage/redis-session-store
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -47,18 +59,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3400927729934589322
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3400927729934589322
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and
   Rails sessions only) in Redis.
 test_files: []
-has_rdoc: true