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

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

@@ -30,7 +30,10 @@ module AwsSdkCodeGenerator
         'timestampFormat' => true, # glacier api customization
         'xmlNamespace' => true,
         'streaming' => true, # transfer-encoding
-        'requiresLength' => true, # transder-encoding
+        'requiresLength' => true, # transfer-encoding
+        'union' => false, # should remain false
+        'document' => true,
+        'jsonvalue' => true,
         # event stream modeling
         'event' => false,
         'eventstream' => false,
@@ -60,7 +63,7 @@ module AwsSdkCodeGenerator
         'max' => false,
         'wrapper' => false,
         'xmlOrder' => false,
-        'retryable' => false
+        'retryable' => false,
       }
 
       METADATA_KEYS = {
@@ -81,7 +84,10 @@ module AwsSdkCodeGenerator
         'checksumFormat' => true,
         'globalEndpoint' => true,
         'serviceAbbreviation' => true,
-        'uid' => true
+        'uid' => true,
+        'awsQueryCompatible' => true, # AwsQuery migration
+        # ignore
+        'ripServiceName' => true
       }
 
       # @option options [required, Service] :service
@@ -127,13 +133,22 @@ module AwsSdkCodeGenerator
             shape_name = lstrip_prefix(upcase_first(shape_name))
           end
           lines = []
-          if non_error_struct?(shape)
+          if non_error_struct?(shape) && !document_struct?(shape)
             required = Set.new(shape['required'] || [])
             unless shape['members'].nil?
               shape['members'].each do |member_name, member_ref|
                 lines << "#{shape_name}.add_member(:#{underscore(member_name)}, #{shape_ref(member_ref, member_name, required)})"
               end
             end
+            if shape['union']
+              lines << "#{shape_name}.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))"
+              shape['members'].each do |member_name, member_ref|
+                member_name_underscore = underscore(member_name)
+                member_class_name = pascal_case(member_name_underscore)
+                lines << "#{shape_name}.add_member_subclass(:#{member_name_underscore}, Types::#{shape_name}::#{member_class_name})"
+              end
+              lines << "#{shape_name}.add_member_subclass(:unknown, Types::#{shape_name}::Unknown)"
+            end
             lines << "#{shape_name}.struct_class = Types::#{shape_name}"
             if payload = shape['payload']
               lines << "#{shape_name}[:payload] = :#{underscore(payload)}"
@@ -186,6 +201,15 @@ module AwsSdkCodeGenerator
             o.http_method = operation['http']['method']
             o.http_request_uri = operation['http']['requestUri']
             o.http_checksum_required = true if operation['httpChecksumRequired']
+            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
             %w(input output).each do |key|
               if operation[key]
                 o.shape_references << "o.#{key} = #{operation_ref(operation[key])}"
@@ -258,7 +282,11 @@ module AwsSdkCodeGenerator
         if @service.protocol == 'api-gateway' && type == 'timestamp'
           shape['timestampFormat'] = 'iso8601'
         end
-        if SHAPE_CLASSES.key?(type)
+        if document_struct?(shape)
+          ["Shapes::DocumentShape", shape]
+	      elsif shape['union']
+          ["Shapes::UnionShape", shape]
+        elsif SHAPE_CLASSES.key?(type)
           ["Shapes::#{SHAPE_CLASSES[type]}", shape]
         else
           raise ArgumentError, "unsupported shape type `#{type}'"
@@ -315,6 +343,10 @@ module AwsSdkCodeGenerator
           (shape['error'] || shape['exception'])
       end
 
+      def document_struct?(shape)
+        shape['type'] == 'structure' && shape['document']
+      end
+
       def structure_shape_enum
         Enumerator.new do |y|
           shape_enum.each do |shape_name, shape|
@@ -516,6 +548,9 @@ module AwsSdkCodeGenerator
         # @return [Boolean]
         attr_accessor :http_checksum_required
 
+        # @return [Hash]
+        attr_accessor :http_checksum
+
         # @return [Array<String>]
         attr_accessor :shape_references
 

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

@@ -18,6 +18,7 @@ module AwsSdkCodeGenerator
       # @option options [required, Hash] :api
       # @option options [Hash] :waiters
       # @option options [Hash] :client_examples
+      # @option options [Array<CodegeneratedPlugin] :codegenerated_plugins
       def initialize(options)
         @service_identifier = options.fetch(:service_identifier)
         @service_name = options.fetch(:service_name)
@@ -25,7 +26,11 @@ module AwsSdkCodeGenerator
         @gem_name = options.fetch(:gem_name)
         @gem_version = options.fetch(:gem_version)
         @plugins = PluginList.new(options)
-        @client_constructor = ClientConstructor.new(options.merge(plugins: @plugins))
+        @codegenerated_plugins = options.fetch(:codegenerated_plugins, [])
+        @client_constructor = ClientConstructor.new(
+          options.merge(
+            plugins: @plugins,
+            codegenerated_plugins: @codegenerated_plugins))
         @operations = ClientOperationList.new(options).to_a
         @waiters = Waiter.build_list(options[:waiters])
         @custom = options.fetch(:custom)
@@ -65,7 +70,7 @@ module AwsSdkCodeGenerator
 
       # @return [Array<String>]
       def plugin_class_names
-        @plugins.map(&:class_name)
+        @plugins.map(&:class_name) + @codegenerated_plugins.map(&:class_name)
       end
 
       # @return [Array<Waiter>]

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class EndpointParametersClass < View
+
+      # @option options [required, Service] :service
+      def initialize(options)
+        @service = options.fetch(:service)
+        if (parameters = @service.endpoint_rules&.fetch('parameters'))
+          @parameters = parameters.map do |k,p|
+            EndpointParameter.new(k, p)
+          end
+        end
+      end
+
+      # @return [Array<EndpointParameter>]
+      attr_reader :parameters
+
+      # @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 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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class EndpointProviderClass < View
+
+      # @option options [required, Service] :service
+      # @option options [required, Hash] :endpoint_rules
+      def initialize(options)
+        @service = options.fetch(:service)
+        @endpoint_rules = @service.endpoint_rules
+
+        version = @endpoint_rules['version']
+        return if version&.match(/^\d+\.\d+$/) # && version == '1.0'
+
+        raise 'Endpoint Rules version must be 1.0'
+      end
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @service.protocol == 'api-gateway'
+        GENERATED_SRC_WARNING
+      end
+
+      def module_name
+        @service.module_name
+      end
+
+      def endpoint_rules_encoded
+        Base64.encode64(JSON.dump(@endpoint_rules))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class EndpointsModule < View
+      # @option options [required, Service] :service
+      def initialize(options)
+        @service = options.fetch(:service)
+
+        @parameters = @service.endpoint_rules.fetch('parameters', {})
+
+        @endpoint_classes = @service.api['operations'].each.with_object([]) do
+          |(name, op), array|
+          array << EndpointClass.new(
+            name: name,
+            parameters: endpoint_parameters_for_operation(op)
+          )
+        end
+      end
+
+      # @return [Array<EndpointClass>]
+      attr_reader :endpoint_classes
+
+      # @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 EndpointClass
+        def initialize(options)
+          @name = options[: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
+
+        # @return [Hash]
+        attr_accessor :param_data
+
+        def static_string?
+          @source == 'staticContextParam' && value.is_a?(String)
+        end
+      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
+          )
+        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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class EndpointsPlugin < View
+      # @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_options = client_options.each.with_object([]) do |(name, _data), array|
+            param_data = endpoint_parameters[name]
+
+            next if param_data['builtIn']
+
+            array << EndpointOption.new(
+              name: Underscore.underscore(name),
+              docstring: param_data['documentation'],
+              doc_type: param_data['type'],
+              default: param_data['default']
+            )
+          end
+        end
+        @endpoint_classes = @service.api['operations'].each.with_object([]) do
+          |(op, _api), array|
+          array << EndpointClass.new(
+            operation_name: Underscore.underscore(op),
+            class_name: op
+          )
+        end
+      end
+
+      # @return [Array<EndpointClass>]
+      attr_reader :endpoint_classes
+
+      # @return [Array<EndpointOption>, nil]
+      attr_reader :endpoint_options
+
+      # @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 EndpointClass
+        def initialize(options)
+          @operation_name = options[:operation_name]
+          @class_name = options[:class_name]
+        end
+
+        # @return [String]
+        attr_reader :operation_name
+
+        # @return [String]
+        attr_reader :class_name
+      end
+
+      class EndpointOption
+        def initialize(options)
+          @name = options[:name]
+          @doc_type = options[:doc_type]
+          @default = options[:default].nil? ? 'nil' : options[:default]
+          @docstring = options[:docstring]
+        end
+
+        # @return [String]
+        attr_reader :name
+
+        # @return [String]
+        attr_reader :doc_type
+
+        # @return [Boolean,String]
+        attr_reader :default
+
+        # @return [String]
+        attr_reader :docstring
+      end
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module AwsSdkCodeGenerator
       end
 
       def email
-        @custom ? 'yourname@email.com' : 'trevrowe@amazon.com'
+        @custom ? 'yourname@email.com' : 'aws-dr-rubygems@amazon.com'
       end
 
       # @return [String]
@@ -42,6 +42,10 @@ module AwsSdkCodeGenerator
         @custom ? false : true
       end
 
+      def files
+        ['LICENSE.txt', 'CHANGELOG.md', 'VERSION', 'lib/**/*.rb']
+      end
+
       # @return [String]
       def description
         if @custom
@@ -58,7 +62,7 @@ module AwsSdkCodeGenerator
 
       # @return [String]
       def code_uri
-        "https://github.com/aws/aws-sdk-ruby/tree/master/gems/#{gem_name}"
+        "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/#{gem_name}"
       end
 
       # @return [Array<Dependency>]

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

@@ -11,6 +11,7 @@ module AwsSdkCodeGenerator
       def initialize(options)
         @service = options.fetch(:service)
         @prefix = options.fetch(:prefix)
+        @codegenerated_plugins = options.fetch(:codegenerated_plugins)
       end
 
       # @return [String|nil]
@@ -51,15 +52,36 @@ module AwsSdkCodeGenerator
         @service.gem_dependencies.keys
       end
 
+      # @return [Boolean] - Return true if a check is needed before
+      # requiring core to prevent circular dependencies.
+      # This is required to support backwards compatibility for SSO which was
+      # moved from the aws-sdk-sso gem into aws-sdk-core.
+      def require_core_guard?
+        @service.included_in_core?
+      end
+
       # @return [Array<String>]
       def relative_requires
         paths = Set.new
         paths << "#{@prefix}/types"
         paths << "#{@prefix}/client_api"
+
+        # these must be required before the client
+        if @codegenerated_plugins
+          paths += @codegenerated_plugins.map { | p| p.path }
+        end
+
         paths << "#{@prefix}/client"
         paths << "#{@prefix}/errors"
         paths << "#{@prefix}/waiters" if @service.waiters
         paths << "#{@prefix}/resource"
+
+        unless @service.legacy_endpoints?
+          paths << "#{@prefix}/endpoint_parameters"
+          paths << "#{@prefix}/endpoint_provider"
+          paths << "#{@prefix}/endpoints"
+        end
+
         if @service.resources && @service.resources['resources']
           @service.resources['resources'].keys.each do |resource_name|
             path = "#{@prefix}/#{underscore(resource_name)}"