Adding ability to supply an HTTP Agent (#125)

* adding ability to pass custom options to request-promise

Author: seangallavan

README.md

@@ -93,8 +93,25 @@ Now you are able to run all of the other [examples]:
 node example/policies.js
 ```
 
-[![Backers](https://opencollective.com/node-vault/tiers/backers.svg?avatarHeight=80&width=600)](https://opencollective.com/node-vault/contribute)
+##Connecting to vault through a bastion host
+To connect to a vault server in a private network with a bastion host, you'll need to first open a connection:
+```bash
+ssh -D <socks4Port> bastion.example.com
+```
+
+```javascript
+const SocksProxyAgent = require('socks-proxy-agent');
+const agent = new SocksProxyAgent(`socks://127.0.0.1:${socks4Port}`, true);
+const options = {
+  apiVersion: 'v1',
+  rpOptions: {
+    agent,
+  },
+};
 
+const vault = require('node-vault')(options);
+```
+[![Backers](https://opencollective.com/node-vault/tiers/backers.svg?avatarHeight=80&width=600)](https://opencollective.com/node-vault/contribute)
 [examples]: https://github.com/kr1sp1n/node-vault/tree/master/example
 [docker-compose.yml]: https://github.com/kr1sp1n/node-vault/tree/master/docker-compose.yml
 [Vault]: https://vaultproject.io/

src/index.js

@@ -4,7 +4,7 @@ let debug = require('debug')('node-vault');
 let tv4 = require('tv4');
 let commands = require('./commands.js');
 let mustache = require('mustache');
-const rp = require('request-promise-native');
+let rp = require('request-promise-native');
 
 class VaultError extends Error {}
 
@@ -24,12 +24,21 @@ module.exports = (config = {}) => {
   tv4 = config.tv4 || tv4;
   commands = config.commands || commands;
   mustache = config.mustache || mustache;
-  const requestPromise = (config['request-promise'] || rp).defaults({
+
+  const rpDefaults = {
     json: true,
     resolveWithFullResponse: true,
     simple: false,
     strictSSL: !process.env.VAULT_SKIP_VERIFY,
-  });
+  };
+
+  if (config.rpDefaults) {
+    Object.keys(config.rpDefaults).forEach(key => {
+      rpDefaults[key] = config.rpDefaults[key];
+    });
+  }
+
+  rp = (config['request-promise'] || rp).defaults(rpDefaults);
   const client = {};
 
   function handleVaultResponse(response) {
@@ -88,7 +97,7 @@ module.exports = (config = {}) => {
     options.uri = uri;
     debug(options.method, uri);
     if (options.json) debug(options.json);
-    return requestPromise(options).then(client.handleVaultResponse);
+    return rp(options).then(client.handleVaultResponse);
   };
 
   client.help = (path, requestOptions) => {

test/unit.js

@@ -43,6 +43,28 @@ describe('node-vault', () => {
       });
     });
 
+    it('should set additional values for request library', () => {
+      const defaultsStub = sinon.stub();
+
+      index({
+        'request-promise': {
+          defaults: defaultsStub,
+        },
+        rpDefaults: {
+          fakeArgument: 1,
+        },
+      });
+
+      defaultsStub.should.be.calledOnce();
+      defaultsStub.should.be.calledWithExactly({
+        json: true,
+        simple: false,
+        resolveWithFullResponse: true,
+        strictSSL: true,
+        fakeArgument: 1,
+      });
+    });
+
     it('should disable ssl security based on vault environment variable', () => {
       const defaultsStub = sinon.stub();