api_gateway_dsl 0.1.0

data/spec/fixtures/greedy_http_proxy/pets/proxy.rb

@@ -0,0 +1,9 @@
+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

data/spec/fixtures/http_get/README.md

@@ -0,0 +1,150 @@
+# GET Endpoint with HTTP Integration
+
+This example demonstrates how to specify a GET endpoint for the path `/pets` which integrates with an HTTP
+downstream service at `https://petstore.example.com`.
+
+## Configuration
+
+* The request accepts a query string parameter `q` and a header `Accept-Language` which are passed through to the
+  downstream service.
+* The endpoint responds with a `200` if the downstream service responds with a `200` and passes through the response
+  header `Content-Language` from the downstream service to the client.
+* The endpoint responds with a `500` otherwise.
+
+## Given
+
+* [`index.rb`](index.rb) (skipped for readability)
+
+* [`pets/get.rb`](pets/get.rb)
+
+  ```rb
+  GET '/pets' do
+    query  'q'
+    header 'Accept-Language'
+  
+    HTTP_GET 'https://petstore.example.com' do
+      query  'q'
+      header 'Accept-Language'
+    end
+  
+    RESPONSE 200, /^200$/ do
+      header 'Content-Language'
+    end
+  
+    RESPONSE 500
+  end
+  ```
+
+* [`pets/response/200.vtl`](pets/response/200.vtl)
+
+  ```vtl
+  $input.path('$')
+  ```
+
+* [`pets/response/200.yml`](pets/response/200.yml)
+
+  ```yml
+  type: "array"
+  items:
+    type: "object"
+    properties: {}
+  ```
+
+* [`pets/response/500.vtl`](pets/response/500.vtl)
+
+  ```vtl
+  {
+    "message": "Something went wrong!"
+  }
+  ```
+
+* [`pets/response/500.yml`](pets/response/500.yml)
+
+  ```yml
+  type: "object"
+  properties:
+    message:
+      type: "string"
+  ```
+
+## Generates
+
+* [`index.yml`](index.yml)
+
+  ```yml
+  swagger: "2.0"
+  info:
+    version: "1.2.3"
+    title: "GET Endpoint with HTTP Integration"
+    description: |
+      This example demonstrates how to specify a GET endpoint for the path `/pets` which integrates with an HTTP
+      downstream service at `https://petstore.example.com`.
+  
+      ## Configuration
+  
+      * The request accepts a query string parameter `q` and a header `Accept-Language` which are passed through to the
+        downstream service.
+      * The endpoint responds with a `200` if the downstream service responds with a `200` and passes through the response
+        header `Content-Language` from the downstream service to the client.
+      * The endpoint responds with a `500` otherwise.
+  host: "api.example.com"
+  schemes:
+    - "https"
+  paths:
+    /pets:
+      get:
+        produces:
+          - "application/json"
+        parameters:
+          - name: "q"
+            in: "query"
+            required: false
+            type: "string"
+          - name: "Accept-Language"
+            in: "header"
+            required: false
+            type: "string"
+        responses:
+          '200':
+            description: "200 response"
+            schema:
+              type: "array"
+              items:
+                type: "object"
+                properties: {}
+            headers:
+              Content-Language:
+                type: "string"
+          '500':
+            description: "500 response"
+            schema:
+              type: "object"
+              properties:
+                message:
+                  type: "string"
+        x-amazon-apigateway-integration:
+          responses:
+            default:
+              statusCode: "500"
+              responseTemplates:
+                application/json: |
+                  {
+                    "message": "Something went wrong!"
+                  }
+            ^200$:
+              statusCode: "200"
+              responseParameters:
+                method.response.header.Content-Language: "integration.response.header.Content-Language"
+              responseTemplates:
+                application/json: |
+                  $input.path('$')
+          requestParameters:
+            integration.request.querystring.q: "method.request.querystring.q"
+            integration.request.header.Accept-Language: "method.request.header.Accept-Language"
+          uri: "https://petstore.example.com"
+          passthroughBehavior: "WHEN_NO_TEMPLATES"
+          httpMethod: "GET"
+          contentHandling: "CONVERT_TO_TEXT"
+          type: "http"
+  ```
+

data/spec/fixtures/http_get/index.rb

@@ -0,0 +1,17 @@
+title 'GET Endpoint with HTTP Integration'
+version '1.2.3'
+description <<-EOS
+  This example demonstrates how to specify a GET endpoint for the path `/pets` which integrates with an HTTP
+  downstream service at `https://petstore.example.com`.
+
+  ## Configuration
+
+  * The request accepts a query string parameter `q` and a header `Accept-Language` which are passed through to the
+    downstream service.
+  * The endpoint responds with a `200` if the downstream service responds with a `200` and passes through the response
+    header `Content-Language` from the downstream service to the client.
+  * The endpoint responds with a `500` otherwise.
+EOS
+
+host 'api.example.com'
+schemes 'https'

data/spec/fixtures/http_get/index.yml

@@ -0,0 +1,74 @@
+swagger: "2.0"
+info:
+  version: "1.2.3"
+  title: "GET Endpoint with HTTP Integration"
+  description: |
+    This example demonstrates how to specify a GET endpoint for the path `/pets` which integrates with an HTTP
+    downstream service at `https://petstore.example.com`.
+
+    ## Configuration
+
+    * The request accepts a query string parameter `q` and a header `Accept-Language` which are passed through to the
+      downstream service.
+    * The endpoint responds with a `200` if the downstream service responds with a `200` and passes through the response
+      header `Content-Language` from the downstream service to the client.
+    * The endpoint responds with a `500` otherwise.
+host: "api.example.com"
+schemes:
+  - "https"
+paths:
+  /pets:
+    get:
+      produces:
+        - "application/json"
+      parameters:
+        - name: "q"
+          in: "query"
+          required: false
+          type: "string"
+        - name: "Accept-Language"
+          in: "header"
+          required: false
+          type: "string"
+      responses:
+        '200':
+          description: "200 response"
+          schema:
+            type: "array"
+            items:
+              type: "object"
+              properties: {}
+          headers:
+            Content-Language:
+              type: "string"
+        '500':
+          description: "500 response"
+          schema:
+            type: "object"
+            properties:
+              message:
+                type: "string"
+      x-amazon-apigateway-integration:
+        responses:
+          default:
+            statusCode: "500"
+            responseTemplates:
+              application/json: |
+                {
+                  "message": "Something went wrong!"
+                }
+          ^200$:
+            statusCode: "200"
+            responseParameters:
+              method.response.header.Content-Language: "integration.response.header.Content-Language"
+            responseTemplates:
+              application/json: |
+                $input.path('$')
+        requestParameters:
+          integration.request.querystring.q: "method.request.querystring.q"
+          integration.request.header.Accept-Language: "method.request.header.Accept-Language"
+        uri: "https://petstore.example.com"
+        passthroughBehavior: "WHEN_NO_TEMPLATES"
+        httpMethod: "GET"
+        contentHandling: "CONVERT_TO_TEXT"
+        type: "http"

data/spec/fixtures/http_get/pets/get.rb

@@ -0,0 +1,15 @@
+GET '/pets' do
+  query  'q'
+  header 'Accept-Language'
+
+  HTTP_GET 'https://petstore.example.com' do
+    query  'q'
+    header 'Accept-Language'
+  end
+
+  RESPONSE 200, /^200$/ do
+    header 'Content-Language'
+  end
+
+  RESPONSE 500
+end

data/spec/fixtures/http_get/pets/response/200.vtl

@@ -0,0 +1 @@
+$input.path('$')

data/spec/fixtures/http_get/pets/response/200.yml

@@ -0,0 +1,4 @@
+type: "array"
+items:
+  type: "object"
+  properties: {}

data/spec/fixtures/http_get/pets/response/500.vtl

@@ -0,0 +1,3 @@
+{
+  "message": "Something went wrong!"
+}

data/spec/fixtures/http_get/pets/response/500.yml

@@ -0,0 +1,4 @@
+type: "object"
+properties:
+  message:
+    type: "string"

data/spec/fixtures/lambda_post/README.md

@@ -0,0 +1,185 @@
+# POST Endpoint with Lambda Integration
+
+This example demonstrates how to specify a POST endpoint for the path `/pets` which integrates with a AWS Lambda
+function `create_pet` as downstream service.
+
+## Configuration
+
+* The request accepts a header `Accept-Language` which is passed through as `$.meta.accept_language` to the Lambda
+  function.
+* The request accepts a request body; its value `$.pet.name` is passed through to the Lambda function.
+* The endpoint responds with a `201` if the Lambda function invocation succeeds and passes through `$.location` as
+  `Location` header from the Lambda function response to the client.
+* The endpoint responds with a `500` if the Lambda function invocation fails.
+
+## Given
+
+* [`index.rb`](index.rb) (skipped for readability)
+
+* [`pets/post.rb`](pets/post.rb)
+
+  ```rb
+  POST '/pets' do
+    header 'Accept-Language'
+  
+    LAMBDA 'arn:aws:lambda:eu-west-1:123456789012:function:create_pet'
+  
+    RESPONSE 201 do
+      header 'Location', integration: { response: { body: 'location' } }
+    end
+  
+    RESPONSE 500, /\n|.*/
+  end
+  ```
+
+* [`pets/request/body.vtl`](pets/request/body.vtl)
+
+  ```vtl
+  #set( $inputRoot = $input.path('$') )
+  {
+    "pet": {
+      "name": $input.json('$.pet.name')
+    }
+    "meta": {
+      "accept_language": "${util.escapeJavaScript($input.params('Accept-Language')).replaceAll("\\'","'")}"
+    }
+  }
+  ```
+
+* [`pets/request/body.yml`](pets/request/body.yml)
+
+  ```yml
+  type: "object"
+  properties:
+    pet:
+      type: "object"
+      properties:
+        name:
+          type: "string"
+  ```
+
+* [`pets/response/201.vtl`](pets/response/201.vtl)
+
+  ```vtl
+  {}
+  ```
+
+* [`pets/response/201.yml`](pets/response/201.yml)
+
+  ```yml
+  type: "object"
+  ```
+
+* [`pets/response/500.vtl`](pets/response/500.vtl)
+
+  ```vtl
+  {
+    "message": "Something went wrong!"
+  }
+  ```
+
+* [`pets/response/500.yml`](pets/response/500.yml)
+
+  ```yml
+  type: "object"
+  properties:
+    message:
+      type: "string"
+  ```
+
+## Generates
+
+* [`index.yml`](index.yml)
+
+  ```yml
+  swagger: "2.0"
+  info:
+    version: "1.2.3"
+    title: "POST Endpoint with Lambda Integration"
+    description: |
+      This example demonstrates how to specify a POST endpoint for the path `/pets` which integrates with a AWS Lambda
+      function `create_pet` as downstream service.
+  
+      ## Configuration
+  
+      * The request accepts a header `Accept-Language` which is passed through as `$.meta.accept_language` to the Lambda
+        function.
+      * The request accepts a request body; its value `$.pet.name` is passed through to the Lambda function.
+      * The endpoint responds with a `201` if the Lambda function invocation succeeds and passes through `$.location` as
+        `Location` header from the Lambda function response to the client.
+      * The endpoint responds with a `500` if the Lambda function invocation fails.
+  host: "api.example.com"
+  schemes:
+    - "https"
+  paths:
+    /pets:
+      post:
+        consumes:
+          - "application/json"
+        produces:
+          - "application/json"
+        parameters:
+          - name: "Accept-Language"
+            in: "header"
+            required: false
+            type: "string"
+          - in: "body"
+            name: "body"
+            required: true
+            schema:
+              type: "object"
+              properties:
+                pet:
+                  type: "object"
+                  properties:
+                    name:
+                      type: "string"
+        responses:
+          '201':
+            description: "201 response"
+            schema:
+              type: "object"
+            headers:
+              Location:
+                type: "string"
+          '500':
+            description: "500 response"
+            schema:
+              type: "object"
+              properties:
+                message:
+                  type: "string"
+        x-amazon-apigateway-integration:
+          responses:
+            default:
+              statusCode: "201"
+              responseParameters:
+                method.response.header.Location: "integration.response.body.location"
+              responseTemplates:
+                application/json: |
+                  {}
+            \n|.*:
+              statusCode: "500"
+              responseTemplates:
+                application/json: |
+                  {
+                    "message": "Something went wrong!"
+                  }
+          requestTemplates:
+            application/json: |
+              #set( $inputRoot = $input.path('$') )
+              {
+                "pet": {
+                  "name": $input.json('$.pet.name')
+                }
+                "meta": {
+                  "accept_language": "${util.escapeJavaScript($input.params('Accept-Language')).replaceAll("\\'","'")}"
+                }
+              }
+          uri: "arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:123456789012:function:create_pet/invocations"
+          passthroughBehavior: "WHEN_NO_TEMPLATES"
+          httpMethod: "POST"
+          contentHandling: "CONVERT_TO_TEXT"
+          type: "aws"
+  ```
+