bumbleworks 0.0.40 → 0.0.41

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bumbleworks.gemspec
 gemspec
+gem "rufus-scheduler", "~> 2.0"

data/README.md

@@ -1,5 +1,11 @@
 # Bumbleworks
 
+**IMPORTANT**: Ruote (a dependency of Bumbleworks) currently has a bug in its dependency graph.  Until this is fixed (and we'll update this readme when it is), make sure you add this to your gemfile:
+
+```ruby
+gem 'rufus-scheduler', '~> 2.0'
+```
+
 **NOTE**: This product is still pre-release, and implementation is *not* in sync with documentation yet - hence the pre-release version.  We'll follow [the Semantic Versioning Specification (Semver)](http://semver.org/), so you can assume anything at 0.x.x still has an unstable API.  But we *are* actively developing this.
 
 Bumbleworks is a gem that adds a workflow engine (via [ruote](http://github.com/jmettraux/ruote)) to your Ruby application, and adds tools for task authorization and locking.  It also establishes conventions for easily loading process definitions and registering participant classes based on configurable file locations.
@@ -197,8 +203,6 @@ See the Bumbleworks::Task class for more details.
 
 ## Rake Tasks
 
-*TODO:  Actually implement these, so I'm not a liar.*
-
 If you...
 
 ```ruby

data/lib/bumbleworks.rb

@@ -10,6 +10,9 @@ require "bumbleworks/hash_storage"
 require "bumbleworks/simple_logger"
 require "bumbleworks/storage_participant"
 require "bumbleworks/local_participant"
+require "bumbleworks/error_handler"
+require "bumbleworks/error_logger"
+require "bumbleworks/error_handler_participant"
 
 module Bumbleworks
   class UnsupportedMode < StandardError; end

data/lib/bumbleworks/configuration.rb

@@ -94,6 +94,24 @@ module Bumbleworks
     # default: 5 seconds
     define_setting :timeout
 
+    # When errors occur during the exection of a process, errors are captured and dispatched to
+    # the registerd error handlers.  an error handler derives from the Bumbleworks::ErrorHandler
+    # and will receive the error information through the #on_error method.
+    #
+    # class MySpecialHandler < Bumbleworks::ErrorHandler
+    #   def on_error
+    #     p @workitem.error
+    #   end
+    # end
+    #
+    # For exclusive use:
+    #   Bumbleworks.error_handlers = [MySpeicalHandler, MySpecialHandler2]
+    #
+    # To append to exisiting handlers:
+    #   Bumbleworks.error_handlers << MySpeicalHandler
+    #
+    define_setting :error_handlers
+
     def initialize
       @storage_adapters = []
       @timeout ||= 5
@@ -173,6 +191,10 @@ module Bumbleworks
       @definitions_folder = @participants_folder = @tasks_folder = nil
     end
 
+    def error_handlers
+      @error_handlers ||= [Bumbleworks::ErrorLogger]
+    end
+
     private
     def defined_settings
       self.class.defined_settings

data/lib/bumbleworks/error_handler.rb

@@ -0,0 +1,15 @@
+module Bumbleworks
+  class ErrorHandler
+    include WorkitemEntityStorage
+    class SubclassResponsibility < StandardError; end
+
+    attr_accessor :workitem
+    def initialize(workitem)
+      @workitem = workitem
+    end
+
+    def on_error
+      raise SubclassResponsibility
+    end
+  end
+end

data/lib/bumbleworks/error_handler_participant.rb

@@ -0,0 +1,13 @@
+module Bumbleworks
+  class ErrorHandlerParticipant
+    include ::Ruote::LocalParticipant
+
+    def on_workitem
+      return if (error_handlers = Bumbleworks.error_handlers).empty?
+
+      error_handlers.each do |error_handler|
+        error_handler.new(workitem).on_error
+      end
+    end
+  end
+end

data/lib/bumbleworks/error_logger.rb

@@ -0,0 +1,27 @@
+module Bumbleworks
+  class ErrorLogger < ErrorHandler
+    def on_error
+      return unless logger
+
+      logger.error(
+        :actor => @workitem.wf_name,
+        :action => 'process error',
+        :target_type => entity_fields[:type],
+        :target_id => entity_fields[:identifier],
+        :metadata => metadata
+      )
+    end
+
+    private
+    def logger
+      Bumbleworks.logger
+    end
+
+    def metadata
+      {
+        :wfid => @workitem.wfid,
+        :error => @workitem.error,
+      }
+    end
+  end
+end

data/lib/bumbleworks/ruote.rb

@@ -35,6 +35,7 @@ module Bumbleworks
         else
           worker.run_in_thread
         end
+        register_error_handler
         worker
       end
 
@@ -99,9 +100,15 @@ module Bumbleworks
       def register_participants(&block)
         dashboard.register(&block) if block
         set_catchall_if_needed
+        register_error_handler
         dashboard.participant_list
       end
 
+      def register_error_handler
+        dashboard.register_participant :error_handler_participant, Bumbleworks::ErrorHandlerParticipant
+        dashboard.on_error = 'error_handler_participant'
+      end
+
       def set_catchall_if_needed
         last_participant = dashboard.participant_list.last
         unless last_participant && last_participant.regex == "^.+$" &&

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.40"
+  VERSION = "0.0.41"
 end

data/spec/integration/sample_application_spec.rb

@@ -10,8 +10,8 @@ describe 'Bumbleworks Sample Application' do
 
   describe 'initializer' do
     it 'registers participants' do
-      Bumbleworks.dashboard.participant_list.should have(3).items
-      Bumbleworks.dashboard.participant_list.map(&:classname).should =~ ['HoneyParticipant', 'MolassesParticipant', 'Bumbleworks::StorageParticipant']
+      Bumbleworks.dashboard.participant_list.should have(4).items
+      Bumbleworks.dashboard.participant_list.map(&:classname).should =~ ['HoneyParticipant', 'MolassesParticipant', 'Bumbleworks::ErrorHandlerParticipant', 'Bumbleworks::StorageParticipant']
     end
 
     it 'loads process definitions' do

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -249,4 +249,21 @@ describe Bumbleworks::Configuration do
       configuration.definitions_directory.should == '/Root/lib/bumbleworks/process_definitions'
     end
   end
+
+  describe '#error_handlers', dev:true do
+    let(:super_handler) {double('error_handler')}
+    it 'sets default error handler' do
+      configuration.error_handlers.should == [Bumbleworks::ErrorLogger]
+    end
+
+    it 'replaces default handler' do
+      configuration.error_handlers = [super_handler]
+      configuration.error_handlers.should == [super_handler]
+    end
+
+    it 'adds to default handler' do
+      configuration.error_handlers << super_handler
+      configuration.error_handlers.should =~ [Bumbleworks::ErrorLogger, super_handler]
+    end
+  end
 end

data/spec/lib/bumbleworks/error_handler_participant_spec.rb

@@ -0,0 +1,15 @@
+describe Bumbleworks::ErrorHandlerParticipant do
+  describe '#on_workitem' do
+    let(:workitem) { double('workitem') }
+    let(:instances) { [double(:on_error => nil), double(:on_error => nil)] }
+    let(:error_handlers) { [double(:new => instances[0]), double(:new => instances[1])] }
+
+    it 'calls all error handlers passing in workitem' do
+      Bumbleworks.error_handlers = error_handlers
+      error_handlers[0].should_receive(:new).ordered.with(workitem).and_return(instances[0])
+      error_handlers[1].should_receive(:new).ordered.with(workitem).and_return(instances[1])
+      subject.stub(:workitem => workitem)
+      subject.on_workitem
+    end
+  end
+end

data/spec/lib/bumbleworks/error_handler_spec.rb

@@ -0,0 +1,15 @@
+describe Bumbleworks::ErrorHandler do
+  subject {described_class.new(workitem)}
+  let(:workitem) { double }
+  describe '#initialize' do
+    it 'sets workitem' do
+      subject.workitem.should == workitem
+    end
+  end
+
+  describe '#on_error' do
+    it 'raises a SubclassResponsiblity exception' do
+      expect{subject.on_error}.to raise_error Bumbleworks::ErrorHandler::SubclassResponsibility
+    end
+  end
+end

data/spec/lib/bumbleworks/error_logger_spec.rb

@@ -0,0 +1,30 @@
+describe Bumbleworks::ErrorLogger do
+  subject {described_class.new(workitem)}
+  let(:workitem) {double(:wf_name => 'armadillo', :error => 'something is amiss in dillo land', :wfid => 'zabme123', :fields => {})}
+  it 'calls registered logger and logs error information' do
+    Bumbleworks.logger.should_receive(:error).with({
+      :actor => 'armadillo',
+      :action => 'process error',
+      :target_type => nil,
+      :target_id => nil,
+      :metadata => {:wfid => 'zabme123', :error => 'something is amiss in dillo land'}
+    })
+
+    subject.on_error
+  end
+
+  it 'sets target to entity if found' do
+    workitem.stub(:fields => {:entity_id => 1234, :entity_type => 'Lizards'})
+    Bumbleworks.logger.should_receive(:error).with(hash_including({
+      :target_type => 'Lizards',
+      :target_id => 1234,
+    }))
+
+    subject.on_error
+  end
+
+  it 'does nothing if logger is not registered' do
+    Bumbleworks.stub(:logger)
+    subject.on_error.should == nil
+  end
+end

data/spec/lib/bumbleworks/ruote_spec.rb

@@ -220,6 +220,11 @@ describe Bumbleworks::Ruote do
       described_class.dashboard.should_receive(:noisy=).with(true)
       described_class.start_worker!(:verbose => true)
     end
+
+    it 'registers error handler' do
+      described_class.should_receive(:register_error_handler)
+      described_class.start_worker!
+    end
   end
 
   describe '.register_participants' do
@@ -232,8 +237,9 @@ describe Bumbleworks::Ruote do
 
       described_class.dashboard.participant_list.should be_empty
       described_class.register_participants &registration_block
-      described_class.dashboard.participant_list.should have(4).items
-      described_class.dashboard.participant_list.map(&:classname).should =~ ['BeesHoney', 'MapleSyrup', 'NewCatchall', 'Bumbleworks::StorageParticipant']
+      described_class.dashboard.participant_list.should have(5).items
+      described_class.dashboard.participant_list.map(&:classname).should =~ [
+        'BeesHoney', 'MapleSyrup', 'NewCatchall', 'Bumbleworks::ErrorHandlerParticipant', 'Bumbleworks::StorageParticipant']
     end
 
     it 'does not add storage participant catchall if already exists' do
@@ -244,18 +250,42 @@ describe Bumbleworks::Ruote do
 
       described_class.dashboard.participant_list.should be_empty
       described_class.register_participants &registration_block
-      described_class.dashboard.participant_list.should have(2).items
-      described_class.dashboard.participant_list.map(&:classname).should =~ ['BeesHoney', 'Ruote::StorageParticipant']
+      described_class.dashboard.participant_list.should have(3).items
+      described_class.dashboard.participant_list.map(&:classname).should =~ [
+        'BeesHoney', 'Bumbleworks::ErrorHandlerParticipant', 'Ruote::StorageParticipant'
+      ]
     end
 
     it 'adds catchall participant if block is nil' do
       described_class.dashboard.participant_list.should be_empty
       described_class.register_participants &nil
-      described_class.dashboard.participant_list.should have(1).item
+      described_class.dashboard.participant_list.should have(2).item
       described_class.dashboard.participant_list.first.classname.should == 'Bumbleworks::StorageParticipant'
     end
   end
 
+  describe '.register_error_handler', dev:true do
+    it 'registers the error handler participant' do
+      described_class.register_error_handler
+      Bumbleworks.dashboard.participant_list.map(&:classname).should include('Bumbleworks::ErrorHandlerParticipant')
+    end
+
+    it 'it sets the global Ruote on_error to the error_handler_participant' do
+      described_class.register_error_handler
+      Bumbleworks.dashboard.on_error.flatten[2].should == 'error_handler_participant'
+    end
+
+    it 'skip registration if error_handlers list is missing' do
+      described_class.stub(:error_handlers => nil)
+      Bumbleworks.dashboard.should_not_receive(:register_participant).with(:error_handler, Bumbleworks::ErrorHandlerParticipant)
+    end
+
+    it 'skip registration if error_handlers list is empty' do
+      described_class.stub(:error_handlers => [])
+      Bumbleworks.dashboard.should_not_receive(:register_participant).with(:error_handler, Bumbleworks::ErrorHandlerParticipant)
+    end
+  end
+
   describe '.storage' do
     it 'raise error when storage is not defined' do
       Bumbleworks.storage = nil

data/spec/lib/bumbleworks_spec.rb

@@ -79,6 +79,7 @@ describe Bumbleworks do
   describe '.configuration' do
     before :each do
       Bumbleworks.reset!
+      Bumbleworks::StorageAdapter.auto_register = nil
     end
 
     it 'creates an instance of Bumbleworks::Configuration' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.40
+  version: 0.0.41
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -167,6 +167,9 @@ files:
 - doc/TERMS.md
 - lib/bumbleworks.rb
 - lib/bumbleworks/configuration.rb
+- lib/bumbleworks/error_handler.rb
+- lib/bumbleworks/error_handler_participant.rb
+- lib/bumbleworks/error_logger.rb
 - lib/bumbleworks/hash_storage.rb
 - lib/bumbleworks/local_participant.rb
 - lib/bumbleworks/participant_registration.rb
@@ -204,6 +207,9 @@ files:
 - spec/integration/configuration_spec.rb
 - spec/integration/sample_application_spec.rb
 - spec/lib/bumbleworks/configuration_spec.rb
+- spec/lib/bumbleworks/error_handler_participant_spec.rb
+- spec/lib/bumbleworks/error_handler_spec.rb
+- spec/lib/bumbleworks/error_logger_spec.rb
 - spec/lib/bumbleworks/local_participant_spec.rb
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/process_definition_spec.rb
@@ -236,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3173447995460527192
+      hash: 2565282303718385581
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -245,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3173447995460527192
+      hash: 2565282303718385581
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -271,6 +277,9 @@ test_files:
 - spec/integration/configuration_spec.rb
 - spec/integration/sample_application_spec.rb
 - spec/lib/bumbleworks/configuration_spec.rb
+- spec/lib/bumbleworks/error_handler_participant_spec.rb
+- spec/lib/bumbleworks/error_handler_spec.rb
+- spec/lib/bumbleworks/error_logger_spec.rb
 - spec/lib/bumbleworks/local_participant_spec.rb
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/process_definition_spec.rb