[Generator] Include Core Bot in the bot generator

Generator/generator-botbuilder-java/README.md

@@ -15,24 +15,30 @@ The generator supports three different template options.  The table below can he
 | ---------- |  ---------  |
 | Echo Bot | A good template if you want a little more than "Hello World!", but not much more.  This template handles the very basics of sending messages to a bot, and having the bot process the messages by repeating them back to the user.  This template produces a bot that simply "echoes" back to the user anything the user says to the bot. |
 | Empty Bot | A good template if you are familiar with Bot Framework v4, and simply want a basic skeleton project.  Also a good option if you want to take sample code from the documentation and paste it into a minimal bot in order to learn. |
+| Core Bot | A good template if you want to create advanced bots, as it uses multi-turn dialogs and [LUIS](https://www.luis.ai), an AI based cognitive service, to implement language understanding. This template creates a bot that can extract places and dates to book a flight. |
 
 ### How to Choose a Template
 
 | Template | When This Template is a Good Choice |
 | -------- | -------- |
 | Echo Bot  | You are new to Bot Framework v4 and want a working bot with minimal features. |
 | Empty Bot  | You are a seasoned Bot Framework v4 developer.  You've built bots before, and want the minimum skeleton of a bot. |
+| Core Bot | You are a medium to advanced user of Bot Framework v4 and want to start integrating language understanding as well as multi-turn dialogs in your bots. |
 
 ### Template Overview
 
 #### Echo Bot Template
 
-The Echo Bot template is slightly more than the a classic "Hello World!" example, but not by much.  This template shows the basic structure of a bot, how a bot recieves messages from a user, and how a bot sends messages to a user.  The bot will "echo" back to the user, what the user says to the bot.  It is a good choice for first time, new to Bot Framework v4 developers.
+The Echo Bot template is slightly more than the a classic "Hello World!" example, but not by much.  This template shows the basic structure of a bot, how a bot receives messages from a user, and how a bot sends messages to a user.  The bot will "echo" back to the user, what the user says to the bot.  It is a good choice for first time, new to Bot Framework v4 developers.
 
 #### Empty Bot Template
 
 The Empty Bot template is the minimal skeleton code for a bot.  It provides a stub `onTurn` handler but does not perform any actions.  If you are experienced writing bots with Bot Framework v4 and want the minimum scaffolding, the Empty template is for you.
 
+#### Core Bot Template
+
+The Core Bot template uses [LUIS](https://www.luis.ai) to implement core AI capabilities, a multi-turn conversation using Dialogs, handles user interruptions, and prompts for and validate requests for information from the user. This template implements a basic three-step waterfall dialog, where the first step asks the user for an input to book a flight, then asks the user if the information is correct, and finally confirms the booking with the user.  Choose this template if want to create an advanced bot that can extract information from the user's input.
+
 ## Installation
 
 1. Install [Yeoman](http://yeoman.io) using [npm](https://www.npmjs.com) (we assume you have pre-installed [node.js](https://nodejs.org/)).

Generator/generator-botbuilder-java/generators/app/index.js

@@ -5,10 +5,9 @@
 const pkg = require('../../package.json');
 const Generator = require('yeoman-generator');
 const path = require('path');
-const _ = require('lodash');
 const chalk = require('chalk');
 const mkdirp = require('mkdirp');
-const camelCase = require('camelcase');
+const _ = require('lodash');
 
 const BOT_TEMPLATE_NAME_EMPTY = 'Empty Bot';
 const BOT_TEMPLATE_NAME_SIMPLE = 'Echo Bot';
@@ -18,6 +17,33 @@ const BOT_TEMPLATE_NOPROMPT_EMPTY = 'empty';
 const BOT_TEMPLATE_NOPROMPT_SIMPLE = 'echo';
 const BOT_TEMPLATE_NOPROMPT_CORE = 'core';
 
+const bigBot =
+  `               ╭─────────────────────────────╮\n` +
+  `   ` +
+  chalk.blue.bold(`//`) +
+  `     ` +
+  chalk.blue.bold(`\\\\`) +
+  `   │        Welcome to the       │\n` +
+  `  ` +
+  chalk.blue.bold(`//`) +
+  ` () () ` +
+  chalk.blue.bold(`\\\\`) +
+  `  │  Microsoft Java Bot Builder │\n` +
+  `  ` +
+  chalk.blue.bold(`\\\\`) +
+  `       ` +
+  chalk.blue.bold(`//`) +
+  ` /│         generator!          │\n` +
+  `   ` +
+  chalk.blue.bold(`\\\\`) +
+  `     ` +
+  chalk.blue.bold(`//`) +
+  `   ╰─────────────────────────────╯\n` +
+  `                                    v${pkg.version}`;
+
+const tinyBot =
+    ` ` + chalk.blue.bold(`<`) + ` ** ` + chalk.blue.bold(`>`) + ` `;
+
 module.exports = class extends Generator {
     constructor(args, opts) {
         super(args, opts);
@@ -31,7 +57,7 @@ module.exports = class extends Generator {
 
     initializing() {
         // give the user some data before we start asking them questions
-        this.log(`\nWelcome to the Microsoft Java Bot Builder generator v${pkg.version}. `);
+        this.log(bigBot);
     }
 
     prompting() {
@@ -59,8 +85,8 @@ module.exports = class extends Generator {
             const botName = this.templateConfig.botName;
             const packageName = this.templateConfig.packageName.toLowerCase();
             const packageTree = packageName.replace(/\./g, '/');
-            const artifact = camelCase(this.templateConfig.botName);
-            const directoryName = camelCase(this.templateConfig.botName);
+            const artifact =  _.kebabCase(this.templateConfig.botName).replace(/([^a-z0-9-]+)/gi, ``);
+            const directoryName = _.camelCase(this.templateConfig.botName);
             const template = this.templateConfig.template.toLowerCase();
 
             if (path.basename(this.destinationPath()) !== directoryName) {
@@ -104,16 +130,16 @@ module.exports = class extends Generator {
             this.log(chalk.green('------------------------ '));
             this.log(chalk.green(' Your new bot is ready!  '));
             this.log(chalk.green('------------------------ '));
-            this.log(`Your bot should be in a directory named "${camelCase(this.templateConfig.botName)}"`);
+            this.log(`Your bot should be in a directory named "${_.camelCase(this.templateConfig.botName)}"`);
             this.log('Open the ' + chalk.green.bold('README.md') + ' to learn how to run your bot. ');
             this.log('Thank you for using the Microsoft Bot Framework. ');
-            this.log('\n< ** > The Bot Framework Team');
+            this.log(`\n${tinyBot} The Bot Framework Team`);
         } else {
             this.log(chalk.red.bold('-------------------------------- '));
             this.log(chalk.red.bold(' New bot creation was canceled. '));
             this.log(chalk.red.bold('-------------------------------- '));
             this.log('Thank you for using the Microsoft Bot Framework. ');
-            this.log('\n< ** > The Bot Framework Team');
+            this.log(`\n${tinyBot} The Bot Framework Team`);
         }
     }
 
@@ -191,14 +217,11 @@ module.exports = class extends Generator {
                         {
                             name: BOT_TEMPLATE_NAME_EMPTY,
                             value: BOT_TEMPLATE_NOPROMPT_EMPTY
-                        }
-
-                        /*,
+                        },
                         {
                             name: BOT_TEMPLATE_NAME_CORE,
                             value: BOT_TEMPLATE_NOPROMPT_CORE
                         }
-                       */
                     ],
                     default: (this.options.template ? _.toLower(this.options.template) : BOT_TEMPLATE_NOPROMPT_SIMPLE)
                     }).then(answer => {

Generator/generator-botbuilder-java/generators/app/templates/core/project/README-LUIS.md

@@ -0,0 +1,216 @@
+# Setting up LUIS via CLI:
+
+This README contains information on how to create and deploy a LUIS application. When the bot is ready to be deployed to production, we recommend creating a LUIS Endpoint Resource for usage with your LUIS App.
+
+> _For instructions on how to create a LUIS Application via the LUIS portal, see these Quickstart steps:_
+> 1. _[Quickstart: Create a new app in the LUIS portal][Quickstart-create]_
+> 2. _[Quickstart: Deploy an app in the LUIS portal][Quickstart-deploy]_
+
+  [Quickstart-create]: https://docs.microsoft.com/azure/cognitive-services/luis/get-started-portal-build-app
+  [Quickstart-deploy]:https://docs.microsoft.com/azure/cognitive-services/luis/get-started-portal-deploy-app
+
+## Table of Contents:
+
+- [Prerequisites](#Prerequisites)
+- [Import a new LUIS Application using a local LUIS application](#Import-a-new-LUIS-Application-using-a-local-LUIS-application)
+- [How to create a LUIS Endpoint resource in Azure and pair it with a LUIS Application](#How-to-create-a-LUIS-Endpoint-resource-in-Azure-and-pair-it-with-a-LUIS-Application)
+
+___
+
+## [Prerequisites](#Table-of-Contents):
+
+#### Install Azure CLI >=2.0.61:
+
+Visit the following page to find the correct installer for your OS:
+- https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest
+
+#### Install LUIS CLI >=2.4.0:
+
+Open a CLI of your choice and type the following:
+
+```bash
+npm i -g luis-apis@^2.4.0
+```
+
+#### LUIS portal account:
+
+You should already have a LUIS account with either https://luis.ai, https://eu.luis.ai, or https://au.luis.ai. To determine where to create a LUIS account, consider where you will deploy your LUIS applications, and then place them in [the corresponding region][LUIS-Authoring-Regions].
+
+After you've created your account, you need your [Authoring Key][LUIS-AKey] and a LUIS application ID.
+
+  [LUIS-Authoring-Regions]: https://docs.microsoft.com/azure/cognitive-services/luis/luis-reference-regions#luis-authoring-regions]
+  [LUIS-AKey]: https://docs.microsoft.com/azure/cognitive-services/luis/luis-concept-keys#authoring-key
+
+___
+
+## [Import a new LUIS Application using a local LUIS application](#Table-of-Contents)
+
+### 1. Import the local LUIS application to luis.ai
+
+```bash
+luis import application --region "LuisAppAuthoringRegion" --authoringKey "LuisAuthoringKey" --appName "FlightBooking" --in "./cognitiveModels/FlightBooking.json"
+```
+
+Outputs the following JSON:
+
+```json
+{
+    "id": "########-####-####-####-############",
+    "name": "FlightBooking",
+    "description": "A LUIS model that uses intent and entities.",
+    "culture": "en-us",
+    "usageScenario": "",
+    "domain": "",
+    "versionsCount": 1,
+    "createdDateTime": "2019-03-29T18:32:02Z",
+    "endpoints": {},
+    "endpointHitsCount": 0,
+    "activeVersion": "0.1",
+    "ownerEmail": "[email protected]",
+    "tokenizerVersion": "1.0.0"
+}
+```
+
+For the next step, you'll need the `"id"` value for `--appId` and the `"activeVersion"` value for `--versionId`.
+
+### 2. Train the LUIS Application
+
+```bash
+luis train version --region "LuisAppAuthoringRegion" --authoringKey "LuisAuthoringKey" --appId "LuisAppId" --versionId "LuisAppversion" --wait
+```
+
+### 3. Publish the LUIS Application
+
+```bash
+luis publish version --region "LuisAppAuthoringRegion" --authoringKey "LuisAuthoringKey" --appId "LuisAppId" --versionId "LuisAppversion" --publishRegion "LuisAppPublishRegion"
+```
+
+> `--region` corresponds to the region you _author_ your application in. The regions available for this are "westus", "westeurope" and "australiaeast". <br/>
+> These regions correspond to the three available portals, https://luis.ai, https://eu.luis.ai, or https://au.luis.ai. <br/>
+> `--publishRegion` corresponds to the region of the endpoint you're publishing to, (e.g. "westus", "southeastasia", "westeurope", "brazilsouth"). <br/>
+> See the [reference docs][Endpoint-API] for a list of available publish/endpoint regions.
+
+  [Endpoint-API]: https://westus.dev.cognitive.microsoft.com/docs/services/5819c76f40a6350ce09de1ac/operations/5819c77140a63516d81aee78
+
+Outputs the following:
+
+```json
+ {
+    "versionId": "0.1",
+    "isStaging": false,
+    "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/########-####-####-####-############",
+    "region": "westus",
+    "assignedEndpointKey": null,
+    "endpointRegion": "westus",
+    "failedRegions": "",
+    "publishedDateTime": "2019-03-29T18:40:32Z",
+    "directVersionPublish": false
+}
+```
+
+To see how to create an LUIS Cognitive Service Resource in Azure, please see [the next README][README-LUIS]. This Resource should be used when you want to move your bot to production. The instructions will show you how to create and pair the resource with a LUIS Application.
+
+  [README-LUIS]: ./README-LUIS.md
+
+___
+
+## [How to create a LUIS Endpoint resource in Azure and pair it with a LUIS Application](#Table-of-Contents)
+
+### 1. Create a new LUIS Cognitive Services resource on Azure via Azure CLI
+
+> _Note:_ <br/>
+> _If you don't have a Resource Group in your Azure subscription, you can create one through the Azure portal or through using:_
+> ```bash
+> az group create --subscription "AzureSubscriptionGuid" --location "westus" --name "ResourceGroupName"
+> ```
+> _To see a list of valid locations, use `az account list-locations`_
+
+
+```bash
+# Use Azure CLI to create the LUIS Key resource on Azure
+az cognitiveservices account create --kind "luis" --name "NewLuisResourceName" --sku "S0" --location "westus" --subscription "AzureSubscriptionGuid" -g "ResourceGroupName"
+```
+
+The command will output a response similar to the JSON below:
+
+```json
+{
+  "endpoint": "https://westus.api.cognitive.microsoft.com/luis/v2.0",
+  "etag": "\"########-####-####-####-############\"",
+  "id": "/subscriptions/########-####-####-####-############/resourceGroups/ResourceGroupName/providers/Microsoft.CognitiveServices/accounts/NewLuisResourceName",
+  "internalId": "################################",
+  "kind": "luis",
+  "location": "westus",
+  "name": "NewLuisResourceName",
+  "provisioningState": "Succeeded",
+  "resourceGroup": "ResourceGroupName",
+  "sku": {
+    "name": "S0",
+    "tier": null
+  },
+  "tags": null,
+  "type": "Microsoft.CognitiveServices/accounts"
+}
+```
+
+
+
+Take the output from the previous command and create a JSON file in the following format:
+
+```json
+{
+    "azureSubscriptionId": "00000000-0000-0000-0000-000000000000",
+    "resourceGroup": "ResourceGroupName",
+    "accountName": "NewLuisResourceName"
+}
+```
+
+### 2. Retrieve ARM access token via Azure CLI
+
+```bash
+az account get-access-token --subscription "AzureSubscriptionGuid"
+```
+
+This will return an object that looks like this:
+
+```json
+{
+  "accessToken": "eyJ0eXAiOiJKVtokentokentokentokentokeng1dCI6Ik4tbEMwbi05REFMcXdodUhZbkhRNjNHZUNYYyIsItokenI6Ik4tbEMwbi05REFMcXdodUhZbkhRNjNHZUNYYyJ9.eyJhdWQiOiJodHRwczovL21hbmFnZW1lbnQuY29yZS53aW5kb3dzLm5ldC8iLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC83MmY5ODhiZi04NmYxLTQxYWYtOTFhYi0yZDdjZDAxMWRiNDcvIiwiaWF0IjoxNTUzODc3MTUwLCJuYmYiOjE1NTM4NzcxNTAsImV4cCI6MTU1Mzg4MTA1MCwiX2NsYWltX25hbWVzIjp7Imdyb3VwcyI6InNyYzEifSwiX2NsYWltX3NvdXJjZXMiOnsic3JjMSI6eyJlbmRwb2ludCI6Imh0dHBzOi8vZ3JhcGgud2luZG93cy5uZXQvNzJmOTg4YmYtODZmMS00MWFmLTkxYWItMmQ3Y2QwMTFkYjQ3L3VzZXJzL2ZmZTQyM2RkLWJhM2YtNDg0Ny04NjgyLWExNTI5MDA4MjM4Ny9nZXRNZW1iZXJPYmplY3RzIn19LCJhY3IiOiIxIiwiYWlvIjoiQVZRQXEvOEtBQUFBeGVUc201NDlhVHg4RE1mMFlRVnhGZmxxOE9RSC9PODR3QktuSmRqV1FqTkkwbmxLYzB0bHJEZzMyMFZ5bWZGaVVBSFBvNUFFUTNHL0FZNDRjdk01T3M0SEt0OVJkcE5JZW9WU0dzd0kvSkk9IiwiYW1yIjpbIndpYSIsIm1mYSJdLCJhcHBpZCI6IjA0YjA3Nzk1LThkZGItNDYxYS1iYmVlLTAyZjllMWJmN2I0NiIsImFwcGlkYWNyIjoiMCIsImRldmljZWlkIjoiNDhmNDVjNjEtMTg3Zi00MjUxLTlmZWItMTllZGFkZmMwMmE3IiwiZmFtaWx5X25hbWUiOiJHdW0iLCJnaXZlbl9uYW1lIjoiU3RldmVuIiwiaXBhZGRyIjoiMTY3LjIyMC4yLjU1IiwibmFtZSI6IlN0ZXZlbiBHdW0iLCJvaWQiOiJmZmU0MjNkZC1iYTNmLTQ4NDctODY4Mi1hMTUyOTAwODIzODciLCJvbnByZW1fc2lkIjoiUy0xLTUtMjEtMjEyNzUyMTE4NC0xNjA0MDEyOTIwLTE4ODc5Mjc1MjctMjYwOTgyODUiLCJwdWlkIjoiMTAwMzdGRkVBMDQ4NjlBNyIsInJoIjoiSSIsInNjcCI6InVzZXJfaW1wZXJzb25hdGlvbiIsInN1YiI6Ik1rMGRNMWszN0U5ckJyMjhieUhZYjZLSU85LXVFQVVkZFVhNWpkSUd1Nk0iLCJ0aWQiOiI3MmY5ODhiZi04NmYxLTQxYWYtOTFhYi0yZDdjZDAxMWRiNDciLCJ1bmlxdWVfbmFtZSI6InN0Z3VtQG1pY3Jvc29mdC5jb20iLCJ1cG4iOiJzdGd1bUBtaWNyb3NvZnQuY29tIiwidXRpIjoiT2w2NGN0TXY4RVNEQzZZQWRqRUFtokenInZlciI6IjEuMCJ9.kFAsEilE0mlS1pcpqxf4rEnRKeYsehyk-gz-zJHUrE__oad3QjgDSBDPrR_ikLdweynxbj86pgG4QFaHURNCeE6SzrbaIrNKw-n9jrEtokenlosOxg_0l2g1LeEUOi5Q4gQREAU_zvSbl-RY6sAadpOgNHtGvz3Rc6FZRITfkckSLmsKAOFoh-aWC6tFKG8P52rtB0qVVRz9tovBeNqkMYL49s9ypduygbXNVwSQhm5JszeWDgrFuVFHBUP_iENCQYGQpEZf_KvjmX1Ur1F9Eh9nb4yI2gFlKncKNsQl-tokenK7-tokentokentokentokentokentokenatoken",
+  "expiresOn": "2200-12-31 23:59:59.999999",
+  "subscription": "AzureSubscriptionGuid",
+  "tenant": "tenant-guid",
+  "tokenType": "Bearer"
+}
+```
+
+The value needed for the next step is the `"accessToken"`.
+
+### 3. Use `luis add appazureaccount` to pair your LUIS resource with a LUIS Application
+
+```bash
+luis add appazureaccount --in "path/to/created/requestBody.json" --appId "LuisAppId" --authoringKey "LuisAuthoringKey" --armToken "accessToken"
+```
+
+If successful, it should yield a response like this:
+
+```json
+{
+  "code": "Success",
+  "message": "Operation Successful"
+}
+```
+
+### 4. See the LUIS Cognitive Services' keys
+
+```bash
+az cognitiveservices account keys list --name "NewLuisResourceName" --subscription "AzureSubscriptionGuid" -g "ResourceGroupName"
+```
+
+This will return an object that looks like this:
+
+```json
+{
+  "key1": "9a69####dc8f####8eb4####399f####",
+  "key2": "####f99e####4b1a####fb3b####6b9f"
+}
+```