Merge branch 'develop'

Author: Chris Park

.travis.yml

@@ -4,6 +4,8 @@ node_js:
   - "0.12.7"
   - "1.0.4"
   - "4.2.4"
+  - "4.4.7"
+  - "6.3.0"
 before_install:
   - npm install -g npm
 before_script:

README.md

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

docker/Dockerfile

@@ -4,6 +4,8 @@ MAINTAINER Sam Hausmann
 #install necessary packages
 RUN apt-get -y update && apt-get install -y git && apt-get install -y vim && apt-get install -y curl
 
+RUN npm install -g grunt-cli && npm install -g eslint
+
 ENV API_KEY api_key
 
 RUN mkdir /nodejs-dev
@@ -13,5 +15,5 @@ RUN chmod 0755 /nodejs-dev/runAll.sh
 #set the working directory
 WORKDIR /nodejs-dev
 
-CMD ./runAll.sh $API_KEY $FILENAME $ALT_URL $GIT_USERNAME $GIT_EMAIL $VERSION
+CMD ./runAll.sh
 VOLUME ["/source"]

docker/README.md

@@ -9,4 +9,4 @@ Build the docker image, e.g. `docker build -t basistech/nodejs:1.1 .`
 
 Run an example as `docker run -e API_KEY=api-key -v "path-to-local-nodejs-dir:/source" basistech/nodejs:1.1`
 
-To test against a specific source file, add `-e FILENAME=filename` before the `-v`, to test against an alternate url, add `-e ALT_URL=alternate_url`, and optionally if you would like to regenerate gh-pages from the changes made to the development source you can add `-e GIT_USERNAME=git-username -e VERSION=version` before the `-v`. In order to push the gh-pages to git remember to mount .ssh and .gitconfig to the root dir `-v path-to-.ssh-dir:/root/.ssh -v path-to-.gitconfig:/root/.gitconfig`.
+To test against a specific source file, add `-e FILENAME=filename` before the `-v`, to test against an alternate url, add `-e ALT_URL=alternate_url`.

docker/runAll.sh

@@ -2,6 +2,7 @@
 
 ping_url="https://api.rosette.com/rest/v1/"
 retcode=0
+errors=( "Exception" "processingFailure" "badRequest" "ParseError" "ValueError" "SyntaxError" "AttributeError" "ImportError" )
 
 #------------------- Functions -------------------------------------
 
@@ -11,12 +12,14 @@ function HELP {
     echo "  API_KEY       - Rosette API key (required)"
     echo "  FILENAME      - Python source file (optional)"
     echo "  ALT_URL       - Alternate service URL (optional)"
-    echo "  GIT_USERNAME  - Git username where you would like to push regenerated gh-pages (optional)"
-    echo "  VERSION       - Build version (optional)"
     echo "Compiles and runs the source file(s) using the local development source."
     exit 1
 }
 
+if [ ! -z ${ALT_URL} ]; then
+    ping_url=${ALT_URL}
+fi
+
 #Checks if Rosette API key is valid
 function checkAPI() {
     match=$(curl "${ping_url}ping" -H "X-RosetteAPI-Key: ${API_KEY}" |  grep -o "forbidden")
@@ -56,38 +59,27 @@ function runExample() {
     fi
     echo "${result}"
     echo -e "\n---------- ${1} end -------------"
-    if [[ $result == *"Exception"* ]]; then
-        retcode=1
-    elif [[ $result == *"processingFailure"* ]]; then
-        retcode=1
-    fi
+    for err in "${errors[@]}"; do 
+        if [[ ${result} == *"${err}"* ]]; then
+            retcode=1
+        fi
+    done
 }
 
 
 #------------------- Functions End ----------------------------------
 
 #Gets API_KEY, FILENAME and ALT_URL if present
-while getopts ":API_KEY:FILENAME:ALT_URL:GIT_USERNAME:VERSION" arg; do
+while getopts ":API_KEY:FILENAME:ALT_URL" arg; do
     case "${arg}" in
         API_KEY)
             API_KEY=${OPTARG}
-            usage
             ;;
         ALT_URL)
             ALT_URL=${OPTARG}
-            usage
             ;;
         FILENAME)
             FILENAME=${OPTARG}
-            usage
-            ;;
-        GIT_USERNAME)
-            GIT_USERNAME=${OPTARG}
-            usage
-            ;;
-        VERSION)
-            VERSION={OPTARG}
-            usage
             ;;
     esac
 done
@@ -100,15 +92,11 @@ validateURL
 cp -r -n /source/. .
 
 #Run unit tests
-npm install -g grunt-cli
-npm install -g eslint
 npm install
 grunt test
 #run eslint
 eslint lib/*.js
 
-
-
 #Run the examples
 if [ ! -z ${API_KEY} ]; then
     checkAPI
@@ -117,8 +105,10 @@ if [ ! -z ${API_KEY} ]; then
     npm install argparse
     npm install temporary
     if [ ! -z ${FILENAME} ]; then
+        echo -e "\nRunning example against: ${ping_url}\n"
         runExample ${FILENAME}
     else
+        echo -e "\nRunning examples against: ${ping_url}\n"
         for file in *.js; do
             runExample $file
         done
@@ -128,11 +118,5 @@ else
     retcode=1
 fi
 
-#Generate gh-pages and push them to git account (if git username is provided)
-if [ ! -z ${GIT_USERNAME} ]; then
-
-grunt doc
-fi
-
 exit ${retcode}
 

examples/entities.js

@@ -15,7 +15,7 @@ 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";
 api.rosette(endpoint, function(err, res){
 	if(err){
 		console.log(err);

examples/entities_linked.js

@@ -14,6 +14,7 @@ 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.";
+// this parameter is deprecated
 api.parameters.linked = true;
 api.parameters.genre = "social-media";
 
@@ -23,4 +24,4 @@ api.rosette(endpoint, function(err, res){
 	} else {
 		console.log(JSON.stringify(res, null, 2));
 	}
-});
+});

examples/language.js

@@ -20,6 +20,10 @@ api.parameters.customHeaders = [appHeader];
 var content = "Por favor Señorita, says the man.";
 
 api.parameters.content = content;
+var appHeader = [];
+appHeader[0] = "X-RosetteAPI-App"
+appHeader[1] = "app";
+api.parameters.customHeaders = [appHeader];
 
 api.rosette(endpoint, function(err, res){
 	if(err){

lib/.Rhistory

@@ -30,13 +30,6 @@ var language = require("./language");
 var ping = require("./ping");
 var info = require("./info");
 
-/**
- * Compatible server version.
- *
- * @type string
- */
-var BINDING_VERSION = "1.1";
-
 /**
  * @class
  *