Merge pull request #33 from RocketChat/incoming-event

[NEW] add a action to trigger an event

Author: renatobecker

README.md

@@ -77,7 +77,10 @@ The app provides API to trigger specific actions. The URL for the API can be fou
     2. **Handover**<br/>
         To perform a handover
         - REST API Documentation for this endpoint can be found [here](./docs/api-endpoints/perform-handover.md)
-    3. **Send-Message**<br/>
+    3. **Trigger Event**<br/>
+        To trigger an event on Dialogflow
+        - REST API Documentation for this endpoint can be found [here](./docs/api-endpoints/trigger-event.md)
+    4. **Send-Message**<br/>
         To send a message as a bot to Visitor
         - REST API Documentation for this endpoint can be found [here](./docs/api-endpoints/send-message.md)
 2. Fulfillment API/Endpoint

docs/api-endpoints/trigger-event.md

@@ -0,0 +1,109 @@
+**Trigger Event**
+----
+  Action to Trigger an Event
+
+* **URL**
+
+    REST API URL can be found on Apps Page <br />
+    Sample Url for eg: <br /> `http://localhost:3000/api/apps/public/783d8e4d-b06a-409a-aaf3-b37650dc0a26/incoming`
+
+* **Method:**
+
+  `POST`
+  
+*  **Input Data Format**
+
+    `JSON`
+
+* **Data Params**
+
+  **Required:**
+ 
+   1. `action` = `trigger-event`  <br/>
+ 
+   2. `sessionId=[string]`
+      > Note. Session Id is the same session of Dialogflow
+
+   3. ```bash
+        actionData: {
+            event: {
+                "name": string,
+                "parameters": {
+                    object
+                },
+                languageCode: string
+            }
+        }
+   
+        ```
+      > The structure for this actionData is similar to [EventInput](https://cloud.google.com/dialogflow/docs/reference/rest/v2/QueryInput#eventinput)
+
+
+* **Sample Payload:**
+
+    ```javascript
+        {
+            action: "trigger-event",
+            sessionId: "uGM3uDZkAjtiBb4MA",
+            actionData: {
+                event: {
+                    name: "Welcome",
+                    parameters: {
+                        "name": "Sam"
+                    },
+                    languageCode: "en"
+                }
+            }
+        }
+    ```
+
+
+* **Success Response:**
+
+  * **Code:** 200 <br />
+    **Content:** `{ result: "Your request was processed successfully" }`
+ 
+* **Error Response:**
+
+  * **Code:** 400 BAD REQUEST <br />
+    **Content:** <br/>
+    `{
+        error: "Error: Session Id not present in request"
+    }`
+
+  OR
+
+  * **Code:** 500 Internal Server Error <br />
+    **Content:** <br />
+    `{ error : "Error occurred while processing perform-handover. Details:- [Error Details]" }`
+
+* **Sample Call:**
+
+    **Curl**
+    ```bash
+      curl "http://localhost:3000/api/apps/public/21b7d3ba-031b-41d9-8ff2-fbbfa081ae90/incoming" \
+        -X POST \
+        -d "{\n  \"action\": \"trigger-event\",\n  \"sessionId\": \"uGM3uDZkAjtiBb4MA\",\n  \"actionData\": {\n    \"event\": {\n      \"name\": \"Welcome\",\n      \"parameters\": {\n        \"name\": \"Sam\"\n      },\n      \"languageCode\": \"en\"\n    }\n  }\n}" \
+        -H "Content-Type: application/json" 
+    ```
+    **HTTP**
+
+  ```HTTP
+    POST /api/apps/public/21b7d3ba-031b-41d9-8ff2-fbbfa081ae90/incoming HTTP/1.1
+    Host: localhost:3000
+    Content-Type: application/json
+
+    {
+        "action": "trigger-event",
+        "sessionId": "uGM3uDZkAjtiBb4MA",
+        "actionData": {
+            "event": {
+                "name": "Welcome",
+                "parameters": {
+                    "name": "Sam"
+                },
+                "languageCode": "en"
+            }
+        }
+    }
+  ```

endpoints/IncomingEndpoint.ts

@@ -1,9 +1,11 @@
 import { HttpStatusCode, IHttp, IModify, IPersistence, IRead } from '@rocket.chat/apps-engine/definition/accessors';
 import { ApiEndpoint, IApiEndpointInfo, IApiRequest, IApiResponse } from '@rocket.chat/apps-engine/definition/api';
 import { ILivechatRoom } from '@rocket.chat/apps-engine/definition/livechat';
+import { IDialogflowMessage, DialogflowRequestType } from '../enum/Dialogflow';
 import { EndpointActionNames, IActionsEndpointContent } from '../enum/Endpoints';
 import { Headers, Response } from '../enum/Http';
 import { Logs } from '../enum/Logs';
+import { Dialogflow } from '../lib/Dialogflow';
 import { createHttpResponse } from '../lib/Http';
 import { createDialogflowMessage } from '../lib/Message';
 import { closeChat, performHandover } from '../lib/Room';
@@ -20,15 +22,15 @@ export class IncomingEndpoint extends ApiEndpoint {
         this.app.getLogger().info(Logs.ENDPOINT_RECEIVED_REQUEST);
 
         try {
-            await this.processRequest(read, modify, persis, request.content);
+            await this.processRequest(read, modify, http, request.content);
             return createHttpResponse(HttpStatusCode.OK, { 'Content-Type': Headers.CONTENT_TYPE_JSON }, { result: Response.SUCCESS });
         } catch (error) {
             this.app.getLogger().error(Logs.ENDPOINT_REQUEST_PROCESSING_ERROR, error);
             return createHttpResponse(HttpStatusCode.INTERNAL_SERVER_ERROR, { 'Content-Type': Headers.CONTENT_TYPE_JSON }, { error: error.message });
         }
     }
 
-    private async processRequest(read: IRead, modify: IModify, persis: IPersistence, endpointContent: IActionsEndpointContent) {
+    private async processRequest(read: IRead, modify: IModify, http: IHttp, endpointContent: IActionsEndpointContent) {
 
         const { action, sessionId } = endpointContent;
         if (!sessionId) { throw new Error(Logs.INVALID_SESSION_ID); }
@@ -43,6 +45,18 @@ export class IncomingEndpoint extends ApiEndpoint {
                 const { visitor: { token: visitorToken } } = room;
                 await performHandover(modify, read, sessionId, visitorToken, targetDepartment);
                 break;
+            case EndpointActionNames.TRIGGER_EVENT:
+                const { actionData: { event = null } = {} } = endpointContent;
+                if (!event) { throw new Error(Logs.INVALID_EVENT_DATA); }
+
+                try {
+                    const response: IDialogflowMessage = await Dialogflow.sendRequest(http, read, modify, sessionId, event, DialogflowRequestType.EVENT);
+                    await createDialogflowMessage(sessionId, read, modify, response);
+                } catch (error) {
+                    this.app.getLogger().error(`${Logs.DIALOGFLOW_REST_API_ERROR} ${error.message}`);
+                    throw new Error(`${Logs.DIALOGFLOW_REST_API_ERROR} ${error.message}`);
+                }
+                break;
             case EndpointActionNames.SEND_MESSAGE:
                 const { actionData: { messages = null } = {} } = endpointContent;
                 if (!messages) { throw new Error(Logs.INVALID_MESSAGES); }

enum/Dialogflow.ts

@@ -14,6 +14,12 @@ export interface IDialogflowAccessToken {
     expiration: Date;
 }
 
+export interface IDialogflowEvent {
+    name: string;
+    parameters?: any;
+    languageCode: string;
+}
+
 export enum QuickReplyContentType {
     TEXT = 'text',
 }
@@ -38,3 +44,8 @@ export enum Base64 {
 export enum LanguageCode {
     EN = 'en',
 }
+
+export enum DialogflowRequestType {
+    MESSAGE = 'message',
+    EVENT = 'event',
+}

enum/Endpoints.ts

@@ -1,16 +1,18 @@
-import { IDialogflowQuickReplies } from './Dialogflow';
+import { IDialogflowEvent, IDialogflowQuickReplies } from './Dialogflow';
 
 export interface IActionsEndpointContent {
     action: EndpointActionNames;
     sessionId: string;
     actionData?: {
         targetDepartment?: string;
+        event?: IDialogflowEvent;
         messages: Array<string | IDialogflowQuickReplies>;
     };
 }
 
 export enum EndpointActionNames {
     CLOSE_CHAT = 'close-chat',
     HANDOVER = 'handover',
+    TRIGGER_EVENT = 'trigger-event',
     SEND_MESSAGE = 'send-message',
 }

enum/Logs.ts

@@ -6,6 +6,7 @@ export enum Logs {
     INVALID_BOT_USERNAME_SETTING = 'The Bot User does not exist.',
     INVALID_VISITOR_TOKEN = 'Error: Visitor Token not valid',
     INVALID_DEPARTMENT_NAME = 'Error: Department Name is not valid',
+    INVALID_EVENT_DATA = 'Error! Event Data not valid',
     INVALID_MESSAGES = 'Error! Messages data not present or in wrong format. Kindly refer the api documentation.',
     ENDPOINT_REQUEST_PROCESSING_ERROR = 'Error occurred while processing the request. Details:- ',
     INVALID_ENDPOINT_ACTION = 'Error!! Invalid Action type',

handler/PostMessageSentHandler.ts

@@ -3,7 +3,7 @@ import { IApp } from '@rocket.chat/apps-engine/definition/IApp';
 import { ILivechatMessage, ILivechatRoom } from '@rocket.chat/apps-engine/definition/livechat';
 import { RoomType } from '@rocket.chat/apps-engine/definition/rooms';
 import { AppSetting, DefaultMessage } from '../config/Settings';
-import { IDialogflowMessage } from '../enum/Dialogflow';
+import { DialogflowRequestType, IDialogflowMessage } from '../enum/Dialogflow';
 import { Logs } from '../enum/Logs';
 import { Dialogflow } from '../lib/Dialogflow';
 import { createDialogflowMessage, createMessage } from '../lib/Message';
@@ -48,7 +48,7 @@ export class PostMessageSentHandler {
 
         let response: IDialogflowMessage;
         try {
-            response = (await Dialogflow.sendMessage(this.http, this.read, this.modify, rid, text));
+            response = (await Dialogflow.sendRequest(this.http, this.read, this.modify, rid, text, DialogflowRequestType.MESSAGE));
         } catch (error) {
             this.app.getLogger().error(`${Logs.DIALOGFLOW_REST_API_ERROR} ${error.message}`);
 

lib/Dialogflow.ts

@@ -2,7 +2,7 @@ import { IHttp, IHttpRequest, IModify, IPersistence, IRead } from '@rocket.chat/
 import { IRoom } from '@rocket.chat/apps-engine/definition/rooms';
 import { createSign } from 'crypto';
 import { AppSetting } from '../config/Settings';
-import { DialogflowJWT, DialogflowUrl, IDialogflowAccessToken, IDialogflowMessage, IDialogflowQuickReplies, LanguageCode } from '../enum/Dialogflow';
+import { DialogflowJWT, DialogflowRequestType, DialogflowUrl, IDialogflowAccessToken, IDialogflowEvent, IDialogflowMessage, IDialogflowQuickReplies, LanguageCode } from '../enum/Dialogflow';
 import { Headers } from '../enum/Http';
 import { Logs } from '../enum/Logs';
 import { base64urlEncode } from './Helper';
@@ -12,23 +12,29 @@ import { getAppSettingValue } from './Settings';
 
 class DialogflowClass {
     private jwtExpiration: Date;
-    public async sendMessage(http: IHttp,
+    public async sendRequest(http: IHttp,
                              read: IRead,
                              modify: IModify,
                              sessionId: string,
-                             messageText: string): Promise<IDialogflowMessage> {
+                             request: IDialogflowEvent | string,
+                             requestType: DialogflowRequestType): Promise<IDialogflowMessage> {
         const serverURL = await this.getServerURL(read, modify, http, sessionId);
 
+        const queryInput = {
+            ...requestType === DialogflowRequestType.EVENT && { event: request },
+            ...requestType === DialogflowRequestType.MESSAGE && { text: { languageCode: LanguageCode.EN, text: request } },
+        };
+
         const httpRequestContent: IHttpRequest = createHttpRequest(
             { 'Content-Type': Headers.CONTENT_TYPE_JSON, 'Accept': Headers.ACCEPT_JSON },
-            { queryInput: { text: { languageCode: LanguageCode.EN, text: messageText } } },
+            { queryInput },
         );
 
         try {
             const response = await http.post(serverURL, httpRequestContent);
             return this.parseRequest(response.data);
         } catch (error) {
-            throw new Error(Logs.HTTP_REQUEST_ERROR);
+            throw new Error(`${ Logs.HTTP_REQUEST_ERROR }`);
         }
     }