Fetch embedded resources

Fetch embedded resources from a JSON document returned from Drupal.

lib/entity.js

@@ -36,7 +36,7 @@ module.exports = class Entity extends Request {
    *  The ID of name of the entity being requested.
    * @param {object} body
    *  An object containing the request body to be sent.
-   * @param {string} [format=json]
+   * @param {string} [format=application/json]
    *  The format for the requested content.
    * @returns {Promise} A Promise that when fulfilled returns a response containing the content entity in JSON (as of 8.2).
    */
@@ -71,7 +71,7 @@ module.exports = class Entity extends Request {
 
   /**
   * Get field data about the expected bundle
-  * @param {string} [format=application/json]
+  * @param {string} [format=json]
   *  The format of the content being posted.
   * @return {promise}
   *   A promise resolved when the request for field data is complete,

lib/waterwheel.js

@@ -126,4 +126,30 @@ module.exports = class Waterwheel extends Request {
       });
   }
 
+  /**
+   * Fetch embedded resources from HAL+JSON documents
+   * @param  {object} entityJSON
+   *   An object, usually returned from Drupal, containing _embedded information
+   * @return {Promise}
+   *   If no _embedded key is found, a rejection is returned, else a resolved
+   *   promise with all the embedded resources requests completed.
+   */
+  fetchEmbedded(entityJSON) {
+    if (!entityJSON || !entityJSON.hasOwnProperty('_embedded')) {
+      return Promise.reject('This is probably not HAL+JSON');
+    }
+
+    let links = [];
+
+    Object.keys(entityJSON._embedded).forEach(key => {
+      entityJSON._embedded[key].forEach(ref => {
+        links.push(ref._links.self.href.split(this.base)[1]);
+      });
+    });
+
+    links = Array.from(new Set(links));
+
+    return Promise.all([Promise.resolve(entityJSON)].concat(links.map(link => this.issueRequest(methods.get, link))));
+  }
+
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "waterwheel",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "A generic JavaScript helper library to query and manipulate Drupal 8 via core REST",
   "author": "Preston So <preston.so@acquia.com>",
   "contributors": [

test/base.js

@@ -158,3 +158,33 @@ test.cb('Populate Resources', t => {
       t.end();
     });
 });
+
+test('Fetch Embedded - Missing _embedded key', t => {
+  const waterwheel = new t.context.Waterwheel(t.context.base, t.context.credentials);
+  return waterwheel.fetchEmbedded({})
+    .catch(err =>{
+      t.is(err, 'This is probably not HAL+JSON');
+    });
+});
+
+test('Fetch Embedded - Missing response', t => {
+  const waterwheel = new t.context.Waterwheel(t.context.base, t.context.credentials);
+  return waterwheel.fetchEmbedded()
+    .catch(err =>{
+      t.is(err, 'This is probably not HAL+JSON');
+    });
+});
+
+test('Fetch Embedded', t => {
+  requireSubvert.subvert('axios', () => (
+    Promise.resolve({data: {halExample: 'Some HAL+JSON'}})
+  ));
+
+  const waterwheel = new t.context.Waterwheel(t.context.base, t.context.credentials);
+  const halJSON = require('./sample/hal.example.json');
+  return waterwheel.fetchEmbedded(halJSON)
+    .then(res =>{
+      t.is(res.length, 4);
+      t.deepEqual(res[1], {halExample: 'Some HAL+JSON'});
+    });
+});

test/sample/hal.example.json

@@ -0,0 +1,141 @@
+{
+  "_links": {
+    "self": {
+      "href": "http://foo.dev/page/bruce-wayne?_format=hal_json"
+    },
+    "type": {
+      "href": "http://foo.dev/rest/type/node/page"
+    },
+    "http://foo.dev/rest/relation/node/page/uid": [{
+      "href": "http://foo.dev/user/1?_format=hal_json",
+      "lang": "en"
+    }],
+    "http://foo.dev/rest/relation/node/page/revision_uid": [{
+      "href": "http://foo.dev/user/1?_format=hal_json"
+    }],
+    "http://foo.dev/rest/relation/node/page/field_actor": [{
+      "href": "http://foo.dev/node/6?_format=hal_json"
+    }, {
+      "href": "http://foo.dev/node/8?_format=hal_json"
+    }]
+  },
+  "nid": [{
+    "value": "7"
+  }],
+  "uuid": [{
+    "value": "284365c0-fa63-43ac-ae68-d60600873c34"
+  }],
+  "vid": [{
+    "value": "7"
+  }],
+  "langcode": [{
+    "value": "en",
+    "lang": "en"
+  }],
+  "type": [{
+    "target_id": "page"
+  }],
+  "title": [{
+    "value": "Bruce  Wayne",
+    "lang": "en"
+  }],
+  "_embedded": {
+    "http://foo.dev/rest/relation/node/page/uid": [{
+      "_links": {
+        "self": {
+          "href": "http://foo.dev/user/1?_format=hal_json"
+        },
+        "type": {
+          "href": "http://foo.dev/rest/type/user/user"
+        }
+      },
+      "uuid": [{
+        "value": "b578592a-a751-4993-9060-53f488597e59"
+      }],
+      "lang": "en"
+    }],
+    "http://foo.dev/rest/relation/node/page/revision_uid": [{
+      "_links": {
+        "self": {
+          "href": "http://foo.dev/user/1?_format=hal_json"
+        },
+        "type": {
+          "href": "http://foo.dev/rest/type/user/user"
+        }
+      },
+      "uuid": [{
+        "value": "b578592a-a751-4993-9060-53f488597e59"
+      }]
+    }],
+    "http://foo.dev/rest/relation/node/page/field_actor": [{
+      "_links": {
+        "self": {
+          "href": "http://foo.dev/node/6?_format=hal_json"
+        },
+        "type": {
+          "href": "http://foo.dev/rest/type/node/actor"
+        }
+      },
+      "uuid": [{
+        "value": "b5c619cd-1dfe-4c9d-afea-760a8eaf27c9"
+      }]
+    }, {
+      "_links": {
+        "self": {
+          "href": "http://foo.dev/node/8?_format=hal_json"
+        },
+        "type": {
+          "href": "http://foo.dev/rest/type/node/actor"
+        }
+      },
+      "uuid": [{
+        "value": "ac1ad040-c05c-45ac-82d7-5b3eda40e451"
+      }]
+    }]
+  },
+  "status": [{
+    "value": "1",
+    "lang": "en"
+  }],
+  "created": [{
+    "value": "1470156620",
+    "lang": "en"
+  }],
+  "changed": [{
+    "value": "1470170146",
+    "lang": "en"
+  }],
+  "promote": [{
+    "value": "0"
+  }],
+  "sticky": [{
+    "value": "0",
+    "lang": "en"
+  }],
+  "revision_timestamp": [{
+    "value": "1470156635"
+  }],
+  "revision_translation_affected": [{
+    "value": "1",
+    "lang": "en"
+  }],
+  "default_langcode": [{
+    "value": "1",
+    "lang": "en"
+  }],
+  "body": [{
+    "value": "some body",
+    "format": "basic_html",
+    "summary": "",
+    "lang": "en"
+  }],
+  "comment": [{
+    "status": "2",
+    "cid": "0",
+    "last_comment_timestamp": "1470156635",
+    "last_comment_name": null,
+    "last_comment_uid": "1",
+    "comment_count": "0",
+    "lang": "en"
+  }]
+}