Merge pull request #94 from watson-developer-cloud/dev

support for document conversion and bug fixing

Author: germanattanasio

.gitignore

@@ -1,4 +1,9 @@
 node_modules/*
 npm-debug.log
 coverage
-.DS_Store
+.DS_Store
+test/resources/auth.js
+test/resources/mobydick.txt
+test/test.all-services.js
+test/resources/tts-output.ogg
+test/resources/face.jpg

README.md

@@ -25,6 +25,7 @@ APIs and SDKs that use cognitive computing to solve complex problems.
       * [Concept Expansion](#concept-expansion)
       * [Concept Insights](#concept-insights)
       * [Dialog](#dialog)
+      * [Document Conversion](#document-conversion)
       * [Language Translation](#language-translation)
       * [Message Resonance](#message-resonance)
       * [Natural Language Classifier](#natural-language-classifier)
@@ -221,12 +222,37 @@ var dialog = watson.dialog({
   version: 'v1'
 });
 
-
 dialog.getDialogs({}, function (err, dialogs) {
-    if (err)
-      console.log('error:', err);
-    else
-      console.log(JSON.stringify(dialogs, null, 2));
+  if (err)
+    console.log('error:', err);
+  else
+    console.log(JSON.stringify(dialogs, null, 2));
+});
+```
+
+### Document Conversion
+
+```javascript
+var watson = require('watson-developer-cloud');
+var fs = require('fs');
+
+var document_conversion = watson.document_conversion({
+  username: '<username>',
+  password: '<password>',
+  version: 'v1-experimental'
+});
+
+// convert a single document
+document_conversion.convert({
+  // (JSON) ANSWER_UNITS, NORMALIZED_HTML, or NORMALIZED_TEXT
+  file: fs.createReadStream('sample-docx.docx'),
+  conversion_target: document_conversion.conversion_target.ANSWER_UNITS
+}, function (err, response) {
+  if (err) {
+    console.error(err);
+  } else {
+    console.log(JSON.stringify(response, null, 2));
+  }
 });
 ```
 

RELEASE.md

@@ -0,0 +1,17 @@
+# Release process
+
+Standard practice with node.js modules is to commit all of the changes for a release except updating the package.json version, and then run the following:
+
+```
+npm version major|minor|patch
+git push --tags
+git push origin master
+npm publish
+```
+
+`npm version *` will update the package.json version field appropriately and create a git commit and tag for the version.  
+`git push --tags` will publish the tag to github., and then immediately.  
+`git push origin master` will publish the changes to package.json.  
+`npm publish` will publish the npm package.
+
+The reason for this is that it allows someone to easily view the source code (and readme) for whatever version they happen to have downloaded from npm. This is particularly helpful when github is ahead of npm.

examples/document_conversion.v1-experimental.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var watson = require('watson-developer-cloud');
+var fs = require('fs');
+
+var document_conversion = watson.document_conversion({
+  username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
+  password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE',
+  version: 'v1-experimental'
+});
+
+// convert a single document
+document_conversion.convert({
+  // (JSON) ANSWER_UNITS, NORMALIZED_HTML, or NORMALIZED_TEXT
+  file: fs.createReadStream(__dirname + '/resources/document_conversion/sample-docx.docx'),
+  conversion_target: document_conversion.conversion_target.ANSWER_UNITS
+}, function (err, response) {
+  if (err) {
+    console.error(err);
+  } else {
+    console.log(JSON.stringify(response, null, 2));
+  }
+});

examples/resources/sample-docx.docx

@@ -22,6 +22,7 @@ var extend  = require('extend');
 var bluemix = require('./bluemix');
 var helper  = require('./helper');
 var omit    = require('object.omit');
+var request = require('request');
 
 
 function createServiceAPI(serviceName) {
@@ -36,6 +37,8 @@ function createServiceAPI(serviceName) {
       options.alchemy = true;
       options.version = 'v1';
       options.api_key = options.apikey || options.api_key;
+    } else {
+      options.jar = request.jar();
     }
 
     // Check if 'version' was provided
@@ -111,15 +114,18 @@ var watson = {};
   'tone_analyzer',
   'dialog',
   'retrieve_and_rank',
+  'document_conversion',
+
   // deprecated
   'search',
   'language_identification',
   'machine_translation',
   'user_modeling',
 
   // alchemy
-  'alchemy_language'
-  //'alchemy_vision'
+  'alchemy_language',
+  'alchemy_vision',
+  'alchemy_data_news'
 
 ].forEach(function(api) {
   watson[api] = createServiceAPI(api);

lib/index.js

@@ -28,13 +28,15 @@
     "concept insights",
     "tradeoff analytics",
     "tone analyzer",
+    "retrieve and rank",
     "natural language classifier",
     "dialog",
     "tone_analyzer",
-    "alchemy api",
+    "alchemy",
+    "alchemyapi",
     "alchemy vision",
     "alchemy language",
-    "alchemy data"
+    "alchemy datanews "
   ],
   "author": "IBM Corp.",
   "contributors": [
@@ -60,6 +62,7 @@
     "coveralls": "~2.11.2",
     "istanbul": "~0.3.15",
     "nock": "~2.10.0",
+    "jshint": "~2.8.0",
     "qs": "~4.0.0"
   },
   "dependencies": {
@@ -68,7 +71,6 @@
     "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",

package.json

@@ -0,0 +1,96 @@
+/**
+ * Copyright 2015 IBM Corp. All Rights Reserved.
+ *
+ * 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
+ *
+ *      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 extend         = require('extend');
+var requestFactory = require('../../lib/requestwrapper');
+var endpoints      = require('../../lib/alchemy_endpoints.json');
+var helper         = require('../../lib/helper');
+
+function errorFormatter(cb) {
+  return function(err, result, response) {
+    if (err) {
+      cb(err, result);
+    }
+    else {
+      if (result.status === 'OK')
+        cb(err,result);
+      else
+        cb({
+          error: result.statusInfo || response['headers']['x-alchemyapi-error-msg'],
+          code: 400
+        }, null);
+    }
+  };
+}
+
+function createRequest(method) {
+  return function(_params, callback ) {
+    var params = _params || {};
+    var accepted_formats = Object.keys(endpoints[method]);
+    var format = helper.getFormat(params, accepted_formats);
+
+    if (format === null) {
+      callback(new Error('Missing required parameters: ' +
+        accepted_formats.join(', ') +
+        ' needs to be specified'));
+      return;
+    }
+
+    var parameters = {
+      options: {
+        url: endpoints[method][format],
+        method: 'POST',
+        json: true,
+        form: extend({outputMode: 'json'}, params) // change default output to json
+      },
+      defaultOptions: this._options
+    };
+    return requestFactory(parameters, errorFormatter(callback));
+  };
+}
+
+function AlchemyDataNews(options) {
+  // Default URL
+  var serviceDefaults = {
+    url: 'https://access.alchemyapi.com/calls'
+  };
+  // Replace default options with user provided
+  this._options = extend(serviceDefaults, options);
+}
+
+/**
+ * Extracts a grouped, ranked list of named entities (people, companies,
+ * organizations, etc.) from text, a URL or HTML.
+ */
+AlchemyDataNews.prototype.getNews = function(params, callback ) {
+    params = params || {};
+
+    var parameters = {
+      options: {
+        url: '/data/GetNews',
+        method: 'GET',
+        json: true,
+        qs: extend({}, params, {outputMode: 'json'}) // change default output to json
+      },
+      requiredParams: ['end','start'],
+      defaultOptions: this._options
+    };
+    return requestFactory(parameters, errorFormatter(callback));
+  };
+
+module.exports = AlchemyDataNews;

services/alchemy_data_news/v1.js

@@ -36,7 +36,7 @@ function errorFormatter(cb) {
         }, null);
     }
   };
-};
+}
 
 function createRequest(method) {
   return function(_params, callback ) {
@@ -56,8 +56,7 @@ function createRequest(method) {
         url: endpoints[method][format],
         method: 'POST',
         json: true,
-        path: params,
-        form: extend({outputMode: 'json'}, params) // change default output to json
+        form: extend({}, params, {outputMode: 'json'}) // change default output to json
       },
       defaultOptions: this._options
     };