Allow proxy options object as a proxy parameter (#458)

Author: tim-kuteev

README.md

@@ -134,7 +134,7 @@ const options = {
     '< header name >': '< header value >'
   },
   contentEncoding: '< Encoding type, e.g.: aesgcm or aes128gcm >',
-  proxy: '< proxy server address >'
+  proxy: '< proxy server options >'
 }
 
 webpush.sendNotification(
@@ -182,7 +182,9 @@ request only. This overrides any API key set via `setGCMAPIKey()`.
 retained by the push service (by default, four weeks).
 - **headers** is an object with all the extra headers you want to add to the request.
 - **contentEncoding** is the type of push encoding to use (e.g. 'aesgcm', by default, or 'aes128gcm').
-- **proxy** proxy hostname/ip and a port to tunnel your requests through (eg. http://< hostname >:< port >).
+- **proxy** is the [HttpsProxyAgent's constructor argument](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options)
+that may either be a string URI of the proxy server (eg. http://< hostname >:< port >)
+or an "options" object with more specific properties.
 
 ### Returns
 
@@ -353,7 +355,7 @@ const options = {
     '< header name >': '< header value >'
   },
   contentEncoding: '< Encoding type, e.g.: aesgcm or aes128gcm >',
-  proxy: '< proxy server address >'
+  proxy: '< proxy server options >'
 }
 
 try {
@@ -407,7 +409,9 @@ request only. This overrides any API key set via `setGCMAPIKey()`.
 retained by the push service (by default, four weeks).
 - **headers** is an object with all the extra headers you want to add to the request.
 - **contentEncoding** is the type of push encoding to use (e.g. 'aesgcm', by default, or 'aes128gcm').
-- **proxy** proxy hostname/ip and a port to tunnel your requests through (eg. http://< hostname >:< port >).
+- **proxy** is the [HttpsProxyAgent's constructor argument](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options)
+that may either be a string URI of the proxy server (eg. http://< hostname >:< port >)
+or an "options" object with more specific properties.
 
 ### Returns
 

src/web-push-lib.js

@@ -166,10 +166,11 @@ WebPushLib.prototype.generateRequestDetails = function(subscription, payload, op
       }
 
       if (options.proxy) {
-        if (typeof options.proxy === 'string') {
+        if (typeof options.proxy === 'string'
+          || typeof options.proxy.host === 'string') {
           proxy = options.proxy;
         } else {
-          console.warn('Attempt to use proxy option, but invalid type it should be a string ');
+          console.warn('Attempt to use proxy option, but invalid type it should be a string or proxy options object.');
         }
       }
     }

test/test-generate-request-details.js

@@ -5,6 +5,7 @@ const urlBase64 = require('urlsafe-base64');
 const webPush = require('../src/index');
 const crypto = require('crypto');
 const jws = require('jws');
+const urlParse = require('url').parse;
 
 suite('Test Generate Request Details', function() {
   test('is defined', function() {
@@ -312,4 +313,20 @@ suite('Test Generate Request Details', function() {
     );
     assert.equal(details.proxy, extraOptions.proxy);
   });
+
+  test('Proxy option as an object', function() {
+    let subscription = {
+      endpoint: 'https://127.0.0.1:8080'
+    };
+    let proxyOption = urlParse('http://proxy');
+    let extraOptions = {
+      proxy: proxyOption
+    };
+    let details = webPush.generateRequestDetails(
+      subscription,
+      null,
+      extraOptions
+    );
+    assert.equal(details.proxy, extraOptions.proxy);
+  });
 });