set up automatic deployment of examples to bluemix

Author: nfriedly

.gitignore

@@ -10,3 +10,4 @@ doc/
 .env
 dist/*.min.js
 examples/static/webpack-bundle.js
+examples/node_modules/

.travis.yml

@@ -1,21 +1,29 @@
 language: node_js
 node_js:
 - stable
+sudo: required
 before_install:
 - export CHROME_BIN=chromium-browser
 - export DISPLAY=:99.0
 - sh -e /etc/init.d/xvfb start
 script:
 - npm test
-- sed -i "s/\/master\//\/$TRAVIS_BRANCH\//g" README.md # replace "master" in doc urls with current branch/tag
+- sed -i "s/\/master\//\/$TRAVIS_BRANCH\//g" README.md
 - npm run doc
 after_success:
 - jsdoc/publish.sh
 env:
   global:
-    secure: Bx6pW0ihp3Y2dW5a8fkPhbMKsVg7MRfCzN3laN/OL7vTy2etIDXFleddE5No74HVQ1gPhkOIoRko/pHPdzWGNq69VtoCxp3AdISsuillYcaDCfRXDBSZXbHVuXsUHFQIABIdKJZZVjjwXM4oulL4OWboZ8FWV7vgOBvN4ZrXjM8LfuahSG51cPbPktqa+v/rA03iuWwC8IUDhf5w2uNPrsvtzWmj+CHcpLIgjmJWan+SiJXK/i3Wz/B74Cb0RtP9Y7zJzIGSWg8Z1VruN/f8xoNeSbMz5HM+PMhGyQJ9QXUNEqUEiXG+gwIzhAYRwBbCGyQZME5zk/y7QM0lr3/4NBzq8e6RYWlyOVLRGxlL6SvPmQ/6FrMCe9QDcMnvDvfeYhTHa6SnkqymN1hp1JnPC65zXENbEOLJH/67mQs/WoHLuuZycUK0KPC+GK6Bc45ViXotyNTttzrxHfpOV4IXQDVqB6p6tlh940ksYpetSs+8s7piUOGIcu4XtYxdnSRGX7TwKiCuuK65XWYpk+oMWhKHsOS2FTDt85+PXKFnM1fiuFD+Oppa7xyXmSUZp4C1befd7nP7F5RGSkZWdfXuCY6xAS6E7dho4clIua2yhOWtgnoMlcjjht6sFYf8OEk3eoVvnP+OO3VSHwk0VkTbI3E3fp3H8CUXVMk9woegydQ=
+  - secure: Bx6pW0ihp3Y2dW5a8fkPhbMKsVg7MRfCzN3laN/OL7vTy2etIDXFleddE5No74HVQ1gPhkOIoRko/pHPdzWGNq69VtoCxp3AdISsuillYcaDCfRXDBSZXbHVuXsUHFQIABIdKJZZVjjwXM4oulL4OWboZ8FWV7vgOBvN4ZrXjM8LfuahSG51cPbPktqa+v/rA03iuWwC8IUDhf5w2uNPrsvtzWmj+CHcpLIgjmJWan+SiJXK/i3Wz/B74Cb0RtP9Y7zJzIGSWg8Z1VruN/f8xoNeSbMz5HM+PMhGyQJ9QXUNEqUEiXG+gwIzhAYRwBbCGyQZME5zk/y7QM0lr3/4NBzq8e6RYWlyOVLRGxlL6SvPmQ/6FrMCe9QDcMnvDvfeYhTHa6SnkqymN1hp1JnPC65zXENbEOLJH/67mQs/WoHLuuZycUK0KPC+GK6Bc45ViXotyNTttzrxHfpOV4IXQDVqB6p6tlh940ksYpetSs+8s7piUOGIcu4XtYxdnSRGX7TwKiCuuK65XWYpk+oMWhKHsOS2FTDt85+PXKFnM1fiuFD+Oppa7xyXmSUZp4C1befd7nP7F5RGSkZWdfXuCY6xAS6E7dho4clIua2yhOWtgnoMlcjjht6sFYf8OEk3eoVvnP+OO3VSHwk0VkTbI3E3fp3H8CUXVMk9woegydQ=
+  - CF_APP=watson-speech
+  - CF_API=https://api.ng.bluemix.net
+  - CF_ORGANIZATION=WatsonPlatformServices
+  - CF_SPACE=sdks
+  - [email protected]
+  - secure: NDOdoAt1bjGspsU9CZl494GW9OEC9J56OCJloyfd0KGkDmKLNpYGw5eHXmJfLVqKAvldhOpjp0aNSrrwVcT2qvE2dhtYkL+a5hVMZFr7DdfOtZze/MIdCpoQhZQz8+wQa82crGgf+cTL2Y+BndkQoDk5mMo/3sAf512euHTHJXb+9DZ36ZJYIK/hVTfzZMdUUH7059rYeUADhXXcbu1Va+cJHXr2xRFI8ZEdZfZ0V1jDEqPyi/hwDYODgsTpk/4jRFlkZu2Agxq2kOETeuJYiTJ7O9Q1qhY3rSAgu/rvQK8+Y7ngTxWS8rStOOr8CNXJtmZdM0zpz6RbmQEhR5Xk4s8aX1rxPDj06/Cx7BVWKZWb7wGJETjKq/+NLv/tK9tXDVZ5oBj/H9VkUm2gWqWCKaAge9xW+wuh/LluGMZIx+pTDI94AbgIZnxP2HoALmGIvyim7AquvQqaqIqVR3XTXZUccYM5yRCkxHknZbbL/hX4GOM/I1Ue24d5wt4okkGV2R/DNWYfnajB7GZOTvK5/kn7x6bJpU0Ls9ZYW+4V0zUO/3g5KalU3Cire/dSOC7WzrL823koEgpF9KCVjtCCsj1wMZI099FTGFljqfzlVKMy4Sw4tafRjpkQQT3GLoX1CV/B4n4BDOySoGBPlM0JYiEua+J5GNpeq34n38bwn4g=
 before_deploy:
 - npm run build
+- npm install -g cf-blue-green
 deploy:
 - provider: releases
   api_key:
@@ -35,3 +43,8 @@ deploy:
   on:
     tags: true
     repo: watson-developer-cloud/speech-javascript-sdk
+- provider: script
+  script: cd examples/ && cf-blue-green-travis
+  on:
+    branch: master
+    repo: watson-developer-cloud/speech-javascript-sdk

README.md

@@ -43,9 +43,9 @@ API & Examples
 
 The basic API is outlined below, see complete API docs at http://watson-developer-cloud.github.io/speech-javascript-sdk/master/
 
-See code for several basic examples at https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples/static/
+See several basic examples at http://watson-speech.mybluemix.net/ ([source](https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples/))
 
-See a live example at https://speech-to-text-demo.mybluemix.net/
+See a more advanced example at https://speech-to-text-demo.mybluemix.net/
 
 All API methods require an auth token that must be [generated server-side](https://github.com/watson-developer-cloud/node-sdk#authorization). 
 (See https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples/ for a couple of basic examples in Node.js and Python.)

examples/.cfignore

@@ -0,0 +1,3 @@
+node_modules/
+keys/
+static/bower_components/jquery/src/

examples/manifest.yml

@@ -0,0 +1,19 @@
+---
+declared-services:
+  speech_to_text_sdk:
+    label: speech_to_text
+    plan: standard
+  text_to_speech_sdk:
+    label: text_to_speech
+    plan: standard
+applications:
+- name: watson-speech
+  buildpack: sdk-for-nodejs
+  path: .
+  command: npm start
+  memory: 512M
+  services:
+  - speech_to_text_sdk
+  - text_to_speech_sdk
+  env:
+   NODE_ENV: production

examples/package.json

@@ -10,13 +10,18 @@
     "dotenv": "^2.0.0",
     "express": "^4.13.3",
     "express-browserify": "^1.0.2",
+    "express-rate-limit": "^2.6.0",
+    "express-secure-only": "^0.2.1",
     "object.assign": "^4.0.4",
-    "vcap_services": "^0.1.7",
-    "watson-developer-cloud": "^1.2.0",
+    "vcap_services": "^0.2.0",
+    "watson-developer-cloud": "^2.18.0",
     "watson-speech": "*",
     "webpack": "^2.2.1",
     "webpack-dev-middleware": "^1.10.0",
     "whatwg-fetch": "^1.0.0"
   },
+  "engines": {
+    "node": ">=4"
+  },
   "license": "Apache-2.0"
 }

examples/server.js

@@ -16,17 +16,17 @@
 
 'use strict';
 
-var express = require('express');
-var app = express();
-var expressBrowserify = require('express-browserify');
+const express = require('express');
+const app = express();
+const expressBrowserify = require('express-browserify');
 
 // allows environment properties to be set in a file named .env
 require('dotenv').load({silent: true});
 
 app.use(express.static(__dirname + '/static'));
 
 // set up express-browserify to serve browserify bundles for examples
-var isDev = app.get('env') === 'development';
+const isDev = app.get('env') === 'development';
 app.get('/browserify-bundle.js', expressBrowserify('static/browserify-app.js', {
   watch: isDev,
   debug: isDev
@@ -38,24 +38,46 @@ app.get('/audio-video-deprecated/bundle.js', expressBrowserify('static/audio-vid
 
 
 // set up webpack-dev-middleware to serve Webpack bundles for examples
-var webpackDevMiddleware = require('webpack-dev-middleware');
-var webpack = require('webpack');
-var webpackConfig = require('./webpack.config');
+const webpackDevMiddleware = require('webpack-dev-middleware');
+const webpack = require('webpack');
+const webpackConfig = require('./webpack.config');
 
-var compiler = webpack(webpackConfig);
+const compiler = webpack(webpackConfig);
 
 app.use(webpackDevMiddleware(compiler, {
   publicPath: '/' // Same as `output.publicPath` in most cases.
 }));
 
 
 
+// on bluemix, enable rate-limiting and force https
+if(process.env.VCAP_SERVICES) {
+  // enable rate-limiting
+  const RateLimit = require('express-rate-limit');
+  app.enable('trust proxy'); // required to work properly behind Bluemix's reverse proxy
+
+  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
+  });
+
+  //  apply to /api/*
+  app.use('/api/', limiter);
+
+  // force https - microphone access requires https in Chrome and possibly other browsers
+  // (*.mybluemix.net domains all have built-in https support)
+  const secure = require('express-secure-only');
+  app.use(secure());
+}
+
+
 // token endpoints
-// **Warning**: these endpoints should be guarded with additional authentication & authorization for production use
+// **Warning**: these endpoints should probably be guarded with additional authentication & authorization for production use
 app.use('/api/speech-to-text/', require('./stt-token.js'));
 app.use('/api/text-to-speech/', require('./tts-token.js'));
 
-var port = process.env.VCAP_APP_PORT || 3000;
+const port = process.env.VCAP_APP_PORT || 3000;
 app.listen(port, function() {
   console.log('Example IBM Watson Speech JS SDK client app & token server live at http://localhost:%s/', port);
 });
@@ -64,12 +86,12 @@ app.listen(port, function() {
 // this sets up a basic server at https://localhost3001/ using an included self-signed certificate
 // note: this is not suitable for production use
 // however bluemix automatically adds https support at http://<myapp>.mybluemix.net
-if (!process.env.VCAP_APP_PORT) {
-  var fs = require('fs'),
+if (!process.env.VCAP_SERVICES) {
+  const fs = require('fs'),
     https = require('https'),
     HTTPS_PORT = 3001;
 
-  var options = {
+  const options = {
     key: fs.readFileSync(__dirname + '/keys/localhost.pem'),
     cert: fs.readFileSync(__dirname + '/keys/localhost.cert')
   };

examples/static/index.html

@@ -9,6 +9,10 @@
 <body>
 <div class="container">
   <h1>IBM Watson Speech JavaScript SDK Examples</h1>
+  <p>The <a href="https://www.npmjs.com/package/watson-speech">watson-speech</a> library allows you to easily add voice
+    recognition and synthesis to any web app with minimal code.</p>
+  <p>Complete source code for these examples is
+    <a href="https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples/">available on GitHub</a>.</p>
   <h2>Speech to Text</h2>
   <h3>Microphone Input</h3>
   <ul>
@@ -19,8 +23,8 @@ <h3>Microphone Input</h3>
     <li><a href="microphone-streaming-text-to-console.html">Transcribe from Microphone, send text to console</a></li>
     <li><a href="microphone-streaming-model.html">Transcribe from Microphone, Streaming with chosen model</a></li>
     <li><a href="microphone-streaming-object-to-console.html">Transcribe from Microphone, send JSON to console (includes text and metadata; v0.22+ format)</a></li>
-    <li><a href="browserify.html">Example bundled with browserify</a>*</li>
-    <li><a href="webpack.html">Example bundled with Webpack</a>*</li>
+    <li><a href="browserify.html">Browserify example</a></li>
+    <li><a href="webpack.html">Webpack example</a></li>
     <li><strike><a href="microphone-streaming-object-extracted-to-console.html">Deprecated: Transcribe from Microphone, send JSON to console with results extracted (pre-v0.22 format)</a></strike></li>
   </ul>
   <h3>File Input</h3>
@@ -34,11 +38,9 @@ <h3>File Input</h3>
     <li><a href="realtime-vs-no-realtime.html">Compare <code>realtime</code> and <code>TimingStream</code> options</a></li>
     <li><a href="url-promise.html">Transcribe from URL, return a Promise</a></li>
     <li><a href="file-ajax.html">Transcribe from file, pre-loaded over AJAX</a></li>
-    <li><strike><a href="audio-video-deprecated/">Deprecated: Transcribe from HTML5 &lt;audio&gt; or &lt;video&gt; element</a></strike>*</li>
+    <li><strike><a href="audio-video-deprecated/">Deprecated: Transcribe from HTML5 &lt;audio&gt; or &lt;video&gt; element</a></strike></li>
   </ul>
 
-  <p>* Examples that depend on browserify or webpack require Node.js and will not work with the example Python server.</p>
-
   <h2>Text to Speech</h2>
   <ul>
     <li><a href="text-to-speech.html">Synthesize text, with pre-loaded token (compatible with Mobile Safari)</a></li>
@@ -51,6 +53,8 @@ <h2>See Also</h2>
     <li><a href="http://watson-developer-cloud.github.io/speech-javascript-sdk/">JSDoc</a></li>
     <li><a href="https://www.npmjs.com/package/watson-speech">npm</a></li>
     <li><a href="https://github.com/watson-developer-cloud/speech-javascript-sdk">GitHub</a></li>
+    <li><a href="https://speech-to-text-demo.mybluemix.net/">Official Speech to Text demo</a></li>
+    <li><a href="https://text-to-speech-demo.mybluemix.net/">Official Text to Speech demo</a></li>
     <li><a href="https://www.ibm.com/watson/developercloud/">Watson</a></li>
   </ul>
 </div>

package.json

@@ -19,7 +19,7 @@
   },
   "author": "Nathan Friedly <http://nfriedly.com>",
   "devDependencies": {
-    "browserify": "^13.3.0",
+    "browserify": "^14.0.0",
     "concat-stream": "^1.6.0",
     "envify": "^4.0.0",
     "eslint": "^3.13.1",
@@ -55,7 +55,7 @@
     "websocket": "^1.0.24",
     "whatwg-fetch": "^2.0.1"
   },
-  "homepage": "https://github.com/watson-developer-cloud/speech-javascript-sdk",
+  "homepage": "http://watson-speech.mybluemix.net/",
   "repository": {
     "type": "git",
     "url": "https://github.com/watson-developer-cloud/speech-javascript-sdk.git"