Use NewTypes for response model.

Author: acerathereinspirative-nhs-nvir

README.md

@@ -78,6 +78,7 @@ The following software packages, or their equivalents, are expected to be instal
 | `AWS_SECRET_ACCESS_KEY` | `dummy_secret`          | AWS Secret Access Key                                                                                                                                                  |
 | `DYNAMODB_ENDPOINT`     | `http://localhost:4566` | Endpoint for the app to access DynamoDB                                                                                                                                |
 | `LOG_LEVEL`             | `WARNING`               | Logging level. Must be one of `DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL` as per [Logging Levels](https://docs.python.org/3/library/logging.html#logging-levels) |
+| `RULES_BUCKET_NAME`     | `test-rules-bucket`     | AWS S3 bucket from which to read rules.                                                                                                                                |
 
 ## Usage
 

src/eligibility_signposting_api/views/eligibility.py

@@ -8,7 +8,12 @@
 
 from eligibility_signposting_api.model.eligibility import EligibilityStatus, NHSNumber, Status
 from eligibility_signposting_api.services import EligibilityService, UnknownPersonError
-from eligibility_signposting_api.views.response_models import EligibilityResponse, ProcessedSuggestion
+from eligibility_signposting_api.views.response_models import (
+    ConditionName,
+    EligibilityResponse,
+    ProcessedSuggestion,
+    StatusText,
+)
 from eligibility_signposting_api.views.response_models import Status as ResponseStatus
 
 STATUS_MAPPING = {
@@ -49,9 +54,9 @@ def build_eligibility_response(eligibility_status: EligibilityStatus) -> Eligibi
     return EligibilityResponse(  # pyright: ignore[reportCallIssue]
         processed_suggestions=[  # pyright: ignore[reportCallIssue]
             ProcessedSuggestion(  # pyright: ignore[reportCallIssue]
-                condition=condition.condition_name,
+                condition_name=ConditionName(condition.condition_name),  # pyright: ignore[reportCallIssue]
                 status=STATUS_MAPPING[condition.status],
-                status_text=f"{condition.status}",  # pyright: ignore[reportCallIssue]
+                status_text=StatusText(f"{condition.status}"),  # pyright: ignore[reportCallIssue]
                 eligibility_cohorts=[],  # pyright: ignore[reportCallIssue]
                 suitability_rules=[],  # pyright: ignore[reportCallIssue]
                 actions=[],

src/eligibility_signposting_api/views/response_models.py

@@ -1,7 +1,18 @@
 from enum import Enum
+from typing import NewType
 
 from pydantic import BaseModel, Field, HttpUrl
 
+ConditionName = NewType("ConditionName", str)
+StatusText = NewType("StatusText", str)
+ActionType = NewType("ActionType", str)
+ActionCode = NewType("ActionCode", str)
+Description = NewType("Description", str)
+RuleCode = NewType("RuleCode", str)
+RuleText = NewType("RuleText", str)
+CohortCode = NewType("CohortCode", str)
+CohortText = NewType("CohortText", str)
+
 
 class Status(str, Enum):
     not_eligible = "NotEligible"
@@ -16,34 +27,34 @@ class RuleType(str, Enum):
 
 
 class EligibilityCohort(BaseModel):
-    cohort_code: str = Field(..., alias="cohortCode")
-    cohort_text: str = Field(..., alias="cohortText")
+    cohort_code: CohortCode = Field(..., alias="cohortCode")
+    cohort_text: CohortText = Field(..., alias="cohortText")
     cohort_status: Status = Field(..., alias="cohortStatus")
 
     model_config = {"populate_by_name": True}
 
 
 class SuitabilityRule(BaseModel):
     type: RuleType = Field(..., alias="ruleType")
-    rule_code: str = Field(..., alias="ruleCode")
-    rule_text: str = Field(..., alias="ruleText")
+    rule_code: RuleCode = Field(..., alias="ruleCode")
+    rule_text: RuleText = Field(..., alias="ruleText")
 
     model_config = {"populate_by_name": True}
 
 
 class Action(BaseModel):
-    action_type: str = Field(..., alias="actionType")
-    action_code: str = Field(..., alias="actionCode")
-    description: str
+    action_type: ActionType = Field(..., alias="actionType")
+    action_code: ActionCode = Field(..., alias="actionCode")
+    description: Description
     url_link: HttpUrl = Field(..., alias="urlLink")
 
     model_config = {"populate_by_name": True}
 
 
 class ProcessedSuggestion(BaseModel):
-    condition: str
+    condition_name: ConditionName = Field(..., alias="condition")
     status: Status
-    status_text: str = Field(..., alias="statusText")
+    status_text: StatusText = Field(..., alias="statusText")
     eligibility_cohorts: list[EligibilityCohort] = Field(..., alias="eligibilityCohorts")
     suitability_rules: list[SuitabilityRule] = Field(..., alias="suitabilityRules")
     actions: list[Action]