Merge pull request #2 from CodingItWrong/create-options

Create options

Author: CodingItWrong

README.md

@@ -116,20 +116,6 @@ resource
   .then(response => console.log(response.data));
 ```
 
-#### Options
-
-All read methods take an optional `options` property, consisting of an object of additional options to pass. Each key/value pair in the object is translated into a query string parameter key/value pair:
-
-```js
-resource.all({
-  options: {
-    include: 'comments',
-  },
-});
-
-// requests to widgets?include=comments
-```
-
 ### Writing
 
 #### create
@@ -170,6 +156,20 @@ Deletes the passed-in record. Only the `id` property is used, so you can pass ei
 widgetResource.delete({ id: 42 });
 ```
 
+### Options
+
+All methods that return records (so, all but `delete()`) take an optional `options` property, consisting of an object of additional options to pass. Each key/value pair in the object is translated into a query string parameter key/value pair:
+
+```js
+resource.all({
+  options: {
+    include: 'comments',
+  },
+});
+
+// requests to widgets?include=comments
+```
+
 ## License
 
 Apache-2.0

src/Resource.js

@@ -74,11 +74,17 @@ class Resource {
     return this.api.get(url).then(extractData).catch(extractErrorResponse);
   }
 
-  create(partialRecord) {
-    const record = Object.assign({}, partialRecord, {type: this.name});
+  create({attributes, relationships, options}) {
+    const record = {type: this.name};
+    if (attributes) {
+      record.attributes = attributes;
+    }
+    if (relationships) {
+      record.relationships = relationships;
+    }
     const requestData = {data: record};
     return this.api
-      .post(`${this.name}`, requestData)
+      .post(`${this.name}?${getOptionsQuery(options)}`, requestData)
       .then(extractData)
       .catch(extractErrorResponse);
   }

test/Resource.spec.js

@@ -245,23 +245,40 @@ describe('Resource', () => {
   });
 
   describe('create', () => {
-    it('can create a record', () => {
-      const partialRecord = {attributes: {key: 'value'}};
+    const attributes = {key: 'value'};
+    const relationships = {key2: 'value2'};
 
+    it('can create a record', () => {
       const responseBody = {data: record};
       api.post.mockResolvedValue({data: responseBody});
 
-      const result = resource.create(partialRecord);
+      const result = resource.create({attributes, relationships});
 
-      expect(api.post).toHaveBeenCalledWith('widgets', {
+      expect(api.post).toHaveBeenCalledWith('widgets?', {
         data: {
-          ...partialRecord,
           type: 'widgets',
+          attributes,
+          relationships,
         },
       });
       return expect(result).resolves.toEqual(responseBody);
     });
 
+    it('passes options', () => {
+      const responseBody = {data: record};
+      api.post.mockResolvedValue({data: responseBody});
+
+      resource.create({
+        attributes,
+        relationships,
+        options: optionsWithInclude,
+      });
+
+      expect(api.post).toHaveBeenCalledWith('widgets?include=comments', {
+        data: {type: 'widgets', attributes, relationships},
+      });
+    });
+
     it('rejects with the response upon error', () => {
       const errorResponse = {dummy: 'data'};
       api.post.mockRejectedValue({response: errorResponse});