aws-sdk-code-generator 0.1.0.pre

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

@@ -0,0 +1,126 @@
+module AwsSdkCodeGenerator
+  class Service
+
+    # @param [Hash] options
+    # @option options [required, String] :gem_version Gem version, e.g. "1.0.0".
+    # @option options [required, String] :name The service name, e.g. "S3"
+    # @option options [String] :module_name The service module name, defaults
+    #   to "Aws::#{name}", e.g. "Aws::S3".
+    # @option options [required, Hash, String] :api
+    # @option options [Hash, String] :docs
+    # @option options [Hash, String] :paginators
+    # @option options [Hash, String] :waiters
+    # @option options [Hash, String] :resources
+    # @option options [Hash, String] :examples
+    # @option options [Hash<gem,version>] :gem_dependencies ({})
+    # @option options [Hash] :add_plugins ({})
+    # @option options [Hash] :remove_plugins ([])
+    def initialize(options)
+      @name = options.fetch(:name)
+      @identifier = name.downcase
+      @module_name = options[:module_name] || "Aws::#{name}"
+      @gem_name = options[:gem_name] || "aws-sdk-#{identifier}"
+      @gem_version = options.fetch(:gem_version)
+      @api = load_json(options.fetch(:api))
+      ApplyDocs.new(@api).apply(load_json(options[:docs]))
+      @paginators = load_json(options[:paginators])
+      @waiters = load_json(options[:waiters])
+      @resources = load_json(options[:resources])
+      @examples = load_json(options[:examples])
+      @gem_dependencies = {
+        'aws-sdk-core' => '3.0.0.rc1'
+      }.merge(options[:gem_dependencies] || {})
+      @add_plugins = options[:add_plugins] || {}
+      @remove_plugins = options[:remove_plugins] || []
+      @endpoints_key = options.fetch(:endpoints_key, nil)
+
+      # computed attributes
+      @protocol = api.fetch('metadata').fetch('protocol')
+      @api_version = api.fetch('metadata')['apiVersion']
+      @signature_version = api.fetch('metadata')['signatureVersion']
+      @full_name = api.fetch('metadata')['serviceFullName']
+      @short_name = api.fetch('metadata')['serviceAbbreviation'] || @full_name
+    end
+
+    # @return [String] The service name, e.g. "S3"
+    attr_reader :name
+
+    # @return [String] The service module, e.g. "Aws::S3"
+    attr_reader :module_name
+
+    # @return [Hash] The service API model.
+    attr_reader :api
+
+    # @return [Hash, nil] The service paginators model.
+    attr_reader :paginators
+
+    # @return [Hash, nil] The service waiters model.
+    attr_reader :waiters
+
+    # @return [Hash, nil] The service resource model.
+    attr_reader :resources
+
+    # @return [Hash, nil] The service shared examples model.
+    attr_reader :examples
+
+    # @return [Hash<String,String>] A hash of gem dependencies. Hash keys
+    #   are gem names, values are versions.
+    attr_reader :gem_dependencies
+
+    # @return [String]
+    attr_reader :gem_version
+
+    # @return [String, nil]
+    attr_reader :endpoints_key
+
+    # @return [Hash<String,String>] A hash of plugins to add.
+    attr_reader :add_plugins
+
+    # @return [Array<String>] A list of default plugins to remove.
+    attr_reader :remove_plugins
+
+    # @return [String] The service identifier, e.g. "s3"
+    attr_reader :identifier
+
+    # @return [String] The gem name, e.g. "aws-sdk-s3"
+    attr_reader :gem_name
+
+    # @return [String] The service protocol, e.g. "json", "query", etc.
+    attr_reader :protocol
+
+    # @return [String] The service API version, e.g. "YYYY-MM-DD".
+    attr_reader :api_version
+
+    # @return [String] The signature version, e.g. "v4"
+    attr_reader :signature_version
+
+    # @return [String] The full product name for the service,
+    #   e.g. "Amazon Simple Storage Service".
+    attr_reader :full_name
+
+    # @return [String] The short product name for the service, e.g. "Amazon S3".
+    attr_reader :short_name
+
+    # @api private
+    def inspect
+      "#<#{self.class.name}>"
+    end
+
+    private
+
+    def load_json(value)
+      case value
+      when nil then nil
+      when Hash then value
+      when String
+        File.open(value, 'rb') do |file|
+          JSON.load(file.read)
+        end
+      else
+        "expected String, Hash, or nil, got `#{value.class}'"
+        raise ArgumentError, msg
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,45 @@
+module AwsSdkCodeGenerator
+  module Underscore
+    class << self
+
+      def irregular_inflections(hash)
+        @irregular_inflections.update(hash)
+        @irregular_regex = Regexp.new(@irregular_inflections.keys.join('|'))
+      end
+
+      # @param [String] string
+      # @return [String] Returns the underscored version of the given string.
+      def underscore(string)
+        string.
+          gsub(@irregular_regex) { |word| '_' + @irregular_inflections[word] }.
+          gsub(/([A-Z0-9]+)([A-Z][a-z])/, '\1_\2').
+          scan(/[a-z0-9]+|\d+|[A-Z0-9]+[a-z]*/).
+          join('_').downcase
+      end
+
+      # @param [String<JMESPath>]
+      # @return [String]
+      def underscore_jmespath(expression)
+        expression.
+          gsub(' or ', '||').
+          gsub(/(?<![`'])\b\w+\b(?![`'])/) { |str| Underscore.underscore(str) }
+      end
+
+    end
+
+    @irregular_inflections = {}
+
+    irregular_inflections({
+      'ARNs' => 'arns',
+      'CNAMEs' => 'cnames',
+      'ETag' => 'etag',
+      'Ec2' => 'ec2',
+      'ElastiCache' => 'elasticache',
+      'iSCSI' => 'iscsi',
+      'ACLs' => 'acls',
+      'Md5s' => 'md5s',
+      #'SSEKMS' => 'sse_kms',
+    })
+
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'mustache'
+
+module AwsSdkCodeGenerator
+  class View < Mustache
+
+    TEMPLATE_DIR = File.expand_path('../../../templates', __FILE__)
+
+    def self.inherited(subclass)
+      parts = subclass.name.split('::')
+      parts.shift #=> remove AwsSdkCodeGenerator
+      parts.shift #=> remove Views
+      path = parts.map { |part| Underscore.underscore(part) }.join('/')
+      subclass.template_path = TEMPLATE_DIR
+      subclass.template_file = "#{TEMPLATE_DIR}/#{path}.mustache"
+      subclass.raise_on_context_miss = true
+    end
+
+    def underscore(string)
+      Underscore.underscore(string)
+    end
+
+  end
+end

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

@@ -0,0 +1,3 @@
+require 'gemspec'
+
+module Views; end

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

@@ -0,0 +1,24 @@
+module AwsSdkCodeGenerator
+  module Views
+    module Features
+      class Env < View
+
+        # @param [Hash] options
+        # @option options [required, Service] :service
+        def initialize(options)
+          service = options.fetch(:service)
+          @gem_name = service.gem_name
+          @module_name = service.module_name
+          @gem_dependencies = service.gem_dependencies.map do |gem_name, _|
+            { dependency: gem_name }
+          end
+        end
+
+        attr_reader :gem_name
+        attr_reader :module_name
+        attr_reader :gem_dependencies
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module AwsSdkCodeGenerator
+  module Views
+    module Features
+      class StepDefinitions < View
+
+        # @param [Hash] options
+        # @option options [required, Service] :service
+        def initialize(options)
+          service = options.fetch(:service)
+          @var_name = service.identifier
+          @module_name = service.module_name
+        end
+
+        attr_reader :var_name
+        attr_reader :module_name
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module AwsSdkCodeGenerator
+  module Views
+    class Gemspec < View
+
+      # @option options [required, Service] :service
+      def initialize(options)
+        @service = options.fetch(:service)
+      end
+
+      # @return [String]
+      def gem_name
+        @service.gem_name
+      end
+
+      # @return [String]
+      def summary
+        "AWS SDK for Ruby - #{@service.short_name}"
+      end
+
+      # @return [String]
+      def description
+        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.'
+        desc
+      end
+
+      # @return [Array<Dependency>]
+      def dependencies
+        @service.gem_dependencies.map do |gem, version|
+          Dependency.new(gem, version)
+        end
+      end
+
+      Dependency = Struct.new(:gem, :version)
+
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+require 'set'
+
+module AwsSdkCodeGenerator
+  module Views
+    class ServiceModule < View
+
+      # @option options [required, Service] :service
+      def initialize(options)
+        @service = options.fetch(:service)
+        @prefix = options.fetch(:prefix)
+      end
+
+      def full_name
+        @service.full_name
+      end
+
+      def gem_name
+        @service.gem_name
+      end
+
+      def gem_version
+        @service.gem_version
+      end
+
+      def name
+        @service.name
+      end
+
+      def module_name
+        @service.module_name
+      end
+
+      def modules
+        parts = module_name.split('::')
+        (0...parts.size).map do |n|
+          parts[0..n].join('::')
+        end
+      end
+
+      # @return [Array<String>]
+      def requires
+        @service.gem_dependencies.keys
+      end
+
+      # @return [Array<String>]
+      def relative_requires
+        paths = Set.new
+        paths << "#{prefix}/types"
+        paths << "#{prefix}/client_api"
+        paths << "#{prefix}/client"
+        paths << "#{prefix}/errors"
+        paths << "#{prefix}/waiters" if @service.waiters
+        paths << "#{prefix}/resource"
+        if @service.resources && @service.resources['resources']
+          @service.resources['resources'].keys.each do |resource_name|
+            path = "#{prefix}/#{underscore(resource_name)}"
+            if paths.include?(path)
+              raise "resource path conflict for `#{resource_name}'"
+            else
+              paths << path
+            end
+          end
+        end
+        paths << "#{prefix}/customizations"
+        paths.to_a
+      end
+
+      def example_var_name
+        underscore(name)
+      end
+
+      def example_operation_name
+        underscore(@service.api['operations'].keys.first)
+        nil
+      end
+
+      private
+
+      def prefix
+        @prefix
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-code-generator/views/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+module AwsSdkCodeGenerator
+  module Views
+    module Spec
+      class SpecHelper < View
+
+        self.template_file = "#{self.template_path}/spec/spec_helper.mustache"
+
+        # @param [Hash] options
+        # @option options [required, Service] :service
+        def initialize(options)
+          service = options.fetch(:service)
+          @gem_name = service.gem_name
+          @gem_dependencies = service.gem_dependencies.map do |gem_name, _|
+            { dependency: gem_name }
+          end
+        end
+
+        attr_reader :gem_name
+        attr_reader :gem_dependencies
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module AwsSdkCodeGenerator
+  module Views
+    class Version < View
+
+      # @option options [required, Service] :service
+      def initialize(options)
+        @service = options.fetch(:service)
+      end
+
+      def version
+        @service.gem_version
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: aws-sdk-code-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-10 00:00:00.000000000 Z
+dependencies: []
+description: Generates the service code for the AWS SDK for Ruby
+email:
+- trevrowe@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aws-sdk-code-generator.rb
+- lib/aws-sdk-code-generator/apply_docs.rb
+- lib/aws-sdk-code-generator/code_builder.rb
+- lib/aws-sdk-code-generator/dsl/access_control_statement.rb
+- lib/aws-sdk-code-generator/dsl/attribute_accessor.rb
+- lib/aws-sdk-code-generator/dsl/attribute_reader.rb
+- lib/aws-sdk-code-generator/dsl/attribute_writer.rb
+- lib/aws-sdk-code-generator/dsl/autoload_statement.rb
+- lib/aws-sdk-code-generator/dsl/block_param.rb
+- lib/aws-sdk-code-generator/dsl/class.rb
+- lib/aws-sdk-code-generator/dsl/code_literal.rb
+- lib/aws-sdk-code-generator/dsl/code_object.rb
+- lib/aws-sdk-code-generator/dsl/docstring.rb
+- lib/aws-sdk-code-generator/dsl/eigenclass.rb
+- lib/aws-sdk-code-generator/dsl/extend_statement.rb
+- lib/aws-sdk-code-generator/dsl/formatter.rb
+- lib/aws-sdk-code-generator/dsl/include_statement.rb
+- lib/aws-sdk-code-generator/dsl/main.rb
+- lib/aws-sdk-code-generator/dsl/method.rb
+- lib/aws-sdk-code-generator/dsl/module.rb
+- lib/aws-sdk-code-generator/dsl/option_tag.rb
+- lib/aws-sdk-code-generator/dsl/param.rb
+- lib/aws-sdk-code-generator/dsl/param_list.rb
+- lib/aws-sdk-code-generator/dsl/return_tag.rb
+- lib/aws-sdk-code-generator/dsl/tag_default.rb
+- lib/aws-sdk-code-generator/dsl/tag_docstring.rb
+- lib/aws-sdk-code-generator/dsl/tag_type.rb
+- lib/aws-sdk-code-generator/errors.rb
+- lib/aws-sdk-code-generator/gem_builder.rb
+- lib/aws-sdk-code-generator/generators/client_api_module.rb
+- lib/aws-sdk-code-generator/generators/client_class.rb
+- lib/aws-sdk-code-generator/generators/client_operation_documentation.rb
+- lib/aws-sdk-code-generator/generators/errors_module.rb
+- lib/aws-sdk-code-generator/generators/resource/action.rb
+- lib/aws-sdk-code-generator/generators/resource/batch_builder.rb
+- lib/aws-sdk-code-generator/generators/resource/builder.rb
+- lib/aws-sdk-code-generator/generators/resource/client_getter.rb
+- lib/aws-sdk-code-generator/generators/resource/client_request.rb
+- lib/aws-sdk-code-generator/generators/resource/client_request_docs.rb
+- lib/aws-sdk-code-generator/generators/resource/client_request_params.rb
+- lib/aws-sdk-code-generator/generators/resource/collection_class.rb
+- lib/aws-sdk-code-generator/generators/resource/data_attribute_getter.rb
+- lib/aws-sdk-code-generator/generators/resource/data_loaded_method.rb
+- lib/aws-sdk-code-generator/generators/resource/data_method.rb
+- lib/aws-sdk-code-generator/generators/resource/exists_method.rb
+- lib/aws-sdk-code-generator/generators/resource/extract_identifier_method.rb
+- lib/aws-sdk-code-generator/generators/resource/has_association.rb
+- lib/aws-sdk-code-generator/generators/resource/has_many_association.rb
+- lib/aws-sdk-code-generator/generators/resource/identifier_getter.rb
+- lib/aws-sdk-code-generator/generators/resource/identifiers_method.rb
+- lib/aws-sdk-code-generator/generators/resource/initialize_method.rb
+- lib/aws-sdk-code-generator/generators/resource/load_method.rb
+- lib/aws-sdk-code-generator/generators/resource/value_source.rb
+- lib/aws-sdk-code-generator/generators/resource/waiter_method.rb
+- lib/aws-sdk-code-generator/generators/resource_class.rb
+- lib/aws-sdk-code-generator/generators/response_structure_example.rb
+- lib/aws-sdk-code-generator/generators/root_resource_class.rb
+- lib/aws-sdk-code-generator/generators/service_documentation.rb
+- lib/aws-sdk-code-generator/generators/shared_example.rb
+- lib/aws-sdk-code-generator/generators/structure_type_class.rb
+- lib/aws-sdk-code-generator/generators/syntax_example.rb
+- lib/aws-sdk-code-generator/generators/types_module.rb
+- lib/aws-sdk-code-generator/generators/waiter_class.rb
+- lib/aws-sdk-code-generator/generators/waiters_module.rb
+- lib/aws-sdk-code-generator/hash_formatter.rb
+- lib/aws-sdk-code-generator/helper.rb
+- lib/aws-sdk-code-generator/service.rb
+- lib/aws-sdk-code-generator/underscore.rb
+- lib/aws-sdk-code-generator/view.rb
+- lib/aws-sdk-code-generator/views.rb
+- lib/aws-sdk-code-generator/views/features/env.rb
+- lib/aws-sdk-code-generator/views/features/step_definitions.rb
+- lib/aws-sdk-code-generator/views/gemspec.rb
+- lib/aws-sdk-code-generator/views/service_module.rb
+- lib/aws-sdk-code-generator/views/spec/spec_helper.rb
+- lib/aws-sdk-code-generator/views/version.rb
+homepage: http://github.com/aws/aws-sdk-ruby
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: AWS SDK for Ruby - Code Generator
+test_files: []