Add ability to pass extra options on each request

docs/client.md

@@ -10,7 +10,7 @@ Pseudo-implementation of an alternative client:
 import SDK, { Client } from '@uphold/uphold-sdk-javascript';
 
 class AlternativeClient extends Client {
-  request(url, method, body, customHeaders = {}) {
+  request(url, method, body, customHeaders = {}, options) {
     // Make your own implementation, but make sure it returns a Promise that resolves
     // or rejects an object with the schema demonstrated at the bottom of this section.
   }
@@ -53,6 +53,7 @@ This method is responsible for performing HTTP requests to Uphold's API.
 | `method`  | String | Yes      | HTTP method       |
 | `body`    | Object | Yes      | Request body      |
 | `headers` | Object | No       | Request headers   |
+| `options` | Object | No       | Request options   |
 
 This method must resolve an object with the following schema so that pagination and errors can be handled in a proper fashion:
 

src/browser/services/fetch-client.js

@@ -2,8 +2,9 @@ import { Client, createError } from '../../core';
 import isHtml from 'is-html';
 
 export default class FetchClient extends Client {
-  request(url, method = 'get', body, headers = {}) {
-    const options = {
+  request(url, method = 'get', body, headers = {}, options = {}) { // eslint-disable-line max-params
+    const requestOptions = {
+      ...options,
       body,
       cache: 'no-cache',
       credentials: 'omit',
@@ -15,7 +16,7 @@ export default class FetchClient extends Client {
       mode: 'cors'
     };
 
-    return fetch(url, options)
+    return fetch(url, requestOptions)
       .then(response => {
         if (!response.ok) {
           return Promise.reject(response);

src/core/sdk.js

@@ -33,7 +33,10 @@ export default class SDK {
     this.oauthClient = new OAuthClient(this.options);
   }
 
-  api(uri, { authenticate = true, body, headers = {}, method = 'get', queryParams, raw, version = this.options.version } = {}) {
+  api(uri, options = {}) {
+    const { authenticate = true, headers = {}, method = 'get', queryParams, raw, version = this.options.version } = options;
+    let { body } = options;
+
     const url = buildUrl(uri, this.options.baseUrl, version, queryParams);
 
     let request;
@@ -50,15 +53,15 @@ export default class SDK {
         return this.client.request(url, method, body, {
           ...buildBearerAuthorizationHeader(tokens.access_token),
           ...headers
-        });
+        }, options);
       });
     } else {
-      request = this.client.request(url, method, body, headers);
+      request = this.client.request(url, method, body, headers, options);
     }
 
     return request
       .then(data => { return raw ? data : data.body; })
-      .catch(this._refreshToken(url, method, body, headers));
+      .catch(this._refreshToken(url, method, body, headers, options));
   }
 
   authorize(code) {
@@ -134,7 +137,7 @@ export default class SDK {
       .then(({ body }) => this.setToken(body));
   }
 
-  _refreshToken(url, method, body, headers) {
+  _refreshToken(url, method, body, headers, options) { // eslint-disable-line max-params
     return response => {
       if (!response || !response.body || response.body.error !== 'invalid_token') {
         return Promise.reject(response);
@@ -149,7 +152,7 @@ export default class SDK {
           return this.client.request(url, method, body, {
             ...buildBearerAuthorizationHeader(tokens.access_token),
             ...headers
-          })
+          }, options)
             .then(data => data.body);
         });
     };

src/node/services/request-client.js

@@ -3,8 +3,9 @@ import { RequestError } from 'request-promise/errors';
 import request from 'request-promise';
 
 export default class RequestClient extends Client {
-  request(url, method, body, headers = {}) {
+  request(url, method, body, headers = {}, options) { // eslint-disable-line max-params
     return request({
+      ...options,
       body,
       headers: {
         ...this.defaultHeaders,

test/browser/services/fetch-client.spec.js

@@ -10,6 +10,15 @@ describe('FetchClient', () => {
   });
 
   describe('request()', () => {
+    it('should set `get` as default method if none is provided', () => {
+      fetchMock.mock('foo', {});
+
+      return client.request('foo')
+        .then(() => {
+          expect(fetchMock.lastOptions().method).toEqual('GET');
+        });
+    });
+
     it('should send a `User-Agent` header', () => {
       fetchMock.mock('foo', {});
 

test/core/sdk.spec.js

@@ -288,6 +288,7 @@ describe('SDK', () => {
       return sdk.authorize('code')
         .then(() => {
           expect(sdk.client.request.mock.calls.length).toBe(1);
+          expect(sdk.client.request.mock.calls[0][1]).toBe('post');
           expect(sdk.client.request.mock.calls[0][2]).toBe('client_id=foo&client_secret=bar&code=code&grant_type=authorization_code');
           expect(sdk.client.request.mock.calls[0][3]).toEqual({ 'content-type': 'application/x-www-form-urlencoded' });
         });
@@ -394,20 +395,22 @@ describe('SDK', () => {
               'https://api.uphold.com/v0/foo',
               'get',
               undefined,
-              { authorization: 'Bearer token' }
+              { authorization: 'Bearer token' },
+              {}
             );
           });
       });
 
-      it('should not build the `authorization` header if provided', () => {
+      it('should not build the `authorization` header if value is already provided', () => {
         return sdk.api('/foo', { headers: { authorization: 'foo' } })
           .then(() => {
             expect(sdk.storage.getItem).not.toBeCalled();
             expect(sdk.client.request).toBeCalledWith(
               'https://api.uphold.com/v0/foo',
               'get',
               undefined,
-              { authorization: 'foo' }
+              { authorization: 'foo' },
+              { headers: { authorization: 'foo' } }
             );
           });
       });
@@ -434,7 +437,8 @@ describe('SDK', () => {
               'https://api.uphold.com/v0/foo',
               'get',
               undefined,
-              {}
+              {},
+              { authenticate: false }
             );
           });
       });
@@ -471,31 +475,38 @@ describe('SDK', () => {
 
     it('should add custom headers', () => {
       sdk.client.request.mockReturnValue(Promise.resolve('foo'));
+      const options = { authenticate: false, headers: { foo: 'bar' } };
 
-      return sdk.api('/biz', { authenticate: false, headers: { foo: 'bar' } })
+      return sdk.api('/biz', options)
         .then(() => {
-          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/v0/biz', 'get', undefined, { foo: 'bar' });
+          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/v0/biz', 'get', undefined, { foo: 'bar' }, options);
         });
     });
 
     it('should build the request url with configured version if `version` is not provided', () => {
-      return sdk.api('/foo', { authenticate: false })
+      const options = { authenticate: false };
+
+      return sdk.api('/foo', options)
         .then(() => {
-          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/v0/foo', 'get', undefined, {});
+          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/v0/foo', 'get', undefined, {}, options);
         });
     });
 
     it('should build the request url with given `version`', () => {
-      return sdk.api('/foo', { authenticate: false, version: 'bar' })
+      const options = { authenticate: false, version: 'bar' };
+
+      return sdk.api('/foo', options)
         .then(() => {
-          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/bar/foo', 'get', undefined, {});
+          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/bar/foo', 'get', undefined, {}, options);
         });
     });
 
     it('should build the request url with no version if `version` is given as `false`', () => {
-      return sdk.api('/foo', { authenticate: false, version: false })
+      const options = { authenticate: false, version: false };
+
+      return sdk.api('/foo', options)
         .then(() => {
-          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/foo', 'get', undefined, {});
+          expect(sdk.client.request).toBeCalledWith('https://api.uphold.com/foo', 'get', undefined, {}, options);
         });
     });
   });