Migrate to ibm-watson

Author: chughts

README.md

@@ -7,9 +7,12 @@ Node-RED Watson Nodes for IBM Cloud
 
 <a href="https://cla-assistant.io/watson-developer-cloud/node-red-node-watson"><img src="https://cla-assistant.io/readme/badge/watson-developer-cloud/node-red-node-watson" alt="CLA assistant" /></a>
 
-### New in version 0.8.1
+### New in version 0.8.2
 - Node-RED & IBM-Watson & Use of promises on API invocation & IAM URL construct migration & Removal of default endpoint of
     - Document Translator node
+    - Discovery node
+    - Discovery Document Loader node
+    - Discovery Query Builder node
 
 
 ### New in version 0.8.1

services/discovery/discovery-utils.js

@@ -14,25 +14,29 @@
  * limitations under the License.
  **/
 const pkg = require('../../package.json'),
-  DiscoveryV1 = require('watson-developer-cloud/discovery/v1');
+  DiscoveryV1 = require('ibm-watson/discovery/v1'),
+  { IamAuthenticator } = require('ibm-watson/auth');
+
 
 function DiscoveryUtils() {}
 DiscoveryUtils.prototype = {
 
   buildService: function(username, password, apikey, endpoint) {
+    let authSettings = {};
     let serviceSettings = {
-      version_date: '2018-12-03',
+      version: '2019-04-30',
       headers: {
         'User-Agent': pkg.name + '-' + pkg.version
       }
     };
 
     if (apikey) {
-      serviceSettings.iam_apikey = apikey;
+      authSettings.apikey = apikey;
     } else {
-      serviceSettings.username = username;
-      serviceSettings.password = password;
+      authSettings.username = username;
+      authSettings.password = password;
     }
+    serviceSettings.authenticator = new IamAuthenticator(authSettings);
 
     if (endpoint) {
       serviceSettings.url = endpoint;
@@ -64,7 +68,7 @@ DiscoveryUtils.prototype = {
       targetField = 'query';
 
     if (config.nlp_query || (msg.discoveryparams && msg.discoveryparams.nlp_query)) {
-      targetField = 'natural_language_query';
+      targetField = 'naturalLanguageQuery';
     }
     if (msg.discoveryparams && msg.discoveryparams[sourceField]) {
       params[targetField] = msg.discoveryparams[sourceField];
@@ -83,7 +87,7 @@ DiscoveryUtils.prototype = {
       params.file = this.isJsonObject(msg.payload) ?
         JSON.stringify(msg.payload) :
         msg.payload;
-      params.file_content_type = 'application/json';
+      params.fileContentType = 'application/json';
     }
     return params;
   },
@@ -149,7 +153,7 @@ DiscoveryUtils.prototype = {
     params = me.buildParamsForName(msg, config, params);
     params = me.buildParamsForQuery(msg, config, params);
 
-    ['environment_id', 'collection_id', 'configuration_id',
+    ['environmentId', 'collectionId', 'configurationId',
       'collection_name', 'language_code',
       'passages', 'description', 'size', 'filename',
       'highlight'
@@ -173,10 +177,10 @@ DiscoveryUtils.prototype = {
   buildMsgOverrides: function(msg, config) {
     var params = {};
     if (config.environment) {
-      params.environment_id = config.environment;
+      params.environmentId = config.environment;
     }
     if (config.collection) {
-      params.collection_id = config.collection;
+      params.collectionId = config.collection;
     }
     if (config.passages) {
       params.passages = config.passages;
@@ -222,7 +226,7 @@ DiscoveryUtils.prototype = {
 
   paramEnvCheck: function(params) {
     var response = '';
-    if (!params.environment_id) {
+    if (!params.environmentId) {
       response = 'Missing Environment ID ';
     }
     return response;
@@ -262,15 +266,15 @@ DiscoveryUtils.prototype = {
 
   paramCollectionCheck: function(params) {
     var response = '';
-    if (!params.collection_id) {
+    if (!params.collectionId) {
       response = 'Missing Collection ID ';
     }
     return response;
   },
 
   paramConfigurationCheck: function(params) {
     var response = '';
-    if (!params.configuration_id) {
+    if (!params.configurationId) {
       response = 'Missing Configuration ID ';
     }
     return response;

services/discovery/v1.html

@@ -38,11 +38,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>
@@ -66,6 +61,7 @@
             <option value="createConfiguration">Create new configuration</option>
             <option value="listConfigurations">List existing configurations</option>
             <option value="getConfigurationDetails">Retrieve configuration details</option>
+            <option value="deleteConfiguration">Delete configuration</option>
         </select>
     </div>
 
@@ -74,24 +70,24 @@
         <input type="text" id="node-input-environmentname" placeholder="">
     </div>
     <div class="form-row">
-        <label for="node-input-environment_id"><i class="fa fa-tag"></i> Environment ID</label>
-        <input type="text" id="node-input-environment_id" placeholder="">
+        <label for="node-input-environmentId"><i class="fa fa-tag"></i> Environment ID</label>
+        <input type="text" id="node-input-environmentId" placeholder="">
     </div>
     <div class="form-row">
         <label for="node-input-collection_name"><i class="fa fa-tag"></i> Collection Name</label>
         <input type="text" id="node-input-collection_name" placeholder="">
     </div>
     <div class="form-row">
-        <label for="node-input-collection_id"><i class="fa fa-tag"></i> Collection ID</label>
-        <input type="text" id="node-input-collection_id" placeholder="">
+        <label for="node-input-collectionId"><i class="fa fa-tag"></i> Collection ID</label>
+        <input type="text" id="node-input-collectionId" placeholder="">
     </div>
     <div class="form-row">
         <label for="node-input-configurationname"><i class="fa fa-tag"></i> Configuration Name</label>
         <input type="text" id="node-input-configurationname" placeholder="">
     </div>
     <div class="form-row">
-        <label for="node-input-configuration_id"><i class="fa fa-tag"></i> Configuration ID</label>
-        <input type="text" id="node-input-configuration_id" placeholder="">
+        <label for="node-input-configurationId"><i class="fa fa-tag"></i> Configuration ID</label>
+        <input type="text" id="node-input-configurationId" placeholder="">
     </div>
 
     <div class="form-row">
@@ -208,7 +204,7 @@
             <p>For this method the node needs an Environment ID as input.
             </p>
             <p>The environment being requested can be overridden by specifying the search id
-      in <code>msg.discoveryparams.environment_id</code>
+      in <code>msg.discoveryparams.environmentId</code>
             </p>
             <p>Node output : </p>
               <ul>
@@ -221,10 +217,10 @@
             Description, Configuration ID and Language Code as input.
             </p>
             <p>The fields can be overridden by specifying
-              in <code>msg.discoveryparams.environment_id</code>
+              in <code>msg.discoveryparams.environmentId</code>
               , <code>msg.discoveryparams.collection_name</code>
               , <code>msg.discoveryparams.description</code>
-              , <code>msg.discoveryparams.configuration_id</code>
+              , <code>msg.discoveryparams.configurationId</code>
               and <code>msg.discoveryparams.language_code</code>
             </p>
 
@@ -239,7 +235,7 @@
             <p><b>List Existing Collections</b><p>
             <p>For this method the node needs an Environment ID as input.</p>
             <p>The Environment ID for the collection list being requested can be overridden by specifying the search id
-      in <code>msg.discoveryparams.environment_id</code>
+      in <code>msg.discoveryparams.environmentId</code>
             </p>
             <p>Node output : </p>
               <ul>
@@ -254,8 +250,8 @@
             </p>
             <p>The collection being requested can be overridden by specifying the
             search ids in
-            <code>msg.discoveryparams.environment_id</code>
-            and <code>msg.discoveryparams.collection_id</code>
+            <code>msg.discoveryparams.environmentId</code>
+            and <code>msg.discoveryparams.collectionId</code>
             </p>
             <p>Node output : </p>
               <ul>
@@ -270,7 +266,7 @@
                configuration with the given name.</p>
             <p>The Environment ID for the configuration list being requested can be
                overridden by specifying the environment id in
-               <code>msg.discoveryparams.environment_id</code>
+               <code>msg.discoveryparams.environmentId</code>
                The configuration name can be overridden by specifying the name inspect
                <code>msg.discoveryparams.configuration_name</code>
             </p>
@@ -288,9 +284,9 @@
             <p>The Environment and Configuration IDs for the configuration being
                requested can be
                overridden by specifying the environment id in
-               <code>msg.discoveryparams.environment_id</code>
+               <code>msg.discoveryparams.environmentId</code>
                and the configuration id in
-               <code>msg.discoveryparams.configuration_id</code>
+               <code>msg.discoveryparams.configurationId</code>
             </p>
             <p>Node output : </p>
               <ul>
@@ -299,14 +295,31 @@
               </ul>
         </li>
         <br/>
+        <li>
+            <p><b>Delete Configuration</b><p>
+            <p>For this method node needs an Environment ID and Configuration ID as input.</p>
+            <p>The Environment and Configuration IDs for the configuration being
+               deleted can be
+               overridden by specifying the environment id in
+               <code>msg.discoveryparams.environmentId</code>
+               and the configuration id in
+               <code>msg.discoveryparams.configurationId</code>
+            </p>
+            <p>Node output : </p>
+              <ul>
+                <li><code>msg.configuration</code> : Details the
+                  deleted configuration.</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.
             </p>
             <p>The collection being requested can be overridden by specifying the
             search ids in
-            <code>msg.discoveryparams.environment_id</code>
-            and <code>msg.discoveryparams.collection_id</code>
+            <code>msg.discoveryparams.environmentId</code>
+            and <code>msg.discoveryparams.collectionId</code>
             </p>
             <p>Optionally you can specify the number of documents to retrieve, a
                query to find the most relevant search results, whether to
@@ -351,11 +364,11 @@
     //disV1.abc = 'abc';
     disV1.hideAll = function() {
       $('#node-input-environmentname').parent().hide();
-      $('#node-input-environment_id').parent().hide();
+      $('#node-input-environmentId').parent().hide();
       $('#node-input-collection_name').parent().hide();
-      $('#node-input-collection_id').parent().hide();
+      $('#node-input-collectionId').parent().hide();
       $('#node-input-configurationname').parent().hide();
-      $('#node-input-configuration_id').parent().hide();
+      $('#node-input-configurationId').parent().hide();
       $('#node-input-language_code').parent().hide();
       $('#node-input-count').parent().hide();
       $('#node-input-passages').parent().hide();
@@ -387,35 +400,36 @@
           fields.push('#node-input-environmentname');
           break;
         case 'createCollection':
-          fields.push('#node-input-environment_id'
-                          + ', #node-input-configuration_id'
+          fields.push('#node-input-environmentId'
+                          + ', #node-input-configurationId'
                           + ', #node-input-language_code'
                           + ', #node-input-collection_name'
                           + ', #node-input-description');
           break;
-        case 'createConfiguration':
+        case 'listConfigurations':
         case 'getEnvironmentDetails':
         case 'listCollections':
         case 'deleteEnvironment':
-          fields.push('#node-input-environment_id');
+          fields.push('#node-input-environmentId');
           break;
         case 'getCollectionDetails':
         case 'deleteCollection':
-          fields.push('#node-input-environment_id'
-                          + ', #node-input-collection_id');
+          fields.push('#node-input-environmentId'
+                          + ', #node-input-collectionId');
           break;
-        case 'listConfigurations':
-          fields.push('#node-input-environment_id'
+        case 'createConfiguration':
+          fields.push('#node-input-environmentId'
                           + ', #node-input-configurationname');
           break;
         case 'getConfigurationDetails':
-          fields.push('#node-input-environment_id'
-                         + ', #node-input-configuration_id');
+        case 'deleteConfiguration':
+          fields.push('#node-input-environmentId'
+                         + ', #node-input-configurationId');
           break;
         case 'query':
-        case 'queryNotices':        
-          fields.push('#node-input-environment_id'
-                         + ', #node-input-collection_id'
+        case 'queryNotices':
+          fields.push('#node-input-environmentId'
+                         + ', #node-input-collectionId'
                          + ', #node-input-count'
                          + ', #node-input-passages'
                          + ', #node-input-nlp_query'
@@ -433,15 +447,6 @@
         var method = $('#node-input-discovery-method').val();
         disV1.processSelectedMethod(method);
       });
-
-      $('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();
-          }
-      });
     }
 
     disV1.checkForPrepare = function () {
@@ -469,10 +474,10 @@
             defaults: {
                 name: {value: ''},
                 environmentname: {value: ''},
-                environment_id: {value: ''},
-                collection_id: {value: ''},
+                environmentId: {value: ''},
+                collectionId: {value: ''},
                 configurationname: {value: ''},
-                configuration_id: {value: ''},
+                configurationId: {value: ''},
                 language_code: {value: 'en'},
                 collection_name: {value: ''},
                 count: {value: '1'},
@@ -485,8 +490,7 @@
                 description: {value: ''},
                 size: {value: 'LT'},
                 'discovery-method': {value:'query'},
-                'default-endpoint' :{value: true},
-                'service-endpoint' :{value: 'https://gateway.watsonplatform.net/discovery/api'}
+                'service-endpoint' :{value: ''}
             },
             credentials: {
               username: {type:'text'},