Merge pull request 'v0.1.0' (#46) from dev into main

Reviewed-on: #46

classes/importer/csv.py

@@ -6,7 +6,7 @@ from typing import Any, Dict, List, Union
 from bson import ObjectId
 
 from classes.importer.abstract import Importer
-from modules.database import col_entries
+from modules.database_api import col_entries
 
 
 class ImporterCSV(Importer):

classes/importer/json.py

@@ -5,7 +5,7 @@ from bson import ObjectId
 from ujson import loads
 
 from classes.importer.abstract import Importer
-from modules.database import col_entries
+from modules.database_api import col_entries
 
 
 class ImporterJSON(Importer):

classes/location.py

@@ -6,7 +6,7 @@ from pytz import timezone as pytz_timezone
 from pytz.tzinfo import BaseTzInfo, DstTzInfo
 
 from classes.point import Point
-from modules.database import col_locations
+from modules.database_api import col_locations
 
 
 @dataclass

classes/pyroclient.py

@@ -7,7 +7,7 @@ from pyrogram.types import User
 
 from classes.location import Location
 from classes.pyrouser import PyroUser
-from modules.database import col_locations
+from modules.database_api import col_locations
 from modules.reminder import remind
 
 

config_example.json

@@ -14,7 +14,14 @@
         "password": null,
         "host": "127.0.0.1",
         "port": 27017,
-        "name": "garbagebot"
+        "name": "garbage_bot"
+    },
+    "database_api": {
+        "user": null,
+        "password": null,
+        "host": "127.0.0.1",
+        "port": 27017,
+        "name": "garbage_reminder"
     },
     "search": {
         "radius": 0.1

locale/de.json

@@ -3,10 +3,14 @@
         "flag": "🇩🇪",
         "name": "Deutsch",
         "codes": [
-            "de",
-            "de-DE"
+            "de"
         ]
     },
+    "bot": {
+        "name": "Garbage Reminder",
+        "about": "Nie wieder Müllabfuhrtermin verpassen. Quellcode: https://garbagebot.eu",
+        "description": "Sie können Erinnerungen an die Müllabfuhr für Orte Ihrer Wahl erhalten.\n\nVerwenden Sie /help, um die Funktionsweise des Bots besser zu verstehen, oder verwenden Sie /setup, um Ihre Erinnerungen zu konfigurieren."
+    },
     "formats": {
         "date": "%d.%m.%Y",
         "time": "%H:%M"

locale/en.json

@@ -3,10 +3,14 @@
         "flag": "🇬🇧",
         "name": "English",
         "codes": [
-            "en",
-            "en-GB"
+            "en"
         ]
     },
+    "bot": {
+        "name": "Garbage Reminder",
+        "about": "Never forget about garbage collection again. Source code: https://garbagebot.eu",
+        "description": "You can receive reminders about garbage collection for locations of your choice.\n\nUse /help to better understand how the bot works or use /setup to configure your reminders."
+    },
     "formats": {
         "date": "%d/%m/%Y",
         "time": "%H:%M"

locale/ru.json

@@ -1,16 +1,44 @@
 {
     "metadata": {
-        "codes": [
-            "ru",
-            "ru-RU"
-        ],
         "flag": "🇺🇦",
-        "name": "Російська"
+        "name": "Російська",
+        "codes": [
+            "ru"
+        ]
+    },
+    "bot": {
+        "name": "Garbage Reminder 🇺🇦",
+        "about": "Більше ніколи не забувайте про вивезення сміття. Вихідний код: https://garbagebot.eu",
+        "description": "Ви можете отримувати нагадування про вивезення сміття для обраних вами місць.\n\nВикористовуйте /help, щоб краще зрозуміти, як працює бот, або /setup, щоб налаштувати нагадування."
+    },
+    "formats": {
+        "date": "%d.%m.%Y",
+        "time": "%H:%M"
+    },
+    "garbage_types": {
+        "0": "🟤 Біо",
+        "1": "🟡 Пластик",
+        "2": "🔵 Папір",
+        "3": "⚫️ Загальне",
+        "4": "🟢 Скло",
+        "5": "❓Невизначене"
+    },
+    "commands": {
+        "help": "Показати меню допомоги",
+        "setup": "Обрати місце розташування",
+        "toggle": "Увімкнути/вимкнути сповіщення",
+        "set_time": "Встановити час сповіщень",
+        "set_offset": "Встановити зміщення сповіщень",
+        "upcoming": "Дати збору на наступні 30 днів",
+        "language": "Змінити мову повідомлень бота",
+        "checkout": "Експортувати або видалити дані",
+        "import": "Завантажити з JSON до бази даних",
+        "shutdown": "Вимкнути бота",
+        "remove_commands": "Видалити всі команди"
     },
     "messages": {
-        "cancelled": "Операцію скасовано.",
-        "setup": "⚙️ Почнемо налаштування з пошуку Вашого місцезнаходження.\n\nБудь ласка, виберіть, чи хочете Ви шукати серед найближчих до Вас локацій, чи одразу перейти до пошуку за назвою.\n\nЗверніть увагу, що надіслане Вами місцезнаходження **НЕ** зберігається ніде і використовується лише для пошуку місць поряд в базі даних.",
         "cancel": "Якщо Ви хочете скасувати цю операцію, використовуйте /cancel.",
+        "cancelled": "Операцію скасовано.",
         "checkout_deleted": "🗑️ Ваші дані було видалено. Якщо Ви хочете знову почати користуватися цим ботом, скористайтеся командою /setup. В іншому випадку видаліть/заблокуйте бота і більше не взаємодійте з ним.",
         "checkout_deletion": "Гаразд. Будь ласка, підтвердіть, що Ви хочете видалити свої дані з бота.\n\nНаступні дані будуть видалені:\n• Вибране місце\n• Бажана мова всіх повідомлень\n• Час сповіщень\n• Зсув сповіщень\n\nВикористовуйте клавіатуру, щоб підтвердити й продовжити або /cancel, щоб перервати цю операцію.",
         "checkout": "Це фактично всі дані, які має бот. Будь ласка, використовуйте ці кнопки, щоб вибрати, чи хочете Ви видалити свої дані з бота.",
@@ -38,6 +66,7 @@
         "set_time": "Гаразд. Будь ласка, надішліть бажаний час у форматі ГГ:ХХ.",
         "setup_finished": "✅ Готово! Ваше місцезнаходження тепер **{name}**. Ви будете отримувати сповіщення про вивезення сміття за {offset} д. заздалегідь о {time}.",
         "setup_retry": "ℹ️ Якщо Ви захочете вибрати місце розташування, скористайтеся командою /setup.",
+        "setup": "⚙️ Почнемо налаштування з пошуку Вашого місцезнаходження.\n\nБудь ласка, виберіть, чи хочете Ви шукати серед найближчих до Вас локацій, чи одразу перейти до пошуку за назвою.\n\nЗверніть увагу, що надіслане Вами місцезнаходження **НЕ** зберігається ніде і використовується лише для пошуку місць поряд в базі даних.",
         "start_code_invalid": "🚫 Ви запустили бота за посиланням, що містить локацію, але, схоже, вона не є дійсною. Будь ласка, скористайтеся командою /setup, щоб налаштувати локацію вручну.",
         "start_code": "ℹ️ Ви запустили бота за посиланням, що містить локацію **{name}**.\n\nБудь ласка, підтвердіть, чи хочете Ви використовувати її як свою локацію для сповіщень.",
         "start_configure": "📍 Налаштуймо Вашу локацію. Натисніть кнопку на показаній клавіатурі, щоб почати процес.",
@@ -51,31 +80,6 @@
         "upcoming_empty": "Не знайдено записів про вивезення сміття на найближчі 30 днів для **{name}**",
         "upcoming": "Найближчі вивози сміття:\n\n{entries}"
     },
-    "formats": {
-        "date": "%d.%m.%Y",
-        "time": "%H:%M"
-    },
-    "garbage_types": {
-        "0": "🟤 Біо",
-        "1": "🟡 Пластик",
-        "2": "🔵 Папір",
-        "3": "⚫️ Загальне",
-        "4": "🟢 Скло",
-        "5": "❓Невизначене"
-    },
-    "commands": {
-        "help": "Показати меню допомоги",
-        "setup": "Обрати місце розташування",
-        "toggle": "Увімкнути/вимкнути сповіщення",
-        "set_time": "Встановити час сповіщень",
-        "set_offset": "Встановити зміщення сповіщень",
-        "upcoming": "Дати збору на наступні 30 днів",
-        "language": "Змінити мову повідомлень бота",
-        "checkout": "Експортувати або видалити дані",
-        "import": "Завантажити з JSON до бази даних",
-        "shutdown": "Вимкнути бота",
-        "remove_commands": "Видалити всі команди"
-    },
     "buttons": {
         "delete_confirm": "Я погоджуюсь і хочу продовжити",
         "delete_no": "❌ Ні, я не хочу видаляти їх",

locale/uk.json

@@ -3,10 +3,14 @@
         "flag": "🇺🇦",
         "name": "Українська",
         "codes": [
-            "uk",
-            "uk-UA"
+            "uk"
         ]
     },
+    "bot": {
+        "name": "Garbage Reminder 🇺🇦",
+        "about": "Більше ніколи не забувайте про вивезення сміття. Вихідний код: https://garbagebot.eu",
+        "description": "Ви можете отримувати нагадування про вивезення сміття для обраних вами місць.\n\nВикористовуйте /help, щоб краще зрозуміти, як працює бот, або /setup, щоб налаштувати нагадування."
+    },
     "formats": {
         "date": "%d.%m.%Y",
         "time": "%H:%M"

modules/database.py

@@ -1,4 +1,4 @@
-"""Module that provides all database collections"""
+"""Module that provides bot's database collections."""
 
 from typing import Any, Mapping
 
@@ -24,5 +24,3 @@ db_client = AsyncClient(con_string)
 db: AsyncDatabase = db_client.get_database(name=db_config["name"])
 
 col_users: AsyncCollection = db.get_collection("users")
-col_entries: AsyncCollection = db.get_collection("entries")
-col_locations: AsyncCollection = db.get_collection("locations")

modules/database_api.py

@@ -0,0 +1,29 @@
+"""Module that provides API database collections.
+It's possible to use REST API client instead, but
+using MongoDB directly is MUCH faster this way."""
+
+from typing import Any, Mapping
+
+from async_pymongo import AsyncClient, AsyncCollection, AsyncDatabase
+from libbot.sync import config_get
+
+db_config: Mapping[str, Any] = config_get("database_api")
+
+if db_config["user"] is not None and db_config["password"] is not None:
+    con_string = "mongodb://{0}:{1}@{2}:{3}/{4}".format(
+        db_config["user"],
+        db_config["password"],
+        db_config["host"],
+        db_config["port"],
+        db_config["name"],
+    )
+else:
+    con_string = "mongodb://{0}:{1}/{2}".format(
+        db_config["host"], db_config["port"], db_config["name"]
+    )
+
+db_client = AsyncClient(con_string)
+db: AsyncDatabase = db_client.get_database(name=db_config["name"])
+
+col_entries: AsyncCollection = db.get_collection("entries")
+col_locations: AsyncCollection = db.get_collection("locations")

modules/reminder.py

@@ -7,7 +7,8 @@ from libbot.pyrogram.classes import PyroClient
 from classes.enums import GarbageType
 from classes.location import Location
 from classes.pyrouser import PyroUser
-from modules.database import col_entries, col_users
+from modules.database import col_users
+from modules.database_api import col_entries
 from modules.utils import from_utc
 
 logger = logging.getLogger(__name__)

modules/search_name.py

@@ -6,7 +6,7 @@ from pyrogram.types import ForceReply, Message, ReplyKeyboardRemove
 
 from classes.location import Location
 from classes.pyroclient import PyroClient
-from modules.database import col_locations
+from modules.database_api import col_locations
 
 
 async def search_name(app: PyroClient, message: Message) -> Union[Location, None]:

modules/search_nearby.py

@@ -6,7 +6,7 @@ from pyrogram.types import Message, ReplyKeyboardRemove
 
 from classes.location import Location
 from classes.pyroclient import PyroClient
-from modules.database import col_locations
+from modules.database_api import col_locations
 from modules.search_name import search_name
 
 

plugins/commands/upcoming.py

@@ -6,7 +6,7 @@ from pyrogram.types import Message
 from classes.garbage_entry import GarbageEntry
 from classes.pyroclient import PyroClient
 from modules import custom_filters
-from modules.database import col_entries
+from modules.database_api import col_entries
 
 
 @PyroClient.on_message(

requirements.txt

@@ -1,11 +1,11 @@
-aiohttp~=3.8.5
-apscheduler~=3.10.3
+aiohttp~=3.9.1
+apscheduler~=3.10.4
 convopyro==0.5
 mongodb-migrations==1.3.0
-pykeyboard==0.1.5
 tgcrypto==1.2.5
 ujson>=5.0.0
 uvloop==0.19.0
 --extra-index-url https://git.end-play.xyz/api/packages/profitroll/pypi/simple
 async_pymongo==0.1.4
-libbot[speed,pyrogram]==2.0.1
+libbot[speed,pyrogram]==3.0.0
+pykeyboard==0.1.7