Merge pull request #39 from NHSDigital/feature/eli-135-eligibility_data_store-schema

ELI 135 eligibility repo & service

Author: acerathereinspirative-nhs-nvir

poetry.lock

@@ -42,7 +42,7 @@ gitpython = "^3.1.44"
 pytest = "^8.3.4"
 pytest-asyncio = "^0.25.3"
 pytest-cov = "^6.0.0"
-#pytest-nhsd-apim = "^3.3.2"
+pytest-nhsd-apim = "^5.0.0"
 aiohttp = "^3.11.12"
 awscli = "^1.37.24"
 awscli-local = "^0.22.0"
@@ -82,6 +82,8 @@ log_cli = true
 log_cli_level = "DEBUG"
 log_format = "%(asctime)s %(levelname)s %(message)s"
 log_date_format = "%Y-%m-%d %H:%M:%S"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 
 [tool.coverage.run]
 relative_files = true

pyproject.toml

@@ -10,7 +10,7 @@
 from eligibility_signposting_api import repos, services
 from eligibility_signposting_api.config import config, init_logging
 from eligibility_signposting_api.error_handler import handle_exception
-from eligibility_signposting_api.views import eligibility, hello
+from eligibility_signposting_api.views import eligibility_blueprint
 
 init_logging()
 logger = logging.getLogger(__name__)
@@ -35,8 +35,7 @@ def create_app() -> Flask:
     logger.info("app created")
 
     # Register views & error handler
-    app.register_blueprint(eligibility, url_prefix="/eligibility")
-    app.register_blueprint(hello, url_prefix="/hello")
+    app.register_blueprint(eligibility_blueprint, url_prefix="/eligibility")
     app.register_error_handler(Exception, handle_exception)
 
     # Set up dependency injection using wireup

src/eligibility_signposting_api/app.py

@@ -1,3 +1,12 @@
+from datetime import date
 from typing import NewType
 
+from pydantic import BaseModel
+
 NHSNumber = NewType("NHSNumber", str)
+DateOfBirth = NewType("DateOfBirth", date)
+Postcode = NewType("Postcode", str)
+
+
+class Eligibility(BaseModel):
+    processed_suggestions: list[dict]

src/eligibility_signposting_api/model/eligibility.py

@@ -1,4 +1,4 @@
+from .eligibility_repo import EligibilityRepo
 from .exceptions import NotFoundError
-from .person_repo import PersonRepo
 
-__all__ = ["NotFoundError", "PersonRepo"]
+__all__ = ["EligibilityRepo", "NotFoundError"]

src/eligibility_signposting_api/model/person.py

@@ -0,0 +1,36 @@
+import logging
+from typing import Annotated, Any
+
+from boto3.dynamodb.conditions import Key
+from boto3.resources.base import ServiceResource
+from wireup import Inject, service
+
+from eligibility_signposting_api.model.eligibility import NHSNumber
+from eligibility_signposting_api.repos.exceptions import NotFoundError
+
+logger = logging.getLogger(__name__)
+
+
+@service(qualifier="eligibility_table")
+def eligibility_table_factory(dynamodb_resource: Annotated[ServiceResource, Inject(qualifier="dynamodb")]) -> Any:
+    table = dynamodb_resource.Table("eligibility_data_store")  # type: ignore[reportAttributeAccessIssue]
+    logger.info("eligibility_table %r", table, extra={"table": table})
+    return table
+
+
+@service
+class EligibilityRepo:
+    def __init__(self, table: Annotated[Any, Inject(qualifier="eligibility_table")]) -> None:
+        super().__init__()
+        self.table = table
+
+    def get_eligibility_data(self, nhs_number: NHSNumber) -> list[dict[str, Any]]:
+        response = self.table.query(KeyConditionExpression=Key("NHS_NUMBER").eq(f"PERSON#{nhs_number}"))
+        logger.debug("response %r for %r", response, nhs_number, extra={"response": response, "nhs_number": nhs_number})
+
+        if not (items := response.get("Items")):
+            message = f"Person not found with nhs_number {nhs_number}"
+            raise NotFoundError(message)
+
+        logger.debug("returning items %s", items, extra={"items": items})
+        return items

src/eligibility_signposting_api/repos/__init__.py

@@ -1,3 +1,3 @@
-from .person_services import PersonService, UnknownPersonError
+from .eligibility_services import EligibilityService, UnknownPersonError
 
-__all__ = ["PersonService", "UnknownPersonError"]
+__all__ = ["EligibilityService", "UnknownPersonError"]

src/eligibility_signposting_api/repos/eligibility_repo.py

@@ -0,0 +1,36 @@
+import logging
+
+from wireup import service
+
+from eligibility_signposting_api.model.eligibility import Eligibility, NHSNumber
+from eligibility_signposting_api.repos import EligibilityRepo, NotFoundError
+
+logger = logging.getLogger(__name__)
+
+
+class UnknownPersonError(Exception):
+    pass
+
+
+@service
+class EligibilityService:
+    def __init__(self, eligibility_repo: EligibilityRepo) -> None:
+        super().__init__()
+        self.eligibility_repo = eligibility_repo
+
+    def get_eligibility(self, nhs_number: NHSNumber | None = None) -> Eligibility:
+        if nhs_number:
+            try:
+                eligibility_data = self.eligibility_repo.get_eligibility_data(nhs_number)
+                logger.debug(
+                    "got eligibility_data %r",
+                    eligibility_data,
+                    extra={"eligibility_data": eligibility_data, "nhs_number": nhs_number},
+                )
+            except NotFoundError as e:
+                raise UnknownPersonError from e
+            else:
+                # TODO: Apply rules here  # noqa: TD002, TD003, FIX002
+                return Eligibility(processed_suggestions=[])
+
+        raise UnknownPersonError