aws-flow 1.0.8 → 1.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74aff8c011e1dda48d38cf639ec0f6fcc1e2ee5a
+  data.tar.gz: 1b23c646c3afe8a5827d21feb8cc1701fad571b8
+SHA512:
+  metadata.gz: bee020ffb919c382d69db2ef2860e5f134fc49ec7fa90bee420256a6adba01e6daf86e5aad6d8bc30110c2805205298f9f53623ec0e0a91077f511843a64406e
+  data.tar.gz: d1edebf2776156f6a881f156c92ed93f21c80d534d464b383c4c56c13a45eabbb7805199cd8abbd968578e02c9611b0f313469c4433186c7c114c22fc2981d86

data/Gemfile

@@ -3,7 +3,7 @@ source "http://www.rubygems.org"
 gemspec
 
 group :test do
-  gem "rspec", "1.3.0"
+  gem "rspec", "2.14"
   gem "rake"
   gem "factory_girl"
 end

data/Rakefile

@@ -13,38 +13,25 @@
 # permissions and limitations under the License.
 ##
 
-require 'spec/rake/spectask'
+require "rspec/core/rake_task"
 
-desc "Run unit tests in test/"
-Spec::Rake::SpecTask.new(:unit_tests) do |t|
-  t.libs << 'lib'
-  t.spec_opts = ['--color', '--format nested']
-  t.spec_files = FileList['test/**/*.rb']
-  t.spec_files.delete_if  do |x|
-    (x =~ /.*factories.rb/) ||
-    (x =~ /.*spec_helper.rb/) ||
-      (x =~ /.*preinclude_tests.rb/) ||
-      (x =~ /.*integration.*/)
-  end
-  t.spec_files.unshift("test/aws/factories.rb")
-  t.spec_files.unshift("test/aws/spec_helper.rb")
-  t.spec_files.unshift("test/aws/preinclude_tests.rb")
+desc "Run unit tests"
+RSpec::Core::RakeTask.new(:unit_tests) do |spec|
+  spec.rspec_opts = ['--color', '--format nested']
+  spec.pattern = 'spec/**/unit/*.rb'
 end
-task :test => :unit_tests
 
-desc "Run integration tests in test/"
-Spec::Rake::SpecTask.new do |t|
-  t.libs << 'lib'
-  #t.ruby_opts = ['-rspec/test/unit'] # Add this line in if you're using Test::Unit instead of RSpec
-  t.spec_opts = ['--color', '--format nested']
-  t.spec_files = FileList['test/**/*.rb']
-  t.spec_files.delete_if  do |x|
-    (x =~ /.*factories.rb/) ||
-    (x =~ /.*spec_helper.rb/) ||
-      (x =~ /.*preinclude_tests.rb/)
-  end
-  t.spec_files.unshift("test/aws/factories.rb")
-  t.spec_files.unshift("test/aws/spec_helper.rb")
-  t.spec_files.unshift("test/aws/preinclude_tests.rb")
+desc "Run integration tests"
+RSpec::Core::RakeTask.new(:integration_tests) do |spec|
+  spec.rspec_opts = ['--color', '--format nested']
+  spec.pattern = 'spec/**/integration/*.rb'
 end
-task :integration_tests => :spec
+
+desc "Run all tests"
+RSpec::Core::RakeTask.new(:all_tests) do |spec|
+  spec.rspec_opts = ['--color', '--format nested']
+  spec.pattern = 'spec/**/*.rb'
+end
+
+task :test => :all_tests
+

data/aws-flow.gemspec

@@ -10,6 +10,6 @@ Gem::Specification.new do |s|
   s.email       = ''
   s.files       = `git ls-files`.split("\n").reject {|file| file =~ /aws-flow-core/}
   s.require_paths << "lib/aws/"
-  s.add_dependency "aws-sdk", "~> 1"
+  s.add_dependency "aws-sdk", "~> 1", ">= 1.36.2"
   s.add_dependency "aws-flow-core", ">= 1.0.1"
 end

data/lib/aws/decider.rb

@@ -13,7 +13,6 @@
 # permissions and limitations under the License.
 #++
 
-
 require 'aws/flow'
 include AWS::Flow::Core
 
@@ -48,7 +47,7 @@ require "aws/decider/flow_defaults"
 require "aws/decider/implementation"
 require "aws/decider/version"
 
-# @!visibility private
+# @api private
 def get_const(name)
   name = name.split('::').reverse
   current = Object

data/lib/aws/decider/activity.rb

@@ -17,37 +17,48 @@ module AWS
   module Flow
 
     # Represents information about an open request.
-    # @!visibility private
+    # @api private
     class OpenRequestInfo
       attr_accessor :completion_handle, :result, :blocking_promise, :description, :run_id
     end
 
+    # Contains metadata about an activity.
+    # @api private
     class ActivityMetadata
+      # The stored ID of the activity.
       attr_reader :activity_id
+
+      # Initializes a new ActivityMetadata object.
+      #
+      # @param activity_id
+      #   The ID of the activity.
+      #
       def initialize(activity_id); @activity_id = activity_id; end
     end
 
-
     # A generic activity client that can be used to perform standard activity actions.
     class GenericActivityClient < GenericClient
-      # The data converter used for serializing/deserializing data when sending requests to and receiving results from
-      # workflow executions of this workflow type. By default, this is {YAMLDataConverter}.
+
+      # The data converter used for serializing/deserializing data when sending
+      # requests to and receiving results from workflow executions of this
+      # workflow type. By default, this is {YAMLDataConverter}.
       attr_accessor :data_converter
 
       # The decision helper used by the activity client.
       attr_accessor :decision_helper
 
-      # A hash of ActivityRuntimeOptions for the activity client
+      # A hash of {ActivityRuntimeOptions} for the activity client.
       attr_accessor :options
 
-       # Returns the default option class for the activity client, which is {ActivityRuntimeOptions}.
+      # Returns the default option class for the activity client, which is {ActivityRuntimeOptions}.
       def self.default_option_class; ActivityRuntimeOptions; end
 
-      # Separates the activity name from the activity type at the point of the last (.) symbol.
+      # Separates the activity name from the activity type at the point of the last period.
       #
       # @param [String] name
       #   The name of the activity type.
       #
+      # @api private
       def activity_name_from_activity_type(name)
         return name.to_s.split(".").last.to_sym
       end
@@ -57,7 +68,8 @@ module AWS
       # @param [DecisionHelper] decision_helper
       #   The decision helper to use for the activity client.
       #
-      # @param [ActivityOptions] options ActivityOptions to set for the activity client.
+      # @param [ActivityOptions] options
+      #   The activity options to set for the activity client.
       #
       def initialize(decision_helper, options)
         @decision_helper = decision_helper
@@ -68,16 +80,17 @@ module AWS
         super
       end
 
-      # Runs an activity given a name and block of options.
+      # Registers and schedules a new activity type, provided a name and block of options.
       #
       # @param method_name
-      #   The name of the activity type to define
+      #   *Required*. The name of the activity type to define.
       #
       # @param args
-      #   Arguments for the method
+      #   *Required*. Arguments for the method provided in *method_name*.
       #
       # @param block
-      #   A block of {ActivityOptions}
+      #   *Required*. A block of {ActivityOptions} to use when registering the new {ActivityType}. This can be set to an
+      #   empty block, in which case, the default activity options will be used.
       #
       def method_missing(method_name, *args, &block)
         options = Utilities::interpret_block_for_options(ActivityOptions, block)
@@ -101,20 +114,20 @@ module AWS
         result
       end
 
-      # @!visibility private
+      # @api private
       def retry_alias_to_method(retry_alias)
         retry_alias.to_s[/__(.*)_retry/, 1].to_sym
       end
 
-      # @!visibility private
+      # @api private
       def method_to_retry_alias(method_name)
         "#{__method_name.to_s + "_retry"}".to_sym
       end
 
       # Requests that the activity is canceled.
       #
-      # @param [Future] to_cancel
-      #   The Future for the task to be canceled.
+      # @param [WorkflowFuture] to_cancel
+      #   The {WorkflowFuture} for the task to be canceled.
       #
       def request_cancel_activity_task(to_cancel)
         metadata = to_cancel.metadata
@@ -124,9 +137,9 @@ module AWS
         @decision_helper[metadata.activity_id].consume(:cancel)
       end
 
-      # A handler for the ActivityClassCanceled event.
+      # A handler for the `ActivityClassCanceled` event.
       #
-      # @param [ActivityClassCanceled] event
+      # @param [AWS::SimpleWorkflow::HistoryEvent] event
       #   The event data.
       #
       def handle_activity_task_canceled(event)
@@ -141,9 +154,9 @@ module AWS
         end
       end
 
-      # A handler for the ActivityClassTimedOut event.
+      # A handler for the `ActivityClassTimedOut` event.
       #
-      # @param [ActivityClassTimedOut] event
+      # @param [AWS::SimpleWorkflow::HistoryEvent] event
       #   The event data.
       #
       def handle_activity_task_timed_out(event)
@@ -160,7 +173,7 @@ module AWS
         end
       end
 
-      # A handler for the {ActivityTaskFailed} event.
+      # A handler for the `ActivityTaskFailed` event.
       #
       # @param [ActivityClassFailed] event
       #   The event data.
@@ -181,9 +194,9 @@ module AWS
         open_request_info.completion_handle.fail(failure)
       end
 
-      # A handler for the {ScheduleActivityTaskFailed} event.
+      # A handler for the `ScheduleActivityTaskFailed` event.
       #
-      # @param [ScheduleActivityTaskFailed] event
+      # @param [AWS::SimpleWorkflow::HistoryEvent] event
       #   The event data.
       #
       def handle_schedule_activity_task_failed(event)
@@ -199,9 +212,9 @@ module AWS
         end
       end
 
-      # A handler for the {ActivityClassCompleted} event.
+      # A handler for the `ActivityClassCompleted` event.
       #
-      # @param [ActivityClassCompleted] event
+      # @param [AWS::SimpleWorkflow::HistoryEvent] event
       #   The event data.
       #
       def handle_activity_task_completed(event)
@@ -215,19 +228,19 @@ module AWS
         end
       end
 
-      # Schedules the named activity.
+      # Schedules a named activity.
       #
       # @param [String] name
-      #   The name of the activity to schedule.
+      #   *Required*. The name of the activity to schedule.
       #
-      # @param [String]
-      #   activity_type The activity type for this scheduled activity.
+      # @param [String] activity_type
+      #   *Required*. The activity type for this scheduled activity.
       #
-      # @param [Object]
-      #   input Optional data passed to the activity.
+      # @param [Object] input
+      #   *Required*. Additional data passed to the activity.
       #
-      # @param [ActivityOptions]
-      #   options ActivityOptions to set for the scheduled activity.
+      # @param [ActivityOptions] options
+      #   *Required*. {ActivityOptions} to set for the scheduled activity.
       #
       def schedule_activity(name, activity_type, input, options)
         options = Utilities::merge_all_options(@option_map[activity_name_from_activity_type(name)], options)
@@ -272,7 +285,7 @@ module AWS
             # we should serialize the error, and stuff that into details, so
             # that things above us can pull it out correctly. We don't have to
             # do this for ActivityTaskFailedException, as the details is
-            # *already* serialized
+            # *already* serialized.
             if error.is_a? ActivityTaskFailedException
               details = @data_converter.load(error.details)
               error.cause = details
@@ -299,21 +312,28 @@ module AWS
 
     # Represents an activity client.
     class ActivityClient
-      # Gets the data converter for the Activity Client.
+
+      # Gets the data converter for the activity client.
       def data_converter
         @generic_client.data_converter
       end
 
-      # Sets the data converter for the Activity Client.
+      # Sets the data converter for the activity client.
+      #
+      # @param other
+      #   The data converter to set.
+      #
       def data_converter=(other)
         @generic_client.data_converter = other
       end
 
       # Exponentially retries the supplied method with optional settings.
       #
-      # @param [String] method_name The method name to retry.
+      # @param [String] method_name
+      #   The method name to retry.
       #
-      # @param [ExponentialRetryOptions] block A hash of ExponentialRetryOptions to use.
+      # @param [ExponentialRetryOptions] block
+      #   A hash of {ExponentialRetryOptions} to use.
       #
       def exponential_retry(method_name, &block)
         @generic_client.retry(method_name, lambda {|first, time_of_failure, attempts| 1}, block)
@@ -323,10 +343,11 @@ module AWS
     # Methods and constants related to activities.
     #
     # @!attribute activity_client
-    #   Gets the [ActivityClient] for this Activity.
+    #   Gets the {ActivityClient} contained by the class.
     #
     # @!attribute activities
-    #   Gets an list of activities for this Activity.
+    #   Gets the list of {ActivityType} objects that were created by the
+    #   {#activity} method.
     #
     module Activities
       @precursors ||= []
@@ -335,21 +356,34 @@ module AWS
         base.send :include, InstanceMethods
       end
       module InstanceMethods
+        # Sets the {ActivityExecutionContext} instance for the activity task.
         attr_writer :_activity_execution_context
+
+        # Gets the activity execution context for the activity task. Raises an `IllegalStateException` if the activity
+        # has no context.
+        #
+        # @return [ActivityExecutionContext] The execution context for this activity.
+        #
         def activity_execution_context
           raise IllegalStateException.new("No activity execution context") unless @_activity_execution_context
           @_activity_execution_context
         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.
+        #
         def record_activity_heartbeat(details)
           @_activity_execution_context.record_activity_heartbeat(details)
         end
       end
 
-
-      # @!visibility private
+      # @api private
       extend Utilities::UpwardLookups
 
-      # @!visibility private
+      # @api private
       def look_upwards(variable)
         precursors = self.ancestors.dup
         precursors.delete(self)
@@ -357,21 +391,33 @@ module AWS
       end
       property(:activities, [])
 
-      # @!visibility private
+      # @api private
       def _options; @activities.map(&:options); end
 
-      # Defines one or more activities, with {ActivityOptions} provided in the supplied block.
+      # Defines one or more activities with {ActivityOptions} provided in the
+      # supplied block.
       #
       # @param [Array] activity_names
-      #   The names of the activities to define.
+      #   The names of the activities to define. These names will be used to
+      #   create {ActivityType} objects, one per name.
+      #
+      #   Each activity type is named as *prefix.activity_name*, where the
+      #   *prefix* is specified in the options block, and each *activity_name*
+      #   comes from the list passed to this parameter.
       #
       # @param [Hash] block
       #   {ActivityOptions} to use on the defined activities.
       #
+      #   The following options are *required* when registering an activity:
+      #
+      #   * `version` - The version of the activity type.
+      #   * `task_list` - The task list used to poll for activity tasks.
+      #
       # @example Defining an activity
       #   new_activity_class = Class.new(MyActivity) do
       #     extend Activities
-      #     activity :run_activity1 do
+      #
+      #     activity :activity1 do
       #     {
       #       :default_task_heartbeat_timeout => "3600",
       #       :default_task_list => task_list,
@@ -379,10 +425,12 @@ module AWS
       #       :default_task_schedule_to_start_timeout => "20",
       #       :default_task_start_to_close_timeout => "20",
       #       :version => "1",
-      #       :prefix_name => "#{class_name}Activity"
+      #       :prefix_name => "ExampleActivity"
       #     }
       #     end
-      #     def run_activity1
+      #
+      #     def activity1
+      #       puts "Hello!"
       #     end
       #   end
       def activity(*activity_names, &block)
@@ -396,9 +444,8 @@ module AWS
       end
     end
 
-    #  This module is for internal use only and may be changed or removed
-    #  without prior notice. Use {Activities} instead.
-    # @!visibility private
+    # @deprecated Use {Activities} instead.
+    # @api private
     module Activity
       include Activities
       def self.extended(base)
@@ -406,6 +453,5 @@ module AWS
       end
     end
 
-
   end
 end