clarity-api-sdk-python 0.4.0__tar.gz → 0.4.1__tar.gz

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.4.0
+Version: 0.4.1
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.4.0"
+version = "0.4.1"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.4.0
+Version: 0.4.1
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/src/cti/api/sonar_wiz_api.py

@@ -357,13 +357,37 @@ class SonarWizApi:
         response.raise_for_status()
         return RawFileDeviceMapping.model_validate(response.json())
 
-    def list_raw_file_device_mappings(self) -> list[RawFileDeviceMapping]:
-        """List all raw file device mappings.
+    def get_raw_file_device_mappings(
+        self,
+        *,
+        raw_file_id: UUID | str | None = None,
+        device_id: UUID | str | None = None,
+    ) -> list[RawFileDeviceMapping]:
+        """Get raw file device mappings filtered by raw file or device.
+
+        At least one of ``raw_file_id`` / ``device_id`` must be provided —
+        the server requires a filter and returns 400 otherwise.
+
+        Args:
+            raw_file_id: Match only mappings for this raw file.
+            device_id: Match only mappings for this device.
 
         Returns:
-            List of raw file device mapping instances.
+            List of matching raw file device mappings (empty if none match).
+
+        Raises:
+            ValueError: If neither ``raw_file_id`` nor ``device_id`` is given.
         """
-        response = self._client.get("/api/v1/raw-file-device-mappings")
+        if raw_file_id is None and device_id is None:
+            raise ValueError(
+                "At least one of raw_file_id or device_id must be provided."
+            )
+        params: dict[str, str] = {}
+        if raw_file_id is not None:
+            params["raw_file_id"] = str(raw_file_id)
+        if device_id is not None:
+            params["device_id"] = str(device_id)
+        response = self._client.get("/api/v1/raw-file-device-mappings", params=params)
         response.raise_for_status()
         return [RawFileDeviceMapping.model_validate(item) for item in response.json()]
 

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/src/cti/api/sonar_wiz_async_api.py

@@ -357,13 +357,39 @@ class SonarWizAsyncApi:
         response.raise_for_status()
         return RawFileDeviceMapping.model_validate(response.json())
 
-    async def list_raw_file_device_mappings(self) -> list[RawFileDeviceMapping]:
-        """List all raw file device mappings.
+    async def get_raw_file_device_mappings(
+        self,
+        *,
+        raw_file_id: UUID | str | None = None,
+        device_id: UUID | str | None = None,
+    ) -> list[RawFileDeviceMapping]:
+        """Get raw file device mappings filtered by raw file or device.
+
+        At least one of ``raw_file_id`` / ``device_id`` must be provided —
+        the server requires a filter and returns 400 otherwise.
+
+        Args:
+            raw_file_id: Match only mappings for this raw file.
+            device_id: Match only mappings for this device.
 
         Returns:
-            List of raw file device mapping instances.
+            List of matching raw file device mappings (empty if none match).
+
+        Raises:
+            ValueError: If neither ``raw_file_id`` nor ``device_id`` is given.
         """
-        response = await self._client.get("/api/v1/raw-file-device-mappings")
+        if raw_file_id is None and device_id is None:
+            raise ValueError(
+                "At least one of raw_file_id or device_id must be provided."
+            )
+        params: dict[str, str] = {}
+        if raw_file_id is not None:
+            params["raw_file_id"] = str(raw_file_id)
+        if device_id is not None:
+            params["device_id"] = str(device_id)
+        response = await self._client.get(
+            "/api/v1/raw-file-device-mappings", params=params
+        )
         response.raise_for_status()
         return [RawFileDeviceMapping.model_validate(item) for item in response.json()]
 

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/tests/test_sdk_async_methods.py

@@ -19,11 +19,15 @@ from .conftest import (
     SURVEY_ID,
     make_job_json,
     make_processing_log_json,
+    make_raw_file_device_mapping_json,
     make_raw_file_json,
     make_raw_file_with_upload_json,
 )
 
 
+DEVICE_ID = UUID("00000000-0000-0000-0000-000000000099")
+
+
 def _mock_response(
     json_data: dict, status_code: int = 200, headers: dict | None = None
 ) -> MagicMock:
@@ -297,3 +301,71 @@ async def test_list_processing_logs_accepts_string_uuid():
         "/api/v1/processing-logs",
         params={"raw_file_id": str(RAW_FILE_ID)},
     )
+
+
+# ── get_raw_file_device_mappings filter kwargs (#23) ────────────────────
+
+
+@pytest.mark.asyncio
+async def test_get_raw_file_device_mappings_requires_a_filter():
+    """Calling with neither filter raises ValueError before touching the wire."""
+    client = AsyncMock()
+    api = SonarWizAsyncApi(client)
+
+    with pytest.raises(ValueError, match="raw_file_id or device_id"):
+        await api.get_raw_file_device_mappings()
+
+    client.get.assert_not_called()
+
+
+@pytest.mark.asyncio
+async def test_get_raw_file_device_mappings_filters_by_raw_file_id():
+    """raw_file_id filter is sent as a query param; UUID stringified."""
+    client = AsyncMock()
+    client.get.return_value = _mock_response(
+        [make_raw_file_device_mapping_json(device_id=DEVICE_ID)]
+    )
+
+    api = SonarWizAsyncApi(client)
+    mappings = await api.get_raw_file_device_mappings(raw_file_id=RAW_FILE_ID)
+
+    client.get.assert_awaited_once_with(
+        "/api/v1/raw-file-device-mappings",
+        params={"raw_file_id": str(RAW_FILE_ID)},
+    )
+    assert len(mappings) == 1
+    assert mappings[0].raw_file_id == RAW_FILE_ID
+    assert mappings[0].device_id == DEVICE_ID
+
+
+@pytest.mark.asyncio
+async def test_get_raw_file_device_mappings_filters_by_device_id():
+    """device_id filter is sent alone when raw_file_id is omitted."""
+    client = AsyncMock()
+    client.get.return_value = _mock_response([])
+
+    api = SonarWizAsyncApi(client)
+    mappings = await api.get_raw_file_device_mappings(device_id=DEVICE_ID)
+
+    client.get.assert_awaited_once_with(
+        "/api/v1/raw-file-device-mappings",
+        params={"device_id": str(DEVICE_ID)},
+    )
+    assert mappings == []
+
+
+@pytest.mark.asyncio
+async def test_get_raw_file_device_mappings_accepts_string_uuids():
+    """String UUIDs are accepted and stringified the same way."""
+    client = AsyncMock()
+    client.get.return_value = _mock_response([])
+
+    api = SonarWizAsyncApi(client)
+    await api.get_raw_file_device_mappings(
+        raw_file_id=str(RAW_FILE_ID), device_id=str(DEVICE_ID)
+    )
+
+    client.get.assert_awaited_once_with(
+        "/api/v1/raw-file-device-mappings",
+        params={"raw_file_id": str(RAW_FILE_ID), "device_id": str(DEVICE_ID)},
+    )

{clarity_api_sdk_python-0.4.0 → clarity_api_sdk_python-0.4.1}/tests/test_sdk_methods.py

@@ -20,11 +20,15 @@ from .conftest import (
     SURVEY_ID,
     make_job_json,
     make_processing_log_json,
+    make_raw_file_device_mapping_json,
     make_raw_file_json,
     make_raw_file_with_upload_json,
 )
 
 
+DEVICE_ID = UUID("00000000-0000-0000-0000-000000000099")
+
+
 def _mock_response(
     json_data: dict, status_code: int = 200, headers: dict | None = None
 ) -> MagicMock:
@@ -317,3 +321,67 @@ def test_list_processing_logs_partial_filter_only_includes_provided():
         params={"survey_id": str(SURVEY_ID)},
     )
     assert logs == []
+
+
+# ── get_raw_file_device_mappings filter kwargs (#23) ────────────────────
+
+
+def test_get_raw_file_device_mappings_requires_a_filter():
+    """Calling with neither filter raises ValueError before touching the wire."""
+    client = MagicMock()
+    api = SonarWizApi(client)
+
+    with pytest.raises(ValueError, match="raw_file_id or device_id"):
+        api.get_raw_file_device_mappings()
+
+    client.get.assert_not_called()
+
+
+def test_get_raw_file_device_mappings_filters_by_raw_file_id():
+    """raw_file_id filter is sent as a query param; UUID stringified."""
+    client = MagicMock()
+    client.get.return_value = _mock_response(
+        [make_raw_file_device_mapping_json(device_id=DEVICE_ID)]
+    )
+
+    api = SonarWizApi(client)
+    mappings = api.get_raw_file_device_mappings(raw_file_id=RAW_FILE_ID)
+
+    client.get.assert_called_once_with(
+        "/api/v1/raw-file-device-mappings",
+        params={"raw_file_id": str(RAW_FILE_ID)},
+    )
+    assert len(mappings) == 1
+    assert mappings[0].raw_file_id == RAW_FILE_ID
+    assert mappings[0].device_id == DEVICE_ID
+
+
+def test_get_raw_file_device_mappings_filters_by_device_id():
+    """device_id filter is sent alone when raw_file_id is omitted."""
+    client = MagicMock()
+    client.get.return_value = _mock_response([])
+
+    api = SonarWizApi(client)
+    mappings = api.get_raw_file_device_mappings(device_id=DEVICE_ID)
+
+    client.get.assert_called_once_with(
+        "/api/v1/raw-file-device-mappings",
+        params={"device_id": str(DEVICE_ID)},
+    )
+    assert mappings == []
+
+
+def test_get_raw_file_device_mappings_accepts_string_uuids():
+    """String UUIDs are accepted and stringified the same way."""
+    client = MagicMock()
+    client.get.return_value = _mock_response([])
+
+    api = SonarWizApi(client)
+    api.get_raw_file_device_mappings(
+        raw_file_id=str(RAW_FILE_ID), device_id=str(DEVICE_ID)
+    )
+
+    client.get.assert_called_once_with(
+        "/api/v1/raw-file-device-mappings",
+        params={"raw_file_id": str(RAW_FILE_ID), "device_id": str(DEVICE_ID)},
+    )