implement scope include

Author: BenjaminHorn

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

@@ -2,10 +2,7 @@ var request = require('supertest');
 var loopback = require('loopback');
 var expect = require('chai').expect;
 var JSONAPIComponent = require('../');
-var ds;
-var app;
-var Post;
-var Comment;
+var ds, app, Post, Author, Comment, Category;
 
 describe('include option', function () {
   beforeEach(function () {
@@ -26,11 +23,30 @@ describe('include option', function () {
     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());
@@ -51,12 +67,20 @@ describe('include option', function () {
           post.comments.create({
             title: 'My second comment',
             comment: 'My second comment text'
-          }, done);
+          }, function () {
+            post.author.create({
+              name: 'Joe'
+            }, function () {
+              post.category.create({
+                name: 'Programming'
+              }, done);
+            });
+          });
         });
       });
     });
 
-    describe('hasMany response', function () {
+    describe('response', function () {
 
       it('should have key `included`', function (done) {
         request(app).get('/posts/1')
@@ -76,7 +100,18 @@ describe('include option', function () {
           });
       });
 
+      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();
+          });
+      });
     });
+
   });
 
 });