resque-timely 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.rbenv-gemsets

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+group :test do
+  gem "rake",     "~> 0.9.2.2"
+  gem "minitest", "~> 4.1.0"
+end
+
+gemspec

data/License.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Amoyal
+
+MIT License
+
+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,45 @@
+# Resque Timely
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "resque-timely"
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install resque-timely
+
+## Usage
+
+Resque Timely requires you to do two things:
+
+1. Include Resque::Plugins::Timely in your Resque Job class
+2. Implement the timely_timeout class method to return the timeout in seconds
+
+For example:
+```ruby
+class YourTimelyJob
+  include Resque::Plugins::Timely
+
+  def self.timely_timeout
+    3 # 3 seconds
+  end
+end
+```
+
+## Requirements
+
+Resque Timeout will only work with 1.9.x and above. Specifically it's tested with 1.9.3.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_spec.rb"
+end
+
+task :default => :test

data/lib/resque-timely.rb

@@ -0,0 +1,2 @@
+require "resque"
+require "#{File.dirname(__FILE__)}/resque/plugins/timely"

data/lib/resque/plugins/timely.rb

@@ -0,0 +1,23 @@
+require 'timeout'
+
+module Resque
+  module Plugins
+    module Timely
+
+      def self.included base
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        def around_perform_with_timeout *args
+          if respond_to? :timely_timeout
+            ::Timeout.timeout(timely_timeout){ yield }
+          else
+            yield
+          end
+        end
+      end
+
+    end
+  end
+end

data/resque-timely.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name            = "resque-timely"
+  s.version         = "0.1.0"
+  s.authors         = ["Tony Amoyal"]
+  s.email           = "tonyamoyal@gmail.com"
+  s.description     = "Set time limits on Resque jobs per Job class."
+  s.summary         = "For Resque jobs that need a time limit"
+  s.homepage        = "http://github.com/getsidewalk/resque-timely"
+  s.license         = "MIT"
+  s.platform        = Gem::Platform::RUBY
+  
+  s.files           = `git ls-files`.split("\n")
+  s.test_files      = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths   = ["lib"]
+
+  s.add_dependency "resque", "~>1.0"
+  s.add_dependency "json"
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+end

data/test/resque_timely_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path("../test_helper.rb", __FILE__)
+
+describe Resque::Plugins::Timely do
+  it "times out when timely but too slow" do
+    ->{
+      Resque.enqueue PoorlyBehavedTimelyJob
+    }.must_raise Timeout::Error
+  end
+  
+  it "doesn't time out when timely but fast enough" do
+    Resque.enqueue WellBehavedTimelyJob
+    WellBehavedTimelyJob.some_state.must_equal "anything but something"
+  end
+  
+  it "doesn't act timely if the module is not included" do
+    Resque.enqueue UntimelyJob
+    UntimelyJob.some_state.must_equal "anything but something"
+  end
+
+  it "doesn't act timely if the timely_timeout method is not implemented" do
+    Resque.enqueue ConfusedJob
+    ConfusedJob.some_state.must_equal "anything but something"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,69 @@
+require "rubygems"
+require "bundler"
+Bundler.require(:default, :test)
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require "resque-timely"
+
+require "minitest/autorun"
+
+Resque.inline = true
+
+class PoorlyBehavedTimelyJob
+  include Resque::Plugins::Timely
+  @queue = :poorly_behaved
+  
+  def self.timely_timeout
+    1.9
+  end
+  
+  def self.perform
+    sleep 2
+  end
+end
+
+class WellBehavedTimelyJob
+  include Resque::Plugins::Timely
+  @queue = :well_behaved
+  @some_state = nil
+  
+  def self.some_state
+    @some_state
+  end
+  
+  def self.timely_timeout
+    3
+  end
+  
+  def self.perform
+    sleep 2
+    @some_state = "anything but something"
+  end
+end
+
+class UntimelyJob
+  @queue = :untimely
+  @some_state = nil
+  
+  def self.some_state
+    @some_state
+  end
+
+  def self.perform
+    @some_state = "anything but something"
+  end
+end
+
+class ConfusedJob
+  include Resque::Plugins::Timely
+  @queue = :confused
+  @some_state = nil
+  
+  def self.some_state
+    @some_state
+  end
+
+  def self.perform
+    @some_state = "anything but something"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: resque-timely
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tony Amoyal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set time limits on Resque jobs per Job class.
+email: tonyamoyal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- License.txt
+- README.md
+- Rakefile
+- lib/resque-timely.rb
+- lib/resque/plugins/timely.rb
+- resque-timely.gemspec
+- test/resque_timely_spec.rb
+- test/test_helper.rb
+homepage: http://github.com/getsidewalk/resque-timely
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: For Resque jobs that need a time limit
+test_files: []