wrapping up vr v3 changes/docs/tests

Author: nfriedly

lib/requestwrapper.js

@@ -76,6 +76,7 @@ function formatErrorIfExists(cb) {
  * 3. Encode path and query parameters
  * 4. Call the api
  * @private
+ * @return {ReadableStream|undefined}
  */
 function createRequest(parameters, callback) {
   var missingParams = null,

services/visual_recognition/v3.js

@@ -435,11 +435,7 @@ VisualRecognitionV3.prototype.createClassifier = function(params, callback) {
   }
   // todo: validate that all *_examples are streams or else objects with buffers and content-types
 
-  if (!params.name) {
-    callback(new Error('Missing required parameter: name'));
-    return;
-  }
-  
+
 
   var allowed_keys = ['name', NEGATIVE_EXAMPLES].concat(example_keys);
 
@@ -459,10 +455,9 @@ VisualRecognitionV3.prototype.createClassifier = function(params, callback) {
 /**
  * Retrieve a list of all classifiers, including built-in and
  * user-created classifiers.
- * @param verbose If verbose is present and not equal to "0",
- * return detailed results for each classifier.
  *
  * Example output:
+
  {"classifiers": [
     {
         "classifier_id": "fruit_679357912",
@@ -475,6 +470,11 @@ VisualRecognitionV3.prototype.createClassifier = function(params, callback) {
         "status": "ready"
     }
 ]}
+
+ * @param {Object} params
+ * @param {Boolean} [params.verbose=false]
+ * @param {Function} callback
+ * @return {ReadableStream|undefined}
  */
 VisualRecognitionV3.prototype.listClassifiers = function(params, callback) {
   var parameters = {
@@ -491,7 +491,24 @@ VisualRecognitionV3.prototype.listClassifiers = function(params, callback) {
 
 /**
  * Retrieves information about a specific classifier.
- * @param classifier_id The classifier id
+ *
+ * Example output:
+{
+  classifier_id: 'fruit_679357912',
+  name: 'fruit',
+  owner: 'a3a48ea7-492b-448b-87d7-9dade8bde5a9',
+  status: 'ready',
+  created: '2016-05-23T21:50:41.680Z',
+  classes: [
+    { class: 'banana' },
+    { class: 'apple' }
+  ]
+}
+
+ * @param {Object} params
+ * @param {Boolean} params.classifier_id The classifier id
+ * @param {Function} callback
+ * @return {ReadableStream|undefined}
  */
 VisualRecognitionV3.prototype.getClassifier = function(params, callback) {
   var parameters = {
@@ -501,16 +518,19 @@ VisualRecognitionV3.prototype.getClassifier = function(params, callback) {
       path: params,
       json: true
     },
-    requiredParams: ['classifier_id', 'api_key'],
+    requiredParams: ['classifier_id'],
     defaultOptions: this._options
   };
   return requestFactory(parameters, callback);
 };
 
 /**
  * Deletes a custom classifier with the specified classifier id.
- * @param classifier_id The classifier id
  *
+ * @param {Object} params
+ * @param {String} params.classifier_id The classifier id
+ * @param {Function} callback
+ * @returns {ReadableStream|undefined}
  */
 VisualRecognitionV3.prototype.deleteClassifier = function(params, callback) {
   var parameters = {

test/test.integration-all-services.js

@@ -457,8 +457,22 @@ describe('integration-all-services', function() {
         });
       });
 
-      describe('createClassifier()', function() {
-
+      describe('getClassifier()', function() {
+        it('should retrieve the classifier', function(done) {
+          var expected = { classifier_id: 'fruit_679357912',
+            name: 'fruit',
+            owner: 'a3a48ea7-492b-448b-87d7-9dade8bde5a9',
+            status: 'ready',
+            created: '2016-05-23T21:50:41.680Z',
+            classes: [ { class: 'banana' }, { class: 'apple' } ] };
+          visual_recognition.getClassifier({classifier_id: 'fruit_679357912'}, function(err, classifier){
+            if (err) {
+              return done(err);
+            }
+            assert.deepEqual(classifier, expected);
+            done();
+          });
+        });
       });
     });
   });
@@ -1018,7 +1032,6 @@ describe('integration-all-services', function() {
           if (err) {
             return done(err);
           }
-          console.log(res); // eslint-disable-line no-console
           assert(res);
           assert(res.media_type_detected, 'application/vnd.openxmlformats-officedocument.wordprocessingml.document');
           assert(res.answer_units);

test/test.visual_recognition.v3.js

@@ -13,7 +13,7 @@ describe('visual_recognition', function() {
   // Test params
   var service = {
     api_key: 'batman',
-    url: 'http://ibm.com:80',
+    url: 'http://ibm.com:80/visual-recognition/api',
     version: 'v3',
     version_date: '2016-05-20'
   };
@@ -151,7 +151,7 @@ describe('visual_recognition', function() {
       visual_recognition.createClassifier({positive_examples: '', negative_examples: '', name: 'foo'}, missingParameter); // positive examples must include a tag
       visual_recognition.createClassifier({foo_positive_examples: '', negative_examples: ''}, missingParameter); // missing name
     });
-    
+
     it('should generate a valid payload with streams', function(done) {
       var params = {
         foo_positive_examples: fake_file,
@@ -189,6 +189,23 @@ describe('visual_recognition', function() {
       assert.equal(req.uri.href, service.url + foo_classifiers_path);
       assert.equal(req.method, 'DELETE');
     });
+
+    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({"api_key":"batman","version":"2016-05-20"})
+        .reply(200, {});
+
+      visual_recognition.deleteClassifier({
+        classifier_id: 'foo_123'
+      }, function(err) {
+        if (err) {
+          return done(err);
+        }
+        assert(scope.isDone());
+        done();
+      });
+    });
   });
 
   describe('getClassifier()', function() {
@@ -206,5 +223,31 @@ describe('visual_recognition', function() {
       assert.equal(req.uri.href, service.url + foo_classifiers_path);
       assert.equal(req.method, 'GET');
     });
+
+    it('should make a GET request and return the result', function(done) {
+      var expected = {
+        "classifier_id":"fruit_679357912",
+        "name":"fruit",
+        "owner":"a3a48ea7-492b-448b-87d7-9dade8bde5a9",
+        "status":"ready",
+        "created":"2016-05-23T21:50:41.680Z",
+        "classes":[{"class":"banana"},{"class":"apple"}]
+      };
+      var scope = nock('http://ibm.com:80', {"encodedQueryParams":true})
+        .get('/visual-recognition/api/v3/classifiers/fruit_679357912')
+        .query({"api_key":"batman","version":"2016-05-20"})
+        .reply(200, expected);
+
+      visual_recognition.getClassifier({
+        classifier_id: 'fruit_679357912'
+      }, function(err, res) {
+        if (err) {
+          return done(err);
+        }
+        assert(scope.isDone());
+        assert.deepEqual(res, expected);
+        done();
+      });
+    });
   });
 });