redis-session-store 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e789857c8192df4657d8e3f853d863c82e47931
-  data.tar.gz: cbc1244aac8ddaa92a9248e070499d3a1aa17ba8
+  metadata.gz: add0c6376d9ff344003c7d062c3844bbe2400037
+  data.tar.gz: 7cd9506424bad86542695fc97f4072d91703ab0c
 SHA512:
-  metadata.gz: b71a5a59e1522f06578b476e2b82503f86b66f2996a06a22ecb565fd2b9376d64c3bffe04d841f956152ded974bdfd8f9fbaad1bf1547b1ec29f634fb5906888
-  data.tar.gz: 5ceadbf4b2c47cabe2b23960d60c0ab258459428cc9cecdc91277b525e22a50cebcde50e48463c0ebb3c5c24c27adf19d39d51ca1ecb4c3acf90014b52e50e02
+  metadata.gz: 0c3cb9bde3e6cc1b979575615b91a19870c4570d3cc2d543f9d38120574f4275df6eab9fdac52779d5a8ec9432e8b95e3f58642c9f1266d27ff442fab915634e
+  data.tar.gz: 7dc45a9772b50b2b9ee73faa38ea34ae4784f979966d8a034be9a5193c5f34a904f3862563f09894f76bcc172d2534411bc80af6f1ffe795ed453229031a1163

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# 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/.simplecov

@@ -0,0 +1,5 @@
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.0
+notifications:
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: jL1lH/wfeRa5MoZRHvkXcZP/Ch7huFxqzbvhEV7UZhiDUBnApcJWkb346jeLEDYnFObUhqhaCZ1/l4fDeSFg2GgatSfEnoWATFVkIf1e4TTGAePlS+4qqsGOcr+XrjP6CEf4o4JACdLuSoT9dtUFj0xkFLnDWILxneXIrqDE9VU=
+  gem: redis-session-store
+  on:
+    tags: true
+    repo: roidrage/redis-session-store
+    branch: master
+    rvm: 2.0.0

data/AUTHORS.md

@@ -6,6 +6,7 @@ Redis Session Store authors
 - Donald Plummer
 - Edwin Cruz
 - Gonçalo Silva
+- Ian C. Anderson
 - Jorge Pardiñas
 - Mathias Meyer
 - Michael Fields

data/Gemfile

@@ -1,7 +1,3 @@
 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/README.md

@@ -1,6 +1,8 @@
 Redis Session Store
 ===================
 
+[![Build Status](https://travis-ci.org/roidrage/redis-session-store.png?branch=master)](https://travis-ci.org/roidrage/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-size-fits-all solution, and I found it not to work
@@ -16,6 +18,16 @@ 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
+-------------
+
+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:
+
+``` ruby
+gem 'redis-session-store', '< 0.3'
+```
+
 Installation
 ------------
 
@@ -27,28 +39,22 @@ Configuration
 -------------
 
 See `lib/redis-session-store.rb` for a list of valid options.
-Set them using:
+In your Rails app, throw in an initializer with the following contents:
 
 ``` ruby
-ActionController::Base.session = {
+My::Application.config.session_store = :redis_session_store, {
   :key          => 'your_session_key',
-  :secret       => 'your_long_secret',
   :redis        => {
     :db => 2,
     :expire_after => 120.minutes,
-    :key_prefix => "myapp:session:"
+    :key_prefix => "myapp:session:",
+    :host    => 'host', # Redis host name, default is localhost
+    :port    => 12345   # Redis port, default is 6379
   }
 }
 ```
     
 
-In your Rails app, throw in an initializer with the following contents
-and the configuration above:
-
-``` ruby
-ActionController::Base.session_store = RedisSessionStore
-```
-
 Contributing, Authors, & License
 --------------------------------
 

data/Rakefile

@@ -1,11 +1,15 @@
-#!/usr/bin/env rake
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task :default => :test
+task default: [:rubocop, :coverage]
 
-Rake::TestTask.new do |t|
-  t.pattern = 'test/*_test.rb'
-  t.verbose = true
-  t.options = '-v'
+RSpec::Core::RakeTask.new
+
+desc 'Run specs with coverage'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+  Rake::Task['spec'].invoke
 end
+
+Rubocop::RakeTask.new

data/lib/redis-session-store.rb

@@ -1,3 +1,4 @@
+# vim:fileencoding=utf-8
 require 'redis'
 
 # Redis session storage for Rails, and for Rails only. Derived from
@@ -5,7 +6,6 @@ require 'redis'
 #
 # Options:
 #  :key     => Same as with the other cookie stores, key name
-#  :secret  => Encryption secret for the key
 #  :redis => {
 #    :host    => Redis host name, default is localhost
 #    :port    => Redis port, default is 6379
@@ -13,65 +13,59 @@ require 'redis'
 #    :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
+class RedisSessionStore < ActionDispatch::Session::AbstractStore
+  VERSION = '0.3.0'
 
   def initialize(app, options = {})
     super
 
     redis_options = options[:redis] || {}
 
-    @default_options.merge!(:namespace => 'rack:session')
+    @default_options.merge!(namespace: 'rack:session')
     @default_options.merge!(redis_options)
     @redis = Redis.new(redis_options)
   end
 
   private
-    def prefixed(sid)
-      "#{@default_options[:key_prefix]}#{sid}"
-    end
 
-    def generate_sid
-      loop do
-        sid = super
-        break sid unless @redis.get(prefixed(sid))
-      end
-    end
+  attr_reader :redis, :key, :default_options
 
-    def get_session(env, sid)
-      unless sid && (session = load_session_from_redis(sid))
-        sid = generate_sid
-        session = {}
-      end
+  def prefixed(sid)
+    "#{default_options[:key_prefix]}#{sid}"
+  end
 
-      [sid, session]
+  def get_session(env, sid)
+    sid ||= generate_sid
+    begin
+      data = redis.get(prefixed(sid))
+      session = data.nil? ? {} : Marshal.load(data)
     rescue Errno::ECONNREFUSED
-      [generate_sid, {}]
+      session = {}
     end
+    [sid, session]
+  end
 
-    def load_session_from_redis(sid)
-      data = @redis.get(prefixed(sid))
-
-      data ? Marshal.load(data) : nil
+  def set_session(env, sid, session_data, options)
+    expiry  = options[:expire_after] || nil
+    if expiry
+      redis.setex(prefixed(sid), expiry, Marshal.dump(session_data))
+    else
+      redis.set(prefixed(sid), Marshal.dump(session_data))
     end
+    return sid
+  rescue Errno::ECONNREFUSED
+    return false
+  end
 
-    def set_session(env, sid, session_data)
-      options = env['rack.session.options']
-      expiry  = options[:expire_after] || nil
-      if expiry
-        @redis.setex(prefixed(sid), expiry, Marshal.dump(session_data))
-      else
-        @redis.set(prefixed(sid), Marshal.dump(session_data))
-      end
-      return true
-    rescue Errno::ECONNREFUSED
-      return false
+  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
-
-    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")
+  rescue Errno::ECONNREFUSED
+    if defined?(Rails)
+      Rails.logger.warn('RedisSessionStore#destroy: Connection to redis refused')
+    else
+      warn('RedisSessionStore#destroy: Connection to redis refused')
     end
+  end
 end

data/redis-session-store.gemspec

@@ -0,0 +1,29 @@
+# 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.'
+  gem.description = gem.summary
+  gem.homepage = 'https://github.com/roidrage/redis-session-store'
+  gem.license = 'MIT'
+
+  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.version = File.read('lib/redis-session-store.rb')
+                .match(/^  VERSION = '(.*)'/)[1]
+
+  gem.add_runtime_dependency 'redis'
+
+  gem.add_development_dependency 'fakeredis'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'simplecov'
+end

data/{test/fake_action_controller_session_abstract_store.rb → spec/fake_action_dispatch_session_abstract_store.rb}

@@ -1,17 +1,19 @@
-unless defined?(ActionController::Session::AbstractStore)
-  module ActionController
+# vim:fileencoding=utf-8
+
+unless defined?(ActionDispatch::Session::AbstractStore)
+  module ActionDispatch
     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
+            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]

data/spec/redis_session_store_spec.rb

@@ -0,0 +1,176 @@
+# vim:fileencoding=utf-8
+
+describe RedisSessionStore do
+  let :random_string do
+    "#{rand}#{rand}#{rand}"
+  end
+
+  let :options do
+    {}
+  end
+
+  subject(:store) { RedisSessionStore.new(nil, options) }
+
+  let :default_options do
+    store.instance_variable_get(:@default_options)
+  end
+
+  it 'assigns a :namespace to @default_options' do
+    default_options[:namespace].should == 'rack:session'
+  end
+
+  describe 'when initializing with the redis sub-hash options' do
+    let :options do
+      {
+        key: random_string,
+        secret: random_string,
+        redis: {
+          host: 'hosty.local',
+          port: 16_379,
+          db: 2,
+          key_prefix: 'myapp:session:',
+          expire_after: 60 * 120
+        }
+      }
+    end
+
+    it 'creates a redis instance' do
+      store.instance_variable_get(:@redis).should_not be_nil
+    end
+
+    it 'assigns the :host option to @default_options' do
+      default_options[:host].should == 'hosty.local'
+    end
+
+    it 'assigns the :port option to @default_options' do
+      default_options[:port].should == 16_379
+    end
+
+    it 'assigns the :db option to @default_options' do
+      default_options[:db].should == 2
+    end
+
+    it 'assigns the :key_prefix option to @default_options' do
+      default_options[:key_prefix].should == 'myapp:session:'
+    end
+
+    it 'assigns the :expire_after option to @default_options' do
+      default_options[:expire_after].should == 60 * 120
+    end
+  end
+
+  describe 'when initializing with top-level redis options' do
+    let :options do
+      {
+        key: random_string,
+        secret: random_string,
+        host: 'hostersons.local',
+        port: 26_379,
+        db: 4,
+        key_prefix: 'appydoo:session:',
+        expire_after: 60 * 60
+      }
+    end
+
+    it 'creates a redis instance' do
+      store.instance_variable_get(:@redis).should_not be_nil
+    end
+
+    it 'assigns the :host option to @default_options' do
+      default_options[:host].should == 'hostersons.local'
+    end
+
+    it 'assigns the :port option to @default_options' do
+      default_options[:port].should == 26_379
+    end
+
+    it 'assigns the :db option to @default_options' do
+      default_options[:db].should == 4
+    end
+
+    it 'assigns the :key_prefix option to @default_options' do
+      default_options[:key_prefix].should == 'appydoo:session:'
+    end
+
+    it 'assigns the :expire_after option to @default_options' do
+      default_options[:expire_after].should == 60 * 60
+    end
+  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
+
+    let(:env)          { double('env') }
+    let(:session_id)   { 12_345 }
+    let(:session_data) { double('session_data') }
+    let(:options)      { { expire_after: 123 } }
+
+    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)
+      end
+
+    end
+
+    context 'when unsuccessfully persisting the session' do
+      before do
+        store.stub(:redis).and_raise(Errno::ECONNREFUSED)
+      end
+
+      it 'returns false' do
+        store.send(:set_session, env, session_id, session_data, options).should eq(false)
+      end
+    end
+
+  end
+
+  describe 'fetching a session' do
+    let :options 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)
+      expect(redis).to receive(:get).with("#{options[:key_prefix]}#{fake_key}")
+
+      store.send(:get_session, double('env'), fake_key)
+    end
+
+    context 'when redis is down' 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, {}])
+      end
+    end
+  end
+
+  describe 'destroying a session' do
+    context 'when the key is in the cookie hash' do
+      let(:env) { { 'rack.request.cookie_hash' => cookie_hash } }
+      let(:cookie_hash) { double('cookie hash') }
+      let(:fake_key) { 'thisisarediskey' }
+
+      before do
+        cookie_hash.stub(:[] => fake_key)
+      end
+
+      it 'should delete the prefixed key from redis' do
+        redis = double('redis')
+        store.stub(redis: redis)
+        expect(redis).to receive(:del).with("#{options[:key_prefix]}#{fake_key}")
+
+        store.send(:destroy, env)
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# vim:fileencoding=utf-8
+
+require 'simplecov'
+require_relative 'fake_action_dispatch_session_abstract_store'
+require 'fakeredis/rspec'
+require 'redis-session-store'

metadata

@@ -1,27 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: redis-session-store
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Mathias Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-02-13 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
@@ -35,6 +105,11 @@ extra_rdoc_files:
 - AUTHORS.md
 - CONTRIBUTING.md
 files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .simplecov
+- .travis.yml
 - AUTHORS.md
 - CONTRIBUTING.md
 - Gemfile
@@ -42,8 +117,10 @@ files:
 - README.md
 - Rakefile
 - lib/redis-session-store.rb
-- test/fake_action_controller_session_abstract_store.rb
-- test/redis_session_store_test.rb
+- redis-session-store.gemspec
+- spec/fake_action_dispatch_session_abstract_store.rb
+- spec/redis_session_store_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/roidrage/redis-session-store
 licenses:
 - MIT
@@ -54,17 +131,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.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and

data/test/redis_session_store_test.rb

@@ -1,103 +0,0 @@
-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