canvas 0.1.15__py3-none-any.whl → 0.2.10__py3-none-any.whl

canvas_sdk/commands/tests/{tests.py → unit/tests.py}

@@ -1,11 +1,7 @@
-import decimal
-from datetime import datetime
-
 import pytest
-import requests
 from pydantic import ValidationError
+from typer.testing import CliRunner
 
-import settings
 from canvas_sdk.commands import (
     AssessCommand,
     DiagnoseCommand,
@@ -19,15 +15,16 @@ from canvas_sdk.commands import (
     StopMedicationCommand,
     UpdateGoalCommand,
 )
-from canvas_sdk.commands.constants import Coding
+from canvas_sdk.commands.base import _BaseCommand
 from canvas_sdk.commands.tests.test_utils import (
-    MaskedValue,
     fake,
     get_field_type,
     raises_none_error_for_effect_method,
     raises_wrong_type_error,
 )
 
+runner = CliRunner()
+
 
 @pytest.mark.parametrize(
     "Command,fields_to_test",
@@ -50,7 +47,7 @@ from canvas_sdk.commands.tests.test_utils import (
         ),
         (HistoryOfPresentIllnessCommand, ("narrative",)),
         (MedicationStatementCommand, ("fdb_code", "sig")),
-        (PlanCommand, ("narrative", "user_id", "command_uuid")),
+        (PlanCommand, ("narrative", "command_uuid")),
         (
             PrescribeCommand,
             (
@@ -82,19 +79,7 @@ from canvas_sdk.commands.tests.test_utils import (
     ],
 )
 def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
-    Command: (
-        AssessCommand
-        | DiagnoseCommand
-        | GoalCommand
-        | HistoryOfPresentIllnessCommand
-        | MedicationStatementCommand
-        | PlanCommand
-        | PrescribeCommand
-        | QuestionnaireCommand
-        | ReasonForVisitCommand
-        | StopMedicationCommand
-        | UpdateGoalCommand
-    ),
+    Command: _BaseCommand,
     fields_to_test: tuple[str],
 ) -> None:
     for field in fields_to_test:
@@ -109,29 +94,22 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
     [
         (
             PlanCommand,
-            {"narrative": "yo", "user_id": 5, "note_uuid": 1},
+            {"narrative": "yo", "note_uuid": 1},
             "1 validation error for PlanCommand\nnote_uuid\n  Input should be a valid string [type=string_type",
-            {"narrative": "yo", "note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"narrative": "yo", "note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             PlanCommand,
-            {"narrative": "yo", "user_id": 5, "note_uuid": "5", "command_uuid": 5},
+            {"narrative": "yo", "note_uuid": "5", "command_uuid": 5},
             "1 validation error for PlanCommand\ncommand_uuid\n  Input should be a valid string [type=string_type",
-            {"narrative": "yo", "user_id": 5, "note_uuid": "5", "command_uuid": "5"},
-        ),
-        (
-            PlanCommand,
-            {"narrative": "yo", "note_uuid": "5", "command_uuid": "4", "user_id": "5"},
-            "1 validation error for PlanCommand\nuser_id\n  Input should be a valid integer [type=int_type",
-            {"narrative": "yo", "note_uuid": "5", "command_uuid": "4", "user_id": 5},
+            {"narrative": "yo", "note_uuid": "5", "command_uuid": "5"},
         ),
         (
             ReasonForVisitCommand,
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1, "structured": True},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000", "structured": True},
             "1 validation error for ReasonForVisitCommand\n  Structured RFV should have a coding",
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "structured": False,
             },
         ),
@@ -139,71 +117,64 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"code": "x"},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.system\n  Field required [type=missing",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"code": 1, "system": "y"},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.code\n  Input should be a valid string [type=string_type",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"code": None, "system": "y"},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.code\n  Input should be a valid string [type=string_type",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"system": "y"},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.code\n  Field required [type=missing",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"code": "x", "system": 1},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.system\n  Input should be a valid string [type=string_type",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"code": "x", "system": None},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.system\n  Input should be a valid string [type=string_type",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             ReasonForVisitCommand,
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
-                "user_id": 1,
                 "coding": {"code": "x", "system": "y", "display": 1},
             },
             "1 validation error for ReasonForVisitCommand\ncoding.display\n  Input should be a valid string [type=string_type",
-            {"note_uuid": "00000000-0000-0000-0000-000000000000", "user_id": 1},
+            {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
     ],
 )
@@ -251,7 +222,7 @@ def test_command_raises_specific_error_when_kwarg_given_incorrect_type(
         ),
         (HistoryOfPresentIllnessCommand, ("narrative",)),
         (MedicationStatementCommand, ("fdb_code", "sig")),
-        (PlanCommand, ("narrative", "user_id", "command_uuid", "note_uuid")),
+        (PlanCommand, ("narrative", "command_uuid", "note_uuid")),
         (
             PrescribeCommand,
             (
@@ -284,19 +255,7 @@ def test_command_raises_specific_error_when_kwarg_given_incorrect_type(
     ],
 )
 def test_command_allows_kwarg_with_correct_type(
-    Command: (
-        AssessCommand
-        | DiagnoseCommand
-        | GoalCommand
-        | HistoryOfPresentIllnessCommand
-        | MedicationStatementCommand
-        | PlanCommand
-        | PrescribeCommand
-        | QuestionnaireCommand
-        | ReasonForVisitCommand
-        | StopMedicationCommand
-        | UpdateGoalCommand
-    ),
+    Command: _BaseCommand,
     fields_to_test: tuple[str],
 ) -> None:
     schema = Command.model_json_schema()
@@ -323,136 +282,3 @@ def test_command_allows_kwarg_with_correct_type(
         cmd = Command(**base)
         effect = getattr(cmd, method)()
         assert effect is not None
-
-
-@pytest.fixture(scope="session")
-def token() -> MaskedValue:
-    return MaskedValue(
-        requests.post(
-            f"{settings.INTEGRATION_TEST_URL}/auth/token/",
-            headers={"Content-Type": "application/x-www-form-urlencoded"},
-            data={
-                "grant_type": "client_credentials",
-                "client_id": settings.INTEGRATION_TEST_CLIENT_ID,
-                "client_secret": settings.INTEGRATION_TEST_CLIENT_SECRET,
-            },
-        ).json()["access_token"]
-    )
-
-
-@pytest.fixture
-def note_uuid(token: MaskedValue) -> str:
-    headers = {
-        "Authorization": f"Bearer {token.value}",
-        "Content-Type": "application/json",
-        "Accept": "application/json",
-    }
-    data = {
-        "patient": 1,
-        "provider": 1,
-        "note_type": "office",
-        "note_type_version": 1,
-        "lastModifiedBySessionKey": "8fee3c03a525cebee1d8a6b8e63dd4dg",
-    }
-    note = requests.post(
-        f"{settings.INTEGRATION_TEST_URL}/api/Note/", headers=headers, json=data
-    ).json()
-    return note["externallyExposableId"]
-
-
-@pytest.fixture
-def command_type_map() -> dict[str, type]:
-    return {
-        "AutocompleteField": str,
-        "MultiLineTextField": str,
-        "TextField": str,
-        "ChoiceField": str,
-        "DateField": datetime,
-        "ApproximateDateField": datetime,
-        "IntegerField": int,
-        "DecimalField": decimal.Decimal,
-    }
-
-
-@pytest.mark.integtest
-@pytest.mark.parametrize(
-    "Command",
-    [
-        (AssessCommand),
-        (DiagnoseCommand),
-        (GoalCommand),
-        (HistoryOfPresentIllnessCommand),
-        (MedicationStatementCommand),
-        (PlanCommand),
-        (PrescribeCommand),
-        (QuestionnaireCommand),
-        (ReasonForVisitCommand),
-        (StopMedicationCommand),
-        (UpdateGoalCommand),
-    ],
-)
-def test_command_schema_matches_command_api(
-    token: MaskedValue,
-    command_type_map: dict[str, str],
-    note_uuid: str,
-    Command: (
-        AssessCommand
-        | DiagnoseCommand
-        | GoalCommand
-        | HistoryOfPresentIllnessCommand
-        | MedicationStatementCommand
-        | PlanCommand
-        | PrescribeCommand
-        | QuestionnaireCommand
-        | ReasonForVisitCommand
-        | StopMedicationCommand
-        | UpdateGoalCommand
-    ),
-) -> None:
-    # first create the command in the new note
-    data = {"noteKey": note_uuid, "schemaKey": Command.Meta.key}
-    headers = {"Authorization": f"Bearer {token.value}"}
-    url = f"{settings.INTEGRATION_TEST_URL}/core/api/v1/commands/"
-    command_resp = requests.post(url, headers=headers, data=data).json()
-    assert "uuid" in command_resp
-    command_uuid = command_resp["uuid"]
-
-    # next, request the fields of the newly created command
-    url = f"{settings.INTEGRATION_TEST_URL}/core/api/v1/commands/{command_uuid}/fields/"
-    command_fields_resp = requests.get(url, headers=headers).json()
-    assert command_fields_resp["schema"] == Command.Meta.key
-
-    command_fields = command_fields_resp["fields"]
-    if Command.Meta.key == "questionnaire":
-        # questionnaire's fields vary per questionnaire, so just check the first two fields which never vary
-        command_fields = command_fields[:2]
-    expected_fields = Command.command_schema()
-    assert len(command_fields) == len(expected_fields)
-
-    for actual_field in command_fields:
-        name = actual_field["name"]
-        assert name in expected_fields
-        expected_field = expected_fields[name]
-
-        assert expected_field["required"] == actual_field["required"]
-
-        expected_type = expected_field["type"]
-        if expected_type is Coding:
-            expected_type = expected_type.__annotations__["code"]
-
-        actual_type = command_type_map.get(actual_field["type"])
-        if actual_field["type"] == "AutocompleteField" and name[-1] == "s":
-            # this condition initially created for Prescribe.indications,
-            # but could apply to other AutocompleteField fields that are lists
-            # making the assumption here that if the field ends in 's' (like indications), it is a list
-            actual_type = list[actual_type]  # type: ignore
-
-        assert expected_type == actual_type
-
-        if (choices := actual_field["choices"]) is None:
-            assert expected_field["choices"] is None
-            continue
-
-        assert len(expected_field["choices"]) == len(choices)
-        for choice in choices:
-            assert choice["value"] in expected_field["choices"]

canvas_sdk/data/client.py

@@ -0,0 +1,82 @@
+from typing import Any, cast
+
+from gql import Client, gql
+from gql.transport.aiohttp import AIOHTTPTransport
+
+from settings import GRAPHQL_ENDPOINT
+
+
+class _CanvasGQLClient:
+    """
+    This is a GraphQL client that can be used to query home-app in order to fetch data for use in plugins.
+
+    Usage Examples:
+
+    A query with no parameters:
+
+    TEST_QUERY_NO_PARAMS = '''
+      query PatientsAll {
+        patients {
+          edges {
+            node {
+              firstName
+              lastName
+              birthDate
+            }
+          }
+        }
+      }
+    '''
+
+    client = _CanvasGQLClient()
+    result = client.query(TEST_QUERY_NO_PARAMS)
+    print(result) # returns dictionary
+
+    A query with parameters:
+
+    TEST_QUERY_WITH_PARAMS = '''
+        query PatientGet($patientKey: String!) {
+          patient(patientKey: $patientKey) {
+            firstName
+            lastName
+            birthDate
+          }
+        }
+    '''
+
+    client = _CanvasGQLClient()
+    result = client.query(TEST_QUERY_NO_PARAMS)
+    print(result)
+
+    For use in plugins, it is included in the instantiation of Protocol class. This means
+    it can simply be referred to as self.client in plugin code.
+    """
+
+    def __init__(self) -> None:
+        self.client = Client(
+            transport=AIOHTTPTransport(url=cast(str, GRAPHQL_ENDPOINT)),
+            # TODO: follow the documentation in the link below to specify a
+            # cached copy of the schema
+            # https://gql.readthedocs.io/en/stable/usage/validation.html#using-a-provided-schema
+            fetch_schema_from_transport=False,
+        )
+
+    def query(
+        self,
+        gql_query: str,
+        variables: dict[str, Any] | None = None,
+        extra_args: dict[str, Any] | None = None
+    ) -> dict[str, Any]:
+        if variables is None:
+            query_variables = {}
+        else:
+            query_variables = variables
+
+        return self.client.execute(
+            gql(gql_query),
+            variable_values=query_variables,
+            extra_args=extra_args,
+        )
+
+
+GQL_CLIENT = _CanvasGQLClient()

canvas_sdk/data/patient.py

@@ -1,26 +1,6 @@
-from datetime import date
-from typing import Self
-
 from canvas_sdk.data import DataModel
 
-from .data_access_layer_client import DAL_CLIENT
-
 
 class Patient(DataModel):
-    """Patient model."""
-
     id: str | None = None
-    first_name: str | None = None
-    last_name: str | None = None
-    birth_date: date | None = None
-
-    @classmethod
-    def get(cls, id: str) -> Self:
-        """Given an ID, get the Patient from the Data Access Layer."""
-        patient = DAL_CLIENT.get_patient(id)
-        return cls(
-            id=patient.id,
-            first_name=patient.first_name or None,
-            last_name=patient.last_name or None,
-            birth_date=date.fromisoformat(patient.birth_date) if patient.birth_date else None,
-        )
+    # TODO - populate more attributes

canvas_sdk/effects/banner_alert/add_banner_alert.py

@@ -13,6 +13,7 @@ class AddBannerAlert(_BaseEffect):
 
     class Meta:
         effect_type = EffectType.ADD_BANNER_ALERT
+        apply_required_fields = ("patient_id", "key", "narrative", "placement", "intent")
 
     class Placement(Enum):
         CHART = "chart"
@@ -26,11 +27,11 @@ class AddBannerAlert(_BaseEffect):
         WARNING = "warning"
         ALERT = "alert"
 
-    patient_id: str
-    key: str
-    narrative: str = Field(max_length=90)
-    placement: list[Placement] = Field(min_length=1)
-    intent: Intent
+    patient_id: str | None = None
+    key: str | None = None
+    narrative: str | None = Field(max_length=90, default=None)
+    placement: list[Placement] | None = Field(min_length=1, default=None)
+    intent: Intent | None = None
     href: str | None = None
 
     @property
@@ -38,8 +39,8 @@ class AddBannerAlert(_BaseEffect):
         """The BannerAlert's values."""
         return {
             "narrative": self.narrative,
-            "placement": [p.value for p in self.placement],
-            "intent": self.intent.value,
+            "placement": [p.value for p in self.placement] if self.placement else None,
+            "intent": self.intent.value if self.intent else None,
             "href": self.href,
         }
 

canvas_sdk/effects/banner_alert/remove_banner_alert.py

@@ -10,9 +10,10 @@ class RemoveBannerAlert(_BaseEffect):
 
     class Meta:
         effect_type = EffectType.REMOVE_BANNER_ALERT
+        apply_required_fields = ("patient_id", "key")
 
-    patient_id: str
-    key: str
+    patient_id: str | None = None
+    key: str | None = None
 
     @property
     def effect_payload(self) -> dict[str, Any]: