aws-sdk-code-generator 0.1.0.pre → 0.2.4.pre

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

@@ -1,91 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'aws-sdk-code-generator/api'
 require_relative 'aws-sdk-code-generator/apply_docs'
+require_relative 'aws-sdk-code-generator/client_constructor'
+require_relative 'aws-sdk-code-generator/client_operation_documentation'
+require_relative 'aws-sdk-code-generator/client_operation_list'
+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/hash_formatter'
 require_relative 'aws-sdk-code-generator/helper'
+require_relative 'aws-sdk-code-generator/plugin_list'
+require_relative 'aws-sdk-code-generator/resource_action'
+require_relative 'aws-sdk-code-generator/resource_action_code'
+require_relative 'aws-sdk-code-generator/resource_association'
+require_relative 'aws-sdk-code-generator/resource_attribute'
+require_relative 'aws-sdk-code-generator/resource_batch_action'
+require_relative 'aws-sdk-code-generator/resource_batch_action_code'
+require_relative 'aws-sdk-code-generator/resource_batch_action_documentation'
+require_relative 'aws-sdk-code-generator/resource_batch_builder'
+require_relative 'aws-sdk-code-generator/resource_builder'
+require_relative 'aws-sdk-code-generator/resource_client_request'
+require_relative 'aws-sdk-code-generator/resource_client_request_documentation'
+require_relative 'aws-sdk-code-generator/resource_client_request_params'
+require_relative 'aws-sdk-code-generator/resource_data_method'
+require_relative 'aws-sdk-code-generator/resource_has_association'
+require_relative 'aws-sdk-code-generator/resource_has_many_association'
+require_relative 'aws-sdk-code-generator/resource_has_many_association_code'
+require_relative 'aws-sdk-code-generator/resource_identifier'
+require_relative 'aws-sdk-code-generator/resource_identifiers_method'
+require_relative 'aws-sdk-code-generator/resource_load_method'
+require_relative 'aws-sdk-code-generator/resource_method'
+require_relative 'aws-sdk-code-generator/resource_skip_params'
+require_relative 'aws-sdk-code-generator/resource_value_source'
+require_relative 'aws-sdk-code-generator/resource_waiter'
 require_relative 'aws-sdk-code-generator/service'
+require_relative 'aws-sdk-code-generator/shared_example'
+require_relative 'aws-sdk-code-generator/eventstream_example'
+require_relative 'aws-sdk-code-generator/syntax_example'
+require_relative 'aws-sdk-code-generator/syntax_example_hash'
 require_relative 'aws-sdk-code-generator/underscore'
 require_relative 'aws-sdk-code-generator/view'
-
-require_relative 'aws-sdk-code-generator/code_builder'
-require_relative 'aws-sdk-code-generator/gem_builder'
-
-# views
+require_relative 'aws-sdk-code-generator/views/client_api_module'
+require_relative 'aws-sdk-code-generator/views/client_class'
+require_relative 'aws-sdk-code-generator/views/async_client_class'
+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'
+require_relative 'aws-sdk-code-generator/views/root_resource_class'
 require_relative 'aws-sdk-code-generator/views/service_module'
 require_relative 'aws-sdk-code-generator/views/spec/spec_helper'
+require_relative 'aws-sdk-code-generator/views/types_module'
+require_relative 'aws-sdk-code-generator/views/event_streams_module'
+require_relative 'aws-sdk-code-generator/views/authorizer_class'
+require_relative 'aws-sdk-code-generator/views/apig_endpoint_class'
+require_relative 'aws-sdk-code-generator/views/apig_readme'
 require_relative 'aws-sdk-code-generator/views/version'
+require_relative 'aws-sdk-code-generator/views/waiters_module'
+require_relative 'aws-sdk-code-generator/waiter'
+require_relative 'aws-sdk-code-generator/yard_option_tag'
 
-module AwsSdkCodeGenerator
-
-  autoload :Errors, 'aws-sdk-code-generator/errors'
-  autoload :HashFormatter, 'aws-sdk-code-generator/hash_formatter'
-  autoload :Helper, 'aws-sdk-code-generator/helper'
-
-  module Dsl
-    autoload :AccessControlStatement, 'aws-sdk-code-generator/dsl/access_control_statement'
-    autoload :AutoloadStatement, 'aws-sdk-code-generator/dsl/autoload_statement'
-    autoload :AttributeAccessor, 'aws-sdk-code-generator/dsl/attribute_accessor'
-    autoload :AttributeReader, 'aws-sdk-code-generator/dsl/attribute_reader'
-    autoload :AttributeWriter, 'aws-sdk-code-generator/dsl/attribute_writer'
-    autoload :BlockParam, 'aws-sdk-code-generator/dsl/block_param'
-    autoload :Class, 'aws-sdk-code-generator/dsl/class'
-    autoload :CodeLiteral, 'aws-sdk-code-generator/dsl/code_literal'
-    autoload :CodeObject, 'aws-sdk-code-generator/dsl/code_object'
-    autoload :Docstring, 'aws-sdk-code-generator/dsl/docstring'
-    autoload :Eigenclass, 'aws-sdk-code-generator/dsl/eigenclass'
-    autoload :ExtendStatement, 'aws-sdk-code-generator/dsl/extend_statement'
-    autoload :IncludeStatement, 'aws-sdk-code-generator/dsl/include_statement'
-    autoload :Main, 'aws-sdk-code-generator/dsl/main'
-    autoload :Method, 'aws-sdk-code-generator/dsl/method'
-    autoload :Module, 'aws-sdk-code-generator/dsl/module'
-    autoload :OptionTag, 'aws-sdk-code-generator/dsl/option_tag'
-    autoload :Param, 'aws-sdk-code-generator/dsl/param'
-    autoload :ParamList,  'aws-sdk-code-generator/dsl/param_list'
-    autoload :ReturnTag, 'aws-sdk-code-generator/dsl/return_tag'
-    autoload :TagDocstring, 'aws-sdk-code-generator/dsl/tag_docstring'
-    autoload :TagDefault, 'aws-sdk-code-generator/dsl/tag_default'
-    autoload :TagType, 'aws-sdk-code-generator/dsl/tag_type'
-  end
+# Public interfaces
+require_relative 'aws-sdk-code-generator/code_builder'
+require_relative 'aws-sdk-code-generator/gem_builder'
 
-  module Generators
-    autoload :ClientApiModule, 'aws-sdk-code-generator/generators/client_api_module'
-    autoload :ClientClass, 'aws-sdk-code-generator/generators/client_class'
-    autoload :ClientOperationDocumentation, 'aws-sdk-code-generator/generators/client_operation_documentation'
-    autoload :ErrorsModule, 'aws-sdk-code-generator/generators/errors_module'
-    autoload :TypesModule, 'aws-sdk-code-generator/generators/types_module'
-    autoload :RootResourceClass, 'aws-sdk-code-generator/generators/root_resource_class'
-    autoload :ResourceClass, 'aws-sdk-code-generator/generators/resource_class'
-    autoload :ResponseStructureExample, 'aws-sdk-code-generator/generators/response_structure_example'
-    autoload :ServiceDocumentation, 'aws-sdk-code-generator/generators/service_documentation'
-    autoload :SharedExample, 'aws-sdk-code-generator/generators/shared_example'
-    autoload :StructureTypeClass, 'aws-sdk-code-generator/generators/structure_type_class'
-    autoload :SyntaxExample, 'aws-sdk-code-generator/generators/syntax_example'
-    autoload :WaiterClass, 'aws-sdk-code-generator/generators/waiter_class'
-    autoload :WaitersModule, 'aws-sdk-code-generator/generators/waiters_module'
+module AwsSdkCodeGenerator
 
-    module Resource
-      autoload :Action, 'aws-sdk-code-generator/generators/resource/action'
-      autoload :BatchBuilder, 'aws-sdk-code-generator/generators/resource/batch_builder'
-      autoload :Builder, 'aws-sdk-code-generator/generators/resource/builder'
-      autoload :ClientGetter,  'aws-sdk-code-generator/generators/resource/client_getter'
-      autoload :ClientRequest,  'aws-sdk-code-generator/generators/resource/client_request'
-      autoload :ClientRequestParams,  'aws-sdk-code-generator/generators/resource/client_request_params'
-      autoload :ClientRequestDocs,  'aws-sdk-code-generator/generators/resource/client_request_docs'
-      autoload :CollectionClass,  'aws-sdk-code-generator/generators/resource/collection_class'
-      autoload :DataMethod, 'aws-sdk-code-generator/generators/resource/data_method'
-      autoload :DataAttributeGetter, 'aws-sdk-code-generator/generators/resource/data_attribute_getter'
-      autoload :DataLoadedMethod, 'aws-sdk-code-generator/generators/resource/data_loaded_method'
-      autoload :ExistsMethod, 'aws-sdk-code-generator/generators/resource/exists_method'
-      autoload :ExtractIdentifierMethod, 'aws-sdk-code-generator/generators/resource/extract_identifier_method'
-      autoload :HasAssociation, 'aws-sdk-code-generator/generators/resource/has_association'
-      autoload :HasManyAssociation, 'aws-sdk-code-generator/generators/resource/has_many_association'
-      autoload :InitializeMethod, 'aws-sdk-code-generator/generators/resource/initialize_method'
-      autoload :IdentifiersMethod, 'aws-sdk-code-generator/generators/resource/identifiers_method'
-      autoload :IdentifierGetter, 'aws-sdk-code-generator/generators/resource/identifier_getter'
-      autoload :LoadMethod, 'aws-sdk-code-generator/generators/resource/load_method'
-      autoload :ValueSource, 'aws-sdk-code-generator/generators/resource/value_source'
-      autoload :WaiterMethod, 'aws-sdk-code-generator/generators/resource/waiter_method'
-    end
-  end
+  GENERATED_SRC_WARNING = <<-WARNING_TXT
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+  WARNING_TXT
 
 end

data/templates/apig_endpoint_class.mustache

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module {{module_name}}
+  module Plugins
+
+    class APIGEndpoint < Seahorse::Client::Plugin
+
+      def after_initialize(client)
+        if client.config.endpoint.nil?
+          client.config.endpoint = '{{default_endpoint}}'
+        end
+      end
+
+    end
+  end
+end

data/templates/apig_readme.mustache

@@ -0,0 +1,62 @@
+# {{service_name}}
+
+This is the Version {{gem_major_version}} of the {{gem_name}} gem.
+
+## WARNING
+
+Please read through this `README.md` and `{{gem_name}}.gemspec` then tailor it with your gem needs before serving it for any official usage or gem publishing. If you have any questions, issue or feature requests for this generated gem, feel free to open an issue or PR againt [`AWS SDK for Ruby`](https://github.com/aws/aws-sdk-ruby)
+
+## API Client
+
+Initialize a service client and list all operations available.
+
+```ruby
+require '{{gem_name}}'
+
+client = {{module_name}}::Client.new
+
+puts client.operation_names
+```
+
+For each operation usage example, see `lib/client.rb` documentation block per operation
+
+## Authorizer
+
+For operations used custom authorizer, you can provide your own authorizer token logic at `lib/plugins/authorizer.rb` under method `generate_token`. For more information, please see [here](http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html).
+
+## AWS Credentials
+
+For those API requets that are authenticated with AWS Credentials (e.g. IAM roles), you would need to configure `:credentials` and `:region` that helps sigining request with [AWS Signature V4](http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). You can also provide those information via your environment:
+
+The SDK searches the following locations for credentials:
+
+* `ENV['AWS_ACCESS_KEY_ID']` and `ENV['AWS_SECRET_ACCESS_KEY']`
+* Unless `ENV['AWS_SDK_CONFIG_OPT_OUT']` is set, the shared configuration files (`~/.aws/credentials` and `~/.aws/config`) will be checked for a `role_arn` and `source_profile`, which if present will be used to attempt to assume a role.
+* The shared credentials ini file at `~/.aws/credentials` ([more information](http://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs))
+* Unless `ENV['AWS_SDK_CONFIG_OPT_OUT']` is set, the shared configuration ini file at `~/.aws/config` will also be parsed for credentials.
+* From an instance profile when running on EC2, or from the ECS credential provider when running in an ECS container with that feature enabled.
+
+The SDK searches the following locations for a region:
+
+* `ENV['AWS_REGION']`
+* Unless `ENV['AWS_SDK_CONFIG_OPT_OUT']` is set, the shared configuration files (`~/.aws/credentials` and `~/.aws/config`) will also be checked for a region selection.
+
+Valid region and credentials options are:
+
+* `:region` - A string like `us-west-2`.
+* `:credentials` - An instance of one of the following classes:
+* [`Aws::Credentials`](http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Credentials.html)
+* [`Aws::SharedCredentials`](http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SharedCredentials.html)
+* [`Aws::InstanceProfileCredentials`](http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/InstanceProfileCredentials.html)
+* [`Aws::AssumeRoleCredentials`](http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AssumeRoleCredentials.html)
+
+## API Key
+
+Simply provide an `:api_key` value when calling an API along with other params, this value will be picked up in the `x-api-key` header value.
+
+## License
+
+DEFAULT: This library is distributed under the
+[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Feel free to change your license specification here and at `{{gem_name}}.gemspec`

data/templates/async_client_class.mustache

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+begin
+  require 'http/2'
+rescue LoadError; end
+{{#plugin_requires}}
+require '{{.}}'
+{{/plugin_requires}}
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:{{service_identifier}})
+
+module {{module_name}}
+  class AsyncClient < Seahorse::Client::AsyncBase
+
+    include Aws::AsyncClientStubs
+
+    @identifier = :{{service_identifier}}
+
+    set_api(ClientApi::API)
+
+    {{#plugin_class_names}}
+    add_plugin({{{.}}})
+    {{/plugin_class_names}}
+
+    {{#client_constructor}}
+    {{>documentation}}
+    {{/client_constructor}}
+    def initialize(*args)
+      unless Kernel.const_defined?("HTTP2")
+        raise "Must include http/2 gem to use AsyncClient instances."
+      end
+      super
+    end
+
+    # @!group API Operations
+    {{#operations}}
+
+    {{#documentation}}
+    {{>documentation}}
+    {{/documentation}}
+    # @overload {{name}}(params = {})
+    # @param [Hash] params ({})
+    def {{name}}(params = {}, options = {}{{{block_option}}})
+      params = params.dup
+      {{#eventstream_input}}
+      input_event_stream_handler = _event_stream_handler(
+        :input,
+        params.delete(:input_event_stream_handler),
+        EventStreams::{{input_eventstream_member}}
+      )
+      {{/eventstream_input}}
+      {{#eventstream_output}}
+      output_event_stream_handler = _event_stream_handler(
+        :output,
+        params.delete(:output_event_stream_handler) || params.delete(:event_stream_handler),
+        EventStreams::{{output_eventstream_member}}
+      )
+      {{/eventstream_output}}
+
+      yield({{#eventstream_output}}output_event_stream_handler{{/eventstream_output}}) if block_given?
+
+      req = build_request(:{{name}}, params)
+
+      {{#eventstream_input}}
+      req.context[:input_event_stream_handler] = input_event_stream_handler
+      req.handlers.add(Aws::Binary::EncodeHandler, priority: 95)
+      {{/eventstream_input}}
+      {{#eventstream_output}}
+      req.context[:output_event_stream_handler] = output_event_stream_handler
+      req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)
+      {{/eventstream_output}}
+
+      req.send_request(options{{{block_option}}})
+    end
+    {{/operations}}
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        http_response: Seahorse::Client::Http::AsyncResponse.new,
+        config: config)
+      context[:gem_name] = '{{gem_name}}'
+      context[:gem_version] = '{{gem_version}}'
+      Seahorse::Client::Request.new(handlers, context)
+    end
+
+    private
+
+    def _event_stream_handler(type, handler, event_stream_class)
+      case handler
+      when event_stream_class then handler
+      when Proc then event_stream_class.new.tap(&handler)
+      when nil then event_stream_class.new
+      else
+        msg = "expected #{type}_event_stream_handler to be a block or "\
+              "instance of {{module_name}}::#{event_stream_class}"\
+              ", got `#{handler.inspect}` instead"
+        raise ArgumentError, msg
+      end
+    end
+
+    class << self
+
+      # @api private
+      attr_reader :identifier
+
+      # @api private
+      def errors_module
+        Errors
+      end
+
+    end
+  end
+end

data/templates/authorizer_class.mustache

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module {{module_name}}
+  module Plugins
+
+    # APIG Custom Authorizer, generated token will be used by API Gateway
+    # to interact with AWS Lambda for authentication
+    #
+    # More information see: http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
+    class Authorizer < Seahorse::Client::Plugin
+
+      def add_handlers(handlers, config)
+        handlers.add(CustomAuthHandler, step: :initialize)
+      end
+
+      # @api private
+      class CustomAuthHandler < Seahorse::Client::Handler
+
+        def call(context)
+          if context.operation['authtype'] == 'custom'
+            context.config.authorizer_token = generate_token(context)
+          end
+          @handler.call(context)
+        end
+
+        private
+
+        # TODO
+        # Provide your own token generation logic here
+        def generate_token(context)
+          nil
+        end
+
+      end
+    end
+  end
+end

data/templates/client_api_module.mustache

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+  # @api private
+  module ClientApi
+
+    include Seahorse::Model
+
+    {{#shapes}}
+    {{name}} = {{class_name}}.new({{{constructor_args}}})
+    {{/shapes}}
+
+    {{#shape_definitions}}
+    {{#lines}}
+    {{{.}}}{{/lines}}
+
+    {{/shape_definitions}}
+
+    # @api private
+    API = Seahorse::Model::Api.new.tap do |api|
+
+      api.version = "{{api_version}}"
+
+      api.metadata = {
+        {{#metadata}}
+        {{{key}}} => {{{value}}},
+        {{/metadata}}
+      }
+      {{#endpoint_operation}}
+      api.endpoint_operation = :{{endpoint_operation}}
+      {{/endpoint_operation}}
+      {{#require_endpoint_discovery}}
+      api.require_endpoint_discovery = true
+      {{/require_endpoint_discovery}}
+      {{#operations}}
+
+      api.add_operation(:{{method_name}}, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "{{name}}"
+        o.http_method = "{{http_method}}"
+        o.http_request_uri = "{{{http_request_uri}}}"
+        {{#http_checksum_required}}
+        o.http_checksum_required = true
+        {{/http_checksum_required}}
+        {{#deprecated}}
+        o.deprecated = true
+        {{/deprecated}}
+        {{#endpoint_operation}}
+        o.endpoint_operation = true
+        {{/endpoint_operation}}
+        {{#endpoint_discovery_available}}
+        o.endpoint_discovery = {
+          {{#endpoint_discovery}}
+          {{{key}}} => {{{value}}},
+          {{/endpoint_discovery}}
+        }
+        {{/endpoint_discovery_available}}
+        {{#authorizer}}
+        o.authorizer = "{{authorizer}}"
+        {{/authorizer}}
+        {{#authtype}}
+        o['authtype'] = "{{.}}"
+        {{/authtype}}
+        {{#endpoint_trait}}
+        o.endpoint_pattern = {
+          {{#endpoint_pattern}}
+          {{{key}}} => {{{value}}},
+          {{/endpoint_pattern}}
+        }
+        {{/endpoint_trait}}
+        {{#require_apikey}}
+        o.require_apikey = {{require_apikey}}
+        {{/require_apikey}}
+        {{#shape_references}}
+        {{#lines}}
+        {{{.}}}{{/lines}}
+        {{/shape_references}}
+        {{#error_shape_names}}
+        o.errors << Shapes::ShapeRef.new(shape: {{.}})
+        {{/error_shape_names}}
+        {{#pager}}
+        {{#lines}}
+        {{{.}}}{{/lines}}
+        {{/pager}}
+        {{#async}}
+        o.async = true
+        {{/async}}
+      end)
+      {{/operations}}
+      {{#apig_authorizer}}
+
+      api.add_authorizer(:{{authorizer_name}}, Seahorse::Model::Authorizer.new.tap do |a|
+        a.name = "{{name}}"{{#type}}
+        a.type = "{{type}}"{{/type}}{{#location}}
+        a.placement = {
+          :location => "{{location}}",
+          :name => "{{location_name}}"
+        }{{/location}}
+      end)
+      {{/apig_authorizer}}
+    end
+
+  end
+end