Release 2.1.2 (#38)

* escape all qs params (#37) * build 2.1.2 and run docs
Tidwell · Jul 9, 2018 · d519201 · d519201
1 parent d939f8d
commit d519201
Show file tree

Hide file tree

Showing 21 changed files with 47 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
+### 2.1.2
+- Force escaping of all url params (#34)
+
 ### 2.1.1
-- Fix bug preventing match_id and participant_id passed as underscore properties for URL generation #32
+- Fix bug preventing match_id and participant_id passed as underscore properties for URL generation (#32)
 
 ### 2.1.0
 - Fix null values being returned as empty objects (#24)

diff --git a/docs/Client.html b/docs/Client.html
@@ -383,7 +383,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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
@@ -131,11 +131,10 @@ <h1 class="page-title">api/client.js</h1>
 	const serialized = util.serializeToQSParams(obj);
 
 	path = versionPaths[this.options.get('version')] + (path ? path : '') + '.' + this.options.get('format') + '?' + serialized;
-
 	// create options for the https call
 	const options = {
 		hostname: 'api.challonge.com',
-		path: path,
+		path: encodeURI(path),
 		method: method,
 		headers: {
 			'Content-Length': 0 // server throws nginx error without a content-length
@@ -180,7 +179,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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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
@@ -120,7 +120,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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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
@@ -89,7 +89,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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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
@@ -450,7 +450,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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 Sat May 05 2018 17:05:04 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 Jul 09 2018 17:18:03 GMT-0400 (EDT) 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
@@ -92,11 +92,10 @@ Client.prototype.makeRequest = function(obj) {
 	const serialized = util.serializeToQSParams(obj);
 
 	path = versionPaths[this.options.get('version')] + (path ? path : '') + '.' + this.options.get('format') + '?' + serialized;
-
 	// create options for the https call
 	const options = {
 		hostname: 'api.challonge.com',
-		path: path,
+		path: encodeURI(path),
 		method: method,
 		headers: {
 			'Content-Length': 0 // server throws nginx error without a content-length

diff --git a/lib/api/client.spec.js b/lib/api/client.spec.js
@@ -215,7 +215,26 @@ describe('Client Class', () => {
 
 			expect(httpsMock.opts).toEqual({
 				hostname: 'api.challonge.com',
-				path: '/v1/tournaments/some/path.json?randomprop=thingie&some_property[another_property]=anotherthing&api_key=mykey&cache_bust=1',
+				path: '/v1/tournaments/some/path.json?randomprop=thingie&some_property%5Banother_property%5D=anotherthing&api_key=mykey&cache_bust=1',
+				method: 'GET',
+				headers: {
+					'Content-Length': 0
+				}
+			});
+		});
+
+		it('should make a request with escaped data for extended characters', () => {
+			spyOn(Math, 'random').and.returnValue(1);
+			client.options.apiKey = 'mykey';
+			client.makeRequest({
+				path: '/some/path',
+				method: 'GET',
+				randomprop: '扶摇ståleSÓLO独播'
+			});
+
+			expect(httpsMock.opts).toEqual({
+				hostname: 'api.challonge.com',
+				path: '/v1/tournaments/some/path.json?randomprop=%E6%89%B6%E6%91%87st%C3%A5leS%C3%93LO%E7%8B%AC%E6%92%AD&api_key=mykey&cache_bust=1',
 				method: 'GET',
 				headers: {
 					'Content-Length': 0

diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "description": "Wrapper for the challong api",
   "author": "Aaron Tiwell <[email protected]>",
   "main": "./lib/challonge.js",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "contributors": [
     {
       "name": "Ricardo Reis",

diff --git a/test/full.js b/test/full.js
@@ -6,7 +6,7 @@ var client = challonge.createClient({
 	version: 1,
 });
 
-var tourneyName = 'new_api_test' + Math.floor(Math.random()*10000);
+var tourneyName = 'new_api_test扶摇ståleSÓLO独播' + Math.floor(Math.random()*10000);
 
 client.tournaments.create({
 	tournament: {
@@ -31,15 +31,15 @@ function update() {
 			url: tourneyName,
 			signupCap: 16,
 			tournamentType: 'double elimination',
-			description: 'some new description',
+			description: 'some new description扶摇ståleSÓLO独播',
 			acceptAttachments: true
 
 		},
 		callback: function(err,data){
 			if (err) { console.log(err); return; }
 			console.log(data);
 
-			pcreate('player1');
+			pcreate('player1扶摇ståleSÓLO独播');
 		}
 	});
 }
@@ -53,7 +53,7 @@ function pcreate(name) {
 		callback: function(err,data){
 			if (err) { console.log(err); return; }
 			console.log(data);
-			if (name === 'player1') {
+			if (name === 'player1扶摇ståleSÓLO独播') {
 				pcreate('player2');
 			} else {
 				start();