boss_queue 0.2.4 → 0.3.0

data/README.md

@@ -67,6 +67,9 @@ Usage
     myobject = MyClass.new
     # default failure action is 'retry' which retries up to four times
     queue = BossQueue.new(:failure_action => 'none', :queue => 'emails')
+    # or we can set up a callback method to be called on the enqueued class / object
+    # when there is a failure
+    queue = BossQueue.new(:failure_action => 'callback', :failure_callback => :method_to_execute_on_failure, :queue => 'emails')
 
     # can enqueue instance methods (assumes that objects have an id and a #find(id) method)
     queue.enqueue(myobject, :method_to_execute, arg1, arg2)
@@ -82,7 +85,7 @@ Usage
 
     # failures are left in the DynamoDB table with the failed boolean set to true
 
-BossQueue does not at present have a daemon component such as Sidekiq or Resque.
+BossQueue does not at present have a daemon component like Sidekiq and Resque do.
 
 
 Future Work

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/boss_queue.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "boss_queue"
-  s.version = "0.2.4"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Nelson"]
-  s.date = "2013-09-27"
+  s.date = "2013-10-03"
   s.description = "A fault tolerant job queue built around Amazon SQS & DynamoDB"
   s.email = "daniel@populr.me"
   s.extra_rdoc_files = [

data/lib/boss_queue/boss_queue.rb

@@ -5,6 +5,7 @@ class BossQueue
 
   def initialize(options={})
     @failure_action = options[:failure_action] if options[:failure_action]
+    @failure_callback = options[:failure_callback] if options[:failure_callback]
     @queue_postfix = options[:queue] ? '_' + options[:queue] : ''
   end
 
@@ -16,6 +17,10 @@ class BossQueue
     @failure_action ||= 'retry'
   end
 
+  def failure_callback
+    @failure_callback
+  end
+
   def table_name
     "#{BossQueue.queue_prefix}boss_queue_jobs"
   end
@@ -57,33 +62,32 @@ class BossQueue
     job_dequeued
   end
 
-  def enqueue(class_or_instance, method_name, *args)
-    job = create_job(class_or_instance, method_name, *args)
+  def enqueue(class_or_instance, callback_method, *args)
+    job = create_job(class_or_instance, callback_method, *args)
     job.enqueue
   end
 
-  def enqueue_with_delay(delay, class_or_instance, method_name, *args)
-    job = create_job(class_or_instance, method_name, *args)
+  def enqueue_with_delay(delay, class_or_instance, callback_method, *args)
+    job = create_job(class_or_instance, callback_method, *args)
     job.enqueue_with_delay(delay)
   end
 
-  def create_job(class_or_instance, method_name, *args) # :nodoc:
+  def create_job(class_or_instance, callback_method, *args) # :nodoc:
     job = BossQueue::Job.shard(table_name).new
     if class_or_instance.is_a?(Class)
       class_name = class_or_instance.to_s
       instance_id = nil
-      job.kind = "#{class_name}@#{method_name}"
     else
       class_name = class_or_instance.class.to_s
       instance_id = class_or_instance.id
-      job.kind = "#{class_name}##{method_name}"
     end
     job.queue_name = queue_name
     job.failure_action = failure_action
+    job.failure_callback = failure_callback.to_s if failure_action == 'callback' && failure_callback
     job.model_class_name = class_name
     job.model_id = instance_id unless instance_id.nil?
-    job.job_method = method_name.to_s
-    job.job_arguments = JSON.generate(args)
+    job.callback = callback_method.to_s
+    job.args = JSON.generate(args)
     job.save!
     job
   end

data/lib/boss_queue/job.rb

@@ -5,16 +5,16 @@ class BossQueue
   class Job < AWS::Record::HashModel
     attr_accessor :queue_name
 
-    string_attr :kind # an index based model_class_name, job_method
     boolean_attr :failed
 
     string_attr :model_class_name
     string_attr :model_id
-    string_attr :job_method
-    string_attr :job_arguments
+    string_attr :callback
+    string_attr :args
 
     integer_attr :failed_attempts
     string_attr :failure_action
+    string_attr :failure_callback
     string_attr :exception_name
     string_attr :exception_message
     string_attr :stacktrace
@@ -59,14 +59,7 @@ class BossQueue
 
     def work
       begin
-        klass = constantize(model_class_name)
-        if model_id
-          target = klass.find(model_id)
-        else
-          target = klass
-        end
-        args = JSON.parse(job_arguments)
-        target.send(job_method, *args)
+        target.send(callback, *arguments)
         destroy
       rescue StandardError => err
         fail(err)
@@ -82,11 +75,17 @@ class BossQueue
 
       if failure_action == 'retry' && retry_delay
         enqueue_with_delay(retry_delay)
+        self.save!
+
+      elsif failure_action == 'callback' &&
+            failure_callback &&
+            target.send(failure_callback, *arguments)
+        destroy
+
       else
         self.failed = true
+        self.save!
       end
-
-      self.save!
     end
 
     def retry_delay
@@ -100,6 +99,19 @@ class BossQueue
 
     private
 
+    def arguments
+      JSON.parse(args)
+    end
+
+    def target
+      klass = constantize(model_class_name)
+      if model_id
+        klass.find(model_id)
+      else
+        klass
+      end
+    end
+
     def sqs_queue
       @sqs_queue ||= AWS::SQS.new.queues[AWS::SQS.new.queues.url_for(queue_name)]
     end

data/spec/boss_queue_spec.rb

@@ -4,15 +4,16 @@ describe "BossQueue module" do
   before(:each) do
     BossQueue.environment = 'test'
 
-    BossQueue::Job.any_instance.stub(:kind=)
     BossQueue::Job.any_instance.stub(:queue_name=)
     BossQueue::Job.any_instance.stub(:failure_action=)
+    BossQueue::Job.any_instance.stub(:failure_callback=)
     BossQueue::Job.any_instance.stub(:model_class_name=)
     BossQueue::Job.any_instance.stub(:model_id=)
-    BossQueue::Job.any_instance.stub(:job_method=)
-    BossQueue::Job.any_instance.stub(:job_arguments=)
+    BossQueue::Job.any_instance.stub(:callback=)
+    BossQueue::Job.any_instance.stub(:args=)
     BossQueue::Job.any_instance.stub(:save!)
     BossQueue::Job.any_instance.stub(:enqueue)
+    BossQueue::Job.any_instance.stub(:enqueue_with_delay)
   end
 
   it "should respond to environment" do
@@ -146,13 +147,12 @@ describe "BossQueue module" do
     context "when a class" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
         queue = BossQueue.new
-        BossQueue::Job.any_instance.should_receive(:kind=).with('TestClass@test_class_method')
         BossQueue::Job.any_instance.should_receive(:queue_name=).with('test_boss_queue')
         BossQueue::Job.any_instance.should_receive(:failure_action=).with('retry')
         BossQueue::Job.any_instance.should_receive(:model_class_name=).with('TestClass')
         BossQueue::Job.any_instance.should_not_receive(:model_id=)
-        BossQueue::Job.any_instance.should_receive(:job_method=).with('test_class_method')
-        BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
+        BossQueue::Job.any_instance.should_receive(:callback=).with('test_class_method')
+        BossQueue::Job.any_instance.should_receive(:args=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue)
         queue.enqueue(TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
@@ -162,19 +162,26 @@ describe "BossQueue module" do
     context "when a class instance" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
         queue = BossQueue.new
-        BossQueue::Job.any_instance.should_receive(:kind=).with('TestClass#test_instance_method')
         BossQueue::Job.any_instance.should_receive(:queue_name=).with('test_boss_queue')
         BossQueue::Job.any_instance.should_receive(:failure_action=).with('retry')
         BossQueue::Job.any_instance.should_receive(:model_class_name=).with('TestClass')
         BossQueue::Job.any_instance.should_receive(:model_id=).with('xyz')
-        BossQueue::Job.any_instance.should_receive(:job_method=).with('test_instance_method')
-        BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
+        BossQueue::Job.any_instance.should_receive(:callback=).with('test_instance_method')
+        BossQueue::Job.any_instance.should_receive(:args=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue)
         queue.enqueue(TestClass.new, :test_instance_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
       end
     end
 
+    context "when failure_action is 'callback'" do
+      it "should set the job failure_callback to the failure_callback option" do
+        queue = BossQueue.new(:failure_action => 'callback', :failure_callback => :call_if_failed)
+        BossQueue::Job.any_instance.should_receive(:failure_callback=).with('call_if_failed')
+        queue.enqueue(TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+      end
+    end
+
   end
 
   describe "#enqueue_with_delay" do
@@ -186,13 +193,12 @@ describe "BossQueue module" do
     context "when a class" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
         queue = BossQueue.new
-        BossQueue::Job.any_instance.should_receive(:kind=).with('TestClass@test_class_method')
         BossQueue::Job.any_instance.should_receive(:queue_name=).with('test_boss_queue')
         BossQueue::Job.any_instance.should_receive(:failure_action=).with('retry')
         BossQueue::Job.any_instance.should_receive(:model_class_name=).with('TestClass')
         BossQueue::Job.any_instance.should_not_receive(:model_id=)
-        BossQueue::Job.any_instance.should_receive(:job_method=).with('test_class_method')
-        BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
+        BossQueue::Job.any_instance.should_receive(:callback=).with('test_class_method')
+        BossQueue::Job.any_instance.should_receive(:args=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue_with_delay).with(60)
         queue.enqueue_with_delay(60, TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
@@ -202,19 +208,26 @@ describe "BossQueue module" do
     context "when a class instance" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
         queue = BossQueue.new
-        BossQueue::Job.any_instance.should_receive(:kind=).with('TestClass#test_instance_method')
         BossQueue::Job.any_instance.should_receive(:queue_name=).with('test_boss_queue')
         BossQueue::Job.any_instance.should_receive(:failure_action=).with('retry')
         BossQueue::Job.any_instance.should_receive(:model_class_name=).with('TestClass')
         BossQueue::Job.any_instance.should_receive(:model_id=).with('xyz')
-        BossQueue::Job.any_instance.should_receive(:job_method=).with('test_instance_method')
-        BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
+        BossQueue::Job.any_instance.should_receive(:callback=).with('test_instance_method')
+        BossQueue::Job.any_instance.should_receive(:args=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue_with_delay).with(60)
         queue.enqueue_with_delay(60, TestClass.new, :test_instance_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
       end
     end
 
+    context "when failure_action is 'callback'" do
+      it "should set the job failure_callback to the failure_callback option" do
+        queue = BossQueue.new(:failure_action => 'callback', :failure_callback => :call_if_failed)
+        BossQueue::Job.any_instance.should_receive(:failure_callback=).with('call_if_failed')
+        queue.enqueue_with_delay(60, TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+      end
+    end
+
   end
 
   describe "#work" do

data/spec/job_spec.rb

@@ -96,21 +96,21 @@ describe "BossQueue::Job" do
   end
 
 
-  it "should respond to job_method" do
-    BossQueue::Job.new.should respond_to(:job_method)
+  it "should respond to callback" do
+    BossQueue::Job.new.should respond_to(:callback)
   end
 
-  it "should respond to job_method=" do
-    BossQueue::Job.new.should respond_to(:job_method=)
+  it "should respond to callback=" do
+    BossQueue::Job.new.should respond_to(:callback=)
   end
 
 
-  it "should respond to job_arguments" do
-    BossQueue::Job.new.should respond_to(:job_arguments)
+  it "should respond to args" do
+    BossQueue::Job.new.should respond_to(:args)
   end
 
-  it "should respond to job_arguments=" do
-    BossQueue::Job.new.should respond_to(:job_arguments=)
+  it "should respond to args=" do
+    BossQueue::Job.new.should respond_to(:args=)
   end
 
 
@@ -120,10 +120,10 @@ describe "BossQueue::Job" do
       @job.stub(:destroy)
       @job.model_class_name = 'TestClass'
       @job.model_id = 'xyz'
-      @job.job_method = 'test_instance_method'
+      @job.callback = 'test_instance_method'
       @arguments = ['a', 'b', { 'c' => 2, 'd' => 1 }]
       @argument_json = JSON.generate(@arguments)
-      @job.job_arguments = @argument_json
+      @job.args = @argument_json
       @instance_to_work_on = double('instance_to_work_on')
       @instance_to_work_on.stub(:test_instance_method)
       TestClass.stub(:find).and_return(@instance_to_work_on)
@@ -147,10 +147,10 @@ describe "BossQueue::Job" do
         @job = BossQueue::Job.new
         @job.stub(:destroy)
         @job.model_class_name = 'TestClass'
-        @job.job_method = 'test_class_method'
+        @job.callback = 'test_class_method'
         @arguments = ['a', 'b', { 'c' => 2, 'd' => 1 }]
         @argument_json = JSON.generate(@arguments)
-        @job.job_arguments = @argument_json
+        @job.args = @argument_json
       end
 
       it "should pass the job arguments to the job method on the class" do
@@ -316,6 +316,47 @@ describe "BossQueue::Job" do
       @job.fail(@err)
     end
 
+    context "when failure_action is 'callback'" do
+      before(:each) do
+        @job.failure_action = 'callback'
+        @job.failure_callback = 'failure'
+
+        @job.stub(:destroy)
+        @job.model_class_name = 'TestClass'
+        @job.model_id = 'xyz'
+        @job.callback = 'test_instance_method'
+        @arguments = ['a', 'b', { 'c' => 2, 'd' => 1 }]
+        @argument_json = JSON.generate(@arguments)
+        @job.args = @argument_json
+        @instance_to_work_on = double('instance_to_work_on')
+        @instance_to_work_on.stub(:test_instance_method)
+        @instance_to_work_on.stub(:failure).and_return(false)
+        TestClass.stub(:find).and_return(@instance_to_work_on)
+      end
+
+      it "should call the failure_callback method with the arguments" do
+        @instance_to_work_on.should_receive(:failure).with('a', 'b', { 'c' => 2, 'd' => 1 })
+        @job.fail(@err)
+      end
+
+      context "when the failure_callback method returns truthy" do
+        it "should delete the job" do
+          @job.should_receive(:destroy)
+          @instance_to_work_on.stub(:failure).and_return(true)
+          @job.fail(@err)
+        end
+      end
+
+      context "when the failure_callback method returns falsey" do
+        it "should mark the job as failed" do
+          @job.should_not_receive(:destroy)
+          @instance_to_work_on.stub(:failure).and_return(false)
+          @job.fail(@err)
+          @job.failed.should be_true
+        end
+      end
+    end
+
     context "when failure_action is 'retry'" do
       before(:each) do
         @job.failure_action = 'retry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boss_queue
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2592417147040776871
+      hash: 2478012361978662154
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: