Migrate to ibm-watson

chughts · chughts · commit 2ea563caabe6 · 2020-01-16T22:20:18.000Z
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ Node-RED Watson Nodes for IBM Cloud
     - Discovery node
     - Discovery Document Loader node
     - Discovery Query Builder node
-
+- List Expansion list, and List Training data modes added to Discovery node  
 
 ### New in version 0.8.1
 - Node-RED & IBM-Watson & Use of promises on API invocation & IAM URL construct migration & Removal of default endpoint of
diff --git a/services/discovery/discovery-utils.js b/services/discovery/discovery-utils.js
@@ -334,18 +334,20 @@ DiscoveryUtils.prototype = {
 
     if (schemaData &&
            'object' === typeof schemaData &&
-           schemaData['fields'] &&
-            Array.isArray(schemaData['fields'])) {
-      schemaData['fields'].forEach((f) => {
+           schemaData.result &&
+           'object' === typeof schemaData.result &&
+           schemaData.result['fields'] &&
+            Array.isArray(schemaData.result['fields'])) {
+      schemaData.result['fields'].forEach((f) => {
         if (f['field'] && f['type'] && 'nested' !== f['type']) {
           fields.push(f['field']);
         }
       });
-
     }
 
     if (fields.length) {
       fields = fields.filter(this.uniqueFilter);
+      fields.sort();
     }
 
     return fields;
diff --git a/services/discovery/v1-query-builder.html b/services/discovery/v1-query-builder.html
@@ -54,11 +54,6 @@
     </div>
 
     <div class="form-row credentials">
-        <label>&nbsp;</label>
-        <input type="checkbox" id="node-input-default-endpoint" style="display: inline-block; width: auto; vertical-align: top;">
-        <label for="node-input-default-endpoint" style="width: 70%;"> Use Default Service Endpoint</label>
-    </div>
-    <div class="form-row">
         <label for="node-input-service-endpoint"><i class="fa fa-tag"></i> Service Endpoint</label>
         <input type="text" id="node-input-service-endpoint" placeholder="https://gateway.watsonplatform.net/discovery/api">
     </div>
@@ -275,15 +270,6 @@
           }
       });
 
-      $('input#node-input-default-endpoint').change(function () {
-          var checked = $('input#node-input-default-endpoint').prop('checked')
-          if (checked) {
-              $('#node-input-service-endpoint').parent().hide();
-          } else {
-              $('#node-input-service-endpoint').parent().show();
-          }
-      });
-
     }
 
     // The dialog is about to be shown.
@@ -458,10 +444,8 @@
       var k = $('#node-input-apikey').val();
 
       var creds = {un: u, pwd: p, key: k};
-      var eChecked = $('input#node-input-default-endpoint').prop('checked')
-      if (!eChecked) {
-        creds.endpoint = $('#node-input-service-endpoint').val();
-      }
+
+      creds.endpoint = $('#node-input-service-endpoint').val();
 
       $.getJSON('watson-discovery-v1-query-builder/environments', creds
       ).done(function (data) {
@@ -496,10 +480,9 @@
       var k = $('#node-input-apikey').val();
 
       var creds = {un: u, pwd: p, key: k};
-      var eChecked = $('input#node-input-default-endpoint').prop('checked')
-      if (!eChecked) {
-        creds.endpoint = $('#node-input-service-endpoint').val();
-      }
+
+      creds.endpoint = $('#node-input-service-endpoint').val();
+
       creds.environment_id = disQB.environment_selected;
 
       $.getJSON('watson-discovery-v1-query-builder/collections', creds
@@ -533,10 +516,9 @@
       var k = $('#node-input-apikey').val();
 
       var creds = {un: u, pwd: p, key: k};
-      var eChecked = $('input#node-input-default-endpoint').prop('checked')
-      if (!eChecked) {
-        creds.endpoint = $('#node-input-service-endpoint').val();
-      }
+
+      creds.endpoint = $('#node-input-service-endpoint').val();
+
       creds.environment_id = disQB.environment_selected;
       creds.collection_id = disQB.collection_selected;
 
@@ -731,8 +713,7 @@
                 queryvalue3hidden: {value: ''},
                 passages: {value: false},
                 passageshidden: {value: false},
-                'default-endpoint' :{value: true},
-                'service-endpoint' :{value: 'https://gateway.watsonplatform.net/discovery/api'}
+                'service-endpoint' :{value: ''}
 
             },
             credentials: {
diff --git a/services/discovery/v1-query-builder.js b/services/discovery/v1-query-builder.js
@@ -37,6 +37,20 @@ module.exports = function(RED) {
     res.json(serviceutils.checkServiceBound(SERVICE_IDENTIFIER));
   });
 
+  function processResponse(response, field) {
+    let reply = response;
+    if (response) {
+      if (response.result) {
+        if (response.result[field]) {
+          reply = response.result[field];
+        } else {
+          reply = response.result;
+        }
+      }
+    }
+    return reply;
+  }
+
   // API used by widget to fetch available environments
   RED.httpAdmin.get('/watson-discovery-v1-query-builder/environments', function(req, res) {
 
@@ -45,13 +59,13 @@ module.exports = function(RED) {
                                          sApikey ? sApikey : req.query.key,
                                          req.query.endpoint ? req.query.endpoint : sEndpoint);
 
-    discovery.listEnvironments({}, function(err, response) {
-      if (err) {
+    discovery.listEnvironments({})
+      .then((response) => {
+        res.json(processResponse(response,'environments'));
+      })
+      .catch((err) => {
         res.json(err);
-      } else {
-        res.json(response.environments ? response.environments : response);
-      }
-    });
+      });
   });
 
   // API used by widget to fetch available collections in environment
@@ -61,17 +75,13 @@ module.exports = function(RED) {
                                          sApikey ? sApikey : req.query.key,
                                          req.query.endpoint ? req.query.endpoint : sEndpoint);
 
-    discovery.listCollections({
-      environment_id: req.query.environment_id
-    },
-      function(err, response) {
-        if (err) {
-          res.json(err);
-        } else {
-          res.json(response.collections ? response.collections : response);
-        }
-      }
-    );
+    discovery.listCollections({environmentId: req.query.environment_id})
+      .then((response) => {
+        res.json(processResponse(response,'collections'));
+      })
+      .catch((err) => {
+        res.json(err);
+      });
   });
 
 
@@ -83,18 +93,17 @@ module.exports = function(RED) {
                                          req.query.endpoint ? req.query.endpoint : sEndpoint);
 
     discovery.listCollectionFields({
-      environment_id: req.query.environment_id,
-      collection_id: req.query.collection_id
-    },
-      function(err, response) {
-        if (err) {
-          res.json(err);
-        } else {
-          var fieldList = discoveryutils.buildFieldList(response);
-          res.json(fieldList);
-        }
-      }
-    );
+      environmentId: req.query.environment_id,
+      collectionId: req.query.collection_id
+    })
+      .then((response) => {
+        let fieldList = discoveryutils.buildFieldList(response);
+        res.json(fieldList);
+      })
+      .catch((err) => {
+        res.json(err);
+      });
+
   });
 
   function Node(config) {
diff --git a/services/discovery/v1.html b/services/discovery/v1.html
@@ -62,6 +62,9 @@
             <option value="listConfigurations">List existing configurations</option>
             <option value="getConfigurationDetails">Retrieve configuration details</option>
             <option value="deleteConfiguration">Delete configuration</option>
+            <option disabled>______________</option>
+            <option value="listExpansions">Get expansion list for collection.</option>
+            <option value="listTrainingData">Get training data for collection.</option>
         </select>
     </div>
 
@@ -312,6 +315,33 @@
               </ul>
         </li>
         <br/>
+        <li>
+            <p><b>List Expansions</b><p>
+            <p>For this method the node needs an Environment ID and Collection ID as input.</p>
+            <p>The Environment ID, and Collection ID for the collection list being requested can be overridden by specifying the search id
+      in <code>msg.discoveryparams.environmentId</code>
+      and in <code>msg.discoveryparams.collectionId</code>
+            </p>
+            <p>Node output : </p>
+              <ul>
+                <li><code>msg.expansions</code> : The current expansion list for the specified collection.
+                  If an expansion list is not specified, an object with empty expansion arrays is returned.</li>
+              </ul>
+        </li>
+        <br/>
+        <li>
+            <p><b>List Training Data</b><p>
+            <p>For this method the node needs an Environment ID and Collection ID as input.</p>
+            <p>The Environment ID, and Collection ID for the collection list being requested can be overridden by specifying the search id
+      in <code>msg.discoveryparams.environmentId</code>
+      and in <code>msg.discoveryparams.collectionId</code>
+            </p>
+            <p>Node output : </p>
+              <ul>
+                <li><code>msg.trainingData</code> : Lists the training data for the specified collection</li>
+              </ul>
+        </li>
+        <br/>
         <li>
             <p><b>Search in Collection</b><p>
             <p>For this method the node needs an Environment ID and Collection ID as input.
@@ -414,6 +444,8 @@
           break;
         case 'getCollectionDetails':
         case 'deleteCollection':
+        case 'listExpansions':
+        case 'listTrainingData':
           fields.push('#node-input-environmentId'
                           + ', #node-input-collectionId');
           break;
diff --git a/services/discovery/v1.js b/services/discovery/v1.js
@@ -31,6 +31,25 @@ module.exports = function (RED) {
     endpoint = '',
     sEndpoint = 'https://gateway.watsonplatform.net/discovery/api';
 
+const ExecutionList = {
+  'createEnvrionment': executeCreateEnvrionment,
+  'listEnvrionments': executeListEnvrionments,
+  'getEnvironmentDetails': executeEnvrionmentDetails,
+  'createCollection': executeCreateCollection,
+  'listCollections': executeListCollections,
+  'getCollectionDetails': executeGetCollectionDetails,
+  'deleteCollection': executeDeleteCollection,
+  'createConfiguration': executeCreateConfiguration,
+  'listConfigurations': executeListConfigurations,
+  'getConfigurationDetails': executeGetConfigurationDetails,
+  'deleteConfiguration': executeDeleteConfiguration,
+  'deleteEnvironment': executeDeleteEnvironment,
+  'listExpansions': executeListExpansions,
+  'listTrainingData': executeListTrainingData,
+  'query': executeQuery,
+  'queryNotices': executeQueryNotices
+};
+
 
   function checkParams(method, params){
     var response = '';
@@ -51,6 +70,8 @@ module.exports = function (RED) {
     case 'getCollectionDetails':
     case 'query':
     case 'queryNotices':
+    case 'listExpansions':
+    case 'listTrainingData':
       response = discoveryutils.paramEnvCheck(params) +
              discoveryutils.paramCollectionCheck(params);
       break;
@@ -207,6 +228,35 @@ module.exports = function (RED) {
     return p;
   }
 
+  function executeListExpansions(node, discovery, params, msg) {
+    var p = new Promise(function resolver(resolve, reject){
+      discovery.listExpansions(params)
+      .then((response) => {
+        responseutils.parseResponseFor(msg, response, 'expansions');
+        resolve();
+      })
+      .catch((err) => {
+        reject(err);
+      });
+    });
+    return p;
+  }
+
+  function executeListTrainingData(node, discovery, params, msg) {
+    var p = new Promise(function resolver(resolve, reject){
+      discovery.listTrainingData(params)
+      .then((response) => {
+        msg.trainingData = response.result ? response.result : response;
+        resolve();
+      })
+      .catch((err) => {
+        reject(err);
+      });
+    });
+    return p;
+  }
+
+
   function executeCreateConfiguration(node, discovery, params, msg) {
     var p = new Promise(function resolver(resolve, reject){
       discovery.createConfiguration(params)
@@ -289,56 +339,13 @@ module.exports = function (RED) {
 
   function executeMethod(node, method, params, msg) {
     let discovery = discoveryutils.buildService(username, password, apikey, endpoint);
-    var p = null;
 
-    switch (method) {
-    case 'createEnvrionment':
-      p = executeCreateEnvrionment(node, discovery, params, msg);
-      break;
-    case 'listEnvrionments':
-      p = executeListEnvrionments(node, discovery, params, msg);
-      break;
-    case 'getEnvironmentDetails':
-      p = executeEnvrionmentDetails(node, discovery, params, msg);
-      break;
-    case 'createCollection':
-      p = executeCreateCollection(node, discovery, params, msg);
-      break;
-    case 'listCollections':
-      p = executeListCollections(node, discovery, params, msg);
-      break;
-    case 'getCollectionDetails':
-      p = executeGetCollectionDetails(node, discovery, params, msg);
-      break;
-    case 'deleteCollection':
-      p = executeDeleteCollection(node, discovery, params, msg);
-      break;
-    case 'createConfiguration':
-      p = executeCreateConfiguration(node, discovery, params, msg);
-      break;
-    case 'listConfigurations':
-      p = executeListConfigurations(node, discovery, params, msg);
-      break;
-    case 'getConfigurationDetails':
-      p = executeGetConfigurationDetails(node, discovery, params, msg);
-      break;
-    case 'deleteConfiguration':
-      p = executeDeleteConfiguration(node, discovery, params, msg);
-      break;
-    case 'deleteEnvironment':
-      p = executeDeleteEnvironment(node, discovery, params, msg);
-      break;
-    case 'query':
-      p = executeQuery(node, discovery, params, msg);
-      break;
-    case 'queryNotices':
-      p = executeQueryNotices(node, discovery, params, msg);
-      break;
-    default :
-      p = unknownMethod(node, discovery, params, msg);
-      break;
+    let exe = ExecutionList[method];
+    if (!exe) {
+      exe = unknownMethod
     }
-    return p;
+
+    return exe(node, discovery, params, msg);
   }
 
   function initialCheck(u, p, k, m) {
