Merge pull request #22 from theburningmonk/feature/support_s3

Feature/support s3

Author: horike37

.gitignore

@@ -43,3 +43,4 @@ tmp
 tmpdirs-serverless
 .eslintcache
 .serverless
+.vscode

README.md

@@ -20,14 +20,15 @@ Please pull request if you are intersted in it.
 
 - Kinesis Streams
 - SQS
+- S3
 
 ## 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.
+Sample syntax for Kinesis proxy in `serverless.yml`.
 
 ```yaml
 custom:
@@ -49,12 +50,12 @@ 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'
+curl -X POST 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.
+Sample syntax for SQS proxy in `serverless.yml`.
 
 ```yaml
 custom:
@@ -74,7 +75,55 @@ resources:
 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'
+curl -X POST https://xxxxxx.execute-api.us-east-1.amazonaws.com/dev/sqs -d '{"message": "testtest"}' -H 'Content-Type:application/json'
+```
+
+### S3
+
+Sample syntax for S3 proxy in `serverless.yml`.
+
+```yaml
+custom:
+  apiGatewayServiceProxies:
+    - s3:
+        path: /s3
+        method: post
+        action: PutObject
+        bucket:
+          Ref: S3Bucket
+        key: static-key.json # use static key
+        cors: true
+
+    - s3:
+        path: /s3/{myKey} # use path param
+        method: get
+        action: GetObject
+        bucket:
+          Ref: S3Bucket
+        key:
+          pathParam: myKey
+        cors: true
+
+    - s3:
+        path: /s3
+        method: delete
+        action: DeleteObject
+        bucket:
+          Ref: S3Bucket
+        key:
+          queryStringParam: key # use query string param
+        cors: true
+
+resources:
+  Resources:
+    S3Bucket:
+      Type: 'AWS::S3::Bucket'
+```
+
+Sample request after deploying.
+
+```bash
+curl -X POST https://xxxxxx.execute-api.us-east-1.amazonaws.com/dev/s3 -d '{"message": "testtest"}' -H 'Content-Type:application/json'
 ```
 
 ## Common API Gateway features

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

@@ -0,0 +1,51 @@
+service: multiple-s3-proxy
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+plugins:
+  localPath: './../../../../../../'
+  modules:
+    - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayServiceProxies:
+    - s3:
+        path: /s3
+        method: post
+        action: PutObject
+        bucket:
+          Ref: S3Bucket
+        key: my-test-object.json  # static key
+        cors: true
+
+    - s3:
+        path: /s3/{key} # path param
+        method: get
+        action: GetObject
+        bucket:
+          Ref: S3Bucket
+        key:
+          pathParam: key
+        cors: true
+
+    - s3:
+        path: /s3
+        method: delete
+        action: DeleteObject
+        bucket:
+          Ref: S3Bucket
+        key:
+          queryStringParam: key # query string param
+        cors: true
+
+resources:
+  Resources:
+    S3Bucket:
+      Type: 'AWS::S3::Bucket'
+
+  Outputs:
+    S3BucketName:
+      Value:
+        Ref: S3Bucket

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

@@ -0,0 +1,69 @@
+'use strict'
+
+const expect = require('chai').expect
+const fetch = require('node-fetch')
+const {
+  deployWithRandomStage,
+  removeService,
+  getS3Object,
+  deleteS3Object
+} = require('../../../utils')
+
+describe('Multiple S3 Proxies Integration Test', () => {
+  let endpoint
+  let stage
+  let bucket
+  const config = '__tests__/integration/s3/multiple-integrations/service/serverless.yml'
+  const key = 'my-test-object.json'
+
+  beforeAll(async () => {
+    const result = await deployWithRandomStage(config)
+
+    stage = result.stage
+    endpoint = result.endpoint
+    bucket = result.outputs.S3BucketName
+  })
+
+  afterAll(async () => {
+    await deleteS3Object(bucket, key)
+    removeService(stage, config)
+  })
+
+  it('should get correct response from s3 put endpoint', async () => {
+    const putEndpoint = `${endpoint}/s3`
+
+    const putResponse = await fetch(putEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: 'test' })
+    })
+    expect(putResponse.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(putResponse.status).to.be.equal(200)
+
+    const uploadedObject = await getS3Object(bucket, key)
+    expect(uploadedObject.toString()).to.equal(JSON.stringify({ message: 'test' }))
+  })
+
+  it('should get correct response from s3 get endpoint', async () => {
+    const getEndpoint = `${endpoint}/s3/${key}`
+
+    const getResponse = await fetch(getEndpoint, {
+      method: 'GET',
+      headers: { Accept: 'application/json' }
+    })
+    expect(getResponse.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(getResponse.status).to.be.equal(200)
+
+    const body = await getResponse.json()
+    expect(body).to.deep.equal({ message: 'test' })
+  })
+
+  it('should get correct response from s3 delete endpoint', async () => {
+    const deleteEndpoint = `${endpoint}/s3?key=${key}`
+
+    const deleteResponse = await fetch(deleteEndpoint, {
+      method: 'DELETE'
+    })
+    expect(deleteResponse.status).to.be.equal(200)
+  })
+})

__tests__/integration/s3/single-integration/service/serverless.yml

@@ -0,0 +1,32 @@
+service: s3-proxy
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+plugins:
+  localPath: './../../../../../../'
+  modules:
+    - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayServiceProxies:
+    - s3:
+        path: /s3/{key}
+        method: post
+        action: PutObject
+        bucket:
+          Ref: S3Bucket
+        key:
+          pathParam: key
+        cors: true
+
+resources:
+  Resources:
+    S3Bucket:
+      Type: 'AWS::S3::Bucket'
+
+  Outputs:
+    S3BucketName:
+      Value:
+        Ref: S3Bucket

__tests__/integration/s3/single-integration/tests.js

@@ -0,0 +1,46 @@
+'use strict'
+
+const expect = require('chai').expect
+const fetch = require('node-fetch')
+const {
+  deployWithRandomStage,
+  removeService,
+  getS3Object,
+  deleteS3Object
+} = require('../../../utils')
+
+describe('Single S3 Proxy Integration Test', () => {
+  let endpoint
+  let stage
+  let bucket
+  const config = '__tests__/integration/s3/single-integration/service/serverless.yml'
+  const key = 'my-test-object.json'
+
+  beforeAll(async () => {
+    const result = await deployWithRandomStage(config)
+
+    stage = result.stage
+    endpoint = result.endpoint
+    bucket = result.outputs.S3BucketName
+  })
+
+  afterAll(async () => {
+    await deleteS3Object(bucket, key)
+    removeService(stage, config)
+  })
+
+  it('should get correct response from s3 proxy endpoint', async () => {
+    const testEndpoint = `${endpoint}/s3/${key}`
+
+    const response = await fetch(testEndpoint, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ message: 'test' })
+    })
+    expect(response.headers.get('access-control-allow-origin')).to.deep.equal('*')
+    expect(response.status).to.be.equal(200)
+
+    const uploadedObject = await getS3Object(bucket, key)
+    expect(uploadedObject.toString()).to.equal(JSON.stringify({ message: 'test' }))
+  })
+})

__tests__/utils.js

@@ -6,14 +6,41 @@ const fs = require('fs')
 const path = require('path')
 const execSync = require('child_process').execSync
 const aws = require('aws-sdk')
+const s3 = new aws.S3()
 const cloudformation = new aws.CloudFormation({ region: 'us-east-1' })
 
-async function getApiGatewayEndpoint(stackName) {
+function getApiGatewayEndpoint(outputs) {
+  return outputs.ServiceEndpoint.match(/https:\/\/.+\.execute-api\..+\.amazonaws\.com.+/)[0]
+}
+
+async function getStackOutputs(stackName) {
   const result = await cloudformation.describeStacks({ StackName: stackName }).promise()
+  const stack = result.Stacks[0]
+
+  const keys = stack.Outputs.map((x) => x.OutputKey)
+  const values = stack.Outputs.map((x) => x.OutputValue)
+
+  return _.zipObject(keys, values)
+}
+
+async function getS3Object(bucket, key) {
+  const resp = await s3
+    .getObject({
+      Bucket: bucket,
+      Key: key
+    })
+    .promise()
+
+  return resp.Body
+}
 
-  const endpointOutput = _.find(result.Stacks[0].Outputs, { OutputKey: 'ServiceEndpoint' })
-    .OutputValue
-  return endpointOutput.match(/https:\/\/.+\.execute-api\..+\.amazonaws\.com.+/)[0]
+async function deleteS3Object(bucket, key) {
+  await s3
+    .deleteObject({
+      Bucket: bucket,
+      Key: key
+    })
+    .promise()
 }
 
 function deployService(stage, config) {
@@ -37,14 +64,16 @@ async function deployWithRandomStage(config) {
     .substring(2)
   const stackName = `${serviceName}-${stage}`
   deployService(stage, config)
-  const endpoint = await getApiGatewayEndpoint(stackName)
+  const outputs = await getStackOutputs(stackName)
+  const endpoint = getApiGatewayEndpoint(outputs)
 
-  return { stage, endpoint }
+  return { stackName, stage, outputs, endpoint }
 }
 
 module.exports = {
-  getApiGatewayEndpoint,
   deployService,
   removeService,
-  deployWithRandomStage
+  deployWithRandomStage,
+  getS3Object,
+  deleteS3Object
 }

lib/apiGateway/methods.js

@@ -1,7 +1,7 @@
 'use strict'
 
 module.exports = {
-  async getMethodResponses(http) {
+  getMethodResponses(http) {
     const methodResponse = {
       Properties: {
         MethodResponses: [
@@ -14,6 +14,11 @@ module.exports = {
             ResponseParameters: {},
             ResponseModels: {},
             StatusCode: 400
+          },
+          {
+            ResponseParameters: {},
+            ResponseModels: {},
+            StatusCode: 500
           }
         ]
       }
@@ -25,7 +30,7 @@ module.exports = {
         origin = http.cors.origins.join(',')
       }
 
-      methodResponse.Properties.MethodResponses.forEach(async (val, i) => {
+      methodResponse.Properties.MethodResponses.forEach((val, i) => {
         methodResponse.Properties.MethodResponses[i].ResponseParameters = {
           'method.response.header.Access-Control-Allow-Origin': `'${origin}'`
         }