aws-sdk-code-generator 0.4.0.pre → 0.6.0.pre

data/templates/async_client_class.mustache

@@ -83,13 +83,18 @@ module {{module_name}}
     # @api private
     def build_request(operation_name, params = {})
       handlers = @handlers.for(operation_name)
+      tracer = config.telemetry_provider.tracer_provider.tracer(
+        Aws::Telemetry.module_to_tracer_name('{{module_name}}')
+      )
       context = Seahorse::Client::RequestContext.new(
         operation_name: operation_name,
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         http_response: Seahorse::Client::Http::AsyncResponse.new,
-        config: config)
+        config: config,
+        tracer: tracer
+      )
       context[:gem_name] = '{{gem_name}}'
       context[:gem_version] = '{{gem_version}}'
       Seahorse::Client::Request.new(handlers, context)

data/templates/client_api_module.mustache

@@ -3,6 +3,7 @@
 {{#generated_src_warning}}
 {{generated_src_warning}}
 {{/generated_src_warning}}
+
 module {{module_name}}
   # @api private
   module ClientApi
@@ -51,6 +52,13 @@ module {{module_name}}
           {{/http_checksum}}
         }
         {{/http_checksum}}
+        {{#request_compression}}
+        o.request_compression = {
+          {{#request_compression}}
+          {{{key}}} => {{{value}}},
+          {{/request_compression}}
+        }
+        {{/request_compression}}
         {{#deprecated}}
         o.deprecated = true
         {{/deprecated}}
@@ -70,6 +78,12 @@ module {{module_name}}
         {{#authtype}}
         o['authtype'] = "{{.}}"
         {{/authtype}}
+        {{#unsigned_payload}}
+        o['unsignedPayload'] = true
+        {{/unsigned_payload}}
+        {{#auth}}
+        o['auth'] = {{&auth}}
+        {{/auth}}
         {{#endpoint_trait}}
         o.endpoint_pattern = {
           {{#endpoint_pattern}}

data/templates/client_class.mustache

@@ -7,8 +7,6 @@
 require '{{.}}'
 {{/plugin_requires}}
 
-Aws::Plugins::GlobalConfiguration.add_identifier(:{{service_identifier}})
-
 module {{module_name}}
   # An API client for {{service_name}}.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
@@ -37,52 +35,12 @@ module {{module_name}}
     {{#client_constructor}}
     # @overload initialize(options)
     #   @param [Hash] options
-    {{>documentation}}
-    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
-    #     requests through.  Formatted like 'http://proxy.com:123'.
-    #
-    #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before raising a
-    #     `Timeout::Error`.
-    #
-    #   @option options [Float] :http_read_timeout (60) The default
-    #     number of seconds to wait for response data.  This value can
-    #     safely be set per-request on the session.
-    #
-    #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idle before it is
-    #     considered stale.  Stale connections are closed and removed
-    #     from the pool before making a request.
-    #
-    #   @option options [Float] :http_continue_timeout (1) The number of
-    #     seconds to wait for a 100-continue response before sending the
-    #     request body.  This option has no effect unless the request has
-    #     "Expect" header set to "100-continue".  Defaults to `nil` which
-    #     disables this behaviour.  This value can safely be set per
-    #     request on the session.
     #
-    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
-    #     in seconds.
-    #
-    #   @option options [Boolean] :http_wire_trace (false) When `true`,
-    #     HTTP debug output will be sent to the `:logger`.
-    #
-    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
-    #     SSL peer certificates are verified when establishing a
-    #     connection.
-    #
-    #   @option options [String] :ssl_ca_bundle Full path to the SSL
-    #     certificate authority bundle file that should be used when
-    #     verifying peer certificates.  If you do not pass
-    #     `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
-    #     will be used if available.
-    #
-    #   @option options [String] :ssl_ca_directory Full path of the
-    #     directory that contains the unbundled SSL certificate
-    #     authority files for verifying peer certificates.  If you do
-    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
-    #     system default will be used if available.
+    #   @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
+    #     A list of plugins to apply to the client. Each plugin is either a
+    #     class name or an instance of a plugin class.
     #
+    {{>documentation}}
     {{/client_constructor}}
     def initialize(*args)
       super
@@ -139,13 +97,18 @@ module {{module_name}}
         end
       end
       {{/authorizer?}}
+      tracer = config.telemetry_provider.tracer_provider.tracer(
+        Aws::Telemetry.module_to_tracer_name('{{module_name}}')
+      )
       context = Seahorse::Client::RequestContext.new(
         operation_name: operation_name,
         operation: config.api.operation(operation_name),{{#authorizer?}}
         authorizer: authorizer,{{/authorizer?}}
         client: self,
         params: params,
-        config: config)
+        config: config,
+        tracer: tracer
+      )
       context[:gem_name] = '{{gem_name}}'
       context[:gem_version] = '{{gem_version}}'
       Seahorse::Client::Request.new(handlers, context)

data/templates/endpoint_parameters_class.mustache

@@ -11,7 +11,7 @@ module {{module_name}}
   {{/parameters}}
   EndpointParameters = Struct.new(
     {{#parameters}}
-    :{{underscore_name}},
+    :{{key}},
     {{/parameters}}
     {{^parameters}}
     nil
@@ -23,28 +23,31 @@ module {{module_name}}
     class << self
       PARAM_MAP = {
         {{#parameters}}
-        '{{name}}' => :{{underscore_name}},
+        '{{name}}' => :{{key}},
         {{/parameters}}
       }.freeze
     end
 
     def initialize(options = {})
       {{#parameters}}
-      self[:{{underscore_name}}] = options[:{{underscore_name}}]
+      self[:{{key}}] = options[:{{key}}]
       {{#default?}}
-      {{#boolean_default?}}
-      self[:{{underscore_name}}] = {{default}} if self[:{{underscore_name}}].nil?
-      {{/boolean_default?}}
-      {{^boolean_default?}}
-      self[:{{underscore_name}}] ||= '{{default}}' if self[:{{underscore_name}}].nil?
-      {{/boolean_default?}}
+      self[:{{key}}] = {{{default}}} if self[:{{key}}].nil?
       {{/default?}}
-      {{#required}}
-      if self[:{{underscore_name}}].nil?
-        raise ArgumentError, "Missing required EndpointParameter: :{{underscore_name}}"
+      {{#validate_required?}}
+      if self[:{{key}}].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :{{key}}"
       end
-      {{/required}}
+      {{/validate_required?}}
       {{/parameters}}
     end
+
+    def self.create(config, options={})
+      new({
+        {{#config_parameters}}
+        {{key}}: {{{value}}},
+        {{/config_parameters}}
+      }.merge(options))
+    end
   end
 end

data/templates/endpoints_module.mustache

@@ -5,29 +5,37 @@
 {{/generated_src_warning}}
 
 module {{module_name}}
+  # @api private
   module Endpoints
 
     {{#endpoint_classes}}
     class {{name}}
       def self.build(context)
-        {{#has_endpoint_built_in?}}
-        unless context.config.regional_endpoint
-          endpoint = context.config.endpoint.to_s
-        end
-        {{/has_endpoint_built_in?}}
-        {{module_name}}::EndpointParameters.new(
+        {{module_name}}::EndpointParameters.create(
+          context.config,
           {{#parameters}}
-          {{#static_string?}}
-          {{key}}: "{{{value}}}",
-          {{/static_string?}}
-          {{^static_string?}}
           {{key}}: {{{value}}},
-          {{/static_string?}}
           {{/parameters}}
         )
       end
     end
 
     {{/endpoint_classes}}
+
+    def self.parameters_for_operation(context)
+      {{#operation_specific_parameters?}}
+      {{module_name}}::EndpointParameters.create(context.config)
+      {{/operation_specific_parameters?}}
+      {{^operation_specific_parameters?}}
+      case context.operation_name
+      {{#endpoint_classes}}
+      when :{{operation}}
+        {{name}}.build(context)
+      {{/endpoint_classes}}
+      else
+        {{module_name}}::EndpointParameters.create(context.config)
+      end
+      {{/operation_specific_parameters?}}
+    end
   end
 end

data/templates/endpoints_plugin.mustache

@@ -10,11 +10,12 @@ module {{module_name}}
       option(
         :endpoint_provider,
         doc_type: '{{module_name}}::EndpointProvider',
-        docstring: 'The endpoint provider used to resolve endpoints. Any '\
-                   'object that responds to `#resolve_endpoint(parameters)` '\
-                   'where `parameters` is a Struct similar to '\
-                   '`{{module_name}}::EndpointParameters`'
-      ) do |cfg|
+        rbs_type: 'untyped',
+        docstring: <<~DOCS) do |_cfg|
+The endpoint provider used to resolve endpoints. Any object that responds to
+`#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
+`{{module_name}}::EndpointParameters`.
+        DOCS
         {{module_name}}::EndpointProvider.new
       end
 
@@ -22,31 +23,57 @@ module {{module_name}}
       option(
         :{{name}},
         doc_type: '{{doc_type}}',
-        default: {{{default}}},
-        docstring: "{{{docstring}}}")
+        docstring: <<~DOCS) do |cfg|
+{{{docstring}}}
+        DOCS
+        {{{default}}}
+      end
 
       {{/endpoint_options}}
       # @api private
       class Handler < Seahorse::Client::Handler
         def call(context)
-          # If endpoint was discovered, do not resolve or apply the endpoint.
           unless context[:discovered_endpoint]
-            params = parameters_for_operation(context)
+            params = {{module_name}}::Endpoints.parameters_for_operation(context)
             endpoint = context.config.endpoint_provider.resolve_endpoint(params)
 
             context.http_request.endpoint = endpoint.url
             apply_endpoint_headers(context, endpoint.headers)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
           end
 
-          context[:endpoint_params] = params
           context[:auth_scheme] =
             Aws::Endpoints.resolve_auth_scheme(context, endpoint)
 
-          @handler.call(context)
+          with_metrics(context) { @handler.call(context) }
         end
 
         private
 
+        def with_metrics(context, &block)
+          metrics = []
+          metrics << 'ENDPOINT_OVERRIDE' unless context.config.regional_endpoint
+          if context[:auth_scheme] && context[:auth_scheme]['name'] == 'sigv4a'
+            metrics << 'SIGV4A_SIGNING'
+          end
+          {{#has_account_id_endpoint_mode?}}
+          case context.config.account_id_endpoint_mode
+          when 'preferred'
+            metrics << 'ACCOUNT_ID_MODE_PREFERRED'
+          when 'disabled'
+            metrics << 'ACCOUNT_ID_MODE_DISABLED'
+          when 'required'
+            metrics << 'ACCOUNT_ID_MODE_REQUIRED'
+          end
+          {{/has_account_id_endpoint_mode?}}
+          if context.config.credentials&.credentials&.account_id
+            metrics << 'RESOLVED_ACCOUNT_ID'
+          end
+          Aws::Plugins::UserAgent.metric(*metrics, &block)
+        end
+
         def apply_endpoint_headers(context, headers)
           headers.each do |key, values|
             value = values
@@ -57,15 +84,6 @@ module {{module_name}}
             context.http_request.headers[key] = value
           end
         end
-
-        def parameters_for_operation(context)
-          case context.operation_name
-          {{#endpoint_classes}}
-          when :{{operation_name}}
-            {{module_name}}::Endpoints::{{class_name}}.build(context)
-          {{/endpoint_classes}}
-          end
-        end
       end
 
       def add_handlers(handlers, _config)

data/templates/errors_module.mustache

@@ -68,3 +68,8 @@ module {{module_name}}
     {{/errors}}
   end
 end
+{{#customization_file_exists?}}
+
+# Load customizations if they exist
+require '{{customization_file_path}}'
+{{/customization_file_exists?}}

data/templates/features/smoke.mustache

@@ -1,22 +1,18 @@
 {{#generated_src_warning}}
 {{generated_src_warning}}
 {{/generated_src_warning}}
-Feature: Smoke tests for {{service}}
-
-Background:
-{{#client_endpoint}}
-  Given I create a client with endpoint '{{client_endpoint}}'
-{{/client_endpoint}}
-{{^client_endpoint}}
-  Given I create a client in region '{{client_region}}'
-{{/client_endpoint}}
+Feature: Smoke tests for {{service_name}}
 {{#smoke_tests}}
 
-  {{smoke_test_tags}}
-  Scenario: {{scenario_string}}
-  When I call the operation '{{operation}}' with params:
-    """
+  {{tags}}
+  Scenario: {{id}}
+    Given I create a '{{service_module}}' client with config:
+      """
+{{&config_hash}}
+      """
+    When I call the operation '{{operation_name}}' with params:
+      """
 {{&param_hash}}
-    """
-  Then {{error_expectation}}
+      """
+    Then {{&expectation}}
 {{/smoke_tests}}

data/templates/features/step_definitions.mustache

@@ -1,10 +1,5 @@
 Before("@{{var_name}}") do
-{{#client_endpoint}}
-  @service = {{module_name}}::Resource.new(endpoint: '{{client_endpoint}}')
-{{/client_endpoint}}
-{{^client_endpoint}}
   @service = {{module_name}}::Resource.new
-{{/client_endpoint}}
   @client = @service.client
 end
 

data/templates/gemspec.mustache

@@ -24,8 +24,11 @@ Gem::Specification.new do |spec|
 
   {{/metadata}}
   {{#dependencies}}
-  spec.add_dependency('{{gem}}', '{{&version}}')
+  spec.add_dependency({{{gem_version}}})
   {{/dependencies}}
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.5'
+  {{#deprecated?}}
+  spec.post_install_message = '*** {{gem_name}} is deprecated ***'
+  {{/deprecated?}}
 end

data/templates/rbs/client_class.mustache

@@ -0,0 +1,39 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    class Client < ::Seahorse::Client::Base
+      include ::Aws::ClientStubs
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Client.html#initialize-instance_method
+      def self.new: ({{{client_option}}}) -> instance
+                  | (?Hash[Symbol, untyped]) -> instance
+
+      {{#operations}}
+
+      {{^empty_structure}}
+      interface {{interface}}
+        include ::Seahorse::Client::_ResponseSuccess[{{data}}]
+        {{#returns_members}}
+        def {{method_name}}: () -> {{{returns}}}
+        {{/returns_members}}
+      end
+      {{/empty_structure}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Client.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/operations}}
+      {{#waiters?}}
+
+      {{#waiters_first}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Client.html#wait_until-instance_method
+      def wait_until: {{{client_overload_keyword_argument}}}
+                    | {{{client_overload_positional_argument}}}
+      {{/waiters_first}}
+      {{#waiters_others}}
+                    | {{{client_overload_keyword_argument}}}
+                    | {{{client_overload_positional_argument}}}
+      {{/waiters_others}}
+      {{/waiters?}}
+    end
+  end
+end
+

data/templates/rbs/errors_module.mustache

@@ -0,0 +1,17 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    module Errors
+      class ServiceError < ::Aws::Errors::ServiceError
+      end
+
+      {{#errors}}
+      class {{name}} < ::Aws::Errors::ServiceError
+        {{#members}}
+        {{{signature}}}
+        {{/members}}
+      end
+      {{/errors}}
+    end
+  end
+end

data/templates/rbs/resource_class.mustache

@@ -0,0 +1,71 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html
+    class {{class_name}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#initialize-instance_method
+      {{{initialize_signature}}}
+      {{#identifiers}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#{{name}}-instance_method
+      def {{name}}: () -> {{type}}
+      {{#alias}}
+      alias {{alias}} {{name}}
+      {{/alias}}
+      {{/identifiers}}
+      {{#data_attributes}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/data_attributes}}
+
+      def client: () -> Client
+
+      {{#load?}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#load-instance_method
+      def load: () -> self
+      alias reload load
+      {{/load?}}
+
+      {{#load_or_shape?}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#data-instance_method
+      def data: () -> Types::{{shape}}
+      {{/load_or_shape?}}
+      {{^load_or_shape?}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#data-instance_method
+      def data: () -> EmptyStructure
+      {{/load_or_shape?}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#data_loaded?-instance_method
+      def data_loaded?: () -> bool
+
+      {{#exists_waiters}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#exists?-instance_method
+      def exists?: (?max_attempts: Integer, ?delay: Numeric, ?before_attempt: (^(Integer attempts) -> void), ?before_wait: (^(Integer attempts, untyped response) -> void)) -> bool
+                 | (?Hash[Symbol, untyped]) -> bool
+      {{/exists_waiters}}
+      {{#waiters}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/waiters}}
+      {{#actions}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/actions}}
+      {{#associations}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/{{class_name}}.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/associations}}
+
+      class Collection < ::Aws::Resources::Collection[{{class_name}}]
+        {{#batch_actions}}
+
+        {{{signature}}}
+        {{/batch_actions}}
+      end
+    end
+  end
+end

data/templates/rbs/root_resource_class.mustache

@@ -0,0 +1,26 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Resource.html
+    class Resource
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Resource.html#initialize-instance_method
+      def initialize: (
+                        ?client: Client,{{{client_option}}}) -> void
+                    | (?Hash[Symbol, untyped]) -> void
+
+      def client: () -> Client
+
+      {{#actions}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Resource.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/actions}}
+
+      {{#associations}}
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Resource.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/associations}}
+    end
+  end
+end

data/templates/rbs/types_module.mustache

@@ -0,0 +1,37 @@
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+  module Types
+    {{#structures}}
+
+    {{> documentation}}
+    {{#empty?}}
+    class {{class_name}} < Aws::EmptyStructure
+    end
+    {{/empty?}}
+    {{^empty?}}
+    class {{class_name}}
+      {{#members}}
+      attr_accessor {{member_name}}: {{{returns}}}
+      {{/members}}
+      SENSITIVE: {{sensitive_params}}
+      {{#union?}}
+
+      {{#members}}
+      class {{member_class_name}} < {{class_name}}
+      end
+      {{/members}}
+      {{/union?}}
+    end
+    {{/empty?}}
+    {{/structures}}
+    {{#eventstreams}}
+
+    {{> documentation}}
+    class {{class_name}} < Enumerator[untyped, untyped]
+      def event_types: () -> {{#empty?}}[]{{/empty?}}{{^empty?}}[{{#types}}:{{member_name}}{{^last}}, {{/last}}{{/types}}]{{/empty?}}
+    end
+    {{/eventstreams}}
+  end
+end

data/templates/rbs/waiters_module.mustache

@@ -0,0 +1,17 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    module Waiters
+      {{#waiters}}
+
+      class {{class_name}}
+        def initialize: (?client: Client, ?max_attempts: Integer, ?delay: Integer, ?before_attempt: Proc, ?before_wait: Proc) -> void
+                      | (?Hash[Symbol, untyped]) -> void
+
+        def wait: {{{waiter_overload_keyword_argument}}}
+                | {{{waiter_overload_positional_argument}}}
+      end
+      {{/waiters}}
+    end
+  end
+end

data/templates/resource_class.mustache

@@ -213,7 +213,9 @@ module {{module_name}}
           :retry
         end
       end
-      Aws::Waiters::Waiter.new(options).wait({})
+      Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        Aws::Waiters::Waiter.new(options).wait({})
+      end
     end
     {{/wait_until}}
     {{#actions?}}
@@ -302,3 +304,8 @@ module {{module_name}}
     {{/batch_actions?}}
   end
 end
+{{#customization_file_exists?}}
+
+# Load customizations if they exist
+require '{{resource_customization}}'
+{{/customization_file_exists?}}

data/templates/root_resource_class.mustache

@@ -49,3 +49,8 @@ module {{module_name}}
 
   end
 end
+{{#customization_file_exists?}}
+
+# Load customizations if they exist
+require '{{customization_file_path}}'
+{{/customization_file_exists?}}