[DCS] Adds required version query param

The Document Conversion Service will soon require a "version" query
parameter on all requests. In the future, this will be used to avoid
breaking changes to behavior when the service is upgraded to newer
versions.

By default, if the SDK user does not specify a version date, the
parameter will be set to yesterday's date (in UTC). However, it should
be noted that not specifying a fixed value may result in future requests
failing or outputting unexpected results due to new or changed behavior
or API/behavior-breaking changes as the service is upgraded.

Author: mfulgo

README.md

@@ -296,7 +296,8 @@ var fs = require('fs');
 var document_conversion = watson.document_conversion({
   username: '<username>',
   password: '<password>',
-  version: 'v1-experimental'
+  version: 'v1-experimental',
+  qs: { version: '2015-12-01' }
 });
 
 // convert a single document

package.json

@@ -72,6 +72,7 @@
     "csv-stringify": "~0.0.8",
     "extend": "~3.0.0",
     "isstream": "~0.1.2",
+    "moment": "~2.10.6",
     "object.omit": "~2.0.0",
     "object.pick": "~1.1.1",
     "request": "~2.67.0",

services/document_conversion/v1-experimental.js

@@ -20,11 +20,13 @@ var extend         = require('extend');
 var requestFactory = require('../../lib/requestwrapper');
 var isStream       = require('isstream');
 var omit           = require('object.omit');
+var moment         = require('moment');
 
 function DocumentConversion(options) {
   // Default URL
   var serviceDefaults = {
-    url: 'https://gateway.watsonplatform.net/document-conversion-experimental/api'
+    url: 'https://gateway.watsonplatform.net/document-conversion-experimental/api',
+    qs: { version: moment.utc().subtract(1, 'd').format('YYYY-MM-DD') }
   };
 
   // Replace default options with user provided

test/test.document_conversion.v1-experimental.js

@@ -2,6 +2,7 @@
 
 var assert  = require('assert');
 var pick    = require('object.pick');
+var extend  = require('extend');
 var watson  = require('../lib/index');
 var nock    = require('nock');
 var fs      = require('fs');
@@ -11,7 +12,7 @@ describe('document_conversion', function() {
   var noop = function() {};
 
   // Test params
-  var service = {
+  var service_options = {
     username: 'batman',
     password: 'bruce-wayne',
     url: 'http://ibm.com:80',
@@ -40,7 +41,7 @@ describe('document_conversion', function() {
     nock.cleanAll();
   });
 
-  var servInstance = watson.document_conversion(service);
+  var servInstance = watson.document_conversion(service_options);
 
   var missingParameter = function(err) {
     assert.ok((err instanceof Error) && /required parameters/.test(err));
@@ -72,7 +73,7 @@ describe('document_conversion', function() {
 
     it('should generate a valid payload', function() {
       var req = servInstance.convert(payload, noop);
-      assert.equal(req.uri.href, service.url + convertPath);
+      assert(req.uri.href.startsWith(service_options.url + convertPath));
       assert.equal(req.method, 'POST');
       assert(req.formData);
     });
@@ -82,5 +83,17 @@ describe('document_conversion', function() {
       var config = JSON.parse(req.formData.config.value);
       assert(config.word.heading.fonts);
     });
+
+    it('should send the version query param', function() {
+      var req = servInstance.convert(payload, noop);
+      assert(req.uri.query);
+      assert(req.uri.query.indexOf("version=") > -1)
+    });
+
+    it('should allow the version query param to be overridden', function() {
+      var custServInstance = watson.document_conversion(extend(service_options, { qs: { version: "2015-11-30"} }));
+      var req = custServInstance.convert(payload, noop);
+      assert(req.uri.query.indexOf("version=2015-11-30" > -1));
+    });
   });
 });