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

data/lib/aws-sdk-code-generator/views/spec/endpoint_provider_spec_class.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module Spec
+      class EndpointProviderSpecClass < View
+
+        # @param [Hash] options
+        # @option options [required, Service] :service
+        def initialize(options)
+          @service = options.fetch(:service)
+          test_cases = @service.endpoint_tests.fetch('testCases', [])
+          @endpoint_tests = test_cases.map do |endpoint_test|
+            EndpointProviderTest.new(
+              service: @service,
+              documentation: endpoint_test['documentation'],
+              params: endpoint_test['params'],
+              tags: endpoint_test['tags'],
+              expect: endpoint_test['expect'],
+              operation_inputs: endpoint_test['operationInputs']
+            )
+          end
+        end
+
+        # @return [Array<EndpointProviderTest>]
+        attr_reader :endpoint_tests
+
+        # @return [String|nil]
+        def generated_src_warning
+          return if @service.protocol == 'api-gateway'
+          GENERATED_SRC_WARNING
+        end
+
+        def module_name
+          @service.module_name
+        end
+
+        class EndpointProviderTest
+          def initialize(options)
+            @service = options[:service]
+            @documentation = options[:documentation]
+            @params = options[:params]&.map do |key, value|
+              [Underscore.underscore(key).to_sym, value]
+            end.to_h
+            @tags = options[:tags]
+            @expect = options[:expect]
+            operation_inputs = options[:operation_inputs] || []
+            @operation_inputs = operation_inputs.map do |operation_inputs_test|
+              OperationInputsTest.new(
+                service: @service,
+                operation_name: Underscore.underscore(
+                  operation_inputs_test['operationName']
+                ),
+                operation_params: operation_inputs_test['operationParams'] || [],
+                built_in_params: operation_inputs_test['builtInParams'] || [],
+                client_params: operation_inputs_test['clientParams'] || []
+              )
+            end
+          end
+
+          # @return [String]
+          attr_reader :documentation
+
+          # @return [Hash<Symbol, String>]
+          attr_reader :params
+
+          # @return [Array<String>]
+          attr_reader :tags
+
+          # @return [Hash]
+          attr_reader :expect
+
+          # # @return [Array<OperationInput>]
+          attr_reader :operation_inputs
+
+          def expect_error?
+            !@expect['error'].nil?
+          end
+
+          def expected_auth
+            if expect_auth?
+              @expect['endpoint']['properties']['authSchemes'].first
+            end
+          end
+
+          def expect_auth?
+            @expect['endpoint'] &&
+              @expect['endpoint']['properties'] &&
+              @expect['endpoint']['properties']['authSchemes'] &&
+              !@expect['endpoint']['properties']['authSchemes'].empty?
+          end
+
+          def expected_headers
+            @expect['endpoint']['headers'].map { |k,v| Param.new(k, v.join(",")) }
+          end
+
+          def expect_headers?
+            @expect['endpoint'] &&
+              @expect['endpoint']['headers'] &&
+              !@expect['endpoint']['headers'].empty?
+          end
+
+        end
+
+        class OperationInputsTest
+
+          def initialize(options)
+            @service = options[:service]
+            @operation_name = options[:operation_name]
+            @operation_params = options[:operation_params].map do |k,v|
+              Param.new(Underscore.underscore(k), transform_operation_values(v))
+            end
+            @client_params = options[:client_params].map do |k,v|
+              Param.new(Underscore.underscore(k), v)
+            end
+
+            @client_params += options[:built_in_params].map do |k,v|
+              built_in_to_param(k, v)
+            end
+            # the expected default of UseGlobalEndpoint does not match the SDK's default value
+            if @service.identifier == 's3' && !options[:built_in_params].include?('AWS::S3::UseGlobalEndpoint')
+              @client_params << built_in_to_param('AWS::S3::UseGlobalEndpoint', false)
+            end
+          end
+
+          # @return String
+          attr_reader :operation_name
+
+          # @return [Hash<String, String>]
+          attr_reader :operation_params
+
+          # @return [Hash<String, String>]
+          attr_reader :client_params
+
+          private
+          def transform_operation_values(value)
+            case value
+            when Hash
+              value.each_with_object({}) do |(k, v), o|
+                o[Underscore.underscore(k)] = transform_operation_values(v)
+              end
+            when Array
+              value.map { |v| transform_operation_values(v) }
+            else
+              value
+            end
+          end
+
+          def built_in_to_param(built_in, value)
+            case built_in
+            when 'AWS::Region'
+              Param.new('region', value)
+            when 'AWS::UseFIPS'
+              Param.new('use_fips_endpoint', value)
+            when 'AWS::UseDualStack'
+              Param.new('use_dualstack_endpoint', value)
+            when 'AWS::STS::UseGlobalEndpoint'
+              Param.new('sts_regional_endpoints', value ? 'legacy' : 'regional')
+            when 'AWS::S3::UseGlobalEndpoint'
+              Param.new('s3_us_east_1_regional_endpoint', value ? 'legacy' : 'regional')
+            when 'AWS::S3::Accelerate'
+              Param.new('use_accelerate_endpoint', value)
+            when 'AWS::S3::ForcePathStyle'
+              Param.new('force_path_style', value)
+            when 'AWS::S3::UseArnRegion'
+              Param.new('s3_use_arn_region', value)
+            when 'AWS::S3Control::UseArnRegion'
+              Param.new('s3_use_arn_region', value)
+            when 'AWS::S3::DisableMultiRegionAccessPoints'
+              Param.new('s3_disable_multiregion_access_points', value)
+            when 'SDK::Endpoint'
+              Param.new('endpoint', value)
+            else
+              raise ArgumentError, "#{built_in} not supported."
+            end
+          end
+        end
+
+        class Param
+          def initialize(param, value)
+            @param = param
+            @value = value
+          end
+          attr_accessor :param
+
+          def value
+            if @value.is_a? String
+              "'#{@value}'"
+            else
+              @value
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-code-generator/views/spec/spec_helper.rb

@@ -9,13 +9,14 @@ module AwsSdkCodeGenerator
 
         # @param [Hash] options
         # @option options [required, Service] :service
+        # @option options[required, String] :aws_sdk_core_lib_path
         def initialize(options)
-          service = options.fetch(:service)
-          @gem_name = service.gem_name
-          @gem_dependencies = service.gem_dependencies.map do |gem_name, _|
+          @service = options.fetch(:service)
+          @gem_name = @service.gem_name
+          @gem_dependencies = @service.gem_dependencies.map do |gem_name, _|
             { dependency: gem_name }
           end
-          @custom = service.protocol == 'api-gateway'
+          @custom = @service.protocol == 'api-gateway'
         end
 
         attr_reader :gem_name
@@ -27,6 +28,10 @@ module AwsSdkCodeGenerator
           GENERATED_SRC_WARNING
         end
 
+        def included_in_core
+          @service.included_in_core?
+        end
+
       end
     end
   end

data/lib/aws-sdk-code-generator/views/types_module.rb

@@ -141,13 +141,14 @@ module AwsSdkCodeGenerator
           elsif shape['union']
             "@note #{shape_name} is a union - when making an API calls you"\
             ' must set exactly one of the members.'
-          else
-            note = "@note When making an API call, you may pass #{shape_name}\n"
-            note += "  data as a hash:\n\n"
-            note += '      ' + SyntaxExampleHash.new(
-              shape: shape(shape_name),
-              api: @service.api,
-            ).format('      ')
+          # This doc block is no longer useful, but keeping for records
+          # else
+          #   note = "@note When making an API call, you may pass #{shape_name}\n"
+          #   note += "  data as a hash:\n\n"
+          #   note += '      ' + SyntaxExampleHash.new(
+          #     shape: shape(shape_name),
+          #     api: @service.api,
+          #   ).format('      ')
           end
         end
       end

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

@@ -2,6 +2,7 @@
 
 require_relative 'aws-sdk-code-generator/api'
 require_relative 'aws-sdk-code-generator/apply_docs'
+require_relative 'aws-sdk-code-generator/codegenerated_plugin'
 require_relative 'aws-sdk-code-generator/client_constructor'
 require_relative 'aws-sdk-code-generator/client_operation_documentation'
 require_relative 'aws-sdk-code-generator/client_operation_list'
@@ -53,9 +54,14 @@ require_relative 'aws-sdk-code-generator/views/features/smoke_step_definitions'
 require_relative 'aws-sdk-code-generator/views/features/smoke'
 require_relative 'aws-sdk-code-generator/views/gemspec'
 require_relative 'aws-sdk-code-generator/views/resource_class'
+require_relative 'aws-sdk-code-generator/views/endpoint_parameters_class'
+require_relative 'aws-sdk-code-generator/views/endpoint_provider_class'
+require_relative 'aws-sdk-code-generator/views/endpoints_module'
+require_relative 'aws-sdk-code-generator/views/endpoints_plugin'
 require_relative 'aws-sdk-code-generator/views/root_resource_class'
 require_relative 'aws-sdk-code-generator/views/service_module'
 require_relative 'aws-sdk-code-generator/views/spec/spec_helper'
+require_relative 'aws-sdk-code-generator/views/spec/endpoint_provider_spec_class'
 require_relative 'aws-sdk-code-generator/views/types_module'
 require_relative 'aws-sdk-code-generator/views/event_streams_module'
 require_relative 'aws-sdk-code-generator/views/authorizer_class'

data/templates/async_client_class.mustache

@@ -66,11 +66,11 @@ module {{module_name}}
 
       {{#eventstream_input}}
       req.context[:input_event_stream_handler] = input_event_stream_handler
-      req.handlers.add(Aws::Binary::EncodeHandler, priority: 95)
+      req.handlers.add(Aws::Binary::EncodeHandler, priority: 55)
       {{/eventstream_input}}
       {{#eventstream_output}}
       req.context[:output_event_stream_handler] = output_event_stream_handler
-      req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)
+      req.handlers.add(Aws::Binary::DecodeHandler, priority: 55)
       {{/eventstream_output}}
 
       req.send_request(options{{{block_option}}})

data/templates/client_api_module.mustache

@@ -44,6 +44,13 @@ module {{module_name}}
         {{#http_checksum_required}}
         o.http_checksum_required = true
         {{/http_checksum_required}}
+        {{#http_checksum}}
+        o.http_checksum = {
+          {{#http_checksum}}
+          {{{key}}} => {{{value}}},
+          {{/http_checksum}}
+        }
+        {{/http_checksum}}
         {{#deprecated}}
         o.deprecated = true
         {{/deprecated}}

data/templates/client_class.mustache

@@ -45,7 +45,7 @@ module {{module_name}}
     #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
-    #   @option options [Integer] :http_read_timeout (60) The default
+    #   @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.
     #
@@ -61,6 +61,9 @@ module {{module_name}}
     #     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`.
     #

data/templates/endpoint_parameters_class.mustache

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+  # Endpoint parameters used to influence endpoints per request.
+  #
+  {{#parameters}}
+  {{documentation}}
+  {{/parameters}}
+  EndpointParameters = Struct.new(
+    {{#parameters}}
+    :{{underscore_name}},
+    {{/parameters}}
+    {{^parameters}}
+    nil
+    {{/parameters}}
+  ) do
+    include Aws::Structure
+
+    # @api private
+    class << self
+      PARAM_MAP = {
+        {{#parameters}}
+        '{{name}}' => :{{underscore_name}},
+        {{/parameters}}
+      }.freeze
+    end
+
+    def initialize(options = {})
+      {{#parameters}}
+      self[:{{underscore_name}}] = options[:{{underscore_name}}]
+      {{#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?}}
+      {{/default?}}
+      {{#required}}
+      if self[:{{underscore_name}}].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :{{underscore_name}}"
+      end
+      {{/required}}
+      {{/parameters}}
+    end
+  end
+end

data/templates/endpoint_provider_class.mustache

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+  class EndpointProvider
+    def resolve_endpoint(parameters)
+{{{ endpoint_rules_code }}}
+    end
+  end
+end

data/templates/endpoints_module.mustache

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+
+module {{module_name}}
+  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(
+          {{#parameters}}
+          {{#static_string?}}
+          {{key}}: "{{{value}}}",
+          {{/static_string?}}
+          {{^static_string?}}
+          {{key}}: {{{value}}},
+          {{/static_string?}}
+          {{/parameters}}
+        )
+      end
+    end
+
+    {{/endpoint_classes}}
+  end
+end

data/templates/endpoints_plugin.mustache

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+
+module {{module_name}}
+  module Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      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|
+        {{module_name}}::EndpointProvider.new
+      end
+
+      {{#endpoint_options}}
+      option(
+        :{{name}},
+        doc_type: '{{doc_type}}',
+        default: {{{default}}},
+        docstring: "{{{docstring}}}")
+
+      {{/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)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+          end
+
+          context[:endpoint_params] = params
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            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)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end

data/templates/gemspec.mustache

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'Apache-2.0'
   spec.email         = ['{{email}}']
   spec.require_paths = ['lib']
-  spec.files         = Dir['LICENSE.txt', 'CHANGELOG.md', 'VERSION', 'lib/**/*.rb']
+  spec.files         = Dir{{{files}}}
 
   {{#metadata}}
   spec.metadata = {

data/templates/spec/endpoint_provider_spec_class.mustache

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+
+require_relative 'spec_helper'
+
+module {{module_name}}
+  describe EndpointProvider do
+    subject { {{module_name}}::EndpointProvider.new }
+
+    {{#endpoint_tests}}
+    context '{{documentation}}' do
+      let(:expected) do
+        {{{expect}}}
+      end
+
+      it 'produces the expected output from the EndpointProvider' do
+        params = EndpointParameters.new(**{{{params}}})
+        {{#expect_error?}}
+        expect do
+          subject.resolve_endpoint(params)
+        end.to raise_error(ArgumentError, expected['error'])
+        {{/expect_error?}}
+        {{^expect_error?}}
+        endpoint = subject.resolve_endpoint(params)
+        expect(endpoint.url).to eq(expected['endpoint']['url'])
+        expect(endpoint.headers).to eq(expected['endpoint']['headers'] || {})
+        expect(endpoint.properties).to eq(expected['endpoint']['properties'] || {})
+        {{/expect_error?}}
+      end
+      {{#operation_inputs}}
+
+      it 'produces the correct output from the client when calling {{operation_name}}' do
+        client = Client.new(
+          {{#client_params}}
+          {{param}}: {{{value}}},
+          {{/client_params}}
+          stub_responses: true
+        )
+        {{#expect_error?}}
+        expect do
+          client.{{operation_name}}(
+            {{#operation_params}}
+            {{param}}: {{{value}}},
+            {{/operation_params}}
+          )
+        end.to raise_error(ArgumentError, expected['error'])
+        {{/expect_error?}}
+        {{^expect_error?}}
+        {{#expect_auth?}}
+        expect_auth({{{expected_auth}}})
+        {{/expect_auth?}}
+        resp = client.{{operation_name}}(
+          {{#operation_params}}
+          {{param}}: {{{value}}},
+          {{/operation_params}}
+        )
+        expected_uri = URI.parse(expected['endpoint']['url'])
+        expect(resp.context.http_request.endpoint.to_s).to include(expected_uri.host)
+        expect(resp.context.http_request.endpoint.to_s).to include(expected_uri.scheme)
+        expect(resp.context.http_request.endpoint.to_s).to include(expected_uri.path)
+        {{#expect_headers?}}
+        {{#expected_headers}}
+        expect(resp.context.http_request.headers['{{param}}']).to eq({{{value}}})
+        {{/expected_headers}}
+        {{/expect_headers?}}
+        {{/expect_error?}}
+      end
+      {{/operation_inputs}}
+    end
+
+    {{/endpoint_tests}}
+  end
+end

data/templates/spec/spec_helper.mustache

@@ -3,7 +3,12 @@
 {{#generated_src_warning}}
 {{generated_src_warning}}
 {{/generated_src_warning}}
+{{#included_in_core}}
+require_relative '../../shared_spec_helper'
+{{/included_in_core}}
+{{^included_in_core}}
 require_relative '../../aws-sdk-core/spec/shared_spec_helper'
+{{/included_in_core}}
 
 $:.unshift(File.expand_path('../../lib', __FILE__))
 {{#gem_dependencies}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-code-generator
 version: !ruby/object:Gem::Version
-  version: 0.2.4.pre
+  version: 0.4.0.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -53,6 +53,7 @@ files:
 - 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/codegenerated_plugin.rb
 - lib/aws-sdk-code-generator/crosslink.rb
 - lib/aws-sdk-code-generator/docstring.rb
 - lib/aws-sdk-code-generator/error_list.rb
@@ -99,6 +100,10 @@ files:
 - 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/endpoint_parameters_class.rb
+- lib/aws-sdk-code-generator/views/endpoint_provider_class.rb
+- lib/aws-sdk-code-generator/views/endpoints_module.rb
+- lib/aws-sdk-code-generator/views/endpoints_plugin.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
@@ -109,6 +114,7 @@ files:
 - 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/endpoint_provider_spec_class.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
@@ -123,6 +129,10 @@ files:
 - templates/client_class.mustache
 - templates/code.mustache
 - templates/documentation.mustache
+- templates/endpoint_parameters_class.mustache
+- templates/endpoint_provider_class.mustache
+- templates/endpoints_module.mustache
+- templates/endpoints_plugin.mustache
 - templates/errors_module.mustache
 - templates/event_streams_module.mustache
 - templates/features/env.mustache
@@ -135,6 +145,7 @@ files:
 - templates/resource_class.mustache
 - templates/root_resource_class.mustache
 - templates/service_module.mustache
+- templates/spec/endpoint_provider_spec_class.mustache
 - templates/spec/spec_helper.mustache
 - templates/types_module.mustache
 - templates/version.mustache
@@ -158,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby - Code Generator