clarity-api-sdk-python 0.4.2__tar.gz → 0.4.3__tar.gz

{clarity_api_sdk_python-0.4.2 → clarity_api_sdk_python-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.4.2
+Version: 0.4.3
 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.2 → clarity_api_sdk_python-0.4.3}/pyproject.toml

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

{clarity_api_sdk_python-0.4.2 → clarity_api_sdk_python-0.4.3}/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.2
+Version: 0.4.3
 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.2 → clarity_api_sdk_python-0.4.3}/src/cti/api/sonar_wiz_api.py

@@ -1709,33 +1709,56 @@ class SonarWizApi:
         response.raise_for_status()
         return Target.model_validate(response.json())
 
-    def list_targets(self) -> list[Target]:
-        """List all targets.
+    def list_targets(self, sidescan_ping_source_id: UUID | str) -> list[Target]:
+        """List all targets for one sidescan ping source.
+
+        The cross-source ``GET /api/v1/targets`` endpoint is deprecated;
+        the spec scopes target reads to a single SidescanPingSource.
+
+        Args:
+            sidescan_ping_source_id: SidescanPingSource UUID or string identifier.
 
         Returns:
-            List of target instances.
+            List of target instances, each with the ``derived`` block
+            populated when the parent line's nav state is available.
         """
-        response = self._client.get("/api/v1/targets")
+        response = self._client.get(
+            f"/api/v1/sidescan-ping-sources/{sidescan_ping_source_id}/targets"
+        )
         response.raise_for_status()
         return [Target.model_validate(item) for item in response.json()]
 
     def update_target(self, target_id: UUID | str, target: TargetUpdate) -> Target:
-        """Update a target.
+        """Partially update a target.
+
+        Targets MVP is the first endpoint in the API to use PATCH (older
+        update endpoints use PUT for legacy reasons but already behave as
+        PATCH server-side via ``exclude_unset=True``). Body fields are
+        optional; only the supplied fields are mutated.
 
         Args:
             target_id: Target UUID or string identifier.
-            target: Target update data.
+            target: Partial target update data.
 
         Returns:
             Updated target instance.
         """
-        response = self._client.put(
+        response = self._client.patch(
             f"/api/v1/targets/{target_id}",
             json=target.model_dump(mode="json", exclude_unset=True),
         )
         response.raise_for_status()
         return Target.model_validate(response.json())
 
+    def delete_target(self, target_id: UUID | str) -> None:
+        """Hard-delete a target.
+
+        Args:
+            target_id: Target UUID or string identifier.
+        """
+        response = self._client.delete(f"/api/v1/targets/{target_id}")
+        response.raise_for_status()
+
     def create_tow_system(self, tow_system: TowSystemCreate) -> TowSystem:
         """Create a new tow system.
 

{clarity_api_sdk_python-0.4.2 → clarity_api_sdk_python-0.4.3}/src/cti/api/sonar_wiz_async_api.py

@@ -1753,35 +1753,58 @@ class SonarWizAsyncApi:
         response.raise_for_status()
         return Target.model_validate(response.json())
 
-    async def list_targets(self) -> list[Target]:
-        """List all targets.
+    async def list_targets(self, sidescan_ping_source_id: UUID | str) -> list[Target]:
+        """List all targets for one sidescan ping source.
+
+        The cross-source ``GET /api/v1/targets`` endpoint is deprecated;
+        the spec scopes target reads to a single SidescanPingSource.
+
+        Args:
+            sidescan_ping_source_id: SidescanPingSource UUID or string identifier.
 
         Returns:
-            List of target instances.
+            List of target instances, each with the ``derived`` block
+            populated when the parent line's nav state is available.
         """
-        response = await self._client.get("/api/v1/targets")
+        response = await self._client.get(
+            f"/api/v1/sidescan-ping-sources/{sidescan_ping_source_id}/targets"
+        )
         response.raise_for_status()
         return [Target.model_validate(item) for item in response.json()]
 
     async def update_target(
         self, target_id: UUID | str, target: TargetUpdate
     ) -> Target:
-        """Update a target.
+        """Partially update a target.
+
+        Targets MVP is the first endpoint in the API to use PATCH (older
+        update endpoints use PUT for legacy reasons but already behave as
+        PATCH server-side via ``exclude_unset=True``). Body fields are
+        optional; only the supplied fields are mutated.
 
         Args:
             target_id: Target UUID or string identifier.
-            target: Target update data.
+            target: Partial target update data.
 
         Returns:
             Updated target instance.
         """
-        response = await self._client.put(
+        response = await self._client.patch(
             f"/api/v1/targets/{target_id}",
             json=target.model_dump(mode="json", exclude_unset=True),
         )
         response.raise_for_status()
         return Target.model_validate(response.json())
 
+    async def delete_target(self, target_id: UUID | str) -> None:
+        """Hard-delete a target.
+
+        Args:
+            target_id: Target UUID or string identifier.
+        """
+        response = await self._client.delete(f"/api/v1/targets/{target_id}")
+        response.raise_for_status()
+
     async def create_tow_system(self, tow_system: TowSystemCreate) -> TowSystem:
         """Create a new tow system.
 

{clarity_api_sdk_python-0.4.2 → clarity_api_sdk_python-0.4.3}/tests/test_sdk_async_methods.py

@@ -369,3 +369,163 @@ async def test_get_raw_file_device_mappings_accepts_string_uuids():
         "/api/v1/raw-file-device-mappings",
         params={"raw_file_id": str(RAW_FILE_ID), "device_id": str(DEVICE_ID)},
     )
+
+
+# ──────────────────────────────────────────────────────────────────────────
+# Targets MVP — async client method coverage (issue #26)
+
+
+_TARGET_ID = UUID("00000000-0000-0000-0000-0000000000a1")
+_SPS_ID = UUID("00000000-0000-0000-0000-0000000000a2")
+_USER_ID = UUID("00000000-0000-0000-0000-000000000001")
+
+
+def _make_target_json(
+    *,
+    target_id: UUID = _TARGET_ID,
+    sidescan_ping_source_id: UUID = _SPS_ID,
+    name: str = "[unreviewed] [Unknown Object]",
+    derived: dict | None = None,
+) -> dict:
+    """Build a Target JSON dict matching the server's read response shape."""
+    return {
+        "target_id": str(target_id),
+        "sidescan_ping_source_id": str(sidescan_ping_source_id),
+        "channel": 0,
+        "ping": 100,
+        "sample": 250,
+        "name": name,
+        "description": "",
+        "width_samples": None,
+        "height_pings": None,
+        "shadow_samples": None,
+        "derived": derived,
+        "created_by_user_id": str(_USER_ID),
+        "last_modified_by_user_id": str(_USER_ID),
+        "created_at": "2026-05-05T12:00:00Z",
+        "updated_at": "2026-05-05T12:00:00Z",
+    }
+
+
+@pytest.mark.asyncio
+async def test_create_target_posts_json_and_parses_target():
+    """create_target POSTs sample-address JSON and returns a typed Target."""
+    from cti.model.target import TargetCreate
+
+    client = AsyncMock()
+    client.post.return_value = _mock_response(_make_target_json())
+
+    api = SonarWizAsyncApi(client)
+    payload = TargetCreate(
+        sidescan_ping_source_id=_SPS_ID,
+        channel=0,
+        ping=100,
+        sample=250,
+    )
+    result = await api.create_target(payload)
+
+    client.post.assert_awaited_once()
+    url, _ = client.post.call_args[0], client.post.call_args[1]
+    assert url[0] == "/api/v1/targets"
+    sent = client.post.call_args.kwargs["json"]
+    assert sent["sidescan_ping_source_id"] == str(_SPS_ID)
+    assert sent["channel"] == 0
+    assert sent["ping"] == 100
+    assert sent["sample"] == 250
+    assert result.target_id == _TARGET_ID
+
+
+@pytest.mark.asyncio
+async def test_get_target_returns_typed_target_with_derived_block():
+    """get_target hits /targets/{id} and surfaces the derived block."""
+    derived = {
+        "longitude": -76.123,
+        "latitude": 38.456,
+        "projected_x": 412345.67,
+        "projected_y": 4256789.01,
+        "srid": "EPSG:32618",
+        "width": None,
+        "height": None,
+        "shadow": None,
+        "linear_unit": "metre",
+    }
+    client = AsyncMock()
+    client.get.return_value = _mock_response(_make_target_json(derived=derived))
+
+    api = SonarWizAsyncApi(client)
+    result = await api.get_target(_TARGET_ID)
+
+    client.get.assert_awaited_once_with(f"/api/v1/targets/{_TARGET_ID}")
+    assert result.target_id == _TARGET_ID
+    assert result.derived is not None
+    assert result.derived.srid == "EPSG:32618"
+
+
+@pytest.mark.asyncio
+async def test_list_targets_scopes_to_sidescan_ping_source():
+    """list_targets hits the per-SPS endpoint, not the deprecated cross-source one."""
+    client = AsyncMock()
+    client.get.return_value = _mock_response(
+        [_make_target_json(target_id=UUID(int=i + 1), name=f"t{i}") for i in range(3)]
+    )
+
+    api = SonarWizAsyncApi(client)
+    results = await api.list_targets(_SPS_ID)
+
+    client.get.assert_awaited_once_with(
+        f"/api/v1/sidescan-ping-sources/{_SPS_ID}/targets"
+    )
+    assert len(results) == 3
+    assert {t.name for t in results} == {"t0", "t1", "t2"}
+
+
+@pytest.mark.asyncio
+async def test_update_target_uses_patch_with_partial_body():
+    """update_target uses PATCH and serialises only the fields the caller set."""
+    from cti.model.target import TargetUpdate
+
+    client = AsyncMock()
+    client.patch.return_value = _mock_response(_make_target_json(name="renamed"))
+
+    api = SonarWizAsyncApi(client)
+    payload = TargetUpdate(name="renamed")
+    result = await api.update_target(_TARGET_ID, payload)
+
+    client.patch.assert_awaited_once()
+    assert client.patch.call_args[0][0] == f"/api/v1/targets/{_TARGET_ID}"
+    sent = client.patch.call_args.kwargs["json"]
+    # exclude_unset → only the field the caller set ships
+    assert sent == {"name": "renamed"}
+    assert result.name == "renamed"
+
+
+@pytest.mark.asyncio
+async def test_delete_target_returns_none_and_calls_delete():
+    """delete_target returns None after a successful DELETE."""
+    client = AsyncMock()
+    delete_resp = MagicMock(spec=httpx.Response)
+    delete_resp.status_code = 204
+    delete_resp.raise_for_status.return_value = None
+    client.delete.return_value = delete_resp
+
+    api = SonarWizAsyncApi(client)
+    result = await api.delete_target(_TARGET_ID)
+
+    client.delete.assert_awaited_once_with(f"/api/v1/targets/{_TARGET_ID}")
+    assert result is None
+
+
+@pytest.mark.asyncio
+async def test_target_method_errors_propagate_via_raise_for_status():
+    """Server errors bubble up as httpx.HTTPStatusError via raise_for_status."""
+    client = AsyncMock()
+    err_resp = MagicMock(spec=httpx.Response)
+    err_resp.status_code = 404
+    err_resp.raise_for_status.side_effect = httpx.HTTPStatusError(
+        "Not found", request=MagicMock(), response=err_resp
+    )
+    client.get.return_value = err_resp
+
+    api = SonarWizAsyncApi(client)
+    with pytest.raises(httpx.HTTPStatusError):
+        await api.get_target(_TARGET_ID)

{clarity_api_sdk_python-0.4.2 → clarity_api_sdk_python-0.4.3}/tests/test_sdk_methods.py

@@ -385,3 +385,153 @@ def test_get_raw_file_device_mappings_accepts_string_uuids():
         "/api/v1/raw-file-device-mappings",
         params={"raw_file_id": str(RAW_FILE_ID), "device_id": str(DEVICE_ID)},
     )
+
+
+# ──────────────────────────────────────────────────────────────────────────
+# Targets MVP — sync client method coverage (issue #26 sync mirror)
+
+
+_TARGET_ID = UUID("00000000-0000-0000-0000-0000000000a1")
+_SPS_ID = UUID("00000000-0000-0000-0000-0000000000a2")
+_USER_ID = UUID("00000000-0000-0000-0000-000000000001")
+
+
+def _make_target_json(
+    *,
+    target_id: UUID = _TARGET_ID,
+    sidescan_ping_source_id: UUID = _SPS_ID,
+    name: str = "[unreviewed] [Unknown Object]",
+    derived: dict | None = None,
+) -> dict:
+    """Build a Target JSON dict matching the server's read response shape."""
+    return {
+        "target_id": str(target_id),
+        "sidescan_ping_source_id": str(sidescan_ping_source_id),
+        "channel": 0,
+        "ping": 100,
+        "sample": 250,
+        "name": name,
+        "description": "",
+        "width_samples": None,
+        "height_pings": None,
+        "shadow_samples": None,
+        "derived": derived,
+        "created_by_user_id": str(_USER_ID),
+        "last_modified_by_user_id": str(_USER_ID),
+        "created_at": "2026-05-05T12:00:00Z",
+        "updated_at": "2026-05-05T12:00:00Z",
+    }
+
+
+def test_create_target_posts_json_and_parses_target():
+    """create_target POSTs sample-address JSON and returns a typed Target."""
+    from cti.model.target import TargetCreate
+
+    client = MagicMock()
+    client.post.return_value = _mock_response(_make_target_json())
+
+    api = SonarWizApi(client)
+    payload = TargetCreate(
+        sidescan_ping_source_id=_SPS_ID,
+        channel=0,
+        ping=100,
+        sample=250,
+    )
+    result = api.create_target(payload)
+
+    client.post.assert_called_once()
+    assert client.post.call_args[0][0] == "/api/v1/targets"
+    sent = client.post.call_args.kwargs["json"]
+    assert sent["sidescan_ping_source_id"] == str(_SPS_ID)
+    assert sent["ping"] == 100
+    assert result.target_id == _TARGET_ID
+
+
+def test_get_target_returns_typed_target_with_derived_block():
+    """get_target hits /targets/{id} and surfaces the derived block."""
+    derived = {
+        "longitude": -76.123,
+        "latitude": 38.456,
+        "projected_x": 412345.67,
+        "projected_y": 4256789.01,
+        "srid": "EPSG:32618",
+        "width": None,
+        "height": None,
+        "shadow": None,
+        "linear_unit": "metre",
+    }
+    client = MagicMock()
+    client.get.return_value = _mock_response(_make_target_json(derived=derived))
+
+    api = SonarWizApi(client)
+    result = api.get_target(_TARGET_ID)
+
+    client.get.assert_called_once_with(f"/api/v1/targets/{_TARGET_ID}")
+    assert result.target_id == _TARGET_ID
+    assert result.derived is not None
+    assert result.derived.srid == "EPSG:32618"
+
+
+def test_list_targets_scopes_to_sidescan_ping_source():
+    """list_targets hits the per-SPS endpoint, not the deprecated cross-source one."""
+    client = MagicMock()
+    client.get.return_value = _mock_response(
+        [_make_target_json(target_id=UUID(int=i + 1), name=f"t{i}") for i in range(3)]
+    )
+
+    api = SonarWizApi(client)
+    results = api.list_targets(_SPS_ID)
+
+    client.get.assert_called_once_with(
+        f"/api/v1/sidescan-ping-sources/{_SPS_ID}/targets"
+    )
+    assert len(results) == 3
+    assert {t.name for t in results} == {"t0", "t1", "t2"}
+
+
+def test_update_target_uses_patch_with_partial_body():
+    """update_target uses PATCH and serialises only the fields the caller set."""
+    from cti.model.target import TargetUpdate
+
+    client = MagicMock()
+    client.patch.return_value = _mock_response(_make_target_json(name="renamed"))
+
+    api = SonarWizApi(client)
+    payload = TargetUpdate(name="renamed")
+    result = api.update_target(_TARGET_ID, payload)
+
+    client.patch.assert_called_once()
+    assert client.patch.call_args[0][0] == f"/api/v1/targets/{_TARGET_ID}"
+    sent = client.patch.call_args.kwargs["json"]
+    assert sent == {"name": "renamed"}
+    assert result.name == "renamed"
+
+
+def test_delete_target_returns_none_and_calls_delete():
+    """delete_target returns None after a successful DELETE."""
+    client = MagicMock()
+    delete_resp = MagicMock(spec=httpx.Response)
+    delete_resp.status_code = 204
+    delete_resp.raise_for_status.return_value = None
+    client.delete.return_value = delete_resp
+
+    api = SonarWizApi(client)
+    result = api.delete_target(_TARGET_ID)
+
+    client.delete.assert_called_once_with(f"/api/v1/targets/{_TARGET_ID}")
+    assert result is None
+
+
+def test_target_method_errors_propagate_via_raise_for_status():
+    """Server errors bubble up as httpx.HTTPStatusError via raise_for_status."""
+    client = MagicMock()
+    err_resp = MagicMock(spec=httpx.Response)
+    err_resp.status_code = 404
+    err_resp.raise_for_status.side_effect = httpx.HTTPStatusError(
+        "Not found", request=MagicMock(), response=err_resp
+    )
+    client.get.return_value = err_resp
+
+    api = SonarWizApi(client)
+    with pytest.raises(httpx.HTTPStatusError):
+        api.get_target(_TARGET_ID)