redis-sinatra 0.0.0 → 1.3.1.rc

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp/*

data/Gemfile

@@ -1,2 +1,4 @@
 source "http://rubygems.org"
 gemspec
+
+gem 'redis-store', '1.1.0.rc', :path => File.expand_path('../../redis-store', __FILE__)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 - 2011 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.md

@@ -0,0 +1,57 @@
+# Redis stores for Sinatra
+
+__`redis-sinatra`__ provides a Redis backed cache store for __Sinatra__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+
+## Redis Installation
+
+### Option 1: Homebrew
+
+MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
+
+    brew install redis
+
+### Option 2: From Source
+
+Download and install Redis from [http://redis.io](http://redis.io/)
+
+	wget http://redis.googlecode.com/files/redis-2.4.5.tar.gz
+    tar -zxf redis-2.4.5.tar.gz
+    mv redis-2.4.5 redis
+    cd redis
+    make
+
+## Usage
+
+    # Gemfile
+	gem 'redis-sinatra'
+
+### Cache Store:
+
+	require 'sinatra'
+	require 'redis-sinatra'
+
+	class MyApp < Sinatra::Base
+	  register Sinatra::Cache
+	  get "/hi" do
+	    settings.cache.fetch("greet") { "Hello, World!" }
+	  end
+	end
+
+Keep in mind that the above fetch will return `"OK"` on success, not the return of the block.
+
+#### Configuration
+
+For advanced configuration options, please check the [Redis Store Wiki](https://github.com/jodosha/redis-store/wiki).
+
+## Running tests
+
+    git clone git://github.com/jodosha/redis-store.git
+	cd redis-store/redis-sinatra
+	gem install bundler --pre # required version: 1.1.rc
+	bundle exec rake
+
+If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`
+
+## Copyright
+
+(c) 2009 - 2011 Luca Guidi - [http://lucaguidi.com](http://lucaguidi.com), released under the MIT license

data/Rakefile

@@ -1 +1,13 @@
-require "bundler/gem_tasks"
+require 'bundler'
+Bundler.setup
+require 'rake'
+require 'bundler/gem_tasks'
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+load 'tasks/redis.tasks.rb'
+task :default => 'redis:test:suite'

data/lib/redis-sinatra/version.rb

@@ -1,5 +1,5 @@
-module Redis
+class Redis
   module Sinatra
-    VERSION = "0.0.0"
+    VERSION = '1.3.1.rc'
   end
 end

data/lib/redis-sinatra.rb

@@ -1,6 +1,9 @@
-require "redis-sinatra/version"
+require 'sinatra'
+require 'redis-store'
+require 'redis-sinatra/version'
+require 'sinatra/cache/redis_store'
 
-module Redis
+class Redis
   module Sinatra
     # Your code goes here...
   end

data/lib/sinatra/cache/redis_store.rb

@@ -0,0 +1,131 @@
+module Sinatra
+  module Cache
+    class << self
+      def register(app)
+        app.set :cache, RedisStore.new
+      end
+      alias_method :registered, :register
+    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 "example.com:23682/1/theplaylist"
+      #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
+      #
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0"
+      #     # => instantiate a cluster
+      def initialize(*addresses)
+        @data = Redis::Factory.create addresses
+      end
+
+      def write(key, value, options = nil)
+        if options && options[:unless_exist]
+          @data.setnx key, value, options
+        else
+          @data.set key, value, options
+        end
+      end
+
+      def read(key, options = nil)
+        @data.get(key, options)
+      end
+
+      def delete(key, options = nil)
+        @data.del key
+      end
+
+      def exist?(key, options = nil)
+        @data.exists 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.incrby 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.decrby key, amount
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.del_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        @data.keys(matcher).each { |key| @data.del key }
+      end
+
+      def fetch(key, options = {})
+        (!options[:force] && data = read(key, options)) || block_given? && begin
+          data = yield
+          write(key, data, options)
+        end
+        data || nil
+      end
+
+      # Clear all the data from the store.
+      def clear
+        @data.flushdb
+      end
+
+      def stats
+        @data.info
+      end
+    end
+  end
+end

data/redis-sinatra.gemspec

@@ -18,7 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_dependency 'redis-store', '1.1.0.rc'
+  s.add_dependency 'sinatra',     '1.3.1'
+
+  s.add_development_dependency 'rake',      '~> 0.9.2.2'
+  s.add_development_dependency 'bundler',   '~> 1.1.rc'
+  s.add_development_dependency 'mocha',     '~> 0.10.0'
+  s.add_development_dependency 'minitest',  '~> 2.8.0'
+  s.add_development_dependency 'purdytest', '~> 1.0.0'
 end

data/test/redis/sinatra/version_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+describe Redis::Sinatra::VERSION do
+  it "must be equal to 1.3.1.rc" do
+    Redis::Sinatra::VERSION.must_equal '1.3.1.rc'
+  end
+end

data/test/sinatra/cache/redis_store_test.rb

@@ -0,0 +1,166 @@
+require 'test_helper'
+
+class App
+  def initialize
+    @values = {}
+  end
+
+  def set(key, value)
+    @values[key] = value
+  end
+
+  def get(key)
+    @values[key]
+  end
+end
+
+describe Sinatra::Cache::RedisStore do
+  before do
+    @store  = Sinatra::Cache::RedisStore.new
+    @dstore = Sinatra::Cache::RedisStore.new "redis://127.0.0.1:6380/1", "redis://127.0.0.1:6381/1"
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    with_store_management do |store|
+      store.write  "rabbit", @rabbit
+      store.delete "counter"
+      store.delete "rub-a-dub"
+    end
+  end
+
+  it "should register as extension" do
+    app = App.new
+    Sinatra::Cache.register(app)
+    store = app.get(:cache)
+    store.must_be_kind_of(Sinatra::Cache::RedisStore)
+  end
+
+  it "should read the data" do
+    with_store_management do |store|
+      store.read("rabbit").must_equal(@rabbit)
+    end
+  end
+
+  it "should write the data" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit
+      store.read("rabbit").must_equal(@white_rabbit)
+    end
+  end
+
+  it "should write the data with expiration time" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit, :expires_in => 1 # second
+      # store.read("rabbit").must_equal(@white_rabbit)
+      sleep 2
+      store.read("rabbit").must_be_nil
+    end
+  end
+
+  it "should not write data if :unless_exist option is true" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit, :unless_exist => true
+      store.read("rabbit").must_equal(@rabbit)
+    end
+  end
+
+  it "should read raw data" do
+    with_store_management do |store|
+      store.read("rabbit", :raw => true).must_equal(Marshal.dump(@rabbit))
+    end
+  end
+
+  it "should write raw data" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit, :raw => true
+      store.read("rabbit", :raw => true).must_equal(%(#<OpenStruct color="white">))
+    end
+  end
+
+  it "should delete data" do
+    with_store_management do |store|
+      store.delete "rabbit"
+      store.read("rabbit").must_be_nil
+    end
+  end
+
+  it "should delete matched data" do
+    with_store_management do |store|
+      store.delete_matched "rabb*"
+      store.read("rabbit").must_be_nil
+    end
+  end
+
+  it "should verify existence of an object in the store" do
+    with_store_management do |store|
+      assert store.exist?("rabbit")
+      assert ! store.exist?("rab-a-dub")
+    end
+  end
+
+  it "should increment a key" do
+    with_store_management do |store|
+      3.times { store.increment "counter" }
+      store.read("counter", :raw => true).to_i.must_equal(3)
+    end
+  end
+
+  it "should decrement a key" do
+    with_store_management do |store|
+      3.times { store.increment "counter" }
+      2.times { store.decrement "counter" }
+      store.read("counter", :raw => true).to_i.must_equal(1)
+    end
+  end
+
+  it "should increment a key by given value" do
+    with_store_management do |store|
+      store.increment "counter", 3
+      store.read("counter", :raw => true).to_i.must_equal(3)
+    end
+  end
+
+  it "should decrement a key by given value" do
+    with_store_management do |store|
+      3.times { store.increment "counter" }
+      store.decrement "counter", 2
+      store.read("counter", :raw => true).to_i.must_equal(1)
+    end
+  end
+
+  it "should clear the store" do
+    with_store_management do |store|
+      store.clear
+      store.instance_variable_get(:@data).keys("*").flatten.must_be :empty?
+    end
+  end
+
+  it "should return store stats" do
+    with_store_management do |store|
+      store.stats.wont_be :empty?
+    end
+  end
+
+  it "should fetch data" do
+    with_store_management do |store|
+      store.fetch("rabbit").must_equal(@rabbit)
+      store.fetch("rub-a-dub").must_be_nil
+      store.fetch("rub-a-dub") { "Flora de Cana" }.must_equal("Flora de Cana")
+      store.fetch("rub-a-dub").must_equal("Flora de Cana")
+      store.fetch("rabbit", :force => true).must_be_nil # force cache miss
+      store.fetch("rabbit", :force => true, :expires_in => 1) { @white_rabbit }
+      # store.fetch("rabbit").must_equal(@white_rabbit)
+      sleep 2
+      store.fetch("rabbit").must_be_nil
+    end
+  end
+
+  private
+    def instantiate_store(addresses = nil)
+      Sinatra::Cache::RedisStore.new(addresses).instance_variable_get(:@data)
+    end
+
+    def with_store_management
+      yield @store
+      yield @dstore
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+Bundler.setup
+gem 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+require 'redis-sinatra'

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: redis-sinatra
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: 
+  hash: 7712022
+  prerelease: 6
   segments: 
-  - 0
-  - 0
-  - 0
-  version: 0.0.0
+  - 1
+  - 3
+  - 1
+  - rc
+  version: 1.3.1.rc
 platform: ruby
 authors: 
 - Luca Guidi
@@ -15,9 +16,122 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-08 00:00:00 Z
-dependencies: []
-
+date: 2011-12-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis-store
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7712002
+        segments: 
+        - 1
+        - 1
+        - 0
+        - rc
+        version: 1.1.0.rc
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7712070
+        segments: 
+        - 1
+        - 1
+        - rc
+        version: 1.1.rc
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: purdytest
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id007
 description: Redis for Sinatra
 email: 
 - guidi.luca@gmail.com
@@ -30,10 +144,16 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- MIT-LICENSE
+- README.md
 - Rakefile
 - lib/redis-sinatra.rb
 - lib/redis-sinatra/version.rb
+- lib/sinatra/cache/redis_store.rb
 - redis-sinatra.gemspec
+- test/redis/sinatra/version_test.rb
+- test/sinatra/cache/redis_store_test.rb
+- test/test_helper.rb
 homepage: http://jodosha.github.com/redis-store
 licenses: []
 
@@ -54,12 +174,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: redis-sinatra
@@ -67,5 +189,8 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Redis for Sinatra
-test_files: []
-
+test_files: 
+- test/redis/sinatra/version_test.rb
+- test/sinatra/cache/redis_store_test.rb
+- test/test_helper.rb
+has_rdoc: