Merge pull request #11 from holidayextras/WEB-10209

WEB-10209 Proxy specific values through json-api to subresources

Author: JordanHood

.gitignore

@@ -81,4 +81,5 @@ build/Release
 node_modules
 
 # make-up
-.eslintrc
+.eslintrc
+.eslintcache

.nvmrc

@@ -0,0 +1 @@
+6.9.4

circle.yml

@@ -1,6 +1,6 @@
 machine:
   node:
-    version: 4.4.4
+    version: 6.9.4
 dependencies:
   pre:
     - npm install git+ssh://git@github.com:holidayextras/deployment-helpers.git
@@ -11,7 +11,7 @@ test:
     - mkdir -p $CIRCLE_TEST_REPORTS/unit
     - mkdir -p $CIRCLE_TEST_REPORTS/coverage
   override:
-    - node_modules/.bin/make-up lib test
+    - npm run lint
     - istanbul cover _mocha --  --timeout 15000 --recursive test/**/*Test.js -R xunit > $CIRCLE_TEST_REPORTS/unit/results.xml
   post:
     - cp -r ./coverage/ $CIRCLE_ARTIFACTS/coverage

index.js

@@ -1,5 +1,5 @@
 /* jslint node: true */
-'use strict';
+'use strict'
 
 /*
 * @name /index.js
@@ -8,4 +8,4 @@
 * @author Kevin Hodges <kevin.hodges@holidayextras.com>
 */
 
-module.exports = require( './lib/pluginJsonapi.js' );
+module.exports = require('./lib/pluginJsonapi.js')

lib/pluginJsonapi.js

@@ -1,60 +1,68 @@
-'use strict';
+'use strict'
 
-var Boom = require('boom');
-var _ = require('lodash');
-var pluginName = 'pluginJsonapi';
-var utilities = require('./utilities');
+var Boom = require('boom')
+var _ = require('lodash')
+var pluginName = 'pluginJsonapi'
+var utilities = require('./utilities')
 
 // some paths sinply don't want to be jsonapi'd
 var ignorePaths = [
   '/', // Lout documentation and AWS healthcheck
   '/css/{path*}' // Lout documentation
-];
+]
 
 // certain status codes shouldn't be jsonapi'd
 var ignoreStatusCodes = [
   201, // Created (used on POST)
   204 // No Content (used on DELETE)
-];
+]
 
-var pluginJsonApi = module.exports = {};
+var proxyableKeys = [
+  'contentVersion',
+  'lang',
+  'ticketRates'
+]
 
-pluginJsonApi.errorHandler = function errorHandler(request, reply, error) {
-  request.log( ['error', __filename, pluginName], {
+var pluginJsonApi = module.exports = {}
+
+pluginJsonApi.errorHandler = function errorHandler (request, reply, error) {
+  request.log(['error', __filename, pluginName], {
     error: error.toString(),
     data: request.data
-  } );
+  })
 
-  return reply(Boom.internal(error));
-};
+  return reply(Boom.internal(error))
+}
 
-pluginJsonApi.alsoMakeItSo = function alsoMakeItSo(request, reply) { // eslint-disable-line consistent-return
+pluginJsonApi.alsoMakeItSo = function alsoMakeItSo (request, reply) {
+ // eslint-disable-line consistent-return
 
   try {
     // If there was no error and it's not one of our ignoredPaths or ignored status codes, jsonapi it
     if (request.response.isBoom || _.includes(ignorePaths, _.get(request, 'route.path')) || _.includes(ignoreStatusCodes, request.response.statusCode)) {
       // return early
-      return reply.continue();
+      return reply.continue()
     }
 
     // Make the response a bit more accessible
-    var result = _.get(request, 'response.source');
+    var result = _.get(request, 'response.source')
     // check a bind configuration is present
-    if ( !_.get(request, 'route.settings.bind.resourceName')) {
-      throw new Error('configuration bind.resourceName not found on handler');
+    if (!_.get(request, 'route.settings.bind.resourceName')) {
+      throw new Error('configuration bind.resourceName not found on handler')
     }
 
     // Get the current resource from the result
-    var resources = result[request.route.settings.bind.resourceName];
+    var resources = result[request.route.settings.bind.resourceName]
     if (!resources) {
       // no resources, return early
-      return reply.continue();
+      return reply.continue()
     }
 
     var stateObject = {
       request: request,
-      resources: resources
-    };
+      resources: resources,
+      proxyableKeys: proxyableKeys
+    }
 
     /*
      * Flow
@@ -64,23 +72,22 @@ pluginJsonApi.alsoMakeItSo = function alsoMakeItSo(request, reply) { // eslint-d
      * resolveLinkedData() - resolve the sub resources which we have collected previously
      */
     utilities.collectIncludes(stateObject)
+    .then(utilities.collectProxyableValues)
     .then(utilities.getSubResources)
     .then(utilities.getResources)
     .then(utilities.resolveLinkedData)
-    .then(function() {
+    .then(function () {
       // all done
-      return reply.continue();
+      return reply.continue()
     })
-    .fail(function(error) {
-      return pluginJsonApi.errorHandler(request, reply, error);
+    .fail(function (error) {
+      return pluginJsonApi.errorHandler(request, reply, error)
     })
-    .done();
-
-  } catch ( error ) {
-    return pluginJsonApi.errorHandler(request, reply, error);
+    .done()
+  } catch (error) {
+    return pluginJsonApi.errorHandler(request, reply, error)
   }
-};
-
+}
 
 /**
 * Registers the plugin when the hapi server bootstraps - follows the convention for Hapi.js plugins
@@ -89,23 +96,22 @@ pluginJsonApi.alsoMakeItSo = function alsoMakeItSo(request, reply) { // eslint-d
 * @param {function} next - the next plugin to be set up
 * @returns {undefined} Nothing - calls the next plugin
 */
-pluginJsonApi.register = function(server, options, next) {
-
-  function makeItSo(request, reply) {
-    return pluginJsonApi.alsoMakeItSo(request, reply);
+pluginJsonApi.register = function (server, options, next) {
+  function makeItSo (request, reply) {
+    return pluginJsonApi.alsoMakeItSo(request, reply)
   }
 
   // Extend the onPreResponse for EVERY request through the api
-  server.ext('onPreResponse', makeItSo);
+  server.ext('onPreResponse', makeItSo)
 
   // In order to test this functionality it needs to be exposed on the server.
   if (process.env.NODE_ENV === 'test') {
-    server.expose('makeItSo', makeItSo);
+    server.expose('makeItSo', makeItSo)
   }
 
-  next();
-};
+  next()
+}
 
 pluginJsonApi.register.attributes = {
   pkg: require('../package.json')
-};
+}