Logging setup & aliased response keys settings added in WebhookServer init

Author: karmaplush

whatsapp_api_webhook_server_python_v2/main.py

@@ -1,8 +1,10 @@
+import logging
 import os
 import signal
 from typing import Annotated, Any, Callable, Dict, Optional, Union
 
 import uvicorn
+import uvicorn.config
 from fastapi import Depends, FastAPI, Header, HTTPException, status
 
 from .webhook_dto import WebhookData
@@ -18,6 +20,12 @@ class GreenAPIWebhookServer:
         - `event_handler`: callable object for handling events. Must receive two args:
         `webhook_type: str` & `webhook_data: dict`
         - `webhook_auth_header`: Your GreenAPI auth header key
+        - `return_keys_by_alias: bool = False`: if this value is set to `True`,
+        webhook keys will be returned in camelCase,
+        otherwise in snake_case. Default `False` (snake_case)
+        - `enable_info_logs: bool = False`: if this value is set to `True`,
+        INFO logs from server will be enabled, otherwise - only ERROR.
+        Default `False` (ERROR)
 
     call `.start()` method for starting server
     """
@@ -28,19 +36,26 @@ def __init__(
         host: str = "0.0.0.0",
         port: int = 8080,
         webhook_auth_header: Optional[str] = None,
+        return_keys_by_alias: bool = False,
+        enable_info_logs: bool = False,
     ):
         self._host = host
         self._port = port
         self._event_handler = event_handler
         self._webhook_auth_header = webhook_auth_header
+        self._return_keys_by_alias = return_keys_by_alias
+        self._enable_info_logs = enable_info_logs
 
         self._init_server()
 
     def _handle_webhook(self, webhook_data: WebhookData, handler_func: Callable):
         """
         Handles the incoming webhook data by calling the event handler function
         """
-        parsed_data = webhook_data.model_dump(exclude_none=True)
+        parsed_data = webhook_data.model_dump(
+            exclude_none=True,
+            by_alias=self._return_keys_by_alias,
+        )
         handler_func(webhook_data.type_webhook, parsed_data)
 
     def _init_server(self):
@@ -83,6 +98,7 @@ def start(self):
                 host=self._host,
                 port=self._port,
                 reload=False,
+                log_level=logging.INFO if self._enable_info_logs else logging.ERROR,
             )
         except KeyboardInterrupt:
             os.kill(os.getpid(), signal.SIGTERM)

whatsapp_api_webhook_server_python_v2/webhook_dto.py

@@ -114,11 +114,13 @@ class ContactsArrayMessage(BaseModel):
 
 
 class Button(BaseModel):
+
     button_id: Optional[str] = Field(None, alias="buttonId")
     button_text: Optional[str] = Field(None, alias="buttonText")
 
 
 class ButtonsMessage(BaseModel):
+
     content_text: Optional[str] = Field(None, alias="contentText")
     footer: Optional[str] = Field(None, alias="footer")
     buttons: Optional[List[Button]] = Field(None, alias="buttons")
@@ -127,17 +129,20 @@ class ButtonsMessage(BaseModel):
 
 
 class ListMessageRow(BaseModel):
+
     title: Optional[str] = Field(None, alias="title")
     row_id: Optional[str] = Field(None, alias="rowId")
     description: Optional[str] = Field(None, alias="description")
 
 
 class ListMessageSection(BaseModel):
+
     title: Optional[str] = Field(None, alias="title")
     rows: Optional[List[ListMessageRow]] = Field(None, alias="rows")
 
 
 class ListMessage(BaseModel):
+
     content_text: Optional[str] = Field(None, alias="contentText")
     title: Optional[str] = Field(None, alias="title")
     footer: Optional[str] = Field(None, alias="footer")
@@ -178,6 +183,7 @@ class TemplateMessageButton(BaseModel):
 
 
 class TemplateMessage(BaseModel):
+
     content_text: Optional[str] = Field(None, alias="contentText")
     footer: Optional[str] = Field(None, alias="footer")
     buttons: Optional[List[TemplateMessageButton]] = Field(None, alias="buttons")
@@ -186,6 +192,7 @@ class TemplateMessage(BaseModel):
 
 
 class GroupInviteMessageDataExpiration(BaseModel):
+
     low: Optional[int] = Field(None, alias="low")
     high: Optional[int] = Field(None, alias="high")
     unsigned: Optional[bool] = Field(None, alias="unsigned")
@@ -205,15 +212,18 @@ class GroupInviteMessageData(BaseModel):
 
 
 class PollMessageOption(BaseModel):
+
     option_name: Optional[str] = Field(None, alias="optionName")
 
 
 class PollMessageVote(BaseModel):
+
     option_name: Optional[str] = Field(None, alias="optionName")
     option_voters: Optional[List[str]] = Field(None, alias="optionVoters")
 
 
 class PollMessageData(BaseModel):
+
     stanza_id: Optional[str] = Field(None, alias="stanzaId")
     name: Optional[str] = Field(None, alias="name")
     options: Optional[List[PollMessageOption]] = Field(None, alias="options")