feat: find Ermittlungsauftraege by malo-id (#21)

* feat: find Ermittlungsauftraege by malo-id

* disable pylint

Author: hf-kklein

src/bssclient/client/bssclient.py

@@ -102,6 +102,33 @@ async def get_ermittlungsauftraege(self, limit: int = 0, offset: int = 0) -> lis
         )
         return _list_of_ermittlungsauftraege.root
 
+    async def get_ermittlungsauftraege_by_malo(self, malo_id: str) -> list[Ermittlungsauftrag]:
+        """
+        find ermittlungsauftraege by their marktlokations-id
+        """
+        if malo_id is None or not isinstance(malo_id, str) or not malo_id.strip():
+            raise ValueError(f"malo_id must not be empty but was '{malo_id}'")
+        session = await self._get_session()
+        # see https://basicsupply.xtk-dev.de/swagger/index.html#operations-Aufgabe-get_api_Aufgabe_ermittlungsauftraege
+        request_url = (
+            self._config.server_url
+            / "api"
+            / "Aufgabe"
+            / "ermittlungsauftraege"
+            % {"marktlokationid": malo_id, "includeDetails": "true"}
+        )
+        request_uuid = uuid.uuid4()
+        _logger.debug("[%s] requesting %s", str(request_uuid), request_url)
+        async with session.get(request_url) as response:
+            response.raise_for_status()  # endpoint returns an empty list but no 404
+            _logger.debug("[%s] response status: %s", str(request_uuid), response.status)
+            response_json = await response.json()
+            _list_of_ermittlungsauftraege = _ListOfErmittlungsauftraege.model_validate(response_json)
+        _logger.debug(
+            "Downloaded %i Ermittlungsauftraege for MaLo '%s'", len(_list_of_ermittlungsauftraege.root), malo_id
+        )
+        return _list_of_ermittlungsauftraege.root
+
     async def get_aufgabe_stats(self) -> AufgabeStats:
         """
         get statistics for all aufgaben types

unittests/test_ermittlungsauftraege.py

@@ -42,6 +42,20 @@ async def test_get_ermittlungsauftraege(self, bss_client_with_default_auth):
             2020, 4, 17, 22, 0, tzinfo=timezone.utc
         )
 
+    async def test_get_ermittlungsauftraege_by_malo(self, bss_client_with_default_auth):
+        ermittlungsauftraege_json_file = Path(__file__).parent / "example_data" / "list_of_1_ermittlungsauftraege.json"
+        with (open(ermittlungsauftraege_json_file, "r", encoding="utf-8") as infile1,):
+            ermittlungsauftraege = json.load(infile1)
+        client, bss_config = bss_client_with_default_auth
+        with aioresponses() as mocked_bss:
+            # pylint: disable=line-too-long
+            mocked_get_url = f"{bss_config.server_url}api/Aufgabe/ermittlungsauftraege?marktlokationid=52671494807&includeDetails=true"
+            mocked_bss.get(mocked_get_url, status=200, payload=ermittlungsauftraege)
+            actual = await client.get_ermittlungsauftraege_by_malo(malo_id="52671494807")
+        assert isinstance(actual, list)
+        assert len(actual) == 1
+        assert all(isinstance(x, Ermittlungsauftrag) for x in actual)
+
     async def test_get_stats(self, bss_client_with_default_auth):
         stats_json_file = Path(__file__).parent / "example_data" / "aufgabe_stats.json"
         with open(stats_json_file, "r", encoding="utf-8") as infile: