Aurora — это телеграм-бот для организации Random Coffee встреч, оснащённый модулями техподдержки, сбора статистики, рассылки сообщений и алгоритмом сопоставления анкет на базе Apache Lucene.
- Aurora
Для корректной работы Aurora вам понадобятся следующие компоненты:
Перед запуском приложения необходимо указать настройки в файле application.properties, который должен находиться в корневом каталоге проекта. Пример содержания файла:
# Database Configuration
spring.datasource.url=jdbc:postgresql://localhost:5432/YOUR_DB_NAME
spring.datasource.username=YOUR_DB_USERNAME
spring.datasource.password=YOUR_DB_PASSWORD
# Logging Configuration
logging.level.root=INFO
# Telegram API Configuration
telegram.bot.name=YOUR_BOT_NAME
telegram.bot.token=YOUR_BOT_TOKEN
# Special User ID
special.user.id=YOUR_SPECIAL_USER_IDЗамените YOUR_DB_NAME, YOUR_DB_USERNAME, YOUR_DB_PASSWORD, YOUR_BOT_NAME, YOUR_BOT_TOKEN, YOUR_SPECIAL_USER_ID на соответствующие значения. Переменная special.user.id должна содержать ID пользователя, который будет добавлен в выборку при нечётном количестве анкет, чтобы количество всегда было чётным и у всех была пара.
Конфигурационный файл application.properties обеспечивает настройку приложения с использованием указанных значений.
Для запуска проекта выполните следующие шаги:
-
Склонируйте репозиторий:
git clone https://github.com/Daniil-Tiunchyk/Aurora-Telegram-Bot cd aurora-telegram-bot -
Установите зависимости и соберите проект:
mvn clean install
-
Запустите приложение:
mvn spring-boot:run
Для удобства развертывания проект также включает Dockerfile. Убедитесь, что вы настроили переменные среды в application.properties перед созданием Docker-образа.
-
Постройте Docker-образ:
docker build -t aurora-telegram-bot . -
Запустите контейнер:
docker run -d aurora-telegram-bot
Команды пользователя:
/start: Инициализация работы с ботом и начало взаимодействия./profile: Просмотр текущей анкеты пользователем./help: Получение справочной информации о функционале бота и доступных командах./support: Отправка запроса в техническую поддержку.
Команды администратора:
/admin: Отображение всех доступных команд с кратким описанием./list_admins: Получение списка администраторов./promote: Повышение пользователя до администратора./match: Ручной запуск процесса подбора профилей пользователей./profile_stats: Просмотр статистики профилей за последние 7 дней./broadcast: Отправить сообщение всем пользователям.
Стандартное время срабатывания автоматических скриптов в Aurora:
- Подбор пользователей для Random Coffee: Каждый понедельник в 11:00.
- Ежедневная рассылка сообщений пользователям(при наличии): Ежедневно в 18:00.
- Сбор статистики использования бота: Ежедневно в 18:00.
- Отчёт по заявкам в поддержку для администраторов: Ежедневно в 19:00.
Aurora использует четыре ключевых скрипта, работающих по расписанию, для автоматизации задач:
Скрипт ProfileMatchingTask.java отвечает за подбор пользователей на основе их анкет. Алгоритм:
- Извлечение анкет из базы данных.
- Векторизация анкет с использованием Apache Lucene.
- Сравнение векторов и сортировка анкет.
- Сопоставление пользователей с наибольшим совпадением интересов.
- Случайное распределение оставшихся анкет.
- Соединение оставшейся анкеты с администратором, если количество анкет нечётное.
Скрипт DailyMessageTask.java ежедневно отправляет сообщения всем пользователям. Алгоритм:
- Заранее подготовленные сообщения помещаются в таблицу
DailyMessage. - В заданное время скрипт проверяет наличие неотправленных сообщений.
- Рассылка сообщений всем пользователям.
Скрипт ProfileStatisticsTask.java собирает ежедневную статистику использования бота. Алгоритм:
- Подсчёт общего количества пользователей.
- Подсчёт количества анкет в базе данных.
- Сохранение собранных данных для анализа.
Скрипт DailySupportRequestReportTask.java ежедневно отправляет отчёт по заявкам в техническую поддержку всем администраторам. Алгоритм:
- Подсчёт количества открытых заявок (
OPEN). - Подсчёт количества заявок в работе (
IN_PROGRESS). - Формирование и отправка отчёта всем администраторам через Telegram.
aurora-telegram-bot/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── org/
│ │ │ └── example/
│ │ │ ├── callbacks/
│ │ │ │ ├── AcceptedCallbackHandler.java
│ │ │ │ ├── StartCallbackHandler.java
│ │ │ │ └── ToggleVisibilityCallbackHandler.java
│ │ │ ├── commands/
│ │ │ │ ├── AdminCommand.java
│ │ │ │ ├── AdminsListCommand.java
│ │ │ │ ├── HelpCommand.java
│ │ │ │ ├── MatchCommand.java
│ │ │ │ ├── ProfileCommand.java
│ │ │ │ ├── PromoteCommand.java
│ │ │ │ ├── StartCommand.java
│ │ │ │ └── SupportCommand.java
│ │ │ ├── dialogs/
│ │ │ │ ├── ProfileDialogHandler.java
│ │ │ │ ├── PromoteUserDialogHandler.java
│ │ │ │ └── SupportDialogHandler.java
│ │ │ ├── enums/
│ │ │ │ └── DialogMode.java
│ │ │ ├── interfaces/
│ │ │ │ ├── BotCommandHandler.java
│ │ │ │ ├── CallbackQueryHandler.java
│ │ │ │ └── DialogHandler.java
│ │ │ ├── models/
│ │ │ │ ├── SupportRequest.java
│ │ │ │ └── UserInfo.java
│ │ │ ├── modules/
│ │ │ │ ├── dailly_support_requests/
│ │ │ │ │ └── DailySupportRequestReportTask.java
│ │ │ │ ├── profile_matching/
│ │ │ │ │ ├── ProfileMatchingResult.java
│ │ │ │ │ ├── ProfileMatchingResultRepository.java
│ │ │ │ │ ├── ProfileMatchingResultService.java
│ │ │ │ │ ├── ProfileMatchingTask.java
│ │ │ │ │ └── TextSimilarity.java
│ │ │ │ ├── regular_messages/
│ │ │ │ │ ├── DailyMessage.java
│ │ │ │ │ ├── DailyMessageRepository.java
│ │ │ │ │ ├── DailyMessageService.java
│ │ │ │ │ └── DailyMessageTask.java
│ │ │ │ ├── statistics/
│ │ │ │ │ ├── ProfileStatistics.java
│ │ │ │ │ ├── ProfileStatisticsRepository.java
│ │ │ │ │ ├── ProfileStatisticsService.java
│ │ │ │ │ └── ProfileStatisticsTask.java
│ │ │ ├── repositories/
│ │ │ │ ├── SupportRequestRepository.java
│ │ │ │ └── UserInfoRepository.java
│ │ │ ├── services/
│ │ │ │ ├── SupportRequestService.java
│ │ │ │ └── UserInfoService.java
│ │ │ ├── AuroraApplication.java
│ │ │ ├── AuroraBot.java
│ │ │ └── MultiSessionTelegramBot.java
│ │ ├── resources/
│ │ │ ├── images/
│ │ │ │ └── name.jpg
│ │ │ ├── messages/
│ │ │ │ ├── help.txt
│ │ │ │ ├── info.txt
│ │ │ │ └── start.txt
│ │ │ └── application.properties
└── pom.xml
Проект включает в себя настройку CI, которая находится в файле Aurora-Telegram-Bot/.github/workflows/java-ci.yml. Этот файл конфигурирует автоматические проверки и сборку проекта с использованием GitHub Actions.
Этот проект распространяется под лицензией Apache License 2.0. Подробности можно найти в файле LICENSE.
- Telegram: https://t.me/yet_another_name
- LinkedIn: https://www.linkedin.com/in/daniil-tiunchyk/
- Gmail: fcad.td@gmail.com