Merge pull request #314 from watson-developer-cloud/vr-similarity-search

germanattanasio · web-flow · commit e0722af11a9f · 2016-09-20T12:46:26.000-04:00
VR similarity search
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# v2.4.0
+* Added support for Visual Recognition similarity search beta
+* Refactored handling of credentials to support constraints in similarity search
+
 # v2.3.0
 * Add support for RetrieveAndRankV1.rank() answers param
 
diff --git a/lib/base_service.js b/lib/base_service.js
@@ -75,21 +75,14 @@ BaseService.prototype.initCredentials = function(options) {
     options
   );
 
-  // Use api_key or username and password as Authorization
-  var user = options.username,
-    pass = options.password,
-    api_key = options.api_key;
-
   if (!options.use_unauthenticated) {
-    // Check if 'api_key' or 'username' and 'password' were provided
-    if (typeof api_key === 'undefined') {
-      if (typeof user === 'undefined' || typeof pass === 'undefined') {
-          throw new Error('Argument error: api_key or username and password were not specified');
-      }
-
-      // Calculate and add api_key
-      options.api_key = new Buffer(user + ':' + pass).toString('base64');
+    if (!options.username || !options.password) {
+        throw new Error('Argument error: username and password are required unless use_unauthenticated is set');
     }
+
+    // Calculate and add Authorization header to base options
+    var authHeader = {Authorization: 'Basic ' + new Buffer(options.username + ':' + options.password).toString('base64')};
+    options.headers = extend(authHeader, options.headers);
   }
 
   return options;
diff --git a/lib/base_service_alchemy.js b/lib/base_service_alchemy.js
@@ -30,8 +30,11 @@ BaseServiceAlchemy.prototype.initCredentials = function(options) {
     this.getCredentialsFromEnvironment(this.name),
     options
   );
-  if (!options.use_unauthenticated && !options.api_key) {
-    throw new Error('Argument error: api_key was not specified');
+  if (!options.use_unauthenticated) {
+    if (!options.api_key) {
+      throw new Error('Argument error: api_key was not specified');
+    }
+    options.qs = extend({ api_key : options.api_key }, options.qs);
   }
   return options
 };
diff --git a/lib/requestwrapper.js b/lib/requestwrapper.js
@@ -117,19 +117,6 @@ function createRequest(parameters, callback) {
     options.headers['User-Agent'] = pkg.name + '-nodejs-'+ pkg.version;
   }
 
-  if (typeof(options.api_key) !== 'undefined') {
-    // Alchemy uses the apikey(a.k.a api_key) as query parameter
-    // (Visual Recognition v3 accepts either one (api_key or apikey) but does not accept the key in an Authorization header!
-    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;
-    }
-    delete options.api_key;
-  }
-
   // Query params
   if (options.qs && Object.keys(options.qs).length > 0)
   options.useQuerystring = true;
diff --git a/speech-to-text/v1.js b/speech-to-text/v1.js
@@ -354,7 +354,7 @@ SpeechToTextV1.prototype.createRecognizeStream = function(params) {
 
   params.headers = extend({
     'user-agent': pkg.name + '-nodejs-'+ pkg.version,
-    authorization:  'Basic ' + this._options.api_key
+    authorization:  this._options.headers.Authorization
   }, params.headers);
 
   return new RecognizeStream(params);
diff --git a/test/resources/obama2.jpg b/test/resources/obama2.jpg
diff --git a/test/test.alchemy_data_news.v1.js b/test/test.alchemy_data_news.v1.js
@@ -5,7 +5,7 @@ var watson    = require('../');
 var nock      = require('nock');
 var qs        = require('querystring');
 
-describe('alchemy_language', function() {
+describe('alchemy_data_news', function() {
 
   var noop = function() {};
 
@@ -51,7 +51,7 @@ describe('alchemy_language', function() {
       var req = alchemy.getNews(payload, noop);
       assert.equal(req.method, 'GET');
       var query = qs.stringify({
-        apikey: 'foobar',
+        api_key: 'foobar',
         start: 'bar',
         end: 'foo',
         q: 'q1.q2',
diff --git a/test/test.alchemy_language.v1.js b/test/test.alchemy_language.v1.js
@@ -48,7 +48,7 @@ describe('alchemy_language', function() {
 
     it('should generate a valid payload', function() {
       var req = alchemy.entities(payload, noop);
-      assert.equal(req.uri.href, service.url + apiPath + '?apikey=' + service.api_key);
+      assert.equal(req.uri.href, service.url + apiPath + '?api_key=' + service.api_key);
       assert.equal(req.method, 'POST');
       assert(req.form);
       var body = new Buffer(req.body).toString('ascii');
@@ -57,7 +57,7 @@ describe('alchemy_language', function() {
 
     it('should use sentiment_target if target is specified', function() {
       var req = alchemy.sentiment({text: payload.text, target:'bat'}, noop);
-      var sentimenTargetPath = service.url + '/text/TextGetTargetedSentiment?apikey=' + service.api_key;
+      var sentimenTargetPath = service.url + '/text/TextGetTargetedSentiment?api_key=' + service.api_key;
       assert.equal(req.uri.href, sentimenTargetPath);
       assert.equal(req.method, 'POST');
       assert(req.form);
@@ -68,7 +68,7 @@ describe('alchemy_language', function() {
 
     it('should use sentiment if target is not specified', function() {
       var req = alchemy.sentiment(payload, noop);
-      var sentimenPath = service.url + '/text/TextGetTextSentiment?apikey=' + service.api_key;
+      var sentimenPath = service.url + '/text/TextGetTextSentiment?api_key=' + service.api_key;
       assert.equal(req.uri.href, sentimenPath);
       assert.equal(req.method, 'POST');
       assert(req.form);
@@ -79,7 +79,7 @@ describe('alchemy_language', function() {
 
     it('should use /text/ endpoint if the text parameter is passed', function() {
       var req = alchemy.sentiment({text: payload.text, url:'www.ibm.com'}, noop);
-      var sentimenPath = service.url + '/text/TextGetTextSentiment?apikey=' + service.api_key;
+      var sentimenPath = service.url + '/text/TextGetTextSentiment?api_key=' + service.api_key;
       assert.equal(req.uri.href, sentimenPath);
       assert.equal(req.method, 'POST');
       assert(req.form);
@@ -90,7 +90,7 @@ describe('alchemy_language', function() {
 
     it('should use /html/ endpoint if the html parameter is passed', function() {
       var req = alchemy.sentiment({html: '<html><body>test</body></html>', url:'www.ibm.com'}, noop);
-      var sentimenPath = service.url + '/html/HTMLGetTextSentiment?apikey=' + service.api_key;
+      var sentimenPath = service.url + '/html/HTMLGetTextSentiment?api_key=' + service.api_key;
       assert.equal(req.uri.href, sentimenPath);
       assert.equal(req.method, 'POST');
       assert(req.form);
@@ -119,7 +119,7 @@ describe('alchemy_language', function() {
 
       it('should generate a valid payload', function() {
         var req = alchemy.title(payload, noop);
-        assert.equal(req.uri.href, service.url + apiPath + '?apikey=' + service.api_key);
+        assert.equal(req.uri.href, service.url + apiPath + '?api_key=' + service.api_key);
         assert.equal(req.method, 'POST');
         assert(req.form);
         var body = new Buffer(req.body).toString('ascii');
@@ -136,7 +136,7 @@ describe('alchemy_language', function() {
 
       it('should generate a valid payload', function() {
         var req = alchemy.title(payload, noop);
-        assert.equal(req.uri.href, service.url + apiPath + '?apikey=' + service.api_key);
+        assert.equal(req.uri.href, service.url + apiPath + '?api_key=' + service.api_key);
         assert.equal(req.method, 'POST');
         assert(req.form);
         var body = new Buffer(req.body).toString('ascii');
@@ -155,7 +155,7 @@ describe('alchemy_language', function() {
 
     it('should generate a valid payload', function() {
       var req = alchemy.dates(payload, noop);
-      assert.equal(req.uri.href, service.url + apiPath + '?apikey=' + service.api_key);
+      assert.equal(req.uri.href, service.url + apiPath + '?api_key=' + service.api_key);
       assert.equal(req.method, 'POST');
       assert(req.form);
       var body = new Buffer(req.body).toString('ascii');
@@ -178,7 +178,7 @@ describe('alchemy_language', function() {
 
     it('should get document-level emotion if no target is passed', function() {
       var req = alchemy.emotion(payload, noop);
-      var emotionPath = service.url + '/text/TextGetEmotion?apikey=' + service.api_key;
+      var emotionPath = service.url + '/text/TextGetEmotion?api_key=' + service.api_key;
       assert.equal(req.uri.href, emotionPath);
       assert.equal(req.method, 'POST');
       assert(req.form);
@@ -190,7 +190,7 @@ describe('alchemy_language', function() {
 
     it('should get targeted emotion if targets are passed', function() {
       var req = alchemy.emotion(target_payload, noop);
-      var targetedEmotionPath = service.url + '/text/TextGetTargetedEmotion?apikey=' + service.api_key;
+      var targetedEmotionPath = service.url + '/text/TextGetTargetedEmotion?api_key=' + service.api_key;
       assert.equal(req.uri.href, targetedEmotionPath);
       assert.equal(req.method, 'POST');
       assert(req.form);
diff --git a/test/test.alchemy_vision.v1.js b/test/test.alchemy_vision.v1.js
@@ -50,7 +50,7 @@ describe('alchemy_vision', function() {
       assert.equal(req.method, 'POST');
       assert(req.form);
       var query = qs.stringify({
-        apikey: 'foobar',
+        api_key: 'foobar',
         outputMode: 'json',
         imagePostMode: 'raw'
       });
@@ -64,7 +64,7 @@ describe('alchemy_vision', function() {
       var req = alchemy.recognizeFaces({image: 'base64img'}, noop);
       assert.equal(req.method, 'POST');
       assert(req.form);
-      assert.equal(req.uri.href, service.url + apiPath + '?apikey=foobar');
+      assert.equal(req.uri.href, service.url + apiPath + '?api_key=foobar');
       var body = new Buffer(req.body).toString('ascii');
       var expectedBody = qs.stringify({
         image: 'base64img',
@@ -76,7 +76,7 @@ describe('alchemy_vision', function() {
 
     it('should generate a valid payload with a url', function() {
       var req = alchemy.recognizeFaces({url : 'http://bat.com/foo.png'}, noop);
-      var imagePath = service.url + '/url/URLGetRankedImageFaceTags?apikey=foobar';
+      var imagePath = service.url + '/url/URLGetRankedImageFaceTags?api_key=foobar';
       assert.equal(req.uri.href, imagePath);
       assert.equal(req.method, 'POST');
       assert(req.form);
diff --git a/test/test.language_translator.v2.js b/test/test.language_translator.v2.js
@@ -66,15 +66,15 @@ describe('language_translator', function() {
         "language_translation": details
       });
       var instance = watson.language_translator({version: 'v2', version_date: '2016-07-01'});
-      assert(instance._options.api_key);
+      assert(instance._options.headers.Authorization);
     });
 
     it('should initialize with new-style VCAP_SERVICES credentials', function() {
       process.env.VCAP_SERVICES = JSON.stringify({
         "language_translator": details
       });
       var instance = watson.language_translator({version: 'v2', version_date: '2016-07-01'});
-      assert(instance._options.api_key);
+      assert(instance._options.headers.Authorization);
     });
   });
 
diff --git a/test/test.visual_recognition.v3.js b/test/test.visual_recognition.v3.js
@@ -18,7 +18,7 @@ describe('visual_recognition', function() {
     version_date: '2016-05-20'
   };
 
-  var api_key_qs = 'apikey=' + service.api_key;
+  var api_key_qs = 'api_key=' + service.api_key;
   var version_qs = 'version=' + service.version_date;
   var fake_file = fs.createReadStream(__dirname + '/resources/car.png');
   var service_request = {
@@ -228,7 +228,7 @@ describe('visual_recognition', function() {
     it('should make a DELETE request and return the result', function(done) {
       var scope = nock('http://ibm.com:80', {"encodedQueryParams":true})
         .delete('/visual-recognition/api/v3/classifiers/foo_123')
-        .query({"apikey":"batman","version":"2016-05-20"})
+        .query({"api_key":"batman","version":"2016-05-20"})
         .reply(200, {});
 
       visual_recognition.deleteClassifier({
@@ -270,7 +270,7 @@ describe('visual_recognition', function() {
       };
       var scope = nock('http://ibm.com:80', {"encodedQueryParams":true})
         .get('/visual-recognition/api/v3/classifiers/fruit_679357912')
-        .query({"apikey":"batman","version":"2016-05-20"})
+        .query({"api_key":"batman","version":"2016-05-20"})
         .reply(200, expected);
 
       visual_recognition.getClassifier({
diff --git a/test/test.wrapper.js b/test/test.wrapper.js
@@ -41,7 +41,7 @@ describe('wrapper', function() {
         version: 'v1'
       });
     },
-      /api_key or username and password were not specified/
+      /use_unauthenticated/
     );
   });
 
@@ -70,21 +70,17 @@ describe('wrapper', function() {
           username: 'user'
         });
       },
-      /api_key or username and password were not specified/
+      /password/
     );
     assert.throws(function() {
         create_service({
           version: 'v1',
           password: 'pass'
         });
       },
-      /api_key or username and password were not specified/
+      /username/
     );
 
-    assert.ok(create_service({
-      api_key: 'keykeykey',
-      version: 'v1'
-    }));
     assert.ok(create_service({
       password: 'pass',
       username: 'user',
@@ -138,6 +134,8 @@ describe('wrapper', function() {
     var service = create_service({
       version: 'v1',
       api_key: 'not-gonna-work',
+      username: 'foo',
+      password: 'bar',
       foo: 'bar',
       use_vcap_services: false,
       bar: 'foo'
diff --git a/test/test.zz.integration-all-services.js b/test/test.zz.integration-all-services.js
diff --git a/visual-recognition/v3.js b/visual-recognition/v3.js
