Check the status response from alchemy to detect errors #72

Author: germanattanasio

README.md

@@ -18,6 +18,8 @@ APIs and SDKs that use cognitive computing to solve complex problems.
     * [Installation](#installation)
     * [Usage](#usage)
     * [Getting the Service Credentials](#getting-the-service-credentials)
+    * [Alchemy Services](#alchemy-services)
+      * [Alchemy Language](#alchemy-language)
     * [IBM Watson Services](#ibm-watson-services)
       * [Authorization](#authorization)
       * [Concept Expansion](#concept-expansion)
@@ -63,9 +65,7 @@ credentials; the wrapper will get them for you by looking at the `VCAP_SERVICES`
 environment variable.
 
 ### Getting the Service Credentials
-The credentials for the services are stored in the
-`VCAP_SERVICES` environment variable. To get them, you need
-to first create and bind the service to your application.
+The credentials for the services are stored in the `VCAP_SERVICES` environment variable. To get them, you need to first create and bind the service to your application.
 
 There are two ways to get the credentials. You can use Bluemix to access your
 app and view the `VCAP_SERVICES` there or you can run:
@@ -95,6 +95,34 @@ Example output:
 
 You need to copy `username` and `password`.
 
+For Alchemy you only need an `api_key`, you can register for one [here](http://www.alchemyapi.com/api/register.html).
+
+## Alchemy APIs
+
+### Alchemy Language
+[Alchemy Language](alchemy_language) offers 12 API functions as part of its text analysis service, each of which uses sophisticated natural language processing techniques to analyze your content and add high-level semantic information.
+
+Use the [Sentiment Analysis](sentiment_analysis) endpoint to identify positive/negative sentiment within a sample text document.
+
+```javascript
+var watson = require('watson-developer-cloud');
+
+var alchemy_language = watson.alchemy_language({
+  api_key: '<api_key>'
+});
+
+var params = {
+  text: 'IBM Watson won the Jeopardy television show hosted by Alex Trebek'
+};
+
+alchemy_language.sentiment(params, function (err, response) {
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(response, null, 2));
+});
+```
+
 ## IBM Watson Services
 The Watson Developer Cloud offers a variety of services for building cognitive
 apps.
@@ -568,6 +596,8 @@ See [CONTRIBUTING](https://github.com/watson-developer-cloud/nodejs-wrapper/blob
 [tradeoff_analytics]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/tradeoff-analytics/
 [language_translation]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/language-translation/
 
+[alchemy_language]: http://www.alchemyapi.com/products/alchemylanguage
+[sentiment_analysis]: http://www.alchemyapi.com/products/alchemylanguage/sentiment-analysis
 [wdc]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/
 [bluemix]: https://console.ng.bluemix.net
 [npm_link]: https://www.npmjs.com/package/watson-developer-cloud

examples/alchemy_language.v1.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var watson = require('watson-developer-cloud');
+
+var alchemy_language = watson.alchemy_language({
+  api_key: '<api_key>'
+});
+
+var params = {
+  text: 'IBM Watson won the Jeopardy television show hosted by Alex Trebek'
+};
+
+alchemy_language.sentiment(params, function (err, response) {
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(response, null, 2));
+});

lib/requestwrapper.js

@@ -106,8 +106,9 @@ function createRequest(parameters, callback) {
 
   if (typeof(options.api_key) !== 'undefined') {
     // Alchemy uses the apikey(a.k.a api_key) as query parameter
-    if (options.alchemy){
+    if (options.alchemy) {
       options.qs = extend({ apikey : options.api_key }, options.qs);
+      delete options.alchemy;
     } else {
       // IBM Watson uses Basic auth
       options.headers['Authorization'] = 'Basic ' + options.api_key;

services/alchemy_language/v1.js

@@ -21,6 +21,20 @@ var requestFactory = require('../../lib/requestwrapper');
 var endpoints      = require('../../lib/alchemy_endpoints.json');
 var helper         = require('../../lib/helper');
 
+var errorFormatter = function(cb) {
+  return function(err, result) {
+    if (err) {
+      cb(err, result);
+    }
+    else {
+      if (result.status === 'OK')
+        cb(err,result);
+      else
+        cb({error: result.statusInfo, code:400 }, null);
+    }
+  };
+};
+
 function createRequest(method) {
   return function(_params, callback ) {
     var params = _params || {};
@@ -44,15 +58,14 @@ function createRequest(method) {
       },
       defaultOptions: this._options
     };
-    return requestFactory(parameters, callback);
+    return requestFactory(parameters, errorFormatter(callback));
   };
 }
 
 function AlchemyLanguage(options) {
   // Default URL
   var serviceDefaults = {
-    url: 'https://access.alchemyapi.com/calls',
-    alchmemy: true
+    url: 'https://access.alchemyapi.com/calls'
   };
   // Replace default options with user provided
   this._options = extend(serviceDefaults, options);
@@ -78,7 +91,7 @@ AlchemyLanguage.prototype.concepts = createRequest('concepts');
  * Calculates the sentiment for text, a URL or HTML.
  */
 AlchemyLanguage.prototype.sentiment = function(params, callback) {
-  var service = (params && params.target) ? 'sentiment' : 'sentiment_targeted';
+  var service = (params && params.target) ? 'sentiment_targeted' : 'sentiment';
   return createRequest(service).call(this, params, callback);
 };
 /**