https://github.com/uriid1/tnt-tg-bot
Lua/Tarantool library for the telegram bot api
https://github.com/uriid1/tnt-tg-bot
api bot lua tarantool telegram telegram-bot telegram-bot-api
Last synced: 10 months ago
JSON representation
Lua/Tarantool library for the telegram bot api
- Host: GitHub
- URL: https://github.com/uriid1/tnt-tg-bot
- Owner: uriid1
- License: mit
- Created: 2023-02-24T22:57:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-06-01T18:17:01.000Z (about 1 year ago)
- Last Synced: 2025-06-02T04:43:59.616Z (about 1 year ago)
- Topics: api, bot, lua, tarantool, telegram, telegram-bot, telegram-bot-api
- Language: Lua
- Homepage:
- Size: 554 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Russian | [English](README_EN.md)
[](https://github.com/uriid1/tnt-tg-bot/actions/workflows/luacheck.yml)
[](LICENSE)
## Описание
tnt-tg-bot - это библиотека, написанная на Lua для платформы Tarantool, которая предоставляет минималистичный интерфейс для работы с Telegram Bot API.
## Особенности
+ Практически полная поддержка Telegram Bot API
+ Простой интерфейс
+ Асинхронная обработка запросов
+ Встроенная поддержка работы с платежами в Telegram Stars
+ Встроенные методы для простой обработки команд, в том числе callback
+ Вы сами даёте названия событиям, из коробки у вас только - `bot.events.onGetUpdate(ctx)`
+ Простая работа с Web App (в будущем будет пример)
+ Базовая поддержка LDoc
+ Больше 10-ти примеров и они будут пополняться
+ Легкая интеграция с Tarantool
Из-за простой и понятной архитектуры, отсутствующий функционал добавлять несложно.
## Установка
### Автоматическая
1. Установите `git`, `curl`, `lua 5.1` и `luarocks`.
2. (опционально) если нужна работа с Web App:
Потребуется установить rock пакет `luaossl`, для него в вашем дистрибутиве -
установите заголовочные файлы для `lua 5.1` и `openssl`.
2. Установите [tarantool](https://www.tarantool.io/ru/download/os-installation)
3. Выполните скрипт автоматической установки необходимых пакетов
```bash
bash tnt-tg-bot.pre-build.sh
```
5. В случае проблем, перейти к ручной установки.
> [!NOTE]
> Для успешной сборки `luaossl` - биндинга к OpenSSL, потребуются заголовочные файлы OpenSSL и Lua 5.1.
> В Ubuntu можно установить, выполнив `sudo apt install libssl-dev liblua5.1-0-dev`.
> `luaossl` нужен для работы модуля `bot/libs/parseInitData.lua`, модуль нужен для обработки данных веб Mini App.
> https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app
### Ручная
1. Установите `git`, `curl`, `lua 5.1` и `luarocks`.
2. Установите [tarantool](https://www.tarantool.io/ru/download/os-installation)
3. (опционально) если нужна работа с Web App:
Потребуется установить rock пакет `luaossl`, для него в вашем дистрибутиве -
установите заголовочные файлы для `lua 5.1` и `openssl`.
4. Установка необходимых пакетов с помощью `luarocks`
+ **HTTP клиент/сервер (обязательно)**
```bash
luarocks install --local --tree=$PWD/.rocks --server=https://rocks.tarantool.org/ http
```
+ **Multipart Post обработчик (обязательно)**
```bash
luarocks install --local --tree=$PWD/.rocks --lua-version 5.1 lua-multipart-post 1.0-0
```
+ **Биндинг к openssl (опционально)**
```bash
luarocks install --local --tree=$PWD/.rocks --lua-version 5.1 luaossl
```
## Примеры
+ `examples/echo-bot.lua` - Простой эхо-бот
+ `examples/ping-pong.lua` - Реакция на команду /ping
+ `examples/send-animation.lua` - Отправка gif по команде /get_animation
+ `examples/send-document.lua` - Отправка документа по команде /get_document
+ `examples/send-image.lua` - Отправка изображения по команде /get_image
+ `examples/send-image-2.lua` - Упрощенный пример отправки изображения через `bot.sendImage`
+ `examples/send-media-group.lua` - Отправка группы медиа-файлов
+ `examples/simple-callback.lua` - Пример обработки callback - /send_callback
+ `examples/simple-callback-2.lua` - Упрощенный пример обработки callback команд
+ `examples/simple-process-commands.lua` - Пример простого процессинга команд
+ `examples/routes-example/init.lua` - Пример работы ручек в боте
+ `examples/stars-payment/init.lua` - Пример обработки платежей в звездах
+ `examples/stars-payment/echo-bot-webhook.lua` - Простой эхо бот через webhook
### Запуск примера
`BOT_TOKEN` - токен вашего бота
```bash
BOT_TOKEN="1348551682:AAFK3iZwBqEHwSrPKyi-hKyAtRgUwXrTiWW" tarantool examples/echo-bot.lua
```
## Структура проекта
+ `bot/init.lua` - Точка входа
+ `bot/libs` - Вспомогательные библиотеки
+ `bot/enums` - Инамы
+ `bot/classes` - Классы для объектов телеграмма
+ `bot/middlewares` - Посредники
+ `bot/processes` - Процессы. Пример processCommand - процессинг команд
+ `bot/types` - Модели/валидаторы для типов телеграмма
+ `bot/ext` - Встроенные экстеншины
## Интерфейс библиотеки
| Метод/Свойство | Описание | Пример использования |
|---------------|---------|---------------------|
| bot:cfg | Инициализация настроек | `bot:cfg { token = "123468:foobarBAZ" }` |
| bot.call | Выполнение запроса к Telegram API | `bot.call('sendMessage', {chat_id = 123, text = 'Привет!'})` |
| bot.events | Таблица с пользовательскими событиями | `function bot.events.onPoll(ctx) ... end` |
| bot.events.onGetUpdate | Событие обработки обновлений от Telegram | `function bot.events.onGetUpdate(ctx) ... end` |
| bot.sendImage | Упрощенная отправка картинки | `examples/send-image-2.lua` |
| bot.Command | Минимальный обработчик команд | `bot.Command(ctx)` |
| bot.CallbackCommand | Минимальный обработчик callback команд | `bot.CallbackCommand(ctx)`
| bot:startWebHook | Запуск бота на удаленном сервере | Пример `examples/echo-bot-webhook.lua` |
| bot:startLongPolling | Запуск бота в режиме long polling | Любой пример из `examples/*` |
По наличию аргументов см. ldoc - `doc/index.html`
## Вклад в проект
Через форк репозитория и открытия Pull Request