rabbit_jobs 0.0.5 → 0.0.6

data/Gemfile

@@ -2,12 +2,13 @@ source :rubygems
 
 gemspec
 
-gem 'rabbit_jobs', :path => './'
-
 group :development do
+  gem 'actionmailer', '>= 3.0'
+
   gem 'rspec', '~> 2.8'
   gem 'rr'
   gem 'autotest'
-  # gem 'fs-event'
+  gem 'autotest-fsevent'
+  gem 'autotest-growl'
   gem 'simplecov', require: false
 end

data/lib/rabbit_jobs.rb

@@ -6,6 +6,7 @@ require 'rabbit_jobs/helpers'
 require 'rabbit_jobs/amqp_helpers'
 require 'rabbit_jobs/configuration'
 require 'rabbit_jobs/logger'
+require 'rabbit_jobs/error_mailer'
 
 require 'rabbit_jobs/job'
 require 'rabbit_jobs/publisher'

data/lib/rabbit_jobs/configuration.rb

@@ -49,6 +49,7 @@ module RabbitJobs
 
     def initialize
       @data = {
+        error_log: true,
         host: 'localhost',
         exchange: 'rabbit_jobs',
         exchange_params: DEFAULT_EXCHANGE_PARAMS,
@@ -60,6 +61,27 @@ module RabbitJobs
       @data[name]
     end
 
+    def mail_errors_to(email = nil, from_email = nil)
+      if email && from_email
+        @data[:mail_errors_to] = email
+        @data[:mail_errors_form] = from_email
+      else
+        @data[:mail_errors_to]
+      end
+    end
+
+    def mail_errors_from
+      @data[:mail_errors_form]
+    end
+
+    def error_log
+      @data[:error_log]
+    end
+
+    def disable_error_log
+      @data[:error_log] = false
+    end
+
     def host(value = nil)
       if value
         raise ArgumentError unless value.is_a?(String) && value != ""

data/lib/rabbit_jobs/error_mailer.rb

@@ -0,0 +1,37 @@
+# -*- encoding : utf-8 -*-
+
+module RabbitJobs
+  class ErrorMailer
+    include RabbitJobs::Logger
+
+    def self.enabled?
+      !!RabbitJobs.config.mail_errors_from && !RabbitJobs.config.mail_errors_from.empty?
+    end
+
+    def self.send(job, error = $!)
+      return unless enabled?
+
+      raise "You must require action_mailer or turn of error reporting in config." unless defined?(ActionMailer)
+
+      params ||= []
+
+      params_str = job.params == [] ? '' : job.params.map { |p| p.inspect }.join(', ')
+      subject = "RJ:Worker: #{error.class} on #{job.class}.perform(#{params_str}) "
+      text    = "\n#{job.class}.perform(#{params_str})\n"
+      text   += "\n#{error.inspect}\n"
+      text   += "\nBacktrace:\n#{error.backtrace.join("\n")}" if error.backtrace
+
+      letter         = ActionMailer::Base.mail
+      letter.from    = RabbitJobs.config.mail_errors_from
+      letter.to      = RabbitJobs.config.mail_errors_to
+      letter.subject = subject
+      letter.body    = text
+
+      begin
+        letter.deliver
+      rescue
+        log $!.inspect
+      end
+    end
+  end
+end

data/lib/rabbit_jobs/job.rb

@@ -30,12 +30,34 @@ module RabbitJobs::Job
           self.class.perform(*params)
           # log 'after perform'
         rescue
-          puts $!.inspect
+          RabbitJobs::Logger.log($!.inspect) if RabbitJobs.config.error_log
+          RabbitJobs::ErrorMailer.send(self, $!)
+
+          run_on_error_hooks($!)
         end
         exit!
       end
     end
 
+    def run_on_error_hooks(error)
+      if self.class.rj_on_error_hooks
+        self.class.rj_on_error_hooks.each do |proc_or_symbol|
+          if proc_or_symbol.is_a?(Symbol)
+            self.send(proc_or_symbol, error, *params)
+          else
+            case proc_or_symbol.arity
+            when 0
+              proc_or_symbol.call()
+            when 1
+              proc_or_symbol.call(error)
+            else
+              proc_or_symbol.call(error, *params)
+            end
+          end
+        end
+      end
+    end
+
     def payload
       {'class' => self.class.to_s, 'opts' => (self.opts || {}), 'params' => params}.to_json
       # ([self.class.to_s] + params).to_json
@@ -46,14 +68,14 @@ module RabbitJobs::Job
     end
 
     def expires?
-      !!self.expires_in
+      self.expires_in && self.expires_in > 0
     end
 
     def expired?
       if self.opts['expires_at']
-        Time.now > Time.new(opts['expires_at'])
+        Time.now.to_i > opts['expires_at'].to_i
       elsif expires? && opts['created_at']
-        Time.now > (Time.new(opts['created_at']) + expires_in)
+        Time.now.to_i > (opts['created_at'].to_i + expires_in.to_i)
       else
         false
       end
@@ -61,11 +83,19 @@ module RabbitJobs::Job
   end
 
   module ClassMethods
-    attr_accessor :rj_expires_in
+    attr_accessor :rj_expires_in, :rj_on_error_hooks
 
     # DSL method for jobs
     def expires_in(seconds)
-     @rj_expires_in = seconds
+     @rj_expires_in = seconds.to_i
+    end
+
+    def on_error(*hooks)
+      hooks.each do |proc_or_symbol|
+        raise ArgumentError unless proc_or_symbol && ( proc_or_symbol.is_a?(Proc) || proc_or_symbol.is_a?(Symbol) )
+        @rj_on_error_hooks ||= []
+        @rj_on_error_hooks << proc_or_symbol
+      end
     end
   end
 

data/lib/rabbit_jobs/publisher.rb

@@ -33,7 +33,7 @@ module RabbitJobs
 
         queue = make_queue(exchange, routing_key)
 
-        job.opts['created_at'] = Time.now.to_s
+        job.opts['created_at'] = Time.now.to_i
 
         payload = job.payload
         exchange.publish(job.payload, Configuration::DEFAULT_MESSAGE_PARAMS.merge({routing_key: routing_key})) {
@@ -46,10 +46,9 @@ module RabbitJobs
 
     def em_publish_job_to(routing_key, job)
       em_amqp_with_exchange do |connection, exchange|
-
         queue = make_queue(exchange, routing_key)
 
-        job.opts['created_at'] = Time.now.to_s
+        job.opts['created_at'] = Time.now.to_i
 
         payload = job.payload
         exchange.publish(job.payload, Configuration::DEFAULT_MESSAGE_PARAMS.merge({routing_key: routing_key})) {

data/lib/rabbit_jobs/scheduler.rb

@@ -38,8 +38,8 @@ module RabbitJobs
           interval_types = %w{cron every}
           interval_types.each do |interval_type|
             if !config[interval_type].nil? && config[interval_type].length > 0
+              log "queueing #{config['class']} (#{name})"
               rufus_scheduler.send(interval_type, config[interval_type]) do
-                log! "queueing #{config['class']} (#{name})"
                 publish_from_config(config)
               end
               interval_defined = true
@@ -68,7 +68,7 @@ module RabbitJobs
       log "publishing #{config}"
       RabbitJobs.publish_to(queue, klass_name.constantize, nil, *params)
     rescue
-      log! "Failed to enqueue #{klass_name}:\n #{$!}\n params = #{params.inspect}"
+      log! "Failed to publish #{klass_name}:\n #{$!}\n params = #{params.inspect}"
     end
 
     def rufus_scheduler
@@ -103,7 +103,6 @@ module RabbitJobs
         if time > 0
           # for debugging
           EM.add_timer(time) do
-            log "Stopping scheduler..."
             self.shutdown
           end
         end

data/lib/rabbit_jobs/version.rb

@@ -1,3 +1,3 @@
 module RabbitJobs
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/rabbit_jobs/worker.rb

@@ -56,9 +56,11 @@ module RabbitJobs
 
           queue.subscribe(ack: true) do |metadata, payload|
             @job = RabbitJobs::Job.parse(payload)
-            @job.run_perform unless @job.expired?
-            metadata.ack
-            processed_count += 1
+            unless @job.expired?
+              @job.run_perform
+              metadata.ack
+              processed_count += 1
+            end
             check_shutdown.call
           end
         end

data/spec/fixtures/jobs.rb

@@ -26,4 +26,21 @@ class ExpiredJob
   def self.perform
 
   end
+end
+
+class JobWithErrorHook
+  include RabbitJobs::Job
+  on_error :first_hook, lambda { puts "second hook" }, :last_hook
+
+  def first_hook(error)
+    puts 'first hook'
+  end
+
+  def last_hook(error)
+    puts 'last hook'
+  end
+
+  def self.perform
+    raise "Job raised an error at #{Time.now}"
+  end
 end

data/spec/integration/worker_spec.rb

@@ -11,6 +11,7 @@ describe RabbitJobs::Worker do
 
     5.times { RabbitJobs.publish(PrintTimeJob, nil, Time.now) }
     5.times { RabbitJobs.publish(ExpiredJob, { :expires_at => Time.now - 10 }) }
+    1.times { RabbitJobs.publish(JobWithErrorHook) }
     worker = RabbitJobs::Worker.new
 
     worker.work(1) # work for 1 second

data/spec/unit/configuration_spec.rb

@@ -4,6 +4,8 @@ require 'spec_helper'
 describe RabbitJobs::Configuration do
   it 'builds configuration from configure block' do
     RabbitJobs.configure do |c|
+      c.disable_error_log
+
       c.host "somehost.lan"
 
       c.exchange 'my_exchange', durable: true, auto_delete: false
@@ -13,6 +15,7 @@ describe RabbitJobs::Configuration do
     end
 
     RabbitJobs.config.to_hash.should == {
+      error_log: false,
       host: "somehost.lan",
       exchange: "my_exchange",
       exchange_params: {
@@ -63,6 +66,7 @@ describe RabbitJobs::Configuration do
 
   it 'use default config' do
     RabbitJobs.config.to_hash.should == {
+      error_log: true,
       host: "localhost",
       exchange: "rabbit_jobs",
       exchange_params: {
@@ -80,6 +84,7 @@ describe RabbitJobs::Configuration do
   end
 
   it 'returns settings on some methods' do
+    RabbitJobs.config.error_log == true
     RabbitJobs.config.host.should == 'localhost'
     RabbitJobs.config[:host].should == 'localhost'
     RabbitJobs.config.routing_keys.should == ['default']

data/spec/unit/job_spec.rb

@@ -16,14 +16,20 @@ describe RabbitJobs::Job do
   context 'job expiration' do
     it 'should expire job by expires_in option' do
       job = TestJob.new
-      job.opts['expires_at'] = (Time.now - 10).to_s
+      job.opts['expires_at'] = (Time.now - 10).to_i
       job.expired?.should == true
     end
 
     it 'should expire job by expires_in option in job class and current_time' do
       job = JobWithExpire.new(1, 2, 3)
-      job.opts['created_at'] = (Time.now - job.expires_in - 10).to_s
+      job.opts['created_at'] = (Time.now - job.expires_in - 10).to_i
       job.expired?.should == true
     end
+
+    it 'should not be expired with default params' do
+      job = TestJob.new(1, 2, 3)
+      job.opts['created_at'] = (Time.now).to_i
+      job.expired?.should == false
+    end
   end
 end

data/spec/unit/mailer_spec.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+require 'action_mailer'
+
+describe RabbitJobs::ErrorMailer do
+  describe '#enabled?' do
+    it 'should be enabled when use setup email' do
+      RabbitJobs::ErrorMailer.enabled?.should == false
+      RabbitJobs.configure do |c|
+        c.mail_errors_to 'dev@exampe.com', 'app@example.com'
+      end
+      RabbitJobs::ErrorMailer.enabled?.should == true
+    end
+  end
+
+  describe '#send' do
+    it 'should send email with error' do
+      email = ActionMailer::Base.mail
+      mock(ActionMailer::Base).mail { email }
+      mock(email).deliver { }
+      mock(RabbitJobs::ErrorMailer).enabled? { true }
+
+      RabbitJobs::ErrorMailer.send(TestJob.new, RuntimeError.new('error text'))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabbit_jobs
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70230061017880 !ruby/object:Gem::Requirement
+  requirement: &70238047574860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70230061017880
+  version_requirements: *70238047574860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70230061016460 !ruby/object:Gem::Requirement
+  requirement: &70238047573560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70230061016460
+  version_requirements: *70238047573560
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
-  requirement: &70230061008760 !ruby/object:Gem::Requirement
+  requirement: &70238047572140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70230061008760
+  version_requirements: *70238047572140
 description: Background jobs on RabbitMQ
 email:
 - lazureykis@gmail.com
@@ -61,6 +61,7 @@ files:
 - lib/rabbit_jobs.rb
 - lib/rabbit_jobs/amqp_helpers.rb
 - lib/rabbit_jobs/configuration.rb
+- lib/rabbit_jobs/error_mailer.rb
 - lib/rabbit_jobs/helpers.rb
 - lib/rabbit_jobs/job.rb
 - lib/rabbit_jobs/logger.rb
@@ -81,6 +82,7 @@ files:
 - spec/unit/configuration_spec.rb
 - spec/unit/job_spec.rb
 - spec/unit/logger_spec.rb
+- spec/unit/mailer_spec.rb
 - spec/unit/rabbit_jobs_spec.rb
 - spec/unit/worker_spec.rb
 homepage: ''
@@ -118,5 +120,6 @@ test_files:
 - spec/unit/configuration_spec.rb
 - spec/unit/job_spec.rb
 - spec/unit/logger_spec.rb
+- spec/unit/mailer_spec.rb
 - spec/unit/rabbit_jobs_spec.rb
 - spec/unit/worker_spec.rb