Merge pull request #8 from watson-developer-cloud/update-dependencies

Update README, Travis and dependencies

Author: Steve Green

.env.example

@@ -0,0 +1,4 @@
+# Environment variables
+ASSISTANT_URL=https://gateway.watsonplatform.net/assistant/api
+ASSISTANT_IAM_APIKEY=
+ASSISTANT_ID=

.travis.yml

@@ -1,10 +1,6 @@
 language: node_js
-dist: trusty
-sudo: required
-node_js: "8"
-script:
-- npm run build
-- npm test
+dist: xenial
+node_js: "10"
 cache:
   directories:
   - node_modules
@@ -15,18 +11,19 @@ env:
   - BX_ORGANIZATION=WatsonPlatformServices
   - BX_SPACE=demos
   - B_DOMAIN=ng.bluemix.net
+script:
+- npm run build
+- npm test
+
 before_deploy:
 - npm install -g bx-blue-green
 deploy:
 - provider: script
   script: bx-blue-green-travis
   on:
     branch: master
-    repo: Watson/watson-conversation-demo-redesign
+    repo: watson-developer-cloud/assistant-demo
   skip_cleanup: true
 - provider: script
-  script: BX_APP=watson-conversation-duo-test bx-blue-green-travis
-  on:
-    branch: dev
-    repo: Watson/watson-conversation-demo-redesign
   skip_cleanup: true
+  script: npx semantic-release

ISSUE_TEMPLATE.md

@@ -1,48 +1,56 @@
-<h1 align="center" style="border-bottom: none;">🚀 Watson Assistant (formerly Conversation) Demo Sample Application</h1>
-<h3>This app demonstrates the Watson Assistant service via a complete, complex interface which engages in simulated banking tasks.<br><br>It utilises features such as:<ul><li>Cloud Functions</li><li>Actions and UI Actions</li><li>Slots</li><li>Multi-Conditional Responses</li><li>Multi-Modal Responses</li></h3>
+<h1 align="center" style="border-bottom: none;">🚀 Watson Assistant Duo Demo</h1>
 
-![Demo](readme_images/demo.gif)
+[![Build Status](https://travis-ci.org/watson-developer-cloud/assistant-demo.svg?branch=master)](https://travis-ci.org/watson-developer-cloud/assistant-demo)
 
-You can view a [demo][demo_url] of this app.
+In this sample application, you're engaging with a banking virtual assistant. The assistant simulates a few scenarios, such as making a credit card payment, booking an appointment with a banker and choosing a credit card. Watson can understand your entries and respond accordingly.
+
+This app demonstrates the Watson Assistant service via a complete, complex interface which engages in simulated banking tasks. It utilises features such as:
+ * Cloud Functions
+ * Actions and UI Actions
+ * Slots
+ * Multi-Conditional Responses
+ * Multi-Modal Responses
+
+
+[![Demo](./readme_images/demo.gif)](https://watson-assistant-demo.ng.bluemix.net)
 
 
-Please note this app uses the [Watson Assistant V2 API](https://console.bluemix.net/apidocs/assistant-v2#introduction).
 
 ## Prerequisites
 
-1. Sign up for an [IBM Cloud account](https://console.bluemix.net/registration/).
-1. Download the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cloud-cli-ibmcloud-cli#overview).
+1. Sign up for an [IBM Cloud account](https://cloud.ibm.com/registration).
+1. Download the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli/index.html#overview).
 1. Create an instance of the Watson Assistant service and get your credentials:
-    - Go to the [Watson Assistant](https://console.bluemix.net/catalog/services/conversation) page in the IBM Cloud Catalog.
+    - Go to the [Watson Assistant][service_url] page in the IBM Cloud Catalog.
     - Log in to your IBM Cloud account.
     - Click **Create**.
     - Click **Show** to view the service credentials.
-    - Copy the `apikey` value, or copy the `username` and `password` values if your service instance doesn't provide an `apikey`.
+    - Copy the `apikey` value.
     - Copy the `url` value.
 
 ## Configuring the application
 
 1. In your IBM Cloud console, open the Watson Assistant service instance
 
-2. Click the **Import workspace** icon in the Watson Assistant service tool. Specify the location of the workspace JSON file in your local copy of the app project:
+1. Click the **Import workspace** icon in the Watson Assistant service tool. Specify the location of the workspace JSON file in your local copy of the app project:
 
     `<project_root>/training/banking_workspace.json`
 
-3. Select **Everything (Intents, Entities, and Dialog)** and then click **Import**. The car dashboard workspace is created.
+1. Select **Everything (Intents, Entities, and Dialog)** and then click **Import**. The car dashboard workspace is created.
 
-4. Click the menu icon in the upper-right corner of the workspace tile, and then select **View details**.
+1. Click the menu icon in the upper-right corner of the workspace tile, and then select **View details**.
 
-5. Click the ![Copy](readme_images/copy_icon.png) icon to copy the workspace ID to the clipboard.
+1. Click the ![Copy](readme_images/copy_icon.png) icon to copy the workspace ID to the clipboard.
 
     ![Steps to get credentials](readme_images/assistant-demo.gif)
 
-6. In the application folder, copy the *.env.example* file and create a file called *.env*
+1. In the application folder, copy the *.env.example* file and create a file called *.env*
 
     ```
     cp .env.example .env
     ```
 
-7. Open the *.env* file and add the service credentials that you obtained in the previous step. The Watson SDK automaticaly locates the correct enviromental variables for either `username`, `password`, and `url` or the `apikey` and `url` credentials found in the *.env* file.
+1. Open the *.env* file and add the service credentials that you obtained in the previous step.
 
     Example *.env* file that configures the `apikey` and `url` for a Watson Assistant service instance hosted in the US East region:
 
@@ -51,32 +59,7 @@ Please note this app uses the [Watson Assistant V2 API](https://console.bluemix.
     ASSISTANT_URL=https://gateway-wdc.watsonplatform.net/assistant/api
     ```
 
-    - If your service instance uses `username` and `password` credentials, add the `ASSISTANT_USERNAME` and `ASSISTANT_PASSWORD` variables to the *.env* file.
-
-    Example *.env* file that configures the `username`, `password`, and `url` for a Watson Assistant service instance hosted in the US South region:
-
-    ```
-    ASSISTANT_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
-    ASSISTANT_PASSWORD=A4Z5BdGENrwu8
-    ASSISTANT_URL=https://gateway.watsonplatform.net/assistant/api
-    ```
-    However, if your credentials contain an IAM API key, copy the `apikey` and `url` to the relevant fields.
-    ```JSON
-      {
-        "apikey": "ca2905e6-7b5d-4408-9192-e4d54d83e604",
-        "iam_apikey_description": "Auto generated apikey during resource-key ...",
-        "iam_apikey_name": "auto-generated-apikey-62b71334-3ae3-4609-be26-846fa59ece42",
-        "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
-        "iam_serviceid_crn": "crn:v1:bluemix:public:iam...",
-        "url": "https://gateway-syd.watsonplatform.net/assistant/api"
-      }
-    ```
-    ```
-    ASSISTANT_IAM_APIKEY=ca2905e6-7b5d-4408-9192-e4d54d83e604
-    ASSISTANT_IAM_URL=https://gateway-syd.watsonplatform.net/assistant/api
-    ```
-
-8. Add the `ASSISTANT_ID` to the previous properties
+1. Add the `ASSISTANT_ID` to the previous properties
 
     ```
     ASSISTANT_ID=522be-7b41-ab44-dec3-g1eab2ha73c6
@@ -129,13 +112,17 @@ For example: https://my-app-name.mybluemix.net
 This sample code is licensed under Apache 2.0.  
 Full license text is available in [LICENSE](LICENSE).
 
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
 
+## Open Source @ IBM
 
+Find more open source projects on the
+[IBM Github Page](http://ibm.github.io/).
 
+[service_url]: https://www.ibm.com/cloud/watson-assistant/
+[docs]: https://cloud.ibm.com/docs/services/assistant/index.html#about
 [demo_url]: http://assistant-demo.ng.bluemix.net/
 [doc_intents]: (https://cloud.ibm.com/docs/services/assistant?topic=assistant-intents#intents)
-[docs]: https://cloud.ibm.com/docs/services/assistant?topic=assistant-getting-started#getting-started
 [docs_landing]: (https://cloud.ibm.com/docs/services/assistant?topic=assistant-getting-started#getting-started)
-[node_link]: (http://nodejs.org/)
-[npm_link]: (https://www.npmjs.com/)
-[sign_up]: https://console.bluemix.net/registration

README.md

@@ -1,6 +1,5 @@
 const path = require('path');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
-const CleanWebpackPlugin = require('clean-webpack-plugin');
 const StyleLintPlugin = require('stylelint-webpack-plugin');
 
 const distDir = path.resolve(__dirname, '..', 'dist');
@@ -60,11 +59,6 @@ module.exports = {
     ],
   },
   plugins: [
-    new CleanWebpackPlugin([distDir], {
-      root: path.resolve(__dirname, '..'),
-      verbose: true,
-      dry: false,
-    }),
     new HtmlWebpackPlugin({
       title: 'Production',
       template: 'public/index.html',

config/webpack.config.common.js

@@ -1,10 +1,14 @@
 const webpack = require('webpack');
+const path = require('path');
 const merge = require('webpack-merge');
 const UglifyJSPlugin = require('uglifyjs-webpack-plugin');
 const ExtractTextPlugin = require('extract-text-webpack-plugin');
 const CompressionPlugin = require('compression-webpack-plugin');
+const CleanWebpackPlugin = require('clean-webpack-plugin');
 const common = require('./webpack.config.common');
 
+const distDir = path.resolve(__dirname, '..', 'dist');
+
 const extractSass = new ExtractTextPlugin({
   filename: '[name].[contenthash].css',
   disable: process.env.NODE_ENV === 'development',
@@ -33,6 +37,11 @@ module.exports = merge.smart(common, {
   },
 
   plugins: [
+    new CleanWebpackPlugin([distDir], {
+      root: path.resolve(__dirname, '..'),
+      verbose: true,
+      dry: false,
+    }),
     new UglifyJSPlugin({
       sourceMap: true,
       uglifyOptions: { ecma: 8 },

config/webpack.config.prod.js

@@ -23,9 +23,7 @@ const bank = require('./lib/bankFunctions');
 
 // declare Watson Assistant service
 const assistant = new AssistantV2({
-  version: '2018-11-08',
-  username: process.env.ASSISTANT_USERNAME || '<username>',
-  password: process.env.ASSISTANT_PASSWORD || '<password>',
+  version: '2019-01-01',
 });
 
 const date = new Date();
@@ -57,9 +55,9 @@ app.get('/', (req, res) => {
 });
 
 app.post('/api/message', (req, res) => {
-  // check for workspace id and handle null workspace env variable
-  const assistantId = process.env.ASSISTANT_ID || '<workspace-id>';
-  if (!assistantId || assistantId === '<workspace-id>') {
+  // check for assistant id and handle null assistant env variable
+  const assistantId = process.env.ASSISTANT_ID || '<assistant-id>';
+  if (!assistantId || assistantId === '<assistant-id>') {
     return res.json({
       output: {
         text: 'The app has not been configured with a ASSISTANT_ID environment variable.',
@@ -96,9 +94,10 @@ app.post('/api/message', (req, res) => {
   // send payload to Conversation and return result
   assistant.message(payload, (err, data) => {
     if (err) {
+      console.log(err);
       // TODO: return error from service, currently service returns non-legal
       // status code
-      return res.status(500).jsonp(err);
+      return res.status(err.code || 500).json(err);
     }
 
     return res.json(data);
@@ -135,7 +134,7 @@ app.get('/api/session', (req, res) => {
     assistant_id: process.env.ASSISTANT_ID || '{assistant_id}',
   }, (error, response) => {
     if (error) {
-      return res.send(error);
+      return res.status(error.code || 500).send(error);
     }
     return res.send(response);
   });

index.js

@@ -1,7 +1,7 @@
 ---
 applications:
 - name: watson-assistant-duo
-- path: .
   command: npm start
+  buildpack: sdk-for-nodejs
   env:
     NODE_ENV: production