api_gateway_dsl 0.1.0

data/lib/api_gateway_dsl/parameter/collection.rb

@@ -0,0 +1,7 @@
+module APIGatewayDSL
+  class Parameter
+    class Collection < Array
+
+    end
+  end
+end

data/lib/api_gateway_dsl/parameter/header.rb

@@ -0,0 +1,13 @@
+module APIGatewayDSL
+  class Parameter
+    class Header < Simple
+
+      def initialize(name, **options)
+        super
+
+        @in = 'header'
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/parameter/path.rb

@@ -0,0 +1,14 @@
+module APIGatewayDSL
+  class Parameter
+    class Path < Simple
+
+      def initialize(name, **options)
+        super
+
+        @in       = 'path'
+        @required = true
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/parameter/query.rb

@@ -0,0 +1,13 @@
+module APIGatewayDSL
+  class Parameter
+    class Query < Simple
+
+      def initialize(name, **options)
+        super
+
+        @in = 'query'
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/parameter/simple.rb

@@ -0,0 +1,23 @@
+module APIGatewayDSL
+  class Parameter
+    class Simple < Parameter
+
+      def initialize(name, **options)
+        super
+
+        @type = options[:type] || 'string'
+      end
+
+      def as_json
+        super.tap do |result|
+          result[:type] = @type
+        end
+      end
+
+    end
+  end
+end
+
+require 'api_gateway_dsl/parameter/header'
+require 'api_gateway_dsl/parameter/path'
+require 'api_gateway_dsl/parameter/query'

data/lib/api_gateway_dsl/response.rb

@@ -0,0 +1,53 @@
+module APIGatewayDSL
+  class Response
+
+    attr_reader :status_code, :mappings, :templates, :context
+
+    def initialize(operation, status_code, regexp, &block)
+      @context = operation.context.dup.tap { |c| c.default_body_file = "response/#{status_code}" }
+
+      @status_code = status_code.to_s
+      @regexp      = regexp(regexp)
+
+      @mappings  = Mapping::Collection.new
+      @templates = Template::Collection.new(@context)
+
+      DSL::ResponseNode.new(self, &block)
+    end
+
+    def content_types
+      templates.content_types
+    end
+
+    def as_json
+      {}.tap do |result|
+        result[:description] = "#{status_code} response"
+
+        if (headers = mappings.response_headers.as_json).present?
+          result[:headers] = headers
+        end
+
+        if (template = templates.current)
+          result[:schema] = template.schema_value
+        end
+      end
+    end
+
+    def response_integration
+      ResponseIntegration.new(@regexp, status_code, mappings, templates)
+    end
+
+    private
+
+    def regexp(value)
+      case value
+      when NilClass then 'default'
+      when Regexp   then value.source
+      else               value
+      end
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/response/collection'

data/lib/api_gateway_dsl/response/collection.rb

@@ -0,0 +1,19 @@
+module APIGatewayDSL
+  class Response
+    class Collection < Array
+
+      def content_types
+        flat_map(&:content_types).uniq
+      end
+
+      def response_integrations
+        ResponseIntegration::Collection.new.concat(map(&:response_integration))
+      end
+
+      def as_json
+        index_by(&:status_code).transform_values(&:as_json)
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/response_header.rb

@@ -0,0 +1,19 @@
+module APIGatewayDSL
+  class ResponseHeader
+
+    VALUE = { type: 'string' }.freeze
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def as_json
+      VALUE
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/response_header/collection'

data/lib/api_gateway_dsl/response_header/collection.rb

@@ -0,0 +1,11 @@
+module APIGatewayDSL
+  class ResponseHeader
+    class Collection < Array
+
+      def as_json
+        index_by(&:name).transform_values(&:as_json)
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/response_integration.rb

@@ -0,0 +1,30 @@
+module APIGatewayDSL
+  class ResponseIntegration
+
+    attr_reader :regexp
+
+    def initialize(regexp, status_code, mappings, templates)
+      @regexp      = regexp
+      @status_code = status_code
+      @mappings    = mappings
+      @templates   = templates
+    end
+
+    def as_json
+      {}.tap do |result|
+        result[:statusCode] = @status_code
+
+        if (response_parameters = @mappings.as_json).present?
+          result[:responseParameters] = response_parameters
+        end
+
+        if (response_templates = @templates.as_json).present?
+          result[:responseTemplates] = response_templates
+        end
+      end
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/response_integration/collection'

data/lib/api_gateway_dsl/response_integration/collection.rb

@@ -0,0 +1,11 @@
+module APIGatewayDSL
+  class ResponseIntegration
+    class Collection < Array
+
+      def as_json
+        index_by(&:regexp).transform_values(&:as_json)
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/template.rb

@@ -0,0 +1,48 @@
+module APIGatewayDSL
+  class Template
+
+    attr_reader :schema, :description, :content_type
+
+    def self.new_if_schema_present(context, **options)
+      template = new(context, **options)
+      template.schema_value ? template : nil
+    end
+
+    def initialize(context, **options)
+      @context = context
+
+      @schema   = options[:schema]   || @context.default_body_file
+      @velocity = options[:velocity] || @context.default_body_file
+
+      @description  = options[:description].try(:strip_heredoc)
+      @content_type = options[:content_type] || 'application/json'
+    end
+
+    def as_json
+      current_dir.join("#{@velocity}.vtl").read
+    end
+
+    def schema_value
+      return unless current_dir
+
+      if (file = current_dir.join("#{@schema}.json")).exist?
+        JSON.parse(file.read)
+      elsif (file = current_dir.join("#{@schema}.yml")).exist?
+        YAML.safe_load(file.read)
+      end
+    end
+
+    def parameter
+      Parameter::Body.new(self)
+    end
+
+    private
+
+    def current_dir
+      @context.current_dir
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/template/collection'

data/lib/api_gateway_dsl/template/collection.rb

@@ -0,0 +1,32 @@
+module APIGatewayDSL
+  class Template
+    class Collection < Array
+
+      def initialize(context)
+        @fallback = Template.new_if_schema_present(context)
+      end
+
+      def content_types
+        currents.map(&:content_type).uniq
+      end
+
+      def current
+        any? ? first : @fallback
+      end
+
+      # Array containing current or empty array
+      def currents
+        Array(current)
+      end
+
+      def as_json
+        currents.index_by(&:content_type).transform_values(&:as_json)
+      end
+
+      def parameters
+        Parameter::Collection.new.concat(currents.map(&:parameter))
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/version.rb

@@ -0,0 +1,5 @@
+module APIGatewayDSL
+
+  VERSION = '0.1.0'.freeze
+
+end

data/spec/api_gateway_dsl/document_spec.rb

@@ -0,0 +1,20 @@
+describe APIGatewayDSL::Document do
+  let(:fixtures_dir) { Pathname.new('spec/fixtures') }
+
+  %w( greedy_http_proxy http_get lambda_post lambda_post_with_cors mock_options ).each do |fixture|
+    describe "for '#{fixture}' fixture" do
+      let(:fixture_dir) { fixtures_dir.join(fixture) }
+
+      let(:from_dsl) { described_class.load(fixture_dir).as_json }
+      let(:from_yml) { YAML.load_file(fixture_dir.join('index.yml')) }
+
+      it 'includes the expected definitions' do
+        expect(from_dsl).to include_json(from_yml)
+      end
+
+      it 'does not include unexptected definitions' do
+        expect(from_yml).to include_json(from_dsl)
+      end
+    end
+  end
+end

data/spec/fixtures/greedy_http_proxy/README.md

@@ -0,0 +1,69 @@
+# Greedy Endpoint for any HTTP method with HTTP proxy integration
+
+This example demonstrates how to specify a greedy endpoint which accepts any HTTP method for all paths below
+`/pets/*` and integrates with an HTTP downstream service at `https://petstore.example.com`.
+
+## Configuration
+
+* Beyond the path, the request accepts a header `Accept-Language` which is passed through to the downstream service.
+
+## Given
+
+* [`index.rb`](index.rb) (skipped for readability)
+
+* [`pets/proxy.rb`](pets/proxy.rb)
+
+  ```rb
+  ANY '/pets/{proxy+}' do
+    path   'proxy'
+    header 'Accept-Language'
+  
+    HTTP_PROXY_ANY 'https://petstore.example.com/{proxy}' do
+      path   'proxy'
+      header 'Accept-Language'
+    end
+  end
+  ```
+
+## Generates
+
+* [`index.yml`](index.yml)
+
+  ```yml
+  swagger: "2.0"
+  info:
+    version: "1.2.3"
+    title: "Greedy Endpoint for any HTTP method with HTTP proxy integration"
+    description: |
+      This example demonstrates how to specify a greedy endpoint which accepts any HTTP method for all paths below
+      `/pets/*` and integrates with an HTTP downstream service at `https://petstore.example.com`.
+  
+      ## Configuration
+  
+      * Beyond the path, the request accepts a header `Accept-Language` which is passed through to the downstream service.
+  host: "api.example.com"
+  schemes:
+    - "https"
+  paths:
+    /pets/{proxy+}:
+      x-amazon-apigateway-any-method:
+        parameters:
+          - name: "proxy"
+            in: "path"
+            required: true
+            type: "string"
+          - name: "Accept-Language"
+            in: "header"
+            required: false
+            type: "string"
+        responses: {}
+        x-amazon-apigateway-integration:
+          requestParameters:
+            integration.request.path.proxy: "method.request.path.proxy"
+            integration.request.header.Accept-Language: "method.request.header.Accept-Language"
+          uri: "https://petstore.example.com/{proxy}"
+          passthroughBehavior: "WHEN_NO_MATCH"
+          httpMethod: "ANY"
+          type: "http_proxy"
+  ```
+

data/spec/fixtures/greedy_http_proxy/index.rb

@@ -0,0 +1,13 @@
+title 'Greedy Endpoint for any HTTP method with HTTP proxy integration'
+version '1.2.3'
+description <<-EOS
+  This example demonstrates how to specify a greedy endpoint which accepts any HTTP method for all paths below
+  `/pets/*` and integrates with an HTTP downstream service at `https://petstore.example.com`.
+
+  ## Configuration
+
+  * Beyond the path, the request accepts a header `Accept-Language` which is passed through to the downstream service.
+EOS
+
+host 'api.example.com'
+schemes 'https'

data/spec/fixtures/greedy_http_proxy/index.yml

@@ -0,0 +1,35 @@
+swagger: "2.0"
+info:
+  version: "1.2.3"
+  title: "Greedy Endpoint for any HTTP method with HTTP proxy integration"
+  description: |
+    This example demonstrates how to specify a greedy endpoint which accepts any HTTP method for all paths below
+    `/pets/*` and integrates with an HTTP downstream service at `https://petstore.example.com`.
+
+    ## Configuration
+
+    * Beyond the path, the request accepts a header `Accept-Language` which is passed through to the downstream service.
+host: "api.example.com"
+schemes:
+  - "https"
+paths:
+  /pets/{proxy+}:
+    x-amazon-apigateway-any-method:
+      parameters:
+        - name: "proxy"
+          in: "path"
+          required: true
+          type: "string"
+        - name: "Accept-Language"
+          in: "header"
+          required: false
+          type: "string"
+      responses: {}
+      x-amazon-apigateway-integration:
+        requestParameters:
+          integration.request.path.proxy: "method.request.path.proxy"
+          integration.request.header.Accept-Language: "method.request.header.Accept-Language"
+        uri: "https://petstore.example.com/{proxy}"
+        passthroughBehavior: "WHEN_NO_MATCH"
+        httpMethod: "ANY"
+        type: "http_proxy"