restoring entities/linked

Author: Hannah

README.md

@@ -44,6 +44,7 @@ api.rosette(endpoint, function(err, res){
 | targetScheme                        | name translation          | No |
 | options              | relationships        | No |
 | accuracyMode              | relationships        | Yes |
+| linked (deprecated)             | entities        | No |
 | linkEntities              | entities        | No |
 | explain              | sentiment        | No |
 | morphology             | morphology        | Yes |

examples/entities_linked.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 linked entities from 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  = "entities";
+
+api.parameters.content = "Last month director Paul Feig announced the movie will have an all-star female cast including Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon.";
+api.parameters.linked = true;
+api.parameters.genre = "social-media";
+
+api.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
+});

lib/entities.js

@@ -19,6 +19,8 @@ var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
 var rosetteRequest = require("./rosetteRequest");
 
+const util = require('util');
+
 /**
  * @class
  *
@@ -39,7 +41,14 @@ function entities() {
 entities.prototype.getResults = function(parameters, userKey, serviceURL, callback) {
 
     if (parameters.documentFile != null) {
-        parameters.loadFile(parameters.documentFile, parameters, userKey, serviceURL, "entities", callback);
+        if (parameters.loadParams().linked == true) {
+            console.log("entities/linked endpoint is deprecated and has been combined with entities. no need to specify param linked.");
+            util.deprecate(parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, serviceURL, "entities/linked", callback),"entities/linked endpoint is deprecated and combined with /entities");
+        } else {
+            parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, serviceURL, "entities", callback);
+        }
+        
+
 
     } else {
 
@@ -50,10 +59,17 @@ entities.prototype.getResults = function(parameters, userKey, serviceURL, callba
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
-            var urlParts = URL.parse(serviceURL + "entities");
+            if (parameters.loadParams().linked == true) {
+                console.log("entities/linked endpoint is deprecated and has been combined with entities. no need to specify param linked.");
+                var urlParts = URL.parse(serviceURL + "entities/linked");
+            } else {
+                urlParts = URL.parse(serviceURL + "entities");
+            }
+
 
             var req = new rosetteRequest();
             req.makeRequest('POST', userKey, urlParts, parameters, callback);
+            
         }
     }
 

lib/parameters.js

@@ -63,6 +63,9 @@ function parameters() {
     this.options = null;
     this.accuracyMode = null;
 
+    //entities parameters
+    this.linked = null;
+
     //sentiment parameters
     this.explain = null;
     this.shortString = null;

tests/unittests.js

@@ -421,6 +421,69 @@ describe("Entities Endpoint", function() {
 
 });
 
+describe("Entities Linked 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/entities/linked')
+           .query({"clientVersion":"1.1"})
+           .reply(200, JSON.parse(mockResponse));
+        done();
+    });
+
+    afterEach(function(done) {
+        nock.cleanAll();
+        done();
+    });
+    
+    it("successfully calls the entities linked endpoint", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Some Content";
+        api.parameters.linked = true;
+
+        api.rosette("entities", 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.parameters.linked = true;
+
+        api.rosette("entities", 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.parameters.linked = true;
+
+        api.rosette("entities", 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("Morphology Endpoint (suite covers all features)", function() {
     beforeEach(function(done) {
         var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});