add support for global request options (#88)

Author: sf-csarov

.gitignore

@@ -4,3 +4,4 @@ node_modules/
 .*.swp
 testing.js
 coverage/
+package-lock.json

lib/fuel-rest.js

@@ -12,6 +12,7 @@ const request = require('request');
 const version = require('../package.json').version;
 
 const clone = require('lodash.clone');
+const merge = require('lodash.merge');
 const isPlainObject = require('lodash.isplainobject');
 
 class FuelRest {
@@ -45,6 +46,7 @@ class FuelRest {
 			},
 			options.headers
 		);
+		this.globalReqOptions = options.globalReqOptions || {};
 	}
 	/**
 	 * Method that makes the api request
@@ -73,7 +75,14 @@ class FuelRest {
 		});
 	}
 	_processRequest(options, callback) {
-		this.AuthClient.getAccessToken(clone(options.auth))
+
+		const requestOptions = merge(
+			{},
+			this.globalReqOptions,
+			options.auth
+		);
+
+		this.AuthClient.getAccessToken(requestOptions)
 			.then(tokenInfo => {
 				if (!tokenInfo.accessToken) {
 					let error = new Error('No access token');
@@ -109,8 +118,12 @@ class FuelRest {
 			.catch(err => callback(err, null));
 	}
 	_makeRequest(consolidatedOpts, callback) {
-		const requestOptions = consolidatedOpts.req;
-
+		const requestOptions = merge(
+			{},
+			this.globalReqOptions,
+			consolidatedOpts.req
+		);
+		
 		request(requestOptions, (err, res, body) => {
 			let parsedBody;
 			let isResponseJson;

package.json

@@ -32,9 +32,10 @@
     "sinon": "~6.1.3"
   },
   "dependencies": {
-    "fuel-auth": "^3.0.2",
+    "fuel-auth": "3.1.0",
     "lodash.clone": "~4.5.0",
     "lodash.isplainobject": "~4.0.4",
+    "lodash.merge": "^4.6.1",
     "request": "~2.88.0"
   }
 }

test/specs/fn-proxy-support.js

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2018, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
+ */
+'use strict';
+const expect = require('chai').expect;
+const FuelRest = require('../../lib/fuel-rest');
+const routes = require('../config').routes;
+const http = require('http');
+
+const port = 4550;
+const proxyPort = 8888;
+const proxyErrorPort = 1234;
+const localhost = `http://127.0.0.1:${port}`;
+const proxyResponseBody = 'Hello Node JS Server Response';
+const requestOptions = {
+	method: 'GET',
+	uri: routes.get
+};
+const server = http.createServer(function (request, response) {
+	response.writeHead(200, {'Content-Type': 'application/json'});
+	response.write(proxyResponseBody);
+	response.end();
+});
+const accessToken = 'testForRest';
+const expiration = 111111111111;
+
+describe('Proxy support', function () {
+
+	let restClient, initOptions;
+
+	before(done => server.listen(proxyPort, done));
+
+	beforeEach(() => {
+		initOptions = {
+			auth: {
+				clientId: 'testing',
+				clientSecret: 'testing'
+			},
+			restEndpoint: localhost,
+			globalReqOptions: {
+				proxy: {
+					host: '127.0.0.1',
+					protocol: 'http:'
+				}
+			}
+		};
+	});
+
+	it('should respond the proxyResponseBody if proxy option passed correctly', done => {
+		initOptions.globalReqOptions.proxy.port = proxyPort;
+		restClient = new FuelRest(initOptions);
+		restClient.AuthClient.accessToken = accessToken;
+		restClient.AuthClient.expiration = expiration;
+		restClient.apiRequest(requestOptions, (err, data) => {
+			expect(data.body).to.equal(proxyResponseBody);
+			done();
+		});
+	});
+
+	it('should error if proxy option passed incorrectly', done => {
+		initOptions.globalReqOptions.proxy.port = proxyErrorPort;
+		restClient = new FuelRest(initOptions);
+		restClient.AuthClient.accessToken = accessToken;
+		restClient.AuthClient.expiration = expiration;
+		restClient.apiRequest(requestOptions, (err) => {
+			expect(err.code).to.equal('ECONNREFUSED');
+			expect(err.port).to.equal(proxyErrorPort);
+			done();
+		});
+	});
+
+	after(() => server.close());
+
+});