Merge pull request #30 from dynamiccast/relationships

Add experimental support for relationships

Author: dynamiccast

README.md

@@ -86,7 +86,12 @@ This will expect sails Model attributes keys to follow the camelCase naming conv
   - [X] DELETE resource
   - [X] PATCH resource
   - [X] Return proper error if any
-  - [ ] Relationships
+  - Relationships
+    - [X] One to one
+    - [ ] One way associations
+    - [ ] Many to many
+    - [ ] One to many
+    - [X] Through relationships
   - [ ] Fields
   - [ ] Sorting
   - [ ] Pagination

lib/api/blueprints/_util/actionUtil.js

@@ -1,3 +1,5 @@
+const Promise = require('bluebird');
+
 /**
  * Utility methods used in built-in blueprint actions.
  *
@@ -81,5 +83,59 @@ module.exports = {
     }
 
     return pk;
+  },
+
+  /**
+   * Parse a JSON API request and set query to be populated with all defined relationships
+   *
+   * @param  {Object} req node request object
+   * @param  {Object} query query to be executed
+   * @return {Object} Returns input query with proper populate set
+   */
+  populateEach(req, query) {
+
+    if (req.body.data.relationships) {
+      for (var name in req.body.data.relationships) {
+        query = query.populate(name);
+      }
+    }
+
+    return query;
+  },
+
+  /**
+   * Parse a JSON API relationship object and update given sails record
+   *
+   * @param  {Object} recordToUpdate a single record for which relationships need to be populated
+   * @param  {String} relationshipName the name of the relationship
+   * @param  {Object} relationships a valid JSON API relationship object (http://jsonapi.org/format/#document-resource-object-relationships)
+   * @return {Promise[null]} a promise resolving to null if relationship was updated successfully
+   */
+  updateRelationship(recordToUpdate, relationshipName, relationships) {
+
+    // First let's remove all current relationships
+    recordToUpdate[relationshipName].forEach((toDelete) => {
+      recordToUpdate[relationshipName].remove(toDelete.id);
+    });
+
+    return new Promise((resolve, reject) => {
+      recordToUpdate.save((err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        relationships.data.forEach((relationship) => {
+          recordToUpdate[relationshipName].add(relationship.id);
+        });
+
+        recordToUpdate.save((err) => {
+          if (err) {
+            return reject(err);
+          }
+
+          return resolve(null);
+        });
+      });
+    })
   }
 };

lib/api/blueprints/update.js

@@ -1,3 +1,4 @@
+const Promise = require('bluebird');
 const actionUtil = require( './_util/actionUtil' );
 
 /**
@@ -43,6 +44,38 @@ module.exports = function updateOneRecord(req, res) {
       return res.notFound();
     }
 
-    return res.ok(updatedRecord);
+    let query = Model.findOne(pk);
+    query = actionUtil.populateEach(req, query);
+    return query.exec((err, updatedRecord) => {
+
+      if (err) {
+        return res.negotiate(err);
+      }
+
+      let relationshipsToUpdate = [];
+
+      // Let's update relationships if any
+      if (req.body.data.relationships) {
+        for (var name in req.body.data.relationships) {
+
+          let relationships = req.body.data.relationships[name];
+
+          relationshipsToUpdate.push(actionUtil.updateRelationship(updatedRecord, name, relationships));
+        }
+        Promise.all(relationshipsToUpdate)
+          .then(() => {
+            query = Model.findOne(pk);
+            query = actionUtil.populateEach(req, query);
+            return query.exec((err, updatedRecord) => {
+              if (err) {
+                return res.negotiate(err);
+              }
+              return res.ok(updatedRecord);
+            });
+          });
+      } else {
+        return res.ok(updatedRecord);
+      }
+    });
   });
 };

lib/api/services/JsonApiService.js

@@ -18,6 +18,33 @@ module.exports = {
   destroyOneRecord: destroyOneRecord,
   updateOneRecord: updateOneRecord,
 
+  init: function() {
+
+    for (let name in sails.models) {
+
+      let model = sails.models[name];
+      let associations = {};
+
+      sails.log.verbose("Registering model " + name + " as " + pluralize(model.identity));
+      model.associations.forEach((association) => {
+
+        let alias = association['alias'];
+        let type = association[association['type']];
+
+        sails.log.verbose(name + " has a relation with " + type + " (as " + alias + ")");
+        associations[alias] = {
+          type: pluralize(type)
+        };
+      });
+
+      Serializer.register(pluralize(model.identity), {
+        id: model.primaryKey || 'id',
+        convertCase: this.getAttributesSerializedCaseSetting(),
+        relationships: associations
+      });
+    };
+  },
+
   getAttributesSerializedCaseSetting: function() {
 
     var caseSetting = undefined;
@@ -101,20 +128,6 @@ module.exports = {
 
   serialize: function(modelName, data) {
 
-    let Model = this._getModelObjectFromModelName(modelName);
-    let id = 'id';
-
-    if (Model) {
-      id = Model.primaryKey;
-    } else {
-      sails.log.warn('Model ' + modelName + ' could not be found by sails-json-api-blueprints');
-    }
-
-    Serializer.register(modelName, {
-      convertCase: this.getAttributesSerializedCaseSetting(),
-      id: id
-    });
-
     var returnedValue = Serializer.serialize(modelName, data);
     delete returnedValue.jsonapi; // Let's ignore the version for now
 

lib/hook.js

@@ -167,6 +167,7 @@ module.exports = function(sails) {
 
     bindShadowRoutes: function() {
 
+      JsonApiService.init();
       var logWarns = function(warns) {
         sails.log.blank();
         _.each(warns, function (warn) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sails-json-api-blueprints",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "Blueprints to turn a Sails.js API into a JSON API",
   "main": "index.js",
   "scripts": {
@@ -25,7 +25,8 @@
   },
   "homepage": "https://github.com/dynamiccast/sails-json-api-blueprints#readme",
   "dependencies": {
-    "json-api-serializer": "1.1.0",
+    "bluebird": "^3.4.1",
+    "json-api-serializer": "1.1.2",
     "jsonapi-validator": "^2.0.0",
     "lodash": "^4.13.1",
     "pluralize": "^2.0.0",

tests/dummy/api/controllers/HouseController.js

@@ -0,0 +1,11 @@
+/**
+ * HouseController
+ *
+ * @description :: Server-side logic for managing houses
+ * @help        :: See http://sailsjs.org/#!/documentation/concepts/Controllers
+ */
+
+module.exports = {
+	
+};
+

tests/dummy/api/controllers/HusbandController.js

@@ -0,0 +1,16 @@
+/**
+ * HusbandController
+ *
+ * @description :: Server-side logic for managing husbands
+ * @help        :: See http://sailsjs.org/#!/documentation/concepts/Controllers
+ */
+
+module.exports = {
+
+  find: function(req, res) {
+
+    Husband.find()
+      .populate("wife")
+      .then(res.ok);
+  }
+};

tests/dummy/api/controllers/PetController.js

@@ -0,0 +1,16 @@
+/**
+ * PetController
+ *
+ * @description :: Server-side logic for managing Pets
+ * @help        :: See http://sailsjs.org/#!/documentation/concepts/Controllers
+ */
+
+module.exports = {
+
+  find: function(req, res) {
+
+    Pet.find()
+      .populate('homes')
+      .then(res.ok);
+  }
+};

tests/dummy/api/controllers/WifeController.js

@@ -0,0 +1,11 @@
+/**
+ * WifeController
+ *
+ * @description :: Server-side logic for managing wives
+ * @help        :: See http://sailsjs.org/#!/documentation/concepts/Controllers
+ */
+
+module.exports = {
+	
+};
+