aws-sdk-code-generator 0.3.0.pre → 0.5.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']]['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

data/templates/client_api_module.mustache

@@ -51,6 +51,13 @@ module {{module_name}}
           {{/http_checksum}}
         }
         {{/http_checksum}}
+        {{#request_compression}}
+        o.request_compression = {
+          {{#request_compression}}
+          {{{key}}} => {{{value}}},
+          {{/request_compression}}
+        }
+        {{/request_compression}}
         {{#deprecated}}
         o.deprecated = true
         {{/deprecated}}

data/templates/client_class.mustache

@@ -38,51 +38,6 @@ module {{module_name}}
     # @overload initialize(options)
     #   @param [Hash] options
     {{>documentation}}
-    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
-    #     requests through.  Formatted like 'http://proxy.com:123'.
-    #
-    #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before raising a
-    #     `Timeout::Error`.
-    #
-    #   @option options [Float] :http_read_timeout (60) The default
-    #     number of seconds to wait for response data.  This value can
-    #     safely be set per-request on the session.
-    #
-    #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idle before it is
-    #     considered stale.  Stale connections are closed and removed
-    #     from the pool before making a request.
-    #
-    #   @option options [Float] :http_continue_timeout (1) The number of
-    #     seconds to wait for a 100-continue response before sending the
-    #     request body.  This option has no effect unless the request has
-    #     "Expect" header set to "100-continue".  Defaults to `nil` which
-    #     disables this behaviour.  This value can safely be set per
-    #     request on the session.
-    #
-    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
-    #     in seconds.
-    #
-    #   @option options [Boolean] :http_wire_trace (false) When `true`,
-    #     HTTP debug output will be sent to the `:logger`.
-    #
-    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
-    #     SSL peer certificates are verified when establishing a
-    #     connection.
-    #
-    #   @option options [String] :ssl_ca_bundle Full path to the SSL
-    #     certificate authority bundle file that should be used when
-    #     verifying peer certificates.  If you do not pass
-    #     `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
-    #     will be used if available.
-    #
-    #   @option options [String] :ssl_ca_directory Full path of the
-    #     directory that contains the unbundled SSL certificate
-    #     authority files for verifying peer certificates.  If you do
-    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
-    #     system default will be used if available.
-    #
     {{/client_constructor}}
     def initialize(*args)
       super

data/templates/endpoint_provider_class.mustache

@@ -5,26 +5,8 @@
 {{/generated_src_warning}}
 module {{module_name}}
   class EndpointProvider
-    def initialize(rule_set = nil)
-      @@rule_set ||= begin
-        endpoint_rules = Aws::Json.load(Base64.decode64(RULES))
-        Aws::Endpoints::RuleSet.new(
-          version: endpoint_rules['version'],
-          service_id: endpoint_rules['serviceId'],
-          parameters: endpoint_rules['parameters'],
-          rules: endpoint_rules['rules']
-        )
-      end
-      @provider = Aws::Endpoints::RulesProvider.new(rule_set || @@rule_set)
-    end
-
     def resolve_endpoint(parameters)
-      @provider.resolve_endpoint(parameters)
+{{{ endpoint_rules_code }}}
     end
-
-    # @api private
-    RULES = <<-JSON
-{{endpoint_rules_encoded}}
-    JSON
   end
 end

data/templates/endpoints_module.mustache

@@ -5,6 +5,7 @@
 {{/generated_src_warning}}
 
 module {{module_name}}
+  # @api private
   module Endpoints
 
     {{#endpoint_classes}}

data/templates/endpoints_plugin.mustache

@@ -10,6 +10,7 @@ module {{module_name}}
       option(
         :endpoint_provider,
         doc_type: '{{module_name}}::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\
@@ -29,16 +30,17 @@ module {{module_name}}
       # @api private
       class Handler < Seahorse::Client::Handler
         def call(context)
-          # If endpoint was discovered, do not resolve or apply the endpoint.
           unless context[:discovered_endpoint]
             params = parameters_for_operation(context)
             endpoint = context.config.endpoint_provider.resolve_endpoint(params)
 
             context.http_request.endpoint = endpoint.url
             apply_endpoint_headers(context, endpoint.headers)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
           end
 
-          context[:endpoint_params] = params
           context[:auth_scheme] =
             Aws::Endpoints.resolve_auth_scheme(context, endpoint)
 

data/templates/features/smoke.mustache

@@ -1,22 +1,18 @@
 {{#generated_src_warning}}
 {{generated_src_warning}}
 {{/generated_src_warning}}
-Feature: Smoke tests for {{service}}
-
-Background:
-{{#client_endpoint}}
-  Given I create a client with endpoint '{{client_endpoint}}'
-{{/client_endpoint}}
-{{^client_endpoint}}
-  Given I create a client in region '{{client_region}}'
-{{/client_endpoint}}
+Feature: Smoke tests for {{service_name}}
 {{#smoke_tests}}
 
-  {{smoke_test_tags}}
-  Scenario: {{scenario_string}}
-  When I call the operation '{{operation}}' with params:
-    """
+  {{tags}}
+  Scenario: {{id}}
+    Given I create a '{{service_module}}' client with config:
+      """
+{{&config_hash}}
+      """
+    When I call the operation '{{operation_name}}' with params:
+      """
 {{&param_hash}}
-    """
-  Then {{error_expectation}}
+      """
+    Then {{&expectation}}
 {{/smoke_tests}}

data/templates/features/step_definitions.mustache

@@ -1,10 +1,5 @@
 Before("@{{var_name}}") do
-{{#client_endpoint}}
-  @service = {{module_name}}::Resource.new(endpoint: '{{client_endpoint}}')
-{{/client_endpoint}}
-{{^client_endpoint}}
   @service = {{module_name}}::Resource.new
-{{/client_endpoint}}
   @client = @service.client
 end
 

data/templates/gemspec.mustache

@@ -24,8 +24,11 @@ Gem::Specification.new do |spec|
 
   {{/metadata}}
   {{#dependencies}}
-  spec.add_dependency('{{gem}}', '{{&version}}')
+  spec.add_dependency({{{gem_version}}})
   {{/dependencies}}
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.5'
+  {{#deprecated?}}
+  spec.post_install_message = '*** {{gem_name}} is deprecated ***'
+  {{/deprecated?}}
 end

data/templates/rbs/client_class.mustache

@@ -0,0 +1,39 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    class Client < ::Seahorse::Client::Base
+      include ::Aws::ClientStubs
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Client.html#initialize-instance_method
+      def self.new: ({{{client_option}}}) -> instance
+                  | (?Hash[Symbol, untyped]) -> instance
+
+      {{#operations}}
+
+      {{^empty_structure}}
+      interface {{interface}}
+        include ::Seahorse::Client::_ResponseSuccess[{{data}}]
+        {{#returns_members}}
+        def {{method_name}}: () -> {{{returns}}}
+        {{/returns_members}}
+      end
+      {{/empty_structure}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Client.html#{{method_name}}-instance_method
+      {{{signature}}}
+      {{/operations}}
+      {{#waiters?}}
+
+      {{#waiters_first}}
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service_name}}/Client.html#wait_until-instance_method
+      def wait_until: {{{client_overload_keyword_argument}}}
+                    | {{{client_overload_positional_argument}}}
+      {{/waiters_first}}
+      {{#waiters_others}}
+                    | {{{client_overload_keyword_argument}}}
+                    | {{{client_overload_positional_argument}}}
+      {{/waiters_others}}
+      {{/waiters?}}
+    end
+  end
+end
+

data/templates/rbs/errors_module.mustache

@@ -0,0 +1,17 @@
+{{generated_src_warning}}
+module Aws
+  module {{service_name}}
+    module Errors
+      class ServiceError < ::Aws::Errors::ServiceError
+      end
+
+      {{#errors}}
+      class {{name}} < ::Aws::Errors::ServiceError
+        {{#members}}
+        {{{signature}}}
+        {{/members}}
+      end
+      {{/errors}}
+    end
+  end
+end