feat: add DocumentReference, SnapshotImage, PatientIdentificationCard, and related models (#1481)

Author: beaugunderson

.claude/settings.json

@@ -0,0 +1,5 @@
+{
+  "additionalDirectories": [
+    "../canvas/home-app"
+  ]
+}

canvas_sdk/tests/data/test_utils.py

@@ -3,8 +3,9 @@
 from unittest.mock import MagicMock, patch
 
 import pytest
+from pytest_django.fixtures import SettingsWrapper
 
-from canvas_sdk.v1.data.utils import generate_mrn, quantize
+from canvas_sdk.v1.data.utils import generate_mrn, presigned_url, quantize
 
 
 @pytest.mark.parametrize(
@@ -93,3 +94,59 @@ def test_raises_runtime_error_after_max_attempts(mock_patient: MagicMock) -> Non
         generate_mrn()
 
     assert mock_patient.objects.filter.call_count == 100
+
+
+def test_presigned_url_generates_valid_url(settings: SettingsWrapper) -> None:
+    """Test that presigned_url generates a valid URL with expected components."""
+    settings.AWS_ACCESS_KEY_ID = "test-access-key"
+    settings.AWS_SECRET_ACCESS_KEY = "test-secret-key"
+    settings.MEDIA_S3_BUCKET_NAME = "test-bucket"
+    settings.AWS_REGION = "us-west-2"
+
+    url = presigned_url("path/to/file.pdf")
+
+    assert url.startswith("https://test-bucket.s3.us-west-2.amazonaws.com/")
+    assert "/path/to/file.pdf?" in url
+    assert "X-Amz-Algorithm=AWS4-HMAC-SHA256" in url
+    assert "X-Amz-Credential=" in url
+    assert "X-Amz-Date=" in url
+    assert "X-Amz-Expires=3600" in url
+    assert "X-Amz-SignedHeaders=host" in url
+    assert "X-Amz-Signature=" in url
+
+
+def test_presigned_url_with_custom_expiry(settings: SettingsWrapper) -> None:
+    """Test that presigned_url respects custom expiry time."""
+    settings.AWS_ACCESS_KEY_ID = "test-access-key"
+    settings.AWS_SECRET_ACCESS_KEY = "test-secret-key"
+    settings.MEDIA_S3_BUCKET_NAME = "test-bucket"
+    settings.AWS_REGION = "us-west-2"
+
+    url = presigned_url("path/to/file.pdf", expires_in=7200)
+
+    assert "X-Amz-Expires=7200" in url
+
+
+def test_presigned_url_removes_bucket_prefix(settings: SettingsWrapper) -> None:
+    """Test that presigned_url removes bucket prefix from key."""
+    settings.AWS_ACCESS_KEY_ID = "test-access-key"
+    settings.AWS_SECRET_ACCESS_KEY = "test-secret-key"
+    settings.MEDIA_S3_BUCKET_NAME = "test-bucket"
+    settings.AWS_REGION = "us-west-2"
+
+    url = presigned_url("test-bucket/path/to/file.pdf")
+
+    # The bucket prefix should be removed, so path should be /path/to/file.pdf
+    assert "/path/to/file.pdf?" in url
+    assert "/test-bucket/path/to/file.pdf?" not in url
+
+
+def test_presigned_url_raises_error_without_credentials(settings: SettingsWrapper) -> None:
+    """Test that presigned_url raises ValueError when AWS credentials are missing."""
+    settings.AWS_ACCESS_KEY_ID = ""
+    settings.AWS_SECRET_ACCESS_KEY = ""
+    settings.MEDIA_S3_BUCKET_NAME = "test-bucket"
+    settings.AWS_REGION = "us-west-2"
+
+    with pytest.raises(ValueError, match="AWS credentials not configured"):
+        presigned_url("path/to/file.pdf")

canvas_sdk/tests/v1/data/test_document_reference.py

@@ -0,0 +1,43 @@
+from unittest.mock import patch
+
+from canvas_sdk.v1.data.document_reference import DocumentReference
+
+
+def test_document_url_with_document() -> None:
+    """document_url returns a presigned URL when document is set."""
+    doc_ref = DocumentReference()
+    doc_ref.document = "some/key.pdf"
+    doc_ref.document_absolute_url = "https://example.com/fallback.pdf"
+
+    with patch(
+        "canvas_sdk.v1.data.document_reference.presigned_url",
+        return_value="https://s3.example.com/presigned",
+    ) as mock:
+        assert doc_ref.document_url == "https://s3.example.com/presigned"
+        mock.assert_called_once_with("some/key.pdf")
+
+
+def test_document_url_falls_back_to_absolute_url() -> None:
+    """document_url returns document_absolute_url when document is empty."""
+    doc_ref = DocumentReference()
+    doc_ref.document = ""
+    doc_ref.document_absolute_url = "https://example.com/fallback.pdf"
+
+    assert doc_ref.document_url == "https://example.com/fallback.pdf"
+
+
+def test_document_url_returns_none_when_both_empty() -> None:
+    """document_url returns None when both document and document_absolute_url are empty."""
+    doc_ref = DocumentReference()
+    doc_ref.document = ""
+    doc_ref.document_absolute_url = None
+
+    assert doc_ref.document_url is None
+
+
+def test_document_reference_str() -> None:
+    """__str__ returns a readable representation."""
+    doc_ref = DocumentReference()
+    doc_ref.id = "abc123"
+
+    assert str(doc_ref) == "DocumentReference(id=abc123)"

canvas_sdk/tests/v1/data/test_message.py

@@ -0,0 +1,24 @@
+from unittest.mock import patch
+
+from canvas_sdk.v1.data.message import MessageAttachment
+
+
+def test_file_url_with_file() -> None:
+    """file_url returns a presigned URL when file is set."""
+    attachment = MessageAttachment()
+    attachment.file = "attachments/doc.pdf"
+
+    with patch(
+        "canvas_sdk.v1.data.message.presigned_url",
+        return_value="https://s3.example.com/presigned",
+    ) as mock:
+        assert attachment.file_url == "https://s3.example.com/presigned"
+        mock.assert_called_once_with("attachments/doc.pdf")
+
+
+def test_file_url_without_file() -> None:
+    """file_url returns None when file is empty."""
+    attachment = MessageAttachment()
+    attachment.file = ""
+
+    assert attachment.file_url is None

canvas_sdk/tests/v1/data/test_patient.py

@@ -1,6 +1,8 @@
+from unittest.mock import patch
+
 import pytest
 
-from canvas_sdk.v1.data.patient import PatientMetadata
+from canvas_sdk.v1.data.patient import PatientIdentificationCard, PatientMetadata
 
 
 @pytest.mark.django_db
@@ -13,3 +15,33 @@ def test_patient_metadata_supports_large_values() -> None:
 
     assert metadata.value == large_value
     assert len(metadata.value) == 1000
+
+
+def test_patient_identification_card_str() -> None:
+    """__str__ returns a readable representation."""
+    card = PatientIdentificationCard()
+    card.dbid = 5
+    card.title = "Driver License"
+
+    assert str(card) == "PatientIdentificationCard(dbid=5, title=Driver License)"
+
+
+def test_patient_identification_card_image_url_with_image() -> None:
+    """image_url returns a presigned URL when image is set."""
+    card = PatientIdentificationCard()
+    card.image = "id_cards/front.jpg"
+
+    with patch(
+        "canvas_sdk.v1.data.patient.presigned_url",
+        return_value="https://s3.example.com/presigned",
+    ) as mock:
+        assert card.image_url == "https://s3.example.com/presigned"
+        mock.assert_called_once_with("id_cards/front.jpg")
+
+
+def test_patient_identification_card_image_url_without_image() -> None:
+    """image_url returns None when image is empty."""
+    card = PatientIdentificationCard()
+    card.image = ""
+
+    assert card.image_url is None

canvas_sdk/tests/v1/data/test_snapshot.py

@@ -0,0 +1,43 @@
+from unittest.mock import patch
+
+from canvas_sdk.v1.data.snapshot import Snapshot, SnapshotImage
+
+
+def test_snapshot_str() -> None:
+    """__str__ returns a readable representation."""
+    snapshot = Snapshot()
+    snapshot.dbid = 42
+    snapshot.title = "Front view"
+
+    assert str(snapshot) == "Snapshot(dbid=42, title=Front view)"
+
+
+def test_snapshot_image_str() -> None:
+    """__str__ returns a readable representation."""
+    image = SnapshotImage()
+    image.dbid = 7
+    image.title = "Left side"
+    image.tag = "wound"
+
+    assert str(image) == "SnapshotImage(dbid=7, title=Left side, tag=wound)"
+
+
+def test_snapshot_image_url_with_image() -> None:
+    """image_url returns a presigned URL when image is set."""
+    image = SnapshotImage()
+    image.image = "snapshots/img.jpg"
+
+    with patch(
+        "canvas_sdk.v1.data.snapshot.presigned_url",
+        return_value="https://s3.example.com/presigned",
+    ) as mock:
+        assert image.image_url == "https://s3.example.com/presigned"
+        mock.assert_called_once_with("snapshots/img.jpg")
+
+
+def test_snapshot_image_url_without_image() -> None:
+    """image_url returns None when image is empty."""
+    image = SnapshotImage()
+    image.image = ""
+
+    assert image.image_url is None

canvas_sdk/v1/data/__init__.py

@@ -35,6 +35,12 @@
 from .detected_issue import DetectedIssue, DetectedIssueEvidence
 from .device import Device
 from .discount import Discount
+from .document_reference import (
+    DocumentReference,
+    DocumentReferenceCategory,
+    DocumentReferenceCoding,
+    DocumentReferenceStatus,
+)
 from .encounter import Encounter
 from .external_event import ExternalEvent, ExternalVisit
 from .facility import Facility
@@ -108,6 +114,7 @@
     PatientContactPoint,
     PatientExternalIdentifier,
     PatientFacilityAddress,
+    PatientIdentificationCard,
     PatientMetadata,
     PatientSetting,
 )
@@ -147,6 +154,7 @@
 from .reason_for_visit import ReasonForVisitSettingCoding
 from .referral import Referral, ReferralReport, ReferralReview
 from .service_provider import ServiceProvider
+from .snapshot import Snapshot, SnapshotImage
 from .specialty_report_template import (
     SpecialtyReportTemplate,
     SpecialtyReportTemplateField,
@@ -209,6 +217,10 @@
     "DetectedIssueEvidence",
     "Device",
     "Discount",
+    "DocumentReference",
+    "DocumentReferenceCategory",
+    "DocumentReferenceCoding",
+    "DocumentReferenceStatus",
     "EligibilitySummary",
     "Encounter",
     "Event",
@@ -285,6 +297,7 @@
     "PatientContactPoint",
     "PatientExternalIdentifier",
     "PatientFacilityAddress",
+    "PatientIdentificationCard",
     "PatientPosting",
     "PatientSetting",
     "PatientMetadata",
@@ -315,6 +328,8 @@
     "SpecialtyReportTemplate",
     "SpecialtyReportTemplateField",
     "SpecialtyReportTemplateFieldOption",
+    "Snapshot",
+    "SnapshotImage",
     "Staff",
     "StaffAddress",
     "StaffLicense",