resque-insist 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque-insist.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    resque-insist (0.1.0)
+      resque (~> 1.10.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    rack (1.2.1)
+    redis (2.1.1)
+    redis-namespace (0.8.0)
+      redis (< 3.0.0)
+    resque (1.10.0)
+      json (~> 1.4.6)
+      redis-namespace (~> 0.8.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    sinatra (1.1.0)
+      rack (~> 1.1)
+      tilt (~> 1.1)
+    tilt (1.1)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  resque (~> 1.10.0)
+  resque-insist!
+  rspec (~> 2.2.0)

data/README.md

@@ -0,0 +1,48 @@
+# Resque::Plugins::Insist
+## Give your Resque jobs a second chance
+
+<http://github.com/jrom/resque-insist> by Jordi Romero
+
+If you want to give your jobs a second chance (or more)
+extend them with this plugin and let the job fail
+some times before considering it failed.
+
+By default a job will be run 3 times before marking it
+as failed, but you can configure that with @insist = N
+in your job.
+
+## Usage
+
+    require 'resque/plugins/insist'
+    class HardJob
+      extend Resque::Plugins::Insist
+      @queue = :hard_job
+      @insist = 5
+      def self.perform(something)
+        do_work
+      end
+    end
+
+When your job fails for the first time, it will be queued
+again, but will be locked for 8 seconds before the worker
+performs it again. If it fails again, the wait time will be
+16 seconds, then 32, 64, ... until your job reaches the
+maximum number of attempts or just succeeds (not raising an
+exception).
+
+## Contributing
+
+If you want to improve resque-insist
+
+1. Fork the repo
+2. Create a topic branch `git checkout -b my_feature`
+3. Push it! `git push origin my_feature`
+4. Open a pull request
+
+Make sure you add specs for your changes and document them.
+Any contribution will be appreciated, both fixing some typo or
+adding the coolest feature ever.
+
+## Issues
+
+<http://github.com/jrom/resque-insist/issues>

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/resque/plugins/insist.rb

@@ -0,0 +1,77 @@
+module Resque # :nodoc:
+  module Plugins # :nodoc:
+    # If you want to give your jobs a second chance (or more)
+    # extend them with this plugin and let the job fail
+    # some times before considering it failed.
+    #
+    # By default a job will be run 3 times before marking it
+    # as failed, but you can configure that with @insist = N
+    # in your job.
+    #
+    # Example:
+    #
+    #   require 'resque/plugins/insist'
+    #   class HardJob
+    #     extend Resque::Plugins::Insist
+    #     @queue = :hard_job
+    #     @insist = 5
+    #     def self.perform(something)
+    #       do_work
+    #     end
+    #   end
+    #
+    # When your job fails for the first time, it will be queued
+    # again, but will be locked for 8 seconds before the worker
+    # performs it again. If it fails again, the wait time will be
+    # 16 seconds, then 32, 64, ... until your job reaches the
+    # maximum number of attempts or just succeeds (not raising an
+    # exception).
+    module Insist
+      include Resque::Helpers
+      # Intercept the execution of a job to add the extra security
+      # layer.
+      def around_perform_insist(*args)
+        if redis.get "plugin:insist:wait:#{insist_key(args)}"
+          Resque.enqueue constantize(self.to_s), *args
+        else
+          begin
+            yield
+            redis.del "plugin:insist:attempts:#{insist_key(args)}"
+          rescue => e
+            attempts = redis.incr "plugin:insist:attempts:#{insist_key(args)}"
+            if attempts.to_i >= insist_times
+              redis.del "plugin:insist:wait:#{insist_key(args)}"
+              redis.del "plugin:insist:attempts:#{insist_key(args)}"
+              raise e
+            else
+              redis.set "plugin:insist:wait:#{insist_key(args)}", 1
+              redis.expire "plugin:insist:wait:#{insist_key(args)}", wait_time(attempts)
+              Resque.enqueue constantize(self.to_s), *args
+            end
+          end
+        end
+      end
+
+      # Number of times a job will be executed before considering
+      # it failed. By default it's 3. To specify it, set the ivar
+      # @insist to an integer. Any value under 1 will make the job
+      # perform just once as if the plugin was never there.
+      def insist_times
+        @insist || 3
+      end
+
+      # Calculates the amount of seconds a job is locked between
+      # the last failure and the next attempt.
+      def wait_time(attempts)
+        2 ** (attempts.to_i + 2)
+      end
+
+      private
+      # Calculates a key to identify the job according to
+      # its arguments.
+      def insist_key(*args)
+        self.to_s + ':' + Digest::SHA1.hexdigest(args.join(','))
+      end
+    end
+  end
+end

data/resque-insist.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "resque-insist"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jordi Romero"]
+  s.email       = ["jordi@jrom.net"]
+  s.homepage    = "http://github.com/jrom/resque-insist"
+  s.summary     = %q{Give your Resque jobs a second chance}
+  s.description = %q{If you want to give your jobs a second change (or more) extend them with this plugin and let the job fail some times before considering it failed.}
+
+  s.files         = `git ls-files`.split("\n") - %w(.gitignore .rspec) - ['autotest/discover.rb']
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "resque", "~> 1.10.0"
+  s.add_development_dependency "rspec", "~> 2.2.0"
+
+end

data/spec/redis-test.conf

@@ -0,0 +1,30 @@
+daemonize yes
+pidfile ./spec/redis.pid
+port 6378
+
+timeout 300
+loglevel debug
+logfile stdout
+databases 16
+
+save 900 1
+save 300 10
+save 60 10000
+rdbcompression yes
+
+dbfilename dump.rdb
+dir ./spec/
+
+appendonly no
+appendfsync everysec
+
+vm-enabled no
+vm-swap-file /tmp/redis.swap
+vm-max-memory 0
+vm-page-size 32
+vm-pages 134217728
+vm-max-threads 4
+glueoutputbuf yes
+hash-max-zipmap-entries 64
+hash-max-zipmap-value 512
+activerehashing yes

data/spec/resque_insist_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Job
+  extend Resque::Plugins::Insist
+  @queue = :job
+  @insist = 2
+  def self.perform(success)
+    raise 'Not gonna work' unless success
+  end
+end
+
+describe Resque::Plugins::Insist do
+  describe "compliance of Resque Plugins guidelines" do
+    it "should be valid" do
+      lambda{ Resque::Plugin.lint(Resque::Plugins::Insist) }.should_not raise_error
+    end
+  end
+
+  describe "config" do
+    it "should take the insist_times value from the @insist ivar" do
+      Job.insist_times.should == 2
+    end
+
+    it "shoult default insist_times to 3" do
+      class JobWithoutCustomInsist
+        extend Resque::Plugins::Insist
+        @queue = :job
+        def self.perform; end
+      end
+      JobWithoutCustomInsist.insist_times.should == 3
+    end
+  end
+
+  describe "a succeeding Job" do
+    it "should be executed on the first attempt and not be enqueued again" do
+      Resque.enqueue Job, true
+      pending.should == 1
+      processed.should == 0
+      failed.should == 0
+      work_jobs
+      pending.should == 0
+      processed.should == 1
+      failed.should == 0
+    end
+  end
+
+  describe "a failing Job" do
+    it "should should quietly die and be enqueued back the first time it's executed" do
+      Resque.enqueue Job, false # enqueue a failing job
+      work_job # try to work it for the first time
+      pending.should == 1
+      failed.should == 0
+      time_before = Time.now
+      work_jobs # try to work it for the second and last time
+      elapsed_time = Time.now - time_before
+      elapsed_time.should > 7 # We wait aprox 8 seconds
+      elapsed_time.should < 9
+      pending.should == 0
+      failed.should == 1 # the job is marked as failed after 2 attempts
+      Resque::Failure.all['error'].should == 'Not gonna work' # we get the original error
+    end
+  end
+
+  # Defines pending, failed, processed, queues, environment, workers and servers
+  Resque.info.keys.each do |key|
+    define_method(key) { Resque.info[key] }
+  end
+
+  # Starts a worker to work off queue
+  def work_jobs(queue = :job)
+    Resque::Worker.new(queue).work(0)
+  end
+
+  # Performs the first job available from queue
+  def work_job(queue = :job)
+    worker = Resque::Worker.new(queue)
+    worker.perform(worker.reserve)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+Bundler.require(:default, :development)
+require 'lib/resque/plugins/insist'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    if !system('which redis-server')
+      puts "\ncan't find `redis-server` in your path"
+      abort
+    end
+    `redis-server #{File.dirname(File.expand_path(__FILE__))}/redis-test.conf` # run Redis with local config
+    puts  "Starting test redis server: redis-server #{File.dirname(File.expand_path(__FILE__))}/redis-test.conf"
+    Resque.redis = 'localhost:6378' # port specified in redis-test.conf
+  end
+
+  config.before(:each) do
+    Resque.redis.flushall # Drop all keys between examples
+  end
+
+  config.after(:all) do
+    pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+    puts "\nKilling test redis server PID #{pid}..."
+    `rm -f #{File.dirname(File.expand_path(__FILE__))}/dump.rdb` # file specified in redis-test.conf
+    Process.kill("KILL", pid.to_i)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: resque-insist
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jordi Romero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 10
+        - 0
+        version: 1.10.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id002
+description: If you want to give your jobs a second change (or more) extend them with this plugin and let the job fail some times before considering it failed.
+email: 
+- jordi@jrom.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/resque/plugins/insist.rb
+- resque-insist.gemspec
+- spec/redis-test.conf
+- spec/resque_insist_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jrom/resque-insist
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Give your Resque jobs a second chance
+test_files: 
+- spec/redis-test.conf
+- spec/resque_insist_spec.rb
+- spec/spec_helper.rb