simpler_workflow 0.3.0.beta → 0.3.0.beta2

data/LICENSE

@@ -1,4 +1,6 @@
 Copyright (c) 2012 Snugg Home LLC
+Copyright (c) 2012-2013 Frederic Jean
+Copyright (c) 2012-2013 Command-Shift-N LLC
 
 MIT License
 

data/README.md

@@ -1,6 +1,7 @@
 # SimplerWorkflow
 
 [![Build Status](https://secure.travis-ci.org/fredjean/simpler_workflow.png)](http://travis-ci.org/fredjean/simpler_workflow)
+[![Code Climate](https://codeclimate.com/github/fredjean/simpler_workflow.png)](https://codeclimate.com/github/fredjean/simpler_workflow)
 
 A wrapper around Amazon's Simple Workflow Service meant to simplify declaring and using activities and workflow. Provides some sane defaults
 and work around some idiosyncracies of the platform.
@@ -176,6 +177,16 @@ You can also define similar hooks for events using the following methods:
 * ```on_activity_completed``` is called when an activity completes and SWF reports back to the decision loop.
 * ```on_activity_failed``` is called when an activity reports a failure to SWF.
 
+### Triggering Workflows
+
+You can trigger the worklow with the following command:
+
+```ruby
+SimplerWorkflow::Domain["my-test-domain"].start_workflow("hello-world", "1.0.1", "AWS")
+```
+
+The parameters are the name of the workflow, the version as well as a string representing the input to the workflow.
+
 ## Workflow and Activity Versioning
 
 All workflow types and activity types are versioned under SWF. This allows an organization to release new versions of a workflow or activity

data/lib/simpler_workflow/activity.rb

@@ -2,22 +2,23 @@ module SimplerWorkflow
   class Activity
     include OptionsAsMethods
 
-    DEFAULT_OPTIONS = {
-      :default_task_list => name,
-      :default_task_start_to_close_timeout => 5 * 60,
-      :default_task_schedule_to_start_timeout => 5 * 60,
-      :default_task_schedule_to_close_timeout => 10 * 60,
-      :default_task_heartbeat_timeout => :none
-    }
-
-    attr_reader :domain, :name, :version, :options, :next_activity
-
-    def initialize(domain, name, version)
-      @options = DEFAULT_OPTIONS.dup
+    attr_reader :domain, :name, :version, :options, :next_activity, :task_list
+
+    def initialize(domain, name, version, options = {})
+      default_options =
+        {
+        :default_task_list => name,
+        :default_task_start_to_close_timeout => 5 * 60,
+        :default_task_schedule_to_start_timeout => 5 * 60,
+        :default_task_schedule_to_close_timeout => 10 * 60,
+        :default_task_heartbeat_timeout => :none
+      }
+      @options = default_options.merge(options)
       @domain = domain
       @name = name
       @version = version
       @failure_policy = :fail
+      @task_list = name.to_s
     end
 
     def on_success(activity, version = nil)
@@ -100,7 +101,7 @@ module SimplerWorkflow
           @time_to_exit = true
         end
 
-        Signal.trap('INT') do 
+        Signal.trap('INT') do
           logger.info("Received SIGINT")
           Process.exit!(0)
         end
@@ -113,17 +114,12 @@ module SimplerWorkflow
         loop do
           begin
             logger.info("Starting activity_loop for #{name}")
-            domain.activity_tasks.poll(name.to_s) do |task|
+            domain.activity_tasks.poll(task_list) do |task|
               begin
                 logger.info("Received task...")
                 perform_task(task)
                 unless task.responded?
-                  if next_activity
-                    result = {:next_activity => next_activity}.to_json
-                    task.complete!(:result => result)
-                  else
-                    task.complete!
-                  end
+                  task.complete!
                 end
               rescue => e
                 context = {}

data/lib/simpler_workflow/version.rb

@@ -1,3 +1,3 @@
 module SimplerWorkflow
-  VERSION = "0.3.0.beta"
+  VERSION = "0.3.0.beta2"
 end

data/lib/simpler_workflow/workflow.rb

@@ -35,7 +35,7 @@ module SimplerWorkflow
           @time_to_exit = true
         end
 
-        Signal.trap('INT') do 
+        Signal.trap('INT') do
           logger.info("Received SIGINT")
           Process.exit!(0)
         end
@@ -82,19 +82,19 @@ module SimplerWorkflow
     end
 
     def on_start_execution(&block)
-      event_handlers['WorkflowExecutionStarted'] = WorkflowEventHandler.new(&block)
+      event_handlers['WorkflowExecutionStarted'] = block
     end
 
     def on_activity_completed(&block)
-      event_handlers['ActivityTaskCompleted'] = WorkflowEventHandler.new(&block)
+      event_handlers['ActivityTaskCompleted'] = block
     end
 
     def on_activity_failed(&block)
-      event_handlers['ActivityTaskFailed'] = WorkflowEventHandler.new(&block)
+      event_handlers['ActivityTaskFailed'] = block
     end
 
     def on_activity_timed_out(&block)
-      event_handlers['ActivityTaskTimedOut'] = WorkflowEventHandler.new(&block)
+      event_handlers['ActivityTaskTimedOut'] = block
     end
 
     def self.[](name, version)
@@ -135,15 +135,15 @@ module SimplerWorkflow
       logger.info("Received decision task")
       decision_task.new_events.each do |event|
         logger.info("Processing #{event.event_type}")
-        event_handlers.fetch(event.event_type, DefaultEventHandler.new(self)).process(decision_task, event)
+        event_handlers.fetch(event.event_type, DefaultEventHandler.new(self)).call(decision_task, event)
       end
     end
 
     def event_handlers
       @event_handlers ||= Map[
-        :WorkflowExecutionStarted , WorkflowExecutionStartedHandler.new(self) , 
-        :ActivityTaskCompleted    , ActivityTaskCompletedHandler.new(self)    , 
-        :ActivityTaskFailed       , ActivityTaskFailedHandler.new(self)       , 
+        :WorkflowExecutionStarted , WorkflowExecutionStartedHandler.new(self) ,
+        :ActivityTaskCompleted    , ActivityTaskCompletedHandler.new(self)    ,
+        :ActivityTaskFailed       , ActivityTaskFailedHandler.new(self)       ,
         :ActivityTaskTimedOut     , ActivityTaskTimedOutHandler.new(self)
         ]
     end
@@ -175,23 +175,11 @@ module SimplerWorkflow
         workflow.initial_activity_type
       end
 
-      def process(*args); end
-    end
-
-    class WorkflowEventHandler
-      attr_accessor :handler
- 
-      def initialize(&block)
-        @handler = block
-      end
-
-      def process(decision_task, event)
-        handler.call(decision_task, event)
-      end
+      def call(*args); end
     end
 
     class ActivityTaskTimedOutHandler < DefaultEventHandler
-      def process(decision_task, event)
+      def call(decision_task, event)
         case event.attributes.timeoutType
         when 'START_TO_CLOSE', 'SCHEDULE_TO_START', 'SCHEDULE_TO_CLOSE'
           last_activity_type = last_activity(decision_task, event)
@@ -204,10 +192,10 @@ module SimplerWorkflow
     end
 
     class ActivityTaskFailedHandler < DefaultEventHandler
-      def process(decision_task, event)
+      def call(decision_task, event)
         last_activity_type = last_activity(decision_task, event)
         failed_activity = domain.activities[last_activity_type]
-        
+
         case failed_activity.failure_policy
         when :abort, :cancel
           SimplerWorkflow.logger.info("Cancelling workflow execution.")
@@ -223,7 +211,7 @@ module SimplerWorkflow
     end
 
     class ActivityTaskCompletedHandler < DefaultEventHandler
-      def process(decision_task, event)
+      def call(decision_task, event)
         last_activity_type = last_activity(decision_task, event)
 
         completed_activity = domain.activities[last_activity_type]
@@ -238,7 +226,7 @@ module SimplerWorkflow
     end
 
     class WorkflowExecutionStartedHandler < DefaultEventHandler
-      def process(decision_task, event)
+      def call(decision_task, event)
         decision_task.schedule_activity_task initial_activity_type, input: event.attributes.input
       end
     end

data/spec/activity_spec.rb

@@ -44,6 +44,7 @@ module SimplerWorkflow
         its(:version) { should == '1.0.0' }
         its(:domain) { should == domain }
         its(:failure_policy) { should == :fail }
+        its(:task_list) { should == 'test-activity' }
       end
 
       context "Setting the failure policy" do

data/spec/workflow_spec.rb

@@ -35,7 +35,7 @@ module SimplerWorkflow
     end
 
     context "Registering a new workflow." do
-      before :each do 
+      before :each do
         Workflow.send :public, :event_handlers
       end
 
@@ -82,7 +82,7 @@ module SimplerWorkflow
 
             decision_task.should_receive(:new_events).and_return([new_event])
 
-            event_handlers[new_event.event_type].should_receive(:process).with(decision_task, new_event)
+            event_handlers[new_event.event_type].should_receive(:call).with(decision_task, new_event)
 
             workflow.send :handle_decision_task, decision_task
           end
@@ -102,7 +102,7 @@ module SimplerWorkflow
 						event = stub( :attributes => stub( :input => "Mary had a little lamb"))
 						decision_task.should_receive(:schedule_activity_task).with(domain.activity_types[:test_activity, '1.0.0'], input: event.attributes.input)
 
-						event_handlers[:WorkflowExecutionStarted].process(decision_task, event)
+						event_handlers[:WorkflowExecutionStarted].call(decision_task, event)
 					end
 				end
 
@@ -120,7 +120,7 @@ module SimplerWorkflow
             decision_task.should_receive(:scheduled_event).with(event).and_return(scheduled_event)
 						decision_task.should_receive(:complete_workflow_execution).with(result: 'success')
 
-						event_handlers[:ActivityTaskCompleted].process(decision_task, event)
+						event_handlers[:ActivityTaskCompleted].call(decision_task, event)
 					end
 
 					it "should schedule the next activity if the current one declares one" do
@@ -129,7 +129,7 @@ module SimplerWorkflow
 
             test_activity = domain.register_activity(:test_activity, '1.0.0')
 
-            scheduled_activity = domain.register_activity(:success_activity, '1.0.0') do 
+            scheduled_activity = domain.register_activity(:success_activity, '1.0.0') do
               on_success :test_activity, '1.0.0'
             end
 
@@ -142,7 +142,7 @@ module SimplerWorkflow
             decision_task.should_receive(:scheduled_event).with(event).twice.and_return(scheduled_event)
 						decision_task.should_receive(:schedule_activity).with(next_activity, input: scheduled_event.attributes.input)
 
-						event_handlers[:ActivityTaskCompleted].process(decision_task, event)
+						event_handlers[:ActivityTaskCompleted].call(decision_task, event)
 					end
 				end
 
@@ -159,7 +159,7 @@ module SimplerWorkflow
 						decision_task.should_receive(:fail_workflow_execution)
             decision_task.should_receive(:scheduled_event).with(event).and_return(scheduled_event)
 
-						event_handlers[:ActivityTaskFailed].process(decision_task, event)
+						event_handlers[:ActivityTaskFailed].call(decision_task, event)
 					end
 
 					it "should cancel the execution if instructed to abort" do
@@ -175,7 +175,7 @@ module SimplerWorkflow
             decision_task.should_receive(:scheduled_event).with(event).and_return(scheduled_event)
 						decision_task.should_receive(:cancel_workflow_execution)
 
-						event_handlers[:ActivityTaskFailed].process(decision_task, event)
+						event_handlers[:ActivityTaskFailed].call(decision_task, event)
 					end
 
 					it "should cancel the execution if instructed to do so" do
@@ -192,7 +192,7 @@ module SimplerWorkflow
             decision_task.should_receive(:scheduled_event).with(event).and_return(scheduled_event)
 						decision_task.should_receive(:cancel_workflow_execution)
 
-						event_handlers[:ActivityTaskFailed].process(decision_task, event)
+						event_handlers[:ActivityTaskFailed].call(decision_task, event)
 					end
 
           it "should reschedule the activity if requested" do
@@ -209,9 +209,8 @@ module SimplerWorkflow
             decision_task.should_receive(:scheduled_event).with(event).twice.and_return(scheduled_event)
             decision_task.should_receive(:schedule_activity_task).with(test_activity.to_activity_type, input: scheduled_event.attributes.input)
 
-            event_handlers[:ActivityTaskFailed].process(decision_task, event)
+            event_handlers[:ActivityTaskFailed].call(decision_task, event)
           end
-
 				end
 
         context "an activity timed out" do
@@ -226,7 +225,7 @@ module SimplerWorkflow
 
               decision_task.should_receive(:scheduled_event).twice.and_return(scheduled_event)
               decision_task.should_receive(:schedule_activity_task).with(activity_type, input: scheduled_event.attributes.input)
-              event_handlers[:ActivityTaskTimedOut].process(decision_task, event)
+              event_handlers[:ActivityTaskTimedOut].call(decision_task, event)
             end
           end
 
@@ -236,7 +235,7 @@ module SimplerWorkflow
 
             decision_task.should_receive(:fail_workflow_execution)
 
-            event_handlers[:ActivityTaskTimedOut].process(decision_task, event)
+            event_handlers[:ActivityTaskTimedOut].call(decision_task, event)
           end
         end
       end

metadata

@@ -2,14 +2,14 @@
 name: simpler_workflow
 version: !ruby/object:Gem::Version
   prerelease: 6
-  version: 0.3.0.beta
+  version: 0.3.0.beta2
 platform: ruby
 authors:
 - Frederic Jean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ files:
 - spec/workflow_spec.rb
 homepage: https://github.com/fredjean/simpler_workflow
 licenses: []
-post_install_message: ! "simpler_workflow 0.3.0.beta\n========================\n\nHave
+post_install_message: ! "simpler_workflow 0.3.0.beta2\n========================\n\nHave
   a look at https://github.com/fredjean/simpler_workflow/wiki/MIgrating-to-0.2.0 if
   you\nare upgrading from a 0.1.x version of the gem. There is a fundamental change
   in how the \nactivity and decision loops are run. You may need to adjust your application