tg-bot-user by "Code Without us" team™

.dockerignore

@@ -0,0 +1,4 @@
+.git
+.idea
+.mvn
+Dockerfile

.env

@@ -0,0 +1,2 @@
+BOT_USER_NAME=GroupControlSkillboxBot
+BOT_TOKEN=5566628073:AAHyZTYOh62Fb7_zVGNmHMqzwJUQtBvGWuc

.gitignore

@@ -0,0 +1,33 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.1/apache-maven-3.8.1-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

Dockerfile

@@ -0,0 +1,4 @@
+FROM openjdk:17-alpine
+COPY target/tg-bot-users-0.0.1-SNAPSHOT.jar tg-bot-users.jar
+COPY application-bot.yml .
+CMD java -jar tg-bot-users.jar

README.md

@@ -1 +1,138 @@
 # tg-bot-users 🤖
+
+---
+## Общие сведения
+Приложение является телеграм ботом
+
+
+Основные функции:
+  * Бот отслеживает вступление в группу новых пользователей.
+  * В случае юбилейного вступления пользователя, присылает уведомление в группу модераторов для принятия решения о поздравлении.
+    * При нажатии кнопки "Поздравить" приходит автоматическое поздравление вступившего пользователя.
+    * При нажатии кнопки "Отклонить" поздравления не происходит.
+
+
+Дополнительные функции:
+  * Помимо самого юбилейного вступления, отслеживается несколько последующих - для ситуаций, если юбилейным оказался бот или модератор. Уведомление присылается на каждое подобное вступление, если решение о поздравлении ещё не было принято.
+  * Модератор может запросить у бота список всех юбилейных вступлений. Если в юбилейном списке есть ожидающие поздравления, то модератор может принять решение, пользуясь полученным списком. При этом раннее отклоненные решения могут быть изменены. 
+
+
+Менять настройки групп могут только администраторы.
+
+---
+## Запуск
+Проект настроен так, чтобы администратору приходилось выполнять минимум действий, поэтому сконфигурированное приложение запускается лишь парой команд. Нет необходимости настраивать базу данных, так как она запускается в docker-контейнере рядом с контейнером приложения. И так для запуска приложения вам потребуется выполнить следующие действия:
+
+Все команды выполняются в терминале в корне проекта!
+* Сделать клонирование репозитория командой `git clone {адрес репозитория}`
+* Настроить соответствующие файлы конфигураций:
+    * .env - установить следующие значения:
+        * `BOT_USER_NAME` - Имя бота
+        * `BOT_TOKEN` - Токен бота (необходимо создать нового бота по [инструкции](https://core.telegram.org/bots#3-how-do-i-create-a-bot))
+        * `DATASOURCE_DB` - Название базы данных (опционально)
+        * `DATASOURCE_URL` - url базы данных со слэшом в конце "/" (опционально)
+        * `DATASOURCE_USER` - Имя пользователя базы данных (опционально)
+        * `DATASOURCE_PASS` - Пароль пользователя базы данных (опционально)
+    * application-bot.yml - установить значения для начальной настройки администраторов, чатов пользователей и модераторов и т.д.
+* С помощью Maven собрать проект командой `mvn clean package`
+* Установить и запустить Docker, затем выполнить команду `docker-compose up` или `docker-compose up -d` (для запуска в фоновом режиме)
+
+---
+## Команды бота
+
+### Команды администраторов
+_Доступны администраторам в приватном чате_
+
+| Команда                            | Описание                                                |
+|------------------------------------|---------------------------------------------------------|
+| /help                              | вывод списка доступных команд                           |
+| /currentSettings                   | вывод текущих настроек чатов                            |
+| /addModerChat {id}                 | добавление чата модераторов                             |
+| /addUserChat {id}                  | добавление чата пользователей                           |
+| /deleteModerChat {id}              | удаление чата модераторов                               |
+| /deleteUserChat {id}               | удаление чата пользователей                             |
+| /bindUserChatToModer {id} {id}     | привязка чата пользователей к чату модераторов          |
+| /unbindUserChatFromModer {id} {id} | удаление привязки чата пользователей к чату модераторов |
+
+
+### Команды модераторов
+_Доступны в чатах модераторов_
+
+| Команда             | Описание                                                                        |
+|---------------------|---------------------------------------------------------------------------------|
+| /luckyList          | вывод списка юбилейных вступлений во всех привязанных чатах пользователей       |
+| /luckyList {id}     | вывод списка юбилейных вступлений в конкретном чате                             |
+| /chooseLucky        | вывод списка **ожидающих поздравления** во всех привязанных чатах пользователей |
+| /chooseLucky {id}   | вывод списка **ожидающих поздравления** в конкретном чате                       |
+
+
+---
+## Web API
+На всякий случай для бота сделан небольшой API.<br/>По умолчанию используется порт 8080.
+
+| Endpoint         | Описание                                                                                        |
+|------------------|-------------------------------------------------------------------------------------------------|
+| /api/start       | Ручной старт бота                                                                               |
+| /api/stop        | Ручная остановка бота                                                                           |
+| /api/status      | Текущий статус бота                                                                             |
+| /api/sendMessage | Отправка сообщения от бота<br/> `chatId` ID чата, куда отправить<br/> `message` текст сообщения |
+
+
+---
+## Настройки приложения
+
+Конфигурационные файлы приложения разделены на две части:
+### Настройки для администраторов _(application.yml)_:
+  * Spring
+  * Database _(environment vars)_
+  * Bot token _(environment vars)_
+
+
+### Настройки функций бота _(application-bot.yml)_:
+Настройки групп в приоритете берутся из базы данных. Из файла конфигурации эти настройки подтягиваются только в случае отсутствия таковых в БД, либо если включен флаг перезаписи настроек.
+
+  * Настройки для чатов `chats-settings`:
+    * `administrators` - список ID администраторов
+    * `anniversary-numbers` - список юбилейных номеров
+    * `anniversary-numbers-delta` - количество дополнительно отслеживаемых вступлений
+    * `chats-settings` - настройки групп. Настройки прописываются иерархически: к каждому ID группы модераторов прописывается список ID групп пользователей.
+    * `rewrite-chats-settings-in-database-on-startup` - перезапись настроек групп в базе данных на настройки из конфигурационного файла.
+
+
+  * Настройки шаблонов `message-templates`:
+    * `variables` - названия переменных шаблонов
+    * `plugs` - дополнительные моменты
+    * `join-congratulation` - шаблон сообщения поздравления пользователя
+    * `join-alert` - шаблон уведомления модераторов о юбилейном вступлении пользователя
+    * `join-user-info` - шаблон данных пользователя при использовании команды `/luckyList`
+
+
+---
+## Примеры сообщений
+
+Уведомление модераторов
+
+    🎉 “Java разработчик” 👤 Василий (ника нет),
+    🔢 500 🕐 26.06.22 10:56
+    [ПОЗДРАВИТЬ] [ОТКЛОНИТЬ]
+
+Поздравление пользователя
+
+    🎉 Поздравляю, Никита,
+    как же удачно попали в нужное время и в нужное время!
+    Вы 500 участник коммьюнити.
+    Вас ждут плюшки и печенюшки!🎉
+
+Вывод списка счастливчиков
+
+    ==================================================
+    Группа: “Java разработчик”
+    ==================================================
+    👑👑👑 👤Василий (ника нет),
+    🔢 500 🕐 20.07.22 22:00
+
+    👤GroupSkillboxBot (GroupSkillboxBot),
+    🔢 501 🕐 20.07.22 23:06
+
+    👑👑👑 👤Никита (nikita),
+    🔢 1000 🕐 22.07.22 01:00

application-bot.yml

@@ -0,0 +1,36 @@
+chats-settings:
+    administrators:
+        - 1039061325    # pavel
+        - 161855902     # max
+        - 1004758635    # alex
+    anniversary-numbers-delta: 3
+    anniversary-numbers:
+        - 5
+        - 50
+        - 100
+        - 500
+        - 777
+        - 1000
+        - 5000
+        - 10000
+    chats-settings:
+        -1001523814996: #Хакатон и телеграм бот (Skillbox)
+            - -1001523814996 # Хакатон и телеграм бот (Skillbox)
+            - -1001781082670 # Java-диплом с нуля (Skillbox)
+
+    rewrite-chats-settings-in-database-on-startup: false
+
+message-templates:
+    variables:
+        chat-name: "{НазваниеГруппы}"
+        user-name: "{ИмяУчастника}"
+        user-nickname: "{НикУчастника}"
+        join-date: "{ВремяВступления}"
+        join-number: "{НомерВступления}"
+    plugs:
+        no-nick: "ника нет"
+        winner-crown: "👑👑👑"
+        join-date-format: "dd.MM.yy HH:mm"
+    join-congratulation: "🎉 Поздравляю, *{ИмяУчастника}*, как же удачно попали в нужное время и в нужное время!\nВы *{НомерВступления}* участник коммьюнити.\nВас ждут плюшки и печенюшки!🎉"
+    join-alert: " 🎉 В *{НазваниеГруппы}* группу вступил юбилейный пользователь\n{ИмяУчастника} (*{НикУчастника}*),\n 🔢 *{НомерВступления}* 🕐 {ВремяВступления}"
+    join-user-info: " 👤{ИмяУчастника} ({НикУчастника}),\n 🔢 *{НомерВступления}* 🕐 {ВремяВступления}"

docker-compose.yml

@@ -0,0 +1,31 @@
+version: "3.9"
+services:
+    postgres:
+        container_name: postgres
+        image: postgres:alpine
+        restart: always
+        ports:
+            - "5431:5432"
+        environment:
+            POSTGRES_DB: ${DATASOURCE_DB:-tg-bot-users}
+            POSTGRES_USER: ${DATASOURCE_USER:-tg-admin}
+            POSTGRES_PASSWORD: ${DATASOURCE_PASS:-postgres}
+        volumes:
+            - C:\docker\postgres:/var/lib/postgres
+    tg-bot-users:
+        container_name: tg-bot-users
+        image: tg-bot-users
+        restart: always
+        build:
+            context: .
+        ports:
+            - "8080:8080"
+        environment:
+            BOT_USER_NAME: ${BOT_USER_NAME}
+            BOT_TOKEN: ${BOT_TOKEN}
+            DATASOURCE_URL: ${DATASOURCE_URL:-jdbc:postgresql://host.docker.internal:5431/}${DATASOURCE_DB:-tg-bot-users}
+            DATASOURCE_USER: ${DATASOURCE_USER:-tg-admin}
+            DATASOURCE_PASS: ${DATASOURCE_PASS:-postgres}
+        depends_on:
+            postgres:
+                condition: service_started