jodosha-redis-store 0.1.0 → 0.2.0

data/README.textile

@@ -4,7 +4,7 @@ h2. Installation
 
 Download and install Redis from http://code.google.com/p/redis/
 
-  wget http://redis.googlecode.com/files/redis-0.094.tar.gz
+  wget "http://redis.googlecode.com/files/redis-0.094.tar.gz":http://redis.googlecode.com/files/redis-0.094.tar.gz
   tar -zxvf redis-0.094.tar.gz
   cd redis-0.094
   make
@@ -14,37 +14,51 @@ Install the gems
   sudo gem install ezmobius-redis-rb -s http://gems.github.com
   sudo gem install jodosha-redis-store -s http://gems.github.com
 
-h2. How to use with Rails
+h2. Cache store
 
-In your configuration files:
+Provides a cache store for your Ruby web framework of choice.
+
+h3. How to use with Rails
 
   config.gem "jodosha-redis-store", :source => "http://gems.github.com", :lib => "redis-store"
   require "redis-store" # HACK Rails tries to instantiate cache first, then load configured gems
   config.cache_store = :redis_store
 
-h2. How to use with Merb
-
-  dependency "jodosha-redis-store", "0.1.0"
+h3. How to use with Merb
+  
+  dependency "jodosha-redis-store", "0.2.0"
   dependency("merb-cache", merb_gems_version) do
     Merb::Cache.setup do
       register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
     end
   end
 
-h2. How to use with Sinatra
+h3. How to use with Sinatra
 
   require 'rubygems'
   require 'sinatra'
   require 'jodosha-redis-store'
-
   class MyApp < Sinatra::Base
     register Sinatra::Cache
-
     get '/hi' do
       cache.fetch("greet") { "Hello, World!" }
     end
   end
 
+h2. Rack::Cache
+
+Provides a Redis store for HTTP caching. See "http://github.com/rtomayko/rack-cache":http://github.com/rtomayko/rack-cache
+
+  require "rubygems"
+  require "rack"
+  require "rack/cache"
+  require "jodosha-redis-store"
+  require "application"
+  use Rack::Cache,
+    :metastore   => 'redis://localhost:6379/0',
+    :entitystore => 'redis://localhost:6380/1'
+  run Application.new
+
 h2. Copyright
 
-(c) 2009 Luca Guidi - http://lucaguidi.com, released under the MIT license
+(c) 2009 Luca Guidi - "http://lucaguidi.com":http://lucaguidi.com, released under the MIT license

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
 
-REDIS_STORE_VERSION = "0.1.0"
+REDIS_STORE_VERSION = "0.2.0"
 
 task :default => :spec
 

data/lib/rack/cache/redis_entitystore.rb

@@ -0,0 +1,51 @@
+module Rack
+  module Cache
+    class EntityStore
+      class RedisBase < EntityStore
+        # The underlying ::Redis instance used to communicate with the Redis daemon.
+        attr_reader :cache
+
+        extend Rack::Utils
+
+        def open(key)
+          data = read(key)
+          data && [data]
+        end
+
+        def self.resolve(uri)
+          db = uri.path.sub(/^\//, '')
+          db = "0" if db.empty?
+          server = { :host => uri.host, :port => uri.port || "6379", :db => db }
+          new server
+        end
+      end
+
+      class Redis < RedisBase
+        def initialize(server, options = {})
+          @cache = ::Redis.new server
+        end
+
+        def exist?(key)
+          cache.key? key
+        end
+
+        def read(key)
+          cache.get key
+        end
+
+        def write(body)
+          buf = StringIO.new
+          key, size = slurp(body){|part| buf.write(part) }
+          [key, size] if cache.set(key, buf.string)
+        end
+
+        def purge(key)
+          cache.delete key
+          nil
+        end
+      end
+
+      REDIS = Redis
+    end
+  end
+end

data/lib/rack/cache/redis_metastore.rb

@@ -0,0 +1,42 @@
+module Rack
+  module Cache
+    class MetaStore
+      class RedisBase < MetaStore
+        extend Rack::Utils
+
+        # The ::MarshaledRedis object used to communicate with the Redis daemon.
+        attr_reader :cache
+
+        def self.resolve(uri)
+          db = uri.path.sub(/^\//, '')
+          db = "0" if db.empty?
+          server = { :host => uri.host, :port => uri.port || "6379", :db => db }
+          new server
+        end
+      end
+
+      class Redis < RedisBase
+        def initialize(server, options = {})
+          @cache = ::MarshaledRedis.new server
+        end
+
+        def read(key)
+          key = hexdigest(key)
+          cache.get(key) || []
+        end
+
+        def write(key, entries)
+          key = hexdigest(key)
+          cache.set(key, entries)
+        end
+
+        def purge(key)
+          cache.delete(hexdigest(key))
+          nil
+        end
+      end
+
+      REDIS = Redis
+    end
+  end
+end

data/lib/redis-store.rb

@@ -3,13 +3,19 @@ require "dist_redis"
 require "redis/marshaled_redis"
 require "redis/distributed_marshaled_redis"
 
+# Cache store
 if defined?(Sinatra)
   require "cache/sinatra/redis_store"
 elsif defined?(Merb)
   # HACK for cyclic dependency: redis-store is required before merb-cache
   module Merb; module Cache; class AbstractStore; end end end
   require "cache/merb/redis_store"
-else # rails or ruby application
-  require "activesupport"
+elsif defined?(Rails)
   require "cache/rails/redis_store"
 end
+
+# Rack::Cache
+if defined?(Rack::Cache)
+  require "rack/cache/redis_metastore"
+  require "rack/cache/redis_entitystore"
+end

data/redis-store.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name               = "redis-store"
-  s.version            = "0.1.0"
+  s.version            = "0.2.0"
   s.date               = "2009-04-30"
   s.summary            = "Redis cache and session stores for Ruby web frameworks"
   s.author             = "Luca Guidi"
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.homepage           = "http://lucaguidi.com"
   s.description        = "Redis cache and session stores for Ruby web frameworks"
   s.has_rdoc           = true
-  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/cache/merb/redis_store.rb", "lib/cache/rails/redis_store.rb", "lib/cache/sinatra/redis_store.rb", "lib/redis-store.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "redis-store.gemspec", "spec/cache/merb/redis_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/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/spec_helper.rb"]
-  s.test_files         = ["spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb"]
+  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/cache/merb/redis_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/redis-store.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "redis-store.gemspec", "spec/cache/merb/redis_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/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/spec_helper.rb"]
+  s.test_files         = ["spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/rack/cache/entitystore/redis_spec.rb", "spec/rack/cache/metastore/redis_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb"]
   s.extra_rdoc_files   = ["README.textile"]
 end

data/spec/rack/cache/entitystore/redis_spec.rb

@@ -0,0 +1,108 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper")
+
+module Rack
+  module Cache
+    class MetaStore
+      describe "Redis" do
+        before(:each) do
+          @store = Rack::Cache::EntityStore::Redis.new :host => "localhost"
+        end
+
+        it "should have the class referenced by homonym constant" do
+          Rack::Cache::EntityStore::REDIS.should be(Rack::Cache::EntityStore::Redis)
+        end
+
+        it "should resolve the connection uri" do
+          cache = Redis.resolve(uri("redis://127.0.0.1")).cache
+          cache.should be_kind_of(::MarshaledRedis)
+          cache.host.should == "127.0.0.1"
+          cache.port.should == "6379"
+          cache.instance_variable_get(:@db).should == "0"
+
+          cache = Redis.resolve(uri("redis://127.0.0.1:6380")).cache
+          cache.port.should == 6380
+
+          cache = Redis.resolve(uri("redis://127.0.0.1/11")).cache
+          cache.instance_variable_get(:@db).should == "11"
+        end
+
+        it 'responds to all required messages' do
+          %w[read open write exist?].each do |message|
+            @store.should respond_to(message)
+          end
+        end
+
+        it 'stores bodies with #write' do
+          key, size = @store.write(['My wild love went riding,'])
+          key.should_not be_nil
+          # key.should be_sha_like TODO re-enable
+
+          data = @store.read(key)
+          data.should == 'My wild love went riding,'
+        end
+
+        it 'correctly determines whether cached body exists for key with #exist?' do
+          key, size = @store.write(['She rode to the devil,'])
+          @store.should be_exist(key)
+          @store.should_not be_exist('938jasddj83jasdh4438021ksdfjsdfjsdsf')
+        end
+
+        it 'can read data written with #write' do
+          key, size = @store.write(['And asked him to pay.'])
+          data = @store.read(key)
+          data.should == 'And asked him to pay.'
+        end
+
+        it 'gives a 40 character SHA1 hex digest from #write' do
+          key, size = @store.write(['she rode to the sea;'])
+          key.should_not be_nil
+          key.length.should == 40
+          key.should =~ /^[0-9a-z]+$/
+          key.should == '90a4c84d51a277f3dafc34693ca264531b9f51b6'
+        end
+
+        it 'returns the entire body as a String from #read' do
+          key, size = @store.write(['She gathered together'])
+          @store.read(key).should == 'She gathered together'
+        end
+
+        it 'returns nil from #read when key does not exist' do
+          @store.read('87fe0a1ae82a518592f6b12b0183e950b4541c62').should be_nil
+        end
+
+        it 'returns a Rack compatible body from #open' do
+          key, size = @store.write(['Some shells for her hair.'])
+          body = @store.open(key)
+          body.should respond_to(:each)
+          buf = ''
+          body.each { |part| buf << part }
+          buf.should == 'Some shells for her hair.'
+        end
+
+        it 'returns nil from #open when key does not exist' do
+          @store.open('87fe0a1ae82a518592f6b12b0183e950b4541c62').should be_nil
+        end
+
+        it 'can store largish bodies with binary data' do
+          pony = ::File.open(::File.dirname(__FILE__) + '/pony.jpg', 'rb') { |f| f.read }
+          key, size = @store.write([pony])
+          key.should == 'd0f30d8659b4d268c5c64385d9790024c2d78deb'
+          data = @store.read(key)
+          data.length.should == pony.length
+          data.hash.should == pony.hash
+        end
+
+        it 'deletes stored entries with #purge' do
+          key, size = @store.write(['My wild love went riding,'])
+          @store.purge(key).should be_nil
+          @store.read(key).should be_nil
+        end
+
+        private
+          def uri(uri)
+            URI.parse uri
+          end
+      end
+    end
+  end
+end

data/spec/rack/cache/metastore/redis_spec.rb

@@ -0,0 +1,102 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper")
+
+module Rack
+  module Cache
+    class MetaStore
+      describe "Redis" do
+        before(:each) do
+          @store = Redis.resolve uri("redis://127.0.0.1")
+        end
+
+        it "should have the class referenced by homonym constant" do
+          Rack::Cache::MetaStore::REDIS.should be(Rack::Cache::MetaStore::Redis)
+        end
+
+        it "should resolve the connection uri" do
+          cache = Redis.resolve(uri("redis://127.0.0.1")).cache
+          cache.should be_kind_of(::MarshaledRedis)
+          cache.host.should == "127.0.0.1"
+          cache.port.should == "6379"
+          cache.instance_variable_get(:@db).should == "0"
+
+          cache = Redis.resolve(uri("redis://127.0.0.1:6380")).cache
+          cache.port.should == 6380
+
+          cache = Redis.resolve(uri("redis://127.0.0.1/11")).cache
+          cache.instance_variable_get(:@db).should == "11"
+        end
+
+        it 'writes a list of negotation tuples with #write' do
+          lambda { @store.write('/test', [[{}, {}]]) }.should_not raise_error
+        end
+
+        it 'reads a list of negotation tuples with #read' do
+          @store.write('/test', [[{},{}],[{},{}]])
+          tuples = @store.read('/test')
+          tuples.should == [ [{},{}], [{},{}] ]
+        end
+
+        it 'reads an empty list with #read when nothing cached at key' do
+          @store.read('/nothing').should be_empty
+        end
+
+        it 'removes entries for key with #purge' do
+          @store.write('/test', [[{},{}]])
+          @store.read('/test').should_not be_empty
+
+          @store.purge('/test')
+          @store.read('/test').should be_empty
+        end
+
+        it 'succeeds when purging non-existing entries' do
+          @store.read('/test').should be_empty
+          @store.purge('/test')
+        end
+
+        it 'returns nil from #purge' do
+          @store.write('/test', [[{},{}]])
+          @store.purge('/test').should be_nil
+          @store.read('/test').should == []
+        end
+
+        %w[/test http://example.com:8080/ /test?x=y /test?x=y&p=q].each do |key|
+          it "can read and write key: '#{key}'" do
+            lambda { @store.write(key, [[{},{}]]) }.should_not raise_error
+            @store.read(key).should == [[{},{}]]
+          end
+        end
+
+        it "can read and write fairly large keys" do
+          key = "b" * 4096
+          lambda { @store.write(key, [[{},{}]]) }.should_not raise_error
+          @store.read(key).should == [[{},{}]]
+        end
+
+        it "allows custom cache keys from block" do
+          request = mock_request('/test', {})
+          request.env['rack-cache.cache_key'] =
+            lambda { |request| request.path_info.reverse }
+          @store.cache_key(request).should == 'tset/'
+        end
+
+        it "allows custom cache keys from class" do
+          request = mock_request('/test', {})
+          request.env['rack-cache.cache_key'] = Class.new do
+            def self.call(request); request.path_info.reverse end
+          end
+          @store.cache_key(request).should == 'tset/'
+        end
+
+        private
+          def mock_request(uri, opts)
+            env = Rack::MockRequest.env_for(uri, opts || {})
+            Rack::Cache::Request.new(env)
+          end
+
+          def uri(uri)
+            URI.parse uri
+          end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,9 @@ require "ostruct"
 require "spec"
 require "redis"
 require "merb"
+require "rack/cache"
+require "rack/cache/metastore"
+require "rack/cache/entitystore"
 require "redis-store"
 require "activesupport"
 require "cache/rails/redis_store"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jodosha-redis-store
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Luca Guidi
@@ -28,6 +28,8 @@ files:
 - lib/cache/merb/redis_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/redis-store.rb
 - lib/redis/distributed_marshaled_redis.rb
 - lib/redis/marshaled_redis.rb
@@ -38,6 +40,9 @@ files:
 - 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/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/marshaled_redis_spec.rb
 - spec/spec_helper.rb
@@ -71,5 +76,7 @@ test_files:
 - spec/cache/merb/redis_store_spec.rb
 - spec/cache/rails/redis_store_spec.rb
 - spec/cache/sinatra/redis_store_spec.rb
+- spec/rack/cache/entitystore/redis_spec.rb
+- spec/rack/cache/metastore/redis_spec.rb
 - spec/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/marshaled_redis_spec.rb