Merge pull request #22 from minvws/feat/query-providers

feat: query healthcare provider on specific params

Author: fouadsfarijlani

app/db/repository/healthcare_provider.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import Sequence
 from uuid import UUID
 
 from sqlalchemy import and_, select, update
@@ -20,11 +20,6 @@ def add_one(self, data: HealthcareProviderEntity) -> HealthcareProviderEntity:
             self.db_session.rollback()
             raise e
 
-    def get_all(self) -> List[HealthcareProviderEntity]:
-        stmt = select(HealthcareProviderEntity).where(HealthcareProviderEntity.deleted_at.is_(None))
-        results = self.db_session.session.execute(stmt).scalars().all()
-        return list(results)
-
     def get_one(self, id: UUID) -> HealthcareProviderEntity | None:
         stmt = select(HealthcareProviderEntity).where(
             and_(
@@ -35,6 +30,31 @@ def get_one(self, id: UUID) -> HealthcareProviderEntity | None:
         results = self.db_session.session.execute(stmt).scalar()
         return results
 
+    def get_many(
+        self,
+        oin: str | None = None,
+        source_id: str | None = None,
+        ura_number: str | None = None,
+    ) -> Sequence[HealthcareProviderEntity]:
+        conditions = []
+
+        if oin:
+            conditions.append((HealthcareProviderEntity.oin == oin))
+
+        if source_id:
+            conditions.append((HealthcareProviderEntity.source_id == source_id))
+
+        if ura_number is not None:
+            conditions.append((HealthcareProviderEntity.ura_number == ura_number))
+
+        stmt = (
+            select(HealthcareProviderEntity)
+            .where(and_(*conditions))
+            .where(HealthcareProviderEntity.deleted_at.is_(None))
+        )
+        results = self.db_session.session.execute(stmt).scalars().all()
+        return results
+
     def update(self, id: UUID, **kwargs: object) -> HealthcareProviderEntity | None:
         try:
             target = {k: kwargs[k] for k in HealthcareProviderEntity.__table__.columns.keys() if k in kwargs}

app/models/params.py

@@ -0,0 +1,21 @@
+from typing import Any
+
+from pydantic import BaseModel, field_validator
+
+from app.models.ura_number import UraNumber
+
+
+class HealthcareProvidersQueryParams(BaseModel):
+    oin: str | None = None
+    source_id: str | None = None
+    ura_number: str | None = None
+
+    @field_validator("ura_number")
+    @classmethod
+    def validate_ura_number(cls, value: Any) -> str:
+        try:
+            result = UraNumber(value)
+        except ValueError as e:
+            raise ValueError(f"Invalid UraNumber: {e}")
+
+        return result.value

app/routers/healthcare_provider.py

@@ -1,15 +1,16 @@
 import logging
-from typing import Annotated, Any
+from typing import Annotated, Any, List
 from uuid import UUID
 
-from fastapi import APIRouter, Body, Depends, HTTPException, Response
+from fastapi import APIRouter, Body, Depends, HTTPException, Query, Response
 
 from app.container import get_healthcare_provider_service
 from app.models.healthcare_provider import (
     HealthcareProvider,
     HealthcareProviderCreate,
     HealthcareProviderUpdate,
 )
+from app.models.params import HealthcareProvidersQueryParams
 from app.services.healthcare_provider import HeatlhcareProviderService
 
 logger = logging.getLogger(__name__)
@@ -25,6 +26,15 @@ def add_one_provider(
     return new_provider
 
 
+@router.get("", response_model=List[HealthcareProvider], response_model_exclude_none=True)
+def get(
+    params: Annotated[HealthcareProvidersQueryParams, Query()],
+    service: Annotated[HeatlhcareProviderService, Depends(get_healthcare_provider_service)],
+) -> Any:
+    # TODO: update this is functional_management
+    return service.get(**params.model_dump())
+
+
 @router.get("/{id}", response_model=HealthcareProvider, response_model_exclude_none=True)
 def get_by_id(
     id: UUID,
@@ -37,14 +47,6 @@ def get_by_id(
     return results
 
 
-@router.get("", response_model=list[HealthcareProvider], response_model_exclude_none=True)
-def get_all(
-    service: Annotated[HeatlhcareProviderService, Depends(get_healthcare_provider_service)],
-) -> Any:
-    results = service.get_all()
-    return results
-
-
 @router.delete("/{id}")
 def delete_by_id(
     id: UUID,

app/services/healthcare_provider.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import List
 from uuid import UUID
 
 from app.db.db import Database
@@ -17,12 +18,16 @@ def get_one(self, id: UUID) -> HealthcareProviderEntity | None:
 
             return provider
 
-    def get_all(self) -> list[HealthcareProviderEntity]:
+    def get(
+        self,
+        oin: str | None = None,
+        source_id: str | None = None,
+        ura_number: str | None = None,
+    ) -> List[HealthcareProviderEntity]:
         with self.db.get_db_session() as session:
             repository = session.get_repository(HealthcareProvidersRepository)
-            providers = repository.get_all()
-
-            return providers
+            healthcare_provider = repository.get_many(oin, source_id, ura_number)
+            return list(healthcare_provider)
 
     def create_one(
         self,

tests/db/test_healthcare_provider.py

@@ -2,6 +2,7 @@
 
 from app.db.models.healthcare_provider import HealthcareProviderEntity
 from app.db.repository.healthcare_provider import HealthcareProvidersRepository
+from app.models.ura_number import UraNumber
 
 
 def test_add_one_success(
@@ -79,23 +80,90 @@ def test_update_not_found(
         assert result is None
 
 
-def test_get_all(
+def test_get_many_should_return_all_records(
     healthcare_provider_repository: HealthcareProvidersRepository,
     healthcare_provider_entity: HealthcareProviderEntity,
+    ura_number: UraNumber,
 ) -> None:
+    entity_2 = HealthcareProviderEntity(
+        ura_number=ura_number.value,
+        source_id="some_other_source_id",
+        is_source=True,
+        is_viewer=True,
+        oin="some_oin",
+        common_name="some_common_name",
+        status="active",
+    )
+    entity_3 = HealthcareProviderEntity(
+        ura_number=UraNumber("00000125").value,
+        source_id="antoher-source-id",
+        is_source=True,
+        is_viewer=False,
+        oin="antoher-oin",
+        common_name="fake-name",
+        status="active",
+    )
     with healthcare_provider_repository.db_session:
         healthcare_provider_repository.add_one(healthcare_provider_entity)
+        healthcare_provider_repository.add_one(entity_2)
+        healthcare_provider_repository.add_one(entity_3)
 
-        result = healthcare_provider_repository.get_all()
+        results = healthcare_provider_repository.get_many()
 
-        assert len(result) == 1
-        assert result[0].id == healthcare_provider_entity.id
+        assert len(results) == 3
 
 
-def test_get_all_returns_empty_list_when_no_data(
+def test_get_many_should_return_exact_as_per_query(
     healthcare_provider_repository: HealthcareProvidersRepository,
+    healthcare_provider_entity: HealthcareProviderEntity,
+    ura_number: UraNumber,
 ) -> None:
+    entity_2 = HealthcareProviderEntity(
+        ura_number=ura_number.value,
+        source_id="some_other_source_id",
+        is_source=True,
+        is_viewer=True,
+        oin="some_oin",
+        common_name="some_common_name",
+        status="active",
+    )
+    entity_3 = HealthcareProviderEntity(
+        ura_number=UraNumber("00000125").value,
+        source_id="antoher-source-id",
+        is_source=True,
+        is_viewer=False,
+        oin="antoher-oin",
+        common_name="fake-name",
+        status="active",
+    )
     with healthcare_provider_repository.db_session:
-        result = healthcare_provider_repository.get_all()
+        healthcare_provider_repository.add_one(healthcare_provider_entity)
+        healthcare_provider_repository.add_one(entity_2)
+        healthcare_provider_repository.add_one(entity_3)
+
+        results = healthcare_provider_repository.get_many(ura_number=ura_number.value, oin="some_oin")
+
+        assert len(results) == 2
+
+        results = healthcare_provider_repository.get_many(
+            ura_number=ura_number.value,
+            oin=healthcare_provider_entity.oin,
+            source_id=healthcare_provider_entity.source_id,
+        )
+        assert len(results) == 1
+
+
+def test_many_should_return_empty_list_when_no_match_is_found(
+    healthcare_provider_repository: HealthcareProvidersRepository,
+    healthcare_provider_entity: HealthcareProviderEntity,
+) -> None:
+    with healthcare_provider_repository.db_session:
+        healthcare_provider_repository.add_one(healthcare_provider_entity)
+
+        results = healthcare_provider_repository.get_many(
+            ura_number="00000157",
+            source_id="some-unknown-source",
+            oin="000012345678910",
+        )
 
-        assert result == []
+        assert len(results) == 0

tests/models/test_params.py

@@ -0,0 +1,37 @@
+import pytest
+
+from app.models.params import HealthcareProvidersQueryParams
+from app.models.ura_number import UraNumber
+
+
+def test_serialize_should_succeed(ura_number: UraNumber) -> None:
+    expected = {
+        "oin": "000000912345678",
+        "source_id": "some-id",
+        "ura_number": ura_number.value,
+    }
+    data = HealthcareProvidersQueryParams(oin="000000912345678", source_id="some-id", ura_number=ura_number.value)
+
+    actual = data.model_dump()
+
+    assert expected == actual
+
+
+def test_deserialize_should_succeed(ura_number: UraNumber) -> None:
+    expected = HealthcareProvidersQueryParams(oin="000000912345678", source_id="some-id", ura_number=ura_number.value)
+    data = {
+        "oin": "000000912345678",
+        "source_id": "some-id",
+        "ura_number": ura_number.value,
+    }
+
+    actual = HealthcareProvidersQueryParams.model_validate(data)
+
+    assert expected == actual
+
+
+def test_deserialize_should_raise_exception_with_invalid_ura() -> None:
+    with pytest.raises(ValueError) as exc:
+        HealthcareProvidersQueryParams(oin="0000123456789", source_id="some-id", ura_number="INVALID-URA")
+
+    assert "Invalid UraNumber" in str(exc.value)

tests/services/test_healthcare_provider_service.py

@@ -147,7 +147,7 @@ def test_update_one_should_return_none_when_nothing_to_update(
     assert expected is None
 
 
-def test_get_all_should_succeed(
+def test_get_should_succeed_and_return_all_records(
     healthcare_provider_service: HeatlhcareProviderService,
     healthcare_provider_entity: HealthcareProviderEntity,
 ) -> None:
@@ -170,20 +170,20 @@ def test_get_all_should_succeed(
         status=healthcare_provider_entity.status,
     )
 
-    expected = healthcare_provider_service.get_all()
+    expected = healthcare_provider_service.get()
     assert len(expected) == 2
     assert expected[0].id == data.id
     assert expected[1].id == data2.id
 
 
-def test_get_all_should_return_empty_list_when_no_data(
+def test_get_should_return_empty_list_when_no_data(
     healthcare_provider_service: HeatlhcareProviderService,
 ) -> None:
-    expected = healthcare_provider_service.get_all()
+    expected = healthcare_provider_service.get()
     assert expected == []
 
 
-def test_get_all_should_return_only_non_deleted_data(
+def test_get_should_return_only_non_deleted_data(
     healthcare_provider_service: HeatlhcareProviderService,
     healthcare_provider_entity: HealthcareProviderEntity,
 ) -> None:
@@ -198,5 +198,39 @@ def test_get_all_should_return_only_non_deleted_data(
     )
     healthcare_provider_service.delete_one(data.id)
 
-    expected = healthcare_provider_service.get_all()
+    expected = healthcare_provider_service.get()
     assert expected == []
+
+
+def test_get_should_return_exact_as_per_args(
+    healthcare_provider_service: HeatlhcareProviderService,
+    healthcare_provider_entity: HealthcareProviderEntity,
+) -> None:
+    data = healthcare_provider_service.create_one(
+        ura_number=healthcare_provider_entity.ura_number,
+        source_id=healthcare_provider_entity.source_id,
+        is_source=healthcare_provider_entity.is_source,
+        is_viewer=healthcare_provider_entity.is_viewer,
+        oin=healthcare_provider_entity.oin,
+        common_name=healthcare_provider_entity.common_name,
+        status=healthcare_provider_entity.status,
+    )
+    healthcare_provider_service.create_one(
+        ura_number="00000456",
+        source_id="some-other-source-id",
+        is_source=True,
+        is_viewer=True,
+        oin="some-other-oin",
+        common_name="some-other-common-name",
+        status="active",
+    )
+
+    results = healthcare_provider_service.get(oin=data.oin, source_id=data.source_id)
+
+    assert len(results) == 1
+    assert results[0].id == data.id
+    for key in data.__table__.columns.keys():
+        expected_attr = getattr(results[0], key)
+        actual_attr = getattr(data, key)
+
+        assert expected_attr == actual_attr