honkster-redis-store 0.3.10

data/spec/rack/session/redis_spec.rb

@@ -0,0 +1,234 @@
+require File.join(File.dirname(__FILE__), "/../../spec_helper")
+
+module Rack
+  module Session
+    describe "Rack::Session::Redis" do
+      before(:each) do
+        @session_key = Rack::Session::Redis::DEFAULT_OPTIONS[:key]
+        @session_match = /#{@session_key}=[0-9a-fA-F]+;/
+        @incrementor = lambda do |env|
+          env["rack.session"]["counter"] ||= 0
+          env["rack.session"]["counter"] += 1
+          Rack::Response.new(env["rack.session"].inspect).to_a
+        end
+        @drop_session = proc do |env|
+          env['rack.session.options'][:drop] = true
+          @incrementor.call(env)
+        end
+        @renew_session = proc do |env|
+          env['rack.session.options'][:renew] = true
+          @incrementor.call(env)
+        end
+        @defer_session = proc do |env|
+          env['rack.session.options'][:defer] = true
+          @incrementor.call(env)
+        end
+      end
+
+      it "should specify connection params" do
+        pool = Rack::Session::Redis.new(@incrementor, :redis_server => "localhost:6380/1").pool
+        pool.should be_kind_of(MarshaledRedis)
+        pool.to_s.should == "Redis Client connected to localhost:6380 against DB 1"
+
+        pool = Rack::Session::Redis.new(@incrementor, :redis_server => ["localhost:6379", "localhost:6380"]).pool
+        pool.should be_kind_of(DistributedMarshaledRedis)
+      end
+
+      it "creates a new cookie" do
+        pool = Rack::Session::Redis.new(@incrementor)
+        res = Rack::MockRequest.new(pool).get("/")
+        res["Set-Cookie"].should match(/#{@session_key}=/)
+        res.body.should == '{"counter"=>1}'
+      end
+
+      it "determines session from a cookie" do
+        pool = Rack::Session::Redis.new(@incrementor)
+        req = Rack::MockRequest.new(pool)
+        res = req.get("/")
+        cookie = res["Set-Cookie"]
+        req.get("/", "HTTP_COOKIE" => cookie).body.should == '{"counter"=>2}'
+        req.get("/", "HTTP_COOKIE" => cookie).body.should == '{"counter"=>3}'
+      end
+
+      it "survives nonexistant cookies" do
+        bad_cookie = "rack.session=blarghfasel"
+        pool = Rack::Session::Redis.new(@incrementor)
+        res = Rack::MockRequest.new(pool).
+          get("/", "HTTP_COOKIE" => bad_cookie)
+        res.body.should == '{"counter"=>1}'
+        cookie = res["Set-Cookie"][@session_match]
+        cookie.should_not match(/#{bad_cookie}/)
+      end
+
+      it "should maintain freshness" do
+        pool = Rack::Session::Redis.new(@incrementor, :expire_after => 3)
+        res = Rack::MockRequest.new(pool).get('/')
+        res.body.should include('"counter"=>1')
+        cookie = res["Set-Cookie"]
+        res = Rack::MockRequest.new(pool).get('/', "HTTP_COOKIE" => cookie)
+        res["Set-Cookie"].should == cookie
+        res.body.should include('"counter"=>2')
+        puts 'Sleeping to expire session' if $DEBUG
+        sleep 4
+        res = Rack::MockRequest.new(pool).get('/', "HTTP_COOKIE" => cookie)
+        res["Set-Cookie"].should_not == cookie
+        res.body.should include('"counter"=>1')
+      end
+
+      it "deletes cookies with :drop option" do
+        pool = Rack::Session::Redis.new(@incrementor)
+        req = Rack::MockRequest.new(pool)
+        drop = Rack::Utils::Context.new(pool, @drop_session)
+        dreq = Rack::MockRequest.new(drop)
+
+        res0 = req.get("/")
+        session = (cookie = res0["Set-Cookie"])[@session_match]
+        res0.body.should == '{"counter"=>1}'
+
+        res1 = req.get("/", "HTTP_COOKIE" => cookie)
+        res1["Set-Cookie"][@session_match].should == session
+        res1.body.should == '{"counter"=>2}'
+
+        res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
+        res2["Set-Cookie"].should be_nil
+        res2.body.should == '{"counter"=>3}'
+
+        res3 = req.get("/", "HTTP_COOKIE" => cookie)
+        res3["Set-Cookie"][@session_match].should_not == session
+        res3.body.should == '{"counter"=>1}'
+      end
+
+      it "provides new session id with :renew option" do
+        pool = Rack::Session::Redis.new(@incrementor)
+        req = Rack::MockRequest.new(pool)
+        renew = Rack::Utils::Context.new(pool, @renew_session)
+        rreq = Rack::MockRequest.new(renew)
+
+        res0 = req.get("/")
+        session = (cookie = res0["Set-Cookie"])[@session_match]
+        res0.body.should == '{"counter"=>1}'
+
+        res1 = req.get("/", "HTTP_COOKIE" => cookie)
+        res1["Set-Cookie"][@session_match].should == session
+        res1.body.should == '{"counter"=>2}'
+
+        res2 = rreq.get("/", "HTTP_COOKIE" => cookie)
+        new_cookie = res2["Set-Cookie"]
+        new_session = new_cookie[@session_match]
+        new_session.should_not == session
+        res2.body.should == '{"counter"=>3}'
+
+        res3 = req.get("/", "HTTP_COOKIE" => new_cookie)
+        res3["Set-Cookie"][@session_match].should == new_session
+        res3.body.should == '{"counter"=>4}'
+      end
+
+      specify "omits cookie with :defer option" do
+        pool = Rack::Session::Redis.new(@incrementor)
+        req = Rack::MockRequest.new(pool)
+        defer = Rack::Utils::Context.new(pool, @defer_session)
+        dreq = Rack::MockRequest.new(defer)
+
+        res0 = req.get("/")
+        session = (cookie = res0["Set-Cookie"])[@session_match]
+        res0.body.should == '{"counter"=>1}'
+
+        res1 = req.get("/", "HTTP_COOKIE" => cookie)
+        res1["Set-Cookie"][@session_match].should == session
+        res1.body.should == '{"counter"=>2}'
+
+        res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
+        res2["Set-Cookie"].should be_nil
+        res2.body.should == '{"counter"=>3}'
+
+        res3 = req.get("/", "HTTP_COOKIE" => cookie)
+        res3["Set-Cookie"][@session_match].should == session
+        res3.body.should == '{"counter"=>4}'
+      end
+
+      # anyone know how to do this better?
+      specify "multithread: should cleanly merge sessions" do
+        next unless $DEBUG
+        warn 'Running multithread test for Session::Redis'
+        pool = Rack::Session::Redis.new(@incrementor)
+        req = Rack::MockRequest.new(pool)
+
+        res = req.get('/')
+        res.body.should == '{"counter"=>1}'
+        cookie = res["Set-Cookie"]
+        sess_id = cookie[/#{pool.key}=([^,;]+)/,1]
+
+        delta_incrementor = lambda do |env|
+          # emulate disconjoinment of threading
+          env['rack.session'] = env['rack.session'].dup
+          Thread.stop
+          env['rack.session'][(Time.now.usec*rand).to_i] = true
+          @incrementor.call(env)
+        end
+        tses = Rack::Utils::Context.new pool, delta_incrementor
+        treq = Rack::MockRequest.new(tses)
+        tnum = rand(7).to_i+5
+        r = Array.new(tnum) do
+          Thread.new(treq) do |run|
+            run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
+          end
+        end.reverse.map{|t| t.run.join.value }
+        r.each do |res|
+          res['Set-Cookie'].should == cookie
+          res.body.should include('"counter"=>2')
+        end
+
+        session = pool.pool.get(sess_id)
+        session.size.should == tnum+1 # counter
+        session['counter'].should == 2 # meeeh
+
+        tnum = rand(7).to_i+5
+        r = Array.new(tnum) do |i|
+          delta_time = proc do |env|
+            env['rack.session'][i]  = Time.now
+            Thread.stop
+            env['rack.session']     = env['rack.session'].dup
+            env['rack.session'][i] -= Time.now
+            @incrementor.call(env)
+          end
+          app = Rack::Utils::Context.new pool, time_delta
+          req = Rack::MockRequest.new app
+          Thread.new(req) do |run|
+            run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
+          end
+        end.reverse.map{|t| t.run.join.value }
+        r.each do |res|
+          res['Set-Cookie'].should == cookie
+          res.body.should include('"counter"=>3')
+        end
+
+        session = pool.pool.get(sess_id)
+        session.size.should == tnum+1
+        session['counter'].should == 3
+
+        drop_counter = proc do |env|
+          env['rack.session'].del 'counter'
+          env['rack.session']['foo'] = 'bar'
+          [200, {'Content-Type'=>'text/plain'}, env['rack.session'].inspect]
+        end
+        tses = Rack::Utils::Context.new pool, drop_counter
+        treq = Rack::MockRequest.new(tses)
+        tnum = rand(7).to_i+5
+        r = Array.new(tnum) do
+          Thread.new(treq) do |run|
+            run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
+          end
+        end.reverse.map{|t| t.run.join.value }
+        r.each do |res|
+          res['Set-Cookie'].should == cookie
+          res.body.should include('"foo"=>"bar"')
+        end
+
+        session = pool.pool.get(sess_id)
+        session.size.should == r.size+1
+        session['counter'].should be_nil
+        session['foo'].should == 'bar'
+      end
+    end
+  end
+end

data/spec/redis/distributed_marshaled_redis_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "DistributedMarshaledRedis" do
+  before(:each) do
+    @dmr = DistributedMarshaledRedis.new [
+      {:host => "localhost", :port => "6380", :db => 0},
+      {:host => "localhost", :port => "6381", :db => 0}
+    ]
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    @dmr.marshalled_set "rabbit", @rabbit
+  end
+
+  after(:all) do
+    @dmr.ring.nodes.each { |server| server.flushdb }
+  end
+
+  it "should accept connection params" do
+    dmr = DistributedMarshaledRedis.new [ :host => "localhost", :port => "6380", :db => "1" ]
+    dmr.ring.should have(1).node
+    mr = dmr.ring.nodes.first
+    mr.to_s.should == "Redis Client connected to localhost:6380 against DB 1"
+  end
+
+  it "should set an object" do
+    @dmr.marshalled_set "rabbit", @white_rabbit
+    @dmr.marshalled_get("rabbit").should == @white_rabbit
+  end
+
+  it "should get an object" do
+    @dmr.marshalled_get("rabbit").should == @rabbit
+  end
+end

data/spec/redis/marshaled_redis_spec.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "MarshaledRedis" do
+  before(:each) do
+    @store = MarshaledRedis.new
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    @store.marshalled_set "rabbit", @rabbit
+    @store.del "rabbit2"
+  end
+
+  after :each do
+    @store.quit
+  end
+
+  it "should unmarshal an object on get" do
+    @store.marshalled_get("rabbit").should === @rabbit
+  end
+
+  it "should marshal object on set" do
+    @store.marshalled_set "rabbit", @white_rabbit
+    @store.marshalled_get("rabbit").should === @white_rabbit
+  end
+
+  it "should not unmarshal object on get if raw option is true" do
+    @store.marshalled_get("rabbit", :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\nbunny"
+  end
+
+  it "should not marshal object on set if raw option is true" do
+    @store.marshalled_set "rabbit", @white_rabbit, :raw => true
+    @store.marshalled_get("rabbit", :raw => true).should == %(#<OpenStruct color="white">)
+  end
+
+  it "should not unmarshal object if getting an empty string" do
+    @store.marshalled_set "empty_string", ""
+    lambda { @store.marshalled_get("empty_string").should == "" }.should_not raise_error
+  end
+
+  it "should not set an object if already exist" do
+    @store.marshalled_setnx "rabbit", @white_rabbit
+    @store.marshalled_get("rabbit").should === @rabbit
+  end
+
+  it "should marshal object on set_unless_exists" do
+    @store.marshalled_setnx "rabbit2", @white_rabbit
+    @store.marshalled_get("rabbit2").should === @white_rabbit
+  end
+
+  it "should not marshal object on set_unless_exists if raw option is true" do
+    @store.marshalled_setnx "rabbit2", @white_rabbit, :raw => true
+    @store.marshalled_get("rabbit2", :raw => true).should == %(#<OpenStruct color="white">)
+  end
+end
+

data/spec/redis/redis_factory_spec.rb

@@ -0,0 +1,68 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "RedisFactory" do
+  describe ".create" do
+    context "when not given any arguments" do
+      it "should instantiate a MarshaledRedis store" do
+        store = RedisFactory.create
+        store.should be_kind_of(MarshaledRedis)
+        store.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
+      end
+    end
+
+    context "when given a Hash" do
+      it "should allow to specify host" do
+        store = RedisFactory.create :host => "localhost"
+        store.to_s.should == "Redis Client connected to localhost:6379 against DB 0"
+      end
+
+      it "should allow to specify port" do
+        store = RedisFactory.create :host => "localhost", :port => 6380
+        store.to_s.should == "Redis Client connected to localhost:6380 against DB 0"
+      end
+
+      it "should allow to specify db" do
+        store = RedisFactory.create :host => "localhost", :port => 6380, :db => 13
+        store.to_s.should == "Redis Client connected to localhost:6380 against DB 13"
+      end
+
+      it "should instantiate a DistributedMarshaledRedis store" do
+        store = RedisFactory.create(
+          {:host => "localhost", :port => 6379},
+          {:host => "localhost", :port => 6380}
+        )
+        store.should be_kind_of(DistributedMarshaledRedis)
+        store.nodes.map {|node| node.to_s}.should == [
+          "Redis Client connected to localhost:6379 against DB 0",
+          "Redis Client connected to localhost:6380 against DB 0",
+        ]
+      end
+    end
+
+    context "when given a String" do
+      it "should allow to specify host" do
+        store = RedisFactory.create "localhost"
+        store.to_s.should == "Redis Client connected to localhost:6379 against DB 0"
+      end
+
+      it "should allow to specify port" do
+        store = RedisFactory.create "localhost:6380"
+        store.to_s.should == "Redis Client connected to localhost:6380 against DB 0"
+      end
+
+      it "should allow to specify db" do
+        store = RedisFactory.create "localhost:6380/13"
+        store.to_s.should == "Redis Client connected to localhost:6380 against DB 13"
+      end
+
+      it "should instantiate a DistributedMarshaledRedis store" do
+        store = RedisFactory.create "localhost:6379", "localhost:6380"
+        store.should be_kind_of(DistributedMarshaledRedis)
+        store.nodes.map {|node| node.to_s}.should == [
+          "Redis Client connected to localhost:6379 against DB 0",
+          "Redis Client connected to localhost:6380 against DB 0",
+        ]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+ARGV << "-b"
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+#require "vendor/gems/environment"
+require "ostruct"
+require "spec"
+require "spec/autorun"
+require "redis"
+require "merb"
+require "rack/cache"
+require "rack/cache/metastore"
+require "rack/cache/entitystore"
+require "redis-store"
+require "active_support"
+require "action_controller/session/abstract_store"
+require "cache/rails/redis_store"
+require "cache/rails/redis_session_store"
+require "cache/sinatra/redis_store"
+
+class Redis; attr_reader :host, :port, :db end
+$DEBUG = ENV["DEBUG"] === "true"

data/tasks/redis.tasks.rb

@@ -0,0 +1,78 @@
+# steal the cool tasks from redis-rb
+require 'rbconfig'
+require "rubygems"
+require "bundler"
+Bundler.setup
+redis_path = $:.
+  find {|path| path =~ /redis-/ }.
+  split("/").
+  tap do |array|
+    array.replace(
+      array[0..array.index(array.find {|segment| segment =~ /redis-/})]
+    )
+  end.
+  join("/")
+
+load "#{redis_path}/tasks/redis.tasks.rb"
+
+class RedisRunner
+  def self.port
+    6379
+  end
+
+  def self.stop
+    system %(echo "SHUTDOWN" | nc localhost #{port})
+  end
+end
+
+class SingleRedisRunner < RedisRunner
+  def self.redisconfdir
+    File.expand_path(File.dirname(__FILE__) + "/../spec/config/single.conf")
+  end
+end
+
+class MasterRedisRunner < RedisRunner
+  def self.redisconfdir
+    File.expand_path(File.dirname(__FILE__) + "/../spec/config/master.conf")
+  end
+
+  def self.dtach_socket
+    "/tmp/redis_master.dtach"
+  end
+
+  def self.port
+    6380
+  end
+end
+
+class SlaveRedisRunner < RedisRunner
+  def self.redisconfdir
+    File.expand_path(File.dirname(__FILE__) + "/../spec/config/slave.conf")
+  end
+
+  def self.dtach_socket
+    "/tmp/redis_slave.dtach"
+  end
+
+  def self.port
+    6381
+  end
+end
+
+class RedisClusterRunner
+  def self.runners
+    [ SingleRedisRunner, MasterRedisRunner, SlaveRedisRunner ]
+  end
+
+  def self.start_detached
+    runners.each do |runner|
+      runner.start_detached
+    end
+  end
+
+  def self.stop
+    runners.each do |runner|
+      runner.stop
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: honkster-redis-store
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 10
+  version: 0.3.10
+platform: ruby
+authors: 
+- Luca Guidi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks.
+email: guidi.luca@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/cache/merb/redis_store.rb
+- lib/cache/rails/redis_session_store.rb
+- lib/cache/rails/redis_store.rb
+- lib/cache/sinatra/redis_store.rb
+- lib/rack/cache/redis_entitystore.rb
+- lib/rack/cache/redis_metastore.rb
+- lib/rack/session/merb.rb
+- lib/rack/session/redis.rb
+- lib/redis-store.rb
+- lib/redis/distributed_marshaled_redis.rb
+- lib/redis/marshaled_redis.rb
+- lib/redis/redis_factory.rb
+- redis-store.gemspec
+- spec/cache/merb/redis_store_spec.rb
+- spec/cache/rails/redis_session_store_spec.rb
+- spec/cache/rails/redis_store_spec.rb
+- spec/cache/sinatra/redis_store_spec.rb
+- spec/config/master.conf
+- spec/config/single.conf
+- spec/config/slave.conf
+- spec/rack/cache/entitystore/pony.jpg
+- spec/rack/cache/entitystore/redis_spec.rb
+- spec/rack/cache/metastore/redis_spec.rb
+- spec/rack/session/redis_spec.rb
+- spec/redis/distributed_marshaled_redis_spec.rb
+- spec/redis/marshaled_redis_spec.rb
+- spec/redis/redis_factory_spec.rb
+- spec/spec_helper.rb
+- tasks/redis.tasks.rb
+has_rdoc: true
+homepage: http://github.com/jodosha/redis-store
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks.
+test_files: 
+- spec/spec_helper.rb
+- spec/cache/sinatra/redis_store_spec.rb
+- spec/cache/merb/redis_store_spec.rb
+- spec/cache/rails/redis_session_store_spec.rb
+- spec/cache/rails/redis_store_spec.rb
+- spec/rack/cache/metastore/redis_spec.rb
+- spec/rack/cache/entitystore/redis_spec.rb
+- spec/rack/session/redis_spec.rb
+- spec/redis/marshaled_redis_spec.rb
+- spec/redis/distributed_marshaled_redis_spec.rb
+- spec/redis/redis_factory_spec.rb