queue_classic 0.2.1 → 0.2.2

data/lib/queue_classic/api.rb

@@ -7,7 +7,8 @@ module QC
 
     def enqueue(job,*params)
       if job.respond_to?(:details) and job.respond_to?(:params)
-        queue.enqueue(job.signature, (job.params || []))
+        p = *job.params
+        queue.enqueue(job.signature, p)
       else
         queue.enqueue(job,params)
       end

data/readme.markdown

@@ -1,7 +1,7 @@
 # Queue Classic
-__Beta 0.2.1__
+__Beta 0.2.2__
 
-__Queue Classic 0.2.1 is in Beta.__ I have been using this library with 30-50 Heroku workers and have had great results. However, your mileage may vary.
+__Queue Classic 0.2.2 is in Beta.__ I have been using this library with 30-50 Heroku workers and have had great results.
 
 I am using this in production applications and plan to maintain and support this library for a long time.
 
@@ -68,12 +68,32 @@ To get access to these tasks, Add `require 'queue_classic/tasks'` to your Rakefi
 
 ### Enqueue
 
-To place a job onto the queue, you should specify a class and a class method. The syntax should be:
+To place a job onto the queue, you should specify a class and a class method. There are a few ways to enqueue:
 
     QC.enqueue('Class.method', :arg1 => 'value1', :arg2 => 'value2')
 
+Requires:
+
+    class Class
+      def self.method(args)
+        puts args["arg1"]
+      end
+    end
+
+    QC.enqueue('Class.method', 'value1', 'value2')
+
+Requires:
+
+    class Class
+      def self.method(arg1,arg2)
+        puts arg1
+        puts arg2
+      end
+    end
+
+
 The job gets stored in the jobs table with a details field set to: `{ job: Class.method, params: {arg1: value1, arg2: value2}}` (as JSON)
-Class can be any class and method can be anything that Class will respond to. For example:
+Here is a more concrete example of a job implementation using a Rails ActiveRecord Model:
 
     class Invoice < ActiveRecord::Base
       def self.process(invoice_id)
@@ -91,32 +111,67 @@ Class can be any class and method can be anything that Class will respond to. Fo
 
 ### Dequeue
 
-Traditionally, a queue's dequeue operation will remove the item from the queue. However, Queue Classic will not delete the item from the queue, it will lock it
-and then the worker will delete the job once it has finished working it. Queue Classic's greatest strength is it's ability to safely lock jobs. Unlike other
-database backed queing libraries, Classic Queue uses the database time to lock. This allows you to be more relaxed about the time synchronization of your worker machines.
+Traditionally, a queue's dequeue operation will remove the item from the queue. However, Queue Classic will not delete the item from the queue right away; instead, the workers will lock
+the job and then the worker will delete the job once it has finished working it. Queue Classic's greatest strength is it's ability to safely lock jobs. Unlike other
+database backed queing libraries, Queue Classic uses the database time to lock. This allows you to be more relaxed about the time synchronization amongst your worker machines.
 
-Finally, the strongest feature of Queue Classic is it's ability to block on on dequeue. This design removes the need to __ Sleep & SELECT. __ Queue Classic takes advantage
-of the wonderul PUB/SUB featuers built in to Postgres. Basically there is a channel in which the workers LISTEN. When a new job is added to the queue, the queue sends NOTIFY
-messages on the channel. Once a NOTIFY is sent, each worker races to acquire a lock on a job. A job is awareded to the victor while the rest go back to wait for another job.
+Queue Classic takes advantage of Postgres' PUB/SUB featuers to dequeue a job. Basically there is a channel in which the workers LISTEN. When a new job is added to the queue, the queue sends NOTIFY
+messages on the channel. Once a NOTIFY is sent, each worker races to acquire a lock on a job. A job is awareded to the victor while the rest go back to wait for another job. This eliminates
+the need to Sleep & Select.
 
 ### The Worker
 
 The worker calls dequeue and then calls the enqueued method with the supplied arguments. Once the method terminates, the job is deleted from the queue. In the case that your method
-does not terminate, or the worker unexpectingly dies, Queue Classic will do following: It will ensure that the job is deleted from the queue and it will call a method (which is certainly over
-rideable) that handles the failure. You can do whatever you want in the handle_failure method, log to Get Exceptional, enqueue the job again, log to stderror.
+does not terminate, or the worker unexpectingly dies, Queue Classic will do following:
+
+* Rescue the Exception %
+* Call handle_failure(job,exception)
+* Delete the job
+
+% - To my knowledge, the only thing that can usurp ensure is a segfault.
+
+By default, handle_failure will puts the job and the exception. This is not very good and you should override this method. It is simple to do so.
+If you are using Queue Classic with Rails, You should:
+
+1. Remove require 'queue_classic/tasks' from Rakefile
+2. Create new file in lib/tasks. Call it queue_classic.rb (name is arbitrary)
+3. Insert something like the following:
+
+    require 'queue_classic'
 
     class MyWorker < QC::Worker
       def handle_failure(job,exception)
+        # You can do many things inside of this method. Here are a few examples:
+
+        # Log to Exceptional
+        Exceptional.handle(exception, "Background Job Failed" + job.inspect)
+
+        # Log to Hoptoad
+        HoptoadNotifier.notify(
+            :error_class   => "Background Job",
+            :error_message => "Special Error: #{e.message}",
+            :parameters    => job.details
+        )
+
+        # Log to STDOUT (Heroku Logplex listens to stdout)
         puts job.inspect
         puts exception.inspect
+        puts exception.backtrace
+
+        # Retry the job
+        QC.enqueue(job)
+
       end
     end
 
-    worker = MyWorker.new
-    worker.start
+    namespace :jobs do
+      task :work  => :environment do
+        MyWorker.new.start
+      end
+    end
 
 ## Performance
-I am pleased at the performance of Queue Classic. It ran 3x faster than the some of the most popular Relational Database backed queues. (I have yet to benchmark redis backed queues)
+I am pleased at the performance of Queue Classic. It ran 3x faster than the DJ. (I have yet to benchmark redis backed queues)
 
     ruby benchmark.rb
                     user     system      total        real
@@ -126,6 +181,12 @@ Hardware: Mac Book Pro 2.8 GHz Intel Core i7. SSD. 4 GB memory.
 
 Software: Ruby 1.9.2-p0, PostgreSQL 9.0.2
 
+It is fast because:
+
+* I wrote my own SQL
+* I do not create many Ruby Objects
+* I do not call very many methods
+
 ## FAQ
 
 How is this different than DJ?
@@ -147,10 +208,11 @@ Why doesn't your queue retry failed jobs?
 > I believe the Class method should handle any sort of exception.  Also, I think
 that the model you are working on should know about it's state. For instance, if you are
 creating jobs for the emailing of newsletters; put a emailed_at column on your newsletter model
-and then right before the job quits, touch the emailed_at column.
+and then right before the job quits, touch the emailed_at column. That being said, you can do whatever you
+want in handle_failure. I will not decide what is best for your application.
 
 Can I use this library with 50 Heroku Workers?
 > Yes.
 
-Why does this project seem incomplete? Will you make it production ready?
-> I started this project on 1/24/2011. Check back soon! Also, feel free to contact me to find out how passionate I am about queueing.
+Is Queue Classic ready for production? Can I do it live?!?
+> I started this project on 1/24/2011. I have been using this in production for some high-traffic apps at Heroku since 2/24/2011.

data/test/api_test.rb

@@ -26,6 +26,15 @@ context "QC::Api" do
     assert_equal({"job" => "Notifier.send", "params" => []}, job.details)
   end
 
+  test "enqueue takes a job and maintain params" do
+    h = {"id" => 1, "details" => {"job" => 'Notifier.send', "params" => ["1"]}.to_json, "locked_at" => nil}
+    job = QC::Job.new(h)
+    QC.enqueue(job)
+
+    job = QC.dequeue
+    assert_equal({"job" => "Notifier.send", "params" => ["1"]}, job.details)
+  end
+
 
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Ryan Smith