aws-sdk-v1 1.52.0

data/lib/aws/simple_workflow/activity_task_collection.rb

@@ -0,0 +1,123 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'timeout'
+
+module AWS
+  class SimpleWorkflow
+
+    class ActivityTaskCollection
+
+      include Core::Model
+      include OptionFormatters
+
+      # @api private
+      def initialize domain, options = {}
+        @domain = domain
+        super
+      end
+
+      # @return [Domain]
+      attr_reader :domain
+
+      # Returns the number of tasks in the specified `task_list`.
+      #
+      #     count = activity_tasks.count('task-list-name')
+      #     count.truncated? #=> false
+      #     count.to_i #=> 7
+      #
+      # @note This operation is eventually consistent. The results are best
+      #   effort and may not exactly reflect recent updates and changes.
+      #
+      # @param [String] task_list The name of the task list.
+      #
+      # @return [Count] Returns a possibly truncated count of
+      #   pending activity tasks for the given `task_list`.
+      #
+      def count task_list
+        options = {}
+        options[:domain] = domain.name
+        options[:task_list] = { :name => task_list }
+        response = client.count_pending_activity_tasks(options)
+        Count.new(response.data['count'], response.data['truncated'])
+      end
+
+      # @param [String] task_list The task list to check for pending
+      #   activity tasks in.
+      #
+      # @param [Hash] options
+      #
+      # @option options [String] :identity (nil) Identity of the worker
+      #   making the request, which is recorded in the ActivityTaskStarted
+      #   event in the workflow history. This enables diagnostic tracing
+      #   when problems arise. The :identity defaults to the hostname and
+      #   pid (e.g. "hostname:pid").
+      #
+      # @yieldparam [ActivityTask] activity_task Yields if a task is
+      #   available within 60 seconds.
+      #
+      # @return [ActivityTask,nil] Returns an activity task when one is
+      #    available, `nil` otherwise.  If you call this function with
+      #    a block, `nil` is always returned.
+      #
+      def poll_for_single_task task_list, options = {}, &block
+
+        client_opts = {}
+        client_opts[:domain] = domain.name
+        client_opts[:task_list] = { :name => task_list }
+        client_opts[:identity] = identity_opt(options)
+
+        response = client.poll_for_activity_task(client_opts)
+
+        if response.data['taskToken']
+          activity_task = ActivityTask.new(domain, response.data)
+          if block_given?
+            begin
+              yield(activity_task)
+              activity_task.complete! unless activity_task.responded?
+            rescue ActivityTask::CancelRequestedError
+              activity_task.cancel! unless activity_task.responded?
+            rescue StandardError => e
+              unless activity_task.responded?
+                reason = "UNTRAPPED ERROR: #{e.message}"
+                details = e.backtrace.join("\n")
+                activity_task.fail!(:reason => reason, :details => details)
+              end
+              raise e
+            end
+            nil
+          else
+            activity_task
+          end
+        else
+          nil
+        end
+
+      end
+
+      def poll task_list, options = {}, &block
+        loop do
+          begin
+            poll_for_single_task(task_list, options) do |activity_task|
+              yield(activity_task)
+            end
+          rescue Timeout::Error
+            retry
+          end
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/aws/simple_workflow/activity_type.rb

@@ -0,0 +1,131 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class SimpleWorkflow
+
+    # ## Registering an ActivityType
+    #
+    # To register an activity type you should use the #activity_types method
+    # on the domain:
+    #
+    #     domain.activity_types.register('name', 'version', { ... })
+    #
+    # See {ActivityTypeCollection#register} for a complete list of options.
+    #
+    # ## Deprecating an activity type
+    #
+    # ActivityType inherits from the generic {Type} base class.  Defined in
+    # {Type} are a few useful methods including:
+    #
+    # * {Type#deprecate}
+    # * {Type#deprecated?}
+    #
+    # You can use these to deprecate an activity type:
+    #
+    #     domain.activity_types['name','version'].deprecate
+    #
+    # @attr_reader [Time] creation_date When the workflow type was registered.
+    #
+    # @attr_reader [Time,nil] deprecation_date When the workflow type
+    #   was deprecated, or nil if the workflow type has not been deprecated.
+    #
+    # @attr_reader [String,nil] description The description of this workflow
+    #   type, or nil if was not set when it was registered.
+    #
+    # @attr_reader [Symbol] status The status of this workflow type.  The
+    #   status will either be `:registered` or `:deprecated`.
+    #
+    # @attr_reader [Integer,:none,nil] default_task_heartbeat_timeout
+    #   The default maximum time specified when registering the activity
+    #   type, before which a worker processing a task 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 return a result, it will be ignored.
+    #
+    #   The return value may be an integer (number of seconds), the
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
+    #
+    # @attr_reader [String,nil] default_task_list
+    #   The default task list specified for this activity type at
+    #   registration. This default task list is used if a task list is
+    #   not provided when a task is scheduled.
+    #
+    # @attr_reader [Integer,:none,nil] default_task_schedule_to_close_timeout
+    #   The default maximum duration specified when registering the
+    #   activity type, for tasks of this activity type. You can override
+    #   this default when scheduling a task.
+    #
+    #   The return value may be an integer (number of seconds), the
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
+    #
+    # @attr_reader [Integer,:none,nil] default_task_schedule_to_start_timeout
+    #   The optional default maximum duration specified when registering
+    #   the activity type, that a task of an activity type can wait
+    #   before being assigned to a worker.
+    #
+    #   The return value may be an integer (number of seconds), the
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
+    #
+    # @attr_reader [Integer,:none,nil] default_task_start_to_close_timeout
+    #   The default maximum duration for activity tasks of this type.
+    #
+    #   The return value may be an integer (number of seconds), the
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
+    #
+    class ActivityType < Type
+
+      type_attribute :creation_date, :timestamp => true
+
+      type_attribute :deprecation_date, :timestamp => true, :static => false
+
+      type_attribute :description
+
+      type_attribute :status, :to_sym => true, :static => false
+
+      config_attribute :default_task_heartbeat_timeout, :duration => true
+
+      config_attribute :default_task_list do
+        translates_output {|v| v['name'] }
+      end
+
+      config_attribute :default_task_schedule_to_close_timeout, :duration => true
+
+      config_attribute :default_task_schedule_to_start_timeout, :duration => true
+
+      config_attribute :default_task_start_to_close_timeout, :duration => true
+
+      # list activity type only provides type attributes
+      provider(:list_activity_types) do |provider|
+        provider.provides *type_attributes.keys
+        provider.find do |resp|
+          desc = resp.data['typeInfos'].find do |info|
+            info[self.class.type_key] == { 'name' => name, 'version' => version }
+          end
+        end
+      end
+
+      # describe activity type provides type and config attributes
+      provider(:describe_activity_type) do |provider|
+        provider.provides *type_attributes.keys
+        provider.provides *config_attributes.keys
+        provider.find do |resp|
+          type = { 'name' => name, 'version' => version }
+          resp.data['typeInfo'][self.class.type_key] == type ?
+            resp.data['typeInfo'].merge(resp.data['configuration']) : nil
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/simple_workflow/activity_type_collection.rb

@@ -0,0 +1,93 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class SimpleWorkflow
+    class ActivityTypeCollection < TypeCollection
+
+      # Registers a new activity type along with its configuration settings
+      # in the current domain.
+      #
+      # @param [String] name The name of the activity type.
+      #
+      # @param [String] version The version of the activity type.
+      #   The activity type consists of the name and version, the
+      #   combination of which must be unique within the domain.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Integer,:none] :default_task_heartbeat_timeout (nil)
+      #   The default 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).
+      #
+      # @option options [String] :default_task_list (nil) The default task
+      #   list to use for scheduling tasks of this activity type.
+      #   This default task list is used if a task list is not provided
+      #   when a task is scheduled.
+      #
+      # @option options [Integer,:none] :default_task_schedule_to_close_timeout (nil)
+      #   The value should be a number of seconds (integer) or the symbol
+      #   `:none` (implying no timeout).
+      #
+      # @option options [Integer,:none] :default_task_schedule_to_start_timeout (nil)
+      #   The default maximum duration that a task of this activity type
+      #   can wait before being assigned to a worker. 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).
+      #
+      # @option options [Integer,:none] :default_task_start_to_close_timeout (nil)
+      #   The default maximum duration that a worker can take to process
+      #   tasks of this activity type (in the ISO 8601 format). 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).
+      #
+      # @option options [String] :description (nil) A textual description
+      #   of the activity type.
+      #
+      def register name, version, options = {}
+
+        options[:domain] = domain.name
+        options[:name] = name
+        options[:version] = version
+
+        duration_opts(options,
+          :default_task_heartbeat_timeout,
+          :default_task_schedule_to_close_timeout,
+          :default_task_schedule_to_start_timeout,
+          :default_task_start_to_close_timeout)
+
+        if task_list = options[:default_task_list]
+          options[:default_task_list] = { :name => task_list.to_s }
+        end
+
+        client.register_activity_type(options)
+
+        self[name, version]
+
+      end
+      alias_method :create, :register
+
+    end
+  end
+end

data/lib/aws/simple_workflow/client.rb

@@ -0,0 +1,69 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class SimpleWorkflow
+
+    # Client class for Amazon Simple Workflow Service (SWF).
+    class Client < Core::JSONClient
+
+      API_VERSION = '2012-01-25'
+
+      signature_version :Version4, 'swf'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[
+        :count_pending_activity_tasks,
+        :count_pending_decision_tasks,
+        :count_closed_workflow_executions,
+        :count_open_workflow_executions,
+        :describe_activity_type,
+        :describe_domain,
+        :describe_workflow_execution,
+        :describe_workflow_type,
+        :get_workflow_execution_history,
+        #:poll_for_decision_task, # see below for expanded logic
+        :list_activity_types,
+        :list_domains,
+        :list_closed_workfow_executions,
+        :list_open_workfow_executions,
+        :list_workfow_types,
+      ]
+
+      protected
+
+      def cacheable_request? name, options
+        if name == :poll_for_decision_task
+          options.keys.include?(:next_page_token)
+        else
+          self.class::CACHEABLE_REQUESTS.include?(name)
+        end
+      end
+
+      def build_request *args
+        request = super(*args)
+        if request.headers['x-amz-target'] =~ /PollFor(Decision|Activity)Task/
+          request.read_timeout = 90
+        end
+        request
+      end
+
+    end
+
+    class Client::V20120125 < Client
+
+      define_client_methods('2012-01-25')
+
+    end
+  end
+end

data/lib/aws/simple_workflow/config.rb

@@ -0,0 +1,18 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'SimpleWorkflow', 'simple_workflow', 'swf'
+
+end

data/lib/aws/simple_workflow/count.rb

@@ -0,0 +1,49 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+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
+    # are definitive.
+    class Count
+
+      # @api private
+      def initialize count, truncated
+        @count = count
+        @truncated = truncated
+      end
+
+      # @return [Integer]
+      attr_reader :count
+
+      alias_method :to_i, :count
+
+      # @return [Boolean]
+      def truncated?
+        @truncated
+      end
+
+      def == other
+        other.is_a?(Count) and
+        other.count == self.count and
+        other.truncated? == self.truncated?
+      end
+
+      alias_method :eql?, :==
+
+    end
+  end
+end