Add service methods to create/delete relationships (#80)

Author: pixelhandler

addon/adapters/application.js

@@ -170,28 +170,6 @@ export default Ember.Object.extend(FetchMixin, Evented, {
     });
   },
 
-  /**
-    Patch a relationship, either add or remove, sends a PATCH request
-
-    Adds with payload: `{ "data": { "type": "comments", "id": "12" } }`
-    Removes with payload: `{ "data": null }` for to-one or `{ "data": [] }` for to-many
-
-    @method patchRelationship
-    @param {Resource} the resource instance, has URLs via it's relationships property
-    @param {String} resource name (plural) to find the url from the resource instance
-    @return {Promise}
-  */
-  patchRelationship(resource, relationship) {
-    let url = resource.get(['relationships', relationship, 'links', 'self'].join('.'));
-    url = url || [this.get('url'), resource.get('id'), 'relationships', relationship].join('/');
-    let data = resource.get(['relationships', relationship, 'data'].join('.'));
-    data = { data: data };
-    return this.fetch(url, {
-      method: 'PATCH',
-      body: JSON.stringify(data)
-    });
-  },
-
   /**
     Delete an existing resource, sends a DELETE request
 
@@ -211,6 +189,94 @@ export default Ember.Object.extend(FetchMixin, Evented, {
     return this.fetch(url, { method: 'DELETE' });
   },
 
+  /**
+    Creates a relationship, sends a POST request
+
+    Adds using a payload with the resource object:
+
+    - to-one: `{ "data": { "type": "authors", "id": "1" } }`
+    - to-many: `{ "data": [{ "type": "comments", "id": "12" }] }`
+
+    @method createRelationship
+    @param {Resource} resource instance, has URLs via it's relationships property
+    @param {String} relationship name (plural) to find the url from the resource instance
+    @param {String} id of the related resource
+    @return {Promise}
+  */
+  createRelationship(resource, relationship, id) {
+    return this.fetch(this._urlForRelationship(resource, relationship), {
+      method: 'POST',
+      body: JSON.stringify(this._payloadForRelationship(resource, relationship, id))
+    });
+  },
+
+  /**
+    Patch a relationship, either adds or removes everyting, sends a PATCH request
+
+    Adds with payload: `{ "data": { "type": "comments", "id": "12" } }`
+    Removes with payload: `{ "data": null }` for to-one or `{ "data": [] }` for to-many
+
+    @method patchRelationship
+    @param {Resource} resource instance, has URLs via it's relationships property
+    @param {String} relationship name (plural) to find the url from the resource instance
+    @return {Promise}
+  */
+  patchRelationship(resource, relationship) {
+    return this.fetch(this._urlForRelationship(resource, relationship), {
+      method: 'PATCH',
+      body: JSON.stringify({
+        data: resource.get(['relationships', relationship, 'data'].join('.'))
+      })
+    });
+  },
+
+  /**
+    Deletes a relationship, sends a DELETE request
+
+    Removes using a payload with the resource object:
+
+    - to-one: `{ "data": { "type": "authors", "id": "1" } }`
+    - to-many: `{ "data": [{ "type": "comments", "id": "12" }] }`
+
+    @method deleteRelationship
+    @param {Resource} resource instance, has URLs via it's relationships property
+    @param {String} relationship name (plural) to find the url from the resource instance
+    @param {String} id of the related resource
+    @return {Promise}
+  */
+  deleteRelationship(resource, relationship, id) {
+    return this.fetch(this._urlForRelationship(resource, relationship), {
+      method: 'DELETE',
+      body: JSON.stringify(this._payloadForRelationship(resource, relationship, id))
+    });
+  },
+
+  /**
+    @method _urlForRelationship
+    @private
+    @param {Resource} [resource] instance, has URLs via it's relationships property
+    @param {String} [relationship] name (plural) to find the url from the resource instance
+    @return {String} url
+  */
+  _urlForRelationship(resource, relationship) {
+    let url = resource.get(['relationships', relationship, 'links', 'self'].join('.'));
+    return url || [this.get('url'), resource.get('id'), 'relationships', relationship].join('/');
+  },
+
+  /**
+    @method _payloadForRelationship
+    @private
+    @param {Resource} [resource] instance, has URLs via it's relationships property
+    @param {String} [relationship] name (plural) to find the url from the resource instance
+    @param {String} [id] the id for the related resource
+    @return {Object} payload
+  */
+  _payloadForRelationship(resource, relationship, id) {
+    let data = resource.get(['relationships', relationship, 'data'].join('.'));
+    let resourceObject = { type: pluralize(relationship), id: id };
+    return { data: (Array.isArray(data)) ? [resourceObject] : resourceObject };
+  },
+
   /**
     Fetches data using Fetch API or XMLHttpRequest
 

addon/services/store.js

@@ -24,7 +24,7 @@ export default Ember.Service.extend({
     @return {Promise}
   */
   find(type, options) {
-    const service = this._service(type, options);
+    let service = this._service(type, options);
     return service.find(options);
   },
 
@@ -36,7 +36,7 @@ export default Ember.Service.extend({
     @return {Ember.Array}
   */
   all(type) {
-    const service = this._service(type);
+    let service = this._service(type);
     return (service.cache && service.cache.data) ? service.cache.data : Ember.A([]);
   },
 
@@ -48,7 +48,7 @@ export default Ember.Service.extend({
     @return {Promise}
   */
   createResource(type, resource) {
-    const service = this._service(type);
+    let service = this._service(type);
     return service.createResource(resource);
   },
 
@@ -61,38 +61,78 @@ export default Ember.Service.extend({
     @return {Promise}
   */
   updateResource(type, resource) {
-    const service = this._service(type);
+    let service = this._service(type);
     return service.updateResource(resource);
   },
 
   /**
-    Patch a relationship, either add or remove, sends a PATCH request
+    Delete an existing resource, sends a DELETE request
+
+    @method deleteResource
+    @param {String} type - the entity or resource name will be pluralized
+    @param {String|Resource} the name (plural) or resource instance w/ self link
+    @return {Promise}
+  */
+  deleteResource(type, resource) {
+    let service = this._service(type);
+    return service.deleteResource(resource);
+  },
+
+  /**
+    Creates a relationship, sends a POST request
+
+    Adds using a payload with the resource object:
+
+    - to-one: `{ "data": { "type": "authors", "id": "1" } }`
+    - to-many: `{ "data": [{ "type": "comments", "id": "12" }] }`
+
+    @method createRelationship
+    @param {String} type the entity or resource name will be pluralized
+    @param {Resource} resource instance, has URLs via it's relationships property
+    @param {String} relationship name (plural) to find the url from the resource instance
+    @param {String} id of the related resource
+    @return {Promise}
+  */
+  createRelationship(type, resource, relationship, id) {
+    let service = this._service(type);
+    return service.createRelationship(resource, relationship, id);
+  },
+
+  /**
+    Patch a relationship, either adds or removes everyting, sends a PATCH request
 
     Adds with payload: `{ "data": { "type": "comments", "id": "12" } }`
-    Removes with payload: `{ "data": null }`
+    Removes with payload: `{ "data": null }` for to-one or `{ "data": [] }` for to-many
 
     @method patchRelationship
-    @param {String} type - the entity or resource name will be pluralized
-    @param {Resource} resource - model instance, has URLs via it's relationships property
-    @param {String} relationship - resource name (plural) to find the url from the resource instance
+    @param {String} type the entity or resource name will be pluralized
+    @param {Resource} resource instance, has URLs via it's relationships property
+    @param {String} relationship name (plural) to find the url from the resource instance
     @return {Promise}
   */
   patchRelationship(type, resource, relationship) {
-    const service = this._service(type);
+    let service = this._service(type);
     return service.patchRelationship(resource, relationship);
   },
 
   /**
-    Delete an existing resource, sends a DELETE request
+    Deletes a relationship, sends a DELETE request
 
-    @method deleteResource
-    @param {String} type - the entity or resource name will be pluralized
-    @param {String|Resource} the name (plural) or resource instance w/ self link
+    Removes using a payload with the resource object:
+
+    - to-one: `{ "data": { "type": "authors", "id": "1" } }`
+    - to-many: `{ "data": [{ "type": "comments", "id": "12" }] }`
+
+    @method deleteRelationship
+    @param {String} type the entity or resource name will be pluralized
+    @param {Resource} resource instance, has URLs via it's relationships property
+    @param {String} relationship name (plural) to find the url from the resource instance
+    @param {String} id of the related resource
     @return {Promise}
   */
-  deleteResource(type, resource) {
-    const service = this._service(type);
-    return service.deleteResource(resource);
+  deleteRelationship(type, resource, relationship, id) {
+    let service = this._service(type);
+    return service.deleteRelationship(resource, relationship, id);
   },
 
   /**

tests/unit/adapters/application-test.js

@@ -211,6 +211,66 @@ test('when serializer returns null (nothing changed) #updateResource return prom
   });
 });
 
+test('#createRelationship (to-many)', function(assert) {
+  const done = assert.async();
+  mockServices.call(this);
+  let adapter = this.subject({type: 'posts', url: '/posts'});
+  sandbox.stub(adapter, 'fetch', function () { return Ember.RSVP.Promise.resolve(null); });
+  let resource = this.container.lookup('model:post').create(postMock.data);
+  let promise = adapter.createRelationship(resource, 'comments', '1');
+  assert.ok(typeof promise.then === 'function', 'returns a thenable');
+  promise.then(function() {
+    let relationURL = 'http://api.pixelhandler.com/api/v1/posts/1/relationships/comments';
+    let jsonBody = '{"data":[{"type":"comments","id":"1"}]}';
+    let msg = '#fetch called with url and options with data';
+    assert.ok(adapter.fetch.calledWith(relationURL, { method: 'POST', body: jsonBody }), msg);
+    done();
+  });
+});
+
+test('#createRelationship (to-one)', function(assert) {
+  const adapter = this.subject({type: 'posts', url: '/posts'});
+  mockServices.call(this);
+  sandbox.stub(adapter, 'fetch', function () { return Ember.RSVP.Promise.resolve(null); });
+  let resource = this.container.lookup('model:post').create(postMock.data);
+  let promise = adapter.createRelationship(resource, 'author', '1');
+  assert.ok(typeof promise.then === 'function', 'returns a thenable');
+  let relationURL = 'http://api.pixelhandler.com/api/v1/posts/1/relationships/author';
+  let jsonBody = '{"data":{"type":"authors","id":"1"}}';
+  let msg = '#fetch called with url and options with data';
+  assert.ok(adapter.fetch.calledWith(relationURL, { method: 'POST', body: jsonBody }), msg);
+});
+
+test('#deleteRelationship (to-many)', function(assert) {
+  const done = assert.async();
+  mockServices.call(this);
+  let adapter = this.subject({type: 'posts', url: '/posts'});
+  sandbox.stub(adapter, 'fetch', function () { return Ember.RSVP.Promise.resolve(null); });
+  let resource = this.container.lookup('model:post').create(postMock.data);
+  let promise = adapter.deleteRelationship(resource, 'comments', '1');
+  assert.ok(typeof promise.then === 'function', 'returns a thenable');
+  promise.then(function() {
+    let relationURL = 'http://api.pixelhandler.com/api/v1/posts/1/relationships/comments';
+    let jsonBody = '{"data":[{"type":"comments","id":"1"}]}';
+    let msg = '#fetch called with url and options with data';
+    assert.ok(adapter.fetch.calledWith(relationURL, { method: 'DELETE', body: jsonBody }), msg);
+    done();
+  });
+});
+
+test('#deleteRelationship (to-one)', function(assert) {
+  const adapter = this.subject({type: 'posts', url: '/posts'});
+  mockServices.call(this);
+  sandbox.stub(adapter, 'fetch', function () { return Ember.RSVP.Promise.resolve(null); });
+  let resource = this.container.lookup('model:post').create(postMock.data);
+  let promise = adapter.deleteRelationship(resource, 'author', '1');
+  assert.ok(typeof promise.then === 'function', 'returns a thenable');
+  let relationURL = 'http://api.pixelhandler.com/api/v1/posts/1/relationships/author';
+  let jsonBody = '{"data":{"type":"authors","id":"1"}}';
+  let msg = '#fetch called with url and options with data';
+  assert.ok(adapter.fetch.calledWith(relationURL, { method: 'DELETE', body: jsonBody }), msg);
+});
+
 test('#patchRelationship (to-many)', function(assert) {
   const done = assert.async();
   mockServices.call(this);

tests/unit/services/store-test.js

@@ -2,7 +2,9 @@ import { moduleFor, test } from 'ember-qunit';
 import Ember from 'ember';
 import { pluralize } from 'ember-inflector';
 
-let methods = Ember.String.w('find createResource updateResource patchRelationship deleteResource');
+let methods = 'find createResource updateResource deleteResource';
+methods += ' createRelationship patchRelationship deleteRelationship';
+methods = Ember.String.w(methods);
 
 let mockServices, entities = ['post', 'author', 'comment'];