Merge pull request #115 from digitalsadhu/scope_include

Scope include

Author: digitalsadhu

lib/serialize.js

@@ -92,6 +92,25 @@ module.exports = function (app, defaults) {
     if (ctx.req.isSideloadingRelationships) {
       requestedIncludes = ctx.req.remotingContext.args.filter.include;
     }
+
+    if (model.definition.settings.scope) {
+      // bring requestedIncludes in array form
+      if (typeof requestedIncludes === 'undefined') {
+        requestedIncludes = [];
+      } else if (typeof requestedIncludes === 'string') {
+        requestedIncludes = [requestedIncludes];
+      }
+
+      // add include from model
+      var include = model.definition.settings.scope.include;
+
+      if (typeof include === 'string') {
+        requestedIncludes.push(include);
+      } else if (_.isArray(include)) {
+        requestedIncludes = requestedIncludes.concat(include);
+      }
+
+    }
     options = {
       app: app,
       model: model,

test/scopeInclude.test.js

@@ -0,0 +1,117 @@
+var request = require('supertest');
+var loopback = require('loopback');
+var expect = require('chai').expect;
+var JSONAPIComponent = require('../');
+var ds, app, Post, Author, Comment, Category;
+
+describe('include option', function () {
+  beforeEach(function () {
+    app = loopback();
+    app.set('legacyExplorer', false);
+    ds = loopback.createDataSource('memory');
+    Post = ds.createModel('post', {
+      id: {type: Number, id: true},
+      title: String,
+      content: String
+    }, {
+      scope: {
+        'include': 'comments'
+      }
+    });
+    app.model(Post);
+
+    Comment = ds.createModel('comment', {
+      id: {type: Number, id: true},
+      postId: Number,
+      authorId: Number,
+      title: String,
+      comment: String
+    });
+
+    app.model(Comment);
+
+    Author = ds.createModel('author', {
+      id: {type: Number, id: true},
+      name: String
+    });
+
+    app.model(Author);
+
+    Category = ds.createModel('category', {
+      id: {type: Number, id: true},
+      name: String
+    });
+
+    app.model(Author);
+
+    Post.hasMany(Comment, {as: 'comments', foreignKey: 'postId'});
+    Post.belongsTo(Author, {as: 'author', foreignKey: 'authorId'});
+    Post.belongsTo(Category, {as: 'category', foreignKey: 'categoryId'});
+    Comment.settings.plural = 'comments';
+
+    app.use(loopback.rest());
+    JSONAPIComponent(app, {restApiRoot: '/'});
+  });
+
+  describe('include defined at model level', function () {
+    beforeEach(function (done) {
+      Post.create({
+        title: 'my post',
+        content: 'my post content'
+      }, function (err, post) {
+        expect(err).to.equal(null);
+        post.comments.create({
+          title: 'My comment',
+          comment: 'My comment text'
+        }, function () {
+          post.comments.create({
+            title: 'My second comment',
+            comment: 'My second comment text'
+          }, function () {
+            post.author.create({
+              name: 'Joe'
+            }, function () {
+              post.category.create({
+                name: 'Programming'
+              }, done);
+            });
+          });
+        });
+      });
+    });
+
+    describe('response', function () {
+
+      it('should have key `included`', function (done) {
+        request(app).get('/posts/1')
+          .end(function (err, res) {
+            expect(err).to.equal(null);
+            expect(res.body.included).to.be.an('array');
+            done();
+          });
+      });
+
+      it('attributes should not have relationship key', function (done) {
+        request(app).get('/posts/1')
+          .end(function (err, res) {
+            expect(err).to.equal(null);
+            expect(res.body.data.attributes).to.not.include.key('comments');
+            done();
+          });
+      });
+
+      it('with include paramter should have both models', function (done) {
+        request(app).get('/posts/1?filter[include]=author')
+          .end(function (err, res) {
+            expect(err).to.equal(null);
+            expect(res.body.included.length).equal(3);
+            expect(res.body.included[0].type).equal('authors');
+            expect(res.body.included[1].type).equal('comments');
+            done();
+          });
+      });
+    });
+
+  });
+
+});