resque-retry 0.0.1 → 0.0.2

data/HISTORY.md

@@ -0,0 +1,11 @@
+## 0.0.2 (2010-05-06)
+
+* Bugfix: Were calling non-existent method to delete redis key.
+* Delay no-longer falls back to `sleep`. resque-scheduler is a required
+  dependancy.
+* Redis key doesn't include ending colon `:` if no args were passed
+  to the job.
+
+## 0.0.1 (2010-04-27)
+
+* First release.

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2010 Luke Antins
+Copyright (c) 2010 Ryan Carver
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 resque-retry
 ============
 
-A [Resque][rq] plugin. Requires Resque 1.8.0.
+A [Resque][rq] plugin. Requires Resque 1.8.0 & [resque-scheduler][rqs]
 
 resque-retry provides retry, delay and exponential backoff support for
 resque jobs.
@@ -13,10 +13,6 @@ resque jobs.
   - Exponential backoff (varying the delay between retrys).
   - Small & Extendable - plenty of places to override retry logic/settings.
 
-**n.b.** [resque-scheduler][rqs] is _really_ recommended if you wish to
-delay between retry attempts, otherwise your workers will block
-using `sleep`.
-
 Usage / Examples
 ----------------
 
@@ -33,6 +29,7 @@ Retry the job **once** on failure, with zero delay.
 
     class DeliverWebHook
       extend Resque::Plugins::Retry
+      @queue = :web_hooks
 
       def self.perform(url, hook_id, hmac_key)
         heavy_lifting
@@ -47,6 +44,8 @@ determine if we can requeue the job for another go.
 
     class DeliverWebHook
       extend Resque::Plugins::Retry
+      @queue = :web_hooks
+
       @retry_limit = 10
       @retry_delay = 120
 
@@ -67,6 +66,7 @@ Use this if you wish to vary the delay between retry attempts:
 
     class DeliverSMS
       extend Resque::Plugins::ExponentialBackoff
+      @queue = :mt_messages
 
       def self.perform(mt_id, mobile_number, message)
         heavy_lifting
@@ -93,8 +93,10 @@ it so only specific exceptions are retried using `retry_exceptions`:
 
     class DeliverSMS
       extend Resque::Plugins::Retry
+      @queue = :mt_messages
+
       @retry_exceptions = [NetworkError]
-      
+
       def self.perform(mt_id, mobile_number, message)
         heavy_lifting
       end
@@ -127,6 +129,7 @@ Or you can define the entire key by overriding `redis_retry_key`.
 
     class DeliverSMS
       extend Resque::Plugins::Retry
+      @queue = :mt_messages
 
       def self.identifier(mt_id, mobile_number, message)
         "#{mobile_number}:#{mt_id}"
@@ -144,7 +147,8 @@ job arguments, to modify the arguments for the next retry attempt.
 
     class DeliverViaSMSC
       extend Resque::Plugins::Retry
-
+      @queue = :mt_smsc_messages
+      
       # retry using the emergency SMSC.
       def self.args_for_retry(smsc_id, mt_message)
         [999, mt_message]

data/Rakefile

@@ -21,5 +21,5 @@ YARD::Rake::YardocTask.new :yardoc do |t|
     t.options = ['--output-dir', "doc/",
                  '--files', 'LICENSE',
                  '--readme', 'README.md',
-                 '--title', 'resque-exponential-backoff documentation']
+                 '--title', 'resque-retry documentation']
 end

data/lib/resque/plugins/exponential_backoff.rb

@@ -7,6 +7,7 @@ module Resque
     #
     #   class DeliverSMS
     #     extend Resque::Plugins::ExponentialBackoff
+    #     @queue = :mt_messages
     #
     #     def self.perform(mt_id, mobile_number, message)
     #       heavy_lifting
@@ -17,6 +18,7 @@ module Resque
     #
     #   class DeliverSMS
     #     extend Resque::Plugins::ExponentialBackoff
+    #     @queue = :mt_messages
     #
     #     @retry_limit = 4
     #

data/lib/resque/plugins/retry.rb

@@ -7,6 +7,7 @@ module Resque
     #
     #   class DeliverWebHook
     #     extend Resque::Plugins::Retry # allows 1 retry by default.
+    #     @queue = :web_hooks
     #
     #     def self.perform(url, hook_id, hmac_key)
     #       heavy_lifting
@@ -17,6 +18,7 @@ module Resque
     #
     #   class DeliverWebHook
     #     extend Resque::Plugins::Retry
+    #     @queue = :web_hooks
     #
     #     @retry_limit = 8          # default: 1
     #     @retry_delay = 60 # default: 0
@@ -43,7 +45,8 @@ module Resque
       # @param [Array] args job arguments
       # @return [String] job identifier
       def identifier(*args)
-        args.join('-')
+        args_string = args.join('-')
+        args_string.empty? ? nil : args_string
       end
 
       ##
@@ -130,15 +133,12 @@ module Resque
 
       ##
       # Will retry the job.
-      #
-      # n.b. If your not using the resque-scheduler plugin your job will block
-      # your worker, while it sleeps for `retry_delay`.
       def try_again(*args)
-        if Resque.respond_to?(:enqueue_in) && retry_delay > 0
-          Resque.enqueue_in(retry_delay, self, *args_for_retry(*args))
-        else
-          sleep(retry_delay) if retry_delay > 0
+        if retry_delay <= 0
+          # If the delay is 0, no point passing it through the scheduler
           Resque.enqueue(self, *args_for_retry(*args))
+        else
+          Resque.enqueue_in(retry_delay, self, *args_for_retry(*args))
         end
       end
 
@@ -169,7 +169,7 @@ module Resque
         if retry_criteria_valid?(exception, *args)
           try_again(*args)
         else
-          delete_retry_redis_key(*args)
+          Resque.redis.del(redis_retry_key(*args))
         end
       end
     end

data/test/retry_test.rb

@@ -105,4 +105,37 @@ class RetryTest < Test::Unit::TestCase
     assert_equal 0, Resque.info[:pending], 'pending jobs'
   end
 
+  def test_delete_redis_key_when_job_is_successful
+    Resque.enqueue(GoodJob, 'arg1')
+
+    assert_equal nil, Resque.redis.get(GoodJob.redis_retry_key('arg1'))
+    perform_next_job(@worker)
+    assert_equal nil, Resque.redis.get(GoodJob.redis_retry_key('arg1'))
+  end
+
+  def test_delete_redis_key_after_final_failed_retry
+    Resque.enqueue(FailFiveTimesJob, 'yarrrr')
+    assert_equal nil, Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
+
+    perform_next_job(@worker)
+    assert_equal '0', Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
+
+    perform_next_job(@worker)
+    assert_equal '1', Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
+
+    5.times do
+      perform_next_job(@worker)
+    end
+    assert_equal nil, Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
+
+    assert_equal 5, Resque.info[:failed], 'failed jobs'
+    assert_equal 6, Resque.info[:processed], 'processed job'
+    assert_equal 0, Resque.info[:pending], 'pending jobs'
+  end
+  
+  def test_job_without_args_has_no_ending_colon_in_redis_key
+    assert_equal 'resque-retry:GoodJob:yarrrr', GoodJob.redis_retry_key('yarrrr')
+    assert_equal 'resque-retry:GoodJob:foo', GoodJob.redis_retry_key('foo')
+    assert_equal 'resque-retry:GoodJob', GoodJob.redis_retry_key
+  end
 end

data/test/test_jobs.rb

@@ -3,6 +3,7 @@ HierarchyCustomException = Class.new(CustomException)
 AnotherCustomException = Class.new(StandardError)
 
 class GoodJob
+  extend Resque::Plugins::Retry
   @queue = :testing
   def self.perform(*args)
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Luke Antins
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-27 00:00:00 +01:00
+date: 2010-05-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,19 +33,21 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: turn
+  name: resque-scheduler
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
+        - 8
         - 0
-        version: "0"
-  type: :development
+        version: 1.8.0
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: turn
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
@@ -57,7 +59,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: resque-scheduler
+  name: yard
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
@@ -68,32 +70,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: |
-  A resque plugin; provides retry, delay and exponential backoff support for
-  resque jobs.
-  
-  Retry Example:
-  
-      require 'resque-retry'
-  
-      class DeliverWebHook
-        extend Resque::Plugins::Retry
-  
-        def self.perform(url, hook_id, hmac_key)
-          heavy_lifting
-        end
-      end
-      
-  Exponential Backoff Example:
-  
-      class DeliverSMS
-        extend Resque::Plugins::ExponentialBackoff
-  
-        def self.perform(mobile_number, message)
-          heavy_lifting
-        end
-      end
-
+description: "  resque-retry provides retry, delay and exponential backoff support for\n  resque jobs.\n\n  Features:\n\n  * Redis backed retry count/limit.\n  * Retry on all or specific exceptions.\n  * Exponential backoff (varying the delay between retrys).\n  * Small & Extendable - plenty of places to override retry logic/settings.\n"
 email: luke@lividpenguin.com
 executables: []
 
@@ -105,6 +82,7 @@ files:
 - LICENSE
 - Rakefile
 - README.md
+- HISTORY.md
 - test/exponential_backoff_test.rb
 - test/redis-test.conf
 - test/resque_test.rb