quebert 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 063bc22b230d2549c427562deb220554b1b6b931
-  data.tar.gz: 0f4db324c52f319abe1229112f0ea4219172f47d
+  metadata.gz: 13a07e8336155e0c777ed1295201b2d7d23e9bee
+  data.tar.gz: 6e3929be1a44ee006809f3b24a1ef605aed7605d
 SHA512:
-  metadata.gz: b001d8710708db59714b9722c75cf0919ab1520a369ff2c3c246645450a02ba0e47235be186f805984d46693c7766b654bc579e73f8bca176c7176e37935e2ad
-  data.tar.gz: 76331a2a7b8600945285f562802b80f68954909d0b0a62f8b5ae857c8c5d782d5c364e74438f38ef542a91588ea2f2ba8dc7d46fa6abd107c59c07c46f4b5d28
+  metadata.gz: f56a3426063aa8353e6e52f8c61bb7a76e73bdbced8df6a919872979fb33102ce0e9cbd536046ccc30fa21d1e57b38b994d275abcfd560366d6b451cf7507257
+  data.tar.gz: 2f464763bb13a6eefd45ebc46f8a2dbc3a326dff7e5968960319f37a52bcf10c3d5d5c3abf64a55d6ca009a30b12d705b65367f47d0e0ab9572969aeb5651427

data/.gitignore

@@ -1,6 +1,9 @@
 ## MAC OS
 .DS_Store
 
+## RUBY
+.bundle
+
 ## TEXTMATE
 *.tmproj
 tmtags
@@ -19,4 +22,4 @@ rdoc
 pkg
 Gemfile.lock
 
-## PROJECT::SPECIFIC
+## PROJECT::SPECIFIC

data/.rbenv-version

@@ -1 +1 @@
-1.9.3-p484
+2.1.2

data/README.md

@@ -18,6 +18,7 @@ Quebert is a serious project. Its used in a production environment at Poll Every
 * Rails/ActiveRecord integration similar to async_observer
 * Pluggable exception handling (for Hoptoad integration)
 * Run workers with pid, log, and config files. These do not daemonize (do it yourself punk!)
+* Provide custom hooks to be called before, after & around jobs are run
 
 Some features that are currently missing that I will soon add include:
 
@@ -53,6 +54,25 @@ Then perform the jobs!
     Quebert.backend.reserve.perform # => 6
     Quebert.backend.reserve.perform # => 15
 
+## Before/After/Around Hooks
+
+Quebert has support for providing custom hooks to be called before, after & around your jobs are being run.
+A common example is making sure that any active ActiveRecord database connections are put back on the connection pool after a job is done:
+
+    Quebert.config.after_job do
+      ActiveRecord::Base.clear_active_connections!
+    end
+
+    Quebert.config.before_job do |job|
+      # all hooks take an optional job argument
+      # in case you want to do something with that job
+    end
+
+    Quebert.config.around_job do |job|
+      # this hook gets called twice
+      # once before & once after a job is performed
+    end
+
 ## Async Sender
 
 Take any ol' class and include the Quebert::AsyncSender.

data/lib/quebert/configuration.rb

@@ -29,13 +29,60 @@ module Quebert
       end
       self
     end
-    
+
     def worker
       @worker ||= Struct.new(:exception_handler).new
     end
-    
+
     def self.from_hash(hash)
       new.from_hash(hash) # Config this puppy up from a config hash
     end
+
+    def before_job(job = nil, &block)
+      if job
+        before_hooks.each do |h|
+          h.call(job)
+        end
+      else
+        before_hooks << block if block
+      end
+      self
+    end
+
+    def after_job(job = nil, &block)
+      if job
+        after_hooks.each do |h|
+          h.call(job)
+        end
+      else
+        after_hooks << block if block
+      end
+      self
+    end
+
+    def around_job(job = nil, &block)
+      if job
+        around_hooks.each do |h|
+          h.call(job)
+        end
+      else
+        around_hooks << block if block
+      end
+      self
+    end
+
+    private
+
+    def before_hooks
+      @before_hooks ||= []
+    end
+
+    def after_hooks
+      @after_hooks ||= []
+    end
+
+    def around_hooks
+      @around_hooks ||= []
+    end
   end
 end

data/lib/quebert/controller/beanstalk.rb

@@ -14,86 +14,79 @@ module Quebert
 
       def initialize(beanstalk_job, queue)
         @beanstalk_job, @queue = beanstalk_job, queue
-
-        begin
-          @job = Job.from_json(beanstalk_job.body)
-        rescue Job::Delete
-          beanstalk_job.delete
-          log "Deleted on initialization", :error
-        rescue Job::Release
-          beanstalk_job.release @job.priority, @job.delay
-          log "Released on initialization with priority: #{@job.priority} and delay: #{@job.delay}", :error
-        rescue Job::Bury
-          beanstalk_job.bury
-          log "Buried on initialization", :error
-        rescue Exception => e
-          beanstalk_job.bury
-          log "Exception caught on initialization. #{e.inspect}", :error
-          raise e  
-        end
+        @job = Job.from_json(beanstalk_job.body)
+      rescue Job::Delete
+        beanstalk_job.delete
+        log "Deleted on initialization", :error
+      rescue Job::Release
+        beanstalk_job.release @job.priority, @job.delay
+        log "Released on initialization with priority: #{@job.priority} and delay: #{@job.delay}", :error
+      rescue Job::Bury
+        beanstalk_job.bury
+        log "Buried on initialization", :error
+      rescue Exception => e
+        beanstalk_job.bury
+        log "Exception caught on initialization. #{e.inspect}", :error
+        raise
       end
-      
-      def perform
-        begin
-          log "Performing with args #{job.args.inspect}"
-          log "Beanstalk Job Stats: #{beanstalk_job.stats.inspect}"
 
-          result = false
-          time = Benchmark.realtime do
-            result = job.perform!
-            beanstalk_job.delete
-          end
+      def perform
+        log "Performing with args #{job.args.inspect}"
+        log "Beanstalk Job Stats: #{beanstalk_job.stats.inspect}"
 
-          log "Completed in #{(time*1000*1000).to_i/1000.to_f} ms\n"
-          result
-        rescue Job::Delete
-          log "Deleting job", :error
+        result = false
+        time = Benchmark.realtime do
+          result = job.perform!
           beanstalk_job.delete
-          log "Job deleted", :error
-        rescue Job::Release
-          log "Releasing with priority: #{@job.priority} and delay: #{@job.delay}", :error 
-          beanstalk_job.release :pri => @job.priority, :delay => @job.delay
-          log "Job released", :error 
-        rescue Job::Bury
-          log "Burrying job", :error
-          beanstalk_job.bury
-          log "Job burried", :error
-        rescue Job::Timeout => e
-          log "Job timed out!", :error
-          retry_with_delay
-          raise e
-        rescue Job::Retry => e
-          # The difference between the Retry and Timeout class is that
-          # Retry does not log an exception where as Timeout does
-          log "Manually retrying with delay"
-          retry_with_delay
-        rescue Exception => e
-          log "Exception caught on perform. Burying job. #{e.inspect} #{e.backtrace.join("\n")}", :error
-          beanstalk_job.bury
-          log "Job buried", :error
-          raise e
         end
+
+        log "Completed in #{(time*1000*1000).to_i/1000.to_f} ms\n"
+        result
+      rescue Job::Delete
+        log "Deleting job", :error
+        beanstalk_job.delete
+        log "Job deleted", :error
+      rescue Job::Release
+        log "Releasing with priority: #{@job.priority} and delay: #{@job.delay}", :error
+        beanstalk_job.release :pri => @job.priority, :delay => @job.delay
+        log "Job released", :error
+      rescue Job::Bury
+        log "Burrying job", :error
+        beanstalk_job.bury
+        log "Job burried", :error
+      rescue Job::Timeout => e
+        log "Job timed out. Retrying with delay. #{e.inspect} #{e.backtrace.join("\n")}", :error
+        retry_with_delay
+        raise
+      rescue Job::Retry
+        # The difference between the Retry and Timeout class is that
+        # Retry does not log an exception where as Timeout does
+        log "Manually retrying with delay"
+        retry_with_delay
+      rescue Exception => e
+        log "Exception caught on perform. Burying job. #{e.inspect} #{e.backtrace.join("\n")}", :error
+        beanstalk_job.bury
+        log "Job buried", :error
+        raise
       end
 
     protected
       def retry_with_delay
-        begin
-          delay = TIMEOUT_RETRY_DELAY_SEED + TIMEOUT_RETRY_GROWTH_RATE**beanstalk_job.stats["releases"].to_i
+        delay = TIMEOUT_RETRY_DELAY_SEED + TIMEOUT_RETRY_GROWTH_RATE**beanstalk_job.stats["releases"].to_i
 
-          if delay > MAX_TIMEOUT_RETRY_DELAY
-            log "Max retry delay exceeded. Burrying job"
-            beanstalk_job.bury
-            log "Job burried"
-          else
-            log "TTR exceeded. Releasing with priority: #{@job.priority} and delay: #{delay}"
-            beanstalk_job.release :pri => @job.priority, :delay => delay
-            log "Job released"
-          end
-        rescue ::Beaneater::NotFoundError
-          log "Job ran longer than allowed. Beanstalk already deleted it!!!!", :error
-          # Sometimes the timer doesn't behave correctly and this job actually runs longer than
-          # allowed. At that point the beanstalk job no longer exists anymore. Lets let it go and don't blow up.
+        if delay > MAX_TIMEOUT_RETRY_DELAY
+          log "Max retry delay exceeded. Burrying job"
+          beanstalk_job.bury
+          log "Job burried"
+        else
+          log "TTR exceeded. Releasing with priority: #{@job.priority} and delay: #{delay}"
+          beanstalk_job.release :pri => @job.priority, :delay => delay
+          log "Job released"
         end
+      rescue ::Beaneater::NotFoundError
+        log "Job ran longer than allowed. Beanstalk already deleted it!!!!", :error
+        # Sometimes the timer doesn't behave correctly and this job actually runs longer than
+        # allowed. At that point the beanstalk job no longer exists anymore. Lets let it go and don't blow up.
       end
 
       def log(message, level=:info)

data/lib/quebert/job.rb

@@ -51,10 +51,18 @@ module Quebert
 
     # Runs the perform method that somebody else should be implementing
     def perform!
+      Quebert.config.before_job(self)
+      Quebert.config.around_job(self)
+
       # Honor the timeout and kill the job in ruby-space. Beanstalk
       # should be cleaning up this job and returning it to the queue
       # as well.
-      ::Timeout.timeout(@ttr, Job::Timeout){ perform(*args) }
+      val = ::Timeout.timeout(@ttr, Job::Timeout){ perform(*args) }
+
+      Quebert.config.around_job(self)
+      Quebert.config.after_job(self)
+
+      val
     end
 
     # Accepts arguments that override the job options and enqueu this stuff.

data/lib/quebert/version.rb

@@ -1,3 +1,3 @@
 module Quebert
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/spec/job_spec.rb

@@ -153,4 +153,35 @@ describe Quebert::Job do
       }.should raise_exception(Quebert::Job::Timeout)
     end
   end
+
+  context "before, after & around hooks" do
+    it "should call each type of hook as expected" do
+      before_jobs = []
+      after_jobs  = []
+      around_jobs = []
+
+      jobs = (1..10).map do |i|
+        Adder.new(i, i)
+      end
+
+      Quebert.config.before_job do |job|
+        before_jobs << job
+      end
+
+      Quebert.config.after_job do |job|
+        after_jobs << job
+      end
+
+      Quebert.config.around_job do |job|
+        around_jobs << job
+      end
+
+      jobs.each(&:perform!)
+
+      before_jobs.should eql jobs
+      after_jobs.should  eql jobs
+      # around_job hooks are called twice per job (before & after its performed)
+      around_jobs.should eql jobs.zip(jobs).flatten
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quebert
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Brad Gessler
@@ -10,34 +10,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: beaneater
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -62,11 +62,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rbenv-version
-- .rspec
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".rbenv-version"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.md
@@ -121,17 +121,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: quebert
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A worker queue framework built around beanstalkd