[WIP] add api keys functionality

Author: horike37

lib/deploy/events/apiGateway/apiKeys.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const _ = require('lodash');
+const BbPromise = require('bluebird');
+
+module.exports = {
+  compileApiKeys() {
+    if (this.serverless.service.provider.apiKeys) {
+      if (!Array.isArray(this.serverless.service.provider.apiKeys)) {
+        throw new this.serverless.classes.Error('apiKeys property must be an array');
+      }
+
+      _.forEach(this.serverless.service.provider.apiKeys, (apiKey, i) => {
+        const apiKeyNumber = i + 1;
+
+        if (typeof apiKey !== 'string') {
+          throw new this.serverless.classes.Error('API Keys must be strings');
+        }
+
+        const apiKeyLogicalId = this.provider.naming
+          .getApiKeyLogicalId(apiKeyNumber);
+
+        _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
+          [apiKeyLogicalId]: {
+            Type: 'AWS::ApiGateway::ApiKey',
+            Properties: {
+              Enabled: true,
+              Name: apiKey,
+              StageKeys: [{
+                RestApiId: { Ref: this.apiGatewayRestApiLogicalId },
+                StageName: this.provider.getStage(),
+              }],
+            },
+            DependsOn: this.apiGatewayDeploymentLogicalId,
+          },
+        });
+      });
+    }
+    return BbPromise.resolve();
+  },
+};

lib/deploy/events/apiGateway/apiKeys.test.js

@@ -0,0 +1,88 @@
+'use strict';
+
+const expect = require('chai').expect;
+const Serverless = require('serverless/lib/Serverless');
+const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
+const ServerlessStepFunctions = require('./../../../index');
+
+describe('#methods()', () => {
+  let serverless;
+  let serverlessStepFunctions;
+
+  beforeEach(() => {
+    serverless = new Serverless();
+    const options = {
+      stage: 'dev',
+      region: 'us-east-1',
+    };
+    serverless.setProvider('aws', new AwsProvider(serverless));
+    serverless.service.provider.apiKeys = ['1234567890'];
+    serverless.service.provider.compiledCloudFormationTemplate = {
+      Resources: {},
+    };
+    serverlessStepFunctions = new ServerlessStepFunctions(serverless, options);
+    serverlessStepFunctions.serverless.service.stepFunctions = {
+      stateMachines: {
+        first: {},
+      },
+    };
+    serverlessStepFunctions.apiGatewayRestApiLogicalId = 'ApiGatewayRestApi';
+    serverlessStepFunctions.apiGatewayDeploymentLogicalId = 'ApiGatewayDeploymentTest';
+  });
+
+  it('should compile api key resource', () =>
+    serverlessStepFunctions.compileApiKeys().then(() => {
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+          ].Type
+      ).to.equal('AWS::ApiGateway::ApiKey');
+
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+          ].Properties.Enabled
+      ).to.equal(true);
+
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+          ].Properties.Name
+      ).to.equal('1234567890');
+
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+          ].Properties.StageKeys[0].RestApiId.Ref
+      ).to.equal('ApiGatewayRestApi');
+
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+          ].Properties.StageKeys[0].StageName
+      ).to.equal('dev');
+
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+          ].DependsOn
+      ).to.equal('ApiGatewayDeploymentTest');
+    })
+  );
+
+  it('throw error if apiKey property is not an array', () => {
+    serverlessStepFunctions.serverless.service.provider.apiKeys = 2;
+    expect(() => serverlessStepFunctions.compileApiKeys()).to.throw(Error);
+  });
+
+  it('throw error if an apiKey is not a string', () => {
+    serverlessStepFunctions.serverless.service.provider.apiKeys = [2];
+    expect(() => serverlessStepFunctions.compileApiKeys()).to.throw(Error);
+  });
+});

lib/index.js

@@ -8,6 +8,7 @@ const httpValidate = require('./deploy/events/apiGateway/validate');
 const httpResources = require('./deploy/events/apiGateway/resources');
 const httpMethods = require('./deploy/events/apiGateway/methods');
 const httpCors = require('./deploy/events/apiGateway/cors');
+const httpApiKeys = require('./deploy/events/apiGateway/apiKeys');
 const httpIamRole = require('./deploy/events/apiGateway/iamRole');
 const httpDeployment = require('./deploy/events/apiGateway/deployment');
 const httpRestApi = require('./deploy/events/apiGateway/restApi');
@@ -38,6 +39,7 @@ class ServerlessStepFunctions {
       httpResources,
       httpMethods,
       httpCors,
+      httpApiKeys,
       httpIamRole,
       httpDeployment,
       invoke,
@@ -106,6 +108,7 @@ class ServerlessStepFunctions {
             .then(this.compileResources)
             .then(this.compileMethods)
             .then(this.compileCors)
+            .then(this.compileApiKeys)
             .then(this.compileHttpIamRole)
             .then(this.compileDeployment);
         }