Merge pull request #169 from mfulgo/dev

DCS: Adds example for passing custom configs

Author: nfriedly

.gitignore

@@ -5,3 +5,4 @@ coverage
 test/resources/auth.js
 test/integration/
 test/resources/tts-output.ogg
+.idea

CONTRIBUTING.md

@@ -28,8 +28,8 @@ If you want to contribute to the repository, follow these steps:
 
 1. Fork the repo.
 1. Develop and test your code changes: `npm install -d && npm test`. Make sure you work in the `dev` branch. PLEASE don't do your work in `master`.
-1. In order to run the tests locally you should comment out `test.integration-all-services.js` because the integration tests require you to have service credentials for all the services.
-Travis will run the integration tests for all services once the changes are merged in.
+1. Travis-CI will run the integration tests for all services once your changes are merged.
+If you wish to run integration tests locally you must provide service credentials for all the services. See `test/test.integration-all-services.js`.
 1. Add a test for your changes. Only refactoring and documentation changes require no new tests.
 1. Make the test pass.
 1. Commit your changes.

README.md

@@ -303,7 +303,16 @@ var document_conversion = watson.document_conversion({
 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
+  conversion_target: document_conversion.conversion_target.ANSWER_UNITS,
+  // Add custom configuration properties or omit for defaults
+  word: {
+    heading: {
+      fonts: [
+        { level: 1, min_size: 24 },
+        { level: 2, min_size: 16, max_size: 24 }
+      ]
+    }
+  }
 }, function (err, response) {
   if (err) {
     console.error(err);

test/test.document_conversion.v1-experimental.js

@@ -21,6 +21,14 @@ describe('document_conversion', function() {
 
   var payload = {
     conversion_target: 'ANSWER_UNITS',
+    word: {
+      heading: {
+        fonts: [
+          { level: 1, min_size: 24 },
+          { level: 2, min_size: 16, max_size: 24 }
+        ]
+      }
+    },
     file: fs.createReadStream(__dirname + '/resources/sampleWORD.docx'),
   };
 
@@ -68,5 +76,11 @@ describe('document_conversion', function() {
       assert.equal(req.method, 'POST');
       assert(req.formData);
     });
+
+    it('should send extra config params', function() {
+      var req = servInstance.convert(payload, noop);
+      var config = JSON.parse(req.formData.config.value);
+      assert(config.word.heading.fonts);
+    });
   });
 });

test/test.integration-all-services.js

@@ -1,9 +1,12 @@
 'use strict';
 
+var fs = require('fs');
+
+if (fs.existsSync(__dirname + '/resources/auth.js')) {
+
 var nock = require('nock');
 var watson = require('../lib/index');
 var auth = require('./resources/auth');
-var fs = require('fs');
 var assert = require('assert');
 
 var mobydick = fs.readFileSync(__dirname + '/resources/mobydick.txt', 'utf8');
@@ -14,8 +17,6 @@ var TEN_SECONDS = 10000;
 var FIVE_SECONDS = 5000;
 var TWO_SECONDS = 2000;
 
-if (fs.existsSync(__dirname + '/resources/auth.js')) {
-
 describe('integration-all-services', function() {
 
   this.slow(TWO_SECONDS); // this controls when the tests get a colored warning for taking too long
@@ -590,7 +591,15 @@ describe('integration-all-services', function() {
     it('convertFile()', function(done) {
       document_conversion.convert({
         file: fs.createReadStream(__dirname + '/resources/sampleWORD.docx'),
-        conversion_target: 'ANSWER_UNITS'
+        conversion_target: 'ANSWER_UNITS',
+        word: {
+          heading: {
+            fonts: [
+              { level: 1, min_size: 24 },
+              { level: 2, min_size: 16, max_size: 24 }
+            ]
+          }
+        }
       }, failIfError.bind(failIfError, done));
     });
   });