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

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

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module RBS
+      class TypesModule < View
+
+        include Helper
+
+        # @option options [required, Service] :service
+        def initialize(options)
+          @service = options.fetch(:service)
+          @api = @service.api
+        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
+
+        # @return [Array<StructClass>]
+        def structures
+          @service.api['shapes'].each do |_, shape|
+            if shape['eventstream']
+              # add internal exception_event ctrait to all exceptions
+              # 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']]['exceptionEvent'] = true
+                end
+              end
+            end
+          end
+          @service.api['shapes'].inject([]) do |list, (shape_name, shape)|
+            # APIG model can have input/output shape with downcase and '__'
+            if @service.protocol == 'api-gateway'
+              shape_name = lstrip_prefix(upcase_first(shape_name))
+            end
+            # eventstream shape will be inheriting from enumerator
+            if shape['eventstream']
+              list
+            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
+              end
+              list << StructClass.new(
+                class_name: shape_name,
+                members: struct_members,
+                sensitive_params: sensitive_params,
+                documentation: struct_class_docs(shape_name, shape),
+                union: shape['union']
+              )
+            else
+              list
+            end
+          end
+        end
+
+        # return [Array<EventStreamClass>]
+        def eventstreams
+          @service.api['shapes'].inject([]) do |list, (shape_name, shape)|
+            if shape['eventstream']
+              list << EventStreamClass.new(
+                class_name: shape_name,
+                types: struct_members(shape),
+                documentation: eventstream_class_docs(shape_name, shape)
+              )
+            else
+              list
+            end
+          end
+        end
+
+        private
+
+        def struct_members(shape)
+          return if shape['members'].nil?
+          members = shape['members'].map do |member_name, member_ref|
+            sensitive = !!(member_ref['sensitive'] ||
+              @api['shapes'][member_ref['shape']]['sensitive'])
+            StructMember.new(
+              member_name: underscore(member_name),
+              sensitive: sensitive,
+              returns: AwsSdkCodeGenerator::RBS.to_type(member_ref, @api)
+            )
+          end
+          if shape['event'] || shape['exceptionEvent']
+            members << StructMember.new(
+              member_name: 'event_type',
+              returns: 'untyped'
+            )
+          end
+          members
+        end
+
+        def struct_class_docs(shape_name, shape)
+          nil
+        end
+
+        def eventstream_class_docs(shape_name, shape)
+          nil
+        end
+
+        def eventstream_docs(shape_name)
+          nil
+        end
+
+        def output_example_docs(shape_name, shape)
+          nil
+        end
+
+        def input_example_docs(shape_name, shape)
+          nil
+        end
+
+        def attribute_macros_docs(shape_name)
+          nil
+        end
+
+        def idempotency_token?(member_ref)
+          member_ref['idempotencyToken'] || shape(member_ref)['idempotencyToken']
+        end
+
+        def idempotency_token_msg
+          "<p><b>A suitable default value is auto-generated.</b> You should normally not need to pass this option.</p>"
+        end
+
+        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_shapes(member_ref, shapes)
+            end
+          when 'list'
+            visit_shapes(s['member'], shapes)
+          when 'map'
+            visit_shapes(s['key'], shapes)
+            visit_shapes(s['value'], shapes)
+          end
+        end
+
+        def shape(shape_ref)
+          Api.resolve(shape_ref, @api)[1]
+        end
+
+        class EventStreamClass
+
+          def initialize(options)
+            @class_name = options.fetch(:class_name)
+            @types = options.fetch(:types)
+            @documentation = options.fetch(:documentation)
+            if @types.nil? || @types.empty?
+              @empty = true
+            else
+              @empty = false
+              @types.last.last = true
+            end
+          end
+
+          # @return [String]
+          attr_accessor :class_name
+
+          # @return [Array<StructMember>]
+          attr_accessor :types
+
+          # @return [String, nil]
+          attr_accessor :documentation
+
+          # @return [Boolean]
+          def empty?
+            @empty
+          end
+
+        end
+
+        class StructClass
+
+          def initialize(options)
+            @class_name = options.fetch(:class_name)
+            @members = options.fetch(:members)
+            @documentation = options.fetch(:documentation)
+            @sensitive_params = options.fetch(:sensitive_params)
+            @union = options.fetch(:union)
+            @members << StructMember.new(
+              member_name: :unknown,
+              returns: 'untyped' # FIXME
+            ) if @union
+            if @members.nil? || @members.empty?
+              @empty = true
+            else
+              @empty = false
+              @members.last.last = true
+            end
+          end
+
+          # @return [String]
+          attr_accessor :class_name
+
+          # @return [Array<StructMember>]
+          attr_accessor :members
+
+          # @return [String, nil]
+          attr_accessor :documentation
+
+          # @return [Array<Symbol>]
+          attr_accessor :sensitive_params
+
+          # @return [Boolean]
+          def union?
+            @union
+          end
+
+          # @return [Boolean]
+          def empty?
+            @empty
+          end
+        end
+
+        class StructMember
+          def initialize(member_name:, sensitive: false, returns:)
+            @member_name = member_name
+            @member_class_name = AwsSdkCodeGenerator::Helper::pascal_case(@member_name)
+            @sensitive = sensitive
+            @returns = returns
+            @last = false
+          end
+
+          # @return [String]
+          attr_accessor :member_name
+
+          # @return [Boolean]
+          attr_accessor :sensitive
+
+          # @return [String]
+          attr_accessor :member_class_name
+
+          # @return [String]
+          attr_accessor :returns
+
+          # @return [Boolean]
+          attr_accessor :last
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module RBS
+      class WaitersModule < View
+        attr_reader :service_name
+        attr_reader :waiters
+
+        def initialize(service_name:, api:, waiters:)
+          @service_name = service_name
+          @waiters = AwsSdkCodeGenerator::RBS::Waiter.build_list(api: api, waiters: waiters)
+        end
+
+        # @return [String|nil]
+        def generated_src_warning
+          GENERATED_SRC_WARNING
+        end
+      end
+    end
+  end
+end

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
@@ -90,6 +90,10 @@ module AwsSdkCodeGenerator
               !@expect['endpoint']['properties']['authSchemes'].empty?
           end
 
+          def s3_express_auth?
+            expect_auth? && expected_auth['name'] == 'sigv4-s3express'
+          end
+
           def expected_headers
             @expect['endpoint']['headers'].map { |k,v| Param.new(k, v.join(",")) }
           end
@@ -113,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
@@ -137,7 +142,7 @@ module AwsSdkCodeGenerator
             case value
             when Hash
               value.each_with_object({}) do |(k, v), o|
-                o[Underscore.underscore(k)] = transform_operation_values(v)
+                o[Underscore.underscore(k).to_sym] = transform_operation_values(v)
               end
             when Array
               value.map { |v| transform_operation_values(v) }
@@ -154,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'
@@ -162,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)
@@ -177,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

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

@@ -28,14 +28,13 @@ module AwsSdkCodeGenerator
 
       # @return [Array<StructClass>]
       def structures
-        unless @service.protocol_settings.empty?
-          if @service.protocol_settings['h2'] == 'eventstream'
-            @service.api['shapes'].each do |_, shape|
-              if shape['eventstream']
-                # add event trait to all members if not exists
-                shape['members'].each do |name, ref|
-                  @service.api['shapes'][ref['shape']]['event'] = true
-                end
+        @service.api['shapes'].each do |_, shape|
+          if shape['eventstream']
+            # add internal exception_event ctrait to all exceptions
+            # 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']]['exceptionEvent'] = true
               end
             end
           end
@@ -81,19 +80,43 @@ module AwsSdkCodeGenerator
         end
       end
 
+      # @return [Array<String>]
+      def types_customizations
+        Dir.glob(File.join(Helper.gem_lib_path(gem_name), "#{gem_name}/customizations/types", '*.rb')).map do |file|
+          filename = File.basename(file, '.rb')
+          "#{gem_name}/customizations/types/#{filename}"
+        end
+      end
+
       private
 
+      def gem_name
+        "aws-sdk-#{module_name.split('::').last.downcase}"
+      end
+
       def struct_members(shape)
         return if shape['members'].nil?
         members = shape['members'].map do |member_name, member_ref|
+          member_target = @api['shapes'][member_ref['shape']]
           sensitive = !!(member_ref['sensitive'] ||
-            @api['shapes'][member_ref['shape']]['sensitive'])
+            member_target['sensitive'])
+
+          case member_target["type"]
+          when 'map'
+            key_shape = @api['shapes'][member_target['key']['shape']]
+            value_shape = @api['shapes'][member_target['value']['shape']]
+            sensitive ||= !!(key_shape['sensitive'] || value_shape['sensitive'])
+          when 'list'
+            list_member = @api['shapes'][member_target['member']['shape']]
+            sensitive ||= !!(list_member['sensitive'])
+          end
+
           StructMember.new(
             member_name: underscore(member_name),
             sensitive: sensitive
           )
         end
-        if shape['event']
+        if shape['event'] || shape['exceptionEvent']
           members << StructMember.new(member_name: 'event_type')
         end
         members
@@ -181,7 +204,7 @@ module AwsSdkCodeGenerator
 
       def see_also_tag(shape_name)
         uid = @api['metadata']['uid']
-        if @api['metadata']['protocol'] != 'api-gateway' && Crosslink.taggable?(uid)
+        if @service.protocol != 'api-gateway' && Crosslink.taggable?(uid)
           Crosslink.tag_string(uid, shape_name)
         end
       end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'aws-sdk-core'
+
 require_relative 'aws-sdk-code-generator/api'
 require_relative 'aws-sdk-code-generator/apply_docs'
 require_relative 'aws-sdk-code-generator/codegenerated_plugin'
@@ -10,6 +12,7 @@ require_relative 'aws-sdk-code-generator/error_list'
 require_relative 'aws-sdk-code-generator/client_response_structure_example'
 require_relative 'aws-sdk-code-generator/crosslink'
 require_relative 'aws-sdk-code-generator/docstring'
+require_relative 'aws-sdk-code-generator/endpoint_parameter'
 require_relative 'aws-sdk-code-generator/hash_formatter'
 require_relative 'aws-sdk-code-generator/helper'
 require_relative 'aws-sdk-code-generator/plugin_list'
@@ -50,7 +53,6 @@ require_relative 'aws-sdk-code-generator/views/docstring'
 require_relative 'aws-sdk-code-generator/views/errors_module'
 require_relative 'aws-sdk-code-generator/views/features/env'
 require_relative 'aws-sdk-code-generator/views/features/step_definitions'
-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'
@@ -76,6 +78,23 @@ require_relative 'aws-sdk-code-generator/yard_option_tag'
 require_relative 'aws-sdk-code-generator/code_builder'
 require_relative 'aws-sdk-code-generator/gem_builder'
 
+# RBS
+require_relative 'aws-sdk-code-generator/rbs'
+require_relative 'aws-sdk-code-generator/rbs/error_list'
+require_relative 'aws-sdk-code-generator/rbs/method_signature'
+require_relative 'aws-sdk-code-generator/rbs/keyword_argument_builder'
+require_relative 'aws-sdk-code-generator/rbs/resource_action'
+require_relative 'aws-sdk-code-generator/rbs/resource_association'
+require_relative 'aws-sdk-code-generator/rbs/resource_batch_action'
+require_relative 'aws-sdk-code-generator/rbs/resource_client_request'
+require_relative 'aws-sdk-code-generator/rbs/waiter'
+require_relative 'aws-sdk-code-generator/views/rbs/client_class'
+require_relative 'aws-sdk-code-generator/views/rbs/errors_module'
+require_relative 'aws-sdk-code-generator/views/rbs/resource_class'
+require_relative 'aws-sdk-code-generator/views/rbs/root_resource_class'
+require_relative 'aws-sdk-code-generator/views/rbs/types_module'
+require_relative 'aws-sdk-code-generator/views/rbs/waiters_module'
+
 module AwsSdkCodeGenerator
 
   GENERATED_SRC_WARNING = <<-WARNING_TXT
@@ -87,4 +106,13 @@ module AwsSdkCodeGenerator
 # WARNING ABOUT GENERATED CODE
   WARNING_TXT
 
+  @warnings = []
+
+  class << self
+    attr_reader :warnings
+    def warn(service, type, message)
+      Kernel.warn(message)
+      @warnings << { service: service, type: type, message: message }
+    end
+  end
 end