aws-sdk-code-generator 0.2.2.pre → 0.3.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

@@ -13,6 +13,7 @@ module AwsSdkCodeGenerator
         @service = options.fetch(:service)
         @api = @service.api
         @input_shapes = compute_input_shapes(@service.api)
+        @output_shapes = compute_output_shapes(@service.api)
       end
 
       # @return [String|nil]
@@ -47,7 +48,7 @@ module AwsSdkCodeGenerator
           # eventstream shape will be inheriting from enumerator
           if shape['eventstream']
             list
-          elsif shape['type'] == 'structure'
+          elsif shape['type'] == 'structure' && !shape['document']
             struct_members = struct_members(shape)
             sensitive_params = struct_members.select(&:sensitive).map do |m|
               m.member_name.to_sym
@@ -56,7 +57,8 @@ module AwsSdkCodeGenerator
               class_name: shape_name,
               members: struct_members,
               sensitive_params: sensitive_params,
-              documentation: struct_class_docs(shape_name)
+              documentation: struct_class_docs(shape_name, shape),
+              union: shape['union']
             )
           else
             list
@@ -71,7 +73,7 @@ module AwsSdkCodeGenerator
             list << EventStreamClass.new(
               class_name: shape_name,
               types: struct_members(shape),
-              documentation: eventstream_class_docs(shape_name)
+              documentation: eventstream_class_docs(shape_name, shape)
             )
           else
             list
@@ -97,19 +99,20 @@ module AwsSdkCodeGenerator
         members
       end
 
-      def struct_class_docs(shape_name)
+      def struct_class_docs(shape_name, shape)
         join_docstrings([
           html_to_markdown(Api.docstring(shape_name, @api)),
-          input_example_docs(shape_name),
+          input_example_docs(shape_name, shape),
+          output_example_docs(shape_name, shape),
           attribute_macros_docs(shape_name),
           see_also_tag(shape_name),
         ])
       end
 
-      def eventstream_class_docs(shape_name)
+      def eventstream_class_docs(shape_name, shape)
         join_docstrings([
           html_to_markdown(Api.docstring(shape_name, @api)),
-          input_example_docs(shape_name),
+          input_example_docs(shape_name, shape),
           eventstream_docs(shape_name),
           see_also_tag(shape_name),
         ])
@@ -120,18 +123,32 @@ module AwsSdkCodeGenerator
         " #event_types #=> Array, returns all modeled event types in the stream"
       end
 
-      def input_example_docs(shape_name)
+      def output_example_docs(shape_name, shape)
+        if @output_shapes.include?(shape_name)
+          if shape['union']
+            "@note #{shape_name} is a union - when returned from an API call"\
+            ' exactly one value will be set and the returned type will'\
+            " be a subclass of #{shape_name} corresponding to the set member."
+          end
+        end
+      end
+
+      def input_example_docs(shape_name, shape)
         if @input_shapes.include?(shape_name)
           return if shape(shape_name)['members'].nil?
           if shape(shape_name)['members'].empty?
-            note = '@api private'
-          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('      ')
+            '@api private'
+          elsif shape['union']
+            "@note #{shape_name} is a union - when making an API calls you"\
+            ' must set exactly one of the members.'
+          # 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
@@ -172,11 +189,19 @@ module AwsSdkCodeGenerator
       def compute_input_shapes(api)
         inputs = Set.new
         (api['operations'] || {}).each do |_, operation|
-          visit_inputs(operation['input'], inputs) if operation['input']
+          visit_shapes(operation['input'], inputs) if operation['input']
         end
         inputs
       end
 
+      def compute_output_shapes(api)
+        outputs = Set.new
+        (api['operations'] || {}).each do |_, operation|
+          visit_shapes(operation['output'], outputs) if operation['output']
+        end
+        outputs
+      end
+
       def idempotency_token?(member_ref)
         member_ref['idempotencyToken'] || shape(member_ref)['idempotencyToken']
       end
@@ -185,22 +210,22 @@ module AwsSdkCodeGenerator
         "<p><b>A suitable default value is auto-generated.</b> You should normally not need to pass this option.</p>"
       end
 
-      def visit_inputs(shape_ref, inputs)
-        return if inputs.include?(shape_ref['shape']) # recursion
-        inputs << shape_ref['shape']
+      def visit_shapes(shape_ref, shapes)
+        return if shapes.include?(shape_ref['shape']) # recursion
+        shapes << shape_ref['shape']
         s = shape(shape_ref)
         raise "cannot locate shape #{shape_ref['shape']}" if s.nil?
         case s['type']
         when 'structure'
           return if s['members'].nil?
           s['members'].each_pair do |_, member_ref|
-            visit_inputs(member_ref, inputs)
+            visit_shapes(member_ref, shapes)
           end
         when 'list'
-          visit_inputs(s['member'], inputs)
+          visit_shapes(s['member'], shapes)
         when 'map'
-          visit_inputs(s['key'], inputs)
-          visit_inputs(s['value'], inputs)
+          visit_shapes(s['key'], shapes)
+          visit_shapes(s['value'], shapes)
         end
       end
 
@@ -245,6 +270,8 @@ module AwsSdkCodeGenerator
           @members = options.fetch(:members)
           @documentation = options.fetch(:documentation)
           @sensitive_params = options.fetch(:sensitive_params)
+          @union = options.fetch(:union)
+          @members << StructMember.new(member_name: :unknown, member_class_name: 'Unknown') if @union
           if @members.nil? || @members.empty?
             @empty = true
           else
@@ -265,6 +292,11 @@ module AwsSdkCodeGenerator
         # @return [Array<Symbol>]
         attr_accessor :sensitive_params
 
+        # @return [Boolean]
+        def union?
+          @union
+        end
+
         # @return [Boolean]
         def empty?
           @empty
@@ -275,6 +307,7 @@ module AwsSdkCodeGenerator
 
         def initialize(options)
           @member_name = options.fetch(:member_name)
+          @member_class_name = AwsSdkCodeGenerator::Helper::pascal_case(@member_name)
           @sensitive = options.fetch(:sensitive, false)
           @last = false
         end
@@ -285,6 +318,9 @@ module AwsSdkCodeGenerator
         # @return [Boolean]
         attr_accessor :sensitive
 
+        # @return [String]
+        attr_accessor :member_class_name
+
         # @return [Boolean]
         attr_accessor :last
 

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'
@@ -76,7 +82,7 @@ module AwsSdkCodeGenerator
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
   WARNING_TXT

data/templates/async_client_class.mustache

@@ -3,11 +3,9 @@
 {{#generated_src_warning}}
 {{generated_src_warning}}
 {{/generated_src_warning}}
-if RUBY_VERSION >= '2.1'
-  begin
-    require 'http/2'
-  rescue LoadError; end
-end
+begin
+  require 'http/2'
+rescue LoadError; end
 {{#plugin_requires}}
 require '{{.}}'
 {{/plugin_requires}}
@@ -68,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,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