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

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

@@ -27,23 +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,
+        '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,
-        'error' => false,
         'deprecated' => false,
         'deprecatedMessage' => false,
         'type' => false,
@@ -51,7 +54,6 @@ module AwsSdkCodeGenerator
         'members' => false,
         'member' => false,
         'key' => false,
-        'locationName' => false,
         'value' => false,
         'required' => false,
         'enum' => false,
@@ -67,27 +69,29 @@ module AwsSdkCodeGenerator
       }
 
       METADATA_KEYS = {
-        # keep all
+        # keep
         'endpointPrefix' => true,
         'signatureVersion' => true,
+        'auth' => true,
         'signingName' => true,
         'serviceFullName' => true,
         'protocol' => true,
+        'protocols' => true,
         '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
@@ -98,6 +102,7 @@ module AwsSdkCodeGenerator
       # @return [String|nil]
       def generated_src_warning
         return if @service.protocol == 'api-gateway'
+
         GENERATED_SRC_WARNING
       end
 
@@ -187,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
@@ -204,12 +213,18 @@ module AwsSdkCodeGenerator
             if operation.key?('httpChecksum')
               operation['httpChecksum']['requestAlgorithmMember'] = underscore(operation['httpChecksum']['requestAlgorithmMember']) if operation['httpChecksum']['requestAlgorithmMember']
               operation['httpChecksum']['requestValidationModeMember'] = underscore(operation['httpChecksum']['requestValidationModeMember']) if operation['httpChecksum']['requestValidationModeMember']
-
               o.http_checksum = operation['httpChecksum'].inject([]) do |a, (k, v)|
                 a << { key: k.inspect, value: v.inspect }
                 a
               end
             end
+
+            if operation.key?('requestcompression')
+              o.request_compression = operation['requestcompression'].each_with_object([]) do |(k, v), arr|
+                arr << { key: k.inspect, value: v.inspect }
+              end
+            end
+
             %w(input output).each do |key|
               if operation[key]
                 o.shape_references << "o.#{key} = #{operation_ref(operation[key])}"
@@ -240,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' &&
@@ -250,6 +267,7 @@ module AwsSdkCodeGenerator
 
       def apig_authorizer
         return nil unless @service.api.key? 'authorizers'
+
         @service.api['authorizers'].map do |name, authorizer|
           Authorizer.new.tap do |a|
             a.name = name
@@ -298,9 +316,16 @@ module AwsSdkCodeGenerator
         args << "name: '#{shape_name}'"
         shape.each_pair do |key, value|
           if SHAPE_KEYS[key]
+            # only query protocols have custom error code
+            next if @service.protocol != 'query' && key == 'error'
+
             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(', ')
@@ -491,8 +516,16 @@ module AwsSdkCodeGenerator
           options = {}
           metadata.each_pair do |key, value|
             next if key == 'resultWrapper'
+
             if key == 'locationName'
-              options[:location_name] = value.inspect
+              options[:location_name] =
+                # use the xmlName on shape if defined
+                if (@service.protocol == 'rest-xml') &&
+                   (shape_location_name = @service.api['shapes'][shape_name]['locationName'])
+                  shape_location_name.inspect
+                else
+                  value.inspect
+                end
             else
               options[:metadata] ||= {}
               options[:metadata][key] = value.inspect
@@ -551,6 +584,9 @@ module AwsSdkCodeGenerator
         # @return [Hash]
         attr_accessor :http_checksum
 
+        # @return [Hash]
+        attr_accessor :request_compression
+
         # @return [Array<String>]
         attr_accessor :shape_references
 
@@ -572,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
 

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

@@ -27,10 +27,14 @@ module AwsSdkCodeGenerator
         @gem_version = options.fetch(:gem_version)
         @plugins = PluginList.new(options)
         @codegenerated_plugins = options.fetch(:codegenerated_plugins, [])
+        @default_plugins = Seahorse::Client::Base.plugins.map do |plugin|
+          PluginList::Plugin.new(class_name: plugin.name, options: plugin.options, path: '')
+        end
         @client_constructor = ClientConstructor.new(
           options.merge(
             plugins: @plugins,
-            codegenerated_plugins: @codegenerated_plugins))
+            codegenerated_plugins: @codegenerated_plugins,
+            default_plugins: @default_plugins))
         @operations = ClientOperationList.new(options).to_a
         @waiters = Waiter.build_list(options[:waiters])
         @custom = options.fetch(:custom)

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

@@ -9,7 +9,7 @@ module AwsSdkCodeGenerator
         @service = options.fetch(:service)
         if (parameters = @service.endpoint_rules&.fetch('parameters'))
           @parameters = parameters.map do |k,p|
-            EndpointParameter.new(k, p)
+            EndpointParameter.new(k, p, @service)
           end
         end
       end
@@ -17,6 +17,11 @@ module AwsSdkCodeGenerator
       # @return [Array<EndpointParameter>]
       attr_reader :parameters
 
+      # @return [Array<EndpointParameter>]
+      def config_parameters
+        parameters.select { |p| p.source == 'config' }
+      end
+
       # @return [String|nil]
       def generated_src_warning
         return if @service.protocol == 'api-gateway'
@@ -26,55 +31,6 @@ module AwsSdkCodeGenerator
       def module_name
         @service.module_name
       end
-
-      class EndpointParameter
-        def initialize(name, definition={})
-          @name = name
-          @type = definition['type']
-          @built_in = definition['builtIn']
-          @default = definition['default']
-          @required = definition['required']
-          @documentation = "# @!attribute #{underscore_name}\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,Boolean]
-        attr_reader :default
-
-        def default?
-          !@default.nil?
-        end
-
-        def boolean_default?
-          default? && (@default == true || @default == false)
-        end
-
-        def underscore_name
-          Underscore.underscore(name)
-        end
-      end
-
     end
   end
 end

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

@@ -9,6 +9,11 @@ module AwsSdkCodeGenerator
       def initialize(options)
         @service = options.fetch(:service)
         @endpoint_rules = @service.endpoint_rules
+        # Used to collect metrics in the generated endpoint provider
+        @has_account_id_endpoint_mode =
+          @endpoint_rules['parameters'].find do |_, param|
+            param['builtIn'] == 'AWS::Auth::AccountIdEndpointMode'
+          end
 
         version = @endpoint_rules['version']
         return if version&.match(/^\d+\.\d+$/) # && version == '1.0'
@@ -76,6 +81,10 @@ module AwsSdkCodeGenerator
         if endpoint['properties']
           res << ", properties: #{templated_hash_to_s(endpoint['properties'])}"
         end
+        if @has_account_id_endpoint_mode
+          account_id_endpoint = endpoint['url'].include?('{AccountId}')
+          res << ", metadata: { account_id_endpoint: #{account_id_endpoint} }"
+        end
         res << ")\n"
         indent(res.string, levels)
       end

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

@@ -10,11 +10,12 @@ module AwsSdkCodeGenerator
         @parameters = @service.endpoint_rules.fetch('parameters', {})
 
         @endpoint_classes = @service.api['operations'].each.with_object([]) do
-          |(name, op), array|
-          array << EndpointClass.new(
+          |(name, op), classes|
+          endpoint_class = EndpointClass.new(
             name: name,
             parameters: endpoint_parameters_for_operation(op)
           )
+          classes << endpoint_class unless endpoint_class.parameters.empty?
         end
       end
 
@@ -31,147 +32,40 @@ module AwsSdkCodeGenerator
         @service.module_name
       end
 
+      def operation_specific_parameters?
+        @endpoint_classes.empty?
+      end
+
       class EndpointClass
         def initialize(options)
           @name = options[:name]
+          @operation = Underscore.underscore(@name)
           @parameters = options[:parameters]
         end
 
         # @return [String]
         attr_reader :name
 
-        # @return [Array<EndpointParameter>]
-        attr_reader :parameters
-
-        def has_endpoint_built_in?
-          parameters.any? { |p| p.param_data['builtIn'] == 'SDK::Endpoint' }
-        end
-      end
-
-      class EndpointParameter
-        def initialize(options)
-          @key = options[:key]
-          @value = options[:value]
-          @source = options[:source]
-          @param_data = options[:param_data]
-        end
-
-        # @return [String]
-        attr_accessor :key
-
-        # @return [String]
-        attr_accessor :value
-
         # @return [String]
-        attr_accessor :source
+        attr_reader :operation
 
-        # @return [Hash]
-        attr_accessor :param_data
-
-        def static_string?
-          @source == 'staticContextParam' && value.is_a?(String)
-        end
+        # @return [Array<EndpointParameter>]
+        attr_reader :parameters
       end
 
-
       private
 
       def endpoint_parameters_for_operation(operation)
-        @parameters.each.with_object([]) do |(param_name, param_data), endpoint_parameters|
-          value, source = endpoint_parameter_value(
-            operation, param_name, param_data
-          )
-
-          endpoint_parameters << EndpointParameter.new(
-            key: Underscore.underscore(param_name),
-            value: value,
-            source: source,
-            param_data: param_data
+        @parameters.each.with_object([]) do |(param_name, param_data), parameters|
+          p = EndpointParameter.new(
+            param_name,
+            param_data,
+            @service,
+            operation
           )
+          parameters << p if p.source == 'operation'
         end
       end
-
-      # Most to least
-      # staticContextParams
-      # contextParam
-      # clientContextParams
-      # Built-In Bindings
-      # Built-in binding default values
-      def endpoint_parameter_value(operation, param_name, param_data)
-        value, source = [
-          static_context_param(operation, param_name), 'staticContextParam'
-        ]
-        value, source = [
-          context_param_value(operation, param_name), 'contextParam'
-        ] unless value
-        value, source = [
-          client_context_param_value(param_name, param_data),
-          'clientContextParam'
-        ] unless value
-        value, source = [
-          built_in_client_context_param_value(param_data), 'builtIn'
-        ] unless value
-
-        [value || 'nil', source]
-      end
-
-      def client_context_param_value(param_name, param_data)
-        if @service.api['clientContextParams']&.key?(param_name) &&
-           !param_data['builtIn']
-          "context.config.#{Underscore.underscore(param_name)}"
-        end
-      end
-
-      def built_in_client_context_param_value(param_data)
-        case param_data['builtIn']
-        when 'AWS::Region'
-          'context.config.region'
-        when 'AWS::UseFIPS'
-          'context.config.use_fips_endpoint'
-        when 'AWS::UseDualStack'
-          if @service.name == 'S3' || @service.name == 'S3Control'
-            'context[:use_dualstack_endpoint]'
-          else
-            'context.config.use_dualstack_endpoint'
-          end
-        when 'AWS::STS::UseGlobalEndpoint'
-          "context.config.sts_regional_endpoints == 'legacy'"
-        when 'AWS::S3::UseGlobalEndpoint'
-          "context.config.s3_us_east_1_regional_endpoint == 'legacy'"
-        when 'AWS::S3::Accelerate'
-          if @service.name == 'S3' || @service.name == 'S3Control'
-            'context[:use_accelerate_endpoint]'
-          else
-            'context.config.use_accelerate_endpoint'
-          end
-        when 'AWS::S3::ForcePathStyle'
-          'context.config.force_path_style'
-        when 'AWS::S3::UseArnRegion', 'AWS::S3Control::UseArnRegion'
-          'context.config.s3_use_arn_region'
-        when 'AWS::S3::DisableMultiRegionAccessPoints'
-          'context.config.s3_disable_multiregion_access_points'
-        when 'SDK::Endpoint'
-          'endpoint'
-        end
-      end
-
-      def context_param_value(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 static_context_param(operation, param_name)
-        operation.fetch('staticContextParams', {})
-                 .fetch(param_name, {}).fetch('value', nil)
-      end
     end
   end
 end

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

@@ -6,15 +6,25 @@ module AwsSdkCodeGenerator
       # @option options [required, Service] :service
       def initialize(options)
         @service = options.fetch(:service)
-        if (client_options = @service.api['clientContextParams'])
-          endpoint_parameters = @service.endpoint_rules.fetch('parameters', {})
+        endpoint_parameters = @service.endpoint_rules.fetch('parameters', {})
+
+        # HACK: AccountIdEndpointMode should likely be a client context
+        # param, but it's a built in that should be per-service.
+        @endpoint_options = []
+        endpoint_parameters.each do |_key, data|
+          next unless data['builtIn'] == 'AWS::Auth::AccountIdEndpointMode'
 
-          @endpoint_options = client_options.each.with_object([]) do |(name, _data), array|
+          @endpoint_options << account_id_endpoint_mode_option
+          @account_id_endpoint_mode = true
+        end
+
+        if (client_options = @service.api['clientContextParams'])
+          client_options.each do |name, _data|
             param_data = endpoint_parameters[name]
 
             next if param_data['builtIn']
 
-            array << EndpointOption.new(
+            @endpoint_options << EndpointOption.new(
               name: Underscore.underscore(name),
               docstring: param_data['documentation'],
               doc_type: param_data['type'],
@@ -22,6 +32,7 @@ module AwsSdkCodeGenerator
             )
           end
         end
+
         @endpoint_classes = @service.api['operations'].each.with_object([]) do
           |(op, _api), array|
           array << EndpointClass.new(
@@ -47,6 +58,37 @@ module AwsSdkCodeGenerator
         @service.module_name
       end
 
+      def has_account_id_endpoint_mode?
+        @account_id_endpoint_mode
+      end
+
+      private
+
+      def account_id_endpoint_mode_option
+        docstring = <<-DOCSTRING.chomp
+The account ID endpoint mode to use. This can be one of the following values:
+* `preferred` - The default behavior. Use the account ID endpoint if
+  available, otherwise use the standard endpoint.
+* `disabled` - Never use the account ID endpoint. Only use the standard
+  endpoint.
+* `required` - Always use the account ID endpoint. If the account ID
+  cannot be retrieved from credentials, an error is raised.
+        DOCSTRING
+
+        default = <<-DEFAULT.chomp
+value = ENV['AWS_ACCOUNT_ID_ENDPOINT_MODE']
+        value ||= Aws.shared_config.account_id_endpoint_mode(profile: cfg.profile)
+        value || 'preferred'
+        DEFAULT
+
+        EndpointOption.new(
+          name: 'account_id_endpoint_mode',
+          docstring: docstring,
+          doc_type: 'String',
+          default: default
+        )
+      end
+
       class EndpointClass
         def initialize(options)
           @operation_name = options[:operation_name]

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

@@ -23,10 +23,31 @@ module AwsSdkCodeGenerator
         GENERATED_SRC_WARNING
       end
 
+      # @return [String]
       def module_name
         @service.module_name
       end
 
+      # @return [Boolean]
+      def customization_file_exists?
+        File.exist?(
+          File.join(
+            Helper.gem_lib_path(gem_name), "#{customization_file_path}.rb"
+          )
+        )
+      end
+
+      # @return [String]
+      def customization_file_path
+        "#{gem_name}/customizations/errors"
+      end
+
+      private
+
+      # @return [String]
+      def gem_name
+        "aws-sdk-#{module_name.split('::').last.downcase}"
+      end
     end
   end
 end

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

@@ -99,9 +99,15 @@ module AwsSdkCodeGenerator
             ).to_s
           end
           param_hash_str = Docstring.join_docstrings([option_tags], block_comment: false)
+          param_hash =
+            if param_hash_str.nil?
+              '# This event has no members'
+            else
+              Docstring.indent(param_hash_str, '      ')
+            end
           m << EventEntry.new(
             name: underscore(n),
-            param_hash: Docstring.indent(param_hash_str, '      ')
+            param_hash: param_hash
           )
           m
         end