Raccoonjs : Mini-framework for Telegram Bots
Making a telegram bot using Raccoonjs makes it easy for developers to focus on developing features.
One of Raccoonjs's goals is to be able to automatically execute the methods in each feature just by entering the name of the method to be executed in the callback data.
Why use Raccoonjs
- Easy workflow (focus on developing feature).
- Easily set how long a session for a feature over.
- The response format is easy to read, etc.
Quick Start
Create project
$ mdkir app
$ touch app/Task.js
$ touch main.jsInstall racconjs
$ npm i raccoonjs@1.2.0Create Feature
// ./app/Task.js
const { Feature } = require("raccoonjs/Feature");
const { makeButton } = require("raccoonjs/helper");
const { ResponseMessage } = require("raccoonjs/ResponseMessage");
class Task extends Feature {
constructor(onwer) {
super(owner);
}
start() {
const keyboard = [
[
makeButton("Left", {
prefix: this.prefix,
action: "onLeftClicked",
params: "1"
}),
makeButton("Right", {
prefix: this.prefix,
action: "onRightClicked",
params: "2"
})
]
];
return new ResponseMessage("$send", {
owner: this.owner,
message: "Hello, World!",
inline_keyboard: keyboard
});
}
onLeftClicked(params, context) {
console.log(params); // 1
// edit current message
const { reply_markup } = context.message;
return new ResponseMessage("$edit", {
owner: this.owner,
message: "Halo, Dunia!",
inline_keyboard: reply_markup.inline_keyboard
});
}
onRightClicked(params, context) {
console.log(params); // 2
// delete current message and destroy feature session
return new ResponseMessage("$delete", {
owner: this.owner,
destroy: true
});
}
}Generate SSL
$ openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pemCreate Public URL using ngrok
#./ngrok http <port>
$ ./ngrok http 5000
Result:
ngrok by @inconshreveable (Ctrl+C to quit)
Session Status online
Account Jose Sitanggang (Plan: Free)
Version 2.3.35
Region United States (us)
Web Interface http://127.0.0.1:4040
Forwarding http://1234.ngrok.io -> http://localhost:5000
Forwarding https://1234.ngrok.io -> http://localhost:5000
Connections ttl opn rt1 rt5 p50 p90
72 0 0.00 0.00 5.73 45.72Create Environment Variable
$ # e.q export BOT_TOKEN=<TOKEN>
$ export BOT_TOKEN=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
$ # e.q export BASE_URL=<Forwading https>
$ export BASE_URL="https://1234.ngrok.io"Create Main
// main.js
const { Raccoon } = require("raccoonjs/Raccoon");
const { Task } = require("./app/Task");
const R = new Raccoon(process.env.BOT_TOKEN, process.env.BASE_URL);
R.onText(/\/t/, context => {
const { from } = context;
const task = new Task(from.id);
const token = R.registerFeature(from.id, task);
R.start(token, task);
R.deleteMessage(from.id, context.message_id);
});
R.watchFeatureCallback();
R.startServer(
{
port: 5000,
cert: "path/to/cert.pem",
key: "path/to/key.pem"
},
() => console.log("started")
);Result
