rabbit-wq 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d634abe252e6b867d154bf13a89c5f5d3ec3b3d
-  data.tar.gz: 8ec4a5e769312855710472b4224486055760987e
+  metadata.gz: 0568de9c0fec913fcfd1095ff871c2950425caec
+  data.tar.gz: e518eaa0d76830ac505aeee415bc0fbf283447d4
 SHA512:
-  metadata.gz: e9cb5f5bbe3b430c65338b61883a81216f09624239fba7dd1e47b5d6c38393bf06dce061e85dd48029f0cf4cf6f8655d2f5b20b774f9a3b2772b60d9011a189b
-  data.tar.gz: a2b728021c002b7e14f8472940534c1c5db972d8a5845fd0d2326ccb6f761e639dae4415a8476fe21a09ac62fec443a2e1d45b8ca62c158ac1e3a2bdf6834757
+  metadata.gz: a3ebfaafb03242620189e60586d2444b1ef3ba07c1f9fa01026e68b66bb4e6a84b9ee2205345e6ce3dd08c8ee6a26bec3241aa6f33c096e1ab22bba5e7dbd883
+  data.tar.gz: 1f8f34bc53f4ac2e83a7db41a8cc018b65fb7785c8480075c50f81500c4347aa33d5f9c3e5a592e5a8e204324d935f67d71b87c831b6e4836ffcb14e63877ca1

data/README.md

@@ -117,6 +117,30 @@ Called when an error is raised and either no retries were requested or are remai
 
 Called when an error is raised and a retry will be attempted.
 
+### Disabling a Worker
+
+A worker can be disabled by overriding the #enabled? method.
+
+    class SomeWorker
+      include RabbitWQ::Worker
+
+      def enabled?
+        # some logic to determine enabled
+      end
+    end
+
+By default, when a worker is disabled a log entry is created and the worker does no work and leaves hte work queue 
+system.  In order to have the worker sent to the error queue if disabled, simply override the #error_on_disabled? method:
+
+    class SomeWorker
+      include RabbitWQ::Worker
+
+      def error_on_disabled?
+        true
+      end
+    end
+
+
 ### Logging
 
 RabbitWQ provides a work logger that is available within all workers.  You must send a reference to self

data/lib/rabbit_wq/message_handler.rb

@@ -20,7 +20,7 @@ module RabbitWQ
 
       worker = YAML::load( payload )
       info ANSI.yellow { "WORKER [#{worker.object_id}] " + worker.inspect }
-      worker.call
+      handle_work( worker, payload )
       try_on_success_callback( worker )
       channel.ack delivery_info.delivery_tag
     rescue => e
@@ -29,6 +29,18 @@ module RabbitWQ
 
   protected
 
+    def handle_work( worker, payload )
+      unless worker.enabled?
+        if worker.error_on_disabled?
+          Work.enqueue_error_payload( payload, error: "Worker disabled" )
+        end
+        worker_info( worker, "Worker disabled" )
+        return
+      end
+
+      worker.call
+    end
+
     def handle_error( worker, e, channel, delivery_info, payload, metadata )
       headers = metadata[:headers]
 

data/lib/rabbit_wq/version.rb

@@ -1,3 +1,3 @@
 module RabbitWQ
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/lib/rabbit_wq/worker.rb

@@ -33,5 +33,15 @@ module RabbitWQ
       info "END   #{self.class.name}"
     end
 
+    def enabled?
+      true
+    end
+
+    # When true, will place the worker in error queue
+    #
+    def error_on_disabled?
+      false
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbit-wq
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - C. Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler