Russenger - Facebook Messenger Webhook Handling in Rust

Russenger is a Rust library designed to simplify the handling of Facebook Messenger webhook responses. It offers a convenient way to construct and send various types of responses, including text messages, quick replies, generic templates, and media attachments.

Features

Russenger provides the following features:

• Text messages: Send text messages to users.
• Quick replies: Send quick replies with buttons to users.
• Generic templates: Send generic templates with images, titles, and buttons to users.
• Media attachments: Send media attachments such as images, audio, and video to users.
• Webhook verification: Verify incoming webhook requests from Facebook.
• Button: A model to create and manipulate buttons in messages.
• Getstart: A model to handle the "Get Started" button in Messenger.
• PersistenceMenu: A model to handle persistent menus in Messenger.
• Action: A model to handle sender actions like typing indicators.
• Actix-web Integration: Russenger continues to leverage Actix-web for improved speed and performance in handling Messenger webhook responses.

New Features

• SeaORM Integration: sea_orm Russenger now leverages SeaORM for improved database operations.

Old Method with create_action!

use russenger::prelude::*;

create_action!(Main, |res: Res, req: Req| async move {
    let message: String = req.data.get_value();
    if message == "Hello" {
        res.send(TextModel::new(&req.user, "Hello, welcome to our bot!")).await;
    }
});

New Method with #[action]

use russenger::prelude::*;

#[action]
async fn Main(res: Res, req: Req) {
    let message: String = req.data.get_value();
    if message == "Hello" {
        res.send(TextModel::new(&req.user, "Hello, welcome to our bot!")).await;
    }
}

In both examples, we define an action Main that sends a welcome message if the user input is "Hello". The new method using #[action] is more concise and easier to read.

How to Create new Project

• 1: Install Cargo Generate

cargo install cargo-generate

• 2: Generate new project

cargo generate --git https://github.com/j03-dev/russenger_template

How To Use

Example

Here's an example of how to use Russenger to handle different actions in a chatbot:

Russenger Cargo.toml

russenger = "0.1.6"
actix-web = "4"

Environnement .env

# You can change this
PORT=6969
HOST=0.0.0.0

# change this
VERIFY_TOKEN=<your-verify-token>

# change this
PAGE_ACCESS_TOKEN=<your-page-access-token>

#### postgres
# DATABASE=postgres://<user>:<password>@<host>/<db_name>

#### mysql
# DATABASE=mysql://<user>:<password>@<host>/<db_name>

#### sqlite
DATABASE=sqlite:<db_name>

Code src/main.rs

use russenger::prelude::*;

#[action]
async fn Main (res: Res, req: Req) {
    res.send(TextModel::new(&req.user, "Main, I'm your chatbot!"))
        .await;

    let payload_1 = Payload::new(Option1, Some(Data::new("payload_for_option_1", None)));
    let payload_2 = Payload::new(Option2, Some(Data::new("payload_for_option_2", None)));

    let replies = vec![
        QuickReply::new("Option1", "", payload_1),
        QuickReply::new("Option2", "", payload_2),
    ];
    res.send(QuickReplyModel::new(
        &req.user,
        "Choose an option:",
        replies,
    ))
    .await;
}

#[action]
async fn Option1 (res: Res, req: Req) {
    let value: String = req.data.get_value();
    let message = format!("You selected Option 1 with payload: {}", value);
    res.send(TextModel::new(&req.user, &message)).await;
}

#[action]
async fn Option2 (res: Res, req: Req) {
    let value: String = req.data.get_value();
    let message = format!("You selected Option 2 with payload: {}", value);
    res.send(TextModel::new(&req.user, &message)).await;

    let generic_elements = vec![GenericElement::new(
        "Option 2",
        "https://example.com/option2.jpg", // use existe url
        "Option 2 description",
        vec![Button::Postback {
            title: "Choose Option 2".to_string(),
            payload: Payload::new(Main, None),
        }],
    )];

    res.send(GenericModel::new(
        &req.user,
        generic_elements,
        req.data.get_page(),
    ))
    .await;
}

russenger_app!(Main, Option1, Option2);

Who to get User Input

use russenger::prelude::*;

#[action]
async fn Main (res: Res, req: Req) {
    res.send(TextModel::new(&req.user, "Main, I'm your chatbot!"))
        .await;
    res.send(TextModel::new(&req.user, "What is your name: "))
        .await;
    req.query.set_action(&req.user, GetUsername).await;
}

#[action]
async fn GetUsername (res: Res, req: Req){
    let username: String = req.data.get_value();
    res.send(TextModel::new(&req.user, &format!("Hello {}", username)))
        .await;
}

russenger_app!(Main, GetUsername);

How to send file from static

use russenger::prelude::*;

#[action]
async fn Main (res: Res, req: Req) {
    res.send(TextModel::new(&req.user, "Main, I'm your chatbot!"))
        .await;

    // Send Image File from static file
    // Add image file, on static dir
    res.send(MediaModel::new(
        &req.user,
        "image",
        &format!("{host}/image.png", host = req.host),
    ))
    .await;
}
russenger_app!(Main);

Run

Migrate Database run it once

if you use sqlite as Bb

touch <dbname>

cargo run migrate

Runserver

cargo run runserver

In this example, we define three actions: Main, Option1, and Option2. Each action is associated with a function that handles the action. The Main action sends a text message and a quick reply with two options. The Option1 and Option2 actions handle the user's selection of the respective options.

EndPoint

• GET /webhook: Verify your chatbot with Facebook Messenger. Facebook will send a challenge, and your bot must respond correctly for verification.

• POST /webhook: This is where Facebook Messenger sends messages from users. Handle incoming messages and respond accordingly here.