Add support for multiple events for a single function (#50)

This adds support for multiple (documented) events for a single function. I've also got an extra test I created as I was learning what was going on, I can strip that out if you'd like.

Great plugin BTW, thanks for your hard work. 👍

Author: tomsaleeba

src/documentation.js

@@ -141,8 +141,8 @@ module.exports = function() {
 
     getFunctionDocumentationParts: function getFunctionDocumentationParts() {
       const httpEvents = this._getHttpEvents();
-      Object.keys(httpEvents).forEach(funcName => {
-        const httpEvent = httpEvents[funcName];
+      Object.keys(httpEvents).forEach(funcNameAndPath => {
+        const httpEvent = httpEvents[funcNameAndPath];
         const path = httpEvent.path;
         const method = httpEvent.method.toUpperCase();
         this.createDocumentationParts(functionDocumentationParts, httpEvent, { path, method });
@@ -152,14 +152,13 @@ module.exports = function() {
     _getHttpEvents: function _getHttpEvents() {
       return this.serverless.service.getAllFunctions().reduce((documentationObj, functionName) => {
         const func = this.serverless.service.getFunction(functionName);
-        const funcHttpEvent = func.events
-        .filter((eventTypes) => eventTypes.http && eventTypes.http.documentation)
-        .map((eventTypes) => eventTypes.http)[0];
-
-        if (funcHttpEvent) {
-          documentationObj[functionName] = funcHttpEvent;
-        }
-
+        func.events
+          .filter((eventTypes) => eventTypes.http && eventTypes.http.documentation)
+          .map((eventTypes) => eventTypes.http)
+          .forEach(currEvent => {
+            let key = functionName + currEvent.path;
+            documentationObj[key] = currEvent;
+          });
         return documentationObj;
       }, {});
     },

src/index.spec.js

@@ -460,6 +460,116 @@ describe('ServerlessAWSDocumentation', function () {
       });
     });
 
+    it('should add multiple response models with different content types for the same HTTP status code to ApiGateway methods', function () {
+      this.serverlessMock.variables.service.custom.documentation.models = [{
+        name: 'CreateResponseJson',
+        contentType: "application/json",
+        schema: {
+          type: 'object'
+        }
+      }, {
+        name: 'CreateResponseXml',
+        contentType: "application/xml",
+        schema: {
+          type: 'object'
+        }
+      }];
+      this.serverlessMock.service._functionNames = ['test'];
+      this.serverlessMock.service._functions = {
+        test: {
+          events: [{
+            http: {
+              path: 'some/path',
+              method: 'post',
+              cors: true,
+              private: true,
+              documentation: {
+                methodResponses: [
+                  {
+                    statusCode: 200,
+                    responseModels: {
+                      'application/json': 'CreateResponseJson',
+                      'application/xml': 'CreateResponseXml',
+                    },
+                    responseHeaders: [{
+                      name: 'x-header',
+                      description: 'THE header',
+                    }],
+                  },
+                ],
+              }
+            },
+          }],
+        },
+      };
+
+      const resources = this.serverlessMock.service.provider.compiledCloudFormationTemplate.Resources;
+      resources.somepath_post = {
+        some: 'configuration',
+        Properties: {},
+      };
+
+      this.plugin.beforeDeploy();
+
+      expect(this.serverlessMock.service.provider.compiledCloudFormationTemplate).toEqual({
+        Resources: {
+          ExistingResource: {
+            with: 'configuration',
+          },
+          somepath_post: {
+            some: 'configuration',
+            DependsOn: ['CreateResponseJsonModel', 'CreateResponseXmlModel'],
+            Properties: {
+              MethodResponses: [{
+                StatusCode: '200',
+                ResponseModels: {
+                  'application/json': 'CreateResponseJson',
+                  'application/xml': 'CreateResponseXml',
+                },
+                ResponseParameters: {
+                  'method.response.header.x-header': true,
+                },
+              }],
+            },
+          },
+          CreateResponseJsonModel: {
+            Type: 'AWS::ApiGateway::Model',
+            Properties: {
+              RestApiId: {
+                Ref: 'ApiGatewayRestApi'
+              },
+              ContentType: 'application/json',
+              Name: 'CreateResponseJson',
+              Schema: {
+                type: 'object'
+              }
+            }
+          },
+          CreateResponseXmlModel: {
+            Type: 'AWS::ApiGateway::Model',
+            Properties: {
+              RestApiId: {
+                Ref: 'ApiGatewayRestApi'
+              },
+              ContentType: 'application/xml',
+              Name:'CreateResponseXml',
+              Schema: {
+                type: 'object'
+              }
+            },
+          },
+        },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
+      });
+    });
+
     it('should only add response methods with existing MethodResponses to ApiGateway methods', function () {
       this.serverlessMock.variables.service.custom.documentation.models = [];
       this.serverlessMock.service._functionNames = ['test'];
@@ -1954,6 +2064,135 @@ describe('ServerlessAWSDocumentation', function () {
       });
     });
 
+    it('should build documentation for all http event under a function', function (done) {
+      this.serverlessMock.variables.service.custom.documentation.api = {
+        description: 'this is an api',
+      };
+      this.serverlessMock.variables.service.custom.documentation.resources = [{
+        path: 'super/path',
+        description: 'this is a super path',
+      }, {
+        path: 'hidden/path',
+        description: 'this is a super secret hidden path',
+      }];
+
+      this.serverlessMock.service._functionNames = ['test'];
+      this.serverlessMock.service._functions = {
+        test: {
+          events: [{
+            http: {
+              path: 'some/path',
+              method: 'post',
+              documentation: {
+                summary: 'hello',
+                description: 'hello hello',
+              }
+            },
+          },{
+            http: {
+              path: 'some/other/path',
+              method: 'get',
+              documentation: {
+                summary: 'blah',
+                description: 'blah blah'
+              },
+            },
+          }],
+        },
+      };
+
+      this.optionsMock.stage = 'megastage';
+      this.optionsMock.region = 'hyperregion';
+      this.serverlessMock.providers.aws.naming.getStackName.and.returnValue('superstack');
+      this.serverlessMock.providers.aws.request.and.callFake((api, method) => {
+        switch (method) {
+          case 'describeStacks':
+            return Promise.resolve({
+              Stacks: [{
+                Outputs: [{
+                  OutputKey: 'ApiKey',
+                  OutputValue: 'nothing',
+                }, {
+                  OutputKey: 'AwsDocApiId',
+                  OutputValue: 'superid',
+                }],
+              }],
+            });
+          case 'getDocumentationParts':
+            return Promise.resolve({ items: [], });
+          case 'getDocumentationVersion':
+            return Promise.reject(new Error('Invalid Documentation version specified'));
+          default:
+            return Promise.resolve();
+        }
+      });
+
+      this.plugin.afterDeploy();
+      setTimeout(() => {
+        // 23
+        expect(this.serverlessMock.providers.aws.request).toHaveBeenCalledWith(
+          'APIGateway',
+          'getDocumentationParts',
+          {
+            restApiId: 'superid',
+            limit: 9999,
+          }
+        );
+
+        // Create documentation parts
+        expect(this.serverlessMock.providers.aws.request).toHaveBeenCalledWith(
+          'APIGateway',
+          'createDocumentationPart',
+          {
+            location: { type: 'API' },
+            properties: JSON.stringify({ description: 'this is an api' }),
+            restApiId: 'superid',
+          }
+        );
+
+        expect(this.serverlessMock.providers.aws.request).toHaveBeenCalledWith(
+          'APIGateway',
+          'createDocumentationPart',
+          {
+            location: { type: 'RESOURCE', path: 'super/path' },
+            properties: JSON.stringify({ description: 'this is a super path' }),
+            restApiId: 'superid',
+          }
+        );
+
+        expect(this.serverlessMock.providers.aws.request).toHaveBeenCalledWith(
+          'APIGateway',
+          'createDocumentationPart',
+          {
+            location: { type: 'RESOURCE', path: 'hidden/path' },
+            properties: JSON.stringify({ description: 'this is a super secret hidden path' }),
+            restApiId: 'superid',
+          }
+        );
+
+        expect(this.serverlessMock.providers.aws.request).toHaveBeenCalledWith(
+          'APIGateway',
+          'createDocumentationPart',
+          {
+            location: { path: 'some/path', method: 'POST', type: 'METHOD' },
+            properties: JSON.stringify({ description: 'hello hello', summary: 'hello' }),
+            restApiId: 'superid',
+          }
+        );
+
+        expect(this.serverlessMock.providers.aws.request).toHaveBeenCalledWith(
+          'APIGateway',
+          'createDocumentationPart',
+          {
+            location: { path: 'some/other/path', method: 'GET', type: 'METHOD' },
+            properties: JSON.stringify({ description: 'blah blah', summary: 'blah' }),
+            restApiId: 'superid',
+          }
+        );
+        done();
+      });
+    });
+
     it('should not deploy when documentation version is not updated', function (done) {
       spyOn(console, 'info');
       this.serverlessMock.providers.aws.naming.getStackName.and.returnValue('superstack');
@@ -2434,6 +2673,5 @@ describe('ServerlessAWSDocumentation', function () {
       const v4 = this.plugin.getDocumentationVersion();
       expect(v4).toBe(v3);
     });
-
   });
 });