aws-sdk 1.8.5 → 1.9.0

data/lib/aws/simple_workflow/decision_task_collection.rb

@@ -21,50 +21,50 @@ module AWS
     # Provides an interface to count, and receive decision tasks
     # ({DecisionTask} objects) from the service.
     #
-    # == Counting
+    # ## Counting
     #
     # To get a count of decision tasks needing attention, call {#count}
     # with a task list name:
     #
-    #   domain.decision_tasks.count('my-task-list').to_i #=> 7
+    #     domain.decision_tasks.count('my-task-list').to_i #=> 7
     #
-    # == Getting a single decision task
+    # ## Getting a single decision task
     #
     # To process a single task use {#poll_for_single_task}:
     #
-    #   domain.decision_tasks.poll_for_single_task('my-task-list') do |task|
-    #     # this block is yielded to only if a task is found
-    #     # within 60 seconds.
-    #   end
+    #     domain.decision_tasks.poll_for_single_task('my-task-list') do |task|
+    #       # this block is yielded to only if a task is found
+    #       # within 60 seconds.
+    #     end
     #
     # At the end of the block, the decision task is auto-completed.
-    # If you prefer you can omit the block and +nil+ or a {DecisionTask}
+    # If you prefer you can omit the block and `nil` or a {DecisionTask}
     # will be returned.
     #
-    #   if task = domain.decision_tasks.poll_for_single_task('my-task-list')
-    #     # you need to call complete! or the decision task will time out
-    #     task.complete!
-    #   end
+    #     if task = domain.decision_tasks.poll_for_single_task('my-task-list')
+    #       # you need to call complete! or the decision task will time out
+    #       task.complete!
+    #     end
     #
-    # == Polling for Tasks in a Loop
+    # ## Polling for Tasks in a Loop
     #
     # You can poll indefinitely for tasks in a loop with {#poll}:
     #
-    #   domain.decision_tasks.poll('my-task-list') do |task|
-    #     # yields once for every decision task found 
-    #   end
+    #     domain.decision_tasks.poll('my-task-list') do |task|
+    #       # yields once for every decision task found
+    #     end
     #
     # Just like the block form above, the decision task is auto completed at
-    # the end of the block.  Please note, if you call +break+ or +return+ 
+    # the end of the block.  Please note, if you call `break` or `return`
     # from inside the block, you *MUST* call {DecisionTask#complete!} or
     # the task will timeout.
     #
-    # == Events and Decisions
+    # ## Events and Decisions
     #
     # Each decision task provides an enumerable collection of both
-    # new events ({DecisionTask#new_events}) and all events 
-    # ({DecisionTask#events}).  
-    # 
+    # new events ({DecisionTask#new_events}) and all events
+    # ({DecisionTask#events}).
+    #
     # Based on the events in the workflow execution history, you should
     # call methods on the decision task.  See {DecisionTask} for
     # a complete list of decision methods.
@@ -83,16 +83,16 @@ module AWS
       # @return [Domain]
       attr_reader :domain
 
-      # Returns the number of decision tasks in the specified +task_list+. 
+      # Returns the number of decision tasks in the specified `task_list`.
       #
-      #   count = decision_tasks.count('task-list-name')
-      #   count.truncated? #=> false
-      #   count.to_i #=> 7
+      #     count = decision_tasks.count('task-list-name')
+      #     count.truncated? #=> false
+      #     count.to_i #=> 7
       #
-      # @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 [String] task_list Name of the task list to count 
+      # @param [String] task_list Name of the task list to count
       #   decision tasks for.
       #
       # @return [Count] Returns a {Count} object that specifies the number
@@ -108,44 +108,44 @@ module AWS
       end
 
       # Polls the service for a single decision task.  The service may
-      # hold the request for up to 60 seconds before responding.  
+      # hold the request for up to 60 seconds before responding.
       #
-      #   # try to get a single task, may return nil when no tasks available
-      #   task = domain.decision_tasks.poll_for_single_task('task-list')
-      #   if task
-      #     # make decisions ...
-      #     task.complete!
-      #   end
+      #     # try to get a single task, may return nil when no tasks available
+      #     task = domain.decision_tasks.poll_for_single_task('task-list')
+      #     if task
+      #       # make decisions ...
+      #       task.complete!
+      #     end
       #
       # You can optionally pass a block and that will only be yielded
       # to when a decision task is available within the 60 seconds.
       #
-      #   domain.decision_tasks.poll_for_single_task('task-list') do |task|
-      #      # make decisions
-      #      # task.complete! is called for you at the end of the block
-      #   end
+      #     domain.decision_tasks.poll_for_single_task('task-list') do |task|
+      #        # make decisions
+      #        # task.complete! is called for you at the end of the block
+      #     end
       #
-      # With the block form you do not need to call #complete! on the 
+      # With the block form you do not need to call #complete! on the
       # decision task.  It will be called when the block exists.
       #
-      # @note If you are not using the block form you must call 
+      # @note If you are not using the block form you must call
       #   {DecisionTask#complete!} yourself or your decision task will
       #   timeout.
       #
-      # @param [String] task_list Specifies the task list to poll for 
+      # @param [String] task_list Specifies the task list to poll for
       #   decision tasks.
       #
       # @param [Hash] options
       #
-      # @option options [String] :identity The identity of the decider 
+      # @option options [String] :identity The identity of the decider
       #   requesting a decision task.  This will be recorded in the
-      #   DecisionTaskStarted event in the workflow history. 
-      #   If +:identity+ is not passed then the hostname and 
+      #   DecisionTaskStarted event in the workflow history.
+      #   If `:identity` is not passed then the hostname and
       #   process id will be sent (e.g. "hostname:pid").
       #
-      # @option options [Boolean] :reverse_event_order (false)  When true, 
-      #   the history events on the decision task will enumerate in 
-      #   reverse chronological order (newest events first).  By default 
+      # @option options [Boolean] :reverse_event_order (false)  When true,
+      #   the history events on the decision task will enumerate in
+      #   reverse chronological order (newest events first).  By default
       #   the events are enumerated in chronological order (oldest first).
       #
       # @option options [Integer] :event_batch_size (1000) When enumerating
@@ -154,10 +154,10 @@ module AWS
       #   of events to request each time (must not be greater than 1000).
       #
       # @yieldparam [DecisionTask] decision_task
-      # 
-      # @return [DecisionTask,nil] Returns a decision task or +nil+.  If
-      #   a block was passed then +nil+ is always returned.  If a block
-      #   is not passed, then +nil+ or a {DecisionTask} will be returned.
+      #
+      # @return [DecisionTask,nil] Returns a decision task or `nil`.  If
+      #   a block was passed then `nil` is always returned.  If a block
+      #   is not passed, then `nil` or a {DecisionTask} will be returned.
       #
       def poll_for_single_task task_list, options = {}, &block
 
@@ -190,25 +190,25 @@ module AWS
       # yielded to the block.  At the end of the block the decision task
       # is auto-completed ({DecisionTask#complete!} is called).
       #
-      #   # yields once for each decision task found, indefinitely
-      #   domain.decision_tasks.poll do |decision_task|
-      #     # make decisions here
-      #   end
+      #     # yields once for each decision task found, indefinitely
+      #     domain.decision_tasks.poll do |decision_task|
+      #       # make decisions here
+      #     end
       #
-      # @note If you to terminate the block (by calling +break+ or +return+)
-      #   then it is your responsibility to call #complete! on the decision 
+      # @note If you to terminate the block (by calling `break` or `return`)
+      #   then it is your responsibility to call #complete! on the decision
       #   task.
       #
       # @param (see #poll_for_single_task)
       #
       # @option (see #poll_for_single_task)
-      # 
+      #
       # @yieldparam [DecisionTask] decision_task
       #
       # @return [nil]
       #
       def poll task_list, options = {}, &block
-        loop do 
+        loop do
           begin
             poll_for_single_task(task_list, options) do |decision_task|
               yield(decision_task)

data/lib/aws/simple_workflow/domain.rb

@@ -14,18 +14,18 @@
 module AWS
   class SimpleWorkflow
 
-    # Domains are used to organize workflows types and activities for 
+    # Domains are used to organize workflows types and activities for
     # an account.
     #
-    # @attr_reader [String,nil] description Returns 
+    # @attr_reader [String,nil] description Returns
     #
     # @attr_reader [Integer,Symbol] retention_period Returns the retention
     #   period for this domain. The return value may be an integer (number
-    #   of days history is kept around) or the symbol +:none+, implying
+    #   of days history is kept around) or the symbol `:none`, implying
     #   no expiry of closed workflow executions.
     #
     # @attr_reader [Symbol] status Returns the domain's status.  Status will
-    #   be either +:registered+ or +:deprecated+.
+    #   be either `:registered` or `:deprecated`.
     #
     class Domain < Resource
 
@@ -44,7 +44,7 @@ module AWS
 
       info_attribute :status, :to_sym => true
 
-      config_attribute :retention_period, 
+      config_attribute :retention_period,
         :from => 'workflowExecutionRetentionPeriodInDays',
         :duration => true,
         :static => true
@@ -79,15 +79,15 @@ module AWS
         self.status == :deprecated
       end
 
-      # Deprecates the domain. After a domain has been deprecated it cannot 
-      # be used to create new workflow executions or register new types. 
-      # However, you can still use visibility actions on this domain. 
+      # Deprecates the domain. After a domain has been deprecated it cannot
+      # be used to create new workflow executions or register new types.
+      # However, you can still use visibility actions on this domain.
       #
-      # Deprecating a domain also deprecates all activity and workflow 
-      # types registered in the domain. Executions that were started 
+      # Deprecating a domain also deprecates all activity and workflow
+      # types registered in the domain. Executions that were started
       # before the domain was deprecated will continue to run.
       #
-      # @return [nil] 
+      # @return [nil]
       #
       def deprecate
         client.deprecate_domain(:name => name)

data/lib/aws/simple_workflow/domain_collection.rb

@@ -17,34 +17,34 @@ module AWS
     # The primary interface for registering, listing and deprecating
     # domains.
     #
-    # == Creating a Domain
+    # ## Creating a Domain
     #
     # To create a domain you need to pass a unique name to #create.
     #
-    #   domain = simple_workflow.domains.create('my-domain', :none)
-    #   #=> #<AWS::SimpleWorkflow::Domain name:my-domain>
+    #     domain = simple_workflow.domains.create('my-domain', :none)
+    #     #=> #<AWS::SimpleWorkflow::Domain name:my-domain>
     #
-    # == Getting a Domain
+    # ## Getting a Domain
     #
     # Domains are indexed by their name.
     #
-    #   domain = simple_workflow.domains['my-domain']
+    #     domain = simple_workflow.domains['my-domain']
     #
-    # == Enumerating Domains
+    # ## Enumerating Domains
     #
     # You can call Enumerable methods on a domain collection to iterate
     # the domains controlled by your account.
     #
-    #   simple_workflow.domains.each {|domain| ... }
+    #     simple_workflow.domains.each {|domain| ... }
     #
     # By default only registered domains are enumerated.  If you would like
     # to enumerate deprecated (deleted) domains you need to pass the
-    # +:deprecated+ option.
+    # `:deprecated` option.
     #
-    #   # returns an array of names for all deprecated domains
-    #   simple_workflow.domains.deprecated.map(&:name)
+    #     # returns an array of names for all deprecated domains
+    #     simple_workflow.domains.deprecated.map(&:name)
     #
-    # See {AWS::Core::Collection} to see other useful methods you can 
+    # See {AWS::Core::Collection} to see other useful methods you can
     # call against a domain collection (e.g. #enum, #page, #each_batch).
     #
     class DomainCollection
@@ -53,8 +53,8 @@ module AWS
       include Core::Collection::WithLimitAndNextToken
 
       def initialize options = {}
-        
-        @registration_status = options[:registration_status] ? 
+
+        @registration_status = options[:registration_status] ?
           options[:registration_status].to_s.upcase : 'REGISTERED'
 
         @reverse_order = options.key?(:reverse_order) ?
@@ -66,23 +66,23 @@ module AWS
 
       # Registers a new domain.
       #
-      #   # register a domain named 'domain' that has no expiry on workflow
-      #   # execution history
-      #   domain = AWS::SimpleWorkflow.new.domains.register('domain', :none)
+      #     # register a domain named 'domain' that has no expiry on workflow
+      #     # execution history
+      #     domain = AWS::SimpleWorkflow.new.domains.register('domain', :none)
       #
-      # @param [String] name Name of the domain to register. The name must 
-      #   be unique.  
+      # @param [String] name Name of the domain to register. The name must
+      #   be unique.
       #
-      # @param [Integer,:none] retention_period A duration (in days) 
-      #   for which the record (including the history) of workflow 
-      #   executions in this domain should be kept by the service. 
-      #   After the retention period, the workflow execution will not be 
+      # @param [Integer,:none] retention_period A duration (in days)
+      #   for which the record (including the history) of workflow
+      #   executions in this domain should be kept by the service.
+      #   After the retention period, the workflow execution will not be
       #   available in the results of visibility calls.
       #
-      #   If you pass the symbol +:none+ then there is no expiration for
+      #   If you pass the symbol `:none` then there is no expiration for
       #   workflow execution history (effectively an infinite retention
       #   period).
-      # 
+      #
       # @param [Hash] options
       #
       # @option [String] :description (nil) Textual description of the domain.
@@ -146,7 +146,7 @@ module AWS
         options[:maximum_page_size] = limit if limit
         options[:next_page_token] = next_token if next_token
         options[:registration_status] ||= @registration_status
-        options[:reverse_order] = @reverse_order unless 
+        options[:reverse_order] = @reverse_order unless
           options.has_key?(:reverse_order)
 
         response = client.list_domains(options)
@@ -156,7 +156,7 @@ module AWS
             desc['name'], :config => config)
 
           yield(domain)
-          
+
         end
 
         response.data['nextPageToken']

data/lib/aws/simple_workflow/history_event.rb

@@ -16,25 +16,25 @@ require 'json'
 module AWS
   class SimpleWorkflow
 
-    # == Getting History Events
+    # ## Getting History Events
     #
-    # History events belong to workflow executions.  You can get them 
+    # History events belong to workflow executions.  You can get them
     # from an execution two ways:
     #
-    # 1) By enumerating events from the execution
+    # * By enumerating events from the execution
     #
-    #      workflow_execution.events.each do |event|
-    #        # ...
-    #      end
+    #       workflow_execution.events.each do |event|
+    #         # ...
+    #       end
     #
-    # 2) By enumerating events from the context of a {DecisionTask}:
+    # * By enumerating events from the context of a {DecisionTask}:
     #
-    #      workflow_execution.decision_tasks.poll do |decision_task|
-    #        decision_task.events.each do |event|
-    #        end
-    #      end
+    #       workflow_execution.decision_tasks.poll do |decision_task|
+    #         decision_task.events.each do |event|
+    #         end
+    #       end
     #
-    # == History Event Attributes
+    # ## History Event Attributes
     #
     # All history events respond to the following 4 methods:
     #
@@ -42,7 +42,7 @@ module AWS
     # * {#event_id}
     # * {#created_at}
     # * {#attributes}
-    # 
+    #
     # For a complete list of event types and a complete list of attributes
     # returned with each event type, see the service API documentation.
     #
@@ -50,12 +50,12 @@ module AWS
     # structure returned by {#attributes} allows you to access attributes
     # by their snake_case name or their camelCase name:
     #
-    #   event.attributes.workflow_type
-    #   event.attributes['workflowType']
+    #     event.attributes.workflow_type
+    #     event.attributes['workflowType']
     #
     # See {HistoryEvent::Attributes} for more information about working
     # with the returned attributes.
-    # 
+    #
     class HistoryEvent
 
       include Core::Model
@@ -63,7 +63,7 @@ module AWS
       # @param [WorkflowExecution] workflow_execution
       #
       # @param [Hash,String] details A hash or JSON string describing
-      #   the history event. 
+      #   the history event.
       #
       def initialize workflow_execution, details
 
@@ -129,28 +129,28 @@ module AWS
       # the service API documentation that lists all history event types
       # along with their returned attributes.
       #
-      # == Indifferent Access
+      # ## Indifferent Access
       #
-      # Here are a few examples showing the different ways to access an 
+      # Here are a few examples showing the different ways to access an
       # attribute:
       #
-      #   event = workflow_executions.events.first
+      #     event = workflow_executions.events.first
       #
-      #   # equivalent
-      #   event.attributes.task_list
-      #   event.attributes[:task_list]
-      #   event.attributes['task_list']
-      #   event.attributes['taskList']
+      #     # equivalent
+      #     event.attributes.task_list
+      #     event.attributes[:task_list]
+      #     event.attributes['task_list']
+      #     event.attributes['taskList']
       #
       # As shown in the example above keys and method names can be
       # snake_cased or camelCased (strings or symbols).
       #
-      # == Special Attributes
-      # 
+      # ## Special Attributes
+      #
       # The following list of attributes are treated specially.  Generally this
-      # means they return 
+      # means they return
       #
-      # * timeout attributes (e.g. taskStartToCloseTimeout) are returned as 
+      # * timeout attributes (e.g. taskStartToCloseTimeout) are returned as
       #   integers (number of seconds) or the special symbol :none, implying
       #   there is no timeout.
       #
@@ -165,7 +165,7 @@ module AWS
       # * taskList is returned as a string, not a hash.
       #
       class Attributes
-        
+
         # @private
         def initialize workflow_execution, data
           @workflow_execution = workflow_execution
@@ -184,7 +184,7 @@ module AWS
           end
         end
 
-        # @return [Array<Symbol>] Returns a list of valid keys for this 
+        # @return [Array<Symbol>] Returns a list of valid keys for this
         #   set of attributes.
         def keys
           @data.keys.collect{|key| _snake_case(key) }
@@ -204,7 +204,7 @@ module AWS
           self[method]
         end
 
-        # @return [Hash] Returns all of the attributes in a hash with 
+        # @return [Hash] Returns all of the attributes in a hash with
         #   snaked_cased and symbolized keys.
         def to_h
           @data.inject({}) do |h,(key,value)|