api: add helper to create object that is passed as locals to render

the automessages/manual messages

apps/api/helpers/get-render-data.js

@@ -0,0 +1,68 @@
+// this module returns an object of variables that will be passed as locals
+// to render the body/subject of an automessage / manual message
+
+/**
+ * npm dependencies
+ */
+
+var _ = require('lodash');
+
+
+
+/**
+ * The 'meta' array must have been converted toObject before calling this function
+ * The 'email' and 'user_id' are passed alongwith the all the metadata keys
+ *
+ * INPUT:
+ *
+    user: {
+      _id: 42389472398472839,
+      user_id: 'prateekbhatt',
+      email: 'prattbhatt@gmail.com',
+      meta: {
+        name: 'Prateek',
+        status: 'Free',
+        amount: 49
+      }
+    }
+ *
+ * OUTPUT:
+ *
+    user: {
+      email: 'prattbhatt@gmail.com',
+      user_id: 'prateekbhatt',
+      name: 'Prateek',
+      status: 'Free',
+      amount: 49
+    }
+ *
+ *
+ */
+
+function getRenderData(user) {
+
+  // if user is in BSON format, convert it into JSON
+  if (user.toJSON) {
+    user = user.toJSON();
+  }
+
+  var meta = user.meta;
+
+  if (_.isArray(meta)) {
+    throw new Error('getRenderData "user.meta" must be an object');
+  }
+
+  // add the email and user_id properties to the meta object
+  meta.email = user.email;
+  meta.user_id = user.user_id;
+
+  var locals = {
+    user: meta
+  };
+
+  return locals;
+
+}
+
+
+module.exports = getRenderData;

apps/api/test/unit/helpers/get-render-data.test.js

@@ -0,0 +1,63 @@
+describe('Helper get-render-data', function () {
+
+  /**
+   * Helpers
+   */
+
+  var getRenderData = require('../../../helpers/get-render-data');
+  var metadata = require('../../../helpers/metadata');
+
+
+  before(function (done) {
+    setupTestDb(done);
+  });
+
+  describe('()', function () {
+
+    var user;
+
+    var output;
+
+    beforeEach(function () {
+      user = saved.users.first.toJSON();
+      user.meta = metadata.toObject(user.meta);
+
+      output = {
+        user: {
+          user_id: user.user_id,
+          email: user.email,
+          name: user.meta.name
+        }
+      }
+    });
+
+
+    it('should throw error if user.meta is array, not object', function () {
+
+      function metaArray() {
+        getRenderData({
+          email: 'randomemail@example.com',
+          meta: [{
+            k: 'name',
+            v: 'Prateek'
+          }]
+        })
+      }
+
+      expect(metaArray).to.throw('getRenderData "user.meta" must be an object');
+
+    });
+
+
+    it('should create locals object for automessage', function () {
+
+      var locals = getRenderData(user);
+
+      expect(locals)
+        .to.have.property("user")
+        .that.is.an("object")
+        .that.deep.equals(output.user);
+    });
+
+  });
+});