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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4fa27373a270b0e11b172d68ccc2c1c5b7926f986a1fb630be00b0a591a956a
-  data.tar.gz: 78f1365cdb7d7b78bdb6b2269e8ce18a42907eff158f7dae9b20c7fcaf6b6a88
+  metadata.gz: 6f47bca9edb4689814cec21486fbc9924716462ea8dc0cf69e05d82b11c95d3b
+  data.tar.gz: 7173e29d52ac6118968e30d35e750cfe2a702e9c4a320041c46ab534f6c5d018
 SHA512:
-  metadata.gz: 94e82e811fa8689c93762b0c590f2d12f3c0dbda5d040d932d7caeb5396096cf8b2109394bb992f0325b137993534cadd0905515f7265e74b25b9de81efb9f51
-  data.tar.gz: b7f27268bbc20faa1c6a6439019ca9ec57e905f509ff4b95904eb0e6b13f0bf6e87f6eca0b81b1235d60f5d961fc0bbd5fd2c97ed7076cda9c7bc8b595966c1a
+  metadata.gz: c009d5dec4abd1d587254c564eeb88c89bd08d687070ae539ea4ea0fc64d747edc8b28641f7544ea9860363aa7467a631fae896d815cde99cc3502c7b7b844e2
+  data.tar.gz: b195875c8e9dd16ba6373784bd786dc79663a6e0f421c2835462cd1bccc407e2168d5a98947bffa6fc31ea1eb65ba27fca67047c83ef2a9d65987e4dbd3902d0

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

@@ -77,7 +77,12 @@ module AwsSdkCodeGenerator
             "Hash<String,#{ruby_input_type(shape['value'], api, operation, nested: true)}>"
           end
         when 'string' then 'String'
-        when 'structure' then "Types::#{shape_ref['shape']}"
+        when 'structure'
+          if shape['document']
+            'Hash,Array,String,Numeric,Boolean'
+          else
+            "Types::#{shape_ref['shape']}"
+          end
         when 'timestamp' then 'Time,DateTime,Date,Integer,String'
         else
           raise "unhandled type #{shape.type}.inspect"
@@ -98,7 +103,12 @@ module AwsSdkCodeGenerator
         when 'long' then 'Integer'
         when 'map' then "Hash<String,#{ruby_type(shape['value'], api)}>"
         when 'string' then streaming?(shape_ref, api) ? 'IO' : 'String'
-        when 'structure' then "Types::#{shape_ref['shape']}"
+        when 'structure'
+          if shape['document']
+            'Hash,Array,String,Numeric,Boolean'
+          else
+            "Types::#{shape_ref['shape']}"
+          end
         when 'timestamp' then 'Time'
         else
           raise "unhandled type #{shape['type'].inspect}"

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

@@ -4,8 +4,11 @@ module AwsSdkCodeGenerator
   class ClientConstructor
 
     # @option options [required, PluginList] :plugins
+    # @option options [required, Array<CodegeneratedPlugin>] :codegenerated_plugins
+
     def initialize(options)
-      plugin_options = documented_plugin_options(options.fetch(:plugins))
+      plugin_options = documented_plugin_options(options.fetch(:plugins)) +
+        documented_plugin_options(options.fetch(:codegenerated_plugins))
       documentation = {}
       plugin_options.each do |option|
         documentation[option.name] = YardOptionTag.new(

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

@@ -3,6 +3,10 @@
 module AwsSdkCodeGenerator
   class ClientOperationDocumentation
 
+    # get all of the enumerable methods that may conflict with members
+    # count has special handling in UnsafeEnumerableMethods
+    ENUMERABLE_METHODS = Class.new.new.extend(Enumerable).methods - [:count]
+
     # @option options [required, String] :method_name
     # @option options [required, Hash] :operation
     # @option options [required, Hash] :api
@@ -57,7 +61,7 @@ module AwsSdkCodeGenerator
         : request_syntax_example(method_name, operation, api),
         response_structure_example(operation, api),
         waiters_tag(@waiters),
-        see_also_tag(operation, api),
+        see_also_tag(@name, api),
       ], block_comment: false)
     end
     alias to_s to_str
@@ -97,9 +101,15 @@ module AwsSdkCodeGenerator
           if member_ref['idempotencyToken']
             docstring = docstring.to_s + "<p><b>A suitable default value is auto-generated.** You should normally not need to pass this option.</b></p>"
           end
-          if member_ref['jsonvalue']
+          if member_ref['jsonvalue'] || member_shape['jsonvalue']
             docstring = docstring.to_s + "<p><b>SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.</b></p>"
           end
+          if member_shape['document']
+            docstring = docstring.to_s + "<p>Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.</p>"
+          end
+          if member_ref['union']
+            docstring = docstring.to_s + "<p>This is a union type and you must set exactly one of the members.</p>"
+          end
           YardOptionTag.new(
             name: Underscore.underscore(member_name),
             ruby_type: Api.ruby_input_type(member_ref, api, operation),
@@ -130,7 +140,11 @@ module AwsSdkCodeGenerator
         methods = shape['members'].map do |member_name, member_ref|
           member_type = Docstring.escape_html(Api.ruby_type(member_ref, api))
           method_name = Underscore.underscore(member_name)
-          "#   * {#{type}##{method_name} ##{method_name}} => #{member_type}"
+          if ENUMERABLE_METHODS.include?(method_name.to_sym)
+            "#   * {#{type}##{method_name} #data.#{method_name}} => #{member_type} (This method conflicts with a method on Response, call it through the data member)"
+          else
+            "#   * {#{type}##{method_name} ##{method_name}} => #{member_type}"
+          end
         end
         "# @return [#{type}] Returns a {Seahorse::Client::Response response} object which responds to the following methods:\n#\n" + methods.join("\n")
       else
@@ -218,17 +232,19 @@ module AwsSdkCodeGenerator
     end
 
     def request_syntax_example(method_name, operation, api)
-      SyntaxExample.new(
+      example = SyntaxExample.new(
         api: api,
         shape: Api.shape(operation['input'], api),
         method_name: method_name,
         receiver: 'client',
         resp_var: 'resp',
       ).format
+      # TODO - QuickSight is breaking this
+      example if example && example.lines.count < 1000
     end
 
     def async_request_syntax_example(method_name, operation, api)
-      SyntaxExample.new(
+      example = SyntaxExample.new(
         api: api,
         shape: Api.shape(operation['input'], api),
         method_name: method_name,
@@ -236,15 +252,19 @@ module AwsSdkCodeGenerator
         resp_var: 'async_resp',
         async: true
       ).format
+      # TODO - QuickSight is breaking this
+      example if example && example.lines.count < 1000
     end
 
     def response_structure_example(operation, api)
       output = Api.shape(operation['output'], api) if operation['output']
       if output && output['members'] && output['members'].size > 0
-        Docstring.block_comment(ClientResponseStructureExample.new(
+        docstring = Docstring.block_comment(ClientResponseStructureExample.new(
           shape_ref: operation['output'],
           api: api
         ).to_s)
+        # TODO - QuickSight is breaking this
+        docstring if docstring && docstring.lines.count < 1000
       end
     end
 
@@ -260,7 +280,7 @@ module AwsSdkCodeGenerator
     def see_also_tag(operation, api)
       uid = api['metadata']['uid']
       if api['metadata']['protocol'] != 'api-gateway' && Crosslink.taggable?(uid)
-        "# " + Crosslink.tag_string(uid, operation['name'])
+        "# " + Crosslink.tag_string(uid, operation)
       end
     end
 

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

@@ -5,6 +5,8 @@ require 'set'
 module AwsSdkCodeGenerator
   class ClientResponseStructureExample
 
+    ENUMERABLE_METHODS = Class.new.new.extend(Enumerable).methods - [:count]
+
     # @option options [required, Hash] :shape_ref
     # @option options [required, Hash] :api
     def initialize(options = {})
@@ -40,7 +42,12 @@ module AwsSdkCodeGenerator
         return event_ctx
       elsif shape['members']
         shape['members'].each_pair do |member_name, member_ref|
-          lines += entry(member_ref, "#{context}.#{underscore(member_name)}", visited)
+          method_name = underscore(member_name)
+          if context == 'resp' && ENUMERABLE_METHODS.include?(method_name.to_sym)
+            lines += entry(member_ref, "#{context}.data.#{method_name}", visited)
+          else
+            lines += entry(member_ref, "#{context}.#{method_name}", visited)
+          end
         end
       end
       lines

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

@@ -51,15 +51,18 @@ module AwsSdkCodeGenerator
 
     # @return [Enumerable<String<path>, String<code>>]
     def source_files(options = {})
+
       prefix = options.fetch(:prefix, @service.gem_name)
+      codegenerated_plugins = codegen_plugins(prefix)
+
       Enumerator.new do |y|
         if @service.protocol == 'api-gateway'
           y.yield("#{prefix}/../../README.md", apig_readme)
           y.yield("#{prefix}/plugins/authorizer.rb", authorizer_class)
           y.yield("#{prefix}/plugins/apig_endpoint.rb", apig_endpoint_class)
         end
-        y.yield("#{prefix}.rb", service_module(prefix))
-        unless prefix == 'aws-sdk-sts'
+        y.yield("#{prefix}.rb", service_module(prefix, codegenerated_plugins))
+        unless @service.included_in_core?
           y.yield("#{prefix}/customizations.rb", '')
         end
         y.yield("#{prefix}/types.rb", types_module)
@@ -67,13 +70,23 @@ module AwsSdkCodeGenerator
           y.yield("#{prefix}/event_streams.rb", event_streams_module)
         end
         y.yield("#{prefix}/client_api.rb", client_api_module)
-        y.yield("#{prefix}/client.rb", client_class)
+
+        codegenerated_plugins.each { |p| y.yield(p.path, p.source) }
+
+        y.yield("#{prefix}/client.rb", client_class(codegenerated_plugins))
         if @service.protocol_settings['h2'] == 'eventstream'
-          y.yield("#{prefix}/async_client.rb", async_client_class)
+          y.yield("#{prefix}/async_client.rb", async_client_class(codegenerated_plugins))
         end
         y.yield("#{prefix}/errors.rb", errors_module)
         y.yield("#{prefix}/waiters.rb", waiters_module) if @waiters
         y.yield("#{prefix}/resource.rb", root_resource_class)
+
+        unless @service.legacy_endpoints?
+          y.yield("#{prefix}/endpoint_parameters.rb", endpoint_parameters)
+          y.yield("#{prefix}/endpoints.rb", endpoints_module)
+          y.yield("#{prefix}/endpoint_provider.rb", endpoint_provider)
+        end
+
         if @resources
           @resources['resources'].keys.sort.each do |name|
             path = "#{prefix}/#{Underscore.underscore(name)}.rb"
@@ -84,10 +97,24 @@ module AwsSdkCodeGenerator
       end
     end
 
+    # @return [Enumerable<String<path>, String<code>>]
+    def spec_files(options = {})
+      prefix = options.fetch(:prefix, '')
+      Enumerator.new do |y|
+        y.yield("#{prefix}/spec_helper.rb", spec_helper_file)
+
+        if @service.endpoint_tests && !@service.legacy_endpoints?
+          y.yield("#{prefix}/endpoint_provider_spec.rb", endpoint_provider_spec_file)
+        end
+      end
+    end
+
     private
 
-    def service_module(prefix)
-      Views::ServiceModule.new(service: @service, prefix: prefix).render
+    def service_module(prefix, codegenerated_plugins)
+      Views::ServiceModule.new(
+        service: @service, prefix: prefix,
+        codegenerated_plugins: codegenerated_plugins).render
     end
 
     def types_module
@@ -102,7 +129,7 @@ module AwsSdkCodeGenerator
       Views::ClientApiModule.new(service: @service).render
     end
 
-    def client_class
+    def client_class(codegenerated_plugins)
       Views::ClientClass.new(
         service_identifier: @service.identifier,
         service_name: @service.name,
@@ -121,11 +148,13 @@ module AwsSdkCodeGenerator
         paginators: @service.paginators,
         waiters: @service.waiters,
         examples: @service.examples,
-        custom: @service.protocol == 'api-gateway'
+        custom: @service.protocol == 'api-gateway',
+        legacy_endpoints: @service.legacy_endpoints?,
+        codegenerated_plugins: codegenerated_plugins
       ).render
     end
 
-    def async_client_class
+    def async_client_class(codegenerated_plugins)
       Views::AsyncClientClass.new(
         service_identifier: @service.identifier,
         service_name: @service.name,
@@ -139,6 +168,8 @@ module AwsSdkCodeGenerator
         add_plugins: @service.add_plugins,
         remove_plugins: @service.remove_plugins,
         api: @service.api,
+        legacy_endpoints: @service.legacy_endpoints?,
+        codegenerated_plugins: codegenerated_plugins,
         async_client: true
       ).render
     end
@@ -200,6 +231,44 @@ module AwsSdkCodeGenerator
       ).render
     end
 
+    def endpoint_parameters
+      Views::EndpointParametersClass.new(service: @service).render
+    end
+
+    def endpoint_provider
+      Views::EndpointProviderClass.new(service: @service).render
+    end
+
+    def endpoints_module
+      Views::EndpointsModule.new(service: @service).render
+    end
+
+    def endpoints_plugin
+      Views::EndpointsPlugin.new(service: @service).render
+    end
+
+    def endpoint_provider_spec_file
+      Views::Spec::EndpointProviderSpecClass.new(service: @service).render
+    end
+
+    def codegen_plugins(prefix)
+      unless @service.legacy_endpoints?
+        [
+          CodegeneratedPlugin.new(
+            source: endpoints_plugin,
+            class_name: "#{@service.module_name}::Plugins::Endpoints",
+            path: "#{prefix}/plugins/endpoints.rb"
+          )
+        ]
+      else
+        []
+      end
+    end
+
+    def spec_helper_file
+      Views::Spec::SpecHelper.new(service: @service).render
+    end
+
     private
 
     def has_eventstream

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  class CodegeneratedPlugin
+
+    # @option options [required, String] :source
+    # @option options [required, String] :class_name
+    # @option options [required, String] :path
+    def initialize(options = {})
+      @source = options.fetch(:source)
+      @class_name = options.fetch(:class_name)
+      @path = options.fetch(:path)
+    end
+
+    attr_reader :source, :path, :class_name
+
+
+    def plugin_class
+      if @plugin_class.nil?
+        Object.module_eval(@source)
+        const_names = @class_name.split('::')
+        @plugin_class = const_names.inject(Kernel) do |const, const_name|
+          const.const_get(const_name)
+        end
+      end
+      @plugin_class
+    end
+
+    def options
+      plugin_class.public_send(:options)
+    end
+
+  end
+end

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

@@ -8,26 +8,35 @@ module AwsSdkCodeGenerator
     def initialize(options)
       @options = options
       @service = options.fetch(:service)
+      validate_model!
     end
 
     # @return [Hash]
     attr_reader :options
 
+    def validate_model!
+      validate_document_support!
+    end
+
     def each(&block)
       Enumerator.new do |y|
         y.yield("#{@service.gem_name}.gemspec", gemspec_file)
         y.yield('features/env.rb', features_env_file)
         y.yield('features/step_definitions.rb', features_step_definitions_file)
-        y.yield('spec/spec_helper.rb', spec_helper_file)
         if @service.smoke_tests
           y.yield('features/smoke.feature', smoke_file)
           y.yield('features/smoke_step_definitions.rb', smoke_step_definitions_file)
         end
         y.yield('VERSION', version_file)
+        y.yield('LICENSE.txt', license_file)
+
         code = CodeBuilder.new(@options)
         code.source_files.each do |path, code|
           y.yield("lib/#{path}", code)
         end
+        code.spec_files.each do |path, code|
+          y.yield("spec/#{path}", code)
+        end
       end.each(&block)
     end
 
@@ -53,13 +62,26 @@ module AwsSdkCodeGenerator
       Views::Features::StepDefinitions.new(options).render
     end
 
-    def spec_helper_file
-      Views::Spec::SpecHelper.new(options).render
-    end
-
     def version_file
       Views::Version.new(options).render
     end
 
+    def license_file
+      File.read(File.expand_path('../../../templates/license.txt',__FILE__ ))
+    end
+
+    private
+
+    # document types are only supported for rest-json and json
+    def validate_document_support!
+      return if ['rest-json', 'json'].include?(@service.protocol)
+
+      # Check all shapes and raise if any are Document types
+      @service.api.fetch('shapes', {}).each do |name, shape|
+        if shape['type'] == 'structure' && shape['document']
+          raise "Shape #{name} is a document type.  Document types are only supported in json protocols."
+        end
+      end
+    end
   end
 end

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

@@ -31,6 +31,15 @@ module AwsSdkCodeGenerator
       end.join('.')
     end
 
+    # convert a snake case to pascal case
+    def pascal_case(str)
+      str
+        .to_s
+        .split('_')
+        .collect(&:capitalize)
+        .join
+    end
+
     def structures
       Enumerator.new do |y|
         (@api['shapes'] || {}).each do |shape_name, shape|
@@ -167,7 +176,7 @@ module AwsSdkCodeGenerator
     end
 
     module_function :deep_copy, :operation_streaming?, :downcase_first, :wrap_string, :apig_prefix,
-      :eventstream_output?, :eventstream_input?, :operation_eventstreaming?
+      :eventstream_output?, :eventstream_input?, :operation_eventstreaming?, :pascal_case
 
   end
 end

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

@@ -20,7 +20,7 @@ module AwsSdkCodeGenerator
     def compute_plugins(options)
       plugins = {}
       plugins.update(options[:async_client] ? default_async_plugins : default_plugins)
-      plugins.update(signature_plugins(options.fetch(:signature_version)))
+      plugins.update(signature_plugins(options))
       plugins.update(protocol_plugins(options.fetch(:protocol)))
       plugins.update(options.fetch(:add_plugins))
       options.fetch(:remove_plugins).each do |plugin_name|
@@ -58,12 +58,16 @@ module AwsSdkCodeGenerator
         'Aws::Plugins::ClientMetricsPlugin' => "#{core_plugins}/client_metrics_plugin.rb",
         'Aws::Plugins::ClientMetricsSendPlugin' => "#{core_plugins}/client_metrics_send_plugin.rb",
         'Aws::Plugins::TransferEncoding' => "#{core_plugins}/transfer_encoding.rb",
-        'Aws::Plugins::HttpChecksum' => "#{core_plugins}/http_checksum.rb"
+        'Aws::Plugins::HttpChecksum' => "#{core_plugins}/http_checksum.rb",
+        'Aws::Plugins::ChecksumAlgorithm' => "#{core_plugins}/checksum_algorithm.rb",
+        'Aws::Plugins::DefaultsMode' => "#{core_plugins}/defaults_mode.rb",
+        'Aws::Plugins::RecursionDetection' => "#{core_plugins}/recursion_detection.rb"
       }
     end
 
     def default_async_plugins
       plugins = default_plugins.dup
+      plugins.delete('Seahorse::Client::Plugins::ContentLength')
       plugins.delete('Aws::Plugins::ResponsePaging')
       plugins.delete('Aws::Plugins::EndpointDiscovery')
       plugins.delete('Aws::Plugins::EndpointPattern')
@@ -92,14 +96,31 @@ module AwsSdkCodeGenerator
       }[protocol]
     end
 
-    def signature_plugins(signature_version)
-      case signature_version
-      when 'v4'
-        { 'Aws::Plugins::SignatureV4' => "#{core_plugins}/signature_v4.rb" }
-      when 'v2'
-        { 'Aws::Plugins::SignatureV2' => "#{core_plugins}/signature_v2.rb" }
+    # HACK: Sigv2 is deprecated, Sigv4/Bearer are with core. Always assume
+    # new signer plugin. This logic would be moved to gem dependencies
+    # calculation, but don't worry until new signature type.
+    #
+    # NOTE: If no rules are provided, just use old Signing method
+    def signature_plugins(options)
+      if !options[:legacy_endpoints]
+        {
+          'Aws::Plugins::Sign' => "#{core_plugins}/sign.rb"
+        }
       else
-        {}
+        auth_types  = [options.fetch(:signature_version)]
+        auth_types += options[:api]['operations'].map { |_n, o| o['authtype'] }.compact
+        plugins = {}
+        auth_types.each do |auth_type|
+          case auth_type
+          when 'v4'
+            plugins['Aws::Plugins::SignatureV4'] = "#{core_plugins}/signature_v4.rb"
+          when 'v2'
+            plugins['Aws::Plugins::SignatureV2'] = "#{core_plugins}/signature_v2.rb"
+          when 'bearer'
+            plugins['Aws::Plugins::BearerAuthorization'] = "#{core_plugins}/bearer_authorization.rb"
+          end
+        end
+        plugins
       end
     end
 

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

@@ -14,6 +14,8 @@ module AwsSdkCodeGenerator
     # @option options [Hash, String] :waiters
     # @option options [Hash, String] :resources
     # @option options [Hash, String] :examples
+    # @option options [Hash, String] :endpoint_rules
+    # @option options [Hash, String] :endpoint_tests
     # @option options [Hash, String] :smoke_tests
     # @option options [Hash<gem,version>] :gem_dependencies ({})
     # @option options [Hash] :add_plugins ({})
@@ -34,6 +36,10 @@ module AwsSdkCodeGenerator
       @resources = load_json(options[:resources])
       @examples = load_json(options[:examples])
       @smoke_tests = load_json(options[:smoke_tests])
+      unless options[:legacy_endpoints]
+        @endpoint_rules = load_json(options[:endpoint_rules])
+        @endpoint_tests = load_json(options[:endpoint_tests])
+      end
       @gem_dependencies = options[:gem_dependencies] || {}
       @add_plugins = options[:add_plugins] || {}
       @remove_plugins = options[:remove_plugins] || []
@@ -77,6 +83,22 @@ module AwsSdkCodeGenerator
     # @return [Hash, nil] The service smoke test model.
     attr_reader :smoke_tests
 
+    # @return Boolean True if the service should use legacy endpoints
+    def legacy_endpoints?
+      !@endpoint_rules || @endpoint_rules.empty?
+    end
+
+    # @return Boolean True if the service is inlined in core (ie not a stand alone gem)
+    def included_in_core?
+      %w[STS SSO SSOOIDC].include?(name)
+    end
+
+    # @return [Hash, nil] The service endpoint rules.
+    attr_reader :endpoint_rules
+
+    # @return [Hash, nil] The service endpoint tests.
+    attr_reader :endpoint_tests
+
     # @return [Hash<String,String>] A hash of gem dependencies. Hash keys
     #   are gem names, values are versions.
     attr_reader :gem_dependencies

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

@@ -23,7 +23,11 @@ module AwsSdkCodeGenerator
         @gem_name = options.fetch(:gem_name)
         @gem_version = options.fetch(:gem_version)
         @plugins = PluginList.new(options)
-        @client_constructor = ClientConstructor.new(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
       end
 
@@ -60,7 +64,7 @@ module AwsSdkCodeGenerator
 
       # @return [Array<String>]
       def plugin_class_names
-        @plugins.map(&:class_name)
+        @plugins.map(&:class_name) + @codegenerated_plugins.map(&:class_name)
       end
 
     end