Merge pull request #76 from Katsuya-Tomioka/DEVOPS-247-address-similarity

DEVOPS-247: support address-similarity

Author: seth-mg

examples/address_similarity.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var Api = require("../lib/Api");
+var ArgumentParser = require("argparse").ArgumentParser;
+
+var parser = new ArgumentParser({
+  addHelp: true,
+  description: "Get the similarity score of two names"
+});
+parser.addArgument(["--key"], {help: "Rosette API key", required: true});
+parser.addArgument(["--url"], {help: "Rosette API alt-url", required: false});
+var args = parser.parseArgs();
+var api = new Api(args.key, args.url);
+var endpoint = "addressSimilarity";
+
+api.parameters.address1 = {"city": "Cambridge"}
+api.parameters.address2 = {"city": "cambridge", "state": "ma"}
+
+api.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
+});

lib/Api.js

@@ -1,7 +1,7 @@
 /**
  * Rosette API.
  *
- * @copyright 2016-2018 Basis Technology Corporation.
+ * @copyright 2016-2019 Basis Technology Corporation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
  * with the License. You may obtain a copy of the License at
@@ -21,6 +21,7 @@ var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
 var paramObj = require("./parameters");
 
+var addressSimilarity = require("./addressSimilarity")
 var categories = require("./categories");
 var entities = require("./entities");
 var info = require("./info");

lib/addressSimilarity.js

@@ -0,0 +1,56 @@
+/**
+ * Rosette API.
+ *
+ * @copyright 2019 Basis Technology Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and limitations under the License.
+ **/
+"use strict";
+
+var URL = require("url");
+
+var rosetteConstants = require("./rosetteConstants");
+var RosetteException = require("./rosetteExceptions");
+var rosetteRequest = require("./rosetteRequest");
+
+/**
+ * @class
+ *
+ * @copyright 2016-2018 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
+function addressSimilarity() {
+
+};
+
+/**
+ * Makes an HTTP request to the specified Rosette API endpoint and returns the result
+ * @param {string} parameters - The Rosette API endpoint parameters
+ * @param {string} userKey - The Rosette API user access key
+ * @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
+ */
+addressSimilarity.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
+
+    if (parameters.documentFile != null) {
+        return callback(new RosetteException("badArgument", "Address similarity does not support documentFile", "bad arguments"));
+    } else {
+        // validate parameters
+        if (!parameters.loadParams().address1 || !parameters.loadParams().address2) {
+            return callback(new RosetteException("badArgument", "Must supply both address1 and address2 parameters to be matched."));
+        } else {
+            // configure URL
+            var urlParts = URL.parse(serviceURL + "address-similarity");
+            var req = new rosetteRequest();
+            req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
+        }
+    }
+};
+
+module.exports = addressSimilarity;

lib/parameters.js

@@ -1,7 +1,7 @@
 /**
  * Rosette API.
  *
- * @copyright 2016-2018 Basis Technology Corporation.
+ * @copyright 2016-2019 Basis Technology Corporation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
  * with the License. You may obtain a copy of the License at
@@ -48,6 +48,10 @@ function parameters() {
     this.genre = null;
     this.options = null;
 
+    // address similarity parameters
+    this.address1 = null;
+    this.address2 = null;
+
     // name matching parameters
     this.name1 = null;
     this.name2 = null;
@@ -98,6 +102,8 @@ parameters.prototype.loadParams = function() {
         "contentUri": this.contentUri,
         "language": this.language,
         "genre": this.genre,
+        "address1": this.address1,
+        "address2": this.address2,
         "name1": this.name1,
         "name2": this.name2,
         "name": this.name,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rosette-api",
-  "version": "1.12.2",
+  "version": "1.14.3",
   "description": "Rosette API Node.js client SDK",
   "main": "index",
   "directories": {
@@ -12,6 +12,7 @@
     "url": "git://github.com/rosette-api/nodejs.git"
   },
   "keywords": [
+    "address similarity",
     "categorization",
     "entity extraction",
     "language detection",
@@ -46,10 +47,10 @@
     "argparse": "^1.0.6",
     "chai": "^3.5.0",
     "eslint": "^6.0.1",
-    "grunt": "^0.4.5",
+    "grunt": "^1.0.4",
     "grunt-contrib-clean": "^1.0.0",
-    "grunt-contrib-watch": "^0.6.1",
-    "grunt-gh-pages": "^1.0.0",
+    "grunt-contrib-watch": "^1.1.0",
+    "grunt-gh-pages": "^3.1.0",
     "grunt-jsdoc": "^1.1.0",
     "grunt-jslint": "^1.1.14",
     "grunt-mocha-test": "^0.12.7",

tests/unittests.js

@@ -1,11 +1,12 @@
-"use strict"
+"use strict";
 
 var chai = require('chai');
 var mocha = require('mocha');
 var nock = require('nock');
 var fs = require('fs');
 
 var Api = require("../lib/Api");
+var addressSimilarity = require("../lib/addressSimilarity");
 var language = require("../lib/language");
 var relationships = require("../lib/relationships");
 var nameDeduplication = require("../lib/nameDeduplication");
@@ -143,6 +144,55 @@ describe("Relationships Endpoint", function() {
     });
 });
 
+describe("Address Similarity Endpoint", function() {
+    beforeEach(function(done) {
+        var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});
+
+        nock('https://api.rosette.com', {"encodedQueryParams": true })
+            .post('/rest/v1/info')
+            .query({"clientVersion": "1.14.3"})
+            .reply(200, JSON.parse(mockResponse));
+
+        nock('https://api.rosette.com', {"encodedQueryParams": true })
+            .post('/rest/v1/address-similarity')
+            .query({"clientVersion": "1.14.3"})
+            .reply(200, JSON.parse(mockResponse));
+        done();
+    });
+
+    afterEach(function(done) {
+        nock.cleanAll();
+        done();
+    });
+
+    it("successfully calls the address similarity endpoint", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+
+        api.parameters.address1 = {"city": "cambridge", "state": "ma"};
+        api.parameters.address2 = {"city": "Cambridge", "road": "1 Kendall sq."};
+
+        api.rosette("addressSimilarity", function(err, res) {
+            chai.expect(err).to.be.null;
+            chai.expect(res.name).to.equal('Rosette API');
+            done();
+        });
+
+    });
+
+    it("detects missing name parameter", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+
+        api.parameters.address1 = {"city": "cambridge", "state": "ma"};
+
+        api.rosette("addressSimilarity", function(err, res) {
+            chai.expect(err).to.not.be.null;
+            chai.expect(err.name).to.equal('RosetteException');
+            chai.expect(err.message).to.contain('badArgument');
+            done();
+        });
+    });
+});
+
 describe("Name Deduplication Endpoint", function() {
     beforeEach(function(done) {
         var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});
@@ -1047,4 +1097,3 @@ describe("Topics Endpoint", function() {
         });
     });
 });
-