Release 1.1. Includes code cleanup

Chris Park · Chris Park · commit 84c8f22f153b · 2016-04-26T11:34:47.000-04:00
diff --git a/lib/Api.js b/lib/Api.js
@@ -36,7 +36,7 @@ var checkVersion = require("./checkVersion");
  *
  * @type string
  */
-var BINDING_VERSION = "1.0";
+var BINDING_VERSION = "1.1";
 
 /**
  * @class
@@ -95,7 +95,7 @@ Api.prototype.rosette = function(endpoint, callback) {
     var c = new checkVersion();
 
     // check if server and client API versions match
-    c.check(this.userKey, this.serviceURL, function(err, res) {
+    c.check(api.parameters, this.userKey, this.serviceURL, function(err, res) {
         if (err) {
             return callback(err);
         } else if (!res.versionChecked) {
diff --git a/lib/categories.js b/lib/categories.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var RosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/checkVersion.js b/lib/checkVersion.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
@@ -38,12 +35,12 @@ function checkVersion() {
  * @param {string} serviceURL - The base service URL to be used to access the Rosette API
  * @param {function} callback - Callback function to be exectuted after the function to which it is passed is complete
  */
-checkVersion.prototype.check = function(userKey, serviceURL, callback) {
+checkVersion.prototype.check = function(parameters, userKey, serviceURL, callback) {
     var req = new rosetteRequest();
     // configure URL
     var urlParts = URL.parse(serviceURL + "info?clientVersion=" + req.bindingVersion());
 
-    req.makeRequest('POST', userKey, urlParts, null, callback);
+    req.makeRequest('POST', userKey, urlParts, parameters, callback);
 
 };
 
diff --git a/lib/entities.js b/lib/entities.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/info.js b/lib/info.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
@@ -44,7 +41,7 @@ info.prototype.getResults = function(parameters, userKey, serviceURL, callback)
     // configure URL
     var urlParts = URL.parse(serviceURL + "info");
     var req = new rosetteRequest();
-    req.makeRequest('GET', userKey, urlParts, null, callback);
+    req.makeRequest('GET', userKey, urlParts, parameters, callback);
 };
 
 module.exports = info;
diff --git a/lib/language.js b/lib/language.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/morphology.js b/lib/morphology.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var RosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
@@ -55,7 +52,6 @@ morphology.prototype.getResults = function(parameters, userKey, serviceURL, call
         } else {
             // configure URL
             var urlParts = URL.parse(serviceURL + "morphology" + "/" + parameters.loadParams().morphology);
-            var protocol = https;
             var req = new rosetteRequest();
             req.makeRequest('POST', userKey, urlParts, parameters, callback);
         }
diff --git a/lib/nameSimilarity.js b/lib/nameSimilarity.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/nameTranslation.js b/lib/nameTranslation.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/parameters.js b/lib/parameters.js
@@ -28,7 +28,7 @@ var zlib = require("zlib");
  *
  * @type string
  */
-var BINDING_VERSION = "1.0";
+var BINDING_VERSION = "1.1";
 
 /**
  * @class
diff --git a/lib/ping.js b/lib/ping.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
@@ -44,7 +41,7 @@ ping.prototype.getResults = function(parameters, userKey, serviceURL, callback)
     // configure URL
     var urlParts = URL.parse(serviceURL + "ping");
     var req = new rosetteRequest();
-    req.makeRequest('GET', userKey, urlParts, null, callback);
+    req.makeRequest('GET', userKey, urlParts, parameters, callback);
 };
 
 module.exports = ping;
diff --git a/lib/relationships.js b/lib/relationships.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/rosetteConstants.js b/lib/rosetteConstants.js
@@ -26,15 +26,6 @@ var dataFormat = {
     "UNSPECIFIED": "application/octet-stream"
 };
 
-/**
- * @desc Accepted input units
- * @type {JSON}
- */
-var inputUnit = {
-    "DOC": "doc",
-    "SENTENCE": "sentence"
-};
-
 /**
  * @desc Accepted morphology output types
  * @type {JSON}
@@ -48,5 +39,4 @@ var morphologyOutput = {
 };
 
 exports.dataFormat = dataFormat;
-exports.inputUnit = inputUnit;
-exports.morpholoyOutput = morphologyOutput;
+exports.morpholoyOutput = morphologyOutput;
diff --git a/lib/rosetteRequest.js b/lib/rosetteRequest.js
@@ -26,7 +26,7 @@ var RosetteException = require("./rosetteExceptions");
  *
  * @type string
  */
-var BINDING_VERSION = "1.0";
+var BINDING_VERSION = "1.1";
 
 /**
  * @class
diff --git a/lib/sentences.js b/lib/sentences.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/sentiment.js b/lib/sentiment.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/lib/tokens.js b/lib/tokens.js
@@ -13,10 +13,7 @@
  **/
 "use strict";
 
-var http = require("http");
-var https = require("https");
 var URL = require("url");
-var zlib = require("zlib");
 
 var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rosette-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Rosette API Node.js client SDK",
   "main": "index",
   "directories": {
diff --git a/tests/unittests.js b/tests/unittests.js
@@ -37,8 +37,9 @@ describe("Check Version", function() {
            .query({"clientVersion":"1.0"})
            .reply(200, JSON.parse(mockResponse));
         
+        var params = new paramObj();
         var c = new checkVersion();
-        c.check('1234567890', 'https://api.rosette.com/rest/v1/', function(err, res) {
+        c.check(params, '1234567890', 'https://api.rosette.com/rest/v1/', function(err, res) {
             chai.expect(res).to.have.property('name');
             chai.expect(res.name).to.equal('Rosette API');
             done();
@@ -55,7 +56,8 @@ describe("Check Version", function() {
            .reply(200, JSON.parse(mockResponse));
 
         var c = new checkVersion();
-        c.check('1234567890', 'https://api.rosette.com/rest/v1/', function(err, res) {
+        var params = new paramObj();
+        c.check(params, '1234567890', 'https://api.rosette.com/rest/v1/', function(err, res) {
             chai.expect(res).to.have.property('versionChecked');
             chai.expect(res.versionChecked).to.be.false;
             done();

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ var zlib = require("zlib");`
`28`	`28`	`*`
`29`	`29`	`* @type string`
`30`	`30`	`*/`
`31`		`-var BINDING_VERSION = "1.0";`
	`31`	`+var BINDING_VERSION = "1.1";`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* @class`