Merge pull request #76 from digitalsadhu/update/dynamic_primary_keys

Update/dynamic primary keys

Author: digitalsadhu

lib/serialize.js

@@ -24,7 +24,8 @@ module.exports = function (app, defaults) {
       modelNamePlural,
       relatedModelPlural,
       relations,
-      res;
+      res,
+      model;
 
     var matches = regexs.filter(function (regex) {
       return ctx.methodString.match(regex);
@@ -48,7 +49,8 @@ module.exports = function (app, defaults) {
     }
 
     data = utils.clone(ctx.result);
-    modelNamePlural = utils.pluralForModel(utils.getModelFromContext(ctx, app));
+    model = utils.getModelFromContext(ctx, app);
+    modelNamePlural = utils.pluralForModel(model);
     type = modelNamePlural;
 
     /**
@@ -77,7 +79,10 @@ module.exports = function (app, defaults) {
       }
     }
 
+    var primaryKeyField = utils.primaryKeyForModel(model);
+
     options = {
+      primaryKeyField: primaryKeyField,
       host: utils.hostFromContext(ctx),
       topLevelLinks: {
         self: utils.urlFromContext(ctx)

lib/serializer.js

@@ -51,7 +51,7 @@ function parseResource (type, data, relations, options) {
   }
 
   _.each(data, function (value, property) {
-    if (property === 'id') {
+    if (property === options.primaryKeyField) {
       resource.id = _(value).toString();
     } else {
       attributes[property] = value;

lib/utils.js

@@ -12,9 +12,14 @@ module.exports = {
   hostFromContext: hostFromContext,
   modelNameFromContext: modelNameFromContext,
   pluralForModel: pluralForModel,
-  urlFromContext: urlFromContext
+  urlFromContext: urlFromContext,
+  primaryKeyForModel: primaryKeyForModel
 };
 
+function primaryKeyForModel (model) {
+  return model.getIdName();
+}
+
 /**
  * Returns the plural for a model.
  * @public

test/find.test.js

@@ -255,3 +255,31 @@ describe('loopback json api component find methods', function () {
     });
   });
 });
+
+describe('non standard primary key naming', function () {
+  beforeEach(function (done) {
+    app = loopback();
+    app.set('legacyExplorer', false);
+    var ds = loopback.createDataSource('memory');
+    Post = ds.createModel('post', {
+      customId: {type: Number, id: true, generated: true},
+      title: String
+    });
+    app.model(Post);
+    app.use(loopback.rest());
+    JSONAPIComponent(app);
+    Post.create({title: 'my post'}, done);
+  });
+
+  it('should dynamically handle primary key', function (done) {
+    request(app)
+      .get('/posts')
+      .expect(200)
+      .end(function (err, res) {
+        expect(err).to.equal(null);
+        expect(res.body.data.length).to.equal(1);
+        expect(res.body.data[0].id).to.equal('1');
+        done();
+      });
+  });
+});

test/update.test.js

@@ -262,3 +262,34 @@ describe('loopback json api component update method', function () {
     });
   });
 });
+
+describe('non standard primary key naming', function () {
+  beforeEach(function (done) {
+    app = loopback();
+    app.set('legacyExplorer', false);
+    var ds = loopback.createDataSource('memory');
+    Post = ds.createModel('post', {
+      customId: {type: Number, id: true, generated: true},
+      title: String
+    });
+    app.model(Post);
+    app.use(loopback.rest());
+    JSONAPIComponent(app);
+    Post.create({title: 'my post'}, done);
+  });
+
+  it('should dynamically handle primary key', function (done) {
+    request(app).patch('/posts/1').send({
+      data: {id: 1, type: 'posts',
+        attributes: {title: 'my post 2'}
+      }})
+      .expect(200)
+      .end(function (err, res) {
+        expect(err).to.equal(null);
+        expect(res.body.data.id).to.equal('1');
+        expect(res.body.data.attributes.title).to.equal('my post 2');
+        expect(res.body.data.links.self).to.match(/http:\/\/127\.0\.0\.1.*\/posts\/1/);
+        done();
+      });
+  });
+});