qmin 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69e96cc20325d7b8809946ac027cbb9de06c7112
-  data.tar.gz: 59e9483bfa81502f4346e2d1e4f09a7a21121b58
+  metadata.gz: 224035ccd522282d02bb6c6020a115ffe5353d14
+  data.tar.gz: 9c0f5ac6458d44113c9ecf656c3b5e82120510bc
 SHA512:
-  metadata.gz: 565eb2604a080306eb7e729213a9f2b4f6b554787eeeae3cf6efc631407bd21efe4f9cbb463f78c45c844ea6c72287833edb287aaa319ff34e108277172cd0d9
-  data.tar.gz: e486391dd19b23339113ef26ef0ccb660e85db02578f74bb6286f89191ea5b45d72d57c2f44193870b0a5092d6cda9fd10b04db32e1c02402a6adf5c574e769f
+  metadata.gz: 597fbd9165320d0183e3c7bb523722bdec58f6ccb9fbb189dbc816706f34ae6de13be56c2e499fdc10dbe0b2f531255ae83505d0e4ddf06a64386165a94277e0
+  data.tar.gz: 2797a8f514bd41aefb36dda45a50a86a8c13a1dcd89a8d4c9ac04ee1d450c36d96de19536539e2a95f6743f3facfc1814b411f5295e0ebb89e5e88881d6626b8

data/lib/qmin.rb

@@ -4,14 +4,20 @@ require 'qmin/core_ext/string'
 require 'qmin/strategy/inline'
 require 'qmin/strategy/noop'
 
+require 'qmin/reporting/inline'
+require 'qmin/reporting/noop'
+
 if defined? Resque
   require 'qmin/resque/background_call_job'
   require 'qmin/resque/base_job'
   require 'qmin/strategy/resque'
 end
 
+if defined? Mail
+  require 'qmin/reporting/mail'
+end
+
 module Qmin
-  MustDefineStrategyError = Class.new(StandardError)
 
   protected
 

data/lib/qmin/core_ext/string.rb

@@ -8,7 +8,7 @@ class String
       downcase
   end unless String.respond_to?(:underscore)
 
-  # shamelessly stolen from resque
+  # copied from resque
   def constantize
     names = self.split('::')
     names.shift if names.empty? || names.first.empty?

data/lib/qmin/qmin.rb

@@ -1,30 +1,43 @@
 module Qmin
   # Handles configuration and dispatches method calls to configured strategy
   class Qmin
-    # configure default strategy
-    def self.default_strategy=(strategy)
-      @@default_strategy = strategy
-    end
 
-    def self.current
-      @@current ||= new
-    end
+    class << self
+      def default_reporter=(reporter)
+        @default_reporter = reporter
+        @current = nil # reset current, so the newly set reporter is used
+      end
 
-    def self.enqueue(worker_class, *args)
-      current.enqueue worker_class, *args
-    end
+      def default_reporter
+        @default_reporter || Reporting::Inline
+      end
 
-    def self.background_call(instance, method_name)
-      current.background_call(instance, method_name)
-    end
+      # configure default strategy
+      def default_strategy=(strategy)
+        @default_strategy = strategy
+        @current = nil  # reset current, so the newly set strategy is used
+      end
+
+      def default_strategy
+        @default_strategy || Strategy::Inline
+      end
 
-    def initialize(strategy = nil)
-      begin
-        @strategy = (strategy || @@default_strategy).new
-      rescue NameError
-        raise MustDefineStrategyError.new
+      def current
+        @current ||= new
+      end
+
+      def enqueue(worker_class, *args)
+        current.enqueue worker_class, *args
+      end
+
+      def background_call(instance, method_name)
+        current.background_call(instance, method_name)
       end
-      @@current = self
+    end
+
+    def initialize
+      @strategy = self.class.default_strategy.new
+      @reporter = self.class.default_reporter.new
     end
 
     def enqueue(worker_class, *args)
@@ -34,5 +47,9 @@ module Qmin
     def background_call(instance, method_name)
       @strategy.background_call(instance, method_name)
     end
+
+    def report(exception)
+      @reporter.report(exception)
+    end
   end
 end

data/lib/qmin/reporting/inline.rb

@@ -0,0 +1,9 @@
+module Qmin
+  module Reporting
+    class Inline
+      def report(exception)
+        raise exception
+      end
+    end
+  end
+end

data/lib/qmin/reporting/mail.rb

@@ -0,0 +1,91 @@
+require 'mail'
+
+module Qmin
+  module Reporting
+    class Mail
+
+      class << self
+        def setup_delivery(delivery_method, delivery_options = {})
+          @delivery_method  = delivery_method
+          @delivery_options = delivery_options
+        end
+
+        def delivery_method
+          @delivery_method
+        end
+
+        def delivery_options
+          @delivery_options
+        end
+
+        def setup_mail(to, from)
+          @mail_to    = to
+          @mail_from  = from
+        end
+
+        def mail_to
+          @mail_to
+        end
+
+        def mail_from
+          @mail_from
+        end
+      end
+
+      def report(exception)
+        deliver(mail(exception))
+      end
+
+      private
+
+      def mail(exception)
+        MailBuilder.new(exception, self.class.mail_to, self.class.mail_from).build
+      end
+
+      def deliver(mail)
+        if self.class.delivery_method && self.class.delivery_options
+          mail.delivery_method(self.class.delivery_method, self.class.delivery_options)
+        end
+
+        mail.deliver
+      end
+
+
+      class MailBuilder
+        def initialize(exception, mail_to, mail_from)
+          @exception, @mail_to, @mail_from = exception, mail_to, mail_from
+        end
+
+        attr_reader :exception, :mail_to, :mail_from
+
+        def build
+          mail = ::Mail.new
+
+          mail.to       mail_to
+          mail.from     mail_from
+          mail.subject  subject
+          mail.body     clean_backtrace.join("\n")
+
+          mail
+        end
+
+        private
+
+        def subject
+          "[ERROR] Qmin Report: #{exception.message}"
+        end
+
+        # copied from exception_notification gem
+        # http://github.com/smartinez87/exception_notification
+        def clean_backtrace
+          if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
+            Rails.backtrace_cleaner.send(:filter, exception.backtrace)
+          else
+            exception.backtrace
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/qmin/reporting/noop.rb

@@ -0,0 +1,8 @@
+module Qmin
+  module Reporting
+    class Noop
+      def report(exception)
+      end
+    end
+  end
+end

data/lib/qmin/resque/background_call_job.rb

@@ -12,8 +12,12 @@ module Qmin
       end
 
       def perform
-        instance = @klass.find(@id)
-        instance.send(::Qmin.method_name_for_instance(instance, @method_name))
+        begin
+          instance = @klass.find(@id)
+          instance.send(::Qmin.method_name_for_instance(instance, @method_name))
+        rescue => e
+          ::Qmin::Qmin.current.report(e)
+        end
       end
     end
   end

data/lib/qmin/version.rb

@@ -1,3 +1,3 @@
 module Qmin
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/qmin.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'mail'
 end

data/spec/qmin/qmin_spec.rb

@@ -8,26 +8,6 @@ describe Qmin do
     defined?(Qmin::Strategy::Resque).should eql('constant')
   end
 
-  describe 'initialize' do
-    it 'raises error if no strategy defined' do
-      Qmin::Qmin.default_strategy = nil
-
-      lambda {
-        Qmin::Qmin.new
-      }.should raise_error(Qmin::MustDefineStrategyError)
-    end
-
-    it 'raises error for current if no strategy defined' do
-      # reset strategies
-      Qmin::Qmin.default_strategy = nil
-      Qmin::Qmin.send :class_variable_set, :@@current, nil
-
-      lambda {
-        Qmin::Qmin.current
-      }.should raise_error(Qmin::MustDefineStrategyError)
-    end
-  end
-
   describe 'background_method' do
     it 'aliases background methods'do
       subject = BackgroundTestClass.new
@@ -51,8 +31,6 @@ describe Qmin do
 
   describe 'enqueue' do
     it 'enqueues job' do
-      Qmin::Qmin.new(Qmin::Strategy::Inline)
-
       TestJob.expects(:perform).with(1,2,3)
       Qmin::Qmin.enqueue TestJob, 1,2,3
     end

data/spec/qmin/reporting/inline_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/qmin'
+
+describe 'Qmin::Reporting::Inline' do
+  let(:error_producer){ TestClass.new(123) }
+
+  it 'raises error with default inline strategy' do
+    lambda{
+      error_producer.raise_error
+    }.should raise_error(TestClass::CustomError)
+  end
+
+  it 'raises no error with noop strategy' do
+    Qmin::Qmin.default_strategy = Qmin::Strategy::Noop
+    lambda{
+      error_producer.raise_error
+    }.should_not raise_error(TestClass::CustomError)
+  end
+
+  describe 'resque strategy' do
+    before do
+      Qmin::Qmin.default_strategy = Qmin::Strategy::Resque
+    end
+
+    it 'raises no error with resque strategy when enqueueing the job' do
+      lambda{
+        error_producer.raise_error
+      }.should_not raise_error(TestClass::CustomError)
+    end
+
+    it 'raises error when job is performing' do
+      lambda{
+        Qmin::Resque::BackgroundCallJob.new(TestClass, :raise_error, error_producer.id).perform
+      }.should raise_error(TestClass::CustomError)
+    end
+  end
+
+end
+

data/spec/qmin/reporting/mail_spec.rb

@@ -0,0 +1,46 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/qmin'
+
+describe 'Qmin::Reporting::Mail' do
+
+  before do
+    Qmin::Reporting::Mail.setup_delivery :test
+    Qmin::Reporting::Mail.setup_mail 'receiver@example.com', 'error-notification@mydomain.com'
+    Qmin::Qmin.default_reporter = Qmin::Reporting::Mail
+  end
+
+  after do
+    Mail::TestMailer.deliveries.clear
+    Qmin::Qmin.default_reporter = nil
+  end
+
+  let(:error_producer){ TestClass.new(123) }
+
+  it 'raises error for inline strategy' do
+    lambda{
+      error_producer.raise_error
+    }.should raise_error(TestClass::CustomError)
+  end
+
+  describe 'resque strategy' do
+    before do
+      Qmin::Qmin.default_strategy = Qmin::Strategy::Resque
+    end
+
+    it 'raises no error with resque strategy when enqueuing the job' do
+      lambda{
+        error_producer.raise_error
+      }.should_not raise_error(TestClass::CustomError)
+    end
+
+    it 'raises error when job is performing' do
+      lambda{
+        Qmin::Resque::BackgroundCallJob.new(TestClass, :raise_error, error_producer.id).perform
+      }.should_not raise_error(TestClass::CustomError)
+
+      Mail::TestMailer.deliveries.should_not be_empty
+    end
+  end
+
+
+end

data/spec/qmin/resque/background_call_job_spec.rb

@@ -4,7 +4,7 @@ describe Qmin::Resque::BackgroundCallJob do
   let(:id){ 123 }
 
   before do
-    Qmin::Qmin.new(Qmin::Strategy::Resque)
+    Qmin::Qmin.default_strategy = Qmin::Strategy::Resque
   end
 
   it 'calls method on instance' do
@@ -12,15 +12,11 @@ describe Qmin::Resque::BackgroundCallJob do
   end
 
   it 'calls method on instance wrapped in background_call_job' do
-    Qmin::Qmin.new(Qmin::Strategy::Resque)
-
     BackgroundTestClass.new(id).action
     ::Resque.queue['qmin_resque_background_call_job_background_test_class_action'][0].should eql ({:class => Qmin::Resque::BackgroundCallJob, :args => ['BackgroundTestClass', :action, 123]})
   end
 
   it 'delegates perform to instance' do
-    Qmin::Qmin.new(Qmin::Strategy::Resque)
-
     Qmin::Resque::BackgroundCallJob.any_instance.expects(:perform)
     Qmin::Resque::BackgroundCallJob.perform(BackgroundTestClass, 'action', 123)
   end

data/spec/qmin/resque/base_job_spec.rb

@@ -2,13 +2,15 @@ require File.expand_path '../../spec_helper', File.dirname(__FILE__)
 
 describe Qmin::Resque::BaseJob do
 
+  before do
+    Qmin::Qmin.default_strategy = Qmin::Strategy::Resque
+  end
+
   it 'performs test job' do
-    Qmin::Qmin.new(Qmin::Strategy::Resque)
     TestJob.perform(10).should eql 10
   end
 
   it 'demands find method on model class' do
-    Qmin::Qmin.new(Qmin::Strategy::Resque)
     lambda {
       Class.new(Qmin::Resque::BaseJob) do
         model Class

data/spec/spec_helper.rb

@@ -7,8 +7,13 @@ rescue LoadError
   # only available for ruby 1.9+ in non-CI environments
 end
 
+require 'mail'
 require 'rspec/autorun'
 
+Mail.defaults do
+  delivery_method :test
+end
+
 # mock Resque behavior
 class Resque
   def self.enqueue_to(queue_name, worker, *args)
@@ -45,11 +50,13 @@ RSpec.configure do |config|
 
   config.before(:each) do
     Resque.reset_queue!
-    Qmin::Qmin.new(Qmin::Strategy::Inline)
+    Mail::TestMailer.deliveries.clear
+    Qmin::Qmin.default_strategy = nil
+    Qmin::Qmin.default_reporter = nil
   end
 
   config.after(:each) do
-    Qmin::Qmin.new(Qmin::Strategy::Inline)
+
   end
 end
 
@@ -67,6 +74,13 @@ class WorkerClass
 end
 
 class TestClass
+  class CustomError < StandardError
+    def initialize(msg = '')
+      super
+    end
+  end
+
+
   def action
     @id
   end
@@ -83,6 +97,11 @@ class TestClass
     @id = id
   end
   attr_reader :id
+
+  def raise_error
+    raise CustomError.new("Something went wrong with #{@id}")
+  end
+  background :raise_error
 end
 
 class BackgroundTestClass < TestClass

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qmin
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - the-architect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple framwork to coordinate background tasks
 email:
 - marcel.scherf@epicteams.com
@@ -85,6 +99,9 @@ files:
 - lib/qmin/core_ext/class.rb
 - lib/qmin/core_ext/string.rb
 - lib/qmin/qmin.rb
+- lib/qmin/reporting/inline.rb
+- lib/qmin/reporting/mail.rb
+- lib/qmin/reporting/noop.rb
 - lib/qmin/resque/background_call_job.rb
 - lib/qmin/resque/base_job.rb
 - lib/qmin/strategy/inline.rb
@@ -95,6 +112,8 @@ files:
 - spec/qmin/core_ext/class_spec.rb
 - spec/qmin/core_ext/string_spec.rb
 - spec/qmin/qmin_spec.rb
+- spec/qmin/reporting/inline_spec.rb
+- spec/qmin/reporting/mail_spec.rb
 - spec/qmin/resque/background_call_job_spec.rb
 - spec/qmin/resque/base_job_spec.rb
 - spec/qmin/strategy/inline_spec.rb
@@ -129,6 +148,8 @@ test_files:
 - spec/qmin/core_ext/class_spec.rb
 - spec/qmin/core_ext/string_spec.rb
 - spec/qmin/qmin_spec.rb
+- spec/qmin/reporting/inline_spec.rb
+- spec/qmin/reporting/mail_spec.rb
 - spec/qmin/resque/background_call_job_spec.rb
 - spec/qmin/resque/base_job_spec.rb
 - spec/qmin/strategy/inline_spec.rb