aws-flow 1.0.8 → 1.0.9

data/lib/aws/decider/activity_definition.rb

@@ -24,7 +24,7 @@ module AWS
     class ActivityDefinition
       attr_accessor :execution_options
 
-      # Creates a new ActivityDefinition instance
+      # Creates a new ActivityDefinition instance.
       #
       # @param [Object] instance
       #
@@ -46,12 +46,10 @@ module AWS
         @converter = converter
       end
 
-      # Executes the activity
-      #
-      # === Parameters
+      # Executes the activity.
       #
       # @param [Object] input
-      #   Optional input for the activity execution.
+      #   Additional input for the activity execution.
       #
       # @param [ActivityExecutionContext] context
       #   The context for the activity execution.
@@ -60,10 +58,10 @@ module AWS
         begin
           @instance._activity_execution_context = context
           # Since we encode all the inputs in some converter, and these inputs
-          # are not "true" ruby objects yet, there is no way for that input to
+          # are not "true" Ruby objects yet, there is no way for that input to
           # be an instance of the NilClass(the only thing that responds true to
           # .nil?) and thus we can be assured that if input.nil?, then the
-          # method had no input
+          # method had no input.
           if input.nil?
             result = @instance.send(@activity_method)
           else
@@ -87,21 +85,59 @@ module AWS
 
     end
 
+    # The execution context for an activity task.
     class ActivityExecutionContext
       attr_accessor :service, :domain, :task
+
+      # Initializes a new `ActivityExecutionContext` object.
+      #
+      # @param [AWS::SimpleWorkflow] service
+      #   An instance of [AWS::SimpleWorkflow](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow.html) to
+      #   set for the activity execution context.
+      #
+      # @param [AWS::SimpleWorkflow::Domain] domain
+      #   The [AWS::SimpleWorkflow::Domain](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/Domain.html)
+      #   in which the activity task is running.
+      #
+      # @param [AWS::SimpleWorkflow::ActivityTask] task
+      #   The
+      #   [AWS::SimpleWorkflow::ActivityTask](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/ActivityTask.html)
+      #   that this execution context is for.
+      #
       def initialize(service, domain, task)
         @service = service
         @domain = domain
         @task = task
       end
+
+      # Gets the [task
+      # token](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/ActivityTask.html#task_token-instance_method),
+      # an opaque string that can be used to uniquely identify this task execution.
+      # @return [String] the activity task token.
       def task_token
         @task.task_token
       end
 
+      # Gets the
+      # [AWS::SimpleWorkflow::WorkflowExecution](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/WorkflowExecution.html)
+      # instance that is the context for this activity execution.
+      #
+      # @return [AWS::SimpleWorkflow::WorkflowExecution]
+      #   The `WorkflowExecution` in this activity execution context.
+      #
       def workflow_execution
         @task.workflow_execution
       end
 
+      # Records a heartbeat for the activity, indicating to Amazon SWF that the activity is still making progress.
+      #
+      # @param [String] details
+      #   If specified, contains details about the progress of the activity task. Up to 2048
+      #   characters can be provided.
+      #
+      # @raise [CancellationException]
+      #   The activity task has been cancelled.
+      #
       def record_activity_heartbeat(details)
         to_send = {:task_token => task_token.to_s, :details => details.to_s }
         response = @service.record_activity_task_heartbeat(to_send)

data/lib/aws/decider/async_decider.rb

@@ -16,26 +16,26 @@
 module AWS
   module Flow
 
-    # Represents a decision ID
+    # Represents a decision ID.
     class DecisionID
 
-      # Creates a new DecisionID
+      # Creates a new decision ID.
       #
       # @param decision_target
-      #   The decision target
+      #   The decision target.
       #
       # @param string_id
-      #   The string that identifies this decisison
+      #   The string that identifies this decision.
       #
       def initialize(decision_target, string_id)
         @decision_target = decision_target
         @string_id = string_id
       end
 
-      # Hash function to return an unique value for the DecisionID
+      # Hash function to return an unique value for the decision ID.
       #
       # @return
-      #   The calculated hash value for the DecisionID.
+      #   The calculated hash value for the decision ID.
       #
       def hash
         prime = 31
@@ -45,20 +45,20 @@ module AWS
         result
       end
 
-      # Is this Decision ID the same as another?
+      # Is this decision ID the same as another?
       #
       # @param [Object] other
       #   The object to compare with.
       #
       # @return [true, false]
-      #   Returns `true` if the object is the same as this DecisionID; `false` otherwise.
+      #   Returns `true` if the object is the same as this decision ID; `false` otherwise.
       #
       def eql?(other)
 
       end
     end
 
-    # @!visibility private
+    # @api private
     class DecisionWrapper
       #TODO Consider taking out the id, it's unclear if it is needed
       def initialize(id, decision, options = [])
@@ -66,11 +66,11 @@ module AWS
         @id = id
       end
 
-      # @!visibility private
+      # @api private
       def get_decision
         @decision
       end
-      # @!visibility private
+      # @api private
       def consume(symbol)
         # quack like a state machine
       end
@@ -81,7 +81,7 @@ module AWS
     end
 
 
-    # A decision helper for a workflow
+    # A decision helper for a workflow.
     #
     # @!attribute [Hash] activity_options
     #
@@ -99,7 +99,7 @@ module AWS
     #
     # @!attribute [Hash] signal_initiated_event_to_signal_id
     #
-    # @!visibility private
+    # @api private
     class DecisionHelper
       attr_accessor :decision_map, :activity_scheduling_event_id_to_activity_id, :scheduled_activities, :scheduled_timers, :activity_options, :scheduled_external_workflows, :scheduled_signals, :signal_initiated_event_to_signal_id, :child_initiated_event_id_to_workflow_id, :workflow_context_data
       class << self
@@ -123,13 +123,13 @@ module AWS
         @child_initiated_event_id_to_workflow_id = {}
       end
 
-      # @!visibility private
+      # @api private
       def get_next_id(decision_target)
         id = (@id[decision_target] += 1)
         "#{decision_target}#{id}"
       end
 
-      # @!visibility private
+      # @api private
       def get_next_state_machine_which_will_schedule(list)
         return if list.empty?
         ele = list.shift
@@ -141,11 +141,11 @@ module AWS
         DecisionHelper.completion_events.include? decision.get_decision[:decision_type].to_sym
       end
 
-      # @!visibility private
+      # @api private
       def handle_decision_task_started_event
         # In order to ensure that the events we have already scheduled do not
         # make a decision, we will process only maximum_decisions_per_completion
-        # here
+        # here.
         count = 0
         decision_list = @decision_map.values
         decision_state_machine = get_next_state_machine_which_will_schedule(decision_list)
@@ -166,31 +166,30 @@ module AWS
         end
       end
 
-
-      def [](key)
-        return @decision_map[key]
-      end
-      def []=(key, val)
-        return @decision_map[key] = val
+      # @api private
+      def method_missing(method_name, *args)
+        if [:[]=, :[]].include? method_name
+          @decision_map.send(method_name, *args)
+        end
       end
 
-      # Returns the activity ID for a scheduled activity
+      # Returns the activity ID for a scheduled activity.
       #
       # @param [String] scheduled_id
       #   The scheduled activity ID.
       #
-      # @!visibility private
+      # @api private
       def get_activity_id(scheduled_id)
         activity_scheduling_event_id_to_activity_id[scheduled_id]
       end
     end
 
-    # The asynchronous decider class
+    # Represents an asynchronous decider class.
     class AsyncDecider
       include Utilities::SelfMethods
       attr_accessor :task_token, :decision_helper
 
-      # Creates a new asynchronous decider
+      # Creates a new asynchronous decider.
       def initialize(workflow_definition_factory, history_helper, decision_helper)
         @workflow_definition_factory = workflow_definition_factory
         @history_helper = history_helper
@@ -207,7 +206,7 @@ module AWS
       # @note *Beware, this getter will modify things*, as it creates decisions for the objects in the {AsyncDecider}
       #   that need decisions sent out.
       #
-      # @!visibility private
+      # @api private
       def get_decisions
         result = @decision_helper.decision_map.values.map {|decision_object|
           decision_object.get_decision}.compact
@@ -221,7 +220,7 @@ module AWS
         return result
       end
 
-      # @!visibility private
+      # @api private
       def decide
         begin
           decide_impl
@@ -241,7 +240,7 @@ module AWS
         end
       end
 
-      # @!visibility private
+      # @api private
       def decide_impl
         single_decision_event = @history_helper.get_single_decision_events
         while single_decision_event.length > 0
@@ -289,7 +288,7 @@ module AWS
 
         # If you don't have details, you must be some other type of
         # exception. We can't do anything exceedingly clever, so lets just get
-        # the stack trace and pop that out
+        # the stack trace and pop that out.
         details = failure.details if (failure.respond_to? :details)
         details ||= failure.backtrace.join("")
         new_details = details[0..(max_response_size - truncation_overhead)]
@@ -314,7 +313,7 @@ module AWS
       # Continues this as a new workflow, using the provided decision and options.
       #
       # @param [DecisionID] decision_id
-      #   The decision id to use.
+      #   The decision ID to use.
       #
       # @param [WorkflowOptions] continue_as_new_options
       #   The options to use for the new workflow.
@@ -359,7 +358,7 @@ module AWS
         end
       end
 
-      # Is the task completed?
+      # Indicates whether the task completed.
       #
       # @return [true, false]
       #   Returns `true` if the task is completed; `false` otherwise.
@@ -371,7 +370,7 @@ module AWS
       # Handler for the `:ActivityTaskScheduled` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_activity_task_scheduled(event)
         activity_id = event.attributes[:activity_id]
@@ -383,7 +382,7 @@ module AWS
       # Handler for the `:WorkflowExecutionStarted` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_workflow_execution_started(event)
         @workflow_async_scope = AsyncScope.new do
@@ -397,7 +396,7 @@ module AWS
       # Handler for the `:TimerFired` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_timer_fired(event)
         timer_id = event.attributes[:timer_id]
@@ -413,7 +412,7 @@ module AWS
       # Handler for the `:StartTimerFailed` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_start_timer_failed(event)
         timer_id = event.attributes.timer_id
@@ -434,7 +433,7 @@ module AWS
 
       # Handler for the `:WorkflowExecutionCancelRequested` event.
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       def handle_workflow_execution_cancel_requested(event)
         @workflow_async_scope.cancel(CancellationException.new("Cancelled from a WorkflowExecutionCancelRequested"))
         @cancel_requested = true
@@ -442,7 +441,7 @@ module AWS
 
       # Handler for the `:ActivityTaskCancelRequested` event.
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       def handle_activity_task_cancel_requested(event)
         activity_id = event.attributes[:activity_id]
         @decision_helper[activity_id].consume(:handle_cancellation_initiated_event)
@@ -450,7 +449,7 @@ module AWS
 
       # Handler for the `:RequestCancelActivityTaskFailed` event.
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       def handle_request_cancel_activity_task_failed(event)
         handle_event(event, {
                        :id_methods => [:activity_id],
@@ -465,7 +464,7 @@ module AWS
 
       # Handler for the `:CompleteWorkflowExecutionFailed` event.
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       def handle_complete_workflow_execution_failed(event)
         handle_closing_failure
       end
@@ -473,7 +472,7 @@ module AWS
       # Handler for the `:FailWorkflowExecutionFailed` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_fail_workflow_execution_failed(event)
         handle_closing_failure
@@ -482,16 +481,16 @@ module AWS
       # Handler for the `:CancelWorkflowExecutionFailed` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_cancel_workflow_execution_failed(event)
         handle_closing_failure
       end
 
-      # Handler for the `:ContinueAsNewWorkflowExecutionFailed' event.
+      # Handler for the `:ContinueAsNewWorkflowExecutionFailed` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_continue_as_new_workflow_execution_failed(event)
         handle_closing_failure
@@ -500,7 +499,7 @@ module AWS
       # Handler for the `:TimerStarted` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_timer_started(event)
         timer_id = event.attributes[:timer_id]
@@ -512,7 +511,7 @@ module AWS
       # Handler for the `:TimerCanceled` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_timer_canceled(event)
         handle_event(event, {
@@ -531,7 +530,7 @@ module AWS
       # Handler for the `:SignalExternalWorkflowExecutionInitiated` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_signal_external_workflow_execution_initiated(event)
         signal_id = event.attributes[:control]
@@ -543,7 +542,7 @@ module AWS
       # Handler for the `:RequestCancelExternalWorkflowExecutionInitiated` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_request_cancel_external_workflow_execution_initiated(event)
         handle_event(event, {
@@ -555,7 +554,7 @@ module AWS
       # Handler for the `:RequestCancelExternalWorkflowExecutionFailed` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_request_cancel_external_workflow_execution_failed(event)
         handle_event(event, {
@@ -567,7 +566,7 @@ module AWS
       # Handler for the `:StartChildWorkflowExecutionInitiated` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_start_child_workflow_execution_initiated(event)
         workflow_id = event.attributes[:workflow_id]
@@ -579,7 +578,7 @@ module AWS
       # Handler for the `:CancelTimerFailed` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_cancel_timer_failed(event)
         handle_event(event, {
@@ -588,10 +587,10 @@ module AWS
                      })
       end
 
-      # Handler for the `:WorkflowExecutionSignaled` event.
+      # Handler for the `WorkflowExecutionSignaled` event.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def handle_workflow_execution_signaled(event)
         signal_name = event.attributes[:signal_name]
@@ -605,10 +604,10 @@ module AWS
         @workflow_async_scope.get_closest_containing_scope << t
       end
 
-      # Processes decider events
+      # Processes decider events.
       #
       # @param [Object] event
-      #   The event to process
+      #   The event to process.
       #
       def process_event(event)
         event_type_symbol = event.event_type.to_sym
@@ -656,7 +655,7 @@ module AWS
           # DecisionTaskStarted is taken care of at TODO
       end
 
-      # @!visibility private
+      # @api private
       def event_loop(event)
         return if @completed
         begin