aws-sdk-v1 1.52.0

data/lib/aws/simple_workflow/workflow_type.rb

@@ -0,0 +1,177 @@
+# 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 a WorkflowType
+    #
+    # To register a workflow type you should use the #workflow_types method
+    # on the domain:
+    #
+    #     domain.workflow_types.register('name', 'version', { ... })
+    #
+    # See {WorkflowTypeCollection#register} for a complete list of options.
+    #
+    # ## Deprecating a workflow type
+    #
+    # WorkflowType 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 a workflow type:
+    #
+    #     domain.workflow_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 [Symbol,nil] default_child_policy Specifies the default
+    #   policy to use for the child workflow executions when a workflow
+    #   execution of this type is terminated.  Values may be one of the
+    #   following (or nil):
+    #
+    #   * `: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
+    #     continue to run.
+    #
+    # @attr_reader [Integer,:none,nil] default_execution_start_to_close_timeout
+    #   The default maximum duration for executions of this workflow type.
+    #
+    #   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 Specifies
+    #   the default task list to use for scheduling decision tasks for
+    #   executions of this workflow type.
+    #
+    # @attr_reader [Integer,:none,nil] default_task_start_to_close_timeout
+    #   The default maximum duration of decision tasks for this workflow type.
+    #
+    #   The return value may be an integer (number of seconds), the
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
+    #
+    class WorkflowType < Type
+
+      include OptionFormatters
+
+      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_child_policy, :to_sym => true
+
+      config_attribute :default_execution_start_to_close_timeout,
+        :duration => true
+
+      config_attribute :default_task_list do
+        translates_output {|v| v['name'] }
+      end
+
+      config_attribute :default_task_start_to_close_timeout,
+        :duration => true
+
+      # @param [Hash] options
+      #
+      # @option (see DecisionTask#continue_as_new_workflow_execution)
+      #
+      # @option options [String] :workflow_id
+      #   A user defined identifier associated with the workflow execution.
+      #   You can use this to associate a custom identifier with the
+      #   workflow execution. You may specify the same identifier if a
+      #   workflow execution is logically a restart of a previous execution.
+      #   You cannot have two open workflow executions with the same
+      #   :workflow_id at the same time.
+      #
+      #   If you do not provide `:workflow_id` a random UUID will be generated.
+      #
+      # @return [WorkflowExecution] Returns the new workflow execution.
+      #
+      def start_execution options = {}
+
+        options[:domain] = domain.name
+        start_execution_opts(options, self)
+        response = client.start_workflow_execution(options)
+
+        workflow_id = options[:workflow_id]
+        run_id = response.data['runId']
+
+        domain.workflow_executions[workflow_id, run_id]
+
+      end
+
+      # Returns a count of workflow executions of this workflow type.
+      #
+      # @example
+      #
+      #   domain.workflow_types['name','version'].count
+      #
+      # @note (see WorkflowExecution#count_executions)
+      # @param (see WorkflowExecution#count_executions)
+      # @option (see WorkflowExecution#count_executions)
+      # @return [Integer] Returns the count of workflow execution of this type.
+      def count_executions options = {}
+        options[:workflow_type] = self
+        domain.workflow_executions.count(options)
+      end
+
+      # @return [WorkflowExecutionCollection] Returns a collection that
+      #   enumerates only workflow executions of this type.
+      def workflow_executions
+        WorkflowExecutionCollection.new(domain).with_workflow_type(self)
+      end
+
+      # list workflow type only provides type attributes
+      provider(:list_workflow_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 workflow type provides type and config attributes
+      provider(:describe_workflow_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/workflow_type_collection.rb

@@ -0,0 +1,91 @@
+# 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 WorkflowTypeCollection < TypeCollection
+
+      # Registers a new workflow type and its configuration settings for
+      # in the current domain.
+      #
+      # @param [String] name The name of the workflow type.
+      #
+      # @param [String] version The version of the workflow type.
+      #   The workflow type consists of the name and version, the
+      #   combination of which must be unique within the domain.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Symbol] :default_child_policy (nil) Specifies the default
+      #   policy to use for the child workflow executions when a workflow
+      #   execution of this type is terminated.  This default can be
+      #   overridden when starting a workflow execution. The supported child
+      #   policies are:
+      #
+      #   * `: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
+      #     continue to run.
+      #
+      # @option options [Integer,:none] :default_execution_start_to_close_timeout (nil)
+      #   The default maximum duration for executions of this workflow type.
+      #   You can override this default when starting an execution.
+      #   The value should be a number of seconds (integer) or the symbol
+      #   `:none` (implying no timeout).
+      #
+      # @option options [String] :default_task_list (nil) Specifies
+      #   the default task list to use for scheduling decision tasks for
+      #   executions of this workflow type. This default is used only if
+      #   a task list is not provided when starting the workflow execution.
+      #
+      # @option options [Integer,:none] :default_task_start_to_close_timeout (nil)
+      #   The default maximum duration of decision tasks for this workflow type.
+      #
+      #   The value should be a number of seconds (integer) or the symbol
+      #   `:none` (implying no timeout).
+      #
+      # @option options [String] :description (nil) Textual description of
+      #   the workflow type.
+      #
+      def register name, version, options = {}
+
+        options[:domain] = domain.name
+        options[:name] = name
+        options[:version] = version
+
+        upcase_opts(options, :default_child_policy)
+
+        duration_opts(options,
+          :default_execution_start_to_close_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_workflow_type(options)
+
+        self[name, version]
+
+      end
+      alias_method :create, :register
+
+    end
+  end
+end

data/lib/aws/sns.rb

@@ -0,0 +1,76 @@
+# 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 'aws/core'
+require 'aws/sns/config'
+require 'aws/sns/message'
+
+module AWS
+
+  # This class is the starting point for working with Amazon Simple
+  # Notification Service (SNS).
+  #
+  # To use Amazon SNS you must first [sign up here](http://aws.amazon.com/sns/).
+  #
+  # For more information about Amazon SNS:
+  #
+  # * [Amazon SNS](http://aws.amazon.com/sns/)
+  # * [Amazon SNS Documentation](http://aws.amazon.com/documentation/sns/)
+  #
+  # # Credentials
+  #
+  # You can setup default credentials for all AWS services via
+  # AWS.config:
+  #
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # Or you can set them directly on the SNS interface:
+  #
+  #     sns = AWS::SNS.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level SNS client object
+  class SNS
+
+    autoload :Client, 'aws/sns/client'
+    autoload :Errors, 'aws/sns/errors'
+    autoload :Policy, 'aws/sns/policy'
+    autoload :HasDeliveryPolicy, 'aws/sns/has_delivery_policy'
+    autoload :Subscription, 'aws/sns/subscription'
+    autoload :SubscriptionCollection, 'aws/sns/subscription_collection'
+    autoload :Topic, 'aws/sns/topic'
+    autoload :TopicCollection, 'aws/sns/topic_collection'
+    autoload :TopicSubscriptionCollection, 'aws/sns/topic_subscription_collection'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'sns'
+
+    # @return [TopicCollection] Returns a topic collection for managing
+    #   SNS topics.
+    def topics
+      TopicCollection.new(:config => config)
+    end
+
+    # @return [SubscriptionCollection] Returns a subscription
+    #   collection for managing SNS subscriptions.
+    def subscriptions
+      SubscriptionCollection.new(:config => config)
+    end
+
+  end
+end

data/lib/aws/sns/client.rb

@@ -0,0 +1,35 @@
+# 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 SNS
+
+    # Client class for Amazon Simple Notifications Service (SNS).
+    class Client < Core::QueryClient
+
+      API_VERSION = '2010-03-31'
+
+      signature_version :Version4, 'sns'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+    end
+
+    class Client::V20100331 < Client
+
+      define_client_methods('2010-03-31')
+
+    end
+  end
+end

data/lib/aws/sns/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 'SNS', 'sns', 'sns'
+
+end

data/lib/aws/sns/errors.rb

@@ -0,0 +1,22 @@
+# 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 SNS
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/sns/has_delivery_policy.rb

@@ -0,0 +1,68 @@
+# 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 SNS
+
+    # A module shared between {Topic} and {Subscription}.  Provides methods
+    # for getting and setting the delivery policy and for getting the
+    # effective delivery policy.
+    module HasDeliveryPolicy
+
+      # @return [nil,Hash] Returns the delivery policy.
+      def delivery_policy
+        parse_delivery_policy(delivery_policy_json)
+      end
+
+      # @return [Hash] Returns the effective delivery policy.
+      def effective_delivery_policy
+        parse_delivery_policy(effective_delivery_policy_json)
+      end
+
+      # @param [nil,Hash,String<JSON>] policy A delivery policy.  You can
+      #   pass a JSON string, A policy hash or nil.
+      def delivery_policy= policy
+
+        policy_json = case policy
+        when nil then ''
+        when String then policy
+        else policy.to_json
+        end
+
+        update_delivery_policy(policy_json)
+
+      end
+
+      # @return [nil,String] Returns the delivery policy JSON string.
+      def delivery_policy_json
+        raise NotImplementedError
+      end
+
+      # @return [String] Returns the effective delivery policy JSON string.
+      def effective_delivery_policy_json
+        raise NotImplementedError
+      end
+
+      protected
+      def parse_delivery_policy policy_json
+        policy_json.nil? ? nil : JSON.parse(policy_json)
+      end
+
+      protected
+      def update_delivery_policy policy_json
+        raise NotImplementedError
+      end
+
+    end
+  end
+end