resolve merge

Tidwell · Feb 18, 2019 · a6fe910 · a6fe910
2 parents d519201 + 4a84c9b
commit a6fe910
Show file tree

Hide file tree

Showing 24 changed files with 184 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+<<<<<<< HEAD
+=======
+### 2.2.0
+- Add timeout support (#39)
+
+>>>>>>> master
 ### 2.1.2
 - Force escaping of all url params (#34)
 

diff --git a/docs/Client.html b/docs/Client.html
@@ -294,6 +294,39 @@ <h6>Properties</h6>
 
 
 
+        <tr>
+
+                <td class="name"><code>timeout</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">number</span>
+
+
+
+            </td>
+
+
+                <td class="attributes">
+
+                    &lt;optional><br>
+
+
+
+
+
+                </td>
+
+
+
+
+            <td class="description last">Duration in ms to wait for a timeout, passed to https request as timeout option</td>
+        </tr>
+
+
+
         <tr>
 
                 <td class="name"><code>massageProperties</code></td>
@@ -383,7 +416,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Matches.html b/docs/Matches.html
@@ -945,7 +945,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Participants.html b/docs/Participants.html
@@ -1645,7 +1645,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Tournaments.html b/docs/Tournaments.html
@@ -2356,7 +2356,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/api_client.js.html b/docs/api_client.js.html
@@ -48,6 +48,7 @@ <h1 class="page-title">api/client.js</h1>
  * @param {string} options.apiKey Your challonge API Key
  * @param {string} [options.subdomain] - Sets the subdomain and automatically passes tournament[subdomain] and prefixes the subdomain to tournament urls.  If you don't want to pass a subdomain to the constructor, and want to use an organization (or multiple organizations), you must use client.setSubdomain('subdomain') before making api calls.
  * @param {string} [options.format] The format of the response data. Defaults to 'json'.  If set to 'json', will return javascript objects.  Anything else (including 'xml') will return the raw text string.
+ * @param {number} [options.timeout] Duration in ms to wait for a timeout, passed to https request as timeout option
  * @param {boolean} [options.massageProperties] If the response object should be massaged into camelCase properties when using json format.  Defaults to true.
  * @description
  *   Constructor function for the Client base responsible for communicating with Challonge API
@@ -141,6 +142,11 @@ <h1 class="page-title">api/client.js</h1>
 		}
 	};
 
+	const timeout = this.options.get('timeout');
+	if (timeout) {
+		options.timeout = timeout;
+	}
+
 	const req = https.request(options, (res) => {
 		// store the chunked data as it comes back
 		let resData = '';
@@ -165,6 +171,13 @@ <h1 class="page-title">api/client.js</h1>
 		});
 	});
 
+	req.on('timeout', () => {
+		errorHandler.handle({
+			timeout: true
+		}, '', callback, self.options.get('format'));
+		req.destroy();
+	});
+
 	req.end();
 };
 </code></pre>
@@ -179,7 +192,7 @@ <h1 class="page-title">api/client.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/api_error-handler.js.html b/docs/api_error-handler.js.html
@@ -96,6 +96,17 @@ <h1 class="page-title">api/error-handler.js</h1>
 		return;
 	}
 
+	if (res.timeout) {
+		err = {
+			error: true,
+			errors: [],
+			statusCode: 'timeout',
+			text: ''
+		};
+		callback(err, res);
+		return;
+	}
+
 	// not an api-documented error
 	err = {
 		error: true,
@@ -120,7 +131,7 @@ <h1 class="page-title">api/error-handler.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/api_matches.js.html b/docs/api_matches.js.html
@@ -160,7 +160,7 @@ <h1 class="page-title">api/matches.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/api_participants.js.html b/docs/api_participants.js.html
@@ -249,7 +249,7 @@ <h1 class="page-title">api/participants.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/api_tournaments.js.html b/docs/api_tournaments.js.html
@@ -361,7 +361,7 @@ <h1 class="page-title">api/tournaments.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/challonge.js.html b/docs/challonge.js.html
@@ -49,6 +49,7 @@ <h1 class="page-title">challonge.js</h1>
  * @param {string} options.apiKey Your challonge API Key
  * @param {string} [options.subdomain] - Sets the subdomain and automatically passes tournament[subdomain] and prefixes the subdomain to tournament urls.  If you don't want to pass a subdomain to the constructor, and want to use an organization (or multiple organizations), you must use client.setSubdomain('subdomain') before making api calls.
  * @param {string} [options.format] The format of the response data. Defaults to 'json'.  If set to 'json', will return javascript objects.  Anything else (including 'xml') will return the raw text string.
+ * @param {number} [options.timeout] Duration in ms to wait for a timeout, passed to https request as timeout option
  * @param {boolean} [options.massageProperties] If the response object should be massaged into camelCase properties when using json format.  Defaults to true.
  * @returns {object} new api client instance
  * @description
@@ -89,7 +90,7 @@ <h1 class="page-title">challonge.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/global.html b/docs/global.html
@@ -353,6 +353,39 @@ <h6>Properties</h6>
 
 
 
+        <tr>
+
+                <td class="name"><code>timeout</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">number</span>
+
+
+
+            </td>
+
+
+                <td class="attributes">
+
+                    &lt;optional><br>
+
+
+
+
+
+                </td>
+
+
+
+
+            <td class="description last">Duration in ms to wait for a timeout, passed to https request as timeout option</td>
+        </tr>
+
+
+
         <tr>
 
                 <td class="name"><code>massageProperties</code></td>
@@ -450,7 +483,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -103,7 +103,7 @@ <h3>Branching</h3><p><code>master</code> is the active development branch</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-ErrorHandler.html b/docs/module-ErrorHandler.html
@@ -366,7 +366,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-Util.html b/docs/module-Util.html
@@ -857,7 +857,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/param-serializer.js.html b/docs/param-serializer.js.html
@@ -107,7 +107,7 @@ <h1 class="page-title">param-serializer.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/util.js.html b/docs/util.js.html
@@ -121,7 +121,7 @@ <h1 class="page-title">util.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jul 09 2018 17:18:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 18 2019 15:34:43 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/lib/api/client.js b/lib/api/client.js
@@ -9,6 +9,7 @@ const util = require('../util');
  * @param {string} options.apiKey Your challonge API Key
  * @param {string} [options.subdomain] - Sets the subdomain and automatically passes tournament[subdomain] and prefixes the subdomain to tournament urls.  If you don't want to pass a subdomain to the constructor, and want to use an organization (or multiple organizations), you must use client.setSubdomain('subdomain') before making api calls.
  * @param {string} [options.format] The format of the response data. Defaults to 'json'.  If set to 'json', will return javascript objects.  Anything else (including 'xml') will return the raw text string.
+ * @param {number} [options.timeout] Duration in ms to wait for a timeout, passed to https request as timeout option
  * @param {boolean} [options.massageProperties] If the response object should be massaged into camelCase properties when using json format.  Defaults to true.
  * @description
  *   Constructor function for the Client base responsible for communicating with Challonge API
@@ -102,6 +103,11 @@ Client.prototype.makeRequest = function(obj) {
 		}
 	};
 
+	const timeout = this.options.get('timeout');
+	if (timeout) {
+		options.timeout = timeout;
+	}
+
 	const req = https.request(options, (res) => {
 		// store the chunked data as it comes back
 		let resData = '';
@@ -126,5 +132,12 @@ Client.prototype.makeRequest = function(obj) {
 		});
 	});
 
+	req.on('timeout', () => {
+		errorHandler.handle({
+			timeout: true
+		}, '', callback, self.options.get('format'));
+		req.destroy();
+	});
+
 	req.end();
 };
diff --git a/lib/api/client.spec.js b/lib/api/client.spec.js
@@ -171,6 +171,13 @@ describe('Client Class', () => {
 			expect(opts.cache_bust).toBeDefined();
 		});
 
+		it('should add a timeout if one is passed', () => {
+			client.options.timeout = 20000;
+			client.makeRequest({});
+
+			expect(httpsMock.opts.timeout).toEqual(20000);
+		});
+
 		it('should delete the callback, path, and method from the object', () => {
 			client.makeRequest({
 				callback: '',
@@ -242,6 +249,17 @@ describe('Client Class', () => {
 			});
 		});
 
+		it('should call the error handler on a timeout', () => {
+			spyOn(errorHandler, 'handle');
+
+			client.makeRequest({});
+
+			httpsMock.reqListeners.timeout[0]();
+			expect(errorHandler.handle).toHaveBeenCalledWith({
+				timeout: true
+			}, '', undefined, 'json');
+		});
+
 		it('should call the error handler on anything but a 200 response', () => {
 			spyOn(errorHandler, 'handle');
 

diff --git a/lib/api/error-handler.js b/lib/api/error-handler.js
@@ -57,6 +57,17 @@ exports.handle = function(res, resData, callback, format) {
 		return;
 	}
 
+	if (res.timeout) {
+		err = {
+			error: true,
+			errors: [],
+			statusCode: 'timeout',
+			text: ''
+		};
+		callback(err, res);
+		return;
+	}
+
 	// not an api-documented error
 	err = {
 		error: true,