Query Notices
+
Queries for notices (errors or warnings) that might have been generated by the system
For this method the node needs an Environment ID and Collection ID as input. +
For more information about the Discovery service, @@ -405,6 +413,7 @@ + ', #node-input-configuration_id'); break; case 'query': + case 'queryNotices': fields.push('#node-input-environment_id' + ', #node-input-collection_id' + ', #node-input-count' diff --git a/services/discovery/v1.js b/services/discovery/v1.js index 4a17a3ea..86fdc0d9 100644 --- a/services/discovery/v1.js +++ b/services/discovery/v1.js @@ -48,6 +48,7 @@ module.exports = function (RED) { break; case 'getCollectionDetails': case 'query': + case 'queryNotices': response = discoveryutils.paramEnvCheck(params) + discoveryutils.paramCollectionCheck(params); break; @@ -242,12 +243,27 @@ module.exports = function (RED) { return p; } + function executeQueryNotices(node, discovery, params, msg) { + var p = new Promise(function resolver(resolve, reject){ + discovery.queryNotices(params, function (err, response) { + if (err) { + reject(err); + } else { + msg.search_results = response; + resolve(); + } + }); + }); + return p; + } + function unknownMethod(node, discovery, params, msg) { return Promise.reject('Unable to process as unknown mode has been specified'); } function executeMethod(node, method, params, msg) { let discovery = discoveryutils.buildService(username, password, apikey, endpoint); + var p = null; switch (method) { case 'createEnvrionment': @@ -286,6 +302,9 @@ module.exports = function (RED) { 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; diff --git a/services/language_translator/translator-utils.js b/services/language_translator/translator-utils.js new file mode 100644 index 00000000..1752dc10 --- /dev/null +++ b/services/language_translator/translator-utils.js @@ -0,0 +1,39 @@ +/** + * Copyright 2018 IBM Corp. + * + * Licensed under the Apache License, Version 2.0 (the 'License'); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + + +class TranslatorUtils { + constructor() { + } + + credentialCheck(u, p, k) { + if (!k && (!u || !p)) { + return Promise.reject('Missing Watson Language Translator service credentials'); + } + return Promise.resolve(); + } + + checkForAction(action) { + if (!action) { + return Promise.reject('Missing action, please select one'); + } + return Promise.resolve(); + } + +} + +var translatorutils = new TranslatorUtils(); +module.exports = translatorutils ; diff --git a/services/language_translator/v3-doc.html b/services/language_translator/v3-doc.html new file mode 100644 index 00000000..db2b354f --- /dev/null +++ b/services/language_translator/v3-doc.html @@ -0,0 +1,556 @@ + + + + + + + + diff --git a/services/language_translator/v3-doc.js b/services/language_translator/v3-doc.js new file mode 100644 index 00000000..4679a525 --- /dev/null +++ b/services/language_translator/v3-doc.js @@ -0,0 +1,495 @@ +/** + * Copyright 2018 IBM Corp. + * + * Licensed under the Apache License, Version 2.0 (the 'License'); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an 'AS IS' BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +module.exports = function (RED) { + const request = require('request'), + SERVICE_IDENTIFIER = 'language-translator', + SERVICE_VERSION = '2018-05-01'; + + var pkg = require('../../package.json'), + LanguageTranslatorV3 = require('watson-developer-cloud/language-translator/v3'), + fs = require('fs'), + fileType = require('file-type'), + temp = require('temp'), + serviceutils = require('../../utilities/service-utils'), + payloadutils = require('../../utilities/payload-utils'), + translatorutils = require('./translator-utils'), + username = null, + password = null, + sUsername = null, + sPassword = null, + apikey = null, + sApikey = null, + endpoint = '', + sEndpoint = 'https://gateway.watsonplatform.net/language-translator/api', + service = serviceutils.getServiceCreds(SERVICE_IDENTIFIER); + + if (service) { + sUsername = service.username ? service.username : ''; + sPassword = service.password ? service.password : ''; + sApikey = service.apikey ? service.apikey : ''; + sEndpoint = service.url; + } + + // Node RED Admin - fetch and set vcap services + RED.httpAdmin.get('/watson-doc-translator/vcap', function (req, res) { + res.json(service ? {bound_service: true} : null); + }); + + + // API used by widget to fetch available models + RED.httpAdmin.get('/watson-doc-translator/models', function (req, res) { + endpoint = req.query.e ? req.query.e : sEndpoint; + var lt = null, + serviceSettings = { + version: SERVICE_VERSION, + url: endpoint, + headers: { + 'User-Agent': pkg.name + '-' + pkg.version + } + }; + + if (sApikey || req.query.key) { + serviceSettings.iam_apikey = sApikey ? sApikey : req.query.key; + } else { + serviceSettings.username = sUsername ? sUsername : req.query.un; + serviceSettings.password = sPassword ? sPassword : req.query.pwd; + } + + lt = new LanguageTranslatorV3(serviceSettings); + + lt.listModels({}, function (err, models) { + if (err) { + res.json(err); + } else { + res.json(models); + } + }); + }); + + + function Node (config) { + var node = this; + RED.nodes.createNode(this, config); + + function payloadCheck(msg, mode) { + var message = null; + switch (mode) { + case 'listDocuments': + case 'documentStatus': + case 'deleteDocument': + case 'getDocument': + case 'translateSubmittedDocument': + break; + case 'translateDocument': + if (!msg.payload) { + message = 'Missing property: msg.payload'; + } + break; + default: + message = 'Unexpected Mode'; + break; + } + if (message) { + return Promise.reject(message); + } + return Promise.resolve(); + } + + function docID(msg) { + if (msg.payload && 'string' === typeof msg.payload) { + return msg.payload; + } + if (msg.payload && + 'object' === typeof msg.payload && + msg.payload.document_id) { + return msg.payload.document_id; + } + return config['document-id']; + } + + function paramCheck(msg, mode) { + var message = null; + switch (mode) { + case 'listDocuments': + case 'translateDocument': + break; + case 'documentStatus': + case 'deleteDocument': + case 'getDocument': + case 'translateSubmittedDocument': + if (!docID(msg)) { + message = 'Document ID is required'; + } + break; + default: + break; + } + if (message) { + return Promise.reject(message); + } + return Promise.resolve(); + } + + + function buildAuthSettings () { + var authSettings = {}; + if (apikey) { + authSettings.user = 'apikey'; + authSettings.pass = apikey; + } else { + authSettings.user = username; + authSettings.pass = password; + } + return authSettings; + } + + function executeRequest(uriAddress, method) { + return new Promise(function resolver(resolve, reject){ + var authSettings = buildAuthSettings(); + + request({ + uri: uriAddress, + method: method, + auth: authSettings + }, (error, response, body) => { + if (error) { + reject(error); + } else { + switch (response.statusCode) { + case 200: + let data = null; + try { + data = JSON.parse(body); + } catch(e) { + data = body; + } + resolve(data); + break; + case 204: + resolve(body); + break; + case 404: + reject('Document not found ' + response.statusCode); + break; + default: + console.log(body); + reject('Error Invoking API ' + response.statusCode); + break; + } + } + }); + + }); + } + + function executeGetRequest(uriAddress) { + return executeRequest(uriAddress, 'GET'); + } + + function executeDeleteRequest(uriAddress) { + return executeRequest(uriAddress, 'DELETE'); + } + + function verifyDocumentPayload (msg) { + if (!msg.payload) { + return Promise.reject('Missing property: msg.payload'); + } else if ( (msg.payload instanceof Buffer) || + (payloadutils.isJsonObject(msg.payload)) ) { + return Promise.resolve(); + } else { + return Promise.reject('msg.payload should be a data buffer or json object'); + } + } + + function determineSuffix(msg) { + var ext = '.json'; + + if (msg.payload instanceof Buffer) { + var ft = fileType(msg.payload); + + if (ft && ft.ext) { + ext = '.' + ft.ext; + } else { + // We don't know what file type, so just assume .txt + ext = '.txt'; + } + } + + return Promise.resolve(ext); + } + + function loadFile(suffix) { + return new Promise(function resolver(resolve, reject){ + var options = {}; + if (suffix) { + options.suffix = suffix; + } + temp.open(options, function(err, info) { + if (err) { + reject('Error opening temp file'); + } else { + resolve(info); + } + }); + }); + } + + function syncTheFile(info, msg) { + return new Promise(function resolver(resolve, reject){ + fs.writeFile(info.path, msg.payload, function(err) { + if (err) { + reject('Error processing buffer'); + } + resolve(); + }); + }); + } + + function createStream(info) { + //var theStream = fs.createReadStream(info.path, 'utf8'); + var theStream = fs.readFileSync(info.path, 'utf8'); + return Promise.resolve(theStream); + } + + function whatName(msg, suffix){ + var name = 'Doc ' + (new Date()).toString(); // + suffix; + if (msg && msg.filename) { + name = msg.filename; + } else if (config && config.filename ) { + name = config.filename; + } + name = name.replace(/[^0-9a-z]/gi, ''); + return (name + suffix); + } + + function sourceLang(msg) { + if (msg.payload && + 'object' === typeof msg.payload && + msg.payload.source) { + return msg.payload.source; + } + return msg.srclang ? msg.srclang : config.srclang; + } + + function executePostRequest(uriAddress, params, msg) { + return new Promise(function resolver(resolve, reject){ + var authSettings = buildAuthSettings(); + + request({ + uri: uriAddress, + method: 'POST', + auth: authSettings, + formData: params + }, (error, response, body) => { + if (!error && response.statusCode === 200) { + let data = JSON.parse(body); + resolve(data); + } else if (error) { + reject(error); + } else { + reject('Error performing request ' + response.statusCode + ' ' + body); + } + }); + }); + } + + function executeUnknownMethod(msg) { + return Promise.reject('Unable to process as unknown mode has been specified'); + } + + function executeListDocuments(msg) { + let uriAddress = `${endpoint}/v3/documents?version=${SERVICE_VERSION}`; + return executeGetRequest(uriAddress); + } + + function executeGetDocumentStatus(msg) { + var docid = docID(msg); + let uriAddress = `${endpoint}/v3/documents/${docid}?version=${SERVICE_VERSION}`; + + return executeGetRequest(uriAddress); + } + + function executeGetDocument(msg) { + var docid = docID(msg); + let uriAddress = `${endpoint}/v3/documents/${docid}/translated_document?version=${SERVICE_VERSION}`; + + return executeGetRequest(uriAddress); + } + + function executeDeleteDocument(msg) { + var docid = docID(msg); + //let uriAddress = endpoint + '/v3/documents/' + docid + '?version=' + SERVICE_VERSION; + let uriAddress = `${endpoint}/v3/documents/${docid}?version=${SERVICE_VERSION}`; + + return executeDeleteRequest(uriAddress); + } + + function executeTranslateSubmittedDocument(msg) { + let uriAddress = `${endpoint}/v3/documents?version=${SERVICE_VERSION}`; + var params = { + 'source' : sourceLang(msg), + 'target' : msg.destlang ? msg.destlang : config.destlang, + 'document_id' : docID(msg) + }; + return executePostRequest(uriAddress, params, msg); + } + + function executeTranslateDocument(msg) { + var p = null, + fileInfo = null, + fileSuffix = ''; + let uriAddress = `${endpoint}/v3/documents?version=${SERVICE_VERSION}`; + + p = verifyDocumentPayload(msg) + .then (() => { + return determineSuffix(msg); + }) + .then ((suffix) => { + //return loadFile(uriAddress, msg, ext); + fileSuffix = suffix; + return loadFile(suffix); + }) + .then ((info) => { + fileInfo = info; + return syncTheFile(fileInfo, msg); + }) + .then(function(){ + return createStream(fileInfo); + }) + .then(function(theStream){ + //params.file = theStream; + //var fname = 'temp' + fileSuffix; + var params = { + 'source' : msg.srclang ? msg.srclang : config.srclang, + 'target' : msg.destlang ? msg.destlang : config.destlang + }; + var fname = whatName(msg, fileSuffix); + + params.file = { + value: theStream, + options: { + filename: fname + } + }; + + //return Promise.reject('temp disabled'); + return executePostRequest(uriAddress, params, msg); + }); + + return p; + } + + + function executeAction(msg, action) { + var f = null; + + const execute = { + 'listDocuments' : executeListDocuments, + 'translateDocument' : executeTranslateDocument, + 'translateSubmittedDocument' : executeTranslateSubmittedDocument, + 'documentStatus' : executeGetDocumentStatus, + 'deleteDocument' : executeDeleteDocument, + 'getDocument' : executeGetDocument + }; + + f = execute[action] || executeUnknownMethod; + node.status({ fill: 'blue', shape: 'dot', text: 'processing' }); + return f(msg); + } + + function processResponse(msg, data) { + msg.payload = data; + return Promise.resolve(); + } + + function doit(msg) { + let action = msg.action || config.action; + + translatorutils.credentialCheck(username, password, apikey) + .then(function(){ + return translatorutils.checkForAction(action); + }) + .then(function(){ + return payloadCheck(msg, action); + }) + .then(function(){ + return paramCheck(msg, action); + }) + .then(function(){ + node.status({fill:'blue', shape:'dot', text:'executing'}); + return executeAction(msg, action); + }) + .then( (data) => { + node.status({ fill: 'blue', shape: 'dot', text: 'processing response' }); + return processResponse(msg, data); + }) + .then(function(){ + temp.cleanup(); + node.status({}); + node.send(msg); + }) + .catch(function(err){ + temp.cleanup(); + payloadutils.reportError(node, msg, err); + node.send(msg); + }); + } + + this.on('input', function (msg) { + // The dynamic nature of this node has caused problems with the password field. it is + // hidden but not a credential. If it is treated as a credential, it gets lost when there + // is a request to refresh the model list. + // Credentials are needed for each of the modes. + username = sUsername || this.credentials.username; + password = sPassword || this.credentials.password || config.password; + apikey = sApikey || this.credentials.apikey || config.apikey; + + endpoint = sEndpoint; + if ((!config['default-endpoint']) && config['service-endpoint']) { + endpoint = config['service-endpoint']; + } + + node.status({}); + temp.track(); + + if ('object' === typeof msg.payload && + msg.payload.documents && + Array.isArray(msg.payload.documents)) { + let len = msg.payload.documents.length; + + msg.payload.documents.forEach((e, i) => { + let msgClone = Object.assign({}, msg), + pos = i+1; + node.status({ fill: 'blue', shape: 'dot', text: `Processing document ${pos} of ${len}` }); + msgClone.payload = e; + doit(msgClone); + }); + + } else { + doit(msg); + } + }); + } + + RED.nodes.registerType('watson-doc-translator', Node, { + credentials: { + username: {type:'text'}, + password: {type:'password'}, + apikey: {type:'password'} + } + }); +}; diff --git a/services/language_translator/v3.html b/services/language_translator/v3.html index 99773084..c22152b9 100644 --- a/services/language_translator/v3.html +++ b/services/language_translator/v3.html @@ -236,6 +236,7 @@ 'fr' : 'French', 'fi' : 'Finnish', 'hi' : 'Hindi', + 'hu' : 'Hungarian', 'it' : 'Italian', 'de' : 'German', 'ja' : 'Japanese', diff --git a/services/language_translator/v3.js b/services/language_translator/v3.js index 469d733d..abce9d87 100644 --- a/services/language_translator/v3.js +++ b/services/language_translator/v3.js @@ -28,6 +28,7 @@ module.exports = function (RED) { //cfenv = require('cfenv'), payloadutils = require('../../utilities/payload-utils'), serviceutils = require('../../utilities/service-utils'), + translatorutils = require('./translator-utils'), fs = require('fs'), temp = require('temp'), username = null, @@ -112,14 +113,6 @@ module.exports = function (RED) { RED.nodes.createNode(this, config); var node = this; - - function initialCheck(u, p, k) { - if (!k && (!u || !p)) { - return Promise.reject('Missing Watson Language Translator service credentials'); - } - return Promise.resolve(); - } - function payloadCheck(msg) { if (!msg.payload) { return Promise.reject('Missing property: msg.payload'); @@ -127,13 +120,6 @@ module.exports = function (RED) { return Promise.resolve(); } - function checkForAction(action) { - if (!action) { - return Promise.reject('Missing action, please select one'); - } - return Promise.resolve(); - } - function checkForGlobalOverides(msg) { // If the selection is to use global overrides then // look for them @@ -456,12 +442,12 @@ module.exports = function (RED) { node.status({}); - initialCheck(username, password, apikey) + translatorutils.credentialCheck(username, password, apikey) .then(function(){ return payloadCheck(msg); }) .then(function(){ - return checkForAction(action); + return translatorutils.checkForAction(action); }) .then(function(){ return checkForGlobalOverides(msg); diff --git a/services/natural_language_understanding/v1.html b/services/natural_language_understanding/v1.html index 407fc133..2c05405a 100644 --- a/services/natural_language_understanding/v1.html +++ b/services/natural_language_understanding/v1.html @@ -21,6 +21,11 @@ +