boss_queue 0.1.10 → 0.2.0

data/README.md

@@ -19,21 +19,25 @@ boss_queue uses an Amazon SQS queue and a Amazon DynamoDB table for each environ
     AWS.config(:access_key_id => <access_key_id>,
                :secret_access_key => <secret_access_key>)
 
+    queue = BossQueue.new # default queue name
+    # or
+    queue = BossQueue.new(:queue => 'emails') # customized queue name (so you can have separate job queues)
+
     BossQueue.environment = 'development'
-    BossQueue.create_table
-    BossQueue.create_queue
+    queue.create_table
+    queue.create_queue
 
     BossQueue.environment = 'staging'
-    BossQueue.create_table
-    BossQueue.create_queue
+    queue.create_table
+    queue.create_queue
 
     # BossQueue.create_table(read_capacity, write_capacity)
     # One read capacity unit = two eventually consistent reads per second, for items up 4 KB in size.
     # One write capacity unit = one write per second, for items up to 1 KB in size.
 
     BossQueue.environment = 'production'
-    BossQueue.create_table(50, 10)
-    BossQueue.create_queue
+    queue.create_table(50, 10)
+    queue.create_queue
 
 
 Alternatively, in each of the respective environments, do:
@@ -55,18 +59,19 @@ Usage
 =====
 
     myobject = MyClass.new
-    BossQueue.failure_action = 'none' # default is 'retry' which retries up to four times
+    # default failure action is 'retry' which retries up to four times
+    queue = BossQueue.new(:failure_action => 'none', :queue => 'emails')
 
     # can enqueue instance methods (assumes that objects have an id and a #find(id) method)
-    BossQueue.enqueue(myobject, :method_to_execute, arg1, arg2)
+    queue.enqueue(myobject, :method_to_execute, arg1, arg2)
     # enqueue with a delay of up to 900 seconds (15 minutes)
-    BossQueue.enqueue_with_delay(60, myobject, :method_to_execute, arg1, arg2, arg3)
+    queue.enqueue_with_delay(60, myobject, :method_to_execute, arg1, arg2, arg3)
 
     # can enqueue class methods
-    BossQueue.enqueue(MyClass, :method_to_execute)
-    BossQueue.enqueue_with_delay(60, MyClass, :method_to_execute, arg1, arg2)
+    queue.enqueue(MyClass, :method_to_execute)
+    queue.enqueue_with_delay(60, MyClass, :method_to_execute, arg1, arg2)
 
-    BossQueue.work
+    queue.work
 
     # failures are left in the DynamoDB table with the failed boolean set to true
 

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.2.0

data/boss_queue.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "boss_queue"
-  s.version = "0.1.10"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Nelson"]

data/lib/boss_queue/boss_queue.rb

@@ -1,50 +1,48 @@
 require 'json'
 
 class BossQueue
-  @@environment
+  @@environment = nil
 
-  def self.environment=(env)
-    @@environment = env
+  def initialize(options={})
+    @failure_action = options[:failure_action] if options[:failure_action]
+    @queue_postfix = options[:queue] ? '_' + options[:queue] : ''
   end
 
-  @@failure_action
-
-  def self.failure_action
-    @@failure_action ||= 'retry'
+  def self.environment=(env)
+    @@environment = env
   end
 
-  def self.failure_action=(env)
-    @@failure_action = env
+  def failure_action
+    @failure_action ||= 'retry'
   end
 
-
-  def self.table_name
-    "#{self.queue_prefix}boss_queue_jobs"
+  def table_name
+    "#{BossQueue.queue_prefix}boss_queue_jobs"
   end
 
-  def self.queue_name
-    "#{self.queue_prefix}boss_queue"
+  def queue_name
+    "#{BossQueue.queue_prefix}boss_queue#{@queue_postfix}"
   end
 
 
-  def self.create_table(read_capacity=1, write_capacity=1, options={})
+  def create_table(read_capacity=1, write_capacity=1, options={})
     create_opts = {}
     create_opts[:hash_key] = { :id => :string }
 
-    AWS::DynamoDB.new.tables.create(self.table_name, read_capacity, write_capacity, create_opts)
+    AWS::DynamoDB.new.tables.create(table_name, read_capacity, write_capacity, create_opts)
   end
 
-  def self.create_queue
-    AWS::SQS::QueueCollection.new.create(self.queue_name, :default_visibility_timeout => 5 * 60)
+  def create_queue
+    AWS::SQS::QueueCollection.new.create(queue_name, :default_visibility_timeout => 5 * 60)
   end
 
-  def self.work
+  def work
     work_done = false
-    self.sqs_queue.receive_message do |job_id|
+    sqs_queue.receive_message do |job_id|
       # When a block is given, each message is yielded to the block and then deleted as long as the block exits normally - http://docs.aws.amazon.com/AWSRubySDK/latest/frames.html
       begin
         job = BossQueue::Job.shard(table_name).find(job_id.body)
-        job.queue_name = self.queue_name
+        job.sqs_queue = sqs_queue
         job.work
         work_done = true
       rescue AWS::Record::RecordNotFound
@@ -53,17 +51,17 @@ class BossQueue
     work_done
   end
 
-  def self.enqueue(class_or_instance, method_name, *args)
-    job = self.create_job(class_or_instance, method_name, *args)
+  def enqueue(class_or_instance, method_name, *args)
+    job = create_job(class_or_instance, method_name, *args)
     job.enqueue
   end
 
-  def self.enqueue_with_delay(delay, class_or_instance, method_name, *args)
-    job = self.create_job(class_or_instance, method_name, *args)
+  def enqueue_with_delay(delay, class_or_instance, method_name, *args)
+    job = create_job(class_or_instance, method_name, *args)
     job.enqueue_with_delay(delay)
   end
 
-  def self.create_job(class_or_instance, method_name, *args) # :nodoc:
+  def create_job(class_or_instance, method_name, *args) # :nodoc:
     job = BossQueue::Job.shard(table_name).new
     if class_or_instance.is_a?(Class)
       class_name = class_or_instance.to_s
@@ -74,8 +72,8 @@ class BossQueue
       instance_id = class_or_instance.id
       job.kind = "#{class_name}##{method_name}"
     end
-    job.queue_name = self.queue_name
-    job.failure_action = self.failure_action
+    job.queue_name = queue_name
+    job.failure_action = failure_action
     job.model_class_name = class_name
     job.model_id = instance_id unless instance_id.nil?
     job.job_method = method_name.to_s
@@ -84,8 +82,8 @@ class BossQueue
     job
   end
 
-  def self.sqs_queue # :nodoc:
-    AWS::SQS.new.queues[AWS::SQS.new.queues.url_for(self.queue_name)]
+  def sqs_queue # :nodoc:
+    @sqs_queue ||= AWS::SQS.new.queues[AWS::SQS.new.queues.url_for(queue_name)]
   end
 
   def self.environment # :nodoc:

data/lib/boss_queue/job.rb

@@ -66,10 +66,14 @@ class BossQueue
       60 * 2**(failed_attempts - 1)
     end
 
+    def sqs_queue=(queue_obj) # :nodoc:
+      @sqs_queue = queue_obj
+    end
+
     private
 
     def sqs_queue
-      AWS::SQS.new.queues[AWS::SQS.new.queues.url_for(queue_name)]
+      @sqs_queue ||= AWS::SQS.new.queues[AWS::SQS.new.queues.url_for(queue_name)]
     end
 
     # from ActiveSupport source: http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-constantize

data/spec/boss_queue_spec.rb

@@ -1,6 +1,19 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 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(: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(:save!)
+    BossQueue::Job.any_instance.stub(:enqueue)
+  end
 
   it "should respond to environment" do
     BossQueue.should respond_to(:environment)
@@ -10,17 +23,13 @@ describe "BossQueue module" do
     BossQueue.should respond_to(:environment=)
   end
 
-  it "should respond to failure_action" do
-    BossQueue.should respond_to(:failure_action)
-  end
-
-  it "should respond to failure_action=" do
-    BossQueue.should respond_to(:failure_action=)
-  end
-
   describe "#failure_action" do
     it "should default to 'retry'" do
-      BossQueue.failure_action.should == 'retry'
+      BossQueue.new.failure_action.should == 'retry'
+    end
+
+    it "should be overridable by a :failure_action option on initialize" do
+      BossQueue.new(:failure_action => 'none').failure_action.should == 'none'
     end
   end
 
@@ -32,35 +41,35 @@ describe "BossQueue module" do
     context "when @@environment is 'development'" do
       it "should be 'dev_boss_queue_jobs'" do
         BossQueue.environment = 'development'
-        BossQueue.table_name.should == 'dev_boss_queue_jobs'
+        BossQueue.new.table_name.should == 'dev_boss_queue_jobs'
       end
     end
 
     context "when @@environment is 'production'" do
       it "should be 'boss_queue_jobs'" do
         BossQueue.environment = 'production'
-        BossQueue.table_name.should == 'boss_queue_jobs'
+        BossQueue.new.table_name.should == 'boss_queue_jobs'
       end
     end
 
     context "when @@environment is 'staging'" do
       it "should be 'staging_boss_queue_jobs'" do
         BossQueue.environment = 'staging'
-        BossQueue.table_name.should == 'staging_boss_queue_jobs'
+        BossQueue.new.table_name.should == 'staging_boss_queue_jobs'
       end
     end
 
     context "when @@environment is 'staging'" do
       it "should be 'staging_boss_queue_jobs'" do
         BossQueue.environment = 'staging'
-        BossQueue.table_name.should == 'staging_boss_queue_jobs'
+        BossQueue.new.table_name.should == 'staging_boss_queue_jobs'
       end
     end
 
     context "when @@environment is nil" do
       it "should raise an exception" do
         lambda {
-          BossQueue.table_name
+          BossQueue.new.table_name
         }.should raise_error
       end
     end
@@ -75,38 +84,45 @@ describe "BossQueue module" do
     context "when @@environment is 'development'" do
       it "should be 'dev_boss_queue'" do
         BossQueue.environment = 'development'
-        BossQueue.queue_name.should == 'dev_boss_queue'
+        BossQueue.new.queue_name.should == 'dev_boss_queue'
       end
     end
 
     context "when @@environment is 'production'" do
       it "should be 'boss_queue'" do
         BossQueue.environment = 'production'
-        BossQueue.queue_name.should == 'boss_queue'
+        BossQueue.new.queue_name.should == 'boss_queue'
       end
     end
 
     context "when @@environment is 'staging'" do
       it "should be 'staging_boss_queue'" do
         BossQueue.environment = 'staging'
-        BossQueue.queue_name.should == 'staging_boss_queue'
+        BossQueue.new.queue_name.should == 'staging_boss_queue'
       end
     end
 
     context "when @@environment is 'staging'" do
       it "should be 'staging_boss_queue'" do
         BossQueue.environment = 'staging'
-        BossQueue.queue_name.should == 'staging_boss_queue'
+        BossQueue.new.queue_name.should == 'staging_boss_queue'
       end
     end
 
     context "when @@environment is nil" do
       it "should raise an exception" do
         lambda {
-          BossQueue.queue_name
+          BossQueue.new.queue_name
         }.should raise_error
       end
     end
+
+    context "when a queue option is included in the initializer" do
+      it "should append that to the queue name" do
+        BossQueue.environment = 'production'
+        BossQueue.new(:queue => 'emails').queue_name.should == 'boss_queue_emails'
+      end
+    end
   end
 
   describe "#enqueue" do
@@ -129,8 +145,7 @@ describe "BossQueue module" do
 
     context "when a class" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
-        BossQueue.environment = 'test'
-        BossQueue.failure_action = 'retry'
+        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')
@@ -140,14 +155,13 @@ describe "BossQueue module" do
         BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue)
-        BossQueue.enqueue(TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+        queue.enqueue(TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
       end
     end
 
     context "when a class instance" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
-        BossQueue.environment = 'test'
-        BossQueue.failure_action = 'retry'
+        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')
@@ -157,7 +171,7 @@ describe "BossQueue module" do
         BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue)
-        BossQueue.enqueue(TestClass.new, :test_instance_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+        queue.enqueue(TestClass.new, :test_instance_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
       end
     end
 
@@ -171,8 +185,7 @@ describe "BossQueue module" do
 
     context "when a class" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
-        BossQueue.environment = 'test'
-        BossQueue.failure_action = 'retry'
+        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')
@@ -182,14 +195,13 @@ describe "BossQueue module" do
         BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue_with_delay).with(60)
-        BossQueue.enqueue_with_delay(60, TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+        queue.enqueue_with_delay(60, TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
       end
     end
 
     context "when a class instance" do
       it "should initialize a new BossQueue::Job object, save and call enqueue on it" do
-        BossQueue.environment = 'test'
-        BossQueue.failure_action = 'retry'
+        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')
@@ -199,7 +211,7 @@ describe "BossQueue module" do
         BossQueue::Job.any_instance.should_receive(:job_arguments=).with(@argument_json)
         BossQueue::Job.any_instance.should_receive(:save!)
         BossQueue::Job.any_instance.should_receive(:enqueue_with_delay).with(60)
-        BossQueue.enqueue_with_delay(60, TestClass.new, :test_instance_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+        queue.enqueue_with_delay(60, TestClass.new, :test_instance_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
       end
     end
 
@@ -207,59 +219,64 @@ describe "BossQueue module" do
 
   describe "#work" do
     before(:each) do
-      @queue = double('queue')
+      @sqs_queue = double('queue')
       AWS::SQS.stub_chain(:new, :queues, :url_for).and_return('queue_url')
-      AWS::SQS.stub_chain(:new, :queues, :[]).and_return(@queue)
+      AWS::SQS.stub_chain(:new, :queues, :[]).and_return(@sqs_queue)
 
       @sqs_message = double('message')
       @sqs_message.stub(:body).and_return('ijk')
-      @queue.stub(:receive_message)
+      @sqs_queue.stub(:receive_message)
 
       @job = double('job')
       @job.stub(:work)
-      @job.stub(:queue_name=)
+      @job.stub(:sqs_queue=)
       BossQueue::Job.stub_chain(:shard, :find).and_return(@job)
     end
 
-    it "should dequeue from SQS" do
-      @queue.should_receive(:receive_message).and_yield(@sqs_message)
-      BossQueue.work
+    it "should dequeue from SQS using the value of sqs_queue_url" do
+      @sqs_queue.should_receive(:receive_message).and_yield(@sqs_message)
+      BossQueue.new.work
     end
 
     context "when something is dequeued from SQS" do
       before(:each) do
-        @queue.should_receive(:receive_message).and_yield(@sqs_message)
+        @sqs_queue.should_receive(:receive_message).and_yield(@sqs_message)
       end
 
       it "should use the dequeued id to retrieve a BossQueue::Job object" do
         shard = double('shard')
-        BossQueue::Job.should_receive(:shard).with(BossQueue.table_name).and_return(shard)
+        BossQueue::Job.should_receive(:shard).with(BossQueue.new.table_name).and_return(shard)
         shard.should_receive(:find).with('ijk').and_return(@job)
-        BossQueue.work
+        BossQueue.new.work
       end
 
       context "when the dequeued id does not match a BossQueue::Job object" do
         it "should not raise an exception" do
           BossQueue::Job.stub_chain(:shard, :find).and_raise(AWS::Record::RecordNotFound.new)
           lambda {
-            BossQueue.work
+            BossQueue.new.work
           }.should_not raise_error
         end
       end
 
+      it "should set the sqs_queue of the job since we already did the work of retrieving it's url" do
+        @job.should_receive(:sqs_queue=).with(@sqs_queue)
+        BossQueue.new.work
+      end
+
       it "should call work on the BossQueue::Job object" do
         @job.should_receive(:work)
-        BossQueue.work
+        BossQueue.new.work
       end
 
       it "should return true" do
-        BossQueue.work.should be_true
+        BossQueue.new.work.should be_true
       end
     end
 
     context "when nothing is dequeued from SQS" do
       it "should return false" do
-        BossQueue.work.should be_false
+        BossQueue.new.work.should be_false
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boss_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2976249042738102520
+      hash: 539574413423499853
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: