feat: add method to call PATCH Event/.../replay endpoint (#137)

* feat: add method to call PATCH`Event/.../replay` endpoint

* pylint

---------

Co-authored-by: Konstantin <[email protected]>

Author: hf-kklein

src/bssclient/client/bssclient.py

@@ -4,9 +4,9 @@
 import logging
 import uuid
 from abc import ABC
-from typing import Awaitable, Optional
+from typing import Awaitable, Literal, Optional, TypeAlias
 
-from aiohttp import BasicAuth, ClientSession, ClientTimeout
+from aiohttp import BasicAuth, ClientResponseError, ClientSession, ClientTimeout
 from more_itertools import chunked
 from yarl import URL
 
@@ -17,6 +17,8 @@
 
 _logger = logging.getLogger(__name__)
 
+DomainModelType: TypeAlias = Literal["Prozess", "Aufgabe", "Zeitlimit"]
+
 
 class BssClient(ABC):
     """
@@ -154,6 +156,29 @@ async def get_all_ermittlungsauftraege(self, package_size: int = 100) -> list[Er
         _logger.info("Downloaded %i Ermittlungsautraege", len(result))
         return result
 
+    async def replay_event(self, model_type: DomainModelType, model_id: uuid.UUID, event_number: int) -> bool:
+        """calls the re-apply endpoint"""
+        session = await self._get_session()
+        request_url = (
+            self._config.server_url
+            / "api"
+            / "Event"
+            / "replay"
+            / model_type
+            / str(model_id)
+            / str(event_number)
+            / "false"  # is temporal
+        )
+        request_uuid = uuid.uuid4()
+        _logger.debug("[%s] requesting %s", str(request_uuid), request_url)
+        try:
+            async with session.patch(request_url) as response:
+                _logger.debug("[%s] response status: %s", str(request_uuid), response.status)
+                return response.status == 200
+        except ClientResponseError as cre:
+            _logger.debug("[%s] response status: %s", str(request_uuid), cre.status)
+            return False
+
 
 class BasicAuthBssClient(BssClient):
     """BSS client with basic auth"""

unittests/test_ermittlungsauftraege.py

@@ -1,4 +1,5 @@
 import json
+import uuid
 from datetime import datetime, timezone
 from pathlib import Path
 from unittest.mock import AsyncMock, Mock
@@ -122,3 +123,20 @@ async def test_get_stats_with_oauth(self, bss_client_with_oauth):
                 # https://github.com/Hochfrequenz/bssclient.py/issues/25
         assert isinstance(actual, AufgabeStats)
         assert actual.stats["Ermittlungsauftrag"]["status"]["Beendet"] == 2692
+
+    @pytest.mark.parametrize(
+        "status_code, expected",
+        [
+            pytest.param(200, True),
+            pytest.param(400, False),
+            pytest.param(404, False),
+        ],
+    )
+    async def test_replay_event(self, bss_client_with_basic_auth, status_code: int, expected: bool) -> None:
+        client, bss_config = bss_client_with_basic_auth
+        random_uuid = uuid.uuid4()
+        with aioresponses() as mocked_bss:
+            mocked_patch_url = f"{bss_config.server_url}api/Event/replay/Prozess/{random_uuid}/17/false"
+            mocked_bss.patch(mocked_patch_url, status=status_code)
+            actual = await client.replay_event("Prozess", random_uuid, 17)
+        assert actual is expected