clarity-api-sdk-python 0.3.35__tar.gz → 0.3.36__tar.gz

{clarity_api_sdk_python-0.3.35 → clarity_api_sdk_python-0.3.36}/PKG-INFO

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

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

{clarity_api_sdk_python-0.3.35 → clarity_api_sdk_python-0.3.36}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.35
+Version: 0.3.36
 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.3.35 → clarity_api_sdk_python-0.3.36}/src/cti/cli/main.py

@@ -21,6 +21,9 @@ app = typer.Typer(
 list_app = typer.Typer(help="List resources (surveys, projects, jobs).", no_args_is_help=True)
 app.add_typer(list_app, name="list")
 
+delete_app = typer.Typer(help="Delete resources (rawfile, survey, project).", no_args_is_help=True)
+app.add_typer(delete_app, name="delete")
+
 
 def _output(data: dict, as_json: bool) -> None:
     """Print output as JSON or human-readable."""
@@ -453,6 +456,53 @@ def list_jobs(
             typer.echo(f"  {j.job_id}  {j.status}  {j.job_type}  {j.created_at}")
 
 
+def _delete_resource(path: str, resource_label: str, resource_id: UUID, yes: bool) -> None:
+    """Confirm and DELETE a resource by its API path. Exits non-zero on error."""
+    if not yes and not typer.confirm(f"Delete {resource_label} {resource_id}?"):
+        typer.echo("Aborted.")
+        raise typer.Exit(1)
+
+    api = get_api()
+    try:
+        response = api._client.delete(path)
+        response.raise_for_status()
+    except httpx.HTTPStatusError as e:
+        if e.response.status_code == 404:
+            typer.echo(f"Error: {resource_label} {resource_id} not found.", err=True)
+        else:
+            typer.echo(f"Error: {_get_error_detail(e)}", err=True)
+        raise typer.Exit(1)
+
+    typer.echo(f"Deleted {resource_label} {resource_id}.")
+
+
+@delete_app.command("rawfile")
+def delete_rawfile(
+    raw_file_id: UUID = typer.Argument(..., help="Raw file ID"),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
+) -> None:
+    """Delete a raw file."""
+    _delete_resource(f"/api/v1/rawfiles/{raw_file_id}", "rawfile", raw_file_id, yes)
+
+
+@delete_app.command("survey")
+def delete_survey(
+    survey_id: UUID = typer.Argument(..., help="Survey ID"),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
+) -> None:
+    """Delete a survey."""
+    _delete_resource(f"/api/v1/surveys/{survey_id}", "survey", survey_id, yes)
+
+
+@delete_app.command("project")
+def delete_project(
+    project_id: UUID = typer.Argument(..., help="Project ID"),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
+) -> None:
+    """Delete a project."""
+    _delete_resource(f"/api/v1/projects/{project_id}", "project", project_id, yes)
+
+
 def main() -> None:
     """Entry point for the ftm CLI."""
     app()

{clarity_api_sdk_python-0.3.35 → clarity_api_sdk_python-0.3.36}/src/cti/model/processing_log.py

@@ -17,6 +17,9 @@ class ProcessingLogBase(BaseModel):
         end_timestamp: End timestamp of processing.
         status: Status of the processing step.
         error_details: Error details if processing failed.
+        result: Processing step result payload (e.g., stream manifest JSON
+            for scan steps); opaque string.
+        processing_hash: Content-addressable cache key (SHA-256 hex digest).
     """
 
     processing_step: str
@@ -26,6 +29,8 @@ class ProcessingLogBase(BaseModel):
     end_timestamp: datetime
     status: str
     error_details: str | None = None
+    result: str | None = None
+    processing_hash: str
 
 
 class ProcessingLogCreate(ProcessingLogBase):
@@ -33,11 +38,11 @@ class ProcessingLogCreate(ProcessingLogBase):
 
     Attributes:
         survey_id: Foreign key reference to Survey.
-        source_id: Foreign key reference to Source.
+        raw_file_id: Foreign key reference to RawFile.
     """
 
     survey_id: UUID
-    source_id: UUID
+    raw_file_id: UUID
 
 
 class ProcessingLogUpdate(ProcessingLogBase):
@@ -51,6 +56,8 @@ class ProcessingLogUpdate(ProcessingLogBase):
         end_timestamp: End timestamp of processing.
         status: Status of the processing step.
         error_details: Error details if processing failed.
+        result: Processing step result payload.
+        processing_hash: Content-addressable cache key.
     """
 
 
@@ -60,11 +67,11 @@ class ProcessingLog(ProcessingLogBase):
     Attributes:
         processing_log_id: Unique identifier for the processing log.
         survey_id: Foreign key reference to Survey.
-        source_id: Foreign key reference to Source.
+        raw_file_id: Foreign key reference to RawFile.
     """
 
     processing_log_id: UUID
     survey_id: UUID
-    source_id: UUID
+    raw_file_id: UUID
 
     model_config = ConfigDict(from_attributes=True)

{clarity_api_sdk_python-0.3.35 → clarity_api_sdk_python-0.3.36}/tests/test_cli.py

@@ -469,6 +469,89 @@ class TestListProjectsCommand:
         assert "No projects found" in result.output
 
 
+class TestDeleteCommand:
+    """Tests for `ftm delete rawfile|survey|project`."""
+
+    def _mock_delete_response(self, status_code: int = 204):
+        resp = MagicMock()
+        resp.status_code = status_code
+        if status_code >= 400:
+            import httpx as _httpx
+            resp.raise_for_status.side_effect = _httpx.HTTPStatusError(
+                "error", request=MagicMock(), response=resp,
+            )
+            resp.headers = {"content-type": "application/json"}
+            resp.json.return_value = {"detail": "boom"}
+        return resp
+
+    def test_delete_rawfile_with_yes(self):
+        """delete rawfile -y skips confirmation and calls DELETE."""
+        mock_api = MagicMock()
+        mock_api._client.delete.return_value = self._mock_delete_response(204)
+
+        with patch("cti.cli.main.get_api", return_value=mock_api):
+            result = runner.invoke(app, ["delete", "rawfile", str(RAW_FILE_ID), "--yes"])
+
+        assert result.exit_code == 0
+        assert f"Deleted rawfile {RAW_FILE_ID}" in result.output
+        mock_api._client.delete.assert_called_once_with(f"/api/v1/rawfiles/{RAW_FILE_ID}")
+
+    def test_delete_survey_with_yes(self):
+        """delete survey -y calls the surveys endpoint."""
+        mock_api = MagicMock()
+        mock_api._client.delete.return_value = self._mock_delete_response(204)
+
+        with patch("cti.cli.main.get_api", return_value=mock_api):
+            result = runner.invoke(app, ["delete", "survey", str(SURVEY_ID), "-y"])
+
+        assert result.exit_code == 0
+        mock_api._client.delete.assert_called_once_with(f"/api/v1/surveys/{SURVEY_ID}")
+
+    def test_delete_project_with_yes(self):
+        """delete project -y calls the projects endpoint."""
+        mock_api = MagicMock()
+        mock_api._client.delete.return_value = self._mock_delete_response(204)
+
+        with patch("cti.cli.main.get_api", return_value=mock_api):
+            result = runner.invoke(app, ["delete", "project", str(PROJECT_ID), "-y"])
+
+        assert result.exit_code == 0
+        mock_api._client.delete.assert_called_once_with(f"/api/v1/projects/{PROJECT_ID}")
+
+    def test_delete_confirmation_abort(self):
+        """delete without --yes aborts on 'n' confirmation and does not call API."""
+        mock_api = MagicMock()
+
+        with patch("cti.cli.main.get_api", return_value=mock_api):
+            result = runner.invoke(app, ["delete", "rawfile", str(RAW_FILE_ID)], input="n\n")
+
+        assert result.exit_code == 1
+        assert "Aborted" in result.output
+        mock_api._client.delete.assert_not_called()
+
+    def test_delete_confirmation_confirm(self):
+        """delete without --yes proceeds on 'y' confirmation."""
+        mock_api = MagicMock()
+        mock_api._client.delete.return_value = self._mock_delete_response(204)
+
+        with patch("cti.cli.main.get_api", return_value=mock_api):
+            result = runner.invoke(app, ["delete", "rawfile", str(RAW_FILE_ID)], input="y\n")
+
+        assert result.exit_code == 0
+        mock_api._client.delete.assert_called_once()
+
+    def test_delete_not_found(self):
+        """delete exits 1 with 'not found' message on 404."""
+        mock_api = MagicMock()
+        mock_api._client.delete.return_value = self._mock_delete_response(404)
+
+        with patch("cti.cli.main.get_api", return_value=mock_api):
+            result = runner.invoke(app, ["delete", "rawfile", str(RAW_FILE_ID), "-y"])
+
+        assert result.exit_code == 1
+        assert "not found" in result.output
+
+
 class TestListJobsCommand:
     """Tests for `ftm list jobs`."""