Merge pull request 'v0.1.3' (#74) from dev into main

Reviewed-on: #74

classes/pyroclient.py

@@ -19,11 +19,11 @@ logger = logging.getLogger(__name__)
 
 class PyroClient(LibPyroClient):
     def __init__(self, **kwargs):
-        self.__version__ = (0, 1, 2)
+        self.__version__ = (0, 1, 3)
 
         super().__init__(**kwargs)
 
-        self.updater = Updater(ClientSession())
+        self.updater = Updater()
         self.contexts = []
 
         if self.scheduler is not None:
@@ -91,6 +91,7 @@ class PyroClient(LibPyroClient):
         ]
 
     async def check_updates(self) -> None:
+        """Check for updates and send a message to the owner if newer version was found"""
         if await self.updater.check_updates(
             self.__version__, self.config["strings"]["url_updater"]
         ):

classes/pyrouser.py

@@ -88,8 +88,7 @@ class PyroUser:
         ### Args:
             * locale (`Union[str, None]`): New locale to be set.
         """
-
+        logger.info("%s's locale has been set to %s", self.id, locale)
-        logger.debug("%s's locale has been set to %s", self.id, locale)
 
         await col_users.update_one({"_id": self._id}, {"$set": {"locale": locale}})
 
@@ -98,7 +97,15 @@ class PyroUser:
         return self.locale
 
     async def update_state(self, enabled: bool = False) -> bool:
-        logger.debug("%s's state has been set to %s", self.id, enabled)
+        """Update user's state (enabled/disabled)
+
+        ### Args:
+            * enabled (`bool`, *optional*): Whether the user is enabled. Defaults to `False`.
+
+        ### Returns:
+            * `bool`: User's current state
+        """
+        logger.info("%s's state has been set to %s", self.id, enabled)
 
         await col_users.update_one({"_id": self._id}, {"$set": {"enabled": enabled}})
 
@@ -106,8 +113,16 @@ class PyroUser:
 
         return self.enabled
 
-    async def update_location(self, location_id: int = 0) -> Location:
+    async def update_location(self, location_id: int) -> Location:
-        logger.debug("%s's location has been set to %s", self.id, location_id)
+        """Update user's location and move their time to the new timezone (if the user had a location set previously)
+
+        ### Args:
+            * location_id (`int`): ID of the location
+
+        ### Returns:
+            `Location`: New location
+        """
+        logger.info("%s's location has been set to %s", self.id, location_id)
 
         await col_users.update_one(
             {"_id": self._id}, {"$set": {"location": location_id}}
@@ -136,7 +151,15 @@ class PyroUser:
         return self.location
 
     async def update_offset(self, offset: int = 1) -> int:
-        logger.debug("%s's offset has been set to %s", self.id, offset)
+        """Update the offset of the reminder (in days)
+
+        ### Args:
+            * offset (`int`, *optional*): Offset in days. Defaults to `1`.
+
+        ### Returns:
+            * `int`: Offset in days
+        """
+        logger.info("%s's offset has been set to %s", self.id, offset)
 
         await col_users.update_one({"_id": self._id}, {"$set": {"offset": offset}})
 
@@ -145,7 +168,16 @@ class PyroUser:
         return offset
 
     async def update_time(self, hour: int = 16, minute: int = 0) -> Tuple[int, int]:
-        logger.debug("%s's time has been set to %s h. %s m.", self.id, hour, minute)
+        """Update the time of the reminder (hour and minute, for UTC timezone)
+
+        ### Args:
+            * hour (`int`, *optional*): Hour of the reminder. Defaults to `16`.
+            * minute (`int`, *optional*): Minute of the reminder. Defaults to `0`.
+
+        ### Returns:
+            * `Tuple[int, int]`: Hour and minute of the reminder
+        """
+        logger.info("%s's time has been set to %s h. %s m.", self.id, hour, minute)
 
         await col_users.update_one(
             {"_id": self._id}, {"$set": {"time_hour": hour, "time_minute": minute}}
@@ -157,16 +189,27 @@ class PyroUser:
         return self.time_hour, self.time_minute
 
     async def delete(self) -> None:
-        logger.debug("%s's data has been deleted", self.id)
+        """Delete the database record of the user"""
+        logger.info("%s's data has been deleted", self.id)
+
         await col_users.delete_one({"_id": self._id})
 
     async def checkout(self) -> Mapping[str, Any]:
-        logger.debug("%s's data has been checked out", self.id)
+        """Checkout the user's database record
+
+        ### Raises:
+            * `KeyError`: Database record of the user was not found
+
+        ### Returns:
+            * `Mapping[str, Any]`: Database record
+        """
+        logger.info("%s's data has been checked out", self.id)
+
         db_entry = await col_users.find_one({"_id": self._id})
 
         if db_entry is None:
             raise KeyError(
-                f"DB record with id {self._id} of user {self.id} is not found"
+                f"DB record with id {self._id} of user {self.id} was not found"
             )
 
         del db_entry["_id"]  # type: ignore

classes/updater.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, Dict, Tuple
+from typing import Any, Dict, Tuple, Union
 
 from aiohttp import ClientSession
 
@@ -7,12 +7,15 @@ logger = logging.getLogger(__name__)
 
 
 class Updater:
-    def __init__(self, client_session: ClientSession) -> None:
+    def __init__(self, client_session: Union[ClientSession, None] = None) -> None:
-        self.client_session: ClientSession = client_session
+        self.client_session: Union[ClientSession, None] = client_session
 
     async def check_updates(
         self, version_current: Tuple[int, int, int], api_url: str
     ) -> bool:
+        if not self.client_session:
+            self.client_session = ClientSession()
+
         response = await self.client_session.get(api_url)
 
         if response.status != 200:
@@ -30,6 +33,9 @@ class Updater:
         )
 
     async def get_latest_release(self, api_url: str) -> Dict[str, Any]:
+        if not self.client_session:
+            self.client_session = ClientSession()
+
         response = await self.client_session.get(api_url)
 
         if response.status != 200:

locale/de.json

@@ -8,7 +8,7 @@
     },
     "bot": {
         "name": "Garbage Reminder",
-        "about": "Nie wieder Müllabfuhrtermin verpassen. Quellcode: https://garbagebot.eu",
+        "about": "Nie wieder Müllabfuhrtermin verpassen. Mehr erfahren: 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": {

locale/en.json

@@ -8,7 +8,7 @@
     },
     "bot": {
         "name": "Garbage Reminder",
-        "about": "Never forget about garbage collection again. Source code: https://garbagebot.eu",
+        "about": "Never forget about garbage collection again. Learn more: 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": {

locale/ru.json

@@ -8,7 +8,7 @@
     },
     "bot": {
         "name": "Garbage Reminder 🇺🇦",
-        "about": "Більше ніколи не забувайте про вивезення сміття. Вихідний код: https://garbagebot.eu",
+        "about": "Більше ніколи не забувайте про вивезення сміття. Дізнатись більше: https://garbagebot.eu",
         "description": "Ви можете отримувати нагадування про вивезення сміття для обраних вами місць.\n\nВикористовуйте /help, щоб краще зрозуміти, як працює бот, або /setup, щоб налаштувати нагадування."
     },
     "formats": {

locale/uk.json

@@ -8,7 +8,7 @@
     },
     "bot": {
         "name": "Garbage Reminder 🇺🇦",
-        "about": "Більше ніколи не забувайте про вивезення сміття. Вихідний код: https://garbagebot.eu",
+        "about": "Більше ніколи не забувайте про вивезення сміття. Дізнатись більше: https://garbagebot.eu",
         "description": "Ви можете отримувати нагадування про вивезення сміття для обраних вами місць.\n\nВикористовуйте /help, щоб краще зрозуміти, як працює бот, або /setup, щоб налаштувати нагадування."
     },
     "formats": {

main.py

@@ -4,6 +4,7 @@ from argparse import ArgumentParser
 from os import getpid
 from pathlib import Path
 
+from aiohttp import ClientSession
 from convopyro import Conversation
 from libbot import sync
 
@@ -41,7 +42,8 @@ def main():
         exit()
 
     client = PyroClient(
-        scheduler=scheduler, commands_source=sync.json_read(Path("commands.json"))
+        scheduler=scheduler,
+        commands_source=sync.json_read(Path("commands.json")),
     )
     Conversation(client)
 

plugins/commands/toggle.py

@@ -13,7 +13,7 @@ async def command_toggle(app: PyroClient, message: Message):
 
     await user.update_state(not user.enabled)
 
-    if user.enabled:
+    if not user.enabled:
         await message.reply_text(
             app._("toggle_disabled", "messages", locale=user.locale)
         )

requirements.txt

@@ -1,12 +1,12 @@
-aiohttp~=3.9.5
+aiohttp~=3.10.2
 apscheduler~=3.10.4
+async_pymongo==0.1.9
 convopyro==0.5
 mongodb-migrations==1.3.1
-pytz<=2023.2
+pytz>=2024.1
 tgcrypto==1.2.5
 ujson>=5.0.0
-uvloop==0.19.0
+uvloop==0.20.0
 --extra-index-url https://git.end-play.xyz/api/packages/profitroll/pypi/simple
-async_pymongo==0.1.4
+libbot[speed,pyrogram]==3.2.3
-libbot[speed,pyrogram]==3.2.2
 pykeyboard==0.1.7