aws-sdk 1.3.4 → 1.3.5

data/lib/aws/simple_workflow/workflow_type.rb

@@ -0,0 +1,177 @@
+# Copyright 2011-2012 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 'uuidtools'
+
+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 workflwo 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.
+      #
+      #   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-2012 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/policy.rb

@@ -14,7 +14,7 @@
 module AWS
   class SNS
 
-    # @see Core::Policy
+    # (see Core::Policy)
     class Policy < Core::Policy
 
       class Statement < Core::Policy::Statement

data/lib/aws/sns/subscription.rb

@@ -119,10 +119,10 @@ module AWS
 
       # @return [Boolean] Returns true if the subscriptions have the same
       #   resource ARN.
-      def ==(other)
+      def eql? other
         other.kind_of?(Subscription) and other.arn == arn
       end
-      alias_method :eql?, :==
+      alias_method :==, :eql?
 
       protected
       def update_delivery_policy policy_json

data/lib/aws/sqs/errors.rb

@@ -84,8 +84,8 @@ module AWS
           super("Failed to send #{failures.size} messages")
         end
 
-        # @return [Array<SentMessage>] Returns a list of {SentMessage}
-        #   objects.
+        # @return [Array<Queue::SentMessage>] Returns a list of 
+        #   {Queue::SentMessage} objects.
         attr_reader :sent
 
         # @return [Array<Hash>] Returns a list of hashes.  Each hash

data/lib/aws/sqs/policy.rb

@@ -14,7 +14,7 @@
 module AWS
   class SQS
 
-    # @see Core::Policy
+    # (see Core::Policy)
     class Policy < Core::Policy
 
       class Statement < Core::Policy::Statement

metadata

@@ -1,66 +1,92 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: aws-sdk
-version: !ruby/object:Gem::Version
-  version: 1.3.4
+version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: 
+  segments: 
+  - 1
+  - 3
+  - 5
+  version: 1.3.5
 platform: ruby
-authors:
+authors: 
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: uuidtools
-  requirement: &2178333900 !ruby/object:Gem::Requirement
+
+date: 2012-02-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  name: uuidtools
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2178333900
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &2178333160 !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  name: httparty
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2178333160
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &2178332320 !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
         version: 1.4.4
-  type: :runtime
+  name: nokogiri
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2178332320
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: &2178331680 !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2178331680
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  name: json
+  version_requirements: *id004
 description: AWS SDK for Ruby
 email: 
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - ca-bundle.crt
 - rails/init.rb
 - lib/aws/core/api_config.rb
@@ -311,6 +337,30 @@ files:
 - lib/aws/simple_email_service/quotas.rb
 - lib/aws/simple_email_service/request.rb
 - lib/aws/simple_email_service.rb
+- lib/aws/simple_workflow/activity_task.rb
+- lib/aws/simple_workflow/activity_task_collection.rb
+- lib/aws/simple_workflow/activity_type.rb
+- lib/aws/simple_workflow/activity_type_collection.rb
+- lib/aws/simple_workflow/client.rb
+- lib/aws/simple_workflow/config.rb
+- lib/aws/simple_workflow/count.rb
+- lib/aws/simple_workflow/decision_task.rb
+- lib/aws/simple_workflow/decision_task_collection.rb
+- lib/aws/simple_workflow/domain.rb
+- lib/aws/simple_workflow/domain_collection.rb
+- lib/aws/simple_workflow/errors.rb
+- lib/aws/simple_workflow/history_event.rb
+- lib/aws/simple_workflow/history_event_collection.rb
+- lib/aws/simple_workflow/option_formatters.rb
+- lib/aws/simple_workflow/request.rb
+- lib/aws/simple_workflow/resource.rb
+- lib/aws/simple_workflow/type.rb
+- lib/aws/simple_workflow/type_collection.rb
+- lib/aws/simple_workflow/workflow_execution.rb
+- lib/aws/simple_workflow/workflow_execution_collection.rb
+- lib/aws/simple_workflow/workflow_type.rb
+- lib/aws/simple_workflow/workflow_type_collection.rb
+- lib/aws/simple_workflow.rb
 - lib/aws/sns/client/xml.rb
 - lib/aws/sns/client.rb
 - lib/aws/sns/config.rb
@@ -355,6 +405,7 @@ files:
 - lib/aws/api_config/IAM-2010-05-08.yml
 - lib/aws/api_config/SimpleDB-2009-04-15.yml
 - lib/aws/api_config/SimpleEmailService-2010-12-01.yml
+- lib/aws/api_config/SimpleWorkflow-2012-01-25.yml
 - lib/aws/api_config/SNS-2010-03-31.yml
 - lib/aws/api_config/SQS-2011-10-01.yml
 - lib/aws/api_config/STS-2011-06-15.yml
@@ -364,31 +415,37 @@ files:
 - NOTICE.txt
 - LICENSE.txt
 homepage: http://aws.amazon.com/sdkforruby
-licenses:
+licenses: 
 - Apache 2.0
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 2879492431833111040
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: AWS SDK for Ruby
 test_files: []
+