Merge pull request #58 from kbailey-basistech/RCB-473_Syntax-Dependencies

syntax dependencies added

Author: cp2boston

examples/syntax_dependencies.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 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 = "syntax_dependencies";
+var syntax_dependencies_data = "Sony Pictures is planning to shoot a good portion of the new \"Ghostbusters\" in Boston as well.";
+
+api.parameters.content = syntax_dependencies_data;
+api.parameters.genre = "social-media";
+api.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
+});

index.js

@@ -28,3 +28,4 @@ module.exports.tokens = require("./lib/tokens");
 
 module.exports.translatedName = require("./lib/nameTranslation");
 
+module.exports.syntax_dependencies = require("./lib/syntax_dependencies");

lib/Api.js

@@ -34,6 +34,7 @@ var sentiment = require("./sentiment");
 var textEmbedding = require("./textEmbedding");
 var translatedName = require("./nameTranslation");
 var tokens = require("./tokens");
+var syntax_dependencies = require("./syntax_dependencies");
 
 /**
  * @class

lib/syntax_dependencies.js

@@ -0,0 +1,64 @@
+/**
+ * Rosette API.
+ *
+ * @copyright 2014-2015 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 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
+function syntax_dependencies() {
+
+};
+
+/**
+ * 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
+ */
+syntax_dependencies.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
+
+    if (parameters.documentFile != null) {
+        parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, protocol, serviceURL, "syntax/dependencies", callback);
+    
+    } else {
+
+    // validate parameters
+        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+            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 both Content and ContentUri", "bad arguments"));
+        } else {
+            // configure URL
+            var urlParts = URL.parse(serviceURL + "syntax/dependencies");
+        }
+
+            
+            var req = new rosetteRequest();
+            req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
+            
+    }
+
+};
+
+module.exports = syntax_dependencies;

tests/unittests.js

@@ -18,6 +18,7 @@ var tokens = require("../lib/tokens");
 var sentences = require("../lib/sentences");
 var info = require("../lib/info");
 var ping = require("../lib/ping");
+var syntax_dependencies = require("../lib/syntax_dependencies");
 var paramObj = require("../lib/parameters");
 var rosetteException = require("../lib/rosetteExceptions");
 
@@ -669,6 +670,65 @@ describe("Text Embedding Endpoint", function() {
 
 });
 
+describe("Syntactic Dependencies 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/syntax/dependencies')
+           .query({"clientVersion": "1.1"})
+           .reply(200, JSON.parse(mockResponse));
+        done();
+    });
+
+    afterEach(function(done) {
+        nock.cleanAll();
+        done();
+    });
+    
+    it("successfully calls the syntactic dependencies endpoint", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Some Content";
+
+        api.rosette("syntax_dependencies", 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("syntax_dependencies", 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("syntax_dependencies", 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("Info Endpoint", function() {
     beforeEach(function(done) {
         var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});