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

data/templates/license.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/templates/method.mustache

@@ -0,0 +1,7 @@
+{{> documentation}}
+def {{method_name}}{{#arguments}}({{{.}}}){{/arguments}}
+  {{> code}}
+end
+{{#alias}}
+alias {{alias}} {{method_name}}
+{{/alias}}

data/templates/resource_class.mustache

@@ -0,0 +1,304 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+
+  class {{class_name}}
+
+    extend Aws::Deprecations
+
+    # @overload def initialize({{#identifiers}}{{name}}, {{/identifiers}}options = {})
+    {{#identifiers}}
+    #   @param [{{type}}] {{name}}
+    {{/identifiers}}
+    #   @option options [Client] :client
+    {{#identifiers?}}
+    # @overload def initialize(options = {})
+    {{#identifiers}}
+    #   @option options [required, {{type}}] :{{name}}
+    {{/identifiers}}
+    #   @option options [Client] :client
+    {{/identifiers?}}
+    def initialize(*args)
+      options = Hash === args.last ? args.pop.dup : {}
+      {{#identifiers}}
+      @{{name}} = extract_{{name}}(args, options)
+      {{/identifiers}}
+      {{#shape}}
+      @data = options.delete(:data)
+      {{/shape}}
+      {{^shape}}
+      @data = Aws::EmptyStructure.new
+      {{/shape}}
+      @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
+    end
+
+    # @!group Read-Only Attributes
+    {{#identifiers}}
+
+    # @return [{{type}}]
+    def {{name}}
+      @{{name}}
+    end
+    {{#alias}}
+    alias :{{alias}} :{{name}}
+    {{/alias}}
+    {{/identifiers}}
+    {{#data_attributes}}
+
+    {{> documentation}}
+    def {{name}}
+      data[:{{name}}]
+    end
+    {{/data_attributes}}
+
+    # @!endgroup
+
+    # @return [Client]
+    def client
+      @client
+    end
+
+    {{#load_method}}
+    {{> method}}
+    {{/load_method}}
+    alias :reload :load
+
+    {{#data_method}}
+    {{> method}}
+    {{/data_method}}
+
+    # @return [Boolean]
+    #   Returns `true` if this resource is loaded.  Accessing attributes or
+    #   {#data} on an unloaded resource will trigger a call to {#load}.
+    def data_loaded?
+      !!@data
+    end
+    {{#exists_waiter}}
+
+    # @param [Hash] options ({})
+    # @return [Boolean]
+    #   Returns `true` if the {{class_name}} exists.
+    def exists?(options = {})
+      begin
+        wait_until_exists(options.merge(max_attempts: 1))
+        true
+      rescue Aws::Waiters::Errors::UnexpectedError => e
+        raise e.error
+      rescue Aws::Waiters::Errors::WaiterFailed
+        false
+      end
+    end
+    {{/exists_waiter}}
+    {{#waiters}}
+
+    # @param [Hash] options ({})
+    # @option options [Integer] :max_attempts ({{max_attempts}})
+    # @option options [Float] :delay ({{delay}})
+    # @option options [Proc] :before_attempt
+    # @option options [Proc] :before_wait
+    # @return [{{class_name}}]
+    def wait_until_{{name}}(options = {}, &block)
+      options, params = separate_params_and_options(options)
+      waiter = Waiters::{{waiter_class_name}}.new(options)
+      yield_waiter_and_warn(waiter, &block) if block_given?
+      {{#wait_call}}
+      {{#lines}}
+      {{{.}}}{{/lines}}
+      {{/wait_call}}
+      {{class_name}}.new({
+      {{#constructor_args}}
+      {{#lines}}
+      {{{.}}}{{/lines}}
+      {{/constructor_args}}
+      })
+    end
+    {{/waiters}}
+    {{#wait_until}}
+
+    # @deprecated Use [{{module_name}}::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource
+    #   remains unchanged.
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) do |instance|
+    #       instance.state.name == 'running'
+    #     end
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is
+    # set by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    # @yieldparam [Resource] resource to be used in the waiting condition.
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
+    #   terminates because the waiter has entered a state that it will not
+    #   transition out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
+    #   encountered while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+    {{/wait_until}}
+    {{#actions?}}
+
+    # @!group Actions
+    {{#actions}}
+
+    {{> method}}
+    {{/actions}}
+    {{/actions?}}
+    {{#associations?}}
+
+    # @!group Associations
+    {{#associations}}
+
+    {{> method}}
+    {{/associations}}
+    {{/associations?}}
+
+    {{#identifiers_method}}
+    {{> method}}
+    {{/identifiers_method}}
+    deprecated(:identifiers)
+    {{#identifiers?}}
+
+    private
+    {{#identifiers}}
+
+    def extract_{{name}}(args, options)
+      value = args[{{offset}}] || options.delete(:{{name}})
+      case value
+      when {{type}} then value
+      when nil then raise ArgumentError, "missing required option :{{name}}"
+      else
+        msg = "expected :{{name}} to be a {{type}}, got #{value.class}"
+        raise ArgumentError, msg
+      end
+    end
+    {{/identifiers}}
+    {{/identifiers?}}
+    {{#waiters?}}
+
+    def yield_waiter_and_warn(waiter, &block)
+      if !@waiter_block_warned
+        msg = "pass options to configure the waiter; "\
+              "yielding the waiter is deprecated"
+        warn(msg)
+        @waiter_block_warned = true
+      end
+      yield(waiter.waiter)
+    end
+
+    def separate_params_and_options(options)
+      opts = Set.new(
+        [:client, :max_attempts, :delay, :before_attempt, :before_wait]
+      )
+      waiter_opts = {}
+      waiter_params = {}
+      options.each_pair do |key, value|
+        if opts.include?(key)
+          waiter_opts[key] = value
+        else
+          waiter_params[key] = value
+        end
+      end
+      waiter_opts[:client] ||= @client
+      [waiter_opts, waiter_params]
+    end
+    {{/waiters?}}
+
+    {{^batch_actions?}}
+    class Collection < Aws::Resources::Collection; end
+    {{/batch_actions?}}
+    {{#batch_actions?}}
+    class Collection < Aws::Resources::Collection
+
+      # @!group Batch Actions
+      {{#batch_actions}}
+
+      {{> method}}
+      {{/batch_actions}}
+
+      # @!endgroup
+
+    end
+    {{/batch_actions?}}
+  end
+end

data/templates/root_resource_class.mustache

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+
+  {{#documentation?}}
+  # This class provides a resource oriented interface for {{service_name}}.
+  # To create a resource object:
+  #
+  #     resource = {{module_name}}::Resource.new(region: 'us-west-2')
+  #
+  # You can supply a client object with custom configuration that will be used for all resource operations.
+  # If you do not pass `:client`, a default client will be constructed.
+  #
+  #     client = {{module_name}}::Client.new(region: 'us-west-2')
+  #     resource = {{module_name}}::Resource.new(client: client)
+  #
+  {{/documentation?}}
+  class Resource
+
+    # @param options ({})
+    # @option options [Client] :client
+    def initialize(options = {})
+      @client = options[:client] || Client.new(options)
+    end
+
+    # @return [Client]
+    def client
+      @client
+    end
+    {{#actions?}}
+
+    # @!group Actions
+    {{#actions}}
+
+    {{> method}}
+    {{/actions}}
+    {{/actions?}}
+    {{#associations?}}
+
+    # @!group Associations
+    {{#associations}}
+
+    {{> method}}
+    {{/associations}}
+    {{/associations?}}
+
+  end
+end

data/templates/service_module.mustache

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+
+{{#require_core_guard?}}
+unless Module.const_defined?(:Aws)
+  {{#requires}}
+  require '{{.}}'
+  {{/requires}}
+end
+{{/require_core_guard?}}
+{{^require_core_guard?}}
+{{#requires}}
+require '{{.}}'
+{{/requires}}
+{{/require_core_guard?}}
+
+{{#relative_requires}}
+require_relative '{{.}}'
+{{/relative_requires}}
+
+# This module provides support for {{full_name}}. This module is available in the
+# `{{gem_name}}` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+{{#example_operation_name}}
+#
+#     {{example_var_name}} = {{module_name}}::Client.new
+#     resp = {{example_var_name}}.{{example_operation_name}}(params)
+{{/example_operation_name}}
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from {{full_name}} are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue {{module_name}}::Errors::ServiceError
+#       # rescues all {{full_name}} API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module {{module_name}}
+
+  GEM_VERSION = '{{gem_version}}'
+
+end

data/templates/spec/spec_helper.mustache

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+require_relative '../../aws-sdk-core/spec/shared_spec_helper'
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+{{#gem_dependencies}}
+$:.unshift(File.expand_path('../../../{{dependency}}/lib', __FILE__))
+{{/gem_dependencies}}
+
+require 'rspec'
+require 'webmock/rspec'
+require '{{gem_name}}'

data/templates/types_module.mustache

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+{{#generated_src_warning}}
+{{generated_src_warning}}
+{{/generated_src_warning}}
+module {{module_name}}
+  module Types
+    {{#structures}}
+
+    {{> documentation}}
+    {{#empty?}}
+    class {{class_name}} < Aws::EmptyStructure; end
+    {{/empty?}}
+    {{^empty?}}
+    class {{class_name}} < Struct.new(
+      {{#members}}
+      :{{member_name}}{{^last}},{{/last}}{{#last}}){{/last}}
+      {{/members}}
+      SENSITIVE = {{sensitive_params}}
+      include Aws::Structure
+      {{#union?}}
+      include Aws::Structure::Union
+
+      {{#members}}
+      class {{member_class_name}} < {{class_name}}; end
+      {{/members}}
+      {{/union?}}
+    end
+    {{/empty?}}
+    {{/structures}}
+    {{#eventstreams}}
+
+    {{> documentation}}
+    class {{class_name}} < Enumerator
+
+      def event_types
+        {{#empty?}}
+        []
+        {{/empty?}}
+        {{^empty?}}
+        [
+        {{#types}}
+          :{{member_name}}{{^last}},{{/last}}
+        {{/types}}
+        ]
+        {{/empty?}}
+      end
+
+    end
+    {{/eventstreams}}
+
+  end
+end

data/templates/version.mustache

@@ -0,0 +1 @@
+{{version}}