redis_store_jr 0.1.0 → 0.2.0

data/.document

@@ -1,5 +1,3 @@
 README.rdoc
 lib/**/*.rb
-bin/*
-features/**/*.feature
 LICENSE

data/README.rdoc

@@ -2,19 +2,24 @@
 
 This is a vastly simplified version of RedisStore.
 
-Most of the code was lifted directly from an earlier version of Luca Guidi's
-redis-store gem. It does *not* support Sinatra, Merb, or many of the other
-options that his Gem does. So if you're looking for that stuff, you probably
-want to take a look at the [the original
-project](http://github.com/jodosha/redis-store).
+Much of this code was shamelessly lifted from an earlier version of Luca
+Guidi's redis-store gem. It does *not* support Sinatra, Merb, distributed
+storage, or many of the other options that his Gem does. So if you're 
+lookig for that stuff, you probably want to take a look at the original 
+project:
+
+http://github.com/jodosha/redis-store
 
 On the other hand, if you're looking for a super-simple Redis store interface
 that works reliably with Rails and Redis 1.2, without the complicated
 (and often unnecessary) dependencies, look no further.
 
+Note that this gem is specifically designed to work with Redis 1.2 and v1.0.7
+of the Redis gem.
+
 == Installation
 
-We assume you already have [Redis](http://code.google.com/p/redis/) set up and
+We assume you already have Redis (http://code.google.com/p/redis/) set up and
 running. If not, you know what to do.
 
 In your environment.rb:
@@ -25,11 +30,23 @@ Or your Gemfile:
 
   gem 'redis_store_jr', :require => 'redis_store' 
 
-In your production (or staging) environment config:
+To use the Rails.cache store, add the following to an initializer or your
+environment-specific config:
 
   require 'redis_store'
   config.cache_store = :redis_store, 'localhost:6379'
 
+Want to store user session data in Redis too? Of course you do.
+
+  ActionController::Base.session = {
+    :host => 'dbhost'
+    :port => 6379,
+    :db   => 2,
+    :expire_after => 24.hours,
+    :key_prefix   => "myapp:session:"
+  }
+  ActionController::Base.session_store = :redis_session_store
+
 This has only been tested on Rails 2.3.x. No guarantees about Rails 3.
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/redis_store.rb

@@ -1,11 +1,14 @@
 gem 'redis', '~> 1.0'
 gem 'activesupport', '~> 2.3'
+gem 'actionpack', '~> 2.3'
 
 require 'redis'
 require 'active_support'
+require 'action_controller'
 
 require 'redis_store/marshalled_client'
 require 'redis_store/cache/redis_store'
+require 'redis_store/session/redis_session_store'
 
 class RedisStore
   class Config < Hash

data/lib/redis_store/marshalled_client.rb

@@ -47,7 +47,7 @@ class RedisStore
 
     def expires_in(options)
       if options
-        options[:expire_after] || options[:expire_in]
+        options[:expire_after] || options[:expires_in]
       else
         nil
       end

data/lib/redis_store/session/redis_session_store.rb

@@ -0,0 +1,49 @@
+require 'action_controller'
+
+module ActionController
+  module Session
+    class RedisSessionStore < AbstractStore
+      def initialize(app, options = {})
+        options[:expire_after] ||= options[:expires]
+
+        super
+
+        @options = {
+          :namespace => 'rack:session',
+          :key_prefix => ''
+        }.update(options)
+
+        @data = options[:cache] || ::RedisStore::MarshalledClient.new(::RedisStore::Config.new(options))
+      end
+
+      private
+
+      def prefixed(sid)
+        "#{@options[:key_prefix]}#{sid}"
+      end
+      
+      def get_session(env, sid)
+        sid ||= generate_sid
+        begin
+          data = @data.marshalled_get(prefixed(sid))
+          session = data.nil? ? {} : data
+        rescue Errno::ECONNREFUSED
+          session = {}
+        end
+        [sid, session]
+      end
+
+      def set_session(env, sid, session_data)
+        options = env['rack.session.options']
+        expiry  = options[:expires_in] || options[:expire_after] || nil
+        
+        write_options = expiry.nil? ? {} : { :expires_in => expiry }
+        @data.marshalled_set(prefixed(sid), session_data, write_options)
+          
+        return true
+      rescue Errno::ECONNREFUSED
+        return false
+      end
+    end    
+  end
+end

data/spec/cache_spec.rb

@@ -18,7 +18,7 @@ describe ActiveSupport::Cache::RedisStore do
 
   it 'should read and write data with an expiration' do
     with_store do |store|
-      store.write('abc', @obj, :expire_in => 1.second)
+      store.write('abc', @obj, :expires_in => 1.second)
       store.read('abc').should == @obj ; sleep 2
       store.read('abc').should be_nil
     end

data/spec/session_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActionController::Session::RedisSessionStore do
+  before(:each) do
+    @app = Object.new
+    @store  = ActionController::Session::RedisSessionStore.new(@app)
+    @obj = OpenStruct.new(:name => 'Test')
+
+    with_store do |store|
+      class << store
+        public :get_session, :set_session
+      end
+
+      store.set_session({'rack.session.options' => {}}, 'abc', @obj)
+    end
+  end
+
+  it 'should save and retrieve session information' do
+    with_store do |store|
+      store.set_session({ 'rack.session.options' => {} }, 'abc', @obj)
+      store.get_session({}, 'abc').should === ['abc', @obj]
+    end
+  end
+
+  it 'should save session data with an expiration time' do
+    with_store do |store|
+      store.set_session({ 'rack.session.options' => { :expires_in => 1.second } }, 'abc', @obj)
+      store.get_session({}, 'abc').should === ['abc', @obj]; sleep 2
+      store.get_session({}, 'abc').should === ['abc', {}]
+    end
+  end
+
+  private
+
+  def with_store
+    yield @store
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redis_store_jr
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nick Plante
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-04 00:00:00 -04:00
+date: 2010-08-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,8 +97,10 @@ files:
 - lib/redis_store.rb
 - lib/redis_store/cache/redis_store.rb
 - lib/redis_store/marshalled_client.rb
+- lib/redis_store/session/redis_session_store.rb
 - spec/cache_spec.rb
 - spec/marshalled_client_spec.rb
+- spec/session_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -138,4 +140,5 @@ summary: Simple Redis Cache Store for Rails
 test_files: 
 - spec/cache_spec.rb
 - spec/marshalled_client_spec.rb
+- spec/session_spec.rb
 - spec/spec_helper.rb