Merge pull request #14 from gramps-graphql/feat/head-support

feat(GraphQLConnector): add support for HEAD requests

src/GraphQLConnector.js

@@ -271,6 +271,18 @@ export default class GraphQLConnector {
     });
   }
 
+  /**
+   * Configures and sends a HEAD request to a REST API endpoint.
+   * @param  {string} endpoint the API endpoint to send the request to
+   * @param  {object} options  optional configuration for request-promise
+   * @return {Promise}         Promise that resolves with the request result
+   */
+  head(endpoint, options = {}) {
+    return this.mutation(endpoint, 'HEAD', {
+      ...options,
+    });
+  }
+
   createLoader() {
     // We can enable batched queries later on, which may be more performant.
     this.loader = new DataLoader(this.load, {

test/GraphQLConnector.test.js

@@ -605,4 +605,34 @@ describe('GraphQLConnector', () => {
       );
     });
   });
+
+  describe('head()', () => {
+    it('sends a properly configured HEAD request', () => {
+      const tc = new TestConnector();
+
+      tc.apiBaseUri = 'https://example.com';
+      tc.head('/test/head');
+
+      expect(tc.request).toHaveBeenCalledWith({
+        uri: 'https://example.com/test/head',
+        json: true,
+        resolveWithFullResponse: true,
+        headers: {},
+        method: 'HEAD',
+      });
+    });
+
+    it('adds custom options as expected', () => {
+      const tc = new TestConnector();
+
+      tc.apiBaseUri = 'https://example.com';
+      tc.head('/test/head', { custom: 'option' });
+
+      expect(tc.request).toHaveBeenCalledWith(
+        expect.objectContaining({
+          custom: 'option',
+        }),
+      );
+    });
+  });
 });