aws-sdk-resources 2.0.34 → 2.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e919f0b752d0c452b8a330bfe8e20d0e05ea32e6
-  data.tar.gz: cac98b1667805d16c0d07ec074a17dee0692515b
+  metadata.gz: 25964c9557fb27724f67bfddf9709199f2fd111c
+  data.tar.gz: e4fdff1ab152b2625c2525c81aa05c7dc2343d12
 SHA512:
-  metadata.gz: bd0ac1a60590c3563ca0cfb33df6b7d8dd7c35401130b82ee9a9b66f78592f67352c3090b4c55fcd021a5bfae9f4f8cdb2db2dcf2a2a721e997aa0cb18cdfc69
-  data.tar.gz: bfce885ffbc5105dfb9e4b8cb16fa504139858ff82f045228d97df8909e6d054ba2530a28bf73e90c2756a17b84c8fa7fd318629749f95812a930fe69973b40d
+  metadata.gz: 0a74c603f35b9181b20e4041bcfc00acf534998781e69df7ca859d232c7e3aec25894d21ddff02a00df6976bcdc4dbca4906ce87187a41e9fb7c07b4aba5849a
+  data.tar.gz: 4ca2daea3869b9d685137d5136d0ffc05f43c5b09e9552dd335225ebff7d8382aa0b3da5fa4aa402930dbf61b14a53dbce28e2f426924f95b91f28069eb23992

data/lib/aws-sdk-resources/documenter/base_operation_documenter.rb

@@ -94,7 +94,7 @@ module Aws
             m.source_type = :json
             m.source = source.format
             filename = source.file
-            filename = filename.match('(aws-sdk-core/apis/.+\.resources\.json)')[1]
+            filename = filename.match('(aws-sdk-core/apis/.+)')[1]
             m.add_file(filename, nil, true)
           end
           tags.each do |tag|

data/lib/aws-sdk-resources/resource.rb

@@ -23,6 +23,98 @@ module Aws
       # @return [Hash<Symbol,String>]
       attr_reader :identifiers
 
+      # Waiter polls an API operation until a resource enters a desired
+      # state.
+      #
+      # @note The waiting operation is performed on a copy. The original resource remains unchanged
+      #
+      # ## Basic Usage
+      #
+      # Waiter will polls until it is succesful, it fails by
+      # entering a terminal state, or until a maximum number of attempts
+      # are made.
+      #
+      #     # polls in a loop until condition is true
+      #     resource.wait_until(options) {|resource| condition}
+      #
+      # ## Example
+      #
+      #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+      #
+      # ## Configuration
+      #
+      # You can configure the maximum number of polling attempts, and the
+      # delay (in seconds) between each polling attempt. The waiting condition is set
+      # by passing a block to {#wait_until}:
+      #
+      #     # poll for ~25 seconds
+      #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+      #
+      # ## Callbacks
+      #
+      # You can be notified before each polling attempt and before each
+      # delay. If you throw `:success` or `:failure` from these callbacks,
+      # it will terminate the waiter.
+      #
+      #     started_at = Time.now
+      #     # poll for 1 hour, instead of a number of attempts
+      #     proc = Proc.new do |attempts, response|
+      #       throw :failure if Time.now - started_at > 3600
+      #     end
+      #
+      #       # disable max attempts
+      #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+      #
+      # ## Handling Errors
+      #
+      # When a waiter is successful, it returns the Resource. When a waiter
+      # fails, it raises an error.
+      #
+      #     begin
+      #       resource.wait_until(...)
+      #     rescue Aws::Waiters::Errors::WaiterFailed
+      #       # resource did not enter the desired state in time
+      #     end
+      #
+      #
+      # @yieldparam [Resource] resource to be used in the waiting condition
+      #
+      # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+      #   because the waiter has entered a state that it will not transition
+      #   out of, preventing success.
+      #
+      # @raise [Aws::Waiters::Errors::TooManyAttemptsError] Raised when the configured
+      #   maximum number of attempts have been made, and the waiter is not
+      #   yet successful.
+      #
+      # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encounted
+      #   while polling for a resource that is not expected.
+      #
+      # @raise [NotImplementedError] Raised when the resource does not
+      #   support #reload operation
+      #
+      # @option options [Integer] :max_attempts (10) Maximum number of attempts
+      # @option options [Integer] :delay (10) Delay between each attempt in seconds
+      # @option options [Proc] :before_attempt (nil) Callback invoked before each attempt
+      # @option options [Proc] :before_wait (nil) Callback invoked before each wait
+      # @return [Resource] if the waiter was successful
+      def wait_until(options = {}, &block)
+        resource_copy = self.dup
+        attempts = 0
+        options[:max_attempts] ||= 10
+        options[:delay] ||= 10
+        options[:poller] = Proc.new do
+          attempts += 1
+          if block.call(resource_copy)
+            [:success, resource_copy]
+          else
+            resource_copy.reload unless attempts == options[:max_attempts]
+            :retry
+          end
+        end
+        Waiters::Waiter.new(options).wait({})
+      end
+
       # @return [Struct]
       def data
         load unless @data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resources
 version: !ruby/object:Gem::Version
-  version: 2.0.34
+  version: 2.0.35
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.34
+        version: 2.0.35
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.34
+        version: 2.0.35
 description: Provides resource oriented interfaces and other higher-level abstractions
   for many AWS services. This gem is part of the official AWS SDK for Ruby.
 email:
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Resources