resque-timeout 1.0.0

data/README.md

@@ -0,0 +1,16 @@
+resque-timeout
+====
+
+Resque plugin to allow long-running jobs to timeout (and fail) automatically.
+
+To install:
+
+    $ gem install resque-timeout
+
+To set the timeout (in seconds, default is 600):
+
+    Resque::Plugins::Timeout.timeout = 60
+
+To turn it off (it is on by default):
+
+    Resque::Plugins::Timeout.switch = :off

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-timeout"
+    gem.summary = "Timeout for long-running jobs in Resque"
+    gem.description = 'Resque plugin allowing long-running jobs to automatically fail after a specified time.'
+    gem.email = "jeff.gran@gmail.com"
+    gem.homepage = "http://github.com/jeffgran/resque-timeout"
+    gem.authors = ["Jeff Gran"]
+    gem.add_dependency "resque", "~>1.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque-fairly #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/resque-timeout.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'resque', :version => '~> 1.0'
+require 'resque'
+
+require File.expand_path('resque/plugins/timeout', File.dirname(__FILE__))
+
+

data/lib/resque/plugins/timeout.rb

@@ -0,0 +1,44 @@
+require 'resque/worker'
+require 'timeout'
+
+module Resque::Plugins
+  module Timeout
+    
+    def self.switch
+      @switch ||= :on
+    end
+
+    def self.switch=(val)
+      @switch = val
+    end
+
+    def self.timeout
+      @timeout ||= 600
+    end
+
+    def self.timeout=(val)
+      @timeout = val
+    end
+
+    def around_perform_with_timeout(*args)
+      ::Timeout.timeout(Resque::Plugins::Timeout.timeout) do
+        yield
+      end
+    end
+
+  end
+  
+  # inject the Timeout mixin into the job class right before it
+  # executes (if it's not already there). This will give it the
+  # `around_perform_...` method above which wraps the execution
+  # in the ::Timeout.timeout block
+  Resque.before_fork do |job|
+    if Resque::Plugins::Timeout.switch == :on && 
+        !(job.payload_class.kind_of?(Resque::Plugins::Timeout))
+      job.payload_class.send(:extend, Resque::Plugins::Timeout)
+    end
+      
+  end
+end
+
+

data/resque-timeout.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{resque-timeout}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Gran"]
+  s.date = %q{2011-03-07}
+  s.description = %q{Resque plugin allowing long-running jobs to automatically fail after a specified time.}
+  s.email = %q{jeff.gran@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/resque-timeout.rb",
+    "lib/resque/plugins/timeout.rb",
+    "resque-timeout.gemspec",
+    "spec/resque-timeout_spec.rb",
+    "spec/resque/plugins/timeout_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jeffgran/resque-timeout}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Timeout for long-running jobs in Resque}
+  s.test_files = [
+    "spec/resque-timeout_spec.rb",
+    "spec/resque/plugins/timeout_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, ["~> 1.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<resque>, ["~> 1.0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["~> 1.0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/resque-timeout_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ResqueTimeout" do
+end

data/spec/resque/plugins/timeout_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path("../../spec_helper", File.dirname(__FILE__))
+
+class TestJob
+  def self.perform
+    1.upto 5 do
+      putc '+'
+      sleep(1)
+    end
+  end
+end
+
+describe Resque::Plugins::Timeout do
+  it "kills jobs that run past the time limit" do
+    # set up the timeout
+    Resque::Plugins::Timeout.timeout = 2
+
+    # create a job
+    Resque::Job.create('queueZ', TestJob)
+
+    # create a worker and get the job
+    worker = Resque::Worker.new('queueZ')
+    job = Resque::Job.reserve('queueZ')
+
+    # mimic the forking and running of the job (with plugin hooks)
+    worker.run_hook :before_fork, job
+    worker.process(job)
+
+    worker.failed.should == 1
+  end
+
+  it 'should not timeout if the plugin is turned off' do
+    # turn it off
+    Resque::Plugins::Timeout.switch = :off
+
+    # create a job
+    Resque::Job.create('queueZ', TestJob)
+
+    # create a worker and get the job
+    worker = Resque::Worker.new('queueZ')
+    job = Resque::Job.reserve('queueZ')
+
+    # mimic the forking and running of the job (with plugin hooks)
+    worker.run_hook :before_fork, job
+    worker.process(job)
+
+    worker.failed.should == 1
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--diff c

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'resque-timeout'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: resque-timeout
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeff Gran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -07: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: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.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: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+description: Resque plugin allowing long-running jobs to automatically fail after a specified time.
+email: jeff.gran@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- lib/resque-timeout.rb
+- lib/resque/plugins/timeout.rb
+- resque-timeout.gemspec
+- spec/resque-timeout_spec.rb
+- spec/resque/plugins/timeout_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jeffgran/resque-timeout
+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: Timeout for long-running jobs in Resque
+test_files: 
+- spec/resque-timeout_spec.rb
+- spec/resque/plugins/timeout_spec.rb
+- spec/spec_helper.rb