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

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/features/smoke.rb

@@ -85,13 +85,14 @@ module AwsSdkCodeGenerator
             when 'sigv4aRegionSet' then nil # TODO
             when 'uri' then ['endpoint', raw_value]
             when 'useFips' then ['use_fips_endpoint', raw_value]
-            when 'useDualStack' then ['use_dualstack_endpoint', raw_value]
+            when 'useDualstack' then ['use_dualstack_endpoint', raw_value]
             # service specific
             when 'useGlobalEndpoint'
               value = raw_value == 'true' ? 'legacy' : 'regional'
-              if @service.name == 'S3'
+              case @service.name
+              when 'S3'
                 ['s3_us_east_1_regional_endpoint', value]
-              elsif @service.name == 'STS'
+              when 'STS'
                 ['sts_regional_endpoints', value]
               end
             # s3 specific
@@ -104,7 +105,7 @@ module AwsSdkCodeGenerator
             when 'useAccountIdRouting' then nil # TODO
             else
               # catch all, possible code generated config options
-              [downcase(raw_key), raw_value]
+              [underscore(raw_key), raw_value]
             end
           end
 

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

@@ -138,7 +138,7 @@ module AwsSdkCodeGenerator
           grouped = buffer.group_by { |name, _| name }
           grouped.transform_values(&:count).find_all { |_, c| 1 < c }.each do |name,|
             case name
-            when :endpoint, :endpoint_provider, :retry_limit, :disable_s3_express_session_auth
+            when :endpoint, :endpoint_provider, :retry_limit, :disable_s3_express_session_auth, :account_id_endpoint_mode
               # ok
             else
               warn("Duplicate client option in #{@service_name}: `#{grouped[name].map { |g| g.values_at(0, 2) }}`", uplevel: 0)

data/lib/aws-sdk-code-generator/views/rbs/types_module.rb

@@ -31,7 +31,7 @@ module AwsSdkCodeGenerator
               # exceptions will not have the event trait.
               shape['members'].each do |name, ref|
                 if !!@service.api['shapes'][ref['shape']]['exception']
-                  @service.api['shapes'][ref['shape']]['exception_event'] = true
+                  @service.api['shapes'][ref['shape']]['exceptionEvent'] = true
                 end
               end
             end
@@ -90,7 +90,7 @@ module AwsSdkCodeGenerator
               returns: AwsSdkCodeGenerator::RBS.to_type(member_ref, @api)
             )
           end
-          if shape['event'] || shape['exception_event']
+          if shape['event'] || shape['exceptionEvent']
             members << StructMember.new(
               member_name: 'event_type',
               returns: 'untyped'

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

@@ -106,8 +106,30 @@ module AwsSdkCodeGenerator
         @identifiers.size > 0
       end
 
+      # @return [Boolean]
+      def customization_file_exists?
+        File.exist?(
+          File.join(
+            Helper.gem_lib_path(gem_name), "#{resource_customization}.rb"
+          )
+        )
+      end
+
+      # @return [String]
+      def resource_customization
+        "#{gem_name}/customizations/#{underscored_name}"
+      end
+
       private
 
+      def gem_name
+        "aws-sdk-#{module_name.split('::').last.downcase}"
+      end
+
+      def underscored_name
+        class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+      end
+
       def build_associations(options)
         ResourceAssociation.build_list(
           class_name: options.fetch(:class_name),

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

@@ -53,6 +53,25 @@ module AwsSdkCodeGenerator
         actions? || associations?
       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/resource"
+      end
+
+      private
+
+      def gem_name
+        "aws-sdk-#{module_name.split('::').last.downcase}"
+      end
     end
   end
 end

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

@@ -11,9 +11,12 @@ module AwsSdkCodeGenerator
       def initialize(options)
         @service = options.fetch(:service)
         @prefix = options.fetch(:prefix)
-        @codegenerated_plugins = options.fetch(:codegenerated_plugins)
+        @codegenerated_plugins = options.fetch(:codegenerated_plugins) || []
       end
 
+      # @return [String]
+      attr_reader :prefix
+
       # @return [String|nil]
       def generated_src_warning
         return if @service.protocol == 'api-gateway'
@@ -60,47 +63,57 @@ module AwsSdkCodeGenerator
         @service.included_in_core?
       end
 
-      # @return [Array<String>]
-      def relative_requires
-        paths = Set.new
-        paths << "#{@prefix}/types"
-        paths << "#{@prefix}/client_api"
+      # @return [String]
+      def service_identifier
+        @service.identifier
+      end
+
+      # @return [Array<Hash>] list of autoload path hashes with :path, :class_name and
+      # :is_plugin keys.
+      def autoloads
+        paths = []
+        paths << auto_load("#{@prefix}/types", :Types)
+        paths << auto_load("#{@prefix}/client_api", :ClientApi)
 
         # these must be required before the client
-        if @codegenerated_plugins
-          paths += @codegenerated_plugins.map { | p| p.path }
+        paths += @codegenerated_plugins.map do |p|
+          auto_load(p.path, p.class_name.split('::').last, true)
         end
 
-        paths << "#{@prefix}/client"
-        paths << "#{@prefix}/errors"
-        paths << "#{@prefix}/waiters" if @service.waiters
-        paths << "#{@prefix}/resource"
+        paths << auto_load("#{@prefix}/client", :Client)
+        paths << auto_load("#{@prefix}/errors", :Errors)
+        paths << auto_load("#{@prefix}/waiters", :Waiters) if @service.waiters
+        paths << auto_load("#{@prefix}/resource", :Resource)
 
         unless @service.legacy_endpoints?
-          paths << "#{@prefix}/endpoint_parameters"
-          paths << "#{@prefix}/endpoint_provider"
-          paths << "#{@prefix}/endpoints"
+          paths << auto_load("#{@prefix}/endpoint_parameters", :EndpointParameters)
+          paths << auto_load("#{@prefix}/endpoint_provider", :EndpointProvider)
+          paths << auto_load("#{@prefix}/endpoints", :Endpoints)
         end
 
         if @service.resources && @service.resources['resources']
           @service.resources['resources'].keys.each do |resource_name|
             path = "#{@prefix}/#{underscore(resource_name)}"
-            if paths.include?(path)
-              raise "resource path conflict for `#{resource_name}'"
-            else
-              paths << path
-            end
+            paths << auto_load(path, resource_name)
           end
         end
-        paths << "#{@prefix}/customizations"
         if @service.api['metadata']['protocolSettings'] &&
-          @service.api['metadata']['protocolSettings']['h2'] == 'eventstream'
-          paths << "#{@prefix}/async_client"
-          paths << "#{@prefix}/event_streams"
+           @service.api['metadata']['protocolSettings']['h2'] == 'eventstream'
+          paths << auto_load("#{@prefix}/async_client", :AsyncClient)
+          paths << auto_load("#{@prefix}/event_streams", :EventStreams)
         elsif eventstream_shape?
-          paths << "#{@prefix}/event_streams"
+          paths << auto_load("#{@prefix}/event_streams", :EventStreams)
         end
-        paths.to_a
+
+        paths
+      end
+
+      def auto_load(path, class_name, is_plugin = false)
+        {
+          file_path: path,
+          class_name: class_name,
+          is_plugin: is_plugin
+        }
       end
 
       def example_var_name
@@ -108,7 +121,8 @@ module AwsSdkCodeGenerator
       end
 
       def example_operation_name
-        raise "no operations found for the service" if @service.api['operations'].empty?
+        raise 'no operations found for the service' if @service.api['operations'].empty?
+
         underscore(@service.api['operations'].keys.first)
       end
 

data/lib/aws-sdk-code-generator/views/spec/endpoint_provider_spec_class.rb

@@ -51,9 +51,9 @@ module AwsSdkCodeGenerator
                 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'] || []
+                operation_params: operation_inputs_test['operationParams'] || {},
+                built_in_params: operation_inputs_test['builtInParams'] || {},
+                client_params: operation_inputs_test['clientParams'] || {}
               )
             end
           end
@@ -117,12 +117,13 @@ module AwsSdkCodeGenerator
             @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')
+            # the expected default of UseGlobalEndpoint in rules
+            # does not match the Ruby 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
@@ -158,6 +159,14 @@ module AwsSdkCodeGenerator
               Param.new('use_fips_endpoint', value)
             when 'AWS::UseDualStack'
               Param.new('use_dualstack_endpoint', value)
+            when 'AWS::Auth::AccountId'
+              Param.new(
+                'credentials',
+                "Aws::Credentials.new('stubbed-akid', 'stubbed-secret', account_id: '#{value}')",
+                true
+              )
+            when 'AWS::Auth::AccountIdEndpointMode'
+              Param.new('account_id_endpoint_mode', value)
             when 'AWS::STS::UseGlobalEndpoint'
               Param.new('sts_regional_endpoints', value ? 'legacy' : 'regional')
             when 'AWS::S3::UseGlobalEndpoint'
@@ -166,9 +175,7 @@ module AwsSdkCodeGenerator
               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'
+            when 'AWS::S3::UseArnRegion', 'AWS::S3Control::UseArnRegion'
               Param.new('s3_use_arn_region', value)
             when 'AWS::S3::DisableMultiRegionAccessPoints'
               Param.new('s3_disable_multiregion_access_points', value)
@@ -181,14 +188,16 @@ module AwsSdkCodeGenerator
         end
 
         class Param
-          def initialize(param, value)
+          def initialize(param, value, literal = false)
             @param = param
             @value = value
+            @literal = literal
           end
+
           attr_accessor :param
 
           def value
-            if @value.is_a? String
+            if @value.is_a?(String) && !@literal
               "'#{@value}'"
             else
               @value