RCB-527 Topics endpoint (#64)

cp2boston · Li Xu · commit 45eee5b40ec3 · 2017-09-19T17:32:05.000-04:00
* RCB-527 Topics endpoint

- Created new topics endpoint
- Created new topics example
- Created new topics unit test
- Updated README
- Updated Api

* Removed .js from require

* Reduce comparisons
diff --git a/README.md b/README.md
@@ -49,10 +49,10 @@ api.rosette(endpoint, function(err, res){
 ## API Parameters
 | Parameter                     | Endpoint                                            | Required
 | -------------                 |-------------                                        |-------------
-| content                    | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, transliteration            | Either content or contentUri required, transliteration requires content only |
-| contentUri                      | categories, entities, language, morphology, relationships, sentences, sentiment, tokens       | Either content or contentUri required |
-| language                          | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, name similarity                    | No |
-| documentFile                      | categories, entities, language, morphology, relationships, sentences, sentiment, tokens                  | No |
+| content                    | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics, transliteration | Either content or contentUri required, transliteration requires content only |
+| contentUri                      | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics | Either content or contentUri required |
+| language                          | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics, name similarity | No |
+| documentFile                      | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics | No |
 | name1                 | name similarity               | Yes |
 | name2               | name similarity| Yes |
 | name    | name translation     | Yes |
diff --git a/examples/topics.js b/examples/topics.js
@@ -0,0 +1,26 @@
+"use strict";
+
+var Api = require("../lib/Api");
+var ArgumentParser = require("argparse").ArgumentParser;
+
+var parser = new ArgumentParser({
+  addHelp: true,
+  description: "Get the key phrases and concepts in a piece of text"
+});
+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 = "topics";
+
+var topics_data = "Lily Collins is in talks to join Nicholas Hoult in Chernin Entertainment and Fox Searchlight's J.R.R. Tolkien biopic Tolkien. Anthony Boyle, known for playing Scorpius Malfoy in the British play Harry Potter and the Cursed Child, also has signed on for the film centered on the famed author. In Tolkien, Hoult will play the author of the Hobbit and Lord of the Rings book series that were later adapted into two Hollywood trilogies from Peter Jackson. Dome Karukoski is directing the project."
+var content = topics_data;
+api.parameters.content = content;
+
+api.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
+});
diff --git a/lib/Api.js b/lib/Api.js
@@ -37,6 +37,7 @@ var translatedName = require("./nameTranslation");
 var tokens = require("./tokens");
 var syntax_dependencies = require("./syntax_dependencies");
 var transliteration = require("./transliteration");
+var topics = require("./topics");
 
 /**
  * @class
diff --git a/lib/categories.js b/lib/categories.js
@@ -43,7 +43,7 @@ categories.prototype.getResults = function(parameters, userKey, protocol, servic
     } else {
 
     // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of content or contentUri", "bad arguments"));
         } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
             return callback(new RosetteException("badArgument", "Cannot supply content and contentUri", "bad arguments"));
diff --git a/lib/entities.js b/lib/entities.js
@@ -43,9 +43,9 @@ entities.prototype.getResults = function(parameters, userKey, protocol, serviceU
     } else {
 
     // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/language.js b/lib/language.js
@@ -43,9 +43,9 @@ language.prototype.getResults = function(parameters, userKey, protocol, serviceU
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/morphology.js b/lib/morphology.js
@@ -43,11 +43,11 @@ morphology.prototype.getResults = function(parameters, userKey, protocol, servic
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
-        } else if (parameters.morphology == null) {
+        } else if (!parameters.morphology) {
             return callback(new RosetteException("badArgument", "Must supply type of morphology", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/nameDeduplication.js b/lib/nameDeduplication.js
@@ -42,7 +42,7 @@ nameDeduplication.prototype.getResults = function(parameters, userKey, protocol,
         return callback(new RosetteException("badArgument", "nameDeduplication does not support documentFile"));
     } else {
         // validate parameters
-        if (parameters.loadParams().names == null) {
+        if (!parameters.loadParams().names) {
             return callback(new RosetteException("badArgument", "Must supply a list of names for deduplication"));
         } else {
             // configure URL
diff --git a/lib/nameSimilarity.js b/lib/nameSimilarity.js
@@ -43,7 +43,7 @@ nameSimilarity.prototype.getResults = function(parameters, userKey, protocol, se
     } else {
 
         // validate parameters
-        if (parameters.loadParams().name1 == null || parameters.loadParams().name2 == null) {
+        if (!parameters.loadParams().name1 || !parameters.loadParams().name2) {
             return callback(new RosetteException("badArgument", "Must supply both name1 and name2 parameters to be matched."));
         } else {
             // configure URL
diff --git a/lib/nameTranslation.js b/lib/nameTranslation.js
@@ -43,9 +43,9 @@ nameTranslation.prototype.getResults = function(parameters, userKey, protocol, s
     } else {
 
         // validate parameters
-        if (parameters.loadParams().name == null) {
+        if (!parameters.loadParams().name) {
             return callback(new RosetteException("badArgument", "Must supply name parameter", "bad arguments"));
-        } else if (parameters.loadParams().targetLanguage == null) {
+        } else if (!parameters.loadParams().targetLanguage) {
             return callback(new RosetteException("badArgument", "Must supply target language parameter", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/relationships.js b/lib/relationships.js
@@ -43,9 +43,9 @@ relationships.prototype.getResults = function(parameters, userKey, protocol, ser
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         }
 
diff --git a/lib/sentences.js b/lib/sentences.js
@@ -43,9 +43,9 @@ sentences.prototype.getResults = function(parameters, userKey, protocol, service
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/sentiment.js b/lib/sentiment.js
@@ -43,9 +43,9 @@ sentiment.prototype.getResults = function(parameters, userKey, protocol, service
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
 
diff --git a/lib/syntax_dependencies.js b/lib/syntax_dependencies.js
@@ -44,9 +44,9 @@ syntax_dependencies.prototype.getResults = function(parameters, userKey, protoco
     } else {
 
     // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/textEmbedding.js b/lib/textEmbedding.js
@@ -43,9 +43,9 @@ textEmbedding.prototype.getResults = function(parameters, userKey, protocol, ser
     } else {
 
     // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/tokens.js b/lib/tokens.js
@@ -43,9 +43,9 @@ tokens.prototype.getResults = function(parameters, userKey, protocol, serviceURL
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
-        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
diff --git a/lib/topics.js b/lib/topics.js
@@ -0,0 +1,60 @@
+/**
+ * Rosette API.
+ *
+ * @copyright 2016-2017 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-2017 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
+function topics() {
+
+};
+
+/**
+ * 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
+ */
+topics.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
+
+    if (parameters.documentFile != null) {
+        parameters.loadFile(parameters.documentFile, parameters, userKey, protocol, serviceURL, "topics", callback);
+    } else {
+
+        // validate parameters
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
+            return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
+            return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
+        } else {
+            // configure URL
+            var urlParts = URL.parse(serviceURL + "topics");
+            var req = new rosetteRequest();
+            req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
+        }
+    }
+
+};
+
+module.exports = topics;
diff --git a/lib/transliteration.js b/lib/transliteration.js
@@ -43,7 +43,7 @@ transliteration.prototype.getResults = function(parameters, userKey, protocol, s
     } else {
 
         // validate parameters
-        if (parameters.loadParams().content == null) {
+        if (!parameters.loadParams().content) {
             return callback(new RosetteException("badArgument", "Must supply Content", "bad arguments"));
         }
 
diff --git a/tests/unittests.js b/tests/unittests.js
@@ -16,6 +16,7 @@ var categories = require("../lib/categories");
 var entities = require("../lib/entities");
 var morphology = require("../lib/morphology");
 var tokens = require("../lib/tokens");
+var topics = require("../lib/topics");
 var sentences = require("../lib/sentences");
 var info = require("../lib/info");
 var ping = require("../lib/ping");
@@ -165,7 +166,7 @@ describe("Name Deduplication Endpoint", function() {
             done();
         });
     });
-    
+
     it("successfully calls the name deduplication endpoint without threshold", function(done) {
         var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
 
@@ -174,7 +175,7 @@ describe("Name Deduplication Endpoint", function() {
             {"text": "Johnathon Smith", "language": "eng", "entityType": "PERSON"},
             {"text": "Fred Jones Smith", "language": "eng", "entityType": "PERSON"}
         ];
-        
+
         api.rosette("nameDeduplication", function(err, res) {
             chai.expect(err).to.be.null;
             chai.expect(res.name).to.equal('Rosette API');
@@ -921,3 +922,62 @@ describe("Error 409 Incompatible Binding Check", function() {
         });
     });
 });
+
+describe("Topics 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.1"})
+           .reply(200, JSON.parse(mockResponse));
+
+        nock('https://api.rosette.com', {"encodedQueryParams": true })
+           .post('/rest/v1/topics')
+           .query({"clientVersion": "1.1"})
+           .reply(200, JSON.parse(mockResponse));
+        done();
+    });
+
+    afterEach(function(done) {
+        nock.cleanAll();
+        done();
+    });
+
+    it("successfully calls the topics endpoint", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Some Content";
+
+        api.rosette("topics", function(err, res) {
+            chai.expect(err).to.be.null;
+            chai.expect(res.name).to.equal('Rosette API');
+            done();
+        });
+
+    });
+
+    it("detects content and contentUri are defined", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Sample Content";
+        api.parameters.contentUri = "http://some.url.com";
+
+        api.rosette("topics", 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();
+        });
+    });
+
+    it("detects neither content nor contentUri are defined", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+
+        api.rosette("topics", 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();
+        });
+    });
+});
+
