aws-sdk-code-generator 0.1.0.pre → 0.2.4.pre

data/templates/waiters_module.mustache

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+require 'aws-sdk-core/waiters'
+
+module {{module_name}}
+  {{#waiters?}}
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  {{#waiters_markdown_table}}
+  {{#lines}}
+  # {{{.}}}{{/lines}}
+  {{/waiters_markdown_table}}
+  #
+  {{/waiters?}}
+  module Waiters
+    {{#waiters}}
+
+    {{> documentation}}
+    class {{class_name}}
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts ({{max_attempts}})
+      # @option options [Integer] :delay ({{delay}})
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: {{max_attempts}},
+          delay: {{delay}},
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :{{client_method}},
+            {{#acceptors}}
+            {{#lines}}
+            {{{.}}}{{/lines}}
+            {{/acceptors}}
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#{{client_method}})
+      # @return (see Client#{{client_method}})
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+    {{/waiters}}
+  end
+end

metadata

@@ -1,103 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-code-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.2.4.pre
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generates the service code for the AWS SDK for Ruby
 email:
-- trevrowe@amazon.com
+- aws-dr-rubygems@amazon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/aws-sdk-code-generator.rb
+- lib/aws-sdk-code-generator/api.rb
 - lib/aws-sdk-code-generator/apply_docs.rb
+- lib/aws-sdk-code-generator/client_constructor.rb
+- lib/aws-sdk-code-generator/client_operation_documentation.rb
+- lib/aws-sdk-code-generator/client_operation_list.rb
+- lib/aws-sdk-code-generator/client_response_structure_example.rb
 - lib/aws-sdk-code-generator/code_builder.rb
-- lib/aws-sdk-code-generator/dsl/access_control_statement.rb
-- lib/aws-sdk-code-generator/dsl/attribute_accessor.rb
-- lib/aws-sdk-code-generator/dsl/attribute_reader.rb
-- lib/aws-sdk-code-generator/dsl/attribute_writer.rb
-- lib/aws-sdk-code-generator/dsl/autoload_statement.rb
-- lib/aws-sdk-code-generator/dsl/block_param.rb
-- lib/aws-sdk-code-generator/dsl/class.rb
-- lib/aws-sdk-code-generator/dsl/code_literal.rb
-- lib/aws-sdk-code-generator/dsl/code_object.rb
-- lib/aws-sdk-code-generator/dsl/docstring.rb
-- lib/aws-sdk-code-generator/dsl/eigenclass.rb
-- lib/aws-sdk-code-generator/dsl/extend_statement.rb
-- lib/aws-sdk-code-generator/dsl/formatter.rb
-- lib/aws-sdk-code-generator/dsl/include_statement.rb
-- lib/aws-sdk-code-generator/dsl/main.rb
-- lib/aws-sdk-code-generator/dsl/method.rb
-- lib/aws-sdk-code-generator/dsl/module.rb
-- lib/aws-sdk-code-generator/dsl/option_tag.rb
-- lib/aws-sdk-code-generator/dsl/param.rb
-- lib/aws-sdk-code-generator/dsl/param_list.rb
-- lib/aws-sdk-code-generator/dsl/return_tag.rb
-- lib/aws-sdk-code-generator/dsl/tag_default.rb
-- lib/aws-sdk-code-generator/dsl/tag_docstring.rb
-- lib/aws-sdk-code-generator/dsl/tag_type.rb
+- lib/aws-sdk-code-generator/crosslink.rb
+- lib/aws-sdk-code-generator/docstring.rb
+- lib/aws-sdk-code-generator/error_list.rb
 - lib/aws-sdk-code-generator/errors.rb
+- lib/aws-sdk-code-generator/eventstream_example.rb
 - lib/aws-sdk-code-generator/gem_builder.rb
-- lib/aws-sdk-code-generator/generators/client_api_module.rb
-- lib/aws-sdk-code-generator/generators/client_class.rb
-- lib/aws-sdk-code-generator/generators/client_operation_documentation.rb
-- lib/aws-sdk-code-generator/generators/errors_module.rb
-- lib/aws-sdk-code-generator/generators/resource/action.rb
-- lib/aws-sdk-code-generator/generators/resource/batch_builder.rb
-- lib/aws-sdk-code-generator/generators/resource/builder.rb
-- lib/aws-sdk-code-generator/generators/resource/client_getter.rb
-- lib/aws-sdk-code-generator/generators/resource/client_request.rb
-- lib/aws-sdk-code-generator/generators/resource/client_request_docs.rb
-- lib/aws-sdk-code-generator/generators/resource/client_request_params.rb
-- lib/aws-sdk-code-generator/generators/resource/collection_class.rb
-- lib/aws-sdk-code-generator/generators/resource/data_attribute_getter.rb
-- lib/aws-sdk-code-generator/generators/resource/data_loaded_method.rb
-- lib/aws-sdk-code-generator/generators/resource/data_method.rb
-- lib/aws-sdk-code-generator/generators/resource/exists_method.rb
-- lib/aws-sdk-code-generator/generators/resource/extract_identifier_method.rb
-- lib/aws-sdk-code-generator/generators/resource/has_association.rb
-- lib/aws-sdk-code-generator/generators/resource/has_many_association.rb
-- lib/aws-sdk-code-generator/generators/resource/identifier_getter.rb
-- lib/aws-sdk-code-generator/generators/resource/identifiers_method.rb
-- lib/aws-sdk-code-generator/generators/resource/initialize_method.rb
-- lib/aws-sdk-code-generator/generators/resource/load_method.rb
-- lib/aws-sdk-code-generator/generators/resource/value_source.rb
-- lib/aws-sdk-code-generator/generators/resource/waiter_method.rb
-- lib/aws-sdk-code-generator/generators/resource_class.rb
-- lib/aws-sdk-code-generator/generators/response_structure_example.rb
-- lib/aws-sdk-code-generator/generators/root_resource_class.rb
-- lib/aws-sdk-code-generator/generators/service_documentation.rb
-- lib/aws-sdk-code-generator/generators/shared_example.rb
-- lib/aws-sdk-code-generator/generators/structure_type_class.rb
-- lib/aws-sdk-code-generator/generators/syntax_example.rb
-- lib/aws-sdk-code-generator/generators/types_module.rb
-- lib/aws-sdk-code-generator/generators/waiter_class.rb
-- lib/aws-sdk-code-generator/generators/waiters_module.rb
 - lib/aws-sdk-code-generator/hash_formatter.rb
 - lib/aws-sdk-code-generator/helper.rb
+- lib/aws-sdk-code-generator/plugin_list.rb
+- lib/aws-sdk-code-generator/resource_action.rb
+- lib/aws-sdk-code-generator/resource_action_code.rb
+- lib/aws-sdk-code-generator/resource_association.rb
+- lib/aws-sdk-code-generator/resource_attribute.rb
+- lib/aws-sdk-code-generator/resource_batch_action.rb
+- lib/aws-sdk-code-generator/resource_batch_action_code.rb
+- lib/aws-sdk-code-generator/resource_batch_action_documentation.rb
+- lib/aws-sdk-code-generator/resource_batch_builder.rb
+- lib/aws-sdk-code-generator/resource_builder.rb
+- lib/aws-sdk-code-generator/resource_client_request.rb
+- lib/aws-sdk-code-generator/resource_client_request_documentation.rb
+- lib/aws-sdk-code-generator/resource_client_request_params.rb
+- lib/aws-sdk-code-generator/resource_data_method.rb
+- lib/aws-sdk-code-generator/resource_has_association.rb
+- lib/aws-sdk-code-generator/resource_has_many_association.rb
+- lib/aws-sdk-code-generator/resource_has_many_association_code.rb
+- lib/aws-sdk-code-generator/resource_identifier.rb
+- lib/aws-sdk-code-generator/resource_identifiers_method.rb
+- lib/aws-sdk-code-generator/resource_load_method.rb
+- lib/aws-sdk-code-generator/resource_method.rb
+- lib/aws-sdk-code-generator/resource_skip_params.rb
+- lib/aws-sdk-code-generator/resource_value_source.rb
+- lib/aws-sdk-code-generator/resource_waiter.rb
 - lib/aws-sdk-code-generator/service.rb
+- lib/aws-sdk-code-generator/shared_example.rb
+- lib/aws-sdk-code-generator/syntax_example.rb
+- lib/aws-sdk-code-generator/syntax_example_hash.rb
 - lib/aws-sdk-code-generator/underscore.rb
 - lib/aws-sdk-code-generator/view.rb
 - lib/aws-sdk-code-generator/views.rb
+- lib/aws-sdk-code-generator/views/apig_endpoint_class.rb
+- lib/aws-sdk-code-generator/views/apig_readme.rb
+- lib/aws-sdk-code-generator/views/async_client_class.rb
+- lib/aws-sdk-code-generator/views/authorizer_class.rb
+- lib/aws-sdk-code-generator/views/client_api_module.rb
+- lib/aws-sdk-code-generator/views/client_class.rb
+- lib/aws-sdk-code-generator/views/docstring.rb
+- lib/aws-sdk-code-generator/views/errors_module.rb
+- lib/aws-sdk-code-generator/views/event_streams_module.rb
 - lib/aws-sdk-code-generator/views/features/env.rb
+- lib/aws-sdk-code-generator/views/features/smoke.rb
+- lib/aws-sdk-code-generator/views/features/smoke_step_definitions.rb
 - lib/aws-sdk-code-generator/views/features/step_definitions.rb
 - lib/aws-sdk-code-generator/views/gemspec.rb
+- lib/aws-sdk-code-generator/views/resource_class.rb
+- lib/aws-sdk-code-generator/views/root_resource_class.rb
 - lib/aws-sdk-code-generator/views/service_module.rb
 - lib/aws-sdk-code-generator/views/spec/spec_helper.rb
+- lib/aws-sdk-code-generator/views/types_module.rb
 - lib/aws-sdk-code-generator/views/version.rb
-homepage: http://github.com/aws/aws-sdk-ruby
+- lib/aws-sdk-code-generator/views/waiters_module.rb
+- lib/aws-sdk-code-generator/waiter.rb
+- lib/aws-sdk-code-generator/yard_option_tag.rb
+- templates/apig_endpoint_class.mustache
+- templates/apig_readme.mustache
+- templates/async_client_class.mustache
+- templates/authorizer_class.mustache
+- templates/client_api_module.mustache
+- templates/client_class.mustache
+- templates/code.mustache
+- templates/documentation.mustache
+- templates/errors_module.mustache
+- templates/event_streams_module.mustache
+- templates/features/env.mustache
+- templates/features/smoke.mustache
+- templates/features/smoke_step_definitions.mustache
+- templates/features/step_definitions.mustache
+- templates/gemspec.mustache
+- templates/license.txt
+- templates/method.mustache
+- templates/resource_class.mustache
+- templates/root_resource_class.mustache
+- templates/service_module.mustache
+- templates/spec/spec_helper.mustache
+- templates/types_module.mustache
+- templates/version.mustache
+- templates/waiters_module.mustache
+homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,9 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby - Code Generator
 test_files: []

data/lib/aws-sdk-code-generator/dsl/access_control_statement.rb

@@ -1,23 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class AccessControlStatement
-
-      include Dsl::CodeObject
-
-      def initialize(access)
-        if [:public, :protected, :private].include?(access)
-          @access = access
-        else
-          raise ArgumentError, "expected :public, :protected, or :private"
-        end
-      end
-
-      attr_reader :access
-
-      def lines
-        [access.to_s]
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/attribute_accessor.rb

@@ -1,43 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class AttributeAccessor
-
-      include Dsl::CodeObject
-
-      # @option options [Boolean] :api_private (false)
-      def initialize(name, options = {}, &block)
-        @name = name
-        @tags = []
-        yield(self) if block
-        api_private! if options.fetch(:api_private, false)
-      end
-
-      attr_reader :name
-
-      def returns(type, options = {})
-        @tags << ReturnTag.new(options.merge(type:type))
-      end
-
-      def api_private!
-        @tags << "# @api private"
-      end
-
-      def documented?
-        !@tags.empty?
-      end
-
-      def lines
-        lines = []
-        @tags.each do |tag|
-          lines.concat(tag.lines.to_a)
-        end
-        lines + ["#{macro} :#{@name}"]
-      end
-
-      def macro
-        "attr_accessor"
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/attribute_reader.rb

@@ -1,11 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class AttributeReader < AttributeAccessor
-
-      def macro
-        "attr_reader"
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/attribute_writer.rb

@@ -1,11 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class AttributeWriter < AttributeAccessor
-
-      def macro
-        "attr_writer"
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/autoload_statement.rb

@@ -1,15 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class AutoloadStatement
-
-      include Dsl::CodeObject
-
-      def initialize(const_name, path)
-        @lines = ["autoload :#{const_name}, '#{path}'"]
-      end
-
-      attr_reader :lines
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/block_param.rb

@@ -1,11 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class BlockParam < Param
-
-      def initialize(options = {})
-        super('&block')
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/class.rb

@@ -1,27 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class Class < Dsl::Module
-
-      # @option options [String, nil] :extends (nil)
-      def initialize(name, options = {}, &block)
-        super(name, options, &block)
-        @extends = options.fetch(:extends, nil)
-      end
-
-      def open_module
-        lines = ["class #{@name}"]
-        if @extends
-          extends = @extends.lines.to_a
-          lines[-1] = "#{lines[-1]} < #{extends[0].rstrip}"
-          extends[1..-1].each do |line|
-            lines << line.rstrip
-          end
-          lines
-        else
-          ["class #{@name}"]
-        end
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/code_literal.rb

@@ -1,66 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class CodeLiteral
-
-      include Dsl::CodeObject
-
-      # @param [String] code
-      # @option options [Integer] :nesting (0)
-      def initialize(code = nil, options = {}, &block)
-        @code_objects = []
-        @nesting = options.fetch(:nesting, 0)
-        append(code) if code
-        yield(self) if block
-      end
-
-      attr_accessor :nesting
-
-      # @param [String, CodeLiteral]
-      def <<(code)
-        if CodeLiteral === code || String === code
-          @code_objects << [@nesting, code]
-        else
-          msg = "expected String or CodeLiteral, got #{code.class}"
-          raise ArgumentError, msg
-        end
-      end
-      alias :append :<<
-
-      def newline
-        @code_objects << [@nesting, :newline]
-      end
-
-      def indent(code = nil, &block)
-        @nesting += 1
-        code = CodeLiteral.new(code) unless CodeLiteral === code
-        append(code)
-        yield(code) if block
-        @nesting -= 1
-        code
-      end
-
-      def lines(pad = '')
-        lines = []
-        @code_objects.each do |i, code_obj|
-          case code_obj
-          when :newline
-            lines << :newline
-          when String
-            code_obj.lines.each do |line|
-              line = line.rstrip
-              if line == ''
-                lines << :newline
-              else
-                lines << "#{pad}#{'  ' * i}#{line}"
-              end
-            end
-          when CodeLiteral
-            lines.concat(code_obj.lines(pad + ('  ' * i)))
-          end
-        end
-        lines
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/code_object.rb

@@ -1,33 +0,0 @@
-require 'set'
-
-module AwsSdkCodeGenerator
-  module Dsl
-    # @api private
-    module CodeObject
-
-      def to_s
-        format(lines)
-      end
-
-      private
-
-      def underscore(str)
-        Underscore.underscore(str)
-      end
-
-      def format(lines, nesting = 0)
-        i = '  ' * nesting
-        lines.inject([]) do |code, obj|
-          case obj
-          when :newline then code << "\n"
-          when String then code << "#{i}#{obj}\n"
-          when CodeObject then code.concat(obj.lines)
-          when Array, Enumerator then code << format(obj, nesting + 1)
-          else raise ArgumentError, "got #{obj.class}"
-          end
-        end.join
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/docstring.rb

@@ -1,36 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    # @api private
-    class Docstring
-
-      include Dsl::CodeObject
-
-      # @param [String, nil]
-      def initialize(docstring = nil, &block)
-        @lines = []
-        append(docstring)
-        yield(self) if block
-      end
-
-      def append(docstring)
-        @lines.concat(docstring.to_s.rstrip.lines.map do |line|
-          if line == "\n"
-            "#"
-          else
-            "# #{line.rstrip}"
-          end
-        end)
-      end
-      alias :<< :append
-
-      # @return [Array<String>]
-      attr_reader :lines
-
-      # @return [Boolean]
-      def empty?
-        @lines.empty?
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/eigenclass.rb

@@ -1,15 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class Eigenclass < Dsl::Module
-
-      def initialize(&block)
-        super('self', &block)
-      end
-
-      def open_module
-        ["class << self"]
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/extend_statement.rb

@@ -1,12 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-
-    class ExtendStatement < IncludeStatement
-
-      def lines
-        ["extend #{@module_name}"]
-      end
-
-    end
-  end
-end

data/lib/aws-sdk-code-generator/dsl/formatter.rb

@@ -1,25 +0,0 @@
-module AwsSdkCodeGenerator
-  module Dsl
-    class Formatter
-
-      def initialize
-        @indent = '  '
-      end
-
-      def format(lines, nesting:0)
-        i = @indent * nesting
-        lines.inject([]) do |code, section|
-          case section
-          when "\n"       then code << "\n" # do not indent blank lines
-          when CodeObject then code.concat(section.lines)
-          when String     then code << "#{i}#{section}"
-          when Array      then code << format(section, nesting:nesting + 1)
-          else
-            raise ArgumentError, "got #{section.class}"
-          end
-        end.join
-      end
-
-    end
-  end
-end