support for deploying to services/ui_api release APIs (#45)

Author: djanhjo

README.md

@@ -2,17 +2,27 @@
 
 # ember-cli-deploy-rest
 
-An ember-cli-deploy plugin to upload index.html files to a REST API. This is useful if you wrap your Ember app in a traditional web app, such as Rails.
+A modified ember-cli-deploy plugin to upload index.html files to a REST API. This is useful if you wrap your Ember app in a traditional web app, such as Rails.
 
 ## API requirements
 
-Your REST API should follow the spec below. Note that the base URL is configurable; for these examples we assume it's `https://yourapp.com/ember-revisions`.
+Your REST API should follow the spec below. Note that the base URL is configurable.
+
+The original implementation assumes an example base URL of `https://yourapp.com/ember-revisions`.
 
 - Authenticate with basic auth (please use HTTPS!)
 - `GET /ember-revisions`: returns a JSON array of objects for the stored revisions. Fields are `id` (revision key), `created_at` (upload timestamp), `revision_data` (usually contains revision metadata) and `current` (boolean)
 - `POST /ember-revisions`: expects a JSON body with fields `id` (revision key) and `body` (the index.html contents)
 - `PUT /ember-revisions/<id>`: activates the revision with key `id`
 
+Our Customer.io implementation has slightly different endpoints and parameters.
+
+- Authenticate with basic auth (please use HTTPS!), utilizing the prefix `Bearer`
+- `GET /`: returns a JSON array of objects for all apps (ONLY ON HYDRA, NOT SERVICES)
+- `GET /<app_name>`: returns a JSON array of objects for the specified app
+- `POST /<app_name>`: expects a JSON body with the fields `version` (revision key) and `body` (the index.html contents)
+- `PUT /<app_name>/<version>/activate`: activates the specified app with the specified version
+
 ## Quick Start
 
 To get up and running quickly, do the following:

index.js

@@ -21,7 +21,9 @@ module.exports = {
 
       // eslint-disable-next-line ember/avoid-leaking-state-in-ember-objects
       defaultConfig: {
+        appName: 'journeys',
         useHydra: false,
+        useServices: false,
         useBearerToken: false,
         bearer: undefined,
         filePattern: 'index.html',
@@ -64,6 +66,7 @@ module.exports = {
 
       upload: function () {
         var useHydra = this.readConfig('useHydra');
+        var useServices = this.readConfig('useServices');
         var restClient = this.readConfig('restClient');
         var revisionKey = this.readConfig('revisionKey');
         var distDir = this.readConfig('distDir');
@@ -77,7 +80,15 @@ module.exports = {
 
         if (useHydra) {
           return this._readFileContents(filePath)
-            .then(restClient.uploadAppRelease.bind(restClient, keyPrefix, revisionKey, appName))
+            .then(restClient.uploadReleaseToHydra.bind(restClient, keyPrefix, revisionKey, appName))
+            .then(this._uploadSuccessMessage.bind(this))
+            .then(function (key) {
+              return { key: key };
+            })
+            .catch(this._errorMessage.bind(this));
+        } else if (useServices) {
+          return this._readFileContents(filePath)
+            .then(restClient.updateReleaseToServices.bind(restClient, keyPrefix, revisionKey, appName))
             .then(this._uploadSuccessMessage.bind(this))
             .then(function (key) {
               return { key: key };
@@ -97,9 +108,11 @@ module.exports = {
       willActivate: function (/* context */) {
         var restClient = this.readConfig('restClient');
         var keyPrefix = this.readConfig('keyPrefix');
+        var appName = this.readConfig('appName');
         var useHydra = this.readConfig('useHydra');
+        var useServices = this.readConfig('useServices');
 
-        var revisionKey = restClient.activeRevision(keyPrefix, useHydra);
+        var revisionKey = restClient.activeRevision(keyPrefix, appName, useHydra || useServices, useHydra);
 
         return {
           revisionData: {
@@ -112,12 +125,14 @@ module.exports = {
         var restClient = this.readConfig('restClient');
         var revisionKey = this.readConfig('revisionKey');
         var keyPrefix = this.readConfig('keyPrefix');
+        var appName = this.readConfig('appName');
         var useHydra = this.readConfig('useHydra');
+        var useServices = this.readConfig('useServices');
 
         this.log('Activating revision `' + revisionKey + '`', {
           verbose: true,
         });
-        return Promise.resolve(restClient.activate(keyPrefix, revisionKey, useHydra))
+        return Promise.resolve(restClient.activate(keyPrefix, revisionKey, appName, useHydra || useServices, useHydra))
           .then(this.log.bind(this, '✔ Activated revision `' + revisionKey + '`', {}))
           .then(function () {
             return {
@@ -139,12 +154,14 @@ module.exports = {
       fetchInitialRevisions: function (/* context */) {
         var restClient = this.readConfig('restClient');
         var keyPrefix = this.readConfig('keyPrefix');
+        var appName = this.readConfig('appName');
         var useHydra = this.readConfig('useHydra');
+        var useServices = this.readConfig('useServices');
 
         this.log('Listing initial revisions for key: `' + keyPrefix + '`', {
           verbose: true,
         });
-        return Promise.resolve(restClient.fetchRevisions(keyPrefix, useHydra))
+        return Promise.resolve(restClient.fetchRevisions(keyPrefix, appName, useHydra || useServices, useHydra))
           .then(function (revisions) {
             return {
               initialRevisions: revisions,
@@ -156,10 +173,14 @@ module.exports = {
       fetchRevisions: function (/* context */) {
         var restClient = this.readConfig('restClient');
         var keyPrefix = this.readConfig('keyPrefix');
+        var appName = this.readConfig('appName');
         var useHydra = this.readConfig('useHydra');
+        var useServices = this.readConfig('useServices');
 
         this.log('Listing revisions for key: `' + keyPrefix + '`');
-        return restClient.fetchRevisions(keyPrefix, useHydra).catch(this._errorMessage.bind(this));
+        return restClient
+          .fetchRevisions(keyPrefix, appName, useHydra || useServices, useHydra)
+          .catch(this._errorMessage.bind(this));
       },
 
       _readFileContents: function (path) {

lib/rest-client.js

@@ -27,7 +27,7 @@ module.exports = CoreObject.extend({
     });
   },
 
-  uploadAppRelease: function (keyPrefix, revisionKey, appName, value) {
+  uploadReleaseToHydra: function (keyPrefix, revisionKey, appName, value) {
     var version = this._uploadKey(keyPrefix, revisionKey);
 
     var requestBody = {
@@ -41,15 +41,15 @@ module.exports = CoreObject.extend({
     });
   },
 
-  uploadHydraRelease: function (keyPrefix, revisionKey, value) {
+  updateReleaseToServices: function (keyPrefix, revisionKey, appName, value) {
     var version = this._uploadKey(keyPrefix, revisionKey);
 
     var requestBody = {
       id: version,
       body: value,
     };
 
-    return denodeify(this._request.post)({ body: requestBody }).then(function () {
+    return denodeify(this._request.post)({ uri: appName, body: requestBody }).then(function () {
       return version;
     });
   },
@@ -71,22 +71,22 @@ module.exports = CoreObject.extend({
     });
   },
 
-  activate: function (keyPrefix, revisionKey, useHydra) {
-    return this._listRevisions(keyPrefix, useHydra)
+  activate: function (keyPrefix, revisionKey, appName, useReleaseEndpoint, isSummaryEndpoint) {
+    return this._listRevisions(keyPrefix, appName, useReleaseEndpoint, isSummaryEndpoint)
       .then(this._validateRevisionKey.bind(this, keyPrefix, revisionKey))
-      .then(this._activateRevision.bind(this, keyPrefix, revisionKey, useHydra));
+      .then(this._activateRevision.bind(this, keyPrefix, revisionKey, useReleaseEndpoint));
   },
 
-  fetchRevisions: function (keyPrefix, useHydra) {
-    return this._listRevisions(keyPrefix, useHydra).then(function (revisions) {
+  fetchRevisions: function (keyPrefix, appName, useReleaseEndpoint, isSummaryEndpoint) {
+    return this._listRevisions(keyPrefix, appName, useReleaseEndpoint, isSummaryEndpoint).then(function (revisions) {
       return {
         revisions: revisions,
       };
     });
   },
 
-  activeRevision: function (keyPrefix, useHydra) {
-    return this._listRevisions(keyPrefix, useHydra).then(function (revisions) {
+  activeRevision: function (keyPrefix, appName, useReleaseEndpoint, isSummaryEndpoint) {
+    return this._listRevisions(keyPrefix, appName, useReleaseEndpoint, isSummaryEndpoint).then(function (revisions) {
       var i;
 
       for (i = 0; i < revisions.length; i++) {
@@ -97,15 +97,24 @@ module.exports = CoreObject.extend({
     });
   },
 
-  _listRevisions: function (keyPrefix, useHydra) {
+  _listRevisions: function (keyPrefix, appName, useReleaseEndpoint, isSummaryEndpoint) {
     var qs = {};
-
     if (keyPrefix) {
       qs.prefix = keyPrefix;
     }
 
-    return denodeify(this._request.get)({ qs: qs }).then(function (response) {
-      var responseBody = useHydra ? response.body.filter((rev) => rev.app === 'journeys') : response.body;
+    var uri = '';
+    if (useReleaseEndpoint && !isSummaryEndpoint) {
+      uri = appName;
+    }
+
+    return denodeify(this._request.get)({ uri, qs: qs }).then(function (response) {
+      var responseBody =
+        useReleaseEndpoint && isSummaryEndpoint ? response.body.filter((rev) => rev.app === appName) : response.body;
+
+      if (response.statusCode == 404) {
+        return [];
+      }
 
       return responseBody.map(function (revision) {
         // ember-cli-deploy-display-revisions expects the timestamp to be either
@@ -118,7 +127,7 @@ module.exports = CoreObject.extend({
         }
 
         return {
-          revision: revision.id,
+          revision: useReleaseEndpoint && !isSummaryEndpoint ? revision.version : revision.id,
           revisionData: revisionData,
           timestamp: new Date(revision.created_at * 1000),
           active: revision.current,
@@ -136,10 +145,10 @@ module.exports = CoreObject.extend({
     return isPresent ? Promise.resolve() : Promise.reject('`' + uploadKey + '` is not a valid revision key');
   },
 
-  _activateRevision: function (keyPrefix, revisionKey, useHydra) {
+  _activateRevision: function (keyPrefix, revisionKey, useReleaseEndpoint) {
     var uri = this._uploadKey(keyPrefix, revisionKey);
 
-    if (useHydra) {
+    if (useReleaseEndpoint) {
       uri = `journeys/${uri}/activate`;
     }