redis-store 0.3.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Luca Guidi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,102 @@
+h1. Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks
+
+h2. Installation
+
+Download and install Redis from "http://code.google.com/p/redis/":http://code.google.com/p/redis/
+
+  curl -OL "http://redis.googlecode.com/files/redis-0.900_2.tar.gz":http://redis.googlecode.com/files/redis-0.900_2.tar.gz
+  tar -zxvf redis-0.900_2.tar.gz
+  mv redis-0.900_2 redis
+  cd redis
+  make
+
+Install the gems
+
+  -sudo gem install ezmobius-redis-rb -s http://gems.github.com-
+  
+  git clone git://github.com/ezmobius/redis-rb.git
+  cd redis-rb
+  sudo rake install
+
+  sudo gem install jodosha-redis-store -s http://gems.github.com
+
+h2. Cache store
+
+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"
+  config.cache_store = :redis_store
+
+h3. How to use with Merb
+
+  dependency "jodosha-redis-store", "0.3.6"
+  dependency("merb-cache", merb_gems_version) do
+    Merb::Cache.setup do
+      register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
+    end
+  end
+
+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::Session
+
+Provides a Redis store for Rack::Session. See "http://rack.rubyforge.org/doc/Rack/Session.html":http://rack.rubyforge.org/doc/Rack/Session.html
+
+h3. How to use with a generic Rack application
+
+  require "rubygems"
+  require "rack"
+  require "jodosha-redis-store"
+  require "application"
+  use Rack::Session::Redis
+  run Application.new
+
+h3. How to use with Rails
+
+  config.gem "jodosha-redis-store", :source => "http://gems.github.com", :lib => "redis-store"
+  ActionController::Base.session_store = Rack::Session::Redis
+
+h3. How to use with Merb
+
+  dependency "jodosha-redis-store", "0.3.6"
+  Merb::Config.use do |c|
+    c[:session_store] = 'redis'
+  end
+  Merb::BootLoader.before_app_loads do
+    Merb::SessionContainer.subclasses << "Merb::RedisSession"
+  end
+
+h3. How to use with Sinatra
+
+Sorry, but Sinatra application boot system "hardcode":http://github.com/sinatra/sinatra/blob/0f02bafe86f8dd9bba9ab425468cb1067caa83ff/lib/sinatra/base.rb#L785 Rack::Session::Cookie
+
+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":http://lucaguidi.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,58 @@
+$:.unshift 'lib'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+REDIS_STORE_VERSION = "0.3.6"
+
+task :default => :spec
+
+desc 'Build and install the gem (useful for development purposes).'
+task :install do
+  system "gem build redis-store.gemspec"
+  system "sudo gem uninstall redis-store"
+  system "sudo gem install --local --no-rdoc --no-ri redis-store-#{REDIS_STORE_VERSION}.gem"
+  system "rm redis-store-*.gem"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+desc 'Show the file list for the gemspec file'
+task :files do
+  puts "Files:\n #{Dir['**/*'].reject {|f| File.directory?(f)}.sort.inspect}"
+  puts "Test files:\n #{Dir['spec/**/*_spec.rb'].reject {|f| File.directory?(f)}.sort.inspect}"
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+namespace :redis do
+  desc 'Start the Redis cluster'
+  task :start => :clean do
+    system "redis-server spec/config/single.conf"
+    system "redis-server spec/config/master.conf"
+    system "redis-server spec/config/slave.conf"
+  end
+
+  desc 'Stop the Redis cluster'
+  task :stop do
+    # TODO replace with:
+    # system "kill -9 `tmp/redis-single.pid`"
+    # system "kill -9 `tmp/redis-master.pid`"
+    # system "kill -9 `tmp/redis-slave.pid`"
+    system "ps -eo pid,comm | grep redis | xargs kill -9"
+  end
+
+  desc 'Clean the tmp/ directory'
+  task :clean do
+    system "rm tmp/*" rescue nil
+  end
+end

data/lib/cache/merb/redis_store.rb

@@ -0,0 +1,63 @@
+module Merb
+  module Cache
+    class RedisStore < AbstractStore
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new                                     # => host: localhost,   port: 6379,  db: 0
+      #   RedisStore.new :servers => ["example.com"]         # => host: example.com, port: 6379,  db: 0
+      #   RedisStore.new :servers => ["example.com:23682"]   # => host: example.com, port: 23682, db: 0
+      #   RedisStore.new :servers => ["example.com:23682/1"] # => host: example.com, port: 23682, db: 1
+      #   RedisStore.new :servers => ["localhost:6379/0", "localhost:6380/0"] # => instantiate a cluster
+      def initialize(config = {})
+        @data = RedisFactory.create config[:servers]
+      end
+
+      def writable?(key, parameters = {}, conditions = {})
+        true
+      end
+
+      def read(key, parameters = {}, conditions = {})
+        @data.get normalize(key, parameters), conditions
+      end
+
+      def write(key, data = nil, parameters = {}, conditions = {})
+        if writable?(key, parameters, conditions)
+          method = conditions && conditions[:unless_exist] ? :set_unless_exists : :set
+          @data.send method, normalize(key, parameters), data, conditions
+        end
+      end
+
+      def write_all(key, data = nil, parameters = {}, conditions = {})
+        write key, data, parameters, conditions
+      end
+
+      def fetch(key, parameters = {}, conditions = {}, &blk)
+        read(key, parameters) || (write key, yield, parameters, conditions if block_given?)
+      end
+
+      def exists?(key, parameters = {})
+        @data.key? normalize(key, parameters)
+      end
+
+      def delete(key, parameters = {})
+        @data.delete normalize(key, parameters)
+      end
+
+      def delete_all
+        @data.flush_db
+      end
+
+      def delete_all!
+        delete_all
+      end
+
+      private
+        # Returns cache key calculated from base key
+        # and SHA2 hex from parameters.
+        def normalize(key, parameters = {})
+          parameters.empty? ? "#{key}" : "#{key}--#{parameters.to_sha2}"
+        end
+    end
+  end
+end

data/lib/cache/rails/redis_store.rb

@@ -0,0 +1,109 @@
+module ActiveSupport
+  module Cache
+    class RedisStore < Store
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new                       # => host: localhost,   port: 6379,  db: 0
+      #   RedisStore.new "example.com"         # => host: example.com, port: 6379,  db: 0
+      #   RedisStore.new "example.com:23682"   # => host: example.com, port: 23682, db: 0
+      #   RedisStore.new "example.com:23682/1" # => host: example.com, port: 23682, db: 1
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0" # => instantiate a cluster
+      def initialize(*addresses)
+        @data = RedisFactory.create(addresses)
+      end
+
+      def write(key, value, options = nil)
+        super
+        method = options && options[:unless_exist] ? :set_unless_exists : :set
+        @data.send method, key, value, options
+      end
+
+      def read(key, options = nil)
+        super
+        @data.get key, options
+      end
+
+      def delete(key, options = nil)
+        super
+        @data.delete key
+      end
+
+      def exist?(key, options = nil)
+        super
+        @data.key? key
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        log "increment", key, amount
+        @data.incr key, amount
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        log "decrement", key, amount
+        @data.decr key, amount
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.delete_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        super
+        @data.keys(matcher).each { |key| @data.delete key }
+      end
+
+      # Clear all the data from the store.
+      def clear
+        log "clear", nil, nil
+        @data.flush_db
+      end
+
+      def stats
+        @data.info
+      end
+    end
+  end
+end

data/lib/cache/sinatra/redis_store.rb

@@ -0,0 +1,111 @@
+module Sinatra
+  module Cache
+    class << self
+      def register(app)
+        app.set :cache, RedisStore.new
+      end
+    end
+
+    class RedisStore
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new                       # => host: localhost,   port: 6379,  db: 0
+      #   RedisStore.new "example.com"         # => host: example.com, port: 6379,  db: 0
+      #   RedisStore.new "example.com:23682"   # => host: example.com, port: 23682, db: 0
+      #   RedisStore.new "example.com:23682/1" # => host: example.com, port: 23682, db: 1
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0" # => instantiate a cluster
+      def initialize(*addresses)
+        @data = RedisFactory.create addresses
+      end
+
+      def write(key, value, options = nil)
+        method = options && options[:unless_exist] ? :set_unless_exists : :set
+        @data.send method, key, value, options
+      end
+
+      def read(key, options = nil)
+        @data.get key, options
+      end
+
+      def delete(key, options = nil)
+        @data.delete key
+      end
+
+      def exist?(key, options = nil)
+        @data.key? key
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        @data.incr key, amount
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        @data.decr key, amount
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.delete_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        @data.keys(matcher).each { |key| @data.delete key }
+      end
+
+      def fetch(key, options = {})
+        (!options[:force] && data = read(key, options)) || (write key, yield, options if block_given?)
+      end
+
+      # Clear all the data from the store.
+      def clear
+        @data.flush_db
+      end
+
+      def stats
+        @data.info
+      end
+    end
+  end
+end