Merge branch 'master' into feature/support_s3

Author: theburningmonk

README.md

@@ -2,27 +2,33 @@
 [![Build Status](https://travis-ci.org/horike37/serverless-apigateway-service-proxy.svg?branch=master)](https://travis-ci.org/horike37/serverless-apigateway-service-proxy) [![npm version](https://badge.fury.io/js/serverless-apigateway-service-proxy.svg)](https://badge.fury.io/js/serverless-apigateway-service-proxy) [![Coverage Status](https://coveralls.io/repos/github/horike37/serverless-apigateway-service-proxy/badge.svg?branch=master)](https://coveralls.io/github/horike37/serverless-apigateway-service-proxy?branch=master) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 
 # Serverless APIGateway Service Proxy(BETA)
+
 This Serverless Framewrok plugin supports the AWS service proxy integration feature of API Gateway. You can directly connect API Gateway to AWS services without Lambda.
 
 ## Install
+
 Run `servelress plugin install` in your Serverless project.
 
-```
-$ serverless plugin install -n serverless-apigateway-service-proxy
+```bash
+serverless plugin install -n serverless-apigateway-service-proxy
 ```
 
 ## Supported AWS services
+
 Here is a services list which this plugin supports for now. But will expand to other services in the feature.
 Please pull request if you are intersted in it.
 
 - Kinesis Streams
 - SQS
 
 ## How to use
+
 Define settings of the AWS services you want to integrate under `custom > apiGatewayServiceProxies` and run `serverless deploy`.
 
 ### Kinesis
+
 Sample syntax for Kinesis proxy in serverless.yml.
+
 ```yaml
 custom:
   apiGatewayServiceProxies:
@@ -41,34 +47,38 @@ resources:
 ```
 
 Sample request after deploying.
-```
+
+```bash
 curl -XPOST https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/kinesis -d '{"Data": "some data","PartitionKey": "some key"}'  -H 'Content-Type:application/json'
 ```
 
 ### SQS
 
 Sample syntax for SQS proxy in serverless.yml.
+
 ```yaml
 custom:
   apiGatewayServiceProxies:
     - sqs:
         path: /sqs
         method: post
-        queueName: {"Fn::GetAtt":[ "SQSQueue", "QueueName" ]}
+        queueName: { 'Fn::GetAtt': ['SQSQueue', 'QueueName'] }
         cors: true
 
 resources:
   Resources:
     SQSQueue:
-      Type: "AWS::SQS::Queue"
+      Type: 'AWS::SQS::Queue'
 ```
 
 Sample request after deploying.
-```
+
+```bash
 curl -XPOST https://xxxxxx.execute-api.us-east-1.amazonaws.com/dev/sqs -d '{"message": "testtest"}' -H 'Content-Type:application/json'
 ```
 
 ## Common API Gateway features
+
 ### Enabling CORS
 
 To set CORS configurations for your HTTP endpoints, simply modify your event configurations as follows:
@@ -143,7 +153,40 @@ custom:
           cacheControl: 'max-age=600, s-maxage=600, proxy-revalidate' # Caches on browser and proxy for 10 minutes and doesnt allow proxy to serve out of date content
 ```
 
-### Customizing request body mapping templates
+### Adding Authorization
+
+You can pass in any supported authorization type:
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - sqs:
+        path: /sqs
+        method: post
+        queueName: { 'Fn::GetAtt': ['SQSQueue', 'QueueName'] }
+        cors: true
+
+        # optional - defaults to 'NONE'
+        authorizationType: 'AWS_IAM' # can be one of ['NONE', 'AWS_IAM', 'CUSTOM', 'COGNITO_USER_POOLS']
+
+        # when using 'CUSTOM' authorization type, one should specify authorizerId
+        # authorizerId: { Ref: 'AuthorizerLogicalId' }
+        # when using 'COGNITO_USER_POOLS' authorization type, one can specify a list of authorization scopes
+        # authorizationScopes: ['scope1','scope2']
+
+resources:
+  Resources:
+    SQSQueue:
+      Type: 'AWS::SQS::Queue'
+```
+
+Source: [AWS::ApiGateway::Method docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype)
+
+## Specific features
+
+### Kinesis
+
+#### Customizing request body mapping templates
 
 If you'd like to add content types or customize the default templates, you can do so by including your custom [API Gateway request mapping template](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in `serverless.yml` like so:
 
@@ -169,4 +212,29 @@ custom:
                 - MyStreamArn:
                     Fn::GetAtt: [MyStream, Arn]
 ```
+
 Source: [How to connect SNS to Kinesis for cross-account delivery via API Gateway](https://theburningmonk.com/2019/07/how-to-connect-sns-to-kinesis-for-cross-account-delivery-via-api-gateway/)
+
+### SQS
+
+#### Customizing request parameters
+
+If you'd like to pass additional data to the integration request, you can do so by including your custom [API Gateway request parameters](https://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html) in `serverless.yml` like so:
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - sqs:
+        path: /queue
+        method: post
+        queueName: !GetAtt MyQueue.QueueName
+        cors: true
+
+        requestParameters:
+          'integration.request.querystring.MessageAttribute.1.Name': "'cognitoIdentityId'"
+          'integration.request.querystring.MessageAttribute.1.Value.StringValue': 'context.identity.cognitoIdentityId'
+          'integration.request.querystring.MessageAttribute.1.Value.DataType': "'String'"
+          'integration.request.querystring.MessageAttribute.2.Name': "'cognitoAuthenticationProvider'"
+          'integration.request.querystring.MessageAttribute.2.Value.StringValue': 'context.identity.cognitoAuthenticationProvider'
+          'integration.request.querystring.MessageAttribute.2.Value.DataType': "'String'"
+```

__tests__/integration/kinesis/multiple-integrations/service/serverless.yml

@@ -0,0 +1,45 @@
+service: multiple-kinesis-proxy
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+plugins:
+  localPath: './../../../../../../'
+  modules:
+    - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayServiceProxies:
+    - kinesis:
+        path: /kinesis1
+        method: post
+        streamName: { Ref: 'YourStream1' }
+        cors: true
+
+    - kinesis:
+        path: /kinesis2
+        method: post
+        streamName: { Ref: 'YourStream2' }
+        cors: true
+
+    - kinesis:
+        path: /kinesis3
+        method: post
+        streamName: { Ref: 'YourStream3' }
+        cors: true
+
+resources:
+  Resources:
+    YourStream1:
+      Type: AWS::Kinesis::Stream
+      Properties:
+        ShardCount: 1
+    YourStream2:
+      Type: AWS::Kinesis::Stream
+      Properties:
+        ShardCount: 1
+    YourStream3:
+      Type: AWS::Kinesis::Stream
+      Properties:
+        ShardCount: 1

__tests__/integration/kinesis/multiple-integrations/tests.js

@@ -0,0 +1,40 @@
+'use strict'
+
+const expect = require('chai').expect
+const fetch = require('node-fetch')
+const { deployWithRandomStage, removeService } = require('../../../utils')
+
+describe('Multiple Kinesis Proxy Integrations Test', () => {
+  let endpoint
+  let stage
+  const config = '__tests__/integration/kinesis/multiple-integrations/service/serverless.yml'
+
+  beforeAll(async () => {
+    const result = await deployWithRandomStage(config)
+    stage = result.stage
+    endpoint = result.endpoint
+  })
+
+  afterAll(() => {
+    removeService(stage, config)
+  })
+
+  it('should get correct response from multiple kinesis proxy endpoints', async () => {
+    const streams = ['kinesis1', 'kinesis2', 'kinesis3']
+
+    for (const stream of streams) {
+      const testEndpoint = `${endpoint}/${stream}`
+
+      const response = await fetch(testEndpoint, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ Data: `data for stream ${stream}`, PartitionKey: 'some key' })
+      })
+      expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+      expect(response.status).to.be.equal(200)
+      const body = await response.json()
+      expect(body).to.have.own.property('ShardId')
+      expect(body).to.have.own.property('SequenceNumber')
+    }
+  })
+})

__tests__/integration/kinesis/service/serverless.yml renamed to __tests__/integration/kinesis/single-integration/service/serverless.yml

@@ -5,7 +5,7 @@ provider:
   runtime: nodejs10.x
 
 plugins:
-  localPath: './../'
+  localPath: './../../../../../../'
   modules:
     - serverless-apigateway-service-proxy
 

__tests__/integration/kinesis/tests.js renamed to __tests__/integration/kinesis/single-integration/tests.js

@@ -2,21 +2,17 @@
 
 const expect = require('chai').expect
 const fetch = require('node-fetch')
-const { deployService, removeService, getApiGatewayEndpoint } = require('./../../utils')
+const { deployWithRandomStage, removeService } = require('../../../utils')
 
-describe('Kinesis Proxy Integration Test', () => {
+describe('Single Kinesis Proxy Integration Test', () => {
   let endpoint
-  let stackName
   let stage
-  const config = '__tests__/integration/kinesis/service/serverless.yml'
+  const config = '__tests__/integration/kinesis/single-integration/service/serverless.yml'
 
   beforeAll(async () => {
-    stage = Math.random()
-      .toString(32)
-      .substring(2)
-    stackName = 'kinesis-proxy-' + stage
-    deployService(stage, config)
-    endpoint = await getApiGatewayEndpoint(stackName)
+    const result = await deployWithRandomStage(config)
+    stage = result.stage
+    endpoint = result.endpoint
   })
 
   afterAll(() => {

__tests__/integration/sqs/multiple-integrations/service/serverless.yml

@@ -0,0 +1,39 @@
+service: multiple-sqs-proxy
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+plugins:
+  localPath: './../../../../../../'
+  modules:
+    - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayServiceProxies:
+    - sqs:
+        path: /sqs1
+        method: post
+        queueName: { 'Fn::GetAtt': ['SQSQueue1', 'QueueName'] }
+        cors: true
+
+    - sqs:
+        path: /sqs2
+        method: post
+        queueName: { 'Fn::GetAtt': ['SQSQueue2', 'QueueName'] }
+        cors: true
+
+    - sqs:
+        path: /sqs3
+        method: post
+        queueName: { 'Fn::GetAtt': ['SQSQueue3', 'QueueName'] }
+        cors: true
+
+resources:
+  Resources:
+    SQSQueue1:
+      Type: 'AWS::SQS::Queue'
+    SQSQueue2:
+      Type: 'AWS::SQS::Queue'
+    SQSQueue3:
+      Type: 'AWS::SQS::Queue'

__tests__/integration/sqs/multiple-integrations/tests.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const expect = require('chai').expect
+const fetch = require('node-fetch')
+const { deployWithRandomStage, removeService } = require('../../../utils')
+
+describe('Multiple SQS Proxy Integrations Test', () => {
+  let endpoint
+  let stage
+  const config = '__tests__/integration/sqs/multiple-integrations/service/serverless.yml'
+
+  beforeAll(async () => {
+    const result = await deployWithRandomStage(config)
+    stage = result.stage
+    endpoint = result.endpoint
+  })
+
+  afterAll(() => {
+    removeService(stage, config)
+  })
+
+  it('should get correct response from multiple sqs proxy endpoints', async () => {
+    const queues = ['sqs1', 'sqs2', 'sqs3']
+
+    for (const queue of queues) {
+      const testEndpoint = `${endpoint}/${queue}`
+      const response = await fetch(testEndpoint, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ message: `message for ${queue}` })
+      })
+      expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+      expect(response.status).to.be.equal(200)
+      const body = await response.json()
+      expect(body.SendMessageResponse.SendMessageResult).to.have.own.property(
+        'MD5OfMessageAttributes'
+      )
+      expect(body.SendMessageResponse.SendMessageResult).to.have.own.property('MD5OfMessageBody')
+      expect(body.SendMessageResponse.SendMessageResult).to.have.own.property('MessageId')
+      expect(body.SendMessageResponse.SendMessageResult).to.have.own.property('SequenceNumber')
+      expect(body.SendMessageResponse.ResponseMetadata).to.have.own.property('RequestId')
+    }
+  })
+})

__tests__/integration/sqs/service/serverless.yml renamed to __tests__/integration/sqs/single-integration/service/serverless.yml

@@ -5,7 +5,7 @@ provider:
   runtime: nodejs10.x
 
 plugins:
-  localPath: './../'
+  localPath: './../../../../../../'
   modules:
     - serverless-apigateway-service-proxy
 
@@ -14,10 +14,10 @@ custom:
     - sqs:
         path: /sqs
         method: post
-        queueName: {"Fn::GetAtt":[ "SQSQueue", "QueueName" ]}
+        queueName: { 'Fn::GetAtt': ['SQSQueue', 'QueueName'] }
         cors: true
 
 resources:
   Resources:
     SQSQueue:
-      Type: "AWS::SQS::Queue"
+      Type: 'AWS::SQS::Queue'