api_gateway_dsl 0.1.0

data/lib/api_gateway_dsl/integration.rb

@@ -0,0 +1,47 @@
+module APIGatewayDSL
+  class Integration
+
+    attr_reader :method, :url, :mappings, :templates, :context
+
+    def initialize(operation, *args, &_block)
+      options = args.last.is_a?(Hash) ? args.last : {}
+
+      @operation = operation
+
+      @context = @operation.context.dup.tap { |c| c.default_body_file = 'request/body' }
+
+      @passthrough_behavior = options[:passthrough_behavior] || 'WHEN_NO_TEMPLATES'
+      @content_handling     = options[:content_handling]     || 'CONVERT_TO_TEXT'
+      @credentials          = options[:credentials]
+
+      @mappings  = Mapping::Collection.new
+      @templates = Template::Collection.new(@context)
+    end
+
+    def as_json # rubocop:disable Metrics/MethodLength
+      {}.tap do |result|
+        if (request_parameters = mappings.as_json).present?
+          result[:requestParameters] = request_parameters
+        end
+
+        result[:passthroughBehavior] = @passthrough_behavior
+        result[:contentHandling]     = @content_handling
+
+        if (request_templates = @templates.as_json).present?
+          result[:requestTemplates] = request_templates
+        end
+
+        if (responses = @operation.responses.response_integrations.as_json).present?
+          result[:responses] = responses
+        end
+      end
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/integration/collection'
+require 'api_gateway_dsl/integration/http'
+require 'api_gateway_dsl/integration/http_proxy'
+require 'api_gateway_dsl/integration/lambda'
+require 'api_gateway_dsl/integration/mock'

data/lib/api_gateway_dsl/integration/collection.rb

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

data/lib/api_gateway_dsl/integration/http.rb

@@ -0,0 +1,26 @@
+module APIGatewayDSL
+  class Integration
+    class HTTP < Integration
+
+      attr_reader :method, :url
+
+      def initialize(_, method, url, **options, &block)
+        super
+
+        @method = method
+        @url    = url
+
+        DSL::IntegrationNode.new(self, &block)
+      end
+
+      def as_json
+        super.tap do |result|
+          result[:type]       = 'http'
+          result[:httpMethod] = @method
+          result[:uri]        = @url
+        end
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/integration/http_proxy.rb

@@ -0,0 +1,29 @@
+module APIGatewayDSL
+  class Integration
+    class HTTPProxy < Integration
+
+      attr_reader :method, :url
+
+      def initialize(_, method, url, **options, &block)
+        super
+
+        @method = method
+        @url    = url
+
+        DSL::IntegrationNode.new(self, &block)
+      end
+
+      def as_json
+        super.tap do |result|
+          result.delete(:contentHandling)
+
+          result[:type]                = 'http_proxy'
+          result[:httpMethod]          = @method
+          result[:uri]                 = @url
+          result[:passthroughBehavior] = 'WHEN_NO_MATCH'
+        end
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/integration/lambda.rb

@@ -0,0 +1,38 @@
+module APIGatewayDSL
+  class Integration
+    class Lambda < Integration
+
+      attr_reader :method, :url
+
+      def initialize(_, lambda_arn, **options, &block)
+        super
+
+        @lambda_arn = lambda_arn
+
+        DSL::IntegrationNode.new(self, &block)
+      end
+
+      def as_json
+        super.tap do |result|
+          result[:type]        = 'aws'
+          result[:httpMethod]  = 'POST'
+          result[:uri]         = uri
+
+          result[:credentials] = @credentials if @credentials
+        end
+      end
+
+      private
+
+      # https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri
+      def uri
+        "arn:aws:apigateway:#{region}:lambda:path/2015-03-31/functions/#{@lambda_arn}/invocations"
+      end
+
+      def region
+        @lambda_arn.split(':')[3]
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/integration/mock.rb

@@ -0,0 +1,33 @@
+module APIGatewayDSL
+  class Integration
+    class Mock < Integration
+
+      attr_reader :status_code, :templates
+
+      def initialize(_, status_code, **options, &block)
+        super
+
+        @status_code = status_code
+
+        DSL::IntegrationNode.new(self, &block)
+      end
+
+      def as_json # rubocop:disable Metrics/MethodLength
+        super.tap do |result|
+          result.delete(:contentHandling)
+
+          result[:type] = 'mock'
+
+          result[:requestTemplates] = {
+            'application/json' => <<-EOS.strip_heredoc
+              {
+                "statusCode": #{@status_code}
+              }
+            EOS
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/mapping.rb

@@ -0,0 +1,68 @@
+module APIGatewayDSL
+  class Mapping
+
+    # Maps Swagger parameter types to API Gateway parameter types
+    TYPES = {
+      'path'   => 'path',
+      'query'  => 'querystring',
+      'header' => 'header'
+    }.freeze
+
+    DEFAULT_SOURCE = {
+      'integration' => 'method',
+      'method'      => 'integration'
+    }.freeze
+
+    def initialize(destination, direction, type, name, source)
+      @destination = destination
+      @direction   = direction
+      @type        = type
+      @name        = name
+      @source      = source
+    end
+
+    def key
+      "#{@destination}.#{@direction}.#{type}.#{@name}"
+    end
+
+    def as_json
+      case @source
+      when ::NilClass
+        flatten(default_source => { @direction => { type => @name } })
+      when ::Symbol
+        flatten(default_source => { @direction => { type => @source } })
+      when ::Hash
+        flatten(@source)
+      else
+        "'#{@source}'"
+      end
+    end
+
+    def response_header
+      ResponseHeader.new(@name)
+    end
+
+    private
+
+    def type
+      TYPES[@type]
+    end
+
+    def default_source
+      DEFAULT_SOURCE[@destination]
+    end
+
+    def flatten(object)
+      case object
+      when ::Hash
+        key = object.keys.first
+        "#{key}.#{flatten(object[key])}"
+      else
+        object
+      end
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/mapping/collection'

data/lib/api_gateway_dsl/mapping/collection.rb

@@ -0,0 +1,15 @@
+module APIGatewayDSL
+  class Mapping
+    class Collection < Array
+
+      def response_headers
+        ResponseHeader::Collection.new.concat(map(&:response_header))
+      end
+
+      def as_json
+        index_by(&:key).transform_values(&:as_json)
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/operation.rb

@@ -0,0 +1,70 @@
+module APIGatewayDSL
+  class Operation
+
+    attr_reader :path, :cors, :parameters, :integrations, :responses, :context
+    attr_accessor :summary, :description
+
+    def initialize(context, method, path, **options, &block)
+      @context = context.dup
+
+      @method = method
+      @path   = path
+
+      @cors     = options[:cors]
+      @security = options[:security]
+
+      @parameters   = Parameter::Collection.new
+      @integrations = Integration::Collection.new
+      @responses    = Response::Collection.new
+
+      DSL::OperationNode.new(self, &block)
+    end
+
+    def parameters_with_body
+      Parameter::Collection.new.concat(parameters).tap do |result|
+        if (integration = integrations.first)
+          result.concat(integration.templates.parameters)
+        end
+      end
+    end
+
+    def method
+      case @method
+      when 'ANY' then 'x-amazon-apigateway-any-method'
+      else            @method.downcase
+      end
+    end
+
+    def cors_method
+      @method # not downcased
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def as_json
+      {}.tap do |result|
+        result[:summary]     = summary                     if summary
+        result[:description] = description.strip_heredoc   if description
+        result[:security]    = [@security => []]           if @security
+
+        if (produces = responses.content_types).present?
+          result[:produces] = produces
+        end
+        result[:responses] = responses.as_json
+
+        if (integration = integrations.first)
+          if (consumes = integration.templates.content_types).present?
+            result[:consumes] = consumes
+          end
+          if (params = parameters_with_body.as_json).present?
+            result[:parameters] = params
+          end
+          result[:'x-amazon-apigateway-integration'] = integration.as_json
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+  end
+end
+
+require 'api_gateway_dsl/operation/collection'

data/lib/api_gateway_dsl/operation/collection.rb

@@ -0,0 +1,62 @@
+module APIGatewayDSL
+  class Operation
+    class Collection < Array
+
+      ACCESS_CONTROL_ALLOW_HEADERS = %w(
+        Content-Type
+        Authorization
+        X-Amz-Date
+        X-Api-Key
+        X-Amz-Security-Token
+      ).freeze
+
+      # Indexes a flat array of operarations by path and HTTP method:
+      #
+      # Given:
+      #
+      #   - operationA ( path = '/path1', method = 'get'  )
+      #   - operationB ( path = '/path1', method = 'post' )
+      #   - operationC ( path = '/path2', method = 'get'  )
+      #
+      # Result:
+      #
+      #   /path1:
+      #     get:
+      #       operationA
+      #     post:
+      #       operationB
+      #   /path2:
+      #     get:
+      #       operationC
+      #
+      def as_json
+        group_by(&:path).transform_values do |operations|
+          append_cors_operation!(operations)
+          operations.index_by(&:method).transform_values(&:as_json)
+        end
+      end
+
+      private
+
+      # All passed operations must have the same path
+      def append_cors_operation!(operations)
+        cors_enabled_ops = operations.select(&:cors)
+        return if cors_enabled_ops.none?
+        operations << cors_operation(operations.first.path, (cors_enabled_ops.map(&:cors_method) << 'OPTIONS').sort)
+      end
+
+      def cors_operation(path, methods)
+        Operation.new(Context.new, 'OPTIONS', path) do
+          MOCK 200
+
+          RESPONSE 200 do
+            header 'Access-Control-Allow-Headers', ACCESS_CONTROL_ALLOW_HEADERS.join(',')
+            header 'Access-Control-Allow-Methods', methods.join(',')
+            header 'Access-Control-Allow-Origin',  '*'
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/parameter.rb

@@ -0,0 +1,24 @@
+module APIGatewayDSL
+  class Parameter
+
+    def initialize(name, **options)
+      @name        = name
+      @description = options[:description].try(:strip_heredoc)
+      @required    = !!options[:required]
+    end
+
+    def as_json
+      {}.tap do |result|
+        result[:name]        = @name
+        result[:description] = @description if @description
+        result[:in]          = @in
+        result[:required]    = @required
+      end
+    end
+
+  end
+end
+
+require 'api_gateway_dsl/parameter/body'
+require 'api_gateway_dsl/parameter/collection'
+require 'api_gateway_dsl/parameter/simple'

data/lib/api_gateway_dsl/parameter/body.rb

@@ -0,0 +1,21 @@
+module APIGatewayDSL
+  class Parameter
+    class Body # does not extend Parameter, but is built from Template
+
+      def initialize(template)
+        @template = template
+      end
+
+      def as_json
+        {}.tap do |result|
+          result[:name]        = File.basename(@template.schema)
+          result[:description] = @template.description if @template.description
+          result[:in]          = 'body'
+          result[:required]    = true
+          result[:schema]      = @template.schema_value
+        end
+      end
+
+    end
+  end
+end