backburner 0.4.3 → 0.4.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cefef513a8a0bdd3a88721c01eb503c01f4aa3c
+  data.tar.gz: b9b0506df21468b7496c5a6b7dec90492c0dc899
+SHA512:
+  metadata.gz: 0da929c2d10311de013e5b1943754fdeb5dc75e598cb2e52097510827ebf23df93a8cb788be599fbfc54fbf83f3b15637a0c91825cbeb49c3da995a7f734363e
+  data.tar.gz: 16783da0512636828941b8a141539c67f4a3dc528f2d0a66e065b4c5c2c3ea710a7c4d658829753362e40f4d3981d6fbb329d4df5c0573d8e006721c5f4692e7

data/.travis.yml

@@ -1,9 +1,20 @@
 # http://about.travis-ci.org/docs/user/build-configuration/
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
   - rbx-19mode
+before_install:
+  - curl -L https://github.com/kr/beanstalkd/archive/v1.9.tar.gz | tar xz -C /tmp
+  - cd /tmp/beanstalkd-1.9/
+  - make
+  - ./beanstalkd &
+  - cd $TRAVIS_BUILD_DIR
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode
+script:
+  - bundle install
+  - bundle exec rake test
 gemfile: Gemfile
 notifications:
   recipients:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Version 0.4.4 (October 27 2013)
+
+ * NEW #51 Added ability to set per-queue default ttr's (Thanks @ryanjohns)
+
 ## Version 0.4.3 (July 19 2013)
 
  * FIX #44 Additional fix to issue introduced in 0.4.2

data/HOOKS.md

@@ -34,17 +34,21 @@ Hooks are just methods prefixed with the hook type. For example:
 ```ruby
 class SomeJob
   def self.before_perform_log_job(*args)
-    Logger.info "About to perform #{self} with #{args.inspect}"
+    logger.info "About to perform #{self} with #{args.inspect}"
   end
 
   def self.on_failure_bury(e, *args)
-    Logger.info "Performing #{self} caused an exception (#{e})"
+    logger.info "Performing #{self} caused an exception (#{e})"
     self.bury
   end
 
   def self.perform(*args)
     # ...
   end
+  
+  def self.logger
+    @_logger ||= Logger.new(STDOUT)
+  end
 end
 ```
 

data/README.md

@@ -149,6 +149,11 @@ class NewsletterJob
   def self.queue_priority
     1000 # most urgent priority is 0
   end
+
+  # optional, defaults to respond_timeout
+  def self.queue_respond_timeout
+    300 # number of seconds before job times out
+  end
 end
 ```
 
@@ -159,6 +164,7 @@ class NewsletterJob
   include Backburner::Queue
   queue "newsletter-sender"  # defaults to 'backburner-jobs' tube
   queue_priority 1000 # most urgent priority is 0
+  queue_respond_timeout 300 # number of seconds before job times out
 
   def self.perform(email, body)
     NewsletterMailer.deliver_text_to_email(email, body)
@@ -186,6 +192,7 @@ class User
   include Backburner::Performable
   queue "user-jobs"  # defaults to 'user'
   queue_priority 500 # most urgent priority is 0
+  queue_respond_timeout 300 # number of seconds before job times out
 
   def activate(device_id)
     @device = Device.find(device_id)

data/backburner.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.name          = "backburner"
   s.require_paths = ["lib"]
   s.version       = Backburner::VERSION
+  s.license       = 'MIT'
 
   s.add_runtime_dependency 'beaneater', '~> 0.3.1'
   s.add_runtime_dependency 'dante', '~> 0.1.5'

data/lib/backburner/helpers.rb

@@ -116,5 +116,22 @@ module Backburner
       end
     end
 
+    # Resolves job respond timeout based on the value given. Can be integer, a class or nothing
+    #
+    # @example
+    #  resolve_respond_timeout(1000) => 1000
+    #  resolve_respond_timeout(FooBar) => <queue respond_timeout>
+    #  resolve_respond_timeout(nil) => <default respond_timeout>
+    #
+    def resolve_respond_timeout(ttr)
+      if ttr.respond_to?(:queue_respond_timeout)
+        resolve_respond_timeout(ttr.queue_respond_timeout)
+      elsif ttr.is_a?(Fixnum) # numerical
+        ttr
+      else # default
+        Backburner.configuration.respond_timeout
+      end
+    end
+
   end # Helpers
 end # Backburner

data/lib/backburner/queue.rb

@@ -33,6 +33,20 @@ module Backburner
           @queue_priority
         end
       end
+
+      # Returns or assigns queue respond_timeout for this job
+      #
+      # @example
+      #   queue_respond_timeout 120
+      #   @klass.queue_respond_timeout # => 120
+      #
+      def queue_respond_timeout(ttr=nil)
+        if ttr
+          @queue_respond_timeout = ttr
+        else # accessor
+          @queue_respond_timeout
+        end
+      end
     end # ClassMethods
   end # Queue
 end # Backburner

data/lib/backburner/version.rb

@@ -1,3 +1,3 @@
 module Backburner
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/lib/backburner/worker.rb

@@ -26,7 +26,7 @@ module Backburner
     def self.enqueue(job_class, args=[], opts={})
       pri   = resolve_priority(opts[:pri] || job_class)
       delay = [0, opts[:delay].to_i].max
-      ttr   = opts[:ttr] || Backburner.configuration.respond_timeout
+      ttr   = resolve_respond_timeout(opts[:ttr] || job_class)
       res = Backburner::Hooks.invoke_hook_events(job_class, :before_enqueue, *args)
       return false unless res # stop if hook is false
       data = { :class => job_class.name, :args => args }

data/test/fixtures/test_jobs.rb

@@ -9,6 +9,7 @@ end
 class TestJob
   include Backburner::Queue
   queue_priority :medium
+  queue_respond_timeout 300
   def self.perform(x, y); $worker_test_count += x + y; end
 end
 

data/test/helpers_test.rb

@@ -78,8 +78,14 @@ describe "Backburner::Helpers module" do
   end # expand_tube_name
 
   describe "for resolve_priority method" do
-    before { Backburner.configure { |config| config.default_priority = 1000 }  }
-    after  { Backburner.configure { |config| config.priority_labels = Backburner::Configuration::PRIORITY_LABELS } }
+    before do
+      @original_queue_priority = Backburner.configuration.default_priority
+      Backburner.configure { |config| config.default_priority = 1000 }
+    end
+    after do
+      Backburner.configure { |config| config.default_priority = @original_queue_priority }
+      Backburner.configure { |config| config.priority_labels = Backburner::Configuration::PRIORITY_LABELS }
+    end
 
     it "supports fix num priority" do
       assert_equal 500, resolve_priority(500)
@@ -124,4 +130,35 @@ describe "Backburner::Helpers module" do
       assert_equal 1000, resolve_priority(nil)
     end
   end # resolve_priority
+
+  describe "for resolve_respond_timeout method" do
+    before do
+      @original_respond_timeout = Backburner.configuration.respond_timeout
+      Backburner.configure { |config| config.respond_timeout = 300 }
+    end
+    after { Backburner.configure { |config| config.respond_timeout = @original_respond_timeout } }
+
+    it "supports fix num respond_timeout" do
+      assert_equal 500, resolve_respond_timeout(500)
+    end
+
+    it "supports classes which respond to queue_respond_timeout" do
+      job = stub(:queue_respond_timeout => 600)
+      assert_equal 600, resolve_respond_timeout(job)
+    end
+
+    it "supports classes which returns null queue_respond_timeout" do
+      job = stub(:queue_respond_timeout => nil)
+      assert_equal 300, resolve_respond_timeout(job)
+    end
+
+    it "supports classes which don't respond to queue_respond_timeout" do
+      job = stub(:fake => true)
+      assert_equal 300, resolve_respond_timeout(job)
+    end
+
+    it "supports default ttr for null values" do
+      assert_equal 300, resolve_respond_timeout(nil)
+    end
+  end # resolve_respond_timeout
 end

data/test/queue_test.rb

@@ -31,5 +31,12 @@ describe "Backburner::Queue module" do
       NestedDemo::TestJobB.queue_priority(1000)
       assert_equal 1000, NestedDemo::TestJobB.queue_priority
     end
-  end # queue
+  end # queue_priority
+
+  describe "for queue_respond_timeout assignment method" do
+    it "should allow queue respond_timeout to be assigned" do
+      NestedDemo::TestJobB.queue_respond_timeout(300)
+      assert_equal 300, NestedDemo::TestJobB.queue_respond_timeout
+    end
+  end # queue_respond_timeout
 end # Backburner::Queue

data/test/test_helper.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'tempfile'
 require 'minitest/autorun'
-require 'mocha'
+require 'mocha/setup'
 $:.unshift File.expand_path("../../lib")
 require 'backburner'
 require File.expand_path('../helpers/templogger', __FILE__)

data/test/worker_test.rb

@@ -5,7 +5,7 @@ require File.expand_path('../fixtures/hooked', __FILE__)
 describe "Backburner::Worker module" do
   before do
     Backburner.default_queues.clear
-    clear_jobs!(Backburner.configuration.primary_queue)
+    clear_jobs!(Backburner.configuration.primary_queue, "test-plain", "test.bar", "bar.baz.foo")
   end
 
   describe "for enqueue class method" do
@@ -25,7 +25,7 @@ describe "Backburner::Worker module" do
       assert_equal [3, 4], body["args"]
       assert_equal 100, job.ttr
       assert_equal 100, job.pri
-    end # queue
+    end # queue priority
 
     it "should support enqueuing job with specified named priority" do
       Backburner::Worker.enqueue TestJob, [3, 4], :ttr => 100, :pri => 'high'
@@ -34,7 +34,16 @@ describe "Backburner::Worker module" do
       assert_equal [3, 4], body["args"]
       assert_equal 100, job.ttr
       assert_equal 0, job.pri
-    end # queue
+    end # queue named priority
+
+    it "should support enqueuing job with class queue respond_timeout" do
+      Backburner::Worker.enqueue TestJob, [3, 4]
+      job, body = pop_one_job
+      assert_equal "TestJob", body["class"]
+      assert_equal [3, 4], body["args"]
+      assert_equal 300, job.ttr
+      assert_equal 100, job.pri
+    end # queue respond_timeout
 
     it "should support enqueuing job with custom queue" do
       Backburner::Worker.enqueue TestJob, [6, 7], :queue => "test.bar", :pri => 5000
@@ -43,7 +52,7 @@ describe "Backburner::Worker module" do
       assert_equal [6, 7], body["args"]
       assert_equal 0, job.delay
       assert_equal 5000, job.pri
-      assert_equal Backburner.configuration.respond_timeout, job.ttr
+      assert_equal 300, job.ttr
     end # custom
 
     it "should support async job" do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: backburner
 version: !ruby/object:Gem::Version
-  version: 0.4.3
-  prerelease: 
+  version: 0.4.4
 platform: ruby
 authors:
 - Nathan Esquenazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaneater
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,23 +41,20 @@ dependencies:
 - !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'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -78,17 +69,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   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: Beanstalk background job processing made easy
@@ -156,34 +145,28 @@ files:
 - test/workers/simple_worker_test.rb
 - test/workers/threads_on_fork_worker_test.rb
 homepage: http://github.com/nesquena/backburner
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2883142524196216213
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2883142524196216213
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Reliable beanstalk background job processing made easy for Ruby and Sinatra
 test_files:
 - test/async_proxy_test.rb
@@ -205,3 +188,4 @@ test_files:
 - test/workers/forking_worker_test.rb
 - test/workers/simple_worker_test.rb
 - test/workers/threads_on_fork_worker_test.rb
+has_rdoc: