DEVOPS-247: support address-similarity

Author: Katsuya-Tomioka

lib/Api.js

@@ -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 2016-2018 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

@@ -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;