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

data/templates/client_api_module.mustache

@@ -51,6 +51,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}}

data/templates/client_class.mustache

@@ -38,51 +38,6 @@ module {{module_name}}
     # @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.
-    #
     {{/client_constructor}}
     def initialize(*args)
       super

data/templates/endpoints_module.mustache

@@ -5,6 +5,7 @@
 {{/generated_src_warning}}
 
 module {{module_name}}
+  # @api private
   module Endpoints
 
     {{#endpoint_classes}}

data/templates/endpoints_plugin.mustache

@@ -10,6 +10,7 @@ module {{module_name}}
       option(
         :endpoint_provider,
         doc_type: '{{module_name}}::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\
@@ -29,16 +30,17 @@ module {{module_name}}
       # @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)
             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)
 

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.feature('resource') do
+        Aws::Waiters::Waiter.new(options).wait({})
+      end
     end
     {{/wait_until}}
     {{#actions?}}

data/templates/spec/endpoint_provider_spec_class.mustache

@@ -50,6 +50,16 @@ module {{module_name}}
         {{/expect_error?}}
         {{^expect_error?}}
         {{#expect_auth?}}
+        {{#s3_express_auth?}}
+        client.stub_responses(:create_session, credentials: {
+          access_key_id: 's3-akid',
+          secret_access_key: 's3-secret',
+          session_token: 's3-session',
+          expiration: Time.now + 60 * 5
+        })
+        expect_auth({"name"=>"sigv4", "signingName"=>"s3express"})
+        Aws::S3.express_credentials_cache.clear
+        {{/s3_express_auth?}}
         expect_auth({{{expected_auth}}})
         {{/expect_auth?}}
         resp = client.{{operation_name}}(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-code-generator
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre
+  version: 0.5.0.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -63,6 +63,15 @@ files:
 - 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/rbs.rb
+- lib/aws-sdk-code-generator/rbs/error_list.rb
+- lib/aws-sdk-code-generator/rbs/keyword_argument_builder.rb
+- lib/aws-sdk-code-generator/rbs/method_signature.rb
+- lib/aws-sdk-code-generator/rbs/resource_action.rb
+- lib/aws-sdk-code-generator/rbs/resource_association.rb
+- lib/aws-sdk-code-generator/rbs/resource_batch_action.rb
+- lib/aws-sdk-code-generator/rbs/resource_client_request.rb
+- lib/aws-sdk-code-generator/rbs/waiter.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
@@ -108,9 +117,14 @@ files:
 - 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/rbs/client_class.rb
+- lib/aws-sdk-code-generator/views/rbs/errors_module.rb
+- lib/aws-sdk-code-generator/views/rbs/resource_class.rb
+- lib/aws-sdk-code-generator/views/rbs/root_resource_class.rb
+- lib/aws-sdk-code-generator/views/rbs/types_module.rb
+- lib/aws-sdk-code-generator/views/rbs/waiters_module.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
@@ -137,11 +151,16 @@ files:
 - 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/rbs/client_class.mustache
+- templates/rbs/errors_module.mustache
+- templates/rbs/resource_class.mustache
+- templates/rbs/root_resource_class.mustache
+- templates/rbs/types_module.mustache
+- templates/rbs/waiters_module.mustache
 - templates/resource_class.mustache
 - templates/root_resource_class.mustache
 - templates/service_module.mustache
@@ -169,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby - Code Generator

data/lib/aws-sdk-code-generator/views/features/smoke_step_definitions.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module AwsSdkCodeGenerator
-  module Views
-    module Features
-      class SmokeStepDefinitions < View
-
-        # @param [Hash] options
-        # @option options [required, Service] :service
-        def initialize(options)
-          service = options.fetch(:service)
-          @module_name = service.module_name
-        end
-
-        attr_reader :module_name
-
-        # @return [String|nil]
-        def generated_src_warning
-          return if @custom
-          GENERATED_SRC_WARNING
-        end
-
-      end
-    end
-  end
-end

data/templates/features/smoke_step_definitions.mustache

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-{{#generated_src_warning}}
-{{generated_src_warning}}
-{{/generated_src_warning}}
-# Shared Smoke Test Definitions
-Given(/I create a client in region '(.*?)'/) do |region|
-  @regional_client = {{module_name}}::Client.new(region: region)
-end
-
-Given(/I create a client with endpoint '(.*?)'/) do |endpoint|
-  @regional_client = {{module_name}}::Client.new(endpoint: endpoint)
-end
-
-When(/I call the operation '(.*?)' with params:/) do |operation, params|
-  opts = JSON.parse(params, symbolize_names: true)
-  begin
-    @regional_client.send(operation.to_sym, opts)
-    @operation_raised_error = false
-  rescue StandardError
-    @operation_raised_error = true
-  end
-end
-
-Then(/I expect an error was raised/) do
-  expect(@operation_raised_error).to be_truthy
-end
-
-Then(/I expect an error was not raised/) do
-  expect(@operation_raised_error).not_to be_truthy
-end