redis-retry 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matt Duncan
+
+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,29 @@
+redis-retry
+===========
+
+Requires the redis gem.
+
+Automatically retries all Redis calls if the Redis server is not available.
+
+    r = Redis::Retry.new(:tries => 3, :wait => 5, :redis => @r)
+
+Redis::Retry will proxy all Redis calls.  If a `Errno::ECONNREFUSED` error
+occurs, the command will be retried the specified number of times, waiting the
+specified number of seconds between tries.  After all tries have been made
+unsuccessfully, the `Errno::ECONNREFUSED` will be raised.
+
+Useful to ensure that apps don't fail when Redis is unavailable for a short
+amount of time.
+
+
+Installation
+------------
+
+    $ gem install redis-retry
+
+
+Author
+------
+
+Matt Duncan
+matt@mattduncan.org

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake/testtask'
+
+task :default => :test
+
+desc "Runs unit tests"
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test_*.rb']
+end
+
+desc "Build a gem"
+task :gem => [:gemspec, :build]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "redis-retry"
+    gemspec.summary = "Auto-retries Redis commands."
+    gemspec.email = "matt@mattduncan.org"
+    gemspec.homepage = "http://github.com/mrduncan/redis-retry"
+    gemspec.authors = ["Matt Duncan"]
+    gemspec.version = '0.1.0'
+    gemspec.add_dependency 'redis'
+    gemspec.description = <<description
+Adds a Redis::Retry class which can be used to proxy calls to Redis while
+automatically retrying when a connection cannot be made.  This is useful
+to ensure that your applications don't fail if Redis is temporarily
+unavailable.
+description
+  end
+rescue LoadError
+  warn "Jeweler not available. Install it with:"
+  warn "gem install jeweler"
+end

data/lib/redis/retry.rb

@@ -0,0 +1,40 @@
+require 'redis'
+
+class Redis
+  class Retry
+    # The number of times a command will be retried if a connection cannot be
+    # made to Redis.  If zero, retry forever.
+    attr_accessor :tries
+
+    # The number of seconds to wait before retrying a command.
+    attr_accessor :wait
+
+    def initialize(options = {})
+      @tries = options[:tries] || 3
+      @wait  = options[:wait]  || 2
+      @redis = options[:redis]
+    end
+
+    # Ruby defines a now deprecated type method so we need to override it here
+    # since it will never hit method_missing.
+    def type(key)
+      method_missing(:type, key)
+    end
+
+    def method_missing(command, *args, &block)
+      try = 1
+      while try <= @tries
+        begin
+          # Dispatch the command to Redis
+          return @redis.send(command, *args, &block)
+        rescue Errno::ECONNREFUSED
+          try += 1
+          sleep @wait
+        end
+      end
+
+      # Ran out of retries
+      raise Errno::ECONNREFUSED
+    end
+  end
+end

data/test/test_redis_retry.rb

@@ -0,0 +1,47 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'test/unit'
+require 'mocha'
+require 'redis'
+require 'redis/retry'
+
+class TestRedisRetry < Test::Unit::TestCase
+  def setup
+    @r = Redis.new :db => 15
+    @redis = Redis::Retry.new(:tries => 10, :wait => 0, :redis => @r)
+    @redis.flushdb
+  end
+
+  def test_should_set_and_get_without_retries
+    @redis['foo'] = 'bar'
+    assert_equal 'bar', @redis['foo']
+  end
+
+  def test_should_retry_after_receiving_connection_refused
+    @r.stubs(:send).raises(Errno::ECONNREFUSED).then.returns(true)
+    assert @redis['foo']
+  end
+
+  def test_should_retry_as_many_times_as_possible
+    send = sequence('send')
+    @r.stubs(:send).raises(Errno::ECONNREFUSED).times(9).in_sequence(send)
+    @r.stubs(:send).returns(true).in_sequence(send)
+    assert @redis['foo']
+  end
+
+  def test_should_fail_if_retries_are_used_up
+    @r.stubs(:send).raises(Errno::ECONNREFUSED).times(10)
+    assert_raise(Errno::ECONNREFUSED) { @redis['foo'] }
+  end
+
+  def test_should_reset_tries_for_every_call
+    # Mocha doesn't seem to like the two #raises with the #returns between
+    # unless they are distinguished by expecting different input params
+    send = sequence('send')
+    @r.stubs(:send).with(:[], 'foo').raises(Errno::ECONNREFUSED).times(8).in_sequence(send)
+    @r.stubs(:send).with(:[], 'foo').returns(true).in_sequence(send)
+    @r.stubs(:send).with(:[], 'bar').raises(Errno::ECONNREFUSED).times(8).in_sequence(send)
+    @r.stubs(:send).with(:[], 'bar').returns(true).in_sequence(send)
+    assert @redis['foo']
+    assert @redis['bar']
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: redis-retry
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Duncan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |
+  Adds a Redis::Retry class which can be used to proxy calls to Redis while
+  automatically retrying when a connection cannot be made.  This is useful
+  to ensure that your applications don't fail if Redis is temporarily
+  unavailable.
+
+email: matt@mattduncan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/redis/retry.rb
+- test/test_redis_retry.rb
+has_rdoc: true
+homepage: http://github.com/mrduncan/redis-retry
+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: Auto-retries Redis commands.
+test_files: 
+- test/test_redis_retry.rb