backburner 0.0.2 → 0.0.3

data/README.md

@@ -105,7 +105,8 @@ Here's an example:
 ```ruby
 class NewsletterJob
   include Backburner::Queue
-  queue "newsletter"
+  queue "newsletter"  # defaults to 'newsletter-job'
+  queue_priority 1000 # most urgent priority is 0
 
   def self.perform(email, body)
     NewsletterMailer.deliver_text_to_email(email, body)
@@ -132,6 +133,8 @@ includes `Backburner::Performable`. Async enqueuing works for both instance and
 ```ruby
 class User
   include Backburner::Performable
+  queue "newsletter"  # defaults to 'newsletter-job'
+  queue_priority 1000 # most urgent priority is 0
 
   def activate(device_id)
     @device = Device.find(device_id)

data/TODO

@@ -1,5 +1,9 @@
-- Better way to enummerate job names in worker (right now using the tubes that exist but they may not exist even tho they will)
-  - Use a better way to aggregate tube names for different jobs
 - Front-end in sinatra for viewing beanstalk jobs
+  - https://github.com/denniskuczynski/beanstalkd_view
 - Better logging
-- Better error handling (failures, retries)
+  - https://github.com/dpree/stalker/commit/70e94b7b445e08166bf2288dd1b7853396b26a86
+- Better error handling (failures, retries)
+  - https://github.com/michaeldwan/stalker/commit/afd7e94d20991bcd96b65eda7c979d92d8746c3b
+  - https://github.com/michaeldwan/stalker/blob/master/lib/stalker/worker.rb
+- Fork jobs to control memory
+  - https://github.com/michaeldwan/stalker/commit/386267690a7c03e11d1a8b7b6f08b7c9c7cd2c0d

data/backburner.gemspec

@@ -15,9 +15,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.version       = Backburner::VERSION
 
-  s.add_runtime_dependency(%q<beanstalk-client>, [">= 0"])
-  s.add_runtime_dependency(%q<json_pure>, [">= 0"])
-  s.add_runtime_dependency(%q<dante>)
+  s.add_runtime_dependency 'beanstalk-client', '~> 1.1'
+  s.add_runtime_dependency 'dante', '~> 0.1.5'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest'

data/lib/backburner/logger.rb

@@ -1,6 +1,5 @@
 module Backburner
   module Logger
-
     # Loads in instance and class levels
     def self.included(base)
       base.extend self
@@ -8,7 +7,7 @@ module Backburner
 
     # Print out when a job is about to begin
     def log_job_begin(body)
-      log [ "Working", body ].join(' ')
+      log_info [ "Working", body ].join(' ')
       @job_begun = Time.now
     end
 
@@ -16,25 +15,15 @@ module Backburner
     def log_job_end(name, failed=false)
       ellapsed = Time.now - @job_begun
       ms = (ellapsed.to_f * 1000).to_i
-      log "Finished #{name} in #{ms}ms #{failed ? ' (failed)' : ''}"
-    end
-
-    # Prints message about failure when beastalk cannot be connected
-    #
-    # @example
-    #   failed_connection(ex)
-    def failed_connection(e)
-      log_error exception_message(e)
-      log_error "*** Failed connection to #{connection.url}"
-      log_error "*** Check that beanstalkd is running (or set a different beanstalk url)"
-      exit 1
+      log_info "Finished #{name} in #{ms}ms #{failed ? ' (failed)' : ''}"
     end
 
     # Print a message to stdout
     #
     # @example
-    #   log("Working on task")
-    def log(msg)
+    #   log_info("Working on task")
+    #
+    def log_info(msg)
       puts msg
     end
 
@@ -42,6 +31,7 @@ module Backburner
     #
     # @example
     #   log_error("Task failed!")
+    #
     def log_error(msg)
       $stderr.puts msg
     end

data/lib/backburner/queue.rb

@@ -11,7 +11,8 @@ module Backburner
       #
       # @example
       #   queue "some.task.name"
-      #   queue => "some.task.name"
+      #   @klass.queue # => "some.task.name"
+      #
       def queue(name=nil)
         if name
           @queue_name = name
@@ -19,6 +20,20 @@ module Backburner
           @queue_name || dasherize(self.name)
         end
       end
+
+      # Returns or assigns queue priority for this job
+      #
+      # @example
+      #   queue_priority 120
+      #   @klass.queue_priority # => 120
+      #
+      def queue_priority(pri=nil)
+        if pri
+          @queue_priority = pri
+        else # accessor
+          @queue_priority
+        end
+      end
     end # ClassMethods
   end # Job
 end # Backburner

data/lib/backburner/version.rb

@@ -1,3 +1,3 @@
 module Backburner
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/backburner/worker.rb

@@ -15,23 +15,24 @@ module Backburner
     # Enqueues a job to be processed later by a worker
     # Options: `pri` (priority), `delay` (delay in secs), `ttr` (time to respond), `queue` (queue name)
     #
+    # @raise [Beanstalk::NotConnected] If beanstalk fails to connect.
     # @example
     #   Backburner::Worker.enqueue NewsletterSender, [self.id, user.id], :ttr => 1000
     #
     def self.enqueue(job_class, args=[], opts={})
-      pri   = opts[:pri] || Backburner.configuration.default_priority
+      pri   = opts[:pri] || job_class.queue_priority || Backburner.configuration.default_priority
       delay = [0, opts[:delay].to_i].max
       ttr   = opts[:ttr] || Backburner.configuration.respond_timeout
       connection.use expand_tube_name(opts[:queue]  || job_class)
       data = { :class => job_class.name, :args => args }
       connection.put data.to_json, pri, delay, ttr
-    rescue Beanstalk::NotConnected => e
-      failed_connection(e)
     end
 
     # Starts processing jobs in the specified tube_names
+    #
     # @example
     #   Backburner::Worker.start(["foo.tube.name"])
+    #
     def self.start(tube_names=nil)
       self.new(tube_names).start
     end
@@ -59,8 +60,10 @@ module Backburner
 
     # Starts processing new jobs indefinitely
     # Primary way to consume and process jobs in specified tubes
+    #
     # @example
     #   @worker.start
+    #
     def start
       prepare
       loop { work_one_job }
@@ -68,35 +71,34 @@ module Backburner
 
     # Setup beanstalk tube_names and watch all specified tubes for jobs.
     # Used to prepare job queues before processing jobs.
+    #
+    # @raise [Beanstalk::NotConnected] If beanstalk fails to connect.
     # @example
     #   @worker.prepare
+    #
     def prepare
       self.tube_names ||= Backburner.default_queues.any? ? Backburner.default_queues : all_existing_queues
       self.tube_names = Array(self.tube_names)
       self.tube_names.map! { |name| expand_tube_name(name)  }
-      log "Working #{tube_names.size} queues: [ #{tube_names.join(', ')} ]"
+      log_info "Working #{tube_names.size} queues: [ #{tube_names.join(', ')} ]"
       self.tube_names.uniq.each { |name| self.connection.watch(name) }
       self.connection.list_tubes_watched.each do |server, tubes|
         tubes.each { |tube| self.connection.ignore(tube) unless self.tube_names.include?(tube) }
       end
-    rescue Beanstalk::NotConnected => e
-      failed_connection(e)
     end
 
     # Reserves one job within the specified queues
     # Pops the job off and serializes the job to JSON
     # Each job is performed by invoking `perform` on the job class.
+    #
     # @example
     #   @worker.work_one_job
+    #
     def work_one_job
       job = Backburner::Job.new(self.connection.reserve)
       self.class.log_job_begin(job.body)
       job.process
       self.class.log_job_end(job.name)
-    rescue Beanstalk::NotConnected => e
-      failed_connection(e)
-    rescue SystemExit
-      raise
     rescue => e
       job.bury
       self.class.log_error self.class.exception_message(e)

data/test/logger_test.rb

@@ -3,12 +3,12 @@ require File.expand_path('../test_helper', __FILE__)
 describe "Backburner::Logger module" do
   include Backburner::Logger
 
-  describe "for log method" do
+  describe "for log_info method" do
     it "prints out to std out" do
-      output = capture_stdout { log("foo") }
+      output = capture_stdout { log_info("foo") }
       assert_equal "foo\n", output
     end
-  end # log
+  end # log_info
 
   describe "for log_error method" do
     it "prints out to std err" do

data/test/queue_test.rb

@@ -25,4 +25,11 @@ describe "Backburner::Queue module" do
       assert_equal "nested/job", NestedDemo::TestJobB.queue
     end
   end # queue
+
+  describe "for queue_priority assignment method" do
+    it "should allow queue priority to be assigned" do
+      NestedDemo::TestJobB.queue_priority(1000)
+      assert_equal 1000, NestedDemo::TestJobB.queue_priority
+    end
+  end # queue
 end # Backburner::Queue

data/test/worker_test.rb

@@ -4,6 +4,7 @@ $worker_test_count = 0
 
 class TestJob
   include Backburner::Queue
+  queue_priority 1000
   def self.perform(x, y); $worker_test_count += x + y; end
 end
 
@@ -27,7 +28,7 @@ describe "Backburner::Worker module" do
       assert_equal "TestJob", body["class"]
       assert_equal [3, 4], body["args"]
       assert_equal 100, job.ttr
-      assert_equal Backburner.configuration.default_priority, job.pri
+      assert_equal 1000, job.pri
     end # simple
 
     it "should support enqueuing job with custom queue" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backburner
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,44 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &2152606340 !ruby/object:Gem::Requirement
+  requirement: &2152606520 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2152606340
-- !ruby/object:Gem::Dependency
-  name: json_pure
-  requirement: &2152605640 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2152605640
+  version_requirements: *2152606520
 - !ruby/object:Gem::Dependency
   name: dante
-  requirement: &2152605220 !ruby/object:Gem::Requirement
+  requirement: &2152605920 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *2152605220
+  version_requirements: *2152605920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152604580 !ruby/object:Gem::Requirement
+  requirement: &2152605440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152604580
+  version_requirements: *2152605440
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2152604000 !ruby/object:Gem::Requirement
+  requirement: &2152604860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152604000
+  version_requirements: *2152604860
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152603460 !ruby/object:Gem::Requirement
+  requirement: &2152604240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152603460
+  version_requirements: *2152604240
 description: Beanstalk background job processing made easy
 email:
 - nesquena@gmail.com