aws-sdk 1.8.5 → 1.9.0

data/lib/aws/simple_workflow/history_event_collection.rb

@@ -14,7 +14,7 @@
 module AWS
   class SimpleWorkflow
 
-    # This collection represents the history events ({HistoryEvent}) for a 
+    # This collection represents the history events ({HistoryEvent}) for a
     # single workflow execution.
     #
     # See {Core::Collection} for documentation on the standard enumerable
@@ -24,7 +24,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
 
-      # @param [WorkflowExecution] workflow_execution The execution this 
+      # @param [WorkflowExecution] workflow_execution The execution this
       #   history event belongs to.
       #
       # @param [Hash] options
@@ -58,7 +58,7 @@ module AWS
         }
         options[:maximum_page_size] = limit if limit
         options[:next_page_token] = next_token if next_token
-        options[:reverse_order] = @reverse_order unless 
+        options[:reverse_order] = @reverse_order unless
           options.has_key?(:reverse_order)
 
         response = client.get_workflow_execution_history(options)

data/lib/aws/simple_workflow/option_formatters.rb

@@ -15,7 +15,7 @@ require 'socket'
 
 module AWS
   class SimpleWorkflow
-    
+
     # @private
     module OptionFormatters
 
@@ -23,7 +23,7 @@ module AWS
       def identity_opt options
         options[:identity] || "#{Socket.gethostname}:#{Process.pid}"
       end
-      
+
       protected
       def upcase_opts options, *opt_names
         opt_names.each do |opt|
@@ -45,12 +45,12 @@ module AWS
         if workflow_type
 
           options[:workflow_id] ||= UUIDTools::UUID.random_create.to_s
-          
+
           if workflow_type.is_a?(WorkflowType)
             options[:workflow_type] = {}
             options[:workflow_type][:name] = workflow_type.name
             options[:workflow_type][:version] = workflow_type.version
-          elsif 
+          elsif
             workflow_type.is_a?(Hash) and
             workflow_type[:name].is_a?(String) and
             workflow_type[:version] .is_a?(String)and
@@ -67,7 +67,7 @@ module AWS
 
         upcase_opts(options, :child_policy)
 
-        duration_opts(options, 
+        duration_opts(options,
           :execution_start_to_close_timeout,
           :task_start_to_close_timeout)
 

data/lib/aws/simple_workflow/request.rb

@@ -22,7 +22,7 @@ module AWS
       def read_timeout
         # increase read timeout for long polling
         if headers['x-amz-target'] =~ /PollFor(Decision|Activity)Task/
-          90 
+          90
         else
           @read_timeout
         end

data/lib/aws/simple_workflow/resource.rb

@@ -39,7 +39,7 @@ module AWS
 
         if options[:duration]
           super(name, options) do
-            translates_output do |v| 
+            translates_output do |v|
               v.to_s =~ /^\d+$/ ? v.to_i : v.downcase.to_sym
             end
           end

data/lib/aws/simple_workflow/type.rb

@@ -36,15 +36,15 @@ module AWS
       # @return [String] Returns the version of this type.
       attr_reader :version
 
-      # Deprecates the type. 
+      # Deprecates the type.
       #
-      # After a type has been deprecated, you cannot create new 
-      # executions of that type. Executions that were started before the 
+      # After a type has been deprecated, you cannot create new
+      # executions of that type. Executions that were started before the
       # type was deprecated will continue to run.
       #
-      # @note This operation is eventually consistent. The results are best 
+      # @note This operation is eventually consistent. The results are best
       #   effort and may not exactly reflect recent updates and changes.
-      # 
+      #
       # @return [nil]
       #
       def deprecate
@@ -66,10 +66,10 @@ module AWS
       protected
       def resource_options
         {
-          :domain => domain.name, 
-          :"#{self.class.ruby_name}" => { 
+          :domain => domain.name,
+          :"#{self.class.ruby_name}" => {
             :name => name,
-            :version => version 
+            :version => version
           }
         }
       end

data/lib/aws/simple_workflow/type_collection.rb

@@ -19,9 +19,9 @@ module AWS
     class TypeCollection
 
       include OptionFormatters
-      include Core::Collection::WithLimitAndNextToken 
+      include Core::Collection::WithLimitAndNextToken
 
-      # @param [Domain] domain The domain the (workflow or activity types 
+      # @param [Domain] domain The domain the (workflow or activity types
       #   belong to.
       def initialize domain, options = {}
 
@@ -29,7 +29,7 @@ module AWS
 
         @named = options[:named]
 
-        @registration_status = options[:registration_status] ? 
+        @registration_status = options[:registration_status] ?
           options[:registration_status].to_s.upcase : 'REGISTERED'
 
         @reverse_order = options.key?(:reverse_order) ?
@@ -44,13 +44,13 @@ module AWS
 
       # Returns the type with the given name and version.
       #
-      #   # get a workflow type
-      #   domain.workflow_types['name','version']
-      #   domain.workflow_types.at('name','version')
+      #     # get a workflow type
+      #     domain.workflow_types['name','version']
+      #     domain.workflow_types.at('name','version')
       #
-      #   # get an activity type
-      #   domain.activity_types['name','version']
-      #   domain.activity_types.at('name','version')
+      #     # get an activity type
+      #     domain.activity_types['name','version']
+      #     domain.activity_types.at('name','version')
       #
       # @param [String] name Name of the type.
       #
@@ -81,7 +81,7 @@ module AWS
         collection_with(:reverse_order => true)
       end
 
-      # @return [TypeCollection] Returns a collection that 
+      # @return [TypeCollection] Returns a collection that
       #   enumerates types with the given name.  Each instance
       #   will have a different version.
       def named name
@@ -112,7 +112,7 @@ module AWS
         options[:maximum_page_size] = limit if limit
         options[:registration_status] ||= @registration_status
         options[:name] ||= @named if @named # may be nil
-        options[:reverse_order] = @reverse_order unless 
+        options[:reverse_order] = @reverse_order unless
           options.has_key?(:reverse_order)
 
 
@@ -123,12 +123,12 @@ module AWS
         response = client.send(client_method, options)
         response.data['typeInfos'].each do |desc|
 
-          type = member_class.new_from(client_method, desc, domain, 
-            desc[type_key]['name'], 
-            desc[type_key]['version']) 
+          type = member_class.new_from(client_method, desc, domain,
+            desc[type_key]['name'],
+            desc[type_key]['version'])
 
           yield(type)
-          
+
         end
 
         response.data['nextPageToken']

data/lib/aws/simple_workflow/workflow_execution.rb

@@ -14,18 +14,16 @@
 module AWS
   class SimpleWorkflow
 
-    # @attr_reader [Symbol] child_policy The policy to use for the child 
-    #   workflow executions if this workflow execution is terminated. 
+    # @attr_reader [Symbol] child_policy The policy to use for the child
+    #   workflow executions if this workflow execution is terminated.
     #   The return value will be one of the following values:
     #
-    #   * +:terminate+ - the child executions will be terminated.
-    #
-    #   * +:request_cancel+ - a request to cancel will be attempted for each
-    #     child execution by recording a WorkflowExecutionCancelRequested 
+    #   * `:terminate` - the child executions will be terminated.
+    #   * `: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.
     #
     # @attr_reader [String] start_to_close_timeout The total allowed
@@ -34,7 +32,7 @@ module AWS
     #   The return value will be formatted as an ISO 8601 duration (e.g.
     #   'PnYnMnDTnHnMnS').
     #
-    # @attr_reader [String] task_list The task list used for the decision 
+    # @attr_reader [String] task_list The task list used for the decision
     #   tasks generated for this workflow execution.
     #
     # @attr_reader [String] task_start_to_close_timeout The maximum duration
@@ -47,24 +45,24 @@ module AWS
     #   was closed.  Returns nil if this execution is not closed.
     #
     # @attr_reader [Time] started_at The time when the execution was started.
-    #   
-    # @attr_reader [Time,nil] latest_activity_task_scheduled_at The time 
+    #
+    # @attr_reader [Time,nil] latest_activity_task_scheduled_at The time
     #   when the last activity task was scheduled for this workflow execution.
-    #   You can use this information to determine if the workflow has not 
-    #   made progress for an unusually long period of time and might 
+    #   You can use this information to determine if the workflow has not
+    #   made progress for an unusually long period of time and might
     #   require a corrective action.
     #
     # @attr_reader [String,nil] latest_execution_context The latest execution
-    #   context provided by the decider for this workflow execution. A decider 
-    #   can provide an execution context, which is a free form string, when 
+    #   context provided by the decider for this workflow execution. A decider
+    #   can provide an execution context, which is a free form string, when
     #   closing a decision task.
     #
     # @attr_reader [Hash] open_counts Returns a hash of counts, including:
-    #   +:open_timers+, +:open_child_workflow_executions+, +:open_decision_tasks+,
-    #   and +:open_activity_tasks+.
-    # 
+    #   `:open_timers`, `:open_child_workflow_executions`, `:open_decision_tasks`,
+    #   and `:open_activity_tasks`.
+    #
     class WorkflowExecution < Resource
-      
+
       def initialize domain, workflow_id, run_id, options = {}
         @domain = domain
         @workflow_id = workflow_id
@@ -104,8 +102,8 @@ module AWS
       info_attribute :parent_details, :from => 'parent', :static => true
       protected :parent_details
 
-      info_attribute :started_at, 
-        :from => 'startTimestamp', 
+      info_attribute :started_at,
+        :from => 'startTimestamp',
         :timestamp => true,
         :static => true
 
@@ -115,7 +113,7 @@ module AWS
       info_attribute :type_details, :from => 'workflowType', :static => true
       protected :type_details
 
-      attribute :latest_activity_task_scheduled_at, 
+      attribute :latest_activity_task_scheduled_at,
         :from => 'latestActivityTaskTimestamp',
         :timestamp => true
 
@@ -131,13 +129,13 @@ module AWS
 
       # list_workflow_executions provides ONLY type attributes
       provider(
-        :list_open_workflow_executions, 
+        :list_open_workflow_executions,
         :list_closed_workflow_executions
       ) do |provider|
         provider.provides *info_attributes.keys
         provider.find do |resp|
           execution = { 'workflowId' => workflow_id, 'runId' => run_id }
-          resp.data['executionInfos'].find do |desc|  
+          resp.data['executionInfos'].find do |desc|
             desc['execution'] == execution
           end
         end
@@ -160,20 +158,20 @@ module AWS
       # @return [Symbol] Returns the status of this execution. Possible
       #   return values are:
       #
-      #   * +:open+ - The execution is still running.
-      #   * +:completed+ - The execution was successfully completed.
-      #   * +:canceled+ - The execution was canceled, cancellation allows 
-      #      the implementation to gracefully clean up before the execution 
+      #   * `:open` - The execution is still running.
+      #   * `:completed` - The execution was successfully completed.
+      #   * `:canceled` - The execution was canceled, cancellation allows
+      #      the implementation to gracefully clean up before the execution
       #      is closed.
-      #   * +:failed+ - The execution failed to complete.
+      #   * `:failed` - The execution failed to complete.
       #     and was automatically timed out.
-      #   * +:continued_as_new+ - The execution is logically continued. This
-      #     means the current execution was completed and a new execution 
+      #   * `:continued_as_new` - The execution is logically continued. This
+      #     means the current execution was completed and a new execution
       #     was started to carry on the workflow.
-      #   * +:terminated+ - The execution was force terminated.
-      #   * +:timed_out+ - The execution did not complete in the allotted
+      #   * `:terminated` - The execution was force terminated.
+      #   * `:timed_out` - The execution did not complete in the allotted
       #     time and was automatically timed out.
-      #   
+      #
       def status
         AWS.memoize do
           execution_status == :open ? :open : (close_status || :closed)
@@ -246,18 +244,18 @@ module AWS
         end
       end
 
-      # Records a WorkflowExecutionSignaled event in the workflow execution 
+      # Records a WorkflowExecutionSignaled event in the workflow execution
       # history and creates a decision task for the workflow execution.
       #
-      #   workflow_execution.signal('signal_name', :input => '...')
+      #     workflow_execution.signal('signal_name', :input => '...')
       #
-      # @param [String] signal_name The name of the signal. This name must be 
+      # @param [String] signal_name The name of the signal. This name must be
       #   meaningful to the target workflow.
       #
       # @param [Hash] options
       #
-      # @option options [String] :input (nil) Data to attach to the 
-      #   WorkflowExecutionSignaled event in the target workflow 
+      # @option options [String] :input (nil) Data to attach to the
+      #   WorkflowExecutionSignaled event in the target workflow
       #   execution's history.
       #
       # @return [nil]
@@ -267,13 +265,13 @@ module AWS
         domain.workflow_executions.signal(workflow_id, signal_name, options)
       end
 
-      # Records a WorkflowExecutionCancelRequested event in the currently 
+      # Records a WorkflowExecutionCancelRequested event in the currently
       # running workflow execution. This logically requests the cancellation
-      # of the workflow execution as a whole. It is up to the decider to 
-      # take appropriate actions when it receives an execution history 
+      # of the workflow execution as a whole. It is up to the decider to
+      # take appropriate actions when it receives an execution history
       # with this event.
       #
-      # @note Because this action allows the workflow to properly clean up 
+      # @note Because this action allows the workflow to properly clean up
       #   and gracefully close, it should be used instead of {#terminate}
       #   when possible.
       #
@@ -284,41 +282,41 @@ module AWS
         domain.workflow_executions.request_cancel(workflow_id, options)
       end
 
-      # Records a WorkflowExecutionTerminated event and forces closure of 
-      # the workflow execution. The child policy, registered with the 
-      # workflow type or specified when starting this execution, is applied 
+      # Records a WorkflowExecutionTerminated event and forces closure of
+      # the workflow execution. The child policy, registered with the
+      # workflow type or specified when starting this execution, is applied
       # to any open child workflow executions of this workflow execution.
       #
-      # @note If the workflow execution was in progress, it is terminated 
+      # @note If the workflow execution was in progress, it is terminated
       #   immediately.
       #
-      # @note You should consider canceling the workflow execution 
+      # @note You should consider canceling the workflow execution
       #   instead because it allows the workflow to gracefully close
       #   while terminate does not.
       #
       # @param [Hash] options
       #
       # @option options [Symbol] :child_policy (nil)
-      #   If set, specifies the policy to use for the child workflow 
-      #   executions of the workflow execution being terminated. This 
+      #   If set, specifies the policy to use for the child workflow
+      #   executions of the workflow execution being terminated. This
       #   policy overrides the default child policy.  Valid policies include:
       #
-      #   * +: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 [String] :details (nil) Optional details for 
+      # @option options [String] :details (nil) Optional details for
       #   terminating the workflow execution.
       #
-      # @option options [String] :reason (nil) An optional descriptive 
+      # @option options [String] :reason (nil) An optional descriptive
       #   reason for terminating the workflow execution.
-      # 
+      #
       # @return [nil]
       #
       def terminate options = {}
@@ -330,35 +328,35 @@ module AWS
       #
       # @note See {WorkflowExecutionCollection#count} for a broader count.
       #
-      # @note This operation is eventually consistent. The results are best 
+      # @note This operation is eventually consistent. The results are best
       #   effort and may not exactly reflect recent updates and changes.
       #
       # @param [Hash] options
       #
-      # @option options [Symbol] :status (:open) Specifies that 
+      # @option options [Symbol] :status (:open) Specifies that
       #   status of the workflow executions to count. Defaults to
       #   open workflows.
       #
-      #   * +:open+
-      #   * +:closed+
+      #   * `:open`
+      #   * `:closed`
       #
       # @option options [Array<Time>] :started_between A start and end time
-      #   to filter workflow execution start times by.  You may pass an 
+      #   to filter workflow execution start times by.  You may pass an
       #   array with two time values or a range.  Times should be
-      #   timestamps (integers), Time, Date, DateTime or parseable time 
-      #   strings. 
+      #   timestamps (integers), Time, Date, DateTime or parseable time
+      #   strings.
       #
-      #   You may not pass both +:started_between+ and +:closed_between+.
+      #   You may not pass both `:started_between` and `:closed_between`.
       #
       # @option options [Array<Time>] :closed_between A start and end time
-      #   to filter workflow execution closed times by.  You may pass an 
+      #   to filter workflow execution closed times by.  You may pass an
       #   array with two time values or a range.  Times should be
-      #   timestamps (integers), Time, Date, DateTime or parseable time 
-      #   strings. 
+      #   timestamps (integers), Time, Date, DateTime or parseable time
+      #   strings.
       #
-      #   You may not pass both +:started_between+ and +:closed_between+.
-      #   You may also not pass +:closed_between+ if the +:status+ is
-      #   +:open+.
+      #   You may not pass both `:started_between` and `:closed_between`.
+      #   You may also not pass `:closed_between` if the `:status` is
+      #   `:open`.
       #
       # @return [Integer] Returns the count of executions that share
       #   workflow id with the current execution.
@@ -380,7 +378,7 @@ module AWS
           :execution => { :workflow_id => workflow_id, :run_id => run_id },
         }
       end
-      
+
     end
   end
 end