Merge pull request #170 from mfulgo/version-param

[DCS] Adds Version Date param

Author: nfriedly

README.md

@@ -294,9 +294,10 @@ var watson = require('watson-developer-cloud');
 var fs = require('fs');
 
 var document_conversion = watson.document_conversion({
-  username: '<username>',
-  password: '<password>',
-  version: 'v1-experimental'
+  username:     '<username>',
+  password:     '<password>',
+  version:      'v1-experimental',
+  version_date: '2015-12-01'
 });
 
 // convert a single document

services/document_conversion/v1-experimental.js

@@ -22,9 +22,19 @@ var isStream       = require('isstream');
 var omit           = require('object.omit');
 
 function DocumentConversion(options) {
+  // Warn if not specifying version date
+  var version_date = "2015-12-01"
+  if(options && options.version_date) {
+    version_date = options.version_date
+  } else {
+    console.warn("[DocumentConversion] WARNING: No version_date specified. Using a (possibly old) default. " +
+                 "e.g. watson.document_conversion({ version_date: '2015-12-01' })")
+  }
+
   // Default URL
   var serviceDefaults = {
-    url: 'https://gateway.watsonplatform.net/document-conversion-experimental/api'
+    url: 'https://gateway.watsonplatform.net/document-conversion-experimental/api',
+    qs: { version: version_date }
   };
 
   // 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, { version_date: "2015-11-30"}));
+      var req = custServInstance.convert(payload, noop);
+      assert(req.uri.query.indexOf("version=2015-11-30" > -1));
+    });
   });
 });