Merge pull request #412 from chughts/iamkeys

Iam keys

Author: chughts

ChangeHistory.md

@@ -1,3 +1,88 @@
+## 0.6.x
+
+### New in version 0.6.14
+- Visual Recognition instances created post May 22 2018, have a new authentication mechanism
+
+### New in version 0.6.13
+- Added opt-out option for collection parsing of strings in Natural Language Classifier Node.
+
+### New in version 0.6.12
+- Fix to collection check in Natural Language Classification Node allowing for . in domain
+names.
+
+### New in version 0.6.11
+- Fix to defaulting name for NLU Node.
+- Allow pre-check of audio format to be disabled in Speech to Text node.
+- Migrate from deprecated getModels and getCustomizations methods in Speech to Text nodes.
+- Implement update classifier in Visual Recognition Util node.
+- In Visual Recognition Util node append 'positive_' to zip name if neither 'positive' not 'negative' not already there.
+- Removed duplicated code in Visual Recognition Util node.
+
+### New in version 0.6.10
+- Needed to stringify json before addDocument in Discovery node.
+- Using Node.js v 6 features, so will not run on Node.js v 4 anymore
+
+### New in version 0.6.9
+- Implemented classify collection on Natural Language Classifier node. The collection can be
+in the form of multiple sentences, an array of strings, or an array of objects.
+
+### New in version 0.6.8
+- Move all Discovery calls to latest API version - 2017-11-07
+- Updated calls to deprecated discovery methods addJsonDocument and getCollections
+- Correct implemetation of passages related options
+- Allow highlight option to be specified in Discovery overrides - msg.discoveryparams
+- Rename Conversation Nodes to Assistant
+- Use Assistant endpoint
+- Move all Assistant calls to latest API version - 2018-02-16
+- Move all Visual Recognition calls to lates API version - 2018-03-19
+- Add French as a Visual Recognition classification response language
+
+### New in version 0.6.7
+- Enable Opt-out option for Conversation Node.
+- Implement time out option for response from Conversation Node.
+- Bump to v 3.2.1 of watson-developer-cloud dependency.
+- Fix to how API version is specified in Natural Language Understanding Node.
+- Add Korean to list of languages in Natural Language Classifier Node.
+
+### New in version 0.6.6
+- Added Mute option for STT Node warning status when running in Streaming mode
+- Discard option for STT Node Streaming listening events.
+- Added Auto-Connect mode for STT Node - Will keep connection to service alive,
+else connection is restored on demand.
+- Fix to Discovery Query Builder Node to return schema options.
+
+### New in version 0.6.5
+- Endpoint can now be specified in Natural Language Classifier Node
+
+### New in version 0.6.4
+- Speech to Text node now reports all errors, including disconnects when running in stream mode.
+
+### New in version 0.6.3
+- Allow input / output from Node-RED web-sockets for Speech to Text node. To
+enable select streaming mode. No token is needed as the Node handles this. Look
+out for sample flows and templates showing how to use this feature.
+- Three new languages for Language Translator, Polish, Russian and Turkish in Neural Translation mode.
+- Removed the code for the deprecated Language Translation Nodes.  
+
+### New in version 0.6.2
+- Visual Recognition fix for accept-language
+
+### New in version 0.6.1
+- Allow STT Language to be dyamically configurable using msg.srclang
+
+### New in version 0.6.0
+- Bump to watson-developer-cloud 3.0.4
+- Document link updates
+- IE fix
+- Option to set Conversation credentials though msg.params
+- Speech To Text fullresult now includes speaker_labels. Breaking change to any code that used fullresult due an extra level of indirection.
+- Allow Korean as an option for Personality Insights
+- Text Recognition option removed from Visual Recognition Node
+- Move Retrieve and Rank nodes to deprecated list
+- Removed Document Conversion, Alchemy, Concept Insights, Dialog, Tradeoff Analytics and Similarity Search Nodes
+- Nodes deprecated in 0.5.x will be removed in 0.6.x releases
+
+
 ## 0.5.x
 
 ### New in version 0.5.23

README.md

@@ -7,87 +7,15 @@ 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.6.14
-- Visual Recognition instances created post May 22 2018, have a new authentication mechanism 
-
-### New in version 0.6.13
-- Added opt-out option for collection parsing of strings in Natural Language Classifier Node.
-
-### New in version 0.6.12
-- Fix to collection check in Natural Language Classification Node allowing for . in domain
-names.
-
-### New in version 0.6.11
-- Fix to defaulting name for NLU Node.
-- Allow pre-check of audio format to be disabled in Speech to Text node.
-- Migrate from deprecated getModels and getCustomizations methods in Speech to Text nodes.
-- Implement update classifier in Visual Recognition Util node.
-- In Visual Recognition Util node append 'positive_' to zip name if neither 'positive' not 'negative' not already there.
-- Removed duplicated code in Visual Recognition Util node.
-
-### New in version 0.6.10
-- Needed to stringify json before addDocument in Discovery node.
-- Using Node.js v 6 features, so will not run on Node.js v 4 anymore
-
-### New in version 0.6.9
-- Implemented classify collection on Natural Language Classifier node. The collection can be
-in the form of multiple sentences, an array of strings, or an array of objects.
-
-### New in version 0.6.8
-- Move all Discovery calls to latest API version - 2017-11-07
-- Updated calls to deprecated discovery methods addJsonDocument and getCollections
-- Correct implemetation of passages related options
-- Allow highlight option to be specified in Discovery overrides - msg.discoveryparams
-- Rename Conversation Nodes to Assistant
-- Use Assistant endpoint
-- Move all Assistant calls to latest API version - 2018-02-16
-- Move all Visual Recognition calls to lates API version - 2018-03-19
-- Add French as a Visual Recognition classification response language
-
-### New in version 0.6.7
-- Enable Opt-out option for Conversation Node.
-- Implement time out option for response from Conversation Node.
-- Bump to v 3.2.1 of watson-developer-cloud dependency.
-- Fix to how API version is specified in Natural Language Understanding Node.
-- Add Korean to list of languages in Natural Language Classifier Node.
-
-### New in version 0.6.6
-- Added Mute option for STT Node warning status when running in Streaming mode
-- Discard option for STT Node Streaming listening events.
-- Added Auto-Connect mode for STT Node - Will keep connection to service alive,
-else connection is restored on demand.
-- Fix to Discovery Query Builder Node to return schema options.
-
-### New in version 0.6.5
-- Endpoint can now be specified in Natural Language Classifier Node
-
-### New in version 0.6.4
-- Speech to Text node now reports all errors, including disconnects when running in stream mode.
-
-### New in version 0.6.3
-- Allow input / output from Node-RED web-sockets for Speech to Text node. To
-enable select streaming mode. No token is needed as the Node handles this. Look
-out for sample flows and templates showing how to use this feature.
-- Three new languages for Language Translator, Polish, Russian and Turkish in Neural Translation mode.
-- Removed the code for the deprecated Language Translation Nodes.  
-
-### New in version 0.6.2
-- Visual Recognition fix for accept-language
-
-### New in version 0.6.1
-- Allow STT Language to be dyamically configurable using msg.srclang
-
-### New in version 0.6.0
-- Bump to watson-developer-cloud 3.0.4
-- Document link updates
-- IE fix
-- Option to set Conversation credentials though msg.params
-- Speech To Text fullresult now includes speaker_labels. Breaking change to any code that used fullresult due an extra level of indirection.
-- Allow Korean as an option for Personality Insights
-- Text Recognition option removed from Visual Recognition Node
-- Move Retrieve and Rank nodes to deprecated list
-- Removed Document Conversion, Alchemy, Concept Insights, Dialog, Tradeoff Analytics and Similarity Search Nodes
-- Nodes deprecated in 0.5.x will be removed in 0.6.x releases
+### New in version 0.7.0
+- Assistant, Discovery, Natural Language Understanding, Speech to Text, Text to Speech, Tone Analyzer nodes updated
+to allow for use of iam key for authentication.
+- Migrated STT node off deprecated methods.
+- Fix to Tone Analyzer Node to preserve credentials on config reopen.
+- Fix to Tone Analyzer to allow json objects and arrays as payload.
+- Fix to STT where auto-connect was not being preserved when reopening configuration.
+- Bump to 2018-03-05 version date for Discovery service.
+- Migrated Discovery Nodes off deprecated methods.
 
 
 ### Watson Nodes for Node-RED

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-node-watson",
-  "version": "0.6.14",
+  "version": "0.7.0",
   "description": "A collection of Node-RED nodes for IBM Watson services",
   "dependencies": {
     "async": "^1.5.2",
@@ -10,7 +10,7 @@
     "temp": "^0.8.3",
     "qs": "6.x",
     "image-type": "^2.0.2",
-    "watson-developer-cloud": "^3.4.2",
+    "watson-developer-cloud": "^3.4.5",
     "kuromoji": "^0.1.1",
     "word-count": "^0.2.2",
     "is-docx": "^0.0.3",

services/conversation/v1-workspace-manager.html

@@ -38,6 +38,11 @@
         <label for="node-input-password"><i class="fa fa-key"></i> Password</label>
         <input type="password" id="node-input-password" placeholder="Password"></input>
     </div>
+    <div class="form-row credentials" style="display: none;">
+        <label for="node-input-apikey"><i class="fa fa-key"></i> API Key</label>
+        <input type="password" id="node-input-apikey" placeholder="API Key"></input>
+    </div>
+
     <div class="form-row credentials">
         <label>&nbsp;</label>
         <input type="checkbox" id="node-input-cwm-default-endpoint" style="display: inline-block; width: auto; vertical-align: top;">
@@ -352,6 +357,9 @@
       <li>
         <code>msg.params.password</code>
       </li>
+      <li>
+        <code>msg.params.apikey</code>
+      </li>
       <li>
         <code>msg.params.workspace_id</code>
       </li>
@@ -596,7 +604,8 @@
             },
             credentials: {
               username: {type:'text'},
-              password: {type: 'password'}
+              password: {type: 'password'},
+              apikey: {type: 'password'}
             },
             color: 'rgb(84,149,180)',
             inputs: 1,

services/conversation/v1-workspace-manager.js

@@ -26,6 +26,7 @@ module.exports = function (RED) {
     AssistantV1 = require('watson-developer-cloud/assistant/v1'),
     service = serviceutils.getServiceCreds(SERVICE_IDENTIFIER),
     username = '', password = '', sUsername = '', sPassword = '',
+    apikey = '', sApikey = '',
     endpoint = '', sEndpoint = '';
 
   if (!service) {
@@ -45,8 +46,10 @@ module.exports = function (RED) {
   // the edited ones are not being taken.
 
   if (service) {
-    sUsername = service.username;
-    sPassword = service.password;
+    sUsername = service.username ? service.username : '';
+    sPassword = service.password ? service.password : '';
+    sApikey = service.apikey ? service.apikey : '';
+
     sEndpoint = service.url;
   }
 
@@ -503,15 +506,20 @@ module.exports = function (RED) {
   function executeMethod(node, method, params, msg) {
     var conv = null,
       serviceSettings = {
-        username: username,
-        password: password,
         version_date: '2018-02-16',
         version: '2018-02-16',
         headers: {
           'User-Agent': pkg.name + '-' + pkg.version
         }
       };
 
+    if (apikey) {
+      serviceSettings.iam_apikey = apikey;
+    } else {
+      serviceSettings.username = username;
+      serviceSettings.password = password;
+    }
+
     if (endpoint) {
       serviceSettings.url = endpoint;
     }
@@ -1040,9 +1048,9 @@ module.exports = function (RED) {
     return Promise.resolve(false);
   }
 
-  function initialCheck(u, p, m) {
+  function initialCheck(a, u, p, m) {
     var message = '';
-    if (!u || !p) {
+    if (!a && (!u || !p)) {
       message = 'Missing Conversation service credentials';
     } else if (!m || '' === m) {
       message = 'Required mode has not been specified';
@@ -1076,6 +1084,7 @@ module.exports = function (RED) {
 
       username = sUsername || this.credentials.username;
       password = sPassword || this.credentials.password || config.password;
+      apikey = sApikey || this.credentials.apikey || config.apikey;
 
       // All method to be overridden
       if (msg.params) {
@@ -1088,14 +1097,17 @@ module.exports = function (RED) {
         if (msg.params.password) {
           password = msg.params.password;
         }
+        if (msg.params.apikey) {
+          apikey = msg.params.apikey;
+        }
       }
       endpoint = sEndpoint;
       if ((!config['cwm-default-endpoint']) && config['cwm-service-endpoint']) {
         endpoint = config['cwm-service-endpoint'];
       }
 
       node.status({});
-      initialCheck(username, password, method)
+      initialCheck(apikey, username, password, method)
         .then(function(){
           return buildParams(msg, method, config, params);
         })
@@ -1134,7 +1146,8 @@ module.exports = function (RED) {
   RED.nodes.registerType('watson-conversation-v1-workspace-manager', Node, {
     credentials: {
       username: {type:'text'},
-      password: {type:'password'}
+      password: {type:'password'},
+      apikey: {type: 'password'}
     }
   });
 

services/conversation/v1.html

@@ -34,6 +34,10 @@
         <label for="node-input-password"><i class="fa fa-key"></i> Password</label>
         <input type="password" id="node-input-password" placeholder="Password">
     </div>
+    <div class="form-row credentials" style="display: none;">
+        <label for="node-input-apikey"><i class="fa fa-key"></i> API Key</label>
+        <input type="password" id="node-input-apikey" placeholder="API Key"></input>
+    </div>
 
     <div class="form-row credentials">
         <label>&nbsp;</label>
@@ -100,6 +104,7 @@
     <br/>
     <li><code>msg.params.username</code> : If provided will be used as the username credential for the Conversation service.</li>
     <li><code>msg.params.password</code> : If provided will be used as the password credential for the Conversation service.</li>
+    <li><code>msg.params.apikey</code> : If provided will be used as the api key credential for the Conversation service.</li>
     <li><code>msg.params.endpoint</code> : If provided will be used as the url for the Conversation service.</li>
     <li><code>msg.params.optout_learning</code> : Set to true to opt out of request logging. Check the <a href="https://console.bluemix.net/docs/services/watson/getting-started-logging.html#controlling-request-logging-for-watson-services" target="_blank">documentation</a> for details.</li>
     </ul>
@@ -165,7 +170,8 @@
             },
             credentials: {
               username: {type:'text'},
-              password: {type:'password'}
+              password: {type:'password'},
+              apikey: {type:'password'}
             },
             color: 'rgb(84,149,230)',
             inputs: 1,