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

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class ClientClass < View
+
+      # @option options [required, String] :service_identifier
+      # @option options [required, String] :service_name
+      # @option options [required, String] :module_name
+      # @option options [required, String] :gem_name
+      # @option options [required, String] :gem_version
+      # @option options [required, String] :aws_sdk_core_lib_path
+      # @option options [required, String] :protocol
+      # @option options [required, String] :signature_version
+      # @option options [required, Boolean] :endpoint_discovery_required
+      # @option options [required, Hash] :add_plugins
+      # @option options [required, Array] :remove_plugins
+      # @option options [required, Hash] :api
+      # @option options [Hash] :waiters
+      # @option options [Hash] :client_examples
+      def initialize(options)
+        @service_identifier = options.fetch(:service_identifier)
+        @service_name = options.fetch(:service_name)
+        @module_name = options.fetch(:module_name)
+        @gem_name = options.fetch(:gem_name)
+        @gem_version = options.fetch(:gem_version)
+        @plugins = PluginList.new(options)
+        @client_constructor = ClientConstructor.new(options.merge(plugins: @plugins))
+        @operations = ClientOperationList.new(options).to_a
+        @waiters = Waiter.build_list(options[:waiters])
+        @custom = options.fetch(:custom)
+      end
+
+      # @return [String]
+      attr_reader :service_identifier
+
+      # @return [String]
+      attr_reader :service_name
+
+      # @return [String]
+      attr_reader :module_name
+
+      # @return [String]
+      attr_reader :gem_name
+
+      # @return [String]
+      attr_reader :gem_version
+
+      # @return [ClientConstructor]
+      attr_reader :client_constructor
+
+      # @return [Array<Operation>]
+      attr_reader :operations
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @custom
+        GENERATED_SRC_WARNING
+      end
+
+      # @return [Array<String>]
+      def plugin_requires
+        @plugins.map(&:require_path)
+      end
+
+      # @return [Array<String>]
+      def plugin_class_names
+        @plugins.map(&:class_name)
+      end
+
+      # @return [Array<Waiter>]
+      def waiters
+        @waiters
+      end
+
+      # @return [Boolean]
+      def waiters?
+        @waiters.size > 0
+      end
+
+      # @return [String<Markdown>]
+      def waiters_markdown_table
+        Waiter.markdown_table(@waiters)
+      end
+
+      # @return [Boolean]
+      def authorizer?
+        @custom
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module AwsSdkCodeGenerator
+  module Views
+    class BlockComment < View
+
+      # @param [String, nil] text
+      def initialize(text)
+        @text = text
+      end
+
+      # @return [Array<String>]
+      def lines
+        @text.to_s.lines.map do |line|
+          if line == "\n"
+            "#"
+          else
+            "# #{line}"
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class ErrorsModule < View
+
+      # @option options [required, Service] :service
+      def initialize(options)
+        @service = options.fetch(:service)
+        @service_name = @service.name
+        @errors = ErrorList.new(api: @service.api, module_name: module_name).to_a
+      end
+
+      # @return [Array<Error>]
+      attr_reader :errors
+
+      # @return [String]
+      attr_reader :service_name
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @service.protocol == 'api-gateway'
+        GENERATED_SRC_WARNING
+      end
+
+      def module_name
+        @service.module_name
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class EventStreamsModule < View
+
+      include Helper
+
+      def initialize(options)
+        @service = options.fetch(:service)
+        input, output = extract_eventstreams
+        @input_eventstreams = input
+        @output_eventstreams = output
+      end
+
+      # @return [Array<EventStreamClass>]
+      attr_reader :input_eventstreams
+
+      # @return [Array<EventStreamClass>]
+      attr_reader :output_eventstreams
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @service.protocol == 'api-gateway'
+        GENERATED_SRC_WARNING
+      end
+
+      def module_name
+        @service.module_name
+      end
+
+      def extract_eventstreams
+        es = []
+        @service.api['operations'].each do |_, ref|
+          pair = []
+          if input = ref['input']
+            input_shape = @service.api['shapes'][input['shape']]
+            input_shape['members'].each do |_, m_ref|
+              if @service.api['shapes'][m_ref['shape']]['eventstream']
+                shape = @service.api['shapes'][m_ref['shape']]
+                pair << {
+                  class_name: m_ref['shape'],
+                  event_entries: eventstream_members_w_doc(shape),
+                  types: eventstream_members(shape)
+                }
+              end
+            end
+          end
+          # have a placeholder for input
+          pair << nil if pair.empty?
+          if output = ref['output']
+            output_shape = @service.api['shapes'][output['shape']]
+            output_shape['members'].each do |_, m_ref|
+              if @service.api['shapes'][m_ref['shape']]['eventstream']
+                shape = @service.api['shapes'][m_ref['shape']]
+                pair << {
+                  class_name: m_ref['shape'],
+                  types: eventstream_members(shape)
+                }
+              end
+            end
+          end
+          es << pair unless pair.compact.empty?
+        end
+        # rename eventstream when needed
+        input_es = []
+        output_es = []
+        es.each do |pair|
+          input, output = pair
+          # bidirectional and sharing same eventstream shape
+          if input && output && input[:class_name] == output[:class_name]
+            input[:class_name] = "Input" + input[:class_name]
+            output[:class_name] = "Output" + output[:class_name]
+          end
+          input_es << EventStreamClass.new(input) if input
+          output_es << EventStreamClass.new(output) if output
+        end
+        [input_es, output_es]
+      end
+
+      def eventstream_members(shape)
+        raise 'no event members for an eventstream' if shape['members'].nil?
+        shape['members'].keys.map {|m| underscore(m)}
+      end
+
+      def eventstream_members_w_doc(shape)
+        raise 'no event members for an eventstream' if shape['members'].nil?
+        shape['members'].inject([]) do |m, (n, ref)|
+          event_shape = @service.api['shapes'][ref['shape']]
+          option_tags = event_shape['members'].map do |member_name, member_ref|
+            next if member_ref['documented'] === false
+            docstring = Api.docstring(member_ref, @service.api)
+            YardOptionTag.new(
+              name: Underscore.underscore(member_name),
+              ruby_type: Api.ruby_input_type(member_ref, @service.api),
+              required: shape.fetch('required', []).include?(member_name),
+              docstring: Docstring.html_to_markdown(docstring),
+              option_hash_name: 'params',
+            ).to_s
+          end
+          param_hash_str = Docstring.join_docstrings([option_tags], block_comment: false)
+          m << EventEntry.new(
+            name: underscore(n),
+            param_hash: Docstring.indent(param_hash_str, '      ')
+          )
+          m
+        end
+      end
+
+      private
+
+      class EventEntry
+
+        def initialize(options)
+          @name = options.fetch(:name)
+          @param_hash = options.fetch(:param_hash)
+        end
+
+        # @return [String]
+        attr_reader :name
+
+        # @return [String]
+        attr_reader :param_hash
+
+      end
+
+      class EventStreamClass
+
+        def initialize(options)
+          @class_name = options.fetch(:class_name)
+          @types = options.fetch(:types)
+          @event_entries = options[:event_entries] || []
+        end
+
+        # @return [String]
+        attr_accessor :class_name
+
+        # @return [Array<String>]
+        attr_accessor :types
+
+        # @return [Array<EventEntry>]
+        attr_reader :event_entries
+
+      end
+
+    end
+  end
+end
+    

data/lib/aws-sdk-code-generator/views/features/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AwsSdkCodeGenerator
   module Views
     module Features
@@ -12,12 +14,19 @@ module AwsSdkCodeGenerator
           @gem_dependencies = service.gem_dependencies.map do |gem_name, _|
             { dependency: gem_name }
           end
+          @custom = service.protocol == 'api-gateway'
         end
 
         attr_reader :gem_name
         attr_reader :module_name
         attr_reader :gem_dependencies
 
+        # @return [String|nil]
+        def generated_src_warning
+          return if @custom
+          GENERATED_SRC_WARNING
+        end
+
       end
     end
   end

data/lib/aws-sdk-code-generator/views/features/smoke.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module Features
+      class Smoke < View
+
+        # @param [Hash] options
+        # @option options [required, Service] :service
+        def initialize(options)
+          service = options.fetch(:service)
+          @custom = service.protocol == 'api-gateway'
+          @service = service.name
+
+          # This will only be called if this is defined
+          smoke_json = service.smoke_tests
+          @client_region = smoke_json["defaultRegion"]
+          @client_endpoint = smoke_json["defaultEndpoint"]
+          @smoke_tests = smoke_json["testCases"].map do |test|
+            h = {
+              operation: underscore(test["operationName"]),
+              smoke_test_tags: "@#{service.identifier} @smoke",
+            }
+            if test["errorExpectedFromService"]
+              h[:error_expectation] = "I expect an error was raised"
+              h[:scenario_string] = "Call Aws::#{service.module_name}::Client##{h[:operation]} and expect it to fail"
+            else
+              h[:error_expectation] = "I expect an error was not raised"
+              h[:scenario_string] = "Call #{service.module_name}::Client##{h[:operation]} and expect it to succeed"
+            end
+            h[:param_hash] = test["input"].inject({}) do |acc, kv|
+              raw_key, value = kv
+              key = underscore(raw_key)
+              acc[key] = value
+              acc
+            end.to_json
+            h
+          end
+        end
+
+        attr_reader :service, :client_region, :client_endpoint, :smoke_tests
+
+        # @return [String|nil]
+        def generated_src_warning
+          return if @custom
+          GENERATED_SRC_WARNING
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-code-generator/views/features/smoke_step_definitions.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    module Features
+      class SmokeStepDefinitions < View
+
+        # @param [Hash] options
+        # @option options [required, Service] :service
+        def initialize(options)
+          service = options.fetch(:service)
+          @module_name = service.module_name
+        end
+
+        attr_reader :module_name
+
+        # @return [String|nil]
+        def generated_src_warning
+          return if @custom
+          GENERATED_SRC_WARNING
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-code-generator/views/features/step_definitions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AwsSdkCodeGenerator
   module Views
     module Features
@@ -9,10 +11,12 @@ module AwsSdkCodeGenerator
           service = options.fetch(:service)
           @var_name = service.identifier
           @module_name = service.module_name
+          if service.smoke_tests
+            @client_endpoint = service.smoke_tests['defaultEndpoint']
+          end
         end
 
-        attr_reader :var_name
-        attr_reader :module_name
+        attr_reader :var_name, :module_name, :client_endpoint
 
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AwsSdkCodeGenerator
   module Views
     class Gemspec < View
@@ -5,6 +7,13 @@ module AwsSdkCodeGenerator
       # @option options [required, Service] :service
       def initialize(options)
         @service = options.fetch(:service)
+        @custom = @service.protocol == 'api-gateway'
+      end
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @service.protocol == 'api-gateway'
+        GENERATED_SRC_WARNING
       end
 
       # @return [String]
@@ -12,21 +21,46 @@ module AwsSdkCodeGenerator
         @service.gem_name
       end
 
+      def author
+        @custom ? 'Author Name' : 'Amazon Web Services'
+      end
+
+      def homepage
+        @custom ? 'http://gem-homepage.com' : 'https://github.com/aws/aws-sdk-ruby'
+      end
+
+      def email
+        @custom ? 'yourname@email.com' : 'aws-dr-rubygems@amazon.com'
+      end
+
       # @return [String]
       def summary
-        "AWS SDK for Ruby - #{@service.short_name}"
+        @custom ? @service.short_name : "AWS SDK for Ruby - #{@service.short_name}"
+      end
+
+      def metadata
+        @custom ? false : true
       end
 
       # @return [String]
       def description
-        if @service.short_name != @service.full_name
-          abbreviation = " (#{@service.short_name})"
+        if @custom
+          desc = "Gem Description"
+        else
+          if @service.short_name != @service.full_name
+            abbreviation = " (#{@service.short_name})"
+          end
+          desc = "Official AWS Ruby gem for #{@service.full_name}#{abbreviation}. "
+          desc += 'This gem is part of the AWS SDK for Ruby.'
         end
-        desc = "Official AWS Ruby gem for #{@service.full_name}#{abbreviation}. "
-        desc += 'This gem is part of the AWS SDK for Ruby.'
         desc
       end
 
+      # @return [String]
+      def code_uri
+        "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/#{gem_name}"
+      end
+
       # @return [Array<Dependency>]
       def dependencies
         @service.gem_dependencies.map do |gem, version|

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class ResourceClass < View
+
+      def initialize(options)
+        @module_name = options.fetch(:module_name)
+        @class_name = options.fetch(:class_name)
+        api = options.fetch(:api)
+        resource = options.fetch(:resource)
+        @identifiers = ResourceIdentifier.build_list(resource)
+        @identifiers_method = ResourceIdentifiersMethod.build(@identifiers)
+        @data_attributes = ResourceAttribute.build_list(resource, api)
+        @load_method = ResourceLoadMethod.build(@class_name, resource)
+        @data_method = ResourceDataMethod.build(@class_name, resource)
+        @client_load_method = Underscore.underscore(resource['load']['request']['operation']) if resource['load']
+        @data_class = "Types::#{resource['shape']}"
+        @waiters = ResourceWaiter.build_list(resource, options[:waiters])
+        @wait_until = options[:waiters] # add #wait_until method if service has waiters
+        @actions = ResourceAction.build_list(@class_name, resource, api)
+        @associations = build_associations(options)
+        @batch_actions = ResourceBatchAction.build_list(@class_name, resource, api)
+        @shape = resource['shape']
+        @custom = options.fetch(:custom)
+      end
+
+      # @return [String]
+      attr_reader :module_name
+
+      # @return [String]
+      attr_reader :class_name
+
+      # @return [Array<ResourceIdentifier>]
+      attr_reader :identifiers
+
+      # @return [String]
+      attr_reader :identifiers_method
+
+      # @return [Array<ResourceAttribute>]
+      attr_reader :data_attributes
+
+      # @return [String]
+      attr_reader :data_class
+
+      # @return [String]
+      attr_reader :load_method
+
+      # @return [String]
+      attr_reader :data_method
+
+      # @return [String, nil]
+      attr_reader :client_load_method
+
+      # @return [Array<Waiter>]
+      attr_reader :waiters
+
+      # @return [Boolean]
+      attr_reader :wait_until
+
+      # @return [Array<ResourceAction>]
+      attr_reader :actions
+
+      # @return [Array<ResourceAssociation>]
+      attr_reader :associations
+
+      # @return [Array<ResourceBatchAction>]
+      attr_reader :batch_actions
+
+      # @return [String, nil]
+      attr_reader :shape
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @custom
+        GENERATED_SRC_WARNING
+      end
+
+      # @return [Boolean]
+      def waiters?
+        !@waiters.empty?
+      end
+
+      # @return [ResoruceWiater, nil]
+      def exists_waiter
+        @waiters.find { |w| w.name == 'exists' }
+      end
+
+      # @return [Boolean]
+      def actions?
+        actions.size > 0
+      end
+
+      # @return [Boolean]
+      def associations?
+        associations.size > 0
+      end
+
+      # @return [Boolean]
+      def batch_actions?
+        batch_actions.size > 0
+      end
+
+      # @return [Boolean]
+      def identifiers?
+        @identifiers.size > 0
+      end
+
+      private
+
+      def build_associations(options)
+        ResourceAssociation.build_list(
+          class_name: options.fetch(:class_name),
+          resource: options.fetch(:resource),
+          api: options.fetch(:api),
+          paginators: options.fetch(:paginators)
+        )
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module AwsSdkCodeGenerator
+  module Views
+    class RootResourceClass < View
+
+      def initialize(options)
+        @module_name = options.fetch(:module_name)
+        @service_name = options.fetch(:service_name)
+        class_name = @module_name.split('::').last
+        api = options.fetch(:api)
+        resource = (options[:resources] || {})['service'] || {}
+        @actions = ResourceAction.build_list(class_name, resource, api)
+        @associations = ResourceAssociation.build_list(
+          class_name: class_name,
+          resource: resource,
+          api: api,
+          paginators: options.fetch(:paginators)
+        )
+        @custom = options.fetch(:custom)
+      end
+
+      # @return [String]
+      attr_reader :module_name
+
+      # @return [Array<ResourceAction>]
+      attr_reader :actions
+
+      # @return [Array<ResourceAssociation>]
+      attr_reader :associations
+
+      # @return [String]
+      attr_reader :service_name
+
+      # @return [String|nil]
+      def generated_src_warning
+        return if @custom
+        GENERATED_SRC_WARNING
+      end
+
+      # @return [Boolean]
+      def actions?
+        actions.size > 0
+      end
+
+      # @return [Boolean]
+      def associations?
+        associations.size > 0
+      end
+
+      # @return [Boolean]
+      def documentation?
+        actions? || associations?
+      end
+
+    end
+  end
+end