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

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['lib/**/*.rb']
+  spec.files         = Dir{{{files}}}
 
   {{#metadata}}
   spec.metadata = {
@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency('{{gem}}', '{{&version}}')
   {{/dependencies}}
 
+  spec.required_ruby_version = '>= 2.3'
 end

data/templates/license.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/templates/service_module.mustache

@@ -3,9 +3,19 @@
 {{#generated_src_warning}}
 {{generated_src_warning}}
 {{/generated_src_warning}}
+
+{{#require_core_guard?}}
+unless Module.const_defined?(:Aws)
+  {{#requires}}
+  require '{{.}}'
+  {{/requires}}
+end
+{{/require_core_guard?}}
+{{^require_core_guard?}}
 {{#requires}}
 require '{{.}}'
 {{/requires}}
+{{/require_core_guard?}}
 
 {{#relative_requires}}
 require_relative '{{.}}'
@@ -40,7 +50,7 @@ require_relative '{{.}}'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module {{module_name}}
 
   GEM_VERSION = '{{gem_version}}'

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}}

data/templates/types_module.mustache

@@ -18,6 +18,13 @@ module {{module_name}}
       {{/members}}
       SENSITIVE = {{sensitive_params}}
       include Aws::Structure
+      {{#union?}}
+      include Aws::Structure::Union
+
+      {{#members}}
+      class {{member_class_name}} < {{class_name}}; end
+      {{/members}}
+      {{/union?}}
     end
     {{/empty?}}
     {{/structures}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-code-generator
 version: !ruby/object:Gem::Version
-  version: 0.2.2.pre
+  version: 0.3.0.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -40,7 +40,7 @@ dependencies:
         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: []
@@ -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
@@ -130,10 +140,12 @@ files:
 - 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/endpoint_provider_spec_class.mustache
 - templates/spec/spec_helper.mustache
 - templates/types_module.mustache
 - templates/version.mustache
@@ -157,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby - Code Generator