fix: update examples to use apikey

Related to: #1007

Author: germanattanasio

examples/.eslintrc.js

@@ -1,12 +1,12 @@
 module.exports = {
-  "parserOptions": { "ecmaVersion": 6 },
-  "rules": {
-    "no-console": "off",
-    "node/no-missing-require": "off",
-    "require-jsdoc": "off",
-    "valid-jsdoc": "off",
-    "no-process-exit": "off",
-    "prefer-const": "off",
-    "no-var": "off"
-  }
+  parserOptions: { ecmaVersion: 6 },
+  rules: {
+    'no-console': 'off',
+    'node/no-missing-require': 'off',
+    'require-jsdoc': 'off',
+    'valid-jsdoc': 'off',
+    'no-process-exit': 'off',
+    'prefer-const': 'off',
+    'no-var': 'off',
+  },
 };

examples/assistant.v1.js

@@ -6,25 +6,25 @@ var AssistantV1 = require('ibm-watson/assistant/v1');
  * Instantiate the Watson Assistant Service
  */
 var assistant = new AssistantV1({
-  username: process.env.ASSISTANT_USERNAME || '<assistant_username>',
-  password: process.env.ASSISTANT_PASSWORD || '<assistant_password>',
-  version: '2018-02-16'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2020-04-30',
 });
 
 /**
  * Calls the assistant message api.
  * returns a promise
  */
-var message = function(text, context) {
+var message = function (text, context) {
   var payload = {
     workspace_id: process.env.WORKSPACE_ID || '<workspace_id>',
     input: {
-      text: text
+      text: text,
     },
-    context: context
+    context: context,
   };
   return new Promise((resolve, reject) =>
-    assistant.message(payload, function(err, data) {
+    assistant.message(payload, function (err, data) {
       if (err) {
         reject(err);
       } else {
@@ -49,9 +49,7 @@ message('first message', undefined)
   })
   .then(response2 => {
     console.log(JSON.stringify(response2, null, 2), '\n--------');
-    console.log(
-      'Note that the two reponses should have the same context.conversation_id'
-    );
+    console.log('Note that the two reponses should have the same context.conversation_id');
   })
   .catch(err => {
     // APPLICATION-SPECIFIC CODE TO PROCESS THE ERROR

examples/assistant_tone_analyzer_integration/tone_assistant_integration.v1.js

@@ -8,23 +8,6 @@
  * Service credentials can be provided directly in this file, or can be saved to a .env file located in the
  * same directory.
  *
- * Requirements:
- *   1. Tone Analyzer Service instance:
- *   - https://cloud.ibm.com/catalog/services/tone-analyzer
- *   - credentials for this service to be provided below in tone_analyzer variable
- *    - replace <tone_analyzer_username> and <tone_analyzer_password>
- *   2. Assistant Service instance:
- *   - https://cloud.ibm.com/catalog/services/watson-assistant
- *   - credentials for this service to be provided below in the assistant variable
- *    - replace <assistant_username> and <assistant_password>
- *   3. Workspace id:
- *   - a workspace containing intents, entities and dialog nodes must be created using the tool
- *     available through the IBM Cloud Assistant Service. Details are available at
- *     https://github.com/watson-developer-cloud/assistant-simple#workspace
- *    - replace <workspace_id> in the payload variable
- *
- * Run the code using the command:
- *   node tone_assistant_integration.v1.js
  */
 
 'use strict';
@@ -39,18 +22,18 @@ require('dotenv').config({ silent: true });
  * Instantiate the Watson Assistant Service
  */
 var assistant = new AssistantV1({
-  username: process.env.ASSISTANT_USERNAME || '<assistant_username>',
-  password: process.env.ASSISTANT_PASSWORD || '<assistant_password>',
-  version: '2017-05-26'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2020-04-30',
 });
 
 /**
  * Instantiate the Watson Tone Analyzer Service
  */
 var toneAnalyzer = new ToneAnalyzerV3({
-  username: process.env.TONE_ANALYZER_USERNAME || '<tone_analyzer_username>',
-  password: process.env.TONE_ANALYZER_PASSWORD || '<tone_analyzer_password>',
-  version: '2017-09-21'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2017-09-21',
 });
 
 /**
@@ -66,8 +49,8 @@ var maintainToneHistoryInContext = true;
 var payload = {
   workspace_id: process.env.WORKSPACE_ID || '<workspace_id>',
   input: {
-    text: 'I am not happy today :('
-  }
+    text: 'I am not happy today :(',
+  },
 };
 
 /**
@@ -84,12 +67,8 @@ function invokeToneAssistant(payload, maintainToneHistoryInContext) {
   tone_detection
     .invokeToneAsync(payload, toneAnalyzer)
     .then(tone => {
-      tone_detection.updateUserTone(
-        payload,
-        tone,
-        maintainToneHistoryInContext
-      );
-      assistant.message(payload, function(err, data) {
+      tone_detection.updateUserTone(payload, tone, maintainToneHistoryInContext);
+      assistant.message(payload, function (err, data) {
         if (err) {
           // APPLICATION-SPECIFIC CODE TO PROCESS THE ERROR
           // FROM ASSISTANT SERVICE
@@ -101,7 +80,7 @@ function invokeToneAssistant(payload, maintainToneHistoryInContext) {
         }
       });
     })
-    .catch(function(err) {
+    .catch(function (err) {
       console.log(JSON.stringify(err, null, 2));
     });
 }

examples/browserify/server.js

@@ -11,7 +11,7 @@ app.get(
   '/bundle.js',
   expressBrowserify('public/client.js', {
     watch: isDev,
-    debug: isDev
+    debug: isDev,
   })
 );
 
@@ -22,13 +22,12 @@ dotenv.load({ silent: true });
 
 // For local development, specify the username and password or set env properties
 var ltAuthService = new AuthorizationV1({
-  username: process.env.TONE_ANALYZER_USERNAME || '<username>',
-  password: process.env.TONE_ANALYZER_PASSWORD || '<password>',
-  url: ToneAnalyzerV3.URL
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
 });
 
-app.get('/api/token/tone_analyzer', function(req, res) {
-  ltAuthService.getToken(function(err, token) {
+app.get('/api/token/tone_analyzer', function (req, res) {
+  ltAuthService.getToken(function (err, token) {
     if (err) {
       console.log('Error retrieving token: ', err);
       return res.status(500).send('Error retrieving token');
@@ -38,6 +37,6 @@ app.get('/api/token/tone_analyzer', function(req, res) {
 });
 
 var port = process.env.PORT || process.env.VCAP_APP_PORT || 3000;
-app.listen(port, function() {
+app.listen(port, function () {
   console.log('Watson browserify example server running at http://localhost:%s/', port);
 });

examples/compare-comply.v1.js

@@ -4,10 +4,8 @@ const fs = require('fs');
 const CompareComplyV1 = require('ibm-watson/compare-comply/v1');
 
 const compareComply = new CompareComplyV1({
-  // if left unspecified here, the SDK will fall back to the COMPARE_COMPLY_IAM_APIKEY
-  // environment property, and then IBM Cloud's VCAP_SERVICES environment property
-  iam_apikey: 'YOUR APIKEY',
-  url: 'https://gateway.watsonplatform.net/compare-comply/api',
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
   version: '2018-12-06',
 });
 

examples/discovery.v1.js

@@ -4,18 +4,12 @@ var DiscoveryV1 = require('ibm-watson/discovery/v1');
 var fs = require('fs');
 
 var discovery = new DiscoveryV1({
-  // if left unspecified here, the SDK will fall back to the DISCOVERY_USERNAME and DISCOVERY_PASSWORD
-  // environment properties, and then IBM Cloud's VCAP_SERVICES environment property
-  // username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
-  // password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE'
-  // url: 'INSERT YOUR URL FOR THE SERVICE HERE'
-  username: 'YOUR USERNAME',
-  password: 'YOUR PASSWORD',
-  version: '2018-03-05',
-  url: 'https://gateway.watsonplatform.net/discovery/api/'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2020-04-30',
 });
 
-discovery.getEnvironments({}, function(error, data) {
+discovery.getEnvironments({}, function (error, data) {
   console.log(JSON.stringify(data, null, 2));
 });
 
@@ -26,9 +20,9 @@ discovery.addDocument(
   {
     environment_id: 'YOUR ENVIRONMENT ID',
     collection_id: 'YOUR COLLECTION ID',
-    file: file
+    file: file,
   },
-  function(error, data) {
+  function (error, data) {
     if (error) {
       console.log(error);
     } else {

examples/language_translator.v3.js

@@ -7,20 +7,21 @@ const LanguageTranslatorV3 = require('ibm-watson/language-translator/v3');
  * Instantiate the Watson Language Translator Service
  */
 const languageTranslator = new LanguageTranslatorV3({
-  username: process.env.LANGUAGE_TRANSLATOR_USERNAME || '<language_translator_username>',
-  password: process.env.LANGUAGE_TRANSLATOR_PASSWORD || '<language_translator_password>',
-  version: '2019-01-10'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2020-04-30',
 });
 
 const params = {
-  text: "Hello, this is a example of translating language with Watson.",
+  text: 'Hello, this is a example of translating language with Watson.',
   source: 'en',
   target: 'es',
-}
+};
 
 // return the body - primary use case
 
-languageTranslator.translate(params)
+languageTranslator
+  .translate(params)
   .then(body => {
     console.log(JSON.stringify(body, null, 2));
     console.log('\n');
@@ -34,7 +35,8 @@ languageTranslator.translate(params)
 
 params.return_response = true;
 
-languageTranslator.translate(params)
+languageTranslator
+  .translate(params)
   .then(res => {
     console.log(JSON.stringify(res, null, 2));
   })

examples/natural_language_classifier.v1.js

@@ -4,10 +4,9 @@ var NaturalLanguageClassifierV1 = require('ibm-watson/natural-language-classifie
 var fs = require('fs');
 
 var classifier = new NaturalLanguageClassifierV1({
-  username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
-  password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE',
-  version: 'v1',
-  url: 'https://gateway.watsonplatform.net/natural-language-classifier/api/'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2020-04-30',
 });
 
 // Optionally for IAM authentication
@@ -20,16 +19,11 @@ var classifier = new NaturalLanguageClassifierV1({
 
 // Creating a classifier
 var params = {
-  training_data: fs.createReadStream(
-    '../test/resources/weather_data_train.csv'
-  ),
-  metadata: Buffer.from(
-    JSON.stringify({ language: 'en', name: 'my-classifier' }),
-    'utf8'
-  )
+  training_data: fs.createReadStream('../test/resources/weather_data_train.csv'),
+  metadata: Buffer.from(JSON.stringify({ language: 'en', name: 'my-classifier' }), 'utf8'),
 };
 
-classifier.createClassifier(params, function(err, response) {
+classifier.createClassifier(params, function (err, response) {
   if (err) {
     console.log(err);
   } else {
@@ -42,9 +36,9 @@ classifier.createClassifier(params, function(err, response) {
 classifier.classify(
   {
     text: 'Is it sunny?',
-    classifier_id: '<classifier-id>'
+    classifier_id: '<classifier-id>',
   }, // from the previous command
-  function(err, response) {
+  function (err, response) {
     if (err) {
       console.log('error:', err);
     } else {

examples/natural_language_understanding.v1.js

@@ -5,27 +5,24 @@ var NaturalLanguageUnderstandingV1 = require('ibm-watson/natural-language-unders
 require('dotenv').config({ silent: true }); //  optional
 
 var nlu = new NaturalLanguageUnderstandingV1({
-  // note: if unspecified here, credentials are pulled from environment properties:
-  // NATURAL_LANGUAGE_UNDERSTANDING_USERNAME &  NATURAL_LANGUAGE_UNDERSTANDING_PASSWORD
-  // username: '<username>'.
-  // password: '<password>',
-  version: '2018-04-05',
-  url: 'https://gateway.watsonplatform.net/natural-language-understanding/api/'
+  // See: https://github.com/watson-developer-cloud/node-sdk#authentication
+  // iam_apikey: 'INSERT YOUR IAM API KEY HERE',
+  version: '2020-04-30',
 });
 
 var filename = '../test/resources/natural_language_understanding/energy-policy.html';
-fs.readFile(filename, 'utf-8', function(file_error, file_data) {
+fs.readFile(filename, 'utf-8', function (file_error, file_data) {
   if (file_error) {
     console.log(file_error);
   } else {
     var options = {
       html: file_data,
       features: {
         concepts: {},
-        keywords: {}
-      }
+        keywords: {},
+      },
     };
-    nlu.analyze(options, function(err, res) {
+    nlu.analyze(options, function (err, res) {
       if (err) {
         console.log(err);
         return;