adding bot connector app sample

Author: weisun022

BotConnectorApp/App.config

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <appSettings>
+    <add key="BotId" value="" />
+    <add key="BotTenantId" value="" />
+    <add key="BotName" value="" />
+    <add key="BotTokenEndpoint" value="https://powerva.microsoft.com/api/botmanagement/v1/directline/directlinetoken" />
+    <add key="EndConversationMessage" value="quit" />
+  </appSettings>
+</configuration>

BotConnectorApp/BotConnector/BotEndpoint.cs

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+
+namespace Microsoft.PowerVirtualAgents.Samples.BotConnectorApp
+{
+    /// <summary>
+    /// class with bot info
+    /// </summary>
+    public class BotEndpoint
+    {
+        /// <summary>
+        /// constructor
+        /// </summary>
+        /// <param name="botId">Bot Id GUID</param>
+        /// <param name="tenantId">Bot tenant GUID</param>
+        /// <param name="tokenEndPoint">REST API endpoint to retreive directline token</param>
+        public BotEndpoint(string botId, string tenantId, string tokenEndPoint)
+        {
+            BotId = botId;
+            TenantId = tenantId;
+            UriBuilder uriBuilder = new UriBuilder(tokenEndPoint);
+            uriBuilder.Query = $"botId={BotId}&tenantId={TenantId}";
+            TokenUrl = uriBuilder.Uri;
+        }
+
+        public string BotId { get; }
+
+        public string TenantId { get; }
+
+        public Uri TokenUrl { get; }
+    }
+}

BotConnectorApp/BotConnector/BotService.cs

@@ -0,0 +1,49 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Rest.Serialization;
+using System;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerVirtualAgents.Samples.BotConnectorApp
+{
+    /// <summary>
+    /// Bot Service class to interact with bot
+    /// </summary>
+    public class BotService
+    {
+        private static readonly HttpClient s_httpClient = new HttpClient();
+
+        public string BotName { get; set; }
+
+        public string BotId { get; set; }
+
+        public string TenantId { get; set; }
+
+        public string TokenEndPoint { get; set; }
+
+        /// <summary>
+        /// Get directline token for connecting bot
+        /// </summary>
+        /// <returns>directline token as string</returns>
+        public async Task<string> GetTokenAsync()
+        {
+            string token;
+            using (var httpRequest = new HttpRequestMessage())
+            {
+                httpRequest.Method = HttpMethod.Get;
+                UriBuilder uriBuilder = new UriBuilder(TokenEndPoint);
+                uriBuilder.Query = $"botId={BotId}&tenantId={TenantId}";
+                httpRequest.RequestUri = uriBuilder.Uri;
+                using (var response = await s_httpClient.SendAsync(httpRequest))
+                {
+                    var responseString = await response.Content.ReadAsStringAsync();
+                    token = SafeJsonConvert.DeserializeObject<DirectLineToken>(responseString).Token;
+                }
+            }
+
+            return token;
+        }
+    }
+}

BotConnectorApp/BotConnector/DirectLineToken.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.PowerVirtualAgents.Samples.BotConnectorApp
+{
+    /// <summary>
+    /// class for serialization/deserialization DirectLineToken
+    /// </summary>
+    public class DirectLineToken
+    {
+        /// <summary>
+        /// constructor
+        /// </summary>
+        /// <param name="token">Directline token string</param>
+        public DirectLineToken(string token)
+        {
+            Token = token;
+        }
+
+        public string Token { get; set; }
+    }
+}

BotConnectorApp/BotConnectorApp.cs

@@ -0,0 +1,160 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Bot.Connector.DirectLine;
+using System;
+using System.Collections.Generic;
+using System.Configuration;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerVirtualAgents.Samples.BotConnectorApp
+{
+    public class BotConnectorApp
+    {
+        private static string _watermark = null;
+        private const int _botReplyWaitIntervalInMilSec = 3000;
+        private const string _botDisplayName = "Bot";
+        private const string _userDisplayName = "You";
+        private static string s_endConversationMessage;
+        private static BotService s_botService;
+
+        /// <summary>
+        /// Start BotConnectorApp console
+        /// See <see cref="README.md"/> for information on how to update bot settings in App.config
+        /// Takes user input and output bot reply, until user types EndConversationMessage
+        /// </summary>
+        public static void Main(string[] args)
+        {
+            var botId = ConfigurationManager.AppSettings["BotId"] ?? string.Empty;
+            var tenantId = ConfigurationManager.AppSettings["BotTenantId"] ?? string.Empty;
+            var botTokenEndpoint = ConfigurationManager.AppSettings["BotTokenEndpoint"] ?? string.Empty;
+            var botName = ConfigurationManager.AppSettings["BotName"] ?? string.Empty;
+            s_endConversationMessage = ConfigurationManager.AppSettings["EndConversationMessage"] ?? "quit";
+            if (string.IsNullOrEmpty(botId) || string.IsNullOrEmpty(tenantId) || string.IsNullOrEmpty(botTokenEndpoint) || string.IsNullOrEmpty(botName))
+            {
+                Console.WriteLine("Update App.config and start again.");
+                Console.WriteLine("Press any key to exit");
+                Console.Read();
+                Environment.Exit(0);
+            }
+
+            s_botService = new BotService()
+            {
+                BotName = botName,
+                BotId = botId,
+                TenantId = tenantId,
+                TokenEndPoint = botTokenEndpoint,
+            };
+            StartConversation().Wait();
+        }
+
+        private static async Task StartConversation()
+        {
+            var token = await s_botService.GetTokenAsync();
+            using (var directLineClient = new DirectLineClient(token))
+            {
+                var conversation = await directLineClient.Conversations.StartConversationAsync();
+                var conversationtId = conversation.ConversationId;
+                string inputMessage;
+
+                while (!string.Equals(inputMessage = GetUserInput(), s_endConversationMessage, StringComparison.OrdinalIgnoreCase))
+                {
+                    // Send user message using directlineClient
+                    await directLineClient.Conversations.PostActivityAsync(conversationtId, new Activity()
+                    {
+                        Type = ActivityTypes.Message,
+                        From = new ChannelAccount { Id = "userId", Name = "userName" },
+                        Text = inputMessage,
+                        TextFormat = "plain",
+                        Locale = "en-Us",
+                    });
+
+                    Console.WriteLine($"{_botDisplayName}:");
+                    Thread.Sleep(_botReplyWaitIntervalInMilSec);
+
+                    // Get bot response using directlinClient
+                    List<Activity> responses = await GetBotResponseActivitiesAsync(directLineClient, conversationtId);
+                    BotReply(responses);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Prompt for user input
+        /// </summary>
+        /// <returns>user message as string</returns>
+        private static string GetUserInput()
+        {
+            Console.WriteLine($"{_userDisplayName}:");
+            var inputMessage = Console.ReadLine();
+            return inputMessage;
+        }
+
+        /// <summary>
+        /// Use directlineClient to get bot response
+        /// </summary>
+        /// <returns>List of DirectLine activities</returns>
+        /// <param name="directLineClient">directline client</param>
+        /// <param name="conversationtId">current conversation ID</param>
+        /// <param name="botName">name of bot to connect to</param>
+        private static async Task<List<Activity>> GetBotResponseActivitiesAsync(DirectLineClient directLineClient, string conversationtId)
+        {
+            ActivitySet response = null;
+            List<Activity> result = new List<Activity>();
+
+            do
+            {
+                response = await directLineClient.Conversations.GetActivitiesAsync(conversationtId, _watermark);
+                if (response == null)
+                {
+                    // response can be null if directLineClient token expires
+                    Console.WriteLine("Conversation expired. Press any key to exit.");
+                    Console.Read();
+                    directLineClient.Dispose();
+                    Environment.Exit(0);
+                }
+
+                _watermark = response?.Watermark;
+                result = response?.Activities?.Where(x =>
+                  x.Type == ActivityTypes.Message &&
+                    string.Equals(x.From.Name, s_botService.BotName, StringComparison.Ordinal)).ToList();
+
+                if (result != null && result.Any())
+                {
+                    return result;
+                }
+
+                Thread.Sleep(1000);
+            } while (response != null && response.Activities.Any());
+
+            return new List<Activity>();
+        }
+
+        /// <summary>
+        /// Print bot reply to console
+        /// </summary>
+        /// <param name="responses">List of DirectLine activities <see cref="https://github.com/Microsoft/botframework-sdk/blob/master/specs/botframework-activity/botframework-activity.md"/>
+        /// </param>
+        private static void BotReply(List<Activity> responses)
+        {
+            responses?.ForEach(responseActivity =>
+            {
+                // responseActivity is standard Microsoft.Bot.Connector.DirectLine.Activity
+                // See https://github.com/Microsoft/botframework-sdk/blob/master/specs/botframework-activity/botframework-activity.md for reference
+                // Showing examples of Text & SuggestedActions in response payload
+                if (!string.IsNullOrEmpty(responseActivity.Text))
+                {
+                    Console.WriteLine(string.Join(Environment.NewLine, responseActivity.Text));
+                }
+
+                if (responseActivity.SuggestedActions != null && responseActivity.SuggestedActions.Actions != null)
+                {
+                    var options = responseActivity.SuggestedActions?.Actions?.Select(a => a.Title).ToList();
+                    Console.WriteLine($"\t{string.Join(" | ", options)}");
+                }
+            });
+        }
+    }
+}

BotConnectorApp/BotConnectorApp.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Bot.Connector.DirectLine" Version="3.0.2" />
+    <PackageReference Include="Microsoft.Rest.ClientRuntime" Version="2.3.20" />
+    <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.6.0" />
+  </ItemGroup>
+
+</Project>

BotConnectorApp/README.md

@@ -0,0 +1,44 @@
+# Bot Connector
+
+This console app shows the minimum code required to connect customized client to an existing virtual agent.
+
+## Prerequisites
+
+- [.NET Core SDK](https://dotnet.microsoft.com/download) version 2.1
+
+  ```powershell
+  # determine dotnet version
+  dotnet --version
+  ```
+
+## To try this sample
+- Update following settings in `BotConnectorApp\App.config`
+
+  1) Set value for `BotName` to name of the bot to connect
+  2) Update `BotId` and `BotTenantId` as follows:
+
+     To retrieve your bot's bot ID and tenant ID, click on left side pane's ***Manage***, click ***Channels*** and click on the Azure Bot Service channel that you need to connect to.
+    Copy and save the bot ID and tenant ID value by clicking Copy.
+
+  3) Update `EndConversationMessage` if needed
+
+-  Run `BotConnectorApp` from a terminal
+
+    ```
+    # change into project folder
+    cd BotConnectorApp
+
+    # run the bot
+    dotnet run
+    ```
+
+- Run `BotConnectorApp` from Visual Studio
+
+  1) Launch Visual Studio
+  2) File -> Open -> Project/Solution
+  3) Navigate to `BotConnectorApp` folder and select `BotConnectorApp.csproj` file
+  4) Press `F5` to run the project
+
+## Further reading
+- [Power Virtual Agents Bot](https://www.bing.com) ***to be updated once formal doc url determined**
+- [Power Virtual Agents - connect bot to custom application](https://www.bing.com) ***to be updated once formal doc url determined**