alordash/botsmartscheduler

Enhance your planning capabilities with this smart bot!

t.me/SmartScheduler_bot

• English description

Бот понимает русскую и англоязычную речь

Если вам нужно быстро и с удобством планировать свои задачи, бот Smart Scheduler станет незаменимым инструментом в этом деле.

Как использовать

Бот Smart Scheduler работает в Telegram.
Просто напишите задачу и требуемое время, а Smart Scheduler автоматически найдет дату и задачу в сообщении.
По истечению времени запланированной задачи бот Smart Scheduler пришлет вам уведомление.

Особенности

Данный бот распознает большинство форм представления даты человеком (например «через X минут», «в без пятнадцати десять», «послезавтра пол первого»), поэтому вам не нужно следовать определенному формату времени.
Также не обязательно писать слова «абсолютно» точно. Бот способен понять что вы имели ввиду даже в словах с ошибками (например «чрез читыре нидели» -> «через 4 недели»).
Вы можете создавать сразу несколько напоминаний в одном сообщении, разделяя каждое с помощью точки, запятой или союза "и".

Smart Scheduler способен записывать время с точностью до минуты.
Smart Scheduler может формировать напоминания из голосовых сообщений.
Smart Scheduler поддерживает повторяющиеся напоминания («каждые 5 минут»), а также поддерживает ограничение для них («каждые 5 минут до 20 часов»).
Smart Scheduler поддерживает картинки, видео или файлы 💾 в напоминаниях.
Smart Scheduler хранит для каждого чата задачи раздельно и может функционировать в беседах.

Smart Scheduler может быть интегрирован в Вашу Trello доску!
Подробнее: Руководство по работе с Trello

Поддерживаемые комманды:

• 🗓 /list - Показывает активные задачи для данного чата.

• 🗑 /del 1, 2, ...N - Удаляет задачи по id.

• 🗑 /del 1-10, A-B - Удаляет задачи в введенном диапазоне.

• #️⃣ /N - Удаляет N-ную задачу.

• 🌐 /tz - Настройка часового пояса.

и, конечно же, /start и /help.

Установка

Для работы бота требуется база данных PostgreSQL.

Переменные среды

Прежде чем запускать бота, убедитесь что вы установили следующие переменные среды:

1. ENABLE_LOGS: "true" или "false", включает или отключает логирование.
2. ENABLE_SCHEDULES_CHEKING: "true" или "false", включает или отключает проверку и отправление уведомлений.
3. TZ: только "GMT".
4. DATABASE_URL (опционально): URL базы данных PostgreSQL.
5. SMART_SCHEDULER_DB_URL (опционально): URL базы данных PostreSQL.
6. IS_HEROKU: "true" или "false". Если true, то для базы данных используется DATABASE_URL, иначе SMART_SCHEDULER_DB_URL.
7. SMART_SCHEDULER_TLGRM_API_TOKEN: токен бота в телеграмме.

Для дебага (опционально):

8. SMART_SCHEDULER_ADMIN": telegram-id пользователя-администратора бота
9. SMART_SCHEDULER_DEBUG_MODE: "true" или "false". При включении бот проверяет только те напоминания, которые были созданные пользователем SMART_SCHEDULER_ADMIN.

Для определения часового пояса по геолокации (опционально):

10. SMART_SCHEDULER_GOOGLE_API_KEY: api-ключ для сервисов Google.

Для обработки голосовых сообщений (опционально):

11. YC_API_KEY: Yandex api key.
12. YC_FOLDER_ID: Yandex catalog id.

Для интеграции с Trello (опционально):

13. TRELLO_TOKEN: Trello api token.

На локальном сервере

$ git clone https://github.com/alordash/BotSmartScheduler
$ cd BotSmartScheduler
$ npm install
$ node ./BotCode/index.js

Используя heroku

1. Создайте аккаунт github.
2. Добавьте этот репозиторий к себе.
3. Создайте аккаунт heroku.
4. Создайте новое heroku приложение.
5. Откройте новое приложение.
6. Перейдите по этой ссылке.
7. Нажмите Install Heroku Postgres.
8. В появившейся строке введите название своего приложения и нажмите Provision add-on.
9. Перейдите во вкладку Settings своего приложения.
10. Нажмите Reveal Config Vars.
11. Заполните все необходимые переменные среды.
12. Перейдите во вкладку Deploy.
13. В поле Deployment method выберите GitHub.
14. Подключите свой github аккаунт к хероку нажав Connect to GitHub.
15. В появившемся окне выберите ваш репозиторий, нажмите connect.
16. Нажмите Deploy Branch.
17. После окончания загрузки перейдите во вкладку Resources.
18. Отключите web, включите worker.
    Ваш бот готов к работе.

botsmartscheduler's Issues

Code refactoring: string concatenation

Replace all string concatenation with string assignment to new formatted string.

Fix "List of schedules" button

It shouldn't disappear and reappear when it's pressed.

Google calendar integration

Add ability to transfer schedules that are made with bot to user's google account.

Add support for attachments

The title is clear.

Планируется выложить dateParser.js как отдельную npm библиотеку?

Ignore schedules without determined hours or minutes in groups

The title is clear.

Remove schedule confirmation if bot has been mentioned in message

The title is clear.

Remove max_date if target_date is expired

Set max_date to 0 if target_date already expired.

New user-bot interface

Currently every utility action with bot (e.g. show list, remove schedules) is performed by sending new messages by bot.
Would be better to realize utility actions via mark-up buttons with just one message being edited after every action from user.

Change tz determination "cancel" button reply text

It should write someting like "Time zone is not specified." if it's actually not specified (check in db), otherwise simply "Cancelled"

Add displaying of new schedules id

Display in message id of new schedule.

Change message that is sent on /start

String which says that this bot is open source should be Italic and at bottom.
After ~15-20 seconds (average amount of time required to read start message) send another message that will ask user for specifying time zone.

Add schedule text corruption for better security

The title is clear.

Remove keyboard in group chats

Remove "Show list" button and the whole keyboard in group chats.

Code refactoring: remove useless requires

Check all .js files and remove useless requires.

Language determination fix

Do not change user language if number of cyrillic symbols is the same as number of latin symbols.

Remove useless awaits

Remove useless awaits when sending message or performing other action with telegram api.

Single letter bug

Single letter becomes capital in schedule's text.
Test: "тест в foo. тест 18:30"
('в' becomes capital)

Big messages splitting

Implement big message splitting algorithm from botActions.LoadSchedulesList to every place where ctx.reply(%SOME_LIST_OF_SOMETHING%) is used.

DB expansion

Move pendingSchedules and tzPendingConfirmationUsers arrays to DB.

Write day of week in schedule's description

In formatting.FormStringFormatSchedule() make so that near schedule's HH:MM will be written day of week in brackets, if there are less than 7 days untill that schedule.

Incorrect processing of "через полчаса" ("in half an hour", rus) / Некорректно обрабатывается "через полчаса"

If you type "Оповестить о чем-либо через полчаса" bot does not recognize "через полчаса" ("in half an hour", rus) as indication of time and assigns the reminder for 19 hours from the current time with the text "Оповестить о чем-либо через полчаса" (as is).

Если напечатать "Оповестить о чем-либо через полчаса" бот не распознает "через полчаса" как указание времени, и назначит напоминалку на момент через 19 часов от текущего времени с текстом "Оповестить о чем-либо через полчаса".

P.s.
Timezone: GMT +05:00;
Screenshot: https://yadi.sk/i/CpZaeBwATOvhZA

Bug with "tommorow"

"Tommorow" shouldn't define remind's hours metric. This word triggers bot in group chats even without hours definition in original message.

Add ability to define schedule's time

Add ability to define schedule's time in next message if user hasn't determined time in the original message.

Disable notifications

Disable notifications for all messages except reminds execution.

Voice messages unique cases

Add support for parse cases with low prevalence (>20) if they're acquired from voice message.

Добавить лицензию

Каждому проекту рекомендуется иметь лицензию, чтобы люди знали, можно ли копировать и распространять код. Я советую воспользоваться choosealicense при выборе лицензии.

Add schedule confirmation button to group chats

In group chat under each schedule must be 2 buttons: Accept or Decline schedule.
Accept button stores schedule.
Decline button deletes message and ignores schedule.

Schedule's text fix

Schedule's text must contain not modified by parse-word-to-number lib words.

New date format cases

Add support for following cases:
"3 ч 20 м" = 3 hours 20 minutes
"3ч 20м" = 3 hours 20 minutes

Display list button only if user has schedules

The title is clear.

English support

Add support for time defined in english.
Need more examples of time definition cases in english.

Hours requiring

Add "require hour definition" message when something scheduled without hours.

Rewrite date parser

Rewrite dateParser.js using visitor pattern.

"Snooze" mechanic

Add button under expired schedule to repeat this schedule after 5 minutes.

Integration with Trello

1. Add ability for user to share access to his Trello boards (TBoard) via bot.
2. Add ability for user to bind particular TBoard to selected chat.
3. Chat is selected by sending some command in it.
4. After binding TBoard to chat, bot will duplicate schedules to the binded TBoard.
   Behaviour settings
5. Enable/disable schedules duplication to TBoard.
6. Allow/disallow to delete cards from trello board via bot.
   Extra markup buttons
7. If user has binded some TBoard to the chat where he is creating schedules, then add under these schedules button "Send to Trello".

Shorten reply

Make repeat remind reply shorter (e.g. "Напоминание установлено на " => "Повтор: ")

Remove Timezone button

The title is clear.

Delete repeat schedules if user has blocked bot

Delete repeationg reminds if user has blocked bot.

Change time zone warnings showing

Show to newly added users TZ warnings only after ~5 messages from user.

Инструкция по запуску

Было бы не плохо получить FAQ по запуску, интуитивно из кода понятно, но если хочется все на своем сервере запустить?

Удобное удаление повторяющихся напоминаний

При отправлении повторного напоминания выводить также его id через /${id} внутри текста сообщения, чтобы его можно было удалить на лету.

Add realtive time aliases

Add to settings ability to define user's relative time aliases (e.g. "morning", "evening") and ability to use them.

New timezone determination option

Add ability to determine user's timezone by sending his town's name.

Disable forwarded messages parsing

The title is clear.

Add periodic type of schedules

Add schedules that won't delete after first expiring, but will be re-scheduled after XXX time.
Consider these cases:
"Каждый четверг в 12:00 ..."
"По будням в 12:00 ..."
"Каждые 2 часа 30 минут с 5 утра до 6 вечера ..."
"Каждый понедельник, среду и пятницу в 12:00 ..."
"Каждое 12-ое число в 12:00 ..."
"Каждого 1-ого января в 12:00 ..."

Refresh boards lists

Add command to refresh list of user's Trello boards.

Move "Repeat remind" button timer to DB

Instead of calling js setTimeout in checkExpiredSchedules add new message's id to the new db table.
In the one minute timer bot should also check this new messages from new db table and remove "Repeat remind" button in them.

Fix "Repeat schedule" button deleting timer

The title is clear.

Remove schedules indexing

Remove first level schedules indexing when multiple tasks are scheduled from one message.