SDK Robot Client

This documentation auto-generates details about the HMAC authentication and convenience methods provided by the SDK for robots.

Note

This document is about API authentication for robots. For anyone else, refer to OAuth and SDK Client.

Client

class libs.sdk.src.destiny_sdk.client.RobotClient(base_url: HttpUrl, secret_key: str, client_id: Annotated[UUID, UuidVersion(uuid_version=4)])

Client for interaction with the Destiny API.

Current implementation only supports robot results.

poll_robot_enhancement_batch(robot_id: Annotated[UUID, UuidVersion(uuid_version=4)], limit: int = 10, lease: str | None = None, timeout: int = 60) → RobotEnhancementBatch | None

Poll for a robot enhancement batch.

Signs the request with the client’s secret key.

Parameters:

• robot_id (UUID4) – The ID of the robot to poll for

• limit (int) – The maximum number of pending enhancements to return

• lease (str | None) – The duration to lease the pending enhancements for, in ISO 8601 duration format eg PT10M. If not provided the repository will use a default lease duration.

Returns:

The RobotEnhancementBatch object from the response, or None if no batches available

Return type:

destiny_sdk.robots.RobotEnhancementBatch | None

renew_robot_enhancement_batch_lease(robot_enhancement_batch_id: Annotated[UUID, UuidVersion(uuid_version=4)], lease_duration: str | None = None) → None

Renew the lease for a robot enhancement batch.

Signs the request with the client’s secret key.

Parameters:

• robot_enhancement_batch_id (UUID4) – The ID of the robot enhancement batch

• lease_duration (str | None) – The duration to lease the pending enhancements for, in ISO 8601 duration format eg PT10M. If not provided the repository will use a default lease duration.

send_robot_enhancement_batch_result(robot_enhancement_batch_result: RobotEnhancementBatchResult) → RobotEnhancementBatchRead

Send a RobotEnhancementBatchResult to destiny repository.

Signs the request with the client’s secret key.

Parameters:

robot_enhancement_batch_result (RobotEnhancementBatchResult) – The RobotEnhancementBatchResult to send

Returns:

The RobotEnhancementBatchRead object from the response.

Return type:

RobotEnhancementBatchRead

send_robot_result(robot_result: RobotResult) → EnhancementRequestRead

Send a RobotResult to destiny repository.

Signs the request with the client’s secret key.

Parameters:

robot_result (RobotResult) – The RobotResult to send

Returns:

The EnhancementRequestRead object from the response.

Return type:

EnhancementRequestRead

HMAC Authentication

The client will apply HMAC authentication automatically, but if you need to access the authentication itself you can access the below directly:

HMAC authentication assistance methods.

exception libs.sdk.src.destiny_sdk.auth.AuthException(status_code: Annotated[int, Doc('\n                HTTP status code to send to the client.\n                ')], detail: Annotated[Any, Doc('\n                Any data to be sent to the client in the `detail` key of the JSON\n                response.\n                ')] = None, headers: Annotated[Dict[str, str] | None, Doc('\n                Any headers to send to the client in the response.\n                ')] = None)

An exception related to HTTP authentication.

Raised by implementations of the AuthMethod protocol.

raise AuthException(
    status_code=status.HTTP_401_UNAUTHORIZED,
    detail="Unable to parse authentication token.",
)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class libs.sdk.src.destiny_sdk.auth.BypassHMACAuth(*args, **kwargs)

A fake auth class that will always respond successfully.

Intended for use in local environments and for testing.

Not for production use!

class libs.sdk.src.destiny_sdk.auth.HMACAuth(secret_key: str)

Adds HMAC auth when used as a router or endpoint dependency.

class libs.sdk.src.destiny_sdk.auth.HMACAuthMethod(*args, **kwargs)

Protocol for HMAC auth methods, enforcing the implmentation of __call__().

This allows FastAPI to call class instances as depenedencies in FastAPI routes, see https://fastapi.tiangolo.com/advanced/advanced-dependencies

auth = HMACAuthMethod()

router = APIRouter(
    prefix="/robots", tags=["robot"], dependencies=[Depends(auth)]
)

pydantic model libs.sdk.src.destiny_sdk.auth.HMACAuthorizationHeaders

The HTTP authorization headers required for HMAC authentication.

Expects the following headers to be present in the request

• Authorization: Signature [request signature]

• X-Client-Id: [UUID]

• X-Request-Timestamp: [float]

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "HMACAuthorizationHeaders",
   "description": "The HTTP authorization headers required for HMAC authentication.\n\nExpects the following headers to be present in the request\n\n- Authorization: Signature [request signature]\n- X-Client-Id: [UUID]\n- X-Request-Timestamp: [float]",
   "type": "object",
   "properties": {
      "signature": {
         "title": "Signature",
         "type": "string"
      },
      "client_id": {
         "format": "uuid4",
         "title": "Client Id",
         "type": "string"
      },
      "timestamp": {
         "title": "Timestamp",
         "type": "number"
      }
   },
   "required": [
      "signature",
      "client_id",
      "timestamp"
   ]
}

Fields:

• client_id (uuid.UUID)

• signature (str)

• timestamp (float)

field client_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

field signature: str [Required]

field timestamp: float [Required]

classmethod from_request(request: Request) → Self

Get the required headers for HMAC authentication.

Parameters:

request (Request) – The incoming request

Raises:

• AuthException – Authorization header is missing

• AuthException – Authorization type not supported

• AuthException – X-Client-Id header is missing

• AuthException – Client id format is invalid

• AuthException – X-Request-Timestamp header is missing

• AuthException – Request timestamp has expired

Returns:

Header values necessary for authenticating the request

Return type:

HMACAuthorizationHeaders

libs.sdk.src.destiny_sdk.auth.create_signature(secret_key: str, request_body: bytes, client_id: Annotated[UUID, UuidVersion(uuid_version=4)], timestamp: float) → str

Create an HMAC signature using SHA256.

Parameters:

• secret_key (bytes) – secret key with which to encrypt message

• request_body (bytes) – request body to be encrypted

• client_id – client id to include in hmac

• timestamp – timestamp for when the request is sent

Type:

UUID4

Type:

float

Returns:

encrypted hexdigest of the request body with the secret key

Return type:

str