destiny_sdk 0.2.3__tar.gz → 0.3.0a0__tar.gz

{destiny_sdk-0.2.3 → destiny_sdk-0.3.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: destiny_sdk
-Version: 0.2.3
+Version: 0.3.0a0
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 Author-email: Adam Hamilton <adam@futureevidence.org>, Andrew Harvey <andrew@futureevidence.org>, Daniel Breves <daniel@futureevidence.org>, Jack Walmisley <jack@futureevidence.org>
 License-Expression: Apache-2.0

{destiny_sdk-0.2.3 → destiny_sdk-0.3.0a0}/pyproject.toml

@@ -33,7 +33,7 @@ license = "Apache-2.0"
 name = "destiny_sdk"
 readme = "README.md"
 requires-python = "~=3.12"
-version = "0.2.3"
+version = "0.3.0-alpha"
 
 [tool.pytest.ini_options]
 addopts = ["--color=yes", "--import-mode=importlib", "--verbose"]

{destiny_sdk-0.2.3 → destiny_sdk-0.3.0a0}/src/destiny_sdk/client.py

@@ -7,8 +7,6 @@ import httpx
 from pydantic import UUID4, HttpUrl
 
 from destiny_sdk.robots import (
-    BatchEnhancementRequestRead,
-    BatchRobotResult,
     EnhancementRequestRead,
     RobotResult,
 )
@@ -80,34 +78,14 @@ class Client:
 
         Signs the request with the client's secret key.
 
-        :param robot_result: The Robot Result to send
+        :param robot_result: The RobotResult to send
         :type robot_result: RobotResult
         :return: The EnhancementRequestRead object from the response.
         :rtype: EnhancementRequestRead
         """
         response = self.session.post(
-            f"/enhancement-requests/single-requests/{robot_result.request_id}/results/",
+            f"/enhancement-requests/{robot_result.request_id}/results/",
             json=robot_result.model_dump(mode="json"),
         )
         response.raise_for_status()
         return EnhancementRequestRead.model_validate(response.json())
-
-    def send_batch_robot_result(
-        self, batch_robot_result: BatchRobotResult
-    ) -> BatchEnhancementRequestRead:
-        """
-        Send a BatchRobotResult to destiny repository.
-
-        Signs the request with the client's secret key.
-
-        :param batch_robot_result: The Batch Robot Result to send
-        :type batch_robot_result: BatchRobotResult
-        :return: The BatchEnhancementRequestRead object from the response.
-        :rtype: BatchEnhancementRequestRead
-        """
-        response = self.session.post(
-            f"/enhancement-requests/batch-requests/{batch_robot_result.request_id}/results/",
-            json=batch_robot_result.model_dump(mode="json"),
-        )
-        response.raise_for_status()
-        return BatchEnhancementRequestRead.model_validate(response.json())

{destiny_sdk-0.2.3 → destiny_sdk-0.3.0a0}/src/destiny_sdk/robots.py

@@ -1,13 +1,12 @@
 """Schemas that define inputs/outputs for robots."""
 
 from enum import StrEnum, auto
-from typing import Annotated, Any, Self
+from typing import Annotated, Any
 
-from pydantic import UUID4, BaseModel, ConfigDict, Field, HttpUrl, model_validator
+from pydantic import UUID4, BaseModel, ConfigDict, Field, HttpUrl
 
 from destiny_sdk.core import _JsonlFileInputMixIn
 from destiny_sdk.enhancements import Enhancement
-from destiny_sdk.references import Reference
 
 
 class RobotError(BaseModel):
@@ -37,29 +36,6 @@ class LinkedRobotError(_JsonlFileInputMixIn, RobotError):
 
 
 class RobotResult(BaseModel):
-    """The result of a robot request which is returned to the repo."""
-
-    request_id: UUID4
-    error: RobotError | None = Field(
-        default=None,
-        description="Error the robot encountered while creating enhancement.",
-    )
-    enhancement: Enhancement | None = Field(
-        default=None, description="An enhancement to create"
-    )
-
-    @model_validator(mode="after")
-    def validate_error_or_enhancement_set(self) -> Self:
-        """Validate that a robot result has either an error or an enhancement set."""
-        if (self.error is None) == (self.enhancement is None):
-            msg = """
-            exactly one of 'error' or 'enhancement' must be provided
-            """
-            raise ValueError(msg)
-        return self
-
-
-class BatchRobotResult(BaseModel):
     """Used to indicate to the repository that the robot has finished processing."""
 
     request_id: UUID4
@@ -67,7 +43,8 @@ class BatchRobotResult(BaseModel):
         default=None,
         description="""
 Error the robot encountered while creating enhancements. If this field is populated,
-we assume the entire batch or request failed, rather than an individual reference.
+we assume the entire enhancement request or http request request failed,
+rather than an individual reference.
 If there was an error with processing an individual reference, it should be passed in
 the result file and this field should be left as None. Vice-versa, if this field is
 None, the repository will assume that the result file is ready for processing.
@@ -75,14 +52,14 @@ None, the repository will assume that the result file is ready for processing.
     )
 
 
-class BatchRobotResultValidationEntry(_JsonlFileInputMixIn, BaseModel):
+class RobotResultValidationEntry(_JsonlFileInputMixIn, BaseModel):
     """A single entry in the validation result file for a batch enhancement request."""
 
     reference_id: UUID4 | None = Field(
         default=None,
         description=(
             "The ID of the reference which was enhanced. "
-            "If this is empty, the BatchEnhancementResultEntry could not be parsed."
+            "If this is empty, the EnhancementResultEntry could not be parsed."
         ),
     )
     error: str | None = Field(
@@ -94,30 +71,15 @@ class BatchRobotResultValidationEntry(_JsonlFileInputMixIn, BaseModel):
     )
 
 
-class RobotRequest(BaseModel):
-    """An enhancement request from the repo to a robot."""
-
-    id: UUID4
-    reference: Reference = Field(
-        description=(
-            "Reference to be enhanced, includes identifiers and existing enhancments."
-        )
-    )
-    extra_fields: dict | None = Field(
-        default=None,
-        description="Extra fields to pass to the robot. TBC.",
-    )
-
-
-#: The result for a single reference when processed by a batch enhancement request.
+#: The result for a single reference when processed by an enhancement request.
 #: This is a single entry in the result file.
-BatchEnhancementResultEntry = Annotated[
+EnhancementResultEntry = Annotated[
     Enhancement | LinkedRobotError,
     Field(),
 ]
 
 
-class BatchRobotRequest(BaseModel):
+class RobotRequest(BaseModel):
     """A batch enhancement request from the repo to a robot."""
 
     id: UUID4
@@ -130,16 +92,16 @@ reference per line.
 Each reference may have identifiers or enhancements attached, as
 required by the robot.
 If the URL expires, a new one can be generated using
-``GET /references/enhancement/batch/<batch_request_id>``.
+``GET /enhancement-requests/{request_id}/``.
 """
     )
     result_storage_url: HttpUrl = Field(
         description="""
 The URL at which the set of enhancements are to be stored. The file is to be a jsonl
 with each line formatted according to
-:class:`BatchEnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.BatchEnhancementResultEntry>`.
+:class:`EnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry>`.
 If the URL expires, a new one can be generated using
-``GET /references/enhancement/batch/<batch_request_id>``.
+``GET /enhancement-requests/{request_id}/``.
 """  # noqa: E501
     )
     extra_fields: dict | None = Field(
@@ -152,64 +114,6 @@ class EnhancementRequestStatus(StrEnum):
     """
     The status of an enhancement request.
 
-    **Allowed values**:
-    - `received`: Enhancement request has been received.
-    - `accepted`: Enhancement request has been accepted.
-    - `rejected`: Enhancement request has been rejected.
-    - `failed`: Enhancement failed to create.
-    - `completed`: Enhancement has been created.
-    """
-
-    RECEIVED = auto()
-    ACCEPTED = auto()
-    REJECTED = auto()
-    FAILED = auto()
-    COMPLETED = auto()
-
-
-class _EnhancementRequestBase(BaseModel):
-    """
-    Base enhancement request class.
-
-    An enhancement request is a request to create an enhancement on a reference.
-    It contains the reference and the robot to be used to create the enhancement.
-    """
-
-    reference_id: UUID4 = Field(description="The ID of the reference to be enhanced.")
-    robot_id: UUID4 = Field(
-        description="The robot to be used to create the enhancement."
-    )
-    source: str | None = Field(
-        default=None,
-        description="The source of the batch enhancement request.",
-    )
-
-    enhancement_parameters: dict | None = Field(
-        default=None, description="Information needed to create the enhancement. TBC."
-    )
-
-
-class EnhancementRequestIn(_EnhancementRequestBase):
-    """The model for requesting an enhancement on specific reference."""
-
-
-class EnhancementRequestRead(_EnhancementRequestBase):
-    """Core enhancement request class."""
-
-    id: UUID4
-    request_status: EnhancementRequestStatus = Field(
-        description="The status of the request to create an enhancement",
-    )
-    error: str | None = Field(
-        default=None,
-        description="Error encountered during the enhancement process",
-    )
-
-
-class BatchEnhancementRequestStatus(StrEnum):
-    """
-    The status of an enhancement request.
-
     **Allowed values**:
     - `received`: Enhancement request has been received by the repo.
     - `accepted`: Enhancement request has been accepted by the robot.
@@ -233,11 +137,11 @@ class BatchEnhancementRequestStatus(StrEnum):
     COMPLETED = auto()
 
 
-class _BatchEnhancementRequestBase(BaseModel):
+class _EnhancementRequestBase(BaseModel):
     """
-    Base batch enhancement request class.
+    Base enhancement request class.
 
-    A batch enhancement request is a request to create multiple enhancements.
+    A enhancement request is a request to create one or more enhancements.
     """
 
     robot_id: UUID4 = Field(
@@ -252,15 +156,15 @@ class _BatchEnhancementRequestBase(BaseModel):
     )
 
 
-class BatchEnhancementRequestIn(_BatchEnhancementRequestBase):
+class EnhancementRequestIn(_EnhancementRequestBase):
     """The model for requesting multiple enhancements on specific references."""
 
 
-class BatchEnhancementRequestRead(_BatchEnhancementRequestBase):
+class EnhancementRequestRead(_EnhancementRequestBase):
     """Core batch enhancement request class."""
 
     id: UUID4
-    request_status: BatchEnhancementRequestStatus = Field(
+    request_status: EnhancementRequestStatus = Field(
         description="The status of the request to create enhancements",
     )
     reference_data_url: HttpUrl | None = Field(
@@ -273,7 +177,7 @@ formatted according to
 Each reference may have identifiers or enhancements attached, as
 required by the robot.
 If the URL expires, a new one can be generated using
-``GET /references/enhancement/batch/<batch_request_id>``.
+``GET /enhancement-requests/{request_id}/``.
         """,
     )
     result_storage_url: HttpUrl | None = Field(
@@ -281,26 +185,26 @@ If the URL expires, a new one can be generated using
         description="""
 The URL at which the set of enhancements are stored. The file is to be a jsonl
 with each line formatted according to
-:class:`BatchEnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.BatchEnhancementResultEntry>`.
+:class:`EnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry>`.
 This field is only relevant to robots.
 If the URL expires, a new one can be generated using
-``GET /references/enhancement/batch/<batch_request_id>``.
+``GET /enhancement-requests/{request_id}/``.
         """,  # noqa: E501
     )
     validation_result_url: HttpUrl | None = Field(
         default=None,
         description="""
-The URL at which the result of the batch enhancement request is stored.
+The URL at which the result of the enhancement request is stored.
 This file is a txt file, one line per reference, with either an error
 or a success message.
 If the URL expires, a new one can be generated using
-``GET /references/enhancement/batch/<batch_request_id>``.
+``GET /enhancement-requests/{request_id}/``.
         """,
     )
     error: str | None = Field(
         default=None,
         description="Error encountered during the enhancement process. This "
-        "is only used if the entire batch enhancement request failed, rather than an "
+        "is only used if the entire enhancement request failed, rather than an "
         "individual reference. If there was an error with processing an individual "
         "reference, it is passed in the validation result file.",
     )
@@ -317,8 +221,7 @@ class _RobotBase(BaseModel):
 
     name: str = Field(description="The name of the robot, must be unique.")
     base_url: HttpUrl = Field(
-        description="The base url of the robot. The robot must implement endpoints "
-        "base_url/single for the enhancement of single references and "
+        description="The base url of the robot. The robot must implement endpoint"
         "base_url/batch for batch enhancements of references.",
     )
     description: str = Field(

{destiny_sdk-0.2.3 → destiny_sdk-0.3.0a0}/tests/unit/test_client.py

@@ -24,11 +24,11 @@ def test_verify_hmac_headers_sent(httpx_mock: HTTPXMock, frozen_time) -> None:
     fake_destiny_repository_url = "https://www.destiny-repository-lives-here.co.au/v1"
 
     fake_robot_result = RobotResult(
-        request_id=uuid.uuid4(), error=RobotError(message="I can't fulfil this request")
+        request_id=uuid.uuid4(), error=RobotError(message="Cannot process this batch")
     )
 
     expected_response_body = EnhancementRequestRead(
-        reference_id=uuid.uuid4(),
+        reference_ids=[uuid.uuid4()],
         id=uuid.uuid4(),
         robot_id=uuid.uuid4(),
         request_status="failed",
@@ -43,7 +43,7 @@ def test_verify_hmac_headers_sent(httpx_mock: HTTPXMock, frozen_time) -> None:
 
     httpx_mock.add_response(
         url=fake_destiny_repository_url
-        + "/enhancement-requests/single-requests/"
+        + "/enhancement-requests/"
         + f"{fake_robot_result.request_id}/results/",
         method="POST",
         match_headers={

destiny_sdk-0.3.0a0/tests/unit/test_robots.py

@@ -0,0 +1,29 @@
+import uuid
+
+import destiny_sdk
+import pytest
+from pydantic import HttpUrl, ValidationError
+
+
+def test_provisioned_robot_valid():
+    provisioned_robot = destiny_sdk.robots.ProvisionedRobot(
+        id=uuid.uuid4(),
+        base_url=HttpUrl("https://www.domo-arigato-mr-robo.to"),
+        name="Mr. Roboto",
+        description="I have come to help you with your problems",
+        owner="Styx",
+        client_secret="secret, secret, I've got a secret",
+    )
+
+    assert provisioned_robot.owner == "Styx"
+
+
+def test_robot_models_reject_any_extra_fields():
+    with pytest.raises(ValidationError):
+        destiny_sdk.robots.Robot(
+            base_url=HttpUrl("https://www.domo-arigato-mr-robo.to"),
+            name="Mr. Roboto",
+            description="I have come to help you with your problems",
+            owner="Styx",
+            client_secret="I'm not allowed in this model",
+        )

{destiny_sdk-0.2.3 → destiny_sdk-0.3.0a0}/uv.lock

@@ -63,7 +63,7 @@ wheels = [
 
 [[package]]
 name = "destiny-sdk"
-version = "0.2.3"
+version = "0.3.0a0"
 source = { editable = "." }
 dependencies = [
     { name = "cachetools" },

destiny_sdk-0.2.3/tests/unit/test_robots.py

@@ -1,61 +0,0 @@
-import uuid
-
-import destiny_sdk
-import pytest
-from pydantic import HttpUrl, ValidationError
-
-
-def test_enhancement_request_valid():
-    enhancement_request = destiny_sdk.robots.EnhancementRequestRead(
-        id=uuid.uuid4(),
-        reference_id=uuid.uuid4(),
-        reference=destiny_sdk.references.Reference(
-            id=uuid.uuid4(), visibility=destiny_sdk.visibility.Visibility.RESTRICTED
-        ),
-        robot_id=uuid.uuid4(),
-        request_status=destiny_sdk.robots.EnhancementRequestStatus.RECEIVED,
-    )
-
-    assert (
-        enhancement_request.request_status
-        == destiny_sdk.robots.EnhancementRequestStatus.RECEIVED
-    )
-    assert enhancement_request.enhancement_parameters is None
-    assert enhancement_request.error is None
-
-
-def test_provisioned_robot_valid():
-    provisioned_robot = destiny_sdk.robots.ProvisionedRobot(
-        id=uuid.uuid4(),
-        base_url=HttpUrl("https://www.domo-arigato-mr-robo.to"),
-        name="Mr. Roboto",
-        description="I have come to help you with your problems",
-        owner="Styx",
-        client_secret="secret, secret, I've got a secret",
-    )
-
-    assert provisioned_robot.owner == "Styx"
-
-
-def test_robot_models_reject_any_extra_fields():
-    with pytest.raises(ValidationError):
-        destiny_sdk.robots.Robot(
-            base_url=HttpUrl("https://www.domo-arigato-mr-robo.to"),
-            name="Mr. Roboto",
-            description="I have come to help you with your problems",
-            owner="Styx",
-            client_secret="I'm not allowed in this model",
-        )
-
-
-def test_robot_request_does_not_require_extra_fields():
-    reference = destiny_sdk.references.Reference(
-        id=uuid.uuid4(), visibility=destiny_sdk.visibility.Visibility.RESTRICTED
-    )
-
-    # Don't pass any extra fields
-    robot_request = destiny_sdk.robots.RobotRequest(
-        id=uuid.uuid4(), reference=reference
-    )
-
-    assert not robot_request.extra_fields