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

data/templates/endpoint_provider_class.mustache

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+  class EndpointProvider
+    def initialize(rule_set = nil)
+      @@rule_set ||= begin
+        endpoint_rules = Aws::Json.load(Base64.decode64(RULES))
+        Aws::Endpoints::RuleSet.new(
+          version: endpoint_rules['version'],
+          service_id: endpoint_rules['serviceId'],
+          parameters: endpoint_rules['parameters'],
+          rules: endpoint_rules['rules']
+        )
+      end
+      @provider = Aws::Endpoints::RulesProvider.new(rule_set || @@rule_set)
+    end
+
+    def resolve_endpoint(parameters)
+      @provider.resolve_endpoint(parameters)
+    end
+
+    # @api private
+    RULES = <<-JSON
+{{endpoint_rules_encoded}}
+    JSON
+  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.3.0.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-12-20 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