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

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

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module RBS
+      class ClientClass < View
+        SKIP_MEMBERS = Set.new(%w[
+          context
+          data
+          error
+          checksum_validated
+          on
+          on_success
+        ])
+
+        def initialize(options)
+          @options = options
+          @service_name = options.fetch(:service_name)
+          @api = options.fetch(:api)
+          @aws_sdk_core_lib_path = options.fetch(:aws_sdk_core_lib_path)
+          @plugins = PluginList.new(options)
+          @codegenerated_plugins = options.fetch(:codegenerated_plugins)
+          @waiters = AwsSdkCodeGenerator::RBS::Waiter.build_list(api: @api, waiters:options.fetch(:waiters))
+        end
+
+        # @return [String|nil]
+        def generated_src_warning
+          GENERATED_SRC_WARNING
+        end
+
+        def service_name
+          @service_name
+        end
+
+        def client_option(indent: ' ' * 20)
+          plugin_options = documented_plugin_options(@plugins) + documented_plugin_options(@codegenerated_plugins)
+          [
+            '',
+            "#{indent}  #{build_keyword_arguments(plugin_options).join(",\n#{indent}  ")}",
+            indent,
+          ].join("\n")
+        end
+
+        def operations
+          shapes = @api["shapes"]
+          @api["operations"].map do |name, body|
+            method_name = Underscore.underscore(name)
+            indent = " " * (12 + method_name.length)
+            input_shape_name = body.dig("input", "shape")
+            arguments = nil
+            include_required = false
+            if input_shape_name
+              input_shape = shapes[input_shape_name]
+              builder = AwsSdkCodeGenerator::RBS::KeywordArgumentBuilder.new(
+                api: @api,
+                shape: input_shape,
+                newline: true,
+              )
+              arguments = builder.format(indent: indent)
+              include_required = input_shape["required"]&.empty?&.!
+            end
+            if AwsSdkCodeGenerator::Helper.operation_streaming?(body, @api)
+              block = " ?{ (*untyped) -> void }"
+            end
+            if output_shape_name = body.dig("output", "shape")
+              output_shape = shapes[output_shape_name]
+              data = AwsSdkCodeGenerator::RBS.to_type(body.fetch( "output"), @api)
+              interface = "_#{name}ResponseSuccess"
+            else
+              output_shape = nil
+              data = "::Aws::EmptyStructure"
+              interface = empty_interface = "::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]"
+            end
+            returns_members = output_shape&.[]("members")&.inject([]) do |a, (member_name, member_ref)|
+              member_name_underscore = Underscore.underscore(member_name)
+              next a if SKIP_MEMBERS.include?(member_name_underscore)
+              a << {
+                method_name: member_name_underscore,
+                returns: AwsSdkCodeGenerator::RBS.to_type(member_ref, @api),
+              }
+            end
+
+            {
+              method_name: method_name,
+              signature: AwsSdkCodeGenerator::RBS::MethodSignature.new(
+                method_name: method_name,
+                overloads: [
+                  "(#{arguments})#{block} -> #{interface}",
+                  "(#{include_required ? "" : "?"}Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options)#{block} -> #{interface}",
+                ]).signature,
+              interface: interface,
+              data: data,
+              returns_members: returns_members,
+              empty_structure: output_shape.nil?
+            }
+          end
+        end
+
+        def waiters?
+          @waiters.size > 0
+        end
+
+        def waiters_first
+          [@waiters.first]
+        end
+
+        def waiters_others
+          @waiters[1..-1]
+        end
+
+        private
+
+        def documented_plugin_options(plugins)
+          i = 0
+          plugins.map(&:options).flatten.select(&:documented?).sort_by do |opt|
+            [opt.required ? 'a' : 'b', opt.name, i += 1]
+          end
+        end
+
+        def build_keyword_arguments(plugins)
+          buffer = plugins.map do |opt|
+            if opt.rbs_type
+              opt.rbs_type
+            else
+              case opt.doc_type
+              when "Boolean"
+                "bool"
+              when nil
+                "untyped"
+              else
+                opt.doc_type.to_s
+              end
+            end.yield_self do |type|
+              [opt.name, "?#{opt.name}: #{type}", opt.doc_type]
+            end
+          end
+          # Find duplicated key
+          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
+              # ok
+            else
+              warn("Duplicate client option in #{@service_name}: `#{grouped[name].map { |g| g.values_at(0, 2) }}`", uplevel: 0)
+            end
+          end
+          buffer.uniq! { |b| b[0] }
+          buffer.map! { |b| b[1] }
+          buffer.concat([
+            # from mustache
+            "?http_proxy: String",
+            "?http_open_timeout: (Float | Integer)",
+            "?http_read_timeout: (Float | Integer)",
+            "?http_idle_timeout: (Float | Integer)",
+            "?http_continue_timeout: (Float | Integer)",
+            "?ssl_timeout: (Float | Integer | nil)",
+            "?http_wire_trace: bool",
+            "?ssl_verify_peer: bool",
+            "?ssl_ca_bundle: String",
+            "?ssl_ca_directory: String",
+            # from object
+            "?ssl_ca_store: String",
+            "?on_chunk_received: Proc",
+            "?on_chunk_sent: Proc",
+            "?raise_response_errors: bool",
+          ])
+          buffer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module RBS
+      class ErrorsModule < View
+        attr_reader :errors
+
+        def initialize(service:)
+          @service = service
+          @errors = AwsSdkCodeGenerator::RBS::ErrorList.new(
+            api: service.api,
+            module_name: service.module_name
+          ).to_a
+        end
+
+        # @return [String|nil]
+        def generated_src_warning
+          GENERATED_SRC_WARNING
+        end
+
+        def service_name
+          @service.name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module RBS
+      class ResourceClass < View
+        attr_reader :service_name
+        attr_reader :class_name
+        attr_reader :identifiers
+        attr_reader :data_attributes
+        attr_reader :shape
+        attr_reader :exists_waiters
+        attr_reader :waiters
+        attr_reader :actions
+        attr_reader :associations
+        attr_reader :batch_actions
+
+        def initialize(service_name:, class_name:, resource:, api:, paginators:)
+          @class_name = class_name
+          @resource = resource
+          @service_name = service_name
+          @identifiers = ResourceIdentifier.build_list(resource)
+          @data_attributes = if @resource["shape"]
+            data_attribute_names = AwsSdkCodeGenerator::ResourceAttribute.send(:data_attribute_names, @resource, api)
+            data_attribute_names.map do |member_name, member_ref|
+              AwsSdkCodeGenerator::RBS::MethodSignature.new(
+                method_name: Underscore.underscore(member_name),
+                overloads: ["() -> #{AwsSdkCodeGenerator::RBS.to_type(member_ref, api)}"]
+              )
+            end
+          else
+            []
+          end
+          @shape = @resource["shape"]
+          @exists_waiters = @resource.fetch("waiters", []).any? { |name, _| name == "Exists" }
+          @waiters = @resource.fetch("waiters", []).map do |waiter_name, waiter_body|
+            AwsSdkCodeGenerator::RBS::MethodSignature.new(
+              method_name: "wait_until_#{Underscore.underscore(waiter_name)}",
+              overloads: [
+                "(?max_attempts: Integer, ?delay: Numeric, ?before_attempt: (^(Integer attempts) -> void), ?before_wait: (^(Integer attempts, untyped response) -> void)) ?{ (untyped waiter) -> void } -> #{class_name}",
+                "(?Hash[Symbol, untyped]) ?{ (untyped waiter) -> void } -> #{class_name}",
+              ],
+            )
+          end
+          @actions = AwsSdkCodeGenerator::RBS::ResourceAction.build_method_signature_list(resource: @resource, api: api)
+          @associations = AwsSdkCodeGenerator::RBS::ResourceAssociation.build_method_signature_list(resource: @resource, api: api, paginators: paginators)
+          @batch_actions = AwsSdkCodeGenerator::RBS::ResourceBatchAction.build_method_signature_list(resource: @resource, api: api)
+          avoid_duplicate_methods
+        end
+
+        # @return [String|nil]
+        def generated_src_warning
+          GENERATED_SRC_WARNING
+        end
+
+        def initialize_signature
+          initialize_overloads =
+            if @identifiers.empty?
+              []
+            else
+              positional = @identifiers.map { |id| "#{id.type} #{id.name}" } << "Hash[Symbol, untyped] options"
+              keyword = @identifiers.map { |id| "#{id.name}: #{id.type}" } << "?client: Client"
+              [
+                "(#{positional.join(', ')}) -> void",
+                "(#{keyword.join(', ')}) -> void"
+              ]
+            end
+          initialize_overloads << "(Hash[Symbol, untyped] args) -> void"
+          "def initialize: #{initialize_overloads.join("\n                    | ")}"
+        end
+
+        def load?
+          @resource["load"]
+        end
+
+        def load_or_shape?
+          load? or !!shape
+        end
+
+        private
+
+        # `Aws::RDS::DBEngineVersion` has a duplicated method named `engine`.
+        # This is a rare case and should be patched minimally.
+        def avoid_duplicate_methods
+          overrided_method_names = @actions.map(&:method_name).to_set + @associations.map(&:method_name).to_set
+          @identifiers.each do |identifier|
+            if identifier.alias && overrided_method_names.include?(identifier.alias)
+              identifier.alias = nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module RBS
+      class RootResourceClass < View
+        attr_reader :actions
+        attr_reader :associations
+        attr_reader :service_name
+
+        def initialize(client_class:, api:, resources:, service_name:, paginators:)
+          @client_class = client_class
+          @service_name = service_name
+          resource = resources&.[]("service") || {}
+          @actions = AwsSdkCodeGenerator::RBS::ResourceAction.build_method_signature_list(resource: resource, api: api)
+          @associations = AwsSdkCodeGenerator::RBS::ResourceAssociation.build_method_signature_list(resource: resource, api: api, paginators: paginators)
+        end
+
+        # @return [String|nil]
+        def generated_src_warning
+          GENERATED_SRC_WARNING
+        end
+
+        def client_option
+          @client_class.client_option(indent: ' ' * 22)
+        end
+      end
+    end
+  end
+end

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']]['exception_event'] = 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['exception_event']
+            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/spec/endpoint_provider_spec_class.rb

@@ -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
@@ -137,7 +141,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) }

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']]['exception_event'] = true
               end
             end
           end
@@ -93,7 +92,7 @@ module AwsSdkCodeGenerator
             sensitive: sensitive
           )
         end
-        if shape['event']
+        if shape['event'] || shape['exception_event']
           members << StructMember.new(member_name: 'event_type')
         end
         members

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

@@ -50,7 +50,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 +75,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