zalobot-python 0.1.0__tar.gz → 0.1.2__tar.gz

{zalobot_python-0.1.0 → zalobot_python-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: zalobot-python
-Version: 0.1.0
+Version: 0.1.2
 Summary: Python SDK for the Zalo Bot API
 Author: NovaH00
 Author-email: NovaH00 <trantay2006super@gmail.com>

{zalobot_python-0.1.0 → zalobot_python-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "zalobot-python"
-version = "0.1.0"
+version = "0.1.2"
 description = "Python SDK for the Zalo Bot API"
 readme = "README.md"
 authors = [

{zalobot_python-0.1.0 → zalobot_python-0.1.2}/src/zalobot_python/__init__.py

@@ -1,5 +1,8 @@
-from .zalobot import ZaloBot
+from .zalobot import ZaloBot, WebhookHandler
 from .models import (
+    SuccessfulResponse,
+    ErrorResponse,
+    ZaloAPIResponse,
     BotInfo,
     WebhookInfo,
     MessageInfo,
@@ -8,11 +11,15 @@ from .models import (
     Chat,
     Message,
     Event,
-    ZaloAPIError
+    ZaloAPIError,
 )
 
 __all__ = [
+    "SuccessfulResponse",
+    "ErrorResponse",
+    "ZaloAPIResponse",
     "ZaloBot",
+    "WebhookHandler",
     "BotInfo",
     "WebhookInfo",
     "MessageInfo",

{zalobot_python-0.1.0 → zalobot_python-0.1.2}/src/zalobot_python/models.py

@@ -1,24 +1,30 @@
 from enum import StrEnum 
-from typing import Literal, TypeVar, override
+from typing import Literal, TypeVar, override, Annotated
 from pydantic import BaseModel, Field
 
 class Result(BaseModel):
-    """Represents the result field in the API successful response"""
+    """Represents the result field in the Zalo API successful response"""
     pass
 
 T = TypeVar("T", bound=Result)
 class SuccessfulResponse[T](BaseModel):
+    """Represents the successful response of the Zalo API"""
     ok: Literal[True] = True
     result: T = Field(description="The result when the API call is successful.")
 
 class ErrorResponse(BaseModel):
+    """Represents the error response of Zalo API"""
     ok: Literal[False] = False
     description: str = Field(description="The description of the error")
     error_code: int = Field(description="The error code")
 
-type APIResponse[T] = SuccessfulResponse[T] | ErrorResponse
+type ZaloAPIResponse[T] = Annotated[
+    SuccessfulResponse[T] | ErrorResponse,
+    "Represents the response of the Zalo API"
+]
 
 class ZaloAPIError(BaseException):
+    """Exception when using the Zalo API"""
     def __init__(self, error_code: int, description: str):
         self.error_code: int = error_code
         self.description: str = description
@@ -43,20 +49,20 @@ class MessageInfo(Result):
     message_id: str
     date: int
 
-
 class EventName(StrEnum):
     TEXT_RECEIVED        = "message.text.received"
     IMAGE_RECEIVED       = "message.image.received"
     STICKER_RECEIVED     = "message.sticker.received"
     UNSUPPORTED_RECEIVED = "message.unsupported.received"
 
-
 class From(BaseModel):
+    """Sender information"""
     id: str
     display_name: str
     is_bot: bool
 
 class Chat(BaseModel):
+    """Current chat information"""
     id: str
     chat_type: str
 

{zalobot_python-0.1.0 → zalobot_python-0.1.2}/src/zalobot_python/zalobot.py

@@ -1,8 +1,8 @@
-from typing import Any, Literal
+from typing import Any, Literal, Protocol
 import httpx
 
 from .models import (
-    APIResponse,
+    ZaloAPIResponse,
     SuccessfulResponse,
     ErrorResponse,
     ZaloAPIError,
@@ -13,13 +13,12 @@ from .models import (
 )
 from .config import ZaloAPIConfig
 
-
 async def fetch[T](
     url: str,
     *,
     method: Literal["GET", "POST"] = "GET",
     body: dict[str, Any] | None = None,
-) -> APIResponse[T]:
+) -> ZaloAPIResponse[T]:
     async with httpx.AsyncClient() as client:
 
         if method == "GET":
@@ -35,15 +34,19 @@ async def fetch[T](
 
         return ErrorResponse(**response_json)
 
+class WebhookHandler(Protocol):
+    async def __call__(self, update_event: Event, bot: ZaloBot) -> None: ...
+
 class ZaloBot:
     def __init__(self, BOT_TOKEN: str):
         self._BOT_TOKEN: str = BOT_TOKEN
         self._base_url: str = f"{ZaloAPIConfig.BASE_URL}/bot{BOT_TOKEN}"
-    
+        self._webhook_handlers: list[WebhookHandler] = [] 
+
     async def getMe(self) -> BotInfo:
         url = f"{self._base_url}/getMe" 
         
-        res: APIResponse[BotInfo] = await fetch(url)
+        res: ZaloAPIResponse[BotInfo] = await fetch(url)
         
         if isinstance(res, ErrorResponse):
             raise ZaloAPIError(
@@ -54,7 +57,6 @@ class ZaloBot:
        
         return res.result
                       
-                
     async def getUpdates(self, timeout: int = 30) -> Event:
         url = f"{self._base_url}/getUpdates"
         
@@ -62,7 +64,7 @@ class ZaloBot:
             "timeout": timeout
         }
 
-        res: APIResponse[Event] = await fetch(url, method="POST", body=payload)
+        res: ZaloAPIResponse[Event] = await fetch(url, method="POST", body=payload)
 
         if isinstance(res, ErrorResponse):
             raise ZaloAPIError(
@@ -72,7 +74,11 @@ class ZaloBot:
 
         return res.result
 
-    async def setWebhook(self, url: str, secret_token: str) -> WebhookInfo:
+    async def setWebhook(
+        self,
+        url: str,
+        secret_token: str,
+    ) -> WebhookInfo:
         url = f"{self._base_url}/setWebhook"
         
         payload = {
@@ -80,7 +86,7 @@ class ZaloBot:
             "secret_token": secret_token
         }
 
-        res: APIResponse[WebhookInfo] = await fetch(url, method="POST", body=payload)
+        res: ZaloAPIResponse[WebhookInfo] = await fetch(url, method="POST", body=payload)
 
         if isinstance(res, ErrorResponse):
             raise ZaloAPIError(
@@ -93,7 +99,7 @@ class ZaloBot:
     async def deleteWebhook(self) -> WebhookInfo:
         url = f"{self._base_url}/deleteWebhook"
         
-        res: APIResponse[WebhookInfo] = await fetch(url)
+        res: ZaloAPIResponse[WebhookInfo] = await fetch(url)
 
         if isinstance(res, ErrorResponse):
             raise ZaloAPIError(
@@ -106,7 +112,7 @@ class ZaloBot:
     async def getWebhookInfo(self) -> WebhookInfo:
         url = f"{self._base_url}/getWebhookInfo"
         
-        res: APIResponse[WebhookInfo] = await fetch(url)
+        res: ZaloAPIResponse[WebhookInfo] = await fetch(url)
 
         if isinstance(res, ErrorResponse):
             raise ZaloAPIError(
@@ -116,6 +122,15 @@ class ZaloBot:
 
         return res.result
     
+    def on_webhook_update(self, handler: WebhookHandler) -> None:
+        """Registers a handler to handle on webhook event update"""
+        self._webhook_handlers.append(handler)
+
+    async def dispatch_webhook_handlers(self, update_event: Event) -> None:
+        """Run all handlers given a webhook event"""
+        for handler in self._webhook_handlers:
+            await handler(update_event, self)
+
     async def sendMessage(self, chat_id: str, text: str) -> MessageInfo:
         url = f"{self._base_url}/sendMessage"
         
@@ -123,7 +138,7 @@ class ZaloBot:
             "chat_id": chat_id,
             "text": text
         }
-        res: APIResponse[MessageInfo] = await fetch(url, method="POST", body=payload)
+        res: ZaloAPIResponse[MessageInfo] = await fetch(url, method="POST", body=payload)
 
         if isinstance(res, ErrorResponse):
             raise ZaloAPIError(