botnaut

<!DOCTYPE HTML> <html lang="" > <head> <meta charset="UTF-8"> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> <title>Using with Wingbot.ai · Botnaut</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="description" content=""> <meta name="generator" content="GitBook 3.2.3"> <meta name="author" content="David Menger"> <link rel="stylesheet" href="../gitbook/style.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-anchors/plugin.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css"> <meta name="HandheldFriendly" content="true"/> <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> <meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-status-bar-style" content="black"> <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png"> <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon"> <link rel="next" href="usingWithWingbot.html" /> <link rel="prev" href="analytics.html" /> </head> <body> <div class="book"> <div class="book-summary"> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search" /> </div> <nav role="navigation"> <ul class="summary"> <li class="header">Building a chat bot</li> <li class="chapter " data-level="1.1" data-path="../"> <a href="../"> Getting Started </a> </li> <li class="chapter " data-level="1.2" data-path="buildingConversation.html"> <a href="buildingConversation.html"> Building a Conversation </a> <ul class="articles"> <li class="chapter " data-level="1.2.1" data-path="buildingConversation.html"> <a href="buildingConversation.html#asking-a-question"> Asking a question </a> </li> <li class="chapter " data-level="1.2.2" data-path="buildingConversation.html"> <a href="buildingConversation.html#using-quick-replies-for-controlling-conversation"> Using quick replies </a> </li> <li class="chapter " data-level="1.2.3" data-path="buildingConversation.html"> <a href="buildingConversation.html#post-back-is-also-an-action"> Postbacks </a> </li> </ul> </li> <li class="chapter " data-level="1.3" data-path="conversationState.html"> <a href="conversationState.html"> Conversation State </a> <ul class="articles"> <li class="chapter " data-level="1.3.1" data-path="conversationState.html"> <a href="conversationState.html#accessing-user-profile"> User profile </a> </li> <li class="chapter " data-level="1.3.2" data-path="conversationState.html"> <a href="conversationState.html#using-the-state-in-navigation"> Using state in navigation </a> </li> <li class="chapter " data-level="1.3.3" data-path="conversationState.html"> <a href="conversationState.html#reading-and-modifiing-user-state"> Reading and writing state </a> </li> </ul> </li> <li class="chapter " data-level="1.4" data-path="asyncActions.html"> <a href="asyncActions.html"> Asynchronous Actions </a> <ul class="articles"> <li class="chapter " data-level="1.4.1" data-path="asyncActions.html"> <a href="asyncActions.html#blocking-asynchronous-actions"> Blocking Actions </a> </li> <li class="chapter " data-level="1.4.2" data-path="asyncActions.html"> <a href="asyncActions.html#non-blocking-asynchronous-actions"> Non Blocking Actions </a> </li> <li class="chapter " data-level="1.4.3" data-path="asyncActions.html"> <a href="asyncActions.html#loading-attachments-to-buffer"> Loading Attachments </a> </li> </ul> </li> <li class="chapter " data-level="1.5" data-path="advancedRouting.html"> <a href="advancedRouting.html"> Advanced Routing </a> <ul class="articles"> <li class="chapter " data-level="1.5.1" data-path="advancedRouting.html"> <a href="advancedRouting.html#resolving-actions"> Resolving Actions </a> </li> <li class="chapter " data-level="1.5.2" data-path="advancedRouting.html"> <a href="advancedRouting.html#simple-text-actions"> Text Actions </a> </li> <li class="chapter " data-level="1.5.3" data-path="advancedRouting.html"> <a href="advancedRouting.html#integrating-with-ai-prediction"> Integrating AI </a> </li> <li class="chapter " data-level="1.5.4" data-path="advancedRouting.html"> <a href="advancedRouting.html#redirecting-flow-with-post-back"> Redirecting with Postback </a> </li> </ul> </li> <li class="chapter " data-level="1.6" data-path="nestingRouters.html"> <a href="nestingRouters.html"> Nesting - Reusable Blocks </a> <ul class="articles"> <li class="chapter " data-level="1.6.1" data-path="nestingRouters.html"> <a href="nestingRouters.html#basic-concept"> Concept </a> </li> <li class="chapter " data-level="1.6.2" data-path="nestingRouters.html"> <a href="nestingRouters.html#example"> Example </a> </li> </ul> </li> <li class="chapter " data-level="1.7" data-path="templates.html"> <a href="templates.html"> Sending Templates </a> <ul class="articles"> <li class="chapter " data-level="1.7.1" data-path="templates.html"> <a href="templates.html#button-template"> Button Template </a> </li> <li class="chapter " data-level="1.7.2" data-path="templates.html"> <a href="templates.html#generic-template"> Generic Template </a> </li> <li class="chapter " data-level="1.7.3" data-path="templates.html"> <a href="templates.html#receipt-template"> Receipt Template </a> </li> <li class="chapter " data-level="1.7.4" data-path="templates.html"> <a href="templates.html#working-with-webviews"> Webviews </a> </li> </ul> </li> <li class="chapter " data-level="1.8" data-path="testing.html"> <a href="testing.html"> Testing </a> </li> <li class="chapter " data-level="1.9" data-path="analytics.html"> <a href="analytics.html"> Analytics </a> </li> <li class="chapter active" data-level="1.10" data-path="usingWithWingbot.html"> <a href="usingWithWingbot.html"> Using with Wingbot.ai </a> <ul class="articles"> <li class="chapter " data-level="1.10.1" data-path="usingWithWingbot.html"> <a href="usingWithWingbot.html#bot-configuration"> Bot configuration </a> </li> <li class="chapter " data-level="1.10.2" data-path="usingWithWingbot.html"> <a href="usingWithWingbot.html#express-mongodb"> Express Mongodb </a> </li> <li class="chapter " data-level="1.10.3" data-path="usingWithWingbot.html"> <a href="usingWithWingbot.html#serverless-aws-lambda"> Serverless AWS Lambda </a> </li> </ul> </li> <li class="header">API</li> <li class="chapter " data-level="2.1" data-path="../api/Request.html"> <a href="../api/Request.html"> Request </a> </li> <li class="chapter " data-level="2.2" data-path="../api/Responder.html"> <a href="../api/Responder.html"> Responder </a> </li> <li class="chapter " data-level="2.3" data-path="../api/Router.html"> <a href="../api/Router.html"> Router </a> </li> <li class="chapter " data-level="2.4" data-path="../api/Tester.html"> <a href="../api/Tester.html"> Tester </a> </li> <li class="chapter " data-level="2.5" data-path="../api/ButtonTemplate.html"> <a href="../api/ButtonTemplate.html"> Template Builders </a> <ul class="articles"> <li class="chapter " data-level="2.5.1" data-path="../api/ButtonTemplate.html"> <a href="../api/ButtonTemplate.html#ButtonTemplate"> ButtonTemplate </a> </li> <li class="chapter " data-level="2.5.2" data-path="../api/ButtonTemplate.html"> <a href="../api/ButtonTemplate.html#GenericTemplate"> GenericTemplate </a> </li> <li class="chapter " data-level="2.5.3" data-path="../api/ButtonTemplate.html"> <a href="../api/ButtonTemplate.html#ReceiptTemplate"> ReceiptTemplate </a> </li> </ul> </li> <li class="chapter " data-level="2.6" data-path="../api/Settings.html"> <a href="../api/Settings.html"> Bot Settings </a> </li> <li class="chapter " data-level="2.7" data-path="../api/express.html"> <a href="../api/express.html"> Express/MongoDb tools </a> </li> <li class="chapter " data-level="2.8" data-path="../api/bufferloader.html"> <a href="../api/bufferloader.html"> Utils </a> </li> <li class="chapter " data-level="2.9" data-path="../api/Ai.html"> <a href="../api/Ai.html"> Ai </a> </li> <li class="chapter " data-level="2.10" data-path="../api/serverlessAWS.html"> <a href="../api/serverlessAWS.html"> Serverless </a> </li> <li class="chapter " data-level="2.11" data-path="../api/BuildRouter.html"> <a href="../api/BuildRouter.html"> Wingbot.ai </a> </li> <li class="chapter " data-level="2.12" data-path="../api/callback.html"> <a href="../api/callback.html"> Middlewares </a> </li> <li class="divider"></li> <li> <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> Published with GitBook </a> </li> </ul> </nav> </div> <div class="book-body"> <div class="body-inner"> <div class="book-header" role="navigation">  <h1> <a href=".." >Using with Wingbot.ai</a> </h1> </div> <div class="page-wrapper" tabindex="-1" role="main"> <div class="page-inner"> <div id="book-search-results"> <div class="search-noresults"> <section class="normal markdown-section"> <h1 id="using-with-wingbot"><a name="using-with-wingbot" class="plugin-anchor" href="#using-with-wingbot"></a>Using With Wingbot</h1> <h2 id="bot-configuration"><a name="bot-configuration" class="plugin-anchor" href="#bot-configuration"></a>Bot configuration</h2> bot.js - common file for every configuration <pre><code class="lang-javascript">'use strict'; const { BuildRouter, Blocks, Router, ai } = require('botnaut'); const wingbotConfig = { botId: '2d48492a-a281-4223-8e6f-7f60a447bc41', snapshot: 'development', token: 'wingbot-token' }; const botName = 'bot-name'; const blocks = new Blocks(); blocks.code('exampleBlock', function* (req, res, postBack, context, params) { yield res.run('responseBlockName'); }); ai.register(`${botName}-${wingbotConfig.snapshot}`); function botFactory () { const bot = new BuildRouter(wingbotConfig, blocks); bot.use((req, res) => { // example middleware return Router.CONTINUE; }); return bot; } module.exports = { botFactory, wingbotConfig }; </code></pre> <h2 id="express-mongodb"><a name="express-mongodb" class="plugin-anchor" href="#express-mongodb"></a>Express Mongodb</h2> app.js <pre><code class="lang-javascript">'use strict'; const express = require('express'); const bodyParser = require('body-parser'); const mongoose = require('mongoose'); const { createRouter, createProcessor, createValidator, createUpdater } = require('botnaut/express'); const { botFactory, wingbotConfig } = require('./bot'); const bot = botFactory(); const processor = createProcessor(bot, { pageToken: '--fb-page-token--', appSecret: '--fb-app-secret', autoTyping: true, }); const app = express(); app.use('/botnaut', createRouter(processor, '--webhook-verification-token--')); app.post('/update', createUpdater(bot, wingbotConfig.token)); app.post('/validate', createValidator(bodyParser, { routerFactory: botFactory, token: wingbotConfig.token })); mongoose.connect('mongodb://localhost/myapp') .then(() => app.listen(3000)); </code></pre> <h2 id="serverless-aws-lambda"><a name="serverless-aws-lambda" class="plugin-anchor" href="#serverless-aws-lambda"></a>Serverless AWS Lambda</h2> example application for botHandler.js <pre><code class="lang-javascript">'use strict'; const AWS = require('aws-sdk'); const { createHandler, createProcessor, createValidator } = require('botnaut/serverlessAWS'); const { botFactory, wingbotConfig } = require('./bot'); const dynamoDb = new AWS.DynamoDB({ // for localhost // endpoint: new AWS.Endpoint('http://localhost:8000'), // region: 'eu-west-1' apiVersion: '2012-08-10' }); const bot = botFactory(); const processor = createProcessor(bot, { pageToken: '--fb-page-token--', appSecret: '--fb-app-secret', autoTyping: true, dynamo: { db: dynamoDb, tablePrefix: `${process.env.PREFIX}-` } }); module.exports.handleRequest = createHandler(processor, '--webhook-verification-token--'); module.exports.validateBot = createValidator({ routerFactory: botFactory, token: wingbotConfig.token }); </code></pre> updateHandler.js <pre><code class="lang-javascript">const { createUpdater } = require('botnaut/serverlessAWS'); module.exports.update = createUpdater('lambda-fn-name', 'wingbot-token'); </code></pre> serverless.yml <pre><code class="lang-yaml">service: wingbot-botnaut custom: accountId: 12344566 stage: ${opt:stage, self:provider.stage} prefix: ${self:service}-${self:custom.stage} provider: name: aws runtime: nodejs6.10 region: eu-west-1 stage: staging memorySize: 256 iamRoleStatements: # permissions for all of your functions can be set here - Effect: Allow Action: # Gives permission to DynamoDB tables in a specific region - dynamodb:DescribeTable Resource: arn:aws:dynamodb:${self:provider.region}:*:* - Effect: Allow Action: # Gives permission to DynamoDB tables in a specific region - dynamodb:DescribeTable - dynamodb:Query - dynamodb:Scan - dynamodb:GetItem - dynamodb:PutItem - dynamodb:UpdateItem - dynamodb:DeleteItem Resource: arn:aws:dynamodb:${self:provider.region}:*:table/${self:custom.prefix}* environment: PREFIX: ${self:custom.prefix} NODE_ENV: ${self:custom.stage} functions: botnaut: handler: botHandler.handleRequest maxRetries: 1 timeout: 30 events: - http: GET /botnaut - http: POST /botnaut validateBot: handler: botHandler.validateBot memorySize: 192 events: - http: POST /validate updateLambdaHandler: handler: updateLambdaHandler.update memorySize: 192 timeout: 30 role: DeployRole events: - http: POST /update resources: Resources: DeployRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Statement: - Effect: Allow Principal: Service: lambda.amazonaws.com Action: - sts:AssumeRole Path: '/' RoleName: ${self:custom.prefix}-${self:provider.region}-workerRole Policies: - PolicyName: ${self:custom.prefix}-workerLambda PolicyDocument: Statement: - Effect: Allow Action: - "logs:CreateLogGroup" - "logs:CreateLogStream" Resource: - 'arn:aws:logs:${self:provider.region}:${self:custom.accountId}:log-group:/aws/lambda/${self:custom.prefix}-updateLambdaHandler:*' - Effect: Allow Action: - "logs:PutLogEvents" Resource: - 'arn:aws:logs:${self:provider.region}:${self:custom.accountId}:log-group:/aws/lambda/${self:custom.prefix}-updateLambdaHandler:*:*' - Effect: Allow Action: - "lambda:GetFunctionConfiguration" - "lambda:UpdateFunctionConfiguration" Resource: - "arn:aws:lambda:${self:provider.region}:${self:custom.accountId}:function:${self:custom.prefix}-botnaut" StatesTable: Type: AWS::DynamoDB::Table Properties: TableName: ${self:custom.prefix}-states AttributeDefinitions: - AttributeName: senderId AttributeType: S KeySchema: - AttributeName: senderId KeyType: HASH ProvisionedThroughput: ReadCapacityUnits: 1 WriteCapacityUnits: 1 ChatlogTable: Type: AWS::DynamoDB::Table Properties: TableName: ${self:custom.prefix}-chatlog AttributeDefinitions: - AttributeName: userId AttributeType: S - AttributeName: time AttributeType: S KeySchema: - AttributeName: userId KeyType: HASH - AttributeName: time KeyType: RANGE ProvisionedThroughput: ReadCapacityUnits: 1 WriteCapacityUnits: 1 BottokensTable: Type: AWS::DynamoDB::Table Properties: TableName: ${self:custom.prefix}-bottokens AttributeDefinitions: - AttributeName: senderId AttributeType: S - AttributeName: token AttributeType: S KeySchema: - AttributeName: senderId KeyType: HASH GlobalSecondaryIndexes: - IndexName: token KeySchema: - AttributeName: token KeyType: HASH Projection: ProjectionType: ALL ProvisionedThroughput: ReadCapacityUnits: 1 WriteCapacityUnits: 1 ProvisionedThroughput: ReadCapacityUnits: 1 WriteCapacityUnits: 1 </code></pre> </section> </div> <div class="search-results"> <div class="has-results"> <h1 class="search-results-title"> results matching ""</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching ""</h1> </div> </div> </div> </div> </div> </div> <a href="analytics.html" class="navigation navigation-prev " aria-label="Previous page: Analytics"> </a> <a href="usingWithWingbot.html#bot-configuration" class="navigation navigation-next " aria-label="Next page: Bot configuration"> </a> </div> <script> var gitbook = gitbook || []; gitbook.push(function() { gitbook.page.hasChanged({"page":{"title":"Using with Wingbot.ai","level":"1.10","depth":1,"next":{"title":"Bot configuration","level":"1.10.1","depth":2,"anchor":"#bot-configuration","path":"tutorial/usingWithWingbot.md","ref":"tutorial/usingWithWingbot.md#bot-configuration","articles":[]},"previous":{"title":"Analytics","level":"1.9","depth":1,"path":"tutorial/analytics.md","ref":"tutorial/analytics.md","articles":[]},"dir":"ltr"},"config":{"plugins":["theme-default","collapsible-menu","anchors"],"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"},"pluginsConfig":{"collapsible-menu":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"theme-api":{"theme":"dark","languages":[{"lang":"js","name":"JavaScript","default":true}]},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"showLevel":false,"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}},"anchors":{}},"theme":"default","author":"David Menger","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"twitter":"https://twitter.com/davidmenger"},"title":"Botnaut","gitbook":"*","description":"Facebook Messenger framework for Node.js"},"file":{"path":"tutorial/usingWithWingbot.md","mtime":"2018-01-10T14:39:54.718Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-05-23T15:31:59.833Z"},"basePath":"..","book":{"language":""}}); }); </script> </div> <script src="../gitbook/gitbook.js"></script> <script src="../gitbook/theme.js"></script> <script src="../gitbook/gitbook-plugin-collapsible-menu/plugin.js"></script> <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script> <script src="../gitbook/gitbook-plugin-search/search.js"></script> <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script> <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script> <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script> <script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> </body> </html>