Merge pull request #49 from rosette-api/RCB-416_unify_entities

Unified entities and entities/linked

Author: cp2boston

README.md

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

examples/entities.js

@@ -15,7 +15,9 @@ var api = new Api(args.key, args.url);
 var endpoint = "entities";
 
 api.parameters.content = "Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS";
-
+api.parameters.genre = "social-media";
+// to improve performance, and if you don't need the QID, set this option
+// api.parameters.options = { "linkEntities": false };
 api.rosette(endpoint, function(err, res){
 	if(err){
 		console.log(err);

examples/entities_linked.js

@@ -39,12 +39,8 @@ function entities() {
 entities.prototype.getResults = function(parameters, userKey, serviceURL, callback) {
 
     if (parameters.loadParams().documentFile != null) {
-        if (parameters.loadParams().linked == true) {
-            parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, serviceURL, "entities/linked", callback);
-        } else {
-            parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, serviceURL, "entities", callback);
-        }
-        
+        parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, serviceURL, "entities", callback);
+    
     } else {
 
     // validate parameters
@@ -54,11 +50,8 @@ entities.prototype.getResults = function(parameters, userKey, serviceURL, callba
             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
         } else {
             // configure URL
-            if (parameters.loadParams().linked == true) {
-                var urlParts = URL.parse(serviceURL + "entities/linked");
-            } else {
-                urlParts = URL.parse(serviceURL + "entities");
-            }
+            var urlParts = URL.parse(serviceURL + "entities");
+            
             var req = new rosetteRequest();
             req.makeRequest('POST', userKey, urlParts, parameters, callback);
         }

lib/entities.js

@@ -63,9 +63,6 @@ function parameters() {
     this.options = null;
     this.accuracyMode = null;
 
-    //entities parameters
-    this.linked = null;
-
     //sentiment parameters
     this.explain = null;
     this.shortString = null;
@@ -101,7 +98,6 @@ parameters.prototype.loadParams = function() {
         "targetScript": this.targetScript,
         "targetScheme": this.targetScheme,
         "options": this.options,
-        "linked": this.linked,
         "explain": this.explain,
         "short-string": this.shortString,
         "morphology": this.morphology,

lib/parameters.js

@@ -75,8 +75,8 @@ rosetteRequest.prototype.makeRequest = function(requestType, userKey, urlParts,
         headers["X-RosetteAPI-Key"] = userKey;
     }
 
-    if(parameters.customHeaders != null){
-        parameters.customHeaders.forEach( function(element, index) {
+    if (parameters.customHeaders != null) {
+        parameters.customHeaders.forEach(function(element, index) {
             headers[element[0]] = element[1];
         });
 

lib/rosetteRequest.js

@@ -421,68 +421,6 @@ 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});