feat: add links to resource objects and relationships

Author: eliias

package.json

@@ -18,6 +18,7 @@
   "dependencies": {
     "bluebird": "^3.1.1",
     "lodash": "^3.10.1",
+    "pluralize": "^3.0.0",
     "sequelize": "^3.17.1"
   },
   "devDependencies": {

src/jsonapi.js

@@ -1,11 +1,85 @@
+import _ from 'lodash'
+import pluralize from 'pluralize'
+
+function documentLinks(req, document) {
+  const {id, type} = document
+  return {
+    self: req.protocol + '://' + req.get('host') + '/' + pluralize(type) + '/' + id
+  }
+}
+
+function relationshipLinks(req, document, relationship) {
+  const {id, type} = document
+  const baseUrl = req.protocol + '://' + req.get('host') + '/' + pluralize(type) + '/' + id
+  return {
+    self: baseUrl + '/relationships/' + relationship,
+    related: baseUrl + '/' + relationship
+  }
+}
+
+function links(req, res) {
+  const body = res.body
+
+  // resource objects
+  if (_.isArray(body.data) && body.data.length > 0) {
+    body.data.forEach(document => {
+      document.links = documentLinks(req, document)
+      if (document.relationships) {
+        _.forEach(document.relationships, (val, key) => {
+          document.relationships[key].links = relationshipLinks(req, document, key)
+        })
+      }
+    })
+  } else if (_.isObject(body.data)) {
+    body.data.links = documentLinks(req, body.data)
+    if (body.data.relationships) {
+      _.forEach(body.data.relationships, (val, key) => {
+        body.data.relationships[key].links = relationshipLinks(req, body.data, key)
+      })
+    }
+  }
+
+  // includes
+  if (_.isArray(body.included) && body.included.length > 0) {
+    body.included.forEach(document => {
+      document.links = documentLinks(req, document)
+    })
+  }
+
+  // body
+  if (_.isArray(body.data) && body.data.length > 0) {
+    const type = body.data[0].type
+    const baseUrl = req.protocol + '://' + req.get('host') + '/' + pluralize(type)
+    return {
+      self: baseUrl
+    }
+  } else if (_.isObject(res.body.data)) {
+    const {id, type} = res.body.data
+    const baseUrl = req.protocol + '://' + req.get('host') + '/' + pluralize(type) + '/' + id
+    return {
+      self: baseUrl
+    }
+  }
+}
+
 export default function() {
   return function(req, res) {
-    if (!res.body) {
-      return res
-        .status(204)
-        .end()
+    if (_.isArray(res.body.data)) {
+      res.body.data.forEach(document => documentLinks(req, document))
+    } else if (_.isObject(res.body.data)) {
+      documentLinks(req, res.body.data)
     }
 
+    if (_.isArray(res.body.included)) {
+      res.body.included.forEach(document => documentLinks(req, document))
+    }
+
+    if (res.meta) {
+      res.body.meta = res.meta
+    }
+
+    res.body.links = links(req, res)
+
     res.json(res.body)
   }
 }

test/test.js

@@ -61,24 +61,45 @@ describe('netiam', () => {
             ]
           })
         })
-        .then(users => {
-          /*console.log(
-            util.inspect(
-              users.map(user => user.toJSON()),
-              {depth: null}
-            )
-          )*/
-        })
         .then(() => done())
         .catch(done)
     })
 
     it('should fetch user', done => {
       request(app)
-        .get(`/users/${user.id}`)
+        .get(`/users/${user.id}?include=projects`)
         .set('Accept', 'application/json')
         .expect(200)
         .expect('Content-Type', /json/)
+        .expect(res => {
+          const json = res.body
+
+          json.should.be.an.Object()
+          json.should.have.properties(['data', 'included', 'links'])
+          json.data.should.be.Object()
+          json.data.should.have.properties([
+            'id',
+            'type',
+            'attributes',
+            'relationships',
+            'links'
+          ])
+          json.data.relationships.should.be.Object()
+          json.data.relationships.should.have.properties([
+            'projects'
+          ])
+
+          json.included.should.be.Array()
+          json.included.should.have.length(1)
+          json.included[0].should.have.properties([
+            'id',
+            'type',
+            'attributes',
+            'links'
+          ])
+          json.included[0].type.should.eql('project')
+          json.included[0].links.should.have.properties(['self'])
+        })
         .end(err => {
           if (err) {
             return done(err)
@@ -89,10 +110,40 @@ describe('netiam', () => {
 
     it('should fetch users', done => {
       request(app)
-        .get('/users')
+        .get('/users?include=projects')
         .set('Accept', 'application/json')
         .expect(200)
         .expect('Content-Type', /json/)
+        .expect(res => {
+          const json = res.body
+
+          json.should.be.an.Object()
+          json.should.have.properties(['data', 'included', 'links'])
+          json.data.should.be.Array()
+          json.data.should.have.length(10)
+          json.data[0].should.have.properties([
+            'id',
+            'type',
+            'attributes',
+            'relationships',
+            'links'
+          ])
+          json.data[0].relationships.should.be.Object()
+          json.data[0].relationships.should.have.properties([
+            'projects'
+          ])
+
+          json.included.should.be.Array()
+          json.included.should.have.length(1)
+          json.included[0].should.have.properties([
+            'id',
+            'type',
+            'attributes',
+            'links'
+          ])
+          json.included[0].type.should.eql('project')
+          json.included[0].links.should.have.properties(['self'])
+        })
         .end(err => {
           if (err) {
             return done(err)