Merge branch 'master' of https://github.com/watson-developer-cloud/nodejs-wrapper

herchu · herchu · commit 70fbef85b04b · 2015-09-10T15:30:59.000-03:00
diff --git a/.jshintignore b/.jshintignore
diff --git a/.jshintrc b/.jshintrc
@@ -15,8 +15,7 @@
   },
 
   "node" : true,
-  "es5" : true,
-  "browser" : true,
+  "browser" : false,
 
   "boss" : false,
   "curly": false,
@@ -26,7 +25,6 @@
   "evil": true,
   "forin": false,
   "immed": true,
-  "maxlen": 100,
   "indent": 2,
   "quotmark": "single",
   "laxbreak": false,
@@ -43,4 +41,4 @@
   "strict": true,
   "white": true,
   "unused": true
-}
+}
diff --git a/README.md b/README.md
@@ -191,14 +191,11 @@ var watson = require('watson-developer-cloud');
 var concept_insights = watson.concept_insights({
   username: '<username>',
   password: '<password>',
-  version: 'v1'
+  version: 'v2'
 });
 
-/*** Annotate Text ***/
-
 var params = {
-  user: 'wikipedia',
-  graph: 'en-20120601',
+  graph: '/graphs/wikipedia/en20120601',
   text: 'IBM Watson won the Jeopardy television show hosted by Alex Trebek'
 };
 
@@ -207,32 +204,9 @@ concept_insights.annotateText(params, function(err, res) {
   if (err)
     console.log(err);
   else {
-    console.log("\n*** Annotate Text ***\n");
     console.log(JSON.stringify(res, null, 2));
   }
 });
-
-/*** Semantic Search ***/
-
-var payload = {
-  func: 'semanticSearch',
-  ids: [
-    '/graph/wikipedia/en-20120601/Software_development_process',
-    '/graph/wikipedia/en-20120601/Programming_tool'
-  ],
-  corpus: 'ibmresearcher',
-  user: 'public',
-  limit: 5
-};
-
-concept_insights.semanticSearch(payload, function(error, results) {
-  if (error)
-    console.log(error);
-  else {
-    console.log("\n*** Semantic Search ***\n");
-    console.log(JSON.stringify(results, null, 2));
-  }
-});
 ```
 
 ### Dialog
@@ -327,7 +301,7 @@ var natural_language_classifier = watson.natural_language_classifier({
 
 natural_language_classifier.classify({
   text: 'Is it sunny?',
-  classifier: '<classifier-id>' },
+  classifier_id: '<classifier-id>' },
   function(err, response) {
     if (err)
       console.log('error:', err);
diff --git a/examples/concept_insights.v2.js b/examples/concept_insights.v2.js
@@ -0,0 +1,24 @@
+'use strict';
+
+var watson = require('watson-developer-cloud');
+
+var concept_insights = watson.concept_insights({
+  username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
+  password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE',
+  version: 'v2'
+});
+
+var params = {
+  graph: '/graphs/wikipedia/en20120601',
+  text: 'IBM Watson won the Jeopardy television show hosted by Alex Trebek'
+};
+
+// Retrieve the concepts for input text
+concept_insights.annotateText(params, function(err, res) {
+  if (err)
+    console.log(err);
+  else {
+    console.log('Annotated Text');
+    console.log(JSON.stringify(res, null, 2));
+  }
+});
diff --git a/examples/natural_language_classifier.v1.js b/examples/natural_language_classifier.v1.js
@@ -29,7 +29,7 @@ natural_language_classifier.create(params, function(err, response) {
 // Using a classifier
 natural_language_classifier.classify({
   text: 'Is it sunny?',
-  classifier: '<classifier-id>' }, // from the previous command
+  classifier_id: '<classifier-id>' }, // from the previous command
   function(err, response) {
     if (err)
       console.log('error:', err);
diff --git a/examples/retrieve_and_rank_lifecycle.v1.js b/examples/retrieve_and_rank_lifecycle.v1.js
@@ -21,7 +21,7 @@ async.series([
   },
 
   function createCluster(done) {
-    retrieve.createCluster({}, function getId(err, res) {
+    retrieve.createCluster({cluster_name: 'example_cluster', cluster_size: '1'}, function getId(err, res) {
       if (err) {
         return console.log('Error creating Solr cluster: ' + JSON.stringify(err));
       }
diff --git a/lib/helper.js b/lib/helper.js
@@ -62,7 +62,7 @@ module.exports = {
     for(var i = 0; i < formats.length; i++) {
       if (formats[i] in params)
         return formats[i];
-    };
+    }
     return null;
   }
-};
+};
diff --git a/lib/index.js b/lib/index.js
@@ -45,7 +45,7 @@ function createServiceAPI(serviceName) {
     }
 
     // Get credentials from Bluemix
-    if (options.use_vcap_services != false) {
+    if (options.use_vcap_services !== false) {
       var service = bluemix.serviceStartsWith(serviceName);
       options = extend({}, options, service.credentials);
     }
@@ -55,7 +55,7 @@ function createServiceAPI(serviceName) {
       pass = options.password,
       api_key = options.api_key;
 
-    if (typeof(options.use_unauthenticated) === 'undefined' ||  options.use_unauthenticated == false) {
+    if (!options.use_unauthenticated) {
       // Check if 'api_key' or 'username' and 'password' were provided
       if (typeof api_key === 'undefined') {
         if (typeof user === 'undefined' || typeof pass === 'undefined') {
@@ -83,7 +83,11 @@ function createServiceAPI(serviceName) {
       var s = new Service(options);
       return Object.freeze(s);
     } catch (e) {
-      throw new Error(util.format('Argument error: %s not found for: %s', version, serviceName));
+      if (e.code === 'MODULE_NOT_FOUND') {
+        throw new Error(util.format('Service %s %s not found', serviceName, version));
+      } else {
+        throw e;
+      }
     }
   };
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "watson-developer-cloud",
-  "version": "0.9.29",
+  "version": "0.9.30",
   "description": "Nodejs Client Wrapper to use the IBM Watson and Services",
   "main": "./lib/index",
   "repository": {
@@ -68,6 +68,7 @@
     "csv-stringify": "~0.0.8",
     "extend": "~3.0.0",
     "isstream": "~0.1.2",
+    "jshint": "^2.8.0",
     "object.omit": "~2.0.0",
     "object.pick": "~1.1.1",
     "request": "~2.61.0",
@@ -78,7 +79,7 @@
     "node": ">=0.10"
   },
   "scripts": {
-    "test": "mocha --reporter spec --timeout 4000",
+    "test": "jshint --exclude node_modules/ **/*.js && mocha --reporter spec --timeout 4000",
     "prepare": "npm test && npm version patch",
     "coverage": "istanbul cover ./node_modules/mocha/bin/_mocha --reporter spec --timeout 4000",
     "coveralls": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"
diff --git a/services/alchemy_language/v1.js b/services/alchemy_language/v1.js
@@ -21,7 +21,7 @@ var requestFactory = require('../../lib/requestwrapper');
 var endpoints      = require('../../lib/alchemy_endpoints.json');
 var helper         = require('../../lib/helper');
 
-var errorFormatter = function(cb) {
+function errorFormatter(cb) {
   return function(err, result, response) {
     if (err) {
       cb(err, result);
diff --git a/services/alchemy_vision/v1.js b/services/alchemy_vision/v1.js
@@ -24,7 +24,7 @@ var pick           = require('object.pick');
 var omit           = require('object.omit');
 var fs             = require('fs');
 
-var errorFormatter = function(cb) {
+function errorFormatter(cb) {
   return function(err, result, response) {
     if (err) {
       cb(err, result);
diff --git a/services/concept_expansion/v1.js b/services/concept_expansion/v1.js
@@ -52,7 +52,8 @@ var concept_decode = {
 // The concepts are encoded using the concept_decode map
 // Create a regular expression to decode them to a human readable form
 var decoderRegExp = new RegExp('/'+Object.keys(concept_decode).join('|')+'/','g');
-var decodeConcept = function (encoded_concept) {
+
+function decodeConcept(encoded_concept) {
   return {
     prevalence: encoded_concept.prevalence,
     result: encoded_concept.result.replace(decoderRegExp,function(word) {
@@ -61,7 +62,7 @@ var decodeConcept = function (encoded_concept) {
   };
 };
 
-var responseFormatter = function(cb) {
+function responseFormatter(cb) {
   return function(err, result) {
     if (err) {
       cb(err, result);
diff --git a/services/natural_language_classifier/v1.js b/services/natural_language_classifier/v1.js
@@ -26,7 +26,7 @@ var toCSV = require('./json-training-to-csv');
 function NaturalLanguageClassifier(options) {
   // Default URL
   var serviceDefaults = {
-    url: 'https://gateway.watsonplatform.net/natural-language-classifier-beta/api'
+    url: 'https://gateway.watsonplatform.net/natural-language-classifier/api'
   };
   this._options = extend(serviceDefaults, options);
 }
@@ -82,15 +82,19 @@ NaturalLanguageClassifier.prototype.create = function(params, callback) {
 NaturalLanguageClassifier.prototype.classify = function(params, callback) {
   params = params || {};
 
+  // #84: use classifier_id not classifier.
+  if (!params.classifier_id)
+    params.classifier_id = params.classifier;
+
   var parameters = {
     options: {
-      url: '/v1/classifiers/{classifier}/classify',
+      url: '/v1/classifiers/{classifier_id}/classify',
       method: 'POST',
       json: true,
-      path: pick(params, ['classifier']),
+      path: pick(params, ['classifier_id']),
       body: pick(params, ['text'])
     },
-    requiredParams: ['classifier', 'text'],
+    requiredParams: ['classifier_id', 'text'],
     defaultOptions: this._options
   };
 
@@ -103,14 +107,18 @@ NaturalLanguageClassifier.prototype.classify = function(params, callback) {
 NaturalLanguageClassifier.prototype.status = function(params, callback) {
   params = params || {};
 
+  // #84: use classifier_id not classifier.
+  if (!params.classifier_id)
+    params.classifier_id = params.classifier;
+
   var parameters = {
     options: {
-      url: '/v1/classifiers/{classifier}',
+      url: '/v1/classifiers/{classifier_id}',
       method: 'GET',
       json: true,
       path: params
     },
-    requiredParams: ['classifier'],
+    requiredParams: ['classifier_id'],
     defaultOptions: this._options
   };
 
@@ -139,14 +147,18 @@ NaturalLanguageClassifier.prototype.list = function(params, callback) {
 NaturalLanguageClassifier.prototype.remove = function(params, callback) {
   params = params || {};
 
+  // #84: use classifier_id not classifier.
+  if (!params.classifier_id)
+    params.classifier_id = params.classifier;
+
   var parameters = {
     options: {
-      url: '/v1/classifiers/{classifier}',
+      url: '/v1/classifiers/{classifier_id}',
       method: 'DELETE',
       path: params,
       json: true
     },
-    requiredParams: ['classifier'],
+    requiredParams: ['classifier_id'],
     defaultOptions: this._options
   };
 
diff --git a/services/question_and_answer/v1.js b/services/question_and_answer/v1.js
@@ -20,7 +20,7 @@ var extend         = require('extend');
 var pick           = require('object.pick');
 var requestFactory = require('../../lib/requestwrapper');
 
-var toQuestion = function(params) {
+function toQuestion(params) {
   return {
     evidenceRequest: {
       items: params.items || 5 // the number of anwers, 5 by default
diff --git a/services/retrieve_and_rank/v1.js b/services/retrieve_and_rank/v1.js
@@ -62,12 +62,22 @@ RetrieveAndRank.prototype.deleteClusters = function(params, callback) {
  * Creates a Solr cluster.
  *
  * @param params An Object representing the parameters for this service call.
- *   This request currently does not require any parameters.
+ *   Optional params
+ *     - cluster_name: name to use for identifying the cluster in responses
+ *     - cluster_size: size of the cluster to create
  *
  * @param callback The callback.
  */
 RetrieveAndRank.prototype.createCluster = function(params, callback) {
-  return sendRequest('POST', solrClustersPath(), this._options, callback);
+  // Avoid modifying the global options by making a deep copy
+  var createOptions = JSON.parse(JSON.stringify(this._options));
+  createOptions.body = JSON.stringify(params || {});
+  if (createOptions.headers === undefined) {
+    createOptions.headers = {};
+  }
+  createOptions.headers['Content-Type'] = 'application/json';
+
+  return sendRequest('POST', solrClustersPath(), createOptions, callback);
 };
 
 /**
diff --git a/services/search/v1.js b/services/search/v1.js
@@ -64,12 +64,22 @@ Search.prototype.deleteClusters = function(params, callback) {
  * Creates a Solr cluster.
  *
  * @param params An Object representing the parameters for this service call.
- *   This request currently does not require any parameters.
+ *   Optional params
+ *     - cluster_name: name to use for identifying the cluster in responses
+ *     - cluster_size: size of the cluster to create
  *
  * @param callback The callback.
  */
 Search.prototype.createCluster = function(params, callback) {
-  return sendRequest('POST', solrClustersPath(), this._options, callback);
+  // Avoid modifying the global options by making a deep copy
+  var createOptions = JSON.parse(JSON.stringify(this._options));
+  createOptions.body = JSON.stringify(params || {});
+  if (createOptions.headers === undefined) {
+    createOptions.headers = {};
+  }
+  createOptions.headers['Content-Type'] = 'application/json';
+
+  return sendRequest('POST', solrClustersPath(), createOptions, callback);
 };
 
 /**
diff --git a/services/speech_to_text/v1.js b/services/speech_to_text/v1.js
@@ -225,15 +225,23 @@ SpeechToText.prototype.observeResult = function(params, callback) {
  * @param {String} [params.session_id] Session used in the recognition.
  */
 SpeechToText.prototype.getRecognizeStatus = function(params, callback) {
+  var missingParams = helper.getMissingParams(params, ['session_id', 'cookie_session']);
+  if (missingParams) {
+    callback(new Error('Missing required parameters: ' + missingParams.join(', ')));
+    return;
+  }
+
   var path = params || {};
   var parameters = {
     options: {
       method: 'GET',
       url: '/v1/sessions/' + path.session_id + '/recognize',
       path: path,
-      json: true
+      json: true,
+      headers: {
+      'Cookie': 'SESSIONID=' + params.cookie_session,
+      }
     },
-    requiredParams: ['session_id'],
     defaultOptions: this._options
   };
   return requestFactory(parameters, callback);
diff --git a/test/test.dialog.v1.js b/test/test.dialog.v1.js
diff --git a/test/test.natural_language_classifier.v1.js b/test/test.natural_language_classifier.v1.js
diff --git a/test/test.retrieve_and_rank.v1.js b/test/test.retrieve_and_rank.v1.js
diff --git a/test/test.search.v1.js b/test/test.search.v1.js
diff --git a/test/test.speech_to_text.v1.js b/test/test.speech_to_text.v1.js

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ async.series([`
`21`	`21`	`},`
`22`	`22`
`23`	`23`	`function createCluster(done) {`
`24`		`- retrieve.createCluster({}, function getId(err, res) {`
	`24`	`+ retrieve.createCluster({cluster_name: 'example_cluster', cluster_size: '1'}, function getId(err, res) {`
`25`	`25`	`if (err) {`
`26`	`26`	`return console.log('Error creating Solr cluster: ' + JSON.stringify(err));`
`27`	`27`	`}`