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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3332820d3c044afc9813a785b511cc25fcce3581477a3f05f860bf49bb225ffe
-  data.tar.gz: '09ed058cda2368a87496efc47772d019dfb3f1911732c344c9146af6a51f68fe'
+  metadata.gz: 7a56cc48e83d1c1b3f3c4abf956e29fdd7adb2aed45c2ff8d69b8489ad569518
+  data.tar.gz: 5ff9d87ff0f38a08370358ccccd6bf9e69f0e77da2bcba60b1042501fead60d7
 SHA512:
-  metadata.gz: 4de3ecc3f1f0ff599143e79808c395aa82319da3af73f9c9b87c1d6526f438feb4471e52d68e8559a027223d523c21d89250e2e212c83a53a52c41726a8df7e3
-  data.tar.gz: 9b6d2456bb9bd9fbff1e7beb50c0f93a8137e1eb249cf931107e0f1dca7dc0f92b57da5d011a199900c03a5cd6d6f53b7fd7387cafead162f7aa892dffaea76f
+  metadata.gz: be96b1aa147f0e2a8bdf45c383feaa21511d81c6129e648cc5fc488f1f19808aee62ec78916c2f9a9a5e3060dcc12bdb61a1e9a890af21c3ee610438997e3798
+  data.tar.gz: c4f0731f69dd91ddcd4498363cb149ee361cfe452c8cbe6c8e7e05d85586bf11b84494a4ececd41f0308ce1dfb612aa3e032575f9abca3566f6476f6857d1a67

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

@@ -131,7 +131,8 @@ module AwsSdkCodeGenerator
       # @return [Boolean]
       def streaming_input?(shape, operation)
         shape['streaming'] && operation &&
-          operation['authtype'] == "v4-unsigned-body"
+          (operation['unsignedPayload'] ||
+          operation['authtype'] == 'v4-unsigned-body')
       end
 
       def plural?(resource)

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

@@ -16,6 +16,7 @@ module AwsSdkCodeGenerator
       @method_name = options.fetch(:method_name)
       @operation = options.fetch(:operation)
       @api = options.fetch(:api)
+      @protocol = options.fetch(:protocol)
       @client_examples = options.fetch(:client_examples, [])
       @examples = options.fetch(:examples)
       @module_name = options.fetch(:module_name)
@@ -279,7 +280,7 @@ module AwsSdkCodeGenerator
 
     def see_also_tag(operation, api)
       uid = api['metadata']['uid']
-      if api['metadata']['protocol'] != 'api-gateway' && Crosslink.taggable?(uid)
+      if @protocol != 'api-gateway' && Crosslink.taggable?(uid)
         "# " + Crosslink.tag_string(uid, operation)
       end
     end

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

@@ -9,6 +9,7 @@ module AwsSdkCodeGenerator
       api = options.fetch(:api)
       examples = options.fetch(:examples, {})
       module_name = options.fetch(:module_name)
+      protocol = options.fetch(:protocol)
       protocol_settings = options.fetch(:protocol_settings, {})
       client_examples = options.fetch(:client_examples, {})
       paginators = options.fetch(:paginators, {})
@@ -41,6 +42,7 @@ module AwsSdkCodeGenerator
                   method_name: method_name,
                   operation: operation,
                   api: api,
+                  protocol: protocol,
                   examples: examples,
                   client_examples: client_examples[method_name] || [],
                   async_client: true
@@ -60,6 +62,7 @@ module AwsSdkCodeGenerator
                 method_name: method_name,
                 operation: operation,
                 api: api,
+                protocol: protocol,
                 examples: examples,
                 client_examples: client_examples[method_name] || [],
                 async_client: false
@@ -80,6 +83,7 @@ module AwsSdkCodeGenerator
               method_name: method_name,
               operation: operation,
               api: api,
+              protocol: protocol,
               examples: examples,
               client_examples: client_examples[method_name] || [],
               async_client: false,

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

@@ -185,13 +185,13 @@ module AwsSdkCodeGenerator
       Views::ClientClass.new(
         service_identifier: @service.identifier,
         service_name: @service.name,
+        protocol: @service.protocol,
         protocol_settings: @service.protocol_settings,
         module_name: @service.module_name,
         gem_name: @service.gem_name,
         gem_version: @service.gem_version,
         aws_sdk_core_lib_path: @aws_sdk_core_lib_path,
         client_examples: @client_examples,
-        protocol: @service.protocol,
         signature_version: @service.signature_version,
         require_endpoint_discovery: @service.require_endpoint_discovery,
         add_plugins: @service.add_plugins,
@@ -210,12 +210,12 @@ module AwsSdkCodeGenerator
       Views::AsyncClientClass.new(
         service_identifier: @service.identifier,
         service_name: @service.name,
+        protocol: @service.protocol,
         protocol_settings: @service.protocol_settings,
         module_name: @service.module_name,
         gem_name: @service.gem_name,
         gem_version: @service.gem_version,
         aws_sdk_core_lib_path: @aws_sdk_core_lib_path,
-        protocol: @service.protocol,
         signature_version: @service.signature_version,
         add_plugins: @service.add_plugins,
         remove_plugins: @service.remove_plugins,

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

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  class EndpointParameter
+    def initialize(name, definition, service, operation=nil)
+      @name = name
+
+      @value, @source = endpoint_parameter_value(name, definition, service, operation)
+
+      @type = definition['type']
+      @built_in = definition['builtIn']
+      @default = definition['default']
+      @required = definition['required']
+      @documentation = "# @!attribute #{key}\n"
+      if definition['documentation']
+        @documentation += "  #   #{definition['documentation']}\n"
+      end
+      if deprecated = definition['deprecated']
+        @documentation += "  #\n  #   @deprecated\n"
+        if deprecated['message']
+          @documentation += "  #     #{deprecated['message']}\n"
+        end
+        if deprecated['since']
+          @documentation += "  #     Since: #{deprecated['since']}\n"
+        end
+      end
+      @documentation += "  #\n  #   @return [#{@type}]\n  #"
+    end
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :documentation
+
+    # @return [Boolean]
+    attr_reader :required
+
+    # @return [String]
+    attr_reader :source
+
+    # @return [String]
+    attr_reader :value
+
+    # @return [String,Boolean,Array]
+    def default
+      case @default
+      when String
+        "\"#{@default}\""
+      else
+        @default.to_s
+      end
+    end
+
+    def default?
+      !@default.nil?
+    end
+
+    def validate_required?
+      required && !default?
+    end
+
+    def key
+      Underscore.underscore(name)
+    end
+
+    private
+
+    # Most to least
+    # staticContextParams
+    # contextParam
+    # operationContextParams
+    # clientContextParams (always sourced from config)
+    # Built-In Bindings (sourced from config in most cases, context in some cases to allow operation level overrides)
+    # Built-in binding default values
+    # @retyrn [value, source].  source may be one of [operation, config, default]
+    def endpoint_parameter_value(param_name, param_data, service, operation)
+      unless operation.nil?
+        value, source = [
+          static_context_param(operation, param_name), 'operation'
+        ]
+        value, source = [
+          context_param_value(service, operation, param_name), 'operation'
+        ] unless value
+        value, source = [
+          operation_context_param_value(operation, param_name), 'operation'
+        ] unless value
+      end
+
+      value, source = [
+        client_context_param_value(service, param_name, param_data),
+        'config'
+      ] unless value
+
+
+      # built-ins may be sourced from operation context in some cases
+      unless value
+        value, source = built_in_param_value(service, param_data)
+      end
+
+      [value || 'nil', source || 'default']
+    end
+
+    def client_context_param_value(service, param_name, param_data)
+      if service.api['clientContextParams']&.key?(param_name) &&
+        !param_data['builtIn']
+        "config.#{Underscore.underscore(param_name)}"
+      end
+    end
+
+    # built-ins may be sourced from operation context in some cases
+    def built_in_param_value(service, param_data)
+      source = 'config'
+      value =
+        case param_data['builtIn']
+        when 'AWS::Region'
+          'config.region'
+        when 'AWS::UseFIPS'
+          'config.use_fips_endpoint'
+        when 'AWS::UseDualStack'
+          if service.name == 'S3' || service.name == 'S3Control'
+            source = 'operation'
+            'context[:use_dualstack_endpoint]'
+          else
+            'config.use_dualstack_endpoint'
+          end
+        when 'AWS::Auth::AccountId'
+          'config.credentials.credentials.account_id'
+        when 'AWS::Auth::AccountIdEndpointMode'
+          'config.account_id_endpoint_mode'
+        when 'AWS::STS::UseGlobalEndpoint'
+          "config.sts_regional_endpoints == 'legacy'"
+        when 'AWS::S3::UseGlobalEndpoint'
+          "config.s3_us_east_1_regional_endpoint == 'legacy'"
+        when 'AWS::S3::Accelerate'
+          if service.name == 'S3' || service.name == 'S3Control'
+            source = 'operation'
+            'context[:use_accelerate_endpoint]'
+          else
+            'config.use_accelerate_endpoint'
+          end
+        when 'AWS::S3::ForcePathStyle'
+          'config.force_path_style'
+        when 'AWS::S3::UseArnRegion', 'AWS::S3Control::UseArnRegion'
+          'config.s3_use_arn_region'
+        when 'AWS::S3::DisableMultiRegionAccessPoints'
+          'config.s3_disable_multiregion_access_points'
+        when 'SDK::Endpoint'
+          '(config.endpoint.to_s unless config.regional_endpoint)'
+        else
+          source = nil
+          nil # no value, not a default
+        end
+      [value, source]
+    end
+
+    def context_param_value(service, operation, param_name)
+      return nil unless operation['input']
+
+      input_shape = operation['input']['shape']
+      members = service.api['shapes'][input_shape].fetch('members', {})
+      members.detect do |(member_name, member)|
+        context_param = member.fetch('contextParam', {})
+        if context_param.fetch('name', nil) == param_name
+          break "context.params[:#{Underscore.underscore(member_name)}]"
+        end
+      end
+    end
+
+    def operation_context_param_value(operation, param_name)
+      return nil unless operation['input']
+
+      binding = operation.fetch('operationContextParams', {})[param_name]
+
+      return nil unless binding
+
+      "JMESPath.search(\"#{Underscore.underscore_jmespath(binding['path'])}\", context.params)"
+    end
+
+    def static_context_param(operation, param_name)
+      value = operation.fetch('staticContextParams', {})
+               .fetch(param_name, {}).fetch('value', nil)
+      if !value.nil? && value.is_a?(String)
+        "\"#{value}\""
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -175,8 +175,18 @@ module AwsSdkCodeGenerator
       str.gsub(/(.{1,#{width}})(\s+|\Z)/, "#{indent}\\1\n").chomp
     end
 
+    def gem_lib_path(gem_name)
+      File.expand_path(
+        File.join(
+          __dir__,
+          "../../../../gems/#{gem_name}/lib/"
+        )
+      )
+    end
+
     module_function :deep_copy, :operation_streaming?, :downcase_first, :wrap_string, :apig_prefix,
-      :eventstream_output?, :eventstream_input?, :operation_eventstreaming?, :pascal_case
+      :eventstream_output?, :eventstream_input?, :operation_eventstreaming?, :pascal_case,
+      :gem_lib_path
 
   end
 end

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

@@ -63,7 +63,8 @@ module AwsSdkCodeGenerator
         'Aws::Plugins::ChecksumAlgorithm' => "#{core_plugins}/checksum_algorithm.rb",
         'Aws::Plugins::RequestCompression' => "#{core_plugins}/request_compression.rb",
         'Aws::Plugins::DefaultsMode' => "#{core_plugins}/defaults_mode.rb",
-        'Aws::Plugins::RecursionDetection' => "#{core_plugins}/recursion_detection.rb"
+        'Aws::Plugins::RecursionDetection' => "#{core_plugins}/recursion_detection.rb",
+        'Aws::Plugins::Telemetry' => "#{core_plugins}/telemetry.rb"
       }
     end
 
@@ -86,6 +87,7 @@ module AwsSdkCodeGenerator
         'rest-xml'  => { 'Aws::Plugins::Protocols::RestXml' => "#{core_plugins}/protocols/rest_xml.rb" },
         'query'     => { 'Aws::Plugins::Protocols::Query' => "#{core_plugins}/protocols/query.rb" },
         'ec2'       => { 'Aws::Plugins::Protocols::EC2' => "#{core_plugins}/protocols/ec2.rb" },
+        'smithy-rpc-v2-cbor' => { 'Aws::Plugins::Protocols::RpcV2' => "#{core_plugins}/protocols/rpc_v2.rb" },
         'api-gateway' => {
           'Aws::Plugins::Protocols::ApiGateway' => "#{core_plugins}/protocols/api_gateway.rb",
           'Aws::Plugins::ApiKey' => "#{core_plugins}/api_key.rb",

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

@@ -15,7 +15,7 @@ module AwsSdkCodeGenerator
       parts << 'batch_enum.each do |batch|'
       parts << initialize_params
       parts << apply_params_per_batch
-      parts << "  Aws::Plugins::UserAgent.feature('resource') do"
+      parts << "  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do"
       parts << "    batch[0].client.#{client_method}(params)"
       parts << '  end'
       parts << 'end'

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

@@ -15,7 +15,7 @@ module AwsSdkCodeGenerator
         parts = []
         parts << request_options(params) if merge
         parts << assignment(options)
-        parts << "Aws::Plugins::UserAgent.feature('resource') do\n"
+        parts << "Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do\n"
         parts << "  @client."
         parts << operation_name(request)
         parts << arguments(merge, params, streaming)

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

@@ -54,7 +54,7 @@ module AwsSdkCodeGenerator
         ).to_s.strip
         parts = []
         parts << 'resp = ' if waiter['path']
-        parts << "Aws::Plugins::UserAgent.feature('resource') do\n"
+        parts << "Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do\n"
         parts << "  waiter.wait(params.merge(#{args}))"
         parts << "\nend"
         parts.join

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

@@ -2,12 +2,26 @@
 
 module AwsSdkCodeGenerator
   class Service
+    # Ordered priority list of supported protocols
+    # api-gateway is a special case and is always first.
+    SUPPORTED_PROTOCOLS = %w[
+      api-gateway
+      smithy-rpc-v2-cbor
+      json_1.0
+      json_1.1
+      rest-json
+      rest-xml
+      query
+      ec2
+    ]
 
     # @param [Hash] options
-    # @option options [required, String] :gem_version Gem version, e.g. "1.0.0".
     # @option options [required, String] :name The service name, e.g. "S3"
     # @option options [String] :module_name The service module name, defaults
     #   to "Aws::#{name}", e.g. "Aws::S3".
+    # @option options [String] :gem_name The gem name, defaults to
+    #  "aws-sdk-#{name}", e.g. "aws-sdk-s3".
+    # @option options [required, String] :gem_version Gem version, e.g. "1.0.0".
     # @option options [required, Hash, String] :api
     # @option options [Hash, String] :docs
     # @option options [Hash, String] :paginators
@@ -21,44 +35,49 @@ module AwsSdkCodeGenerator
     # @option options [Hash] :add_plugins ({})
     # @option options [Hash] :remove_plugins ([])
     # @option options [Boolean] :deprecated (false)
+    # @option options [String] :default_endpoint (nil)
+    # @option options [String] :endpoints_key (nil)
     def initialize(options)
       @name = options.fetch(:name)
       @identifier = name.downcase
       @module_name = options[:module_name] || "Aws::#{name}"
       @gem_name = options[:gem_name] || "aws-sdk-#{identifier}"
       @gem_version = options.fetch(:gem_version)
+
       @api = load_json(options.fetch(:api))
-      unless @api['metadata']['protocol'] == 'api-gateway'
-        # Dont reply on API Gateway doc.json
+
+      # computed attributes
+      metadata = @api.fetch('metadata')
+      @protocol = select_protocol(metadata)
+      @protocol_settings = metadata['protocolSettings'] || {}
+      @api_version = metadata['apiVersion']
+      @signature_version = metadata['signatureVersion']
+      @auth = api.fetch('metadata')['auth']
+      @full_name = metadata['serviceFullName']
+      @short_name = metadata['serviceAbbreviation'] || @full_name
+
+      # Dont reply on API Gateway doc.json
+      unless @protocol == 'api-gateway'
         ApplyDocs.new(@api).apply(load_json(options[:docs]))
       end
       @paginators = load_json(options[:paginators])
       @waiters = load_json(options[:waiters])
       @resources = load_json(options[:resources])
       @examples = load_json(options[:examples])
-      @smoke_tests = load_json(options[:smoke_tests])
       unless options[:legacy_endpoints]
         @endpoint_rules = load_json(options[:endpoint_rules])
         @endpoint_tests = load_json(options[:endpoint_tests])
       end
+      @smoke_tests = load_json(options[:smoke_tests])
+
       @gem_dependencies = options[:gem_dependencies] || {}
       @add_plugins = options[:add_plugins] || {}
       @remove_plugins = options[:remove_plugins] || []
+      @deprecated = options[:deprecated] || false
+      @default_endpoint = options[:default_endpoint] # APIG custom service only
       @endpoints_key = options.fetch(:endpoints_key, nil)
-      # APIG custom service only
-      @default_endpoint = options[:default_endpoint]
 
-      # computed attributes
-      @protocol = api.fetch('metadata').fetch('protocol')
-      @protocol_settings = api.fetch('metadata')['protocolSettings'] || {}
-      @api_version = api.fetch('metadata')['apiVersion']
-      @signature_version = api.fetch('metadata')['signatureVersion']
-      @full_name = api.fetch('metadata')['serviceFullName']
-      @short_name = api.fetch('metadata')['serviceAbbreviation'] || @full_name
-      @require_endpoint_discovery = api.fetch('operations', []).any? do |_, o|
-        o['endpointdiscovery'] && o['endpointdiscovery']['required']
-      end
-      @deprecated = options[:deprecated] || false
+      @require_endpoint_discovery = endpoint_discovery_required?
     end
 
     # @return [String] The service name, e.g. "S3"
@@ -129,6 +148,9 @@ module AwsSdkCodeGenerator
     # @return [String] The service protocol, e.g. "json", "query", etc.
     attr_reader :protocol
 
+    # @return [Array<String>] The list of supported protocols
+    attr_reader :protocols
+
     # @return [Hash] The service protocol settings
     attr_reader :protocol_settings
 
@@ -138,6 +160,9 @@ module AwsSdkCodeGenerator
     # @return [String] The signature version, e.g. "v4"
     attr_reader :signature_version
 
+    # @return [Array<String>] A list of supported auth types
+    attr_reader :auth
+
     # @return [String] The full product name for the service,
     #   e.g. "Amazon Simple Storage Service".
     attr_reader :full_name
@@ -174,6 +199,29 @@ module AwsSdkCodeGenerator
 
     private
 
+    def select_protocol(metadata)
+      protocols = metadata.fetch('protocols', [metadata['protocol']])
+      protocol = SUPPORTED_PROTOCOLS.find do |supported_protocol|
+        if %w[json_1.0 json_1.1].include?(supported_protocol)
+          supported_protocol, version = supported_protocol.split('_')
+        end
+
+        if protocols.include?(supported_protocol) &&
+           (version.nil? || version == metadata['jsonVersion'])
+          return supported_protocol
+        end
+      end
+      return protocol if protocol
+
+      raise "unsupported protocols `#{protocols.join(', ')}'"
+    end
+
+    def endpoint_discovery_required?
+      @api.fetch('operations', []).any? do |_, o|
+        o['endpointdiscovery'] && o['endpointdiscovery']['required']
+      end
+    end
+
     def load_json(value)
       case value
       when nil then nil

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

@@ -27,25 +27,26 @@ module AwsSdkCodeGenerator
       SHAPE_KEYS = {
         # keep
         'flattened' => true,
-        'timestampFormat' => true, # glacier api customization
+        'timestampFormat' => true,
         'xmlNamespace' => true,
-        'streaming' => true, # transfer-encoding
-        'requiresLength' => true, # transfer-encoding
-        'union' => false, # should remain false
+        'streaming' => true,
+        'requiresLength' => true,
+        'union' => false, # handled separately - should remain false
         'document' => true,
         'jsonvalue' => true,
-        'error' => true, # parsing customized error code in query protocol
-        'locationName' => true, # to recognize xmlName defined on shape
+        'error' => true,
+        'locationName' => true,
+        # ignore
         # event stream modeling
         'event' => false,
         'eventstream' => false,
         'eventheader' => false,
         'eventpayload' => false,
-        # ignore
+        'exceptionEvent' => false, # internal, exceptions cannot be events
+        # other
         'synthetic' => false,
         'box' => false,
         'fault' => false,
-        'exception_event' => false, # internal, exceptions cannot be events
         'deprecated' => false,
         'deprecatedMessage' => false,
         'type' => false,
@@ -68,7 +69,7 @@ module AwsSdkCodeGenerator
       }
 
       METADATA_KEYS = {
-        # keep all
+        # keep
         'endpointPrefix' => true,
         'signatureVersion' => true,
         'auth' => true,
@@ -79,18 +80,18 @@ module AwsSdkCodeGenerator
         'targetPrefix' => true,
         'jsonVersion' => true,
         'errorPrefix' => true,
-        'timestampFormat' => true, # glacier api customization
+        'timestampFormat' => true,
         'xmlNamespace' => true,
-        'protocolSettings' => {}, # current unused unless for h2 exclude
+        'protocolSettings' => {},
         'serviceId' => true,
         'apiVersion' => true,
         'checksumFormat' => true,
         'globalEndpoint' => true,
         'serviceAbbreviation' => true,
         'uid' => true,
-        'awsQueryCompatible' => true, # AwsQuery migration
+        'awsQueryCompatible' => true,
         # ignore
-        'ripServiceName' => true
+        'ripServiceName' => false
       }
 
       # @option options [required, Service] :service
@@ -191,7 +192,11 @@ module AwsSdkCodeGenerator
               value: @service.api['metadata'][key].inspect
             }
           elsif METADATA_KEYS[key].nil?
-            raise "unhandled metadata key #{key.inspect}"
+            AwsSdkCodeGenerator.warn(
+              @service.service_id,
+              :invalid_key,
+              "unhandled metadata key `#{key}`"
+            )
           end
         end
         metadata
@@ -250,6 +255,8 @@ module AwsSdkCodeGenerator
             end
             o.authorizer = operation['authorizer'] if operation.key?('authorizer')
             o.authtype = operation['authtype'] if operation.key?('authtype')
+            o.unsigned_payload = operation['unsignedPayload'] if operation.key?('unsignedPayload')
+            o.auth = operation['auth'] if operation.key?('auth')
             o.require_apikey = operation['requiresApiKey'] if operation.key?('requiresApiKey')
             o.pager = pager(operation_name)
             o.async = @service.protocol_settings['h2'] == 'eventstream' &&
@@ -314,7 +321,11 @@ module AwsSdkCodeGenerator
 
             args << "#{key}: #{value.inspect}"
           elsif SHAPE_KEYS[key].nil?
-            raise "unhandled shape key #{key.inspect}"
+            AwsSdkCodeGenerator.warn(
+              @service.service_id,
+              :invalid_key,
+              "unhandled shape key `#{key}` on `#{shape_name}`"
+            )
           end
         end
         args.join(', ')
@@ -597,6 +608,12 @@ module AwsSdkCodeGenerator
         # @return [String,nil]
         attr_accessor :authtype
 
+        # @return [Boolean,nil]
+        attr_accessor :unsigned_payload
+
+        # @return [Array<String>]
+        attr_accessor :auth
+
         # @return [Boolean]
         attr_accessor :endpoint_trait