refactor: better name convention

schemas/config.json

@@ -32,7 +32,7 @@
             }
           ],
           "default": null,
-          "description": "Ghi chú chủ sở hữu (phù hợp khi dùng notify ai đó)",
+          "description": "Ghi chú chủ sở hữu (phù hợp khi dùng nhắc ai đó với lựa chọn notifications)",
           "examples": [
             "@kevinnitro",
             "dad"
@@ -169,7 +169,7 @@
     },
     "requestTimeout": {
       "default": 10,
-      "description": "Thời gian (s) để gửi request đến server API và gửi message notify",
+      "description": "Thời gian (s) để gửi request đến server API và gửi notify message",
       "title": "Requesttimeout",
       "type": "integer"
     },

src/check_phat_nguoi/config/dto/config.py

@@ -39,7 +39,7 @@ class ConfigDTO(BaseModel):
         frozen=True,
     )
     request_timeout: int = Field(
-        description="Thời gian (s) để gửi request đến server API và gửi message notify",
+        description="Thời gian (s) để gửi request đến server API và gửi notify message",
         default=10,
         frozen=True,
     )

src/check_phat_nguoi/config/dto/notifications/__init__.py

@@ -1,7 +1,7 @@
 from .base_engine import BaseNotificationEngineDTO
-from .base_notify import BaseNotificationDTO
+from .base_notification import BaseNotificationDTO
 from .telegram_engine import TelegramNotificationEngineDTO
-from .telegram_notify import TelegramNotificationDTO
+from .telegram_notification import TelegramNotificationDTO
 
 __all__ = [
     "BaseNotificationEngineDTO",

src/check_phat_nguoi/config/dto/notifications/telegram_engine.py

@@ -1,14 +1,11 @@
 from re import match as re_match
 
-from pydantic import ConfigDict, Field, field_validator
-from pydantic.alias_generators import to_camel
+from pydantic import Field, field_validator
 
 from .base_engine import BaseNotificationEngineDTO
 
 
 class TelegramNotificationEngineDTO(BaseNotificationEngineDTO):
-    model_config = ConfigDict(alias_generator=to_camel)
-
     bot_token: str = Field(
         description="Bot token Telegram",
         examples=["2780473231:weiruAShGUUx4oLOMoUhd0GiREXSZcCq-uB"],

src/check_phat_nguoi/config/dto/notifications/telegram_notify.py → src/check_phat_nguoi/config/dto/notifications/telegram_notification.py

@@ -1,6 +1,6 @@
 from pydantic import Field
 
-from .base_notify import BaseNotificationDTO
+from .base_notification import BaseNotificationDTO
 from .telegram_engine import TelegramNotificationEngineDTO
 
 

src/check_phat_nguoi/config/dto/plate_info.py

@@ -24,7 +24,7 @@ class PlateInfoDTO(BaseModel):
         examples=["60A64685", "98-A-56604", "30-F88251", "59XB-00000"],
     )
     owner: str | None = Field(
-        description="Ghi chú chủ sở hữu (phù hợp khi dùng notify ai đó)",
+        description="Ghi chú chủ sở hữu (phù hợp khi dùng nhắc ai đó với lựa chọn notifications)",
         title="Ghi chú chủ sở hữu",
         examples=["@kevinnitro", "dad"],
         default=None,

src/check_phat_nguoi/notify/engines/telegram.py

@@ -10,7 +10,7 @@
 from check_phat_nguoi.config import TelegramNotificationEngineDTO
 from check_phat_nguoi.constants import SEND_MESSAGE_API_URL_TELEGRAM as API_URL
 
-from ..markdown_msg import MessagesModel
+from ..markdown_message import MessagesModel
 from .base import BaseNotificationEngine
 
 logger = getLogger(__name__)
@@ -53,9 +53,10 @@ async def _send_message(message: str, plate: str) -> None:
             except Exception as e:
                 logger.error(e)
 
+        # TODO: the violation name conventno is not match with param message :v
         tasks = (
-            _send_message(vio_msg, message.plate)
+            _send_message(violation, message.plate)
             for message in messages
-            for vio_msg in message.vio_msgs
+            for violation in message.violations
         )
         await asyncio.gather(*tasks)

src/check_phat_nguoi/notify/markdown_message/__init__.py

@@ -0,0 +1,4 @@
+from .markdown_message import MarkdownMessage
+from .models import *
+
+__all__ = ["MarkdownMessage"]

src/check_phat_nguoi/notify/markdown_msg/md_msg.py → src/check_phat_nguoi/notify/markdown_message/markdown_message.py

@@ -13,7 +13,7 @@
 from .models import MessagesModel
 
 
-class MdMsg:
+class MarkdownMessage:
     def __init__(self, plate_info: PlateInfoModel) -> None:
         self.plate_info: PlateInfoModel = plate_info
 
@@ -56,8 +56,8 @@ def _format_message(self) -> tuple[str, ...]:
             ]
         )
 
-    def generate_msg(self) -> MessagesModel:
+    def generate_message(self) -> MessagesModel:
         return MessagesModel(
             plate=self.plate_info.plate,
-            vio_msgs=self._format_message(),
+            violations=self._format_message(),
         )

src/check_phat_nguoi/notify/markdown_msg/models/message.py → src/check_phat_nguoi/notify/markdown_message/models/message.py

@@ -3,6 +3,6 @@
 
 class MessagesModel(BaseModel):
     plate: str = Field(description="Biển số")
-    vio_msgs: tuple[str, ...] = Field(
+    violations: tuple[str, ...] = Field(
         description="List chứa các string chứa các thông tin cụ thể về lỗi vi phạm sau"
     )

src/check_phat_nguoi/notify/send_notifications.py

@@ -5,28 +5,34 @@
 from check_phat_nguoi.context import plates_context
 
 from .engines.telegram import TelegramNotificationEngine
-from .markdown_msg import MdMsg, MessagesModel
+from .markdown_message import MarkdownMessage, MessagesModel
 
 
 class SendNotifications:
     def __init__(self) -> None:
-        self._message_dict: tuple[MessagesModel, ...] = tuple(
-            MdMsg(plate_info).generate_msg() for plate_info in plates_context.plates
-        )
+        self._md_messages: tuple[MessagesModel, ...]
         self._tele: TelegramNotificationEngine
 
-    async def _send_msgs(self, notification: BaseNotificationDTO) -> None:
+    async def _send_messages(self, notification: BaseNotificationDTO) -> None:
         if isinstance(notification, TelegramNotificationDTO):
-            await self._tele.send(notification.telegram, self._message_dict)
+            await self._tele.send(notification.telegram, self._md_messages)
 
     async def send(self) -> None:
-        enabled_notifications: filter[BaseNotificationDTO] = filter(
-            lambda notify: notify.enabled, config.notifications
+        enabled_notifications: tuple[TelegramNotificationDTO, ...] = tuple(
+            notification
+            for notification in config.notifications
+            if notification.enabled
+        )
+        if len(enabled_notifications) == 0:
+            return
+        self._md_messages = tuple(
+            MarkdownMessage(plate_info).generate_message()
+            for plate_info in plates_context.plates
         )
         async with TelegramNotificationEngine() as self._tele:
             await gather(
                 *(
-                    self._send_msgs(notification)
+                    self._send_messages(notification)
                     for notification in enabled_notifications
                 )
             )