Merge branch 'develop'

Author: Chris Park

.gitmodules

@@ -4,13 +4,7 @@ node_js:
   - "0.12.7"
   - "1.0.4"
   - "4.2.2"
-# Handle git submodules yourself
-git:
-    submodules: false
-# Use sed to replace the SSH URL with the public URL, then initialize submodules
 before_install:
-  - sed -i 's/[email protected]:/https:\/\/github.com\//' .gitmodules
-  - git submodule update --init --recursive  
   - npm install -g npm
 before_script:
   - npm install grunt-cli -g
@@ -19,6 +13,6 @@ notifications:
   slack:
     rooms:
       - secure: 4FRaTAAiYyeUvgw2RhmblgbNiJO4wmd34OBgWcwURjP9oVmFfSwR9r1LNCdUGxrPOghexSY2DjXIuvIrfTfi/xYbhHb3Kw7PEAyB8IuBMlKtY4NSFou62S2VhYpxyg58T+C7P2zi0eDnDE06pwTCoGPaimxMZQY91yQ0yPYDPVXbwe5SjEgamzlwGBxlS/0A6w1iCPHg27/iO2hXtdW3oLS2I0F/Q8Q95RBkX9hpg6yqHlTV7jRbSqvQ9OFBqk/tXMHQvhoPDGgCgQDuykJuaAYx7g9d0YL0eEYYOh9B/TJ/kNOwdRFBu5kuQ2/nFS5Z0S3Y3UIhdYjUmm9gSMnwIbYnrW22EqDJLoT9Zi3Gv7Prg/8/fSkWsof7BJTMSuXUqO1AxDGKIxFv9uSF1daZoY+AC1ooU1xDu1nNvWVYPlkwEdDxxmHpFkGT3ESTZYccPovQl8Z5K0I1BBAVdJKDzm07lE6VHbxkKcvK6gG0TN3uLxnSlQtjkfJ+aVMq1kxeVsB9lEsKs9oezsKzzbftMm525aXPg+OAv+31CUFWxvT/p4ps8Q+AV6aZpoPHkpK8VryyNirUeZ/m4m4ebDHhD9vcN+JqE9gzshT+0U3g19SvLiUMQtbuZ2BUvrq2hh2LEGs03AFZaNg9AEUVA1PQRhV5NILyoS/lbiBYJPT39Sg=
-      - secure: D4VxkkZlj7uaaFbqEBITkJCusVeii436N8X6GijuosUSaee9lqGYUF5ZS9lV6VGMKs719IfSJsCc2v/N4nc9Y/8AKgXd7AWHUwaRR+MC6rLwv9xqH8ZlkTPUKHUXkUQe1f9042PcMxzYa9r0+uKniM9l915Yx0PLaawJrWe3ZVig/uBhn5FueLhtUACzLJcjNcri/BKEgmP2+EgUsupUhujd0MsQd8xN5YIIv6VM5oD0XWXZCnBqHoZK+Qq7LfwDnTmUk7juqTOAjefF6v8IJTDELvSdK9QW7f9x7h0ICabIrI+Gl4IbNLJYEnELBi+X7da2YJUTgUoQrlBB4z+T8KybD8myqV/pJc1n0xrk84g1MtYQ3ahZn7eD3DTjIvK+ML8qAAGwxibF8VsV+GSoo5FcB6e3vV+glHODlwszstVs11PpL1grurVdoa5HPhUbm1jtQixOwO7h8GgGpwO20PuMLfyOfTjfoMcJ3ISjGNHRmUwcCH9avcaHqMLPLHht0z+8inVlDZeTcN+Wi8tk1YXwuQYUkTW46iFmoZNGdygRjTu43h9hCqdG7vcoKrR8oDbMT8X/sfs+z/UaBbuYBr9dT8rrdKJoa9115PaYpCs529DLrw1iGmzr5CkAXDElc1y2F352nwVS+dX7/OIQz1/dbT1ozWQ9Blx6ez5XN84=
-      - secure: g/eOC2QCn7oUW234u/P1kmh9OASO9t5g6iC+DflNdnedHnpw8IEG9CsLAnNynOY0KvC/2/Q6BAIFpT/qO8BPdaC2eQnd9LDurOXExxvjKZgTujhqgzijJGzVPSL8//hafj0Ec2+iJZFo/DYMPqUpYDsiKxX53+SMz9/GN/PKVKsI7bzuaOm04xXktU0A76pVfaG0N/qFSVHI64SShACoUXRpTzyUbmksRgzk7FB162R+TH1soPsR3vPh8c2SSWC9msrDc4iljcBhSFTdjL68z+srjDPYMSoOcFXXFNP+dmL+Q0veL/E4e40e7CWIU1O3grOcEcCkaSoZVSpGduNnCst8h6MpgauPtrgwHk4zGMoSl+L6al+nFo/3h2dXeebrQ0tY/hRfZi4Q8xwqG9083TBqi71fTpoFZ7sNtrY4Kdtl5Oa2CFUo7lVn1JB9qQwSa0eai3Whv0RyRqqQe77aDUj0dfD2R3Q61rX5OF/f++W0XtNwHQubzmj8HD/cFneShIQsbl9KgYXoR6HiXcbBiNdmmZjSrzkPYh7vlsujYrz6Cg2msKybWJ/FfOz0tS1cjlCtiCMOTExN6tEF8YCp9l+s+5RLe61pgFPy4Snr9pEjuTS5DYliTyZMY2ZZC1clBQtgE8E2qCG1QSzqnqqiGxj2K4zmLPpB4y1XpW8e3yk=
+#      - secure: D4VxkkZlj7uaaFbqEBITkJCusVeii436N8X6GijuosUSaee9lqGYUF5ZS9lV6VGMKs719IfSJsCc2v/N4nc9Y/8AKgXd7AWHUwaRR+MC6rLwv9xqH8ZlkTPUKHUXkUQe1f9042PcMxzYa9r0+uKniM9l915Yx0PLaawJrWe3ZVig/uBhn5FueLhtUACzLJcjNcri/BKEgmP2+EgUsupUhujd0MsQd8xN5YIIv6VM5oD0XWXZCnBqHoZK+Qq7LfwDnTmUk7juqTOAjefF6v8IJTDELvSdK9QW7f9x7h0ICabIrI+Gl4IbNLJYEnELBi+X7da2YJUTgUoQrlBB4z+T8KybD8myqV/pJc1n0xrk84g1MtYQ3ahZn7eD3DTjIvK+ML8qAAGwxibF8VsV+GSoo5FcB6e3vV+glHODlwszstVs11PpL1grurVdoa5HPhUbm1jtQixOwO7h8GgGpwO20PuMLfyOfTjfoMcJ3ISjGNHRmUwcCH9avcaHqMLPLHht0z+8inVlDZeTcN+Wi8tk1YXwuQYUkTW46iFmoZNGdygRjTu43h9hCqdG7vcoKrR8oDbMT8X/sfs+z/UaBbuYBr9dT8rrdKJoa9115PaYpCs529DLrw1iGmzr5CkAXDElc1y2F352nwVS+dX7/OIQz1/dbT1ozWQ9Blx6ez5XN84=
+#      - secure: g/eOC2QCn7oUW234u/P1kmh9OASO9t5g6iC+DflNdnedHnpw8IEG9CsLAnNynOY0KvC/2/Q6BAIFpT/qO8BPdaC2eQnd9LDurOXExxvjKZgTujhqgzijJGzVPSL8//hafj0Ec2+iJZFo/DYMPqUpYDsiKxX53+SMz9/GN/PKVKsI7bzuaOm04xXktU0A76pVfaG0N/qFSVHI64SShACoUXRpTzyUbmksRgzk7FB162R+TH1soPsR3vPh8c2SSWC9msrDc4iljcBhSFTdjL68z+srjDPYMSoOcFXXFNP+dmL+Q0veL/E4e40e7CWIU1O3grOcEcCkaSoZVSpGduNnCst8h6MpgauPtrgwHk4zGMoSl+L6al+nFo/3h2dXeebrQ0tY/hRfZi4Q8xwqG9083TBqi71fTpoFZ7sNtrY4Kdtl5Oa2CFUo7lVn1JB9qQwSa0eai3Whv0RyRqqQe77aDUj0dfD2R3Q61rX5OF/f++W0XtNwHQubzmj8HD/cFneShIQsbl9KgYXoR6HiXcbBiNdmmZjSrzkPYh7vlsujYrz6Cg2msKybWJ/FfOz0tS1cjlCtiCMOTExN6tEF8YCp9l+s+5RLe61pgFPy4Snr9pEjuTS5DYliTyZMY2ZZC1clBQtgE8E2qCG1QSzqnqqiGxj2K4zmLPpB4y1XpW8e3yk=
 

.travis.yml

@@ -30,11 +30,10 @@ api.rosette(endpoint, function(err, res){
 | -------------                 |-------------                                        |------------- 
 | content                    | categories, entities, language, morphology, relationships, sentences, sentiment, tokens            | Either content or contentUri required |
 | contentUri                      | categories, entities, language, morphology, relationships, sentences, sentiment, tokens       | Either content or contentUri required |
-| contentType               | categories, entities, language, morphology, relationships, sentences, sentiment, tokens | No |
-| language                          | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, matchedName                    | No |
+| language                          | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, name similarity                    | No |
 | documentFile                      | categories, entities, language, morphology, relationships, sentences, sentiment, tokens                  | No |
-| name1                 | name matching               | Yes |
-| name2               | name matching| Yes |
+| name1                 | name similarity               | Yes |
+| name2               | name similarity| Yes |
 | name    | name translation     | Yes |
 | targetLanguage           | name translation           | Yes |
 | entityType                 | name translation         | No |

CHANGES.txt

@@ -6,6 +6,7 @@ RUN apt-get -y update && apt-get install -y git && apt-get install -y vim && apt
 
 ENV API_KEY api_key
 
+RUN mkdir /nodejs-dev
 COPY runAll.sh /nodejs-dev/runAll.sh
 RUN chmod 755 /nodejs-dev/runAll.sh
 
@@ -14,4 +15,4 @@ WORKDIR /nodejs-dev
 
 CMD ./runAll.sh $API_KEY $FILENAME $ALT_URL $GIT_USERNAME $VERSION
 
-VOLUME ["/source"]
+VOLUME ["/source"]

README.md

@@ -1,5 +1,10 @@
 #!/bin/bash
 
+ping_url="https://api.rosette.com/rest/v1/"
+retcode=0
+
+#------------------- Functions -------------------------------------
+
 #Gets called when the user doesn't provide any args
 function HELP {
     echo -e "\nusage: source_file.py --key API_KEY [--url ALT_URL]"
@@ -12,6 +17,55 @@ function HELP {
     exit 1
 }
 
+#Checks if Rosette API key is valid
+function checkAPI() {
+    match=$(curl "${ping_url}ping" -H "X-RosetteAPI-Key: ${API_KEY}" |  grep -o "forbidden")
+    if [ ! -z $match ]; then
+        echo -e "\nInvalid Rosette API Key"
+        exit 1
+    fi  
+}
+
+# add the trailing slash of the alt_url if necessary
+function cleanURL() {
+    if [ ! -z "${ALT_URL}" ]; then
+        if [[ ! ${ALT_URL} == */ ]]; then
+            ALT_URL="${ALT_URL}/"
+            echo "No Slash detected"
+        fi
+        ping_url=${ALT_URL}
+    fi
+}
+
+#Checks for valid url
+function validateURL() {
+    match=$(curl "${ping_url}ping" -H "X-RosetteAPI-Key: ${API_KEY}" |  grep -o "Rosette API")
+    if [ "${match}" = "" ]; then
+        echo -e "\n${ping_url} server not responding\n"
+        exit 1
+    fi  
+}
+
+function runExample() {
+    echo -e "\n---------- ${1} start -------------"
+    result=""
+    if [ -z ${ALT_URL} ]; then
+        result="$(node ${1} --key ${API_KEY} 2>&1 )"
+    else
+        result="$(node ${1} --key ${API_KEY} --url ${ALT_URL} 2>&1 )"
+    fi
+    echo "${result}"
+    echo -e "\n---------- ${1} end -------------"
+    if [[ $result == *"Exception"* ]]; then
+        retcode=1
+    elif [[ $result == *"processingFailure"* ]]; then
+        retcode=1
+    fi
+}
+
+
+#------------------- Functions End ----------------------------------
+
 #Gets API_KEY, FILENAME and ALT_URL if present
 while getopts ":API_KEY:FILENAME:ALT_URL:GIT_USERNAME:VERSION" arg; do
     case "${arg}" in
@@ -38,38 +92,28 @@ while getopts ":API_KEY:FILENAME:ALT_URL:GIT_USERNAME:VERSION" arg; do
     esac
 done
 
-#Checks if Rosette API key is valid
-function checkAPI {
-    match=$(curl "https://api.rosette.com/rest/v1/ping" -H "user_key: ${API_KEY}" |  grep -o "forbidden")
-    if [ ! -z $match ]; then
-        echo -e "\nInvalid Rosette API Key"
-        exit 1
-    fi  
-}
+cleanURL
+
+validateURL
 
 #Copy the mounted content in /source to current WORKDIR
-cp -r -n /source/* .
+cp -r -n /source/. .
 
 #Run unit tests
 
-cd mock-data
-mkdir status
-mkdir other
-cd response
-find . -name "*.status" -exec mv {} ../status \;
-find . -name "info.json" -exec mv {} ../other \;
-find . -name "ping.json" -exec mv {} ../other \;
-find . -name "checkVersion.json" -exec mv {} ../other \;
-find . -name "retry-fail.json" -exec mv {} ../other \;
-find . -name "bad_info.json" -exec mv {} ../other \;
-
-cd ../../tests
+cd tests
 npm install -g mocha
 npm install mocha
 npm install -g istanbul
 npm install chai
 npm install nock
+npm install -g eslint
+npm install multipart-stream
 istanbul cover _mocha unittests.js
+#run eslint
+eslint ../lib/**
+
+
 
 #Run the examples
 if [ ! -z ${API_KEY} ]; then
@@ -79,24 +123,17 @@ if [ ! -z ${API_KEY} ]; then
     npm install argparse
     npm install temporary
     if [ ! -z ${FILENAME} ]; then
-        if [ ! -z ${ALT_URL} ]; then
-	    node ${FILENAME} --key ${API_KEY} --url ${ALT_URL} 
-	else
-	   node ${FILENAME} --key ${API_KEY} 
-   	fi
-    elif [ ! -z ${ALT_URL} ]; then
-    	find . -name '*.js' -exec node {} --key ${API_KEY} --url ${ALT_URL} \;
+        runExample ${FILENAME}
     else
-	find . -name '*.js' -exec node {} --key ${API_KEY} \;
+        for file in *.js; do
+            runExample $file
+        done
     fi
 else 
     HELP
+    retcode=1
 fi
 
-#run eslint
-npm install -g eslint
-eslint ../lib/**
-
 #Generate gh-pages and push them to git account (if git username is provided)
 if [ ! -z ${GIT_USERNAME} ] && [ ! -z ${VERSION} ]; then
    #clone nodejs git repo
@@ -116,4 +153,7 @@ if [ ! -z ${GIT_USERNAME} ] && [ ! -z ${VERSION} ]; then
    git add .
    git commit -a -m "publish grunt apidocs ${VERSION}"
    git push
-fi
+fi
+
+exit ${retcode}
+

docker/Dockerfile

@@ -7,8 +7,11 @@ RUN apt-get -y update && apt-get install -y git && apt-get install -y vim && apt
 ENV API_KEY api_key
 
 #set the working directory
-WORKDIR /source/examples
+RUN mkdir /nodejs-dev
+WORKDIR /nodejs-dev
+COPY runAll.sh /nodejs-dev/runAll.sh
 
-CMD ./runAll.sh $API_KEY $FILENAME $ALT_URL; /bin/bash
+CMD chmod 0755 ./runAll.sh && ./runAll.sh $API_KEY $FILENAME $ALT_URL
+
+VOLUME ["/source"]
 
-VOLUME ["/source"]

docker/runAll.sh

@@ -1,25 +1,25 @@
-"use strict";
-
-var Api = require("../lib/Api");
-var ArgumentParser = require("argparse").ArgumentParser;
-
-var parser = new ArgumentParser({
-  addHelp: true,
-  description: "Get the category of a piece of a document at a URL"
-});
-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);
-var endpoint = "categories";
-
-var categories_url_data = "http://www.onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/";
-api.parameters.contentUri = categories_url_data;
-
-api.rosette(endpoint, function(err, res){
-	if(err){
-		console.log(err);
-	} else {
-		console.log(JSON.stringify(res, null, 2));
-	}
+"use strict";
+
+var Api = require("../lib/Api");
+var ArgumentParser = require("argparse").ArgumentParser;
+
+var parser = new ArgumentParser({
+  addHelp: true,
+  description: "Get the category of a piece of a document at a URL"
+});
+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 = "categories";
+
+var categories_url_data = "http://www.onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/";
+api.parameters.contentUri = categories_url_data;
+
+api.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
 });

examples/Dockerfile

@@ -1,25 +1,25 @@
-"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);
-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.rosette(endpoint, function(err, res){
-	if(err){
-		console.log(err);
-	} else {
-		console.log(JSON.stringify(res, null, 2));
-	}
+"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 = "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.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
 });