feat: change the specification of synchronous requests

ExpressApp · Jun 21, 2024 · 92b64d4 · 92b64d4
1 parent 646825c
commit 92b64d4
Show file tree

Hide file tree

Showing 15 changed files with 338 additions and 228 deletions.
diff --git a/README.md b/README.md
@@ -234,16 +234,12 @@ collector = HandlerCollector()
 @collector.sync_smartapp_event
 async def handle_sync_smartapp_event(
     event: SmartAppEvent, bot: Bot,
-) -> SyncSmartAppEventResponsePayload:
+) -> BotAPISyncSmartAppEventResultResponse:
     print(f"Got sync smartapp event: {event}")
-    return SyncSmartAppEventResponsePayload.from_domain(
+    return BotAPISyncSmartAppEventResultResponse.from_domain(
         ref=event.ref,
-        smartapp_id=event.bot.id,
-        chat_id=event.chat.id,
         data={},
-        opts={},
         files=[],
-        encrypted=True,
     )
 ```
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pybotx/__init__.py b/pybotx/__init__.py
@@ -64,9 +64,6 @@
     SmartappManifest,
     SmartappManifestWebParams,
 )
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.client.stickers_api.exceptions import (
     InvalidEmojiError,
     InvalidImageError,
@@ -126,6 +123,11 @@
 from pybotx.models.smartapps import SmartApp
 from pybotx.models.status import BotMenu, StatusRecipient
 from pybotx.models.stickers import Sticker, StickerPack
+from pybotx.models.sync_smartapp_event import (
+    BotAPISyncSmartAppEventErrorResponse,
+    BotAPISyncSmartAppEventResponse,
+    BotAPISyncSmartAppEventResultResponse,
+)
 from pybotx.models.system_events.added_to_chat import AddedToChatEvent
 from pybotx.models.system_events.chat_created import ChatCreatedEvent, ChatCreatedMember
 from pybotx.models.system_events.cts_login import CTSLoginEvent
@@ -151,6 +153,9 @@
     "BotAPIBotDisabledErrorData",
     "BotAPIBotDisabledResponse",
     "BotAPIMethodFailedCallback",
+    "BotAPISyncSmartAppEventErrorResponse",
+    "BotAPISyncSmartAppEventResponse",
+    "BotAPISyncSmartAppEventResultResponse",
     "BotAPIUnverifiedRequestErrorData",
     "BotAPIUnverifiedRequestResponse",
     "BotAccount",
@@ -226,7 +231,6 @@
     "RequestHeadersNotProvidedError",
     "SmartApp",
     "SmartAppEvent",
-    "SyncSmartAppEventResponsePayload",
     "SmartappManifest",
     "SmartappManifestWebLayoutChoices",
     "SmartappManifestWebParams",

diff --git a/pybotx/bot/bot.py b/pybotx/bot/bot.py
@@ -148,9 +148,6 @@
     BotXAPISmartAppsListRequestPayload,
     SmartAppsListMethod,
 )
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.client.smartapps_api.upload_file import (
     UploadFileMethod as SmartappsUploadFileMethod,
 )
@@ -245,10 +242,11 @@
     build_bot_status_response,
 )
 from pybotx.models.stickers import Sticker, StickerPack, StickerPackFromList
-from pybotx.models.system_events.smartapp_event import (
-    BotAPISmartAppEvent,
-    SmartAppEvent,
+from pybotx.models.sync_smartapp_event import (
+    BotAPISyncSmartAppEvent,
+    BotAPISyncSmartAppEventResponse,
 )
+from pybotx.models.system_events.smartapp_event import SmartAppEvent
 from pybotx.models.users import UserFromCSV, UserFromSearch
 
 MissingOptionalAttachment = MissingOptional[
@@ -331,7 +329,7 @@ async def sync_execute_raw_smartapp_event(
         verify_request: bool = True,
         request_headers: Optional[Mapping[str, str]] = None,
         logging_command: bool = True,
-    ) -> SyncSmartAppEventResponsePayload:
+    ) -> BotAPISyncSmartAppEventResponse:
         if logging_command:
             log_incoming_request(
                 raw_smartapp_event,
@@ -342,8 +340,8 @@ async def sync_execute_raw_smartapp_event(
             self._verify_request(request_headers)
 
         try:
-            bot_api_smartapp_event: BotAPISmartAppEvent = parse_obj_as(
-                BotAPISmartAppEvent,
+            bot_api_smartapp_event: BotAPISyncSmartAppEvent = parse_obj_as(
+                BotAPISyncSmartAppEvent,
                 raw_smartapp_event,
             )
         except ValidationError as validation_exc:
@@ -357,7 +355,7 @@ async def sync_execute_raw_smartapp_event(
     async def sync_execute_smartapp_event(
         self,
         smartapp_event: SmartAppEvent,
-    ) -> SyncSmartAppEventResponsePayload:
+    ) -> BotAPISyncSmartAppEventResponse:
         self._bot_accounts_storage.ensure_bot_id_exists(smartapp_event.bot.id)
         return await self._handler_collector.handle_sync_smartapp_event(
             self,

diff --git a/pybotx/bot/handler.py b/pybotx/bot/handler.py
@@ -2,12 +2,10 @@
 from functools import partial
 from typing import TYPE_CHECKING, Awaitable, Callable, List, Literal, TypeVar, Union
 
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.models.commands import BotCommand
 from pybotx.models.message.incoming_message import IncomingMessage
 from pybotx.models.status import StatusRecipient
+from pybotx.models.sync_smartapp_event import BotAPISyncSmartAppEventResponse
 from pybotx.models.system_events.added_to_chat import AddedToChatEvent
 from pybotx.models.system_events.chat_created import ChatCreatedEvent
 from pybotx.models.system_events.cts_login import CTSLoginEvent
@@ -28,7 +26,7 @@
 
 SyncSmartAppEventHandlerFunc = Callable[
     [SmartAppEvent, "Bot"],
-    Awaitable[SyncSmartAppEventResponsePayload],
+    Awaitable[BotAPISyncSmartAppEventResponse],
 ]
 
 IncomingMessageHandlerFunc = HandlerFunc[IncomingMessage]

diff --git a/pybotx/bot/handler_collector.py b/pybotx/bot/handler_collector.py
@@ -33,14 +33,12 @@
     ExceptionMiddleware,
 )
 from pybotx.client.smartapps_api.exceptions import SyncSmartAppEventHandlerNotFoundError
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.converters import optional_sequence_to_list
 from pybotx.logger import logger
 from pybotx.models.commands import BotCommand, SystemEvent
 from pybotx.models.message.incoming_message import IncomingMessage
 from pybotx.models.status import BotMenu, StatusRecipient
+from pybotx.models.sync_smartapp_event import BotAPISyncSmartAppEventResponse
 from pybotx.models.system_events.added_to_chat import AddedToChatEvent
 from pybotx.models.system_events.chat_created import ChatCreatedEvent
 from pybotx.models.system_events.cts_login import CTSLoginEvent
@@ -126,7 +124,7 @@ async def handle_sync_smartapp_event(
         self,
         bot: "Bot",
         smartapp_event: SmartAppEvent,
-    ) -> SyncSmartAppEventResponsePayload:
+    ) -> BotAPISyncSmartAppEventResponse:
         if not isinstance(smartapp_event, SmartAppEvent):
             raise NotImplementedError(
                 f"Unsupported event type for sync smartapp event: `{smartapp_event}`",