Merge pull request #146 from watson-developer-cloud/examples

chore: Update examples

Author: germanattanasio

.travis.yml

@@ -1,10 +1,12 @@
 language: node_js
-node_js: 10
+node_js:
+  - "10"
 sudo: required
-before_install:
-- export CHROME_BIN=chromium-browser
-- export DISPLAY=:99.0
-- sh -e /etc/init.d/xvfb start
+services:
+  - xvfb
+addons:
+  firefox: "latest"
+  chrome: "stable"
 script:
 - npm run build
 - npm test
@@ -22,8 +24,7 @@ before_deploy: npm install -g bx-blue-green
 deploy:
 - provider: script
   skip_cleanup: true
-  script:
-  - cd examples/ && bx-blue-green-travis
+  script: cd examples/ && bx-blue-green-travis
   on:
     branch: master
     repo: watson-developer-cloud/speech-javascript-sdk

examples/package-lock.json

@@ -15,15 +15,15 @@
     "dotenv": "^6.2.0",
     "express": "^4.17.1",
     "express-browserify": "^1.0.3",
-    "express-rate-limit": "^2.6.0",
+    "express-rate-limit": "^5.0.0",
     "express-secure-only": "^0.2.1",
+    "ibm-watson": "^4.4.0",
     "jquery": "^3.4.1",
     "object.assign": "^4.0.4",
-    "vcap_services": "^0.7.0",
-    "watson-developer-cloud": "^4.0.1",
+    "vcap_services": "^0.7.1",
     "watson-speech": "*",
-    "webpack": "^3.5.5",
-    "webpack-dev-middleware": "^1.10.0",
+    "webpack": "^4.39.3",
+    "webpack-dev-middleware": "^3.7.1",
     "whatwg-fetch": "^3.0.0"
   },
   "engines": {

examples/package.json

@@ -1,16 +1,16 @@
 Watson Speech JavaScript SDK Examples
 =====================================
 
-This folder has example Node.js and Python servers to generate auth tokens and 
-several html files (in `static/`) with different examples of using the Speech SDK. 
+This folder has example Node.js and Python servers to generate auth tokens and
+several html files (in `static/`) with different examples of using the Speech SDK.
 
 There are also a few audio files to test with in the `static/` folder.
 
 
 Prerequisite
 ------------
 
-* IBM Watson Speech to Text service credentials - see [Service credentials for Watson services](https://www.ibm.com/watson/developercloud/doc/common/getting-started-credentials.html)
+* IBM Watson Speech to Text service credentials - see [Service credentials for Watson services](https://cloud.ibm.com/docs/services/watson?topic=watson-creating-credentials)
 * Node.js OR Python
 
 
@@ -22,28 +22,15 @@ Setup - Node.js
 3. run `npm start`
 4. Open your browser to http://localhost:3000/ to see the examples.
 
-
-Setup - Python
---------------
-
-1. `cd` into the `examples/` directory and run `pip install watson_developer_cloud flask python-dotenv pyopenssl` (or `easy_install...`) to install python dependencies.
-2. run `./scripts/postinstall.sh` to install client-side dependencies
-3. edit `server.py` to include your service credentials (or create a `.env` file)
-4. run `python server.py`
-5. Open your browser to http://localhost:5000/ to see the examples.
-
-
 Notes
 -----
 
 * The examples all use [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) (a modern promise-based replacement for XMLHttpRequest) to retrieve auth tokens. Most supported browsers include a native fetch implementation, but a pollyfill is included in the top-level module for older browsers.
-* The examples use a Node.js server to generate tokens. It doesn't have to be written in Node.js, but *some server-side token generator is required*. The SDK will not accept your service credentials directly, and you can not use them to generate a token client-side. SDKs are available for [Node.js](https://github.com/watson-developer-cloud/node-sdk#authorization), [Java](https://github.com/watson-developer-cloud/java-sdk), [Python](https://github.com/watson-developer-cloud/python-sdk/blob/master/examples/authorization_v1.py), and there is a [REST API](https://www.ibm.com/watson/developercloud/doc/common/getting-started-tokens.html) for use with other languages (or `curl`).
+* The examples use a Node.js server to generate tokens. It doesn't have to be written in Node.js, but *some server-side token generator is required*. The SDK will not accept your service credentials directly, and you can not use them to generate a token client-side. SDKs are available for [Node.js](https://github.com/watson-developer-cloud/node-sdk#authorization), [Java](https://github.com/watson-developer-cloud/java-sdk), [Python](https://github.com/watson-developer-cloud/python-sdk/blob/master/examples/authorization_v1.py), and there is a [REST API](https://cloud.ibm.com/docs/services/watson?topic=watson-gs-tokens-watson-tokens) for use with other languages (or `curl`).
 * The Speech SDK may be used in browserify, Webpack, or as a standalone library. Most of the examples use the standalone version either installed via NPM or symlinked to the root directory when developing locally.
 
 
 More Examples
 -------------
 
-* Speech to Text: [Demo](https://speech-to-text-demo.mybluemix.net/), [Code](https://github.com/watson-developer-cloud/speech-to-text-nodejs)
-* Speech & Dialog services together: [Demo](https://speech-dialog.mybluemix.net/), [Code](https://github.com/nfriedly/speech-dialog)
-* Text to Speech w/ word timings: [Demo](http://watson-tts-timing.mybluemix.net/), [Code](https://github.com/nfriedly/tts-timing)
+* Speech to Text: [Demo](https://speech-to-text-demo.ng.bluemix.net/), [Code](https://github.com/watson-developer-cloud/speech-to-text-nodejs)

examples/readme.md

@@ -20,9 +20,10 @@
 
 const express = require('express');
 const app = express();
-const AuthorizationV1 = require('watson-developer-cloud/authorization/v1');
-const SpeechToTextV1 = require('watson-developer-cloud/speech-to-text/v1');
-const TextToSpeechV1 = require('watson-developer-cloud/text-to-speech/v1');
+const AuthorizationV1 = require('ibm-watson/authorization/v1');
+const SpeechToTextV1 = require('ibm-watson/speech-to-text/v1');
+const TextToSpeechV1 = require('ibm-watson/text-to-speech/v1');
+
 const vcapServices = require('vcap_services');
 const expressBrowserify = require('express-browserify');
 const webpackDevMiddleware = require('webpack-dev-middleware');
@@ -40,8 +41,7 @@ if (process.env.VCAP_SERVICES) {
 
   const limiter = new RateLimit({
     windowMs: 15 * 60 * 1000, // 15 minutes
-    max: 100, // limit each IP to 100 requests per windowMs
-    delayMs: 0 // disable delaying - full speed until the max limit is reached
+    max: 100 // limit each IP to 100 requests per windowMs
   });
 
   //  apply to /api/*
@@ -64,13 +64,6 @@ app.get(
     debug: isDev
   })
 );
-app.get(
-  '/audio-video-deprecated/bundle.js',
-  expressBrowserify('static/audio-video-deprecated/audio-video-app.js', {
-    watch: isDev,
-    debug: isDev
-  })
-);
 
 // set up webpack-dev-middleware to serve Webpack bundles for examples
 const compiler = webpack(webpackConfig);
@@ -80,52 +73,58 @@ app.use(
   })
 );
 
-// token endpoints
-// **Warning**: these endpoints should probably be guarded with additional authentication & authorization for production use
+const sttCredentials = Object.assign(
+  {
+    username: process.env.SPEECH_TO_TEXT_USERNAME, // or hard-code credentials here
+    password: process.env.SPEECH_TO_TEXT_PASSWORD,
+    iam_apikey: process.env.SPEECH_TO_TEXT_IAM_APIKEY, // if using an RC service
+    url: process.env.SPEECH_TO_TEXT_URL ? process.env.SPEECH_TO_TEXT_URL : SpeechToTextV1.URL
+  },
+  vcapServices.getCredentials('speech_to_text') // pulls credentials from environment in bluemix, otherwise returns {}
+);
 
 // speech to text token endpoint
-var sttAuthService = new AuthorizationV1(
-  Object.assign(
-    {
-      username: process.env.SPEECH_TO_TEXT_USERNAME, // or hard-code credentials here
-      password: process.env.SPEECH_TO_TEXT_PASSWORD,
-      iam_apikey: process.env.SPEECH_TO_TEXT_IAM_APIKEY, // if using an RC service
-      url: process.env.SPEECH_TO_TEXT_URL ? process.env.SPEECH_TO_TEXT_URL : SpeechToTextV1.URL
-    },
-    vcapServices.getCredentials('speech_to_text') // pulls credentials from environment in bluemix, otherwise returns {}
-  )
-);
 app.use('/api/speech-to-text/token', function(req, res) {
-  sttAuthService.getToken(function(err, token) {
+  const sttAuthService = new AuthorizationV1(sttCredentials);
+  sttAuthService.getToken(function(err, response) {
     if (err) {
       console.log('Error retrieving token: ', err);
       res.status(500).send('Error retrieving token');
       return;
     }
-    res.send(token.token || token);
+    const token = response.token || response;
+    if (process.env.SPEECH_TO_TEXT_IAM_APIKEY) {
+      res.json({ access_token: token, url: sttCredentials.url });
+    } else {
+      res.json({ token: token, url: sttCredentials.url });
+    }
   });
 });
 
 // text to speech token endpoint
-var ttsAuthService = new AuthorizationV1(
-  Object.assign(
-    {
-      username: process.env.TEXT_TO_SPEECH_USERNAME, // or hard-code credentials here
-      password: process.env.TEXT_TO_SPEECH_PASSWORD,
-      iam_apikey: process.env.TEXT_TO_SPEECH_IAM_APIKEY, // if using an RC service
-      url: process.env.TEXT_TO_SPEECH_URL ? process.env.TEXT_TO_SPEECH_URL : TextToSpeechV1.URL
-    },
-    vcapServices.getCredentials('text_to_speech') // pulls credentials from environment in bluemix, otherwise returns {}
-  )
+const ttsCredentials = Object.assign(
+  {
+    username: process.env.TEXT_TO_SPEECH_USERNAME, // or hard-code credentials here
+    password: process.env.TEXT_TO_SPEECH_PASSWORD,
+    iam_apikey: process.env.TEXT_TO_SPEECH_IAM_APIKEY, // if using an RC service
+    url: process.env.TEXT_TO_SPEECH_URL ? process.env.TEXT_TO_SPEECH_URL : TextToSpeechV1.URL
+  },
+  vcapServices.getCredentials('text_to_speech') // pulls credentials from environment in bluemix, otherwise returns {}
 );
 app.use('/api/text-to-speech/token', function(req, res) {
-  ttsAuthService.getToken(function(err, token) {
+  const ttsAuthService = new AuthorizationV1(ttsCredentials);
+  ttsAuthService.getToken(function(err, response) {
     if (err) {
       console.log('Error retrieving token: ', err);
       res.status(500).send('Error retrieving token');
       return;
     }
-    res.send(token.token || token);
+    const token = response.token || response;
+    if (process.env.TEXT_TO_SPEECH_IAM_APIKEY) {
+      res.json({ access_token: token, url: ttsCredentials.url });
+    } else {
+      res.json({ token: token, url: ttsCredentials.url });
+    }
   });
 });