Write populate blueprint (#49)

* Adding base support for "populate." Writing tests after.

* Method info clarification.

* Comment correction and improvement.

* Forgot to add support for queries on non-ID requests.

* Add basic initial tests.

* Finalized and verified relationship tests.

* Enabling pluralization in dummy test Sails config.

* HOTFIX add symlink in dummy app node_modules to refer to current module code

* Delete sails-json-api-blueprints

* Accidentally removed symlink thanks to Windows.

* Updated formatting of changes to meet repo guidelines.

Author: GoldenChrysus

lib/api/blueprints/_util/actionUtil.js

@@ -1,3 +1,8 @@
+/**
+ * Module dependencies
+ */
+let pluralize = require("pluralize");
+
 /**
  * Utility methods used in built-in blueprint actions.
  *
@@ -83,6 +88,43 @@ module.exports = {
     return pk;
   },
 
+  /**
+   * Parse parent key value for use in a Waterline criteria
+   * (e.g. for `populate`)
+   *
+   * @param  {Request} req
+   * @return {Integer|String}
+   */
+  parseParentId: function(req) {
+    return req.options.parentid || req.param("parentid");
+  },
+
+  /**
+   * Parse relationship alias for use in a Waterline criteria
+   * (e.g. for `populate`)
+   *
+   * @param  {Request} req
+   * @return {String}
+   */
+  parseAlias: function(req) {
+    return req.options.alias;
+  },
+
+  /**
+   * Parse relationship alias model name for use in a Waterline criteria
+   * (e.g. for `populate`)
+   *
+   * @param  {Request} req
+   * @return {String}
+   */
+  parseAliasModelName: function(req) {
+    let Model     = module.exports.parseModel(req);
+    let alias     = module.exports.parseAlias(req);
+    let attribute = Model.attributes[alias];
+
+    return (attribute) ? pluralize(attribute.model || attribute.collection) : false;
+  },
+
   /**
    * Parse a JSON API request and set query to be populated with all defined relationships
    *

lib/api/blueprints/populate.js

@@ -1,5 +1,58 @@
+/**
+ * Module dependencies
+ */
+let actionUtil = require("./_util/actionUtil");
+let pluralize = require("pluralize");
+
+/**
+ * Populate Relationships
+ *
+ * get /:modelIdentity/:parentid/:alias
+ * get /:modelIdentity/:parentid/:alias/:id
+ *
+ * An API call to find and return relationship instances from the data adapter
+ * using the specified criteria.
+ *
+ * Required:
+ * @param {Integer|String} parentid - the unique ID of the particular parent model you'd like to look up
+ * @param {String}         alias    - the collection alias used to look up relationships
+ *
+ * Optional:
+ * @param {Integer|String} id       - the unique ID of the particular relationship model you'd like to look up *
+ *
+ */
+
 module.exports = function findRecords(req, res) {
+  let Model = actionUtil.parseModel(req);
+  let alias = actionUtil.parseAlias(req);
+  let parent_id = actionUtil.parseParentId(req);
+  let pk = actionUtil.parsePk(req);
+  let query_params = JsonApiService.deserialize(req.query.filter) || null;
+  let query = Model.findOne(parent_id).populate(alias, pk || query_params);
+
+  query.exec((err, result) => {
+    if (err) {
+      return res.serverError(err);
+    }
+
+    if (!result) {
+      return res.ok(result);
+    }
+
+    let sub_results = result[alias];
+
+    if 
+    (
+      pk &&
+      (
+        !sub_results ||
+        (Array.isArray(sub_results) && (!sub_results || sub_results.length === 0)) ||
+        (sub_results !== null && typeof sub_results === "object" && Object.keys(sub_results).length === 0)
+      )
+    ) {
+      return res.notFound("No record found with the specified ID.");
+    }
 
-  res.status(501); // Not implemented
-  return res.send(null);
+    return res.ok(sub_results);
+  });
 };

lib/api/responses/ok.js

@@ -1,3 +1,7 @@
+/**
+ * Module dependencies
+ */
+let actionUtil = require("../blueprints/_util/actionUtil");
 var pluralize = require('pluralize');
 
 /**
@@ -19,7 +23,7 @@ module.exports = function sendOK(data, options) {
   var req = this.req;
   var res = this.res;
   var sails = req._sails;
-  var type = pluralize(req.options.model || req.options.controller);
+  var type = pluralize(actionUtil.parseAliasModelName(req) || req.options.model || req.options.controller);
 
   data = JsonApiService.serialize(type, data);
 

tests/dummy/api/models/Husband.js

@@ -12,5 +12,8 @@ module.exports = {
       model: 'wife',
       unique: true
     }
-  }
+  },
+
+  autoUpdatedAt : false,
+  autoCreatedAt : false
 };

tests/dummy/api/models/Wife.js

@@ -15,5 +15,8 @@ module.exports = {
       collection: 'husband',
       via: 'wife'
     }
-  }
+  },
+
+  autoUpdatedAt : false,
+  autoCreatedAt : false
 };

tests/dummy/config/blueprints.js

@@ -126,7 +126,7 @@ module.exports.blueprints = {
   *                                                                          *
   ***************************************************************************/
 
-  // pluralize: false,
+  pluralize: true,
 
   /***************************************************************************
   *                                                                          *

tests/dummy/test/integration/controllers/Relationships.test.js

@@ -217,4 +217,115 @@ describe("Has many through relationships", function() {
     })
   })
 
+  describe("GET /husbands/:parentid/wife, GET /wives/:parentid/husband", function() {
+    let husband_id = null;
+    let wife_id    = null;
+
+    before("Populate some data", function(done) {
+      Husband.create({})
+        .then((husband) => {
+          husband_id = husband.id;
+
+          Wife.create({
+            maidenName: 'Doe',
+            husband: husband
+          })
+          .then((wife) => {
+            wife_id = wife.id;
+
+            done();
+          });
+        })
+    });
+
+    it("Should return the husband's wife", function(done) {
+      request(sails.hooks.http.app)
+        .get(`/husbands/${husband_id}/wife`)
+        .expect(200)
+        .expect(validateJSONapi)
+        .expect({
+          data : {
+            type       : "wives",
+            id         : `${wife_id}`,
+            attributes : {
+              "maiden-name" : "Doe"
+            }
+          }
+        })
+        .end(done);
+    });
+
+    it("Should return the wife's husbands", function(done) {
+      request(sails.hooks.http.app)
+        .get(`/wives/${wife_id}/husband`)
+        .expect(200)
+        .expect(validateJSONapi)
+        .expect({
+          data : [{
+            type       : "husbands",
+            id         : `${husband_id}`,
+            attributes : {
+              wife : `${wife_id}`
+            }
+          }]
+        })
+        .end(done);
+    });
+  });
+
+  describe("GET /husbands/:parentid/wife/:id, GET /wives/:parentid/husband/:id", function() {
+    let husband_id = null;
+    let wife_id    = null;
+
+    before("Populate some data", function(done) {
+      Husband.create({})
+        .then((husband) => {
+          husband_id = husband.id;
+
+          Wife.create({
+            maidenName: 'Doe',
+            husband: husband
+          })
+          .then((wife) => {
+            wife_id = wife.id;
+
+            done();
+          });
+        });
+    });
+
+    it("Should return the husband's wife", function(done) {
+      request(sails.hooks.http.app)
+        .get(`/husbands/${husband_id}/wife/${wife_id}`)
+        .expect(200)
+        .expect(validateJSONapi)
+        .expect({
+          data : {
+            type       : "wives",
+            id         : `${wife_id}`,
+            attributes : {
+              "maiden-name" : "Doe"
+            }
+          }
+        })
+        .end(done);
+    });
+
+    it("Should return the wife's husbands", function(done) {
+      request(sails.hooks.http.app)
+        .get(`/wives/${wife_id}/husband/${husband_id}`)
+        .expect(200)
+        .expect(validateJSONapi)
+        .expect({
+          data : [{
+            type       : "husbands",
+            id         : `${husband_id}`,
+            attributes : {
+              wife : `${wife_id}`
+            }
+          }]
+        })
+        .end(done);
+    });
+  });
 });