aws-sdk 1.8.5 → 1.9.0

data/lib/aws/simple_workflow/config.rb

@@ -13,6 +13,6 @@
 
 AWS::Core::Configuration.module_eval do
 
-  add_service 'SimpleWorkflow', 'simple_workflow', 'swf.us-east-1.amazonaws.com'
+  add_service 'SimpleWorkflow', 'simple_workflow', 'swf.%s.amazonaws.com'
 
 end

data/lib/aws/simple_workflow/count.rb

@@ -14,9 +14,9 @@
 module AWS
   class SimpleWorkflow
 
-    # Simple Workflow returns counts that may be truncated.  Truncated 
-    # counts indicate a lower bound.  A count of 100 that is truncated 
-    # could be represented to a user like "100+".  Non-truncated counts 
+    # Simple Workflow returns counts that may be truncated.  Truncated
+    # counts indicate a lower bound.  A count of 100 that is truncated
+    # could be represented to a user like "100+".  Non-truncated counts
     # are definitive.
     class Count
 
@@ -37,8 +37,8 @@ module AWS
       end
 
       def == other
-        other.is_a?(Count) and 
-        other.count == self.count and 
+        other.is_a?(Count) and
+        other.count == self.count and
         other.truncated? == self.truncated?
       end
 

data/lib/aws/simple_workflow/decision_task.rb

@@ -14,43 +14,43 @@
 module AWS
   class SimpleWorkflow
 
-    # == Getting Decision Tasks
+    # ## Getting Decision Tasks
     #
     # You can use #poll or #poll_for_single_task on {DecisionTaskCollection}
     # to grab a decision task:
     #
-    #   # get a single task
-    #   if task = domain.decision_tasks.poll_for_single_task('task-list')
-    #     # make decisions
-    #     task.complete!
-    #   end
+    #     # get a single task
+    #     if task = domain.decision_tasks.poll_for_single_task('task-list')
+    #       # make decisions
+    #       task.complete!
+    #     end
     #
     # See {DecisionTaskCollection} for more information on getting and
     # counting decision tasks.
     #
-    # == Exploring Event History
+    # ## Exploring Event History
     #
-    # Once you have a decision task you can examine the event history. 
+    # Once you have a decision task you can examine the event history.
     # This can give you the information you need to make decisions.
     # The {#events} and {#new_events} methods enumerate through
     # all events or events since the last decision.
     #
-    #   decision_task.new_events.each do |event|
-    #     # inspect the #event_type and #attributes
-    #   end
-    # 
+    #     decision_task.new_events.each do |event|
+    #       # inspect the #event_type and #attributes
+    #     end
+    #
     # Check out {HistoryEvent} for more information on working with
     # events.
     #
-    # == Making Decisions
+    # ## Making Decisions
     #
     # Based on the history of events, you should make decisions by calling
     # methods listed below.  You can call each method as many times as
     # you wish, until you have completed the decision task.
-    # 
+    #
     #  * {#schedule_activity_task}
     #  * {#request_cancel_activity_task}
-    # 
+    #
     #  * {#complete_workflow_execution}
     #  * {#cancel_workflow_execution}
     #  * {#fail_workflow_execution}
@@ -66,23 +66,23 @@ module AWS
     #
     # The decision methods are grouped above by concern.
     #
-    # == Completing the Decision Task
+    # ## Completing the Decision Task
     #
     # Once you have finished adding decisions to the task, you need to
-    # complete it.  If you called {DecisionTaskCollection#poll} or 
+    # complete it.  If you called {DecisionTaskCollection#poll} or
     # {DecisionTaskCollection#poll_for_single_task} with a block
     # argument then the decision will be completed automatically at the
     # end of the block.
     #
-    #   domain.decision_tasks.poll do |decision_task|
-    #     # ...
-    #   end #=> the decision task is closed here
+    #     domain.decision_tasks.poll do |decision_task|
+    #       # ...
+    #     end #=> the decision task is closed here
     #
     # If you get a task from {DecisionTaskCollection#poll_for_single_task}
     # without a block, then it is your responsibility to call {#complete!}
     # on the decision task.  If you fail to do this before the
-    # task start to close timeout, then a decisionTaskTimedOut event 
-    # will be added to the workflow execution history. 
+    # task start to close timeout, then a decisionTaskTimedOut event
+    # will be added to the workflow execution history.
     #
     class DecisionTask
 
@@ -113,7 +113,7 @@ module AWS
         @next_token = data['nextPageToken']
 
         @events = data['events']
-        
+
         @decisions = []
 
         super
@@ -132,18 +132,18 @@ module AWS
       # @return [WorkflowType]
       attr_reader :workflow_type
 
-      # @return [Integer] The id of the DecisionTaskStarted event of the 
-      #   previous decision task of this workflow execution that was 
-      #   processed by the decider. This can be used to determine the new 
-      #   events in the history new since the last decision task received 
+      # @return [Integer] The id of the DecisionTaskStarted event of the
+      #   previous decision task of this workflow execution that was
+      #   processed by the decider. This can be used to determine the new
+      #   events in the history new since the last decision task received
       #   by the decider.
       attr_reader :previous_started_event_id
 
-      # @return [Integer] The id of the DecisionTaskStarted event recorded 
+      # @return [Integer] The id of the DecisionTaskStarted event recorded
       #   in the history.
       attr_reader :started_event_id
 
-      # @return [String,nil] Returns a value if the results are paginated. 
+      # @return [String,nil] Returns a value if the results are paginated.
       #   Normally you do not need this value, as {#events} will enumerate
       #   all events, making requests as necessary to get more.
       attr_reader :next_token
@@ -156,14 +156,14 @@ module AWS
 
       # @return [Enumerable] Returns an enumerable collection of only the
       #   new events for workflow execution (since the last decision).
-      def new_events  
+      def new_events
         enum_for(:_new_events)
       end
 
       # @param [Hash] options
       #
-      # @option options [String] :execution_context (nil)  A user-defined 
-      #   context to add to the workflow execution.  You can fetch this 
+      # @option options [String] :execution_context (nil)  A user-defined
+      #   context to add to the workflow execution.  You can fetch this
       #   later with {WorkflowExecution#latest_execution_context}.
       #
       # @return [nil]
@@ -188,67 +188,67 @@ module AWS
       def responded?
         !!@responded
       end
-      
+
       # Schedules an activity task.
       #
       # @note This adds a decision to this task that is finalized when you
       #   call {#complete!}.
       #
       # @param [ActivityType,Hash] activity_type The type of activity
-      #   to schedule.  +activity_type+ must be an {ActivityType} object
-      #   or a hash with +:name+ and +:version+.
+      #   to schedule.  `activity_type` must be an {ActivityType} object
+      #   or a hash with `:name` and `:version`.
       #
       # @param [Hash] options
       #
-      # @option options [String] :control (nil) Optional data attached to 
-      #   the event that can be used by the decider in subsequent workflow 
+      # @option options [String] :control (nil) Optional data attached to
+      #   the event that can be used by the decider in subsequent workflow
       #   tasks. This data is not sent to the activity.
       #
       # @option options [Integer,:none] :heartbeat_timeout (nil)
-      #   The maximum time before which a worker processing a task 
-      #   of this type must report progress.  If the timeout is exceeded, 
-      #   the activity task is automatically timed out. If the worker 
-      #   subsequently attempts to record a heartbeat or returns a 
-      #   result, it will be ignored. This default can be overridden when 
+      #   The maximum time before which a worker processing a task
+      #   of this type must report progress.  If the timeout is exceeded,
+      #   the activity task is automatically timed out. If the worker
+      #   subsequently attempts to record a heartbeat or returns a
+      #   result, it will be ignored. This default can be overridden when
       #   scheduling an activity task.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
-      # @option options [String] :input (nil) Input provided to the 
+      # @option options [String] :input (nil) Input provided to the
       #   activity task.
       #
-      # @option options [Integer,:none] :schedule_to_close_timeout (nil) 
-      #   The maximum duration that a task of this activity type 
-      #   can wait before being assigned to a worker. 
+      # @option options [Integer,:none] :schedule_to_close_timeout (nil)
+      #   The maximum duration that a task of this activity type
+      #   can wait before being assigned to a worker.
       #
-      #   A schedule-to-close timeout for this activity task must be 
-      #   specified either as a default for the activity type or through 
-      #   this option. If neither this field is set nor a default was 
+      #   A schedule-to-close timeout for this activity task must be
+      #   specified either as a default for the activity type or through
+      #   this option. If neither this field is set nor a default was
       #   specified at registration time then a fault will be returned.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
       # @option options [Integer,:none] :schedule_to_start_timeout (nil)
-      #   The maximum duration that a task of this activity type 
-      #   can wait before being assigned to a worker.  This overrides the 
+      #   The maximum duration that a task of this activity type
+      #   can wait before being assigned to a worker.  This overrides the
       #   default timeout specified when registering the activity type.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
       # @option options [Integer,:none] :start_to_close_timeout (nil)
-      #   The maximum duration that a worker can take to process 
-      #   tasks of this activity type.  This overrides the default 
+      #   The maximum duration that a worker can take to process
+      #   tasks of this activity type.  This overrides the default
       #   timeout specified when registering the activity type.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
       # @option options [String] :task_list (nil)
-      #   If set, specifies the name of the task list in which to schedule 
-      #   the activity task. If not specified, the default task list 
+      #   If set, specifies the name of the task list in which to schedule
+      #   the activity task. If not specified, the default task list
       #   registered with the activity type will be used.
       #
       # @return [nil]
@@ -258,8 +258,8 @@ module AWS
         options[:activity_id] ||= UUIDTools::UUID.random_create.to_s
 
         options[:activity_type] = case activity_type
-        when Hash 
-          unless 
+        when Hash
+          unless
             activity_type[:name].is_a?(String) and
             activity_type[:version].is_a?(String) and
             activity_type.keys.length == 2
@@ -272,10 +272,10 @@ module AWS
           { :name => activity_type.name, :version => activity_type.version }
         else
           msg = 'expected activity_type to be an ActivityType object or a hash'
-          raise ArgumentError, msg 
+          raise ArgumentError, msg
         end
 
-        duration_opts(options, 
+        duration_opts(options,
           :heartbeat_timeout,
           :schedule_to_close_timeout,
           :schedule_to_start_timeout,
@@ -286,17 +286,17 @@ module AWS
         end
 
         add_decision :schedule_activity_task, options
-        
+
       end
 
-      # Attempts to cancel a previously scheduled activity task. If the 
-      # activity task was scheduled but has not been assigned to a worker, 
-      # then it will be canceled. If the activity task was already assigned 
-      # to a worker, then the worker will be informed that cancellation has 
+      # Attempts to cancel a previously scheduled activity task. If the
+      # activity task was scheduled but has not been assigned to a worker,
+      # then it will be canceled. If the activity task was already assigned
+      # to a worker, then the worker will be informed that cancellation has
       # been requested when recording the activity task heartbeat.
       #
       # @param [ActivityTask,String] activity_or_activity_id An {ActivityTask}
-      #   object or the activity_id of an activity task to request 
+      #   object or the activity_id of an activity task to request
       #   cancellation for.
       #
       # @return [nil]
@@ -311,12 +311,12 @@ module AWS
 
       end
 
-      # Closes the workflow execution and records a 
+      # Closes the workflow execution and records a
       # WorkflowExecutionCompleted event in the history.
       #
       # @param [Hash] options
       #
-      # @option options [String] :result (nil) The results of the workflow 
+      # @option options [String] :result (nil) The results of the workflow
       #   execution.
       #
       # @return [nil]
@@ -325,7 +325,7 @@ module AWS
         add_decision :complete_workflow_execution, options
       end
 
-      # Closes the workflow execution and records a WorkflowExecutionFailed 
+      # Closes the workflow execution and records a WorkflowExecutionFailed
       # event in the history.
       #
       # @param [Hash] options
@@ -340,12 +340,12 @@ module AWS
         add_decision :fail_workflow_execution, options
       end
 
-      # Closes the workflow execution and records a 
+      # Closes the workflow execution and records a
       # WorkflowExecutionCanceled event in the history.
       #
       # @param [Hash] options
-      # 
-      # @option options [String] :details (nil) Optional details of the 
+      #
+      # @option options [String] :details (nil) Optional details of the
       #   cancellation.
       #
       # @return [nil]
@@ -354,57 +354,57 @@ module AWS
         add_decision :cancel_workflow_execution, options
       end
 
-      # Closes the workflow execution and starts a new workflow execution 
-      # of the same type using the same workflow id and a unique run Id. 
+      # Closes the workflow execution and starts a new workflow execution
+      # of the same type using the same workflow id and a unique run Id.
       # A WorkflowExecutionContinuedAsNew event is recorded in the history.
       #
       # @option options [String] :input (nil)
-      #   The input for the workflow execution. This is a free form string 
-      #   which should be meaningful to the workflow you are starting. 
-      #   This input is made available to the new workflow execution in the 
+      #   The input for the workflow execution. This is a free form string
+      #   which should be meaningful to the workflow you are starting.
+      #   This input is made available to the new workflow execution in the
       #   WorkflowExecutionStarted history event.
-      # 
+      #
       # @option options [Array<string>] :tag_list ([])
       #   A list of tags (strings) to associate with the workflow execution.
       #   You can specify a maximum of 5 tags.
       #
       # @option options [Symbol] :child_policy (nil)
-      #   Specifies the policy to use for the child workflow executions of 
-      #   this workflow execution if it is terminated explicitly or due to 
-      #   an expired timeout. This policy overrides the default child policy 
+      #   Specifies the policy to use for the child workflow executions of
+      #   this workflow execution if it is terminated explicitly or due to
+      #   an expired timeout. This policy overrides the default child policy
       #   specified when registering the workflow type.  The supported child
       #   policies are:
       #
-      #   * +:terminate+ - the child executions will be terminated.
+      #   * `:terminate` - the child executions will be terminated.
       #
-      #   * +:request_cancel+ - a request to cancel will be attempted for each
-      #     child execution by recording a WorkflowExecutionCancelRequested 
+      #   * `:request_cancel` - a request to cancel will be attempted for each
+      #     child execution by recording a WorkflowExecutionCancelRequested
       #     event in its history. It is up to the decider to take appropriate
       #     actions when it receives an execution history with this event.
       #
-      #   * +:abandon+ - no action will be taken. The child executions will 
+      #   * `:abandon` - no action will be taken. The child executions will
       #     continue to run.
       #
       # @option options [Integer,:none] :execution_start_to_close_timeout (nil)
-      #   The total duration for this workflow execution.  This overrides 
+      #   The total duration for this workflow execution.  This overrides
       #   the default specified when registering the workflow type.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
-      # @option options [String] :task_list (nil) 
-      #   The task list to use for the decision tasks generated for this 
+      # @option options [String] :task_list (nil)
+      #   The task list to use for the decision tasks generated for this
       #   workflow execution. This overrides the default task list specified
       #   when registering the workflow type.
       #
       # @option options [Integer,:none] :task_start_to_close_timeout (nil)
-      #   Specifies the maximum duration of decision tasks for this 
-      #   workflow execution. This parameter overrides the default 
+      #   Specifies the maximum duration of decision tasks for this
+      #   workflow execution. This parameter overrides the default
       #   specified when the workflow type was registered.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
-      #   
+      #   `:none` (implying no timeout).
+      #
       # @return [nil]
       #
       def continue_as_new_workflow_execution options = {}
@@ -412,9 +412,9 @@ module AWS
         add_decision :continue_as_new_workflow_execution, options
       end
 
-      # Records a MarkerRecorded event in the history. Markers can be used 
-      # for adding custom information in the history for instance to let 
-      # deciders know that they do not need to look at the history beyond 
+      # Records a MarkerRecorded event in the history. Markers can be used
+      # for adding custom information in the history for instance to let
+      # deciders know that they do not need to look at the history beyond
       # the marker event.
       #
       # @param [String] marker_name The name of the marker.
@@ -428,21 +428,21 @@ module AWS
       def record_marker marker_name, options = {}
         add_decision :record_marker, options.merge(:marker_name => marker_name)
       end
-      
-      # Schedules a timer for this workflow execution and records a 
-      # TimerScheduled event in the history. This timer will fire after 
+
+      # Schedules a timer for this workflow execution and records a
+      # TimerScheduled event in the history. This timer will fire after
       # the specified delay and record a TimerFired event.
       #
-      # @param [Integer] start_to_fire_timeout (nil) The duration to wait 
-      #   before firing the timer. 
-      # 
+      # @param [Integer] start_to_fire_timeout (nil) The duration to wait
+      #   before firing the timer.
+      #
       # @param [Hash] options
       #
-      # @option options [String] :control (nil) Optional data attached to 
-      #   the event that can be used by the decider in subsequent workflow 
+      # @option options [String] :control (nil) Optional data attached to
+      #   the event that can be used by the decider in subsequent workflow
       #   tasks.
       #
-      # @option options [String] :timer_id (nil) Unique id for the timer. 
+      # @option options [String] :timer_id (nil) Unique id for the timer.
       #   If you do not pass this option, a UUID will be generated.
       #
       # @return [String] Returns the id of the timer.
@@ -467,7 +467,7 @@ module AWS
       end
 
       # Requests a signal to be delivered to the specified external workflow
-      # execution and records a SignalExternalWorkflowExecutionRequested 
+      # execution and records a SignalExternalWorkflowExecutionRequested
       # event in the history.
       #
       # @param [WorkflowExecution,String] workflow_execution
@@ -476,13 +476,13 @@ module AWS
       #
       # @param [Hash] options
       #
-      # @option options [String] :control (nil) Optional data attached to 
-      #   the event that can be used by the decider in subsequent decision 
+      # @option options [String] :control (nil) Optional data attached to
+      #   the event that can be used by the decider in subsequent decision
       #   tasks.
       #
-      # @option options [String] :input (nil) Optional input to be provided 
-      #   with the signal.  The target workflow execution will use the 
-      #   signal name and input to process the signal. 
+      # @option options [String] :input (nil) Optional input to be provided
+      #   with the signal.  The target workflow execution will use the
+      #   signal name and input to process the signal.
       #
       # @return [nil]
       #
@@ -492,9 +492,9 @@ module AWS
         add_decision :signal_external_workflow_execution, options
       end
 
-      # Requests that a request be made to cancel the specified external 
-      # workflow execution and records a 
-      # RequestCancelExternalWorkflowExecutionRequested event in 
+      # Requests that a request be made to cancel the specified external
+      # workflow execution and records a
+      # RequestCancelExternalWorkflowExecutionRequested event in
       # the history.
       #
       # @return [nil]
@@ -504,21 +504,21 @@ module AWS
         add_decision :request_cancel_external_workflow_execution, options
       end
 
-      # Requests that a child workflow execution be started and records a 
-      # StartChildWorkflowExecutionRequested event in the history. 
-      # The child workflow execution is a separate workflow execution with 
+      # Requests that a child workflow execution be started and records a
+      # StartChildWorkflowExecutionRequested event in the history.
+      # The child workflow execution is a separate workflow execution with
       # its own history.
       #
-      # @param [WorkflowType,Hash] workflow_type (nil) The type of 
+      # @param [WorkflowType,Hash] workflow_type (nil) The type of
       #   workflow execution to start.  This should be a {WorkflowType} object
-      #   or a hash with the keys +:name+ and +:version+.
+      #   or a hash with the keys `:name` and `:version`.
       #
       # @param [Hash] options
       #
       # @option (see WorkflowType#start_execution)
       #
-      # @option options [String] :control (nil) Optional data attached to 
-      #   the event that can be used by the decider in subsequent workflow 
+      # @option options [String] :control (nil) Optional data attached to
+      #   the event that can be used by the decider in subsequent workflow
       #   tasks.
       #
       # @return [String] Returns the workflow id of the new execution.
@@ -535,8 +535,8 @@ module AWS
        if workflow_execution.is_a?(WorkflowExecution)
           options[:workflow_id] = workflow_execution.workflow_id
           options[:run_id] = workflow_execution.run_id
-        elsif 
-          workflow_execution.is_a?(Hash) and 
+        elsif
+          workflow_execution.is_a?(Hash) and
           workflow_execution[:workflow_id].is_a?(String) and
           workflow_execution[:run_id].is_a?(String) and
           workflow_execution.keys.length == 2
@@ -554,9 +554,9 @@ module AWS
 
       protected
       def add_decision decision_type, attributes
-        @decisions << { 
+        @decisions << {
           :decision_type => Core::Inflection.class_name(decision_type.to_s),
-          :"#{decision_type}_decision_attributes" => attributes, 
+          :"#{decision_type}_decision_attributes" => attributes,
         }
         nil
       end
@@ -591,7 +591,7 @@ module AWS
         events.each do |description|
           event = HistoryEvent.new(workflow_execution, description)
           Core::MetaUtils.extend_method(event, :new?) do
-            prev_event_id.nil? or self.event_id > prev_event_id  
+            prev_event_id.nil? or self.event_id > prev_event_id
           end
           yield(event)
         end