Merge pull request #6 from tahzeer/3.0

[G2P-4236] Update standardized schemas and related changes

Author: venky-ganapathy

openg2p-pbms-staff-portal-api/src/openg2p_pbms_staff_portal_api/controllers/beneficiary_search.py

@@ -4,7 +4,6 @@
 from openg2p_bg_task_models.schemas import (
     BeneficiarySearchRequest,
     BeneficiarySearchResponse,
-    BeneficiarySearchResponsePayload,
 )
 from openg2p_fastapi_common.controller import BaseController
 
@@ -35,14 +34,11 @@ async def search_beneficiaries(
         _logger.debug("Beneficiary Search Request: %s", beneficiary_search_request)
 
         try:
-            beneficiary_search_response_payload: BeneficiarySearchResponsePayload = (
+            beneficiary_search_response: BeneficiarySearchResponse = (
                 await self.beneficiary_search_service.search_beneficiaries(
-                    beneficiary_search_request.message
+                    beneficiary_search_request
                 )
             )
-            beneficiary_search_response: BeneficiarySearchResponse = await self.beneficiary_search_service.construct_beneficiary_search_success_response(
-                beneficiary_search_request, beneficiary_search_response_payload
-            )
             _logger.info("Beneficiaries retrieved successfully")
             _logger.debug(
                 "Beneficiary Search Response: %s", beneficiary_search_response

openg2p-pbms-staff-portal-api/src/openg2p_pbms_staff_portal_api/controllers/disbursement.py

@@ -49,7 +49,7 @@ async def disbursement_envelope(
 
         try:
             disbursement_envelope_response_payload: DisbursementEnvelopeResponsePayload = await self.disbursement_envelope_service.disbursement_envelope(
-                disbursement_envelope_request.message
+                disbursement_envelope_request.request_body.request_payload
             )
             disbursement_envelope_response: DisbursementEnvelopeResponse = await self.disbursement_envelope_service.construct_disbursement_envelope_success_response(
                 disbursement_envelope_request, disbursement_envelope_response_payload
@@ -74,7 +74,7 @@ async def disbursement_batch(
         try:
             disbursement_batch_response_payload: DisbursementBatchResponsePayload = (
                 await self.disbursement_batch_service.disbursement_batch(
-                    disbursement_batch_request.message
+                    disbursement_batch_request.request_body.request_payload
                 )
             )
             disbursement_batch_response: DisbursementBatchResponse = await self.disbursement_batch_service.construct_disbursement_batch_success_response(

openg2p-pbms-staff-portal-api/src/openg2p_pbms_staff_portal_api/controllers/summary.py

@@ -1,10 +1,10 @@
 import logging
 
 from openg2p_bg_task_models.errors import BGTaskException
-from openg2p_bg_task_models.models import BeneficiaryListSummary
 from openg2p_bg_task_models.schemas import (
     SummaryRequest,
     SummaryResponse,
+    SummaryResponsePayload,
 )
 from openg2p_fastapi_common.controller import BaseController
 
@@ -33,12 +33,14 @@ async def get_summary(self, summary_request: SummaryRequest) -> SummaryResponse:
         _logger.debug("Beneficiary List Summary Request: %s", summary_request)
 
         try:
-            beneficiary_list_summary: BeneficiaryListSummary = (
-                await self.summary_service.get_summary(summary_request.message)
+            summary_response_payload: SummaryResponsePayload = (
+                await self.summary_service.get_summary(
+                    summary_request.request_body.request_payload
+                )
             )
             summary_response: SummaryResponse = (
                 await self.summary_service.construct_summary_success_response(
-                    summary_request, beneficiary_list_summary
+                    summary_request, summary_response_payload
                 )
             )
             _logger.info("Eligibility summary retrieved successfully")

openg2p-pbms-staff-portal-api/src/openg2p_pbms_staff_portal_api/main.py

@@ -2,7 +2,7 @@
 
 # ruff: noqa: I001
 
-from .app import Initializer
+from openg2p_pbms_staff_portal_api.app import Initializer
 from openg2p_fastapi_common.ping import PingInitializer
 
 initializer = Initializer()

openg2p-pbms-staff-portal-api/src/openg2p_pbms_staff_portal_api/services/beneficiary_search.py

@@ -1,19 +1,21 @@
 import logging
+import math
 from datetime import datetime
 
 from openg2p_bg_task_models.schemas import (
     BeneficiarySearchRequest,
-    BeneficiarySearchRequestPayload,
     BeneficiarySearchResponse,
+    BeneficiarySearchResponseBody,
     BeneficiarySearchResponsePayload,
 )
 from openg2p_bg_task_registry_adapters.factory import RegistryFactory
 from openg2p_bg_task_registry_adapters.interface import RegistryInterface
-from openg2p_fastapi_common.service import BaseService
-from openg2p_g2pconnect_common_lib.schemas import (
-    StatusEnum,
-    SyncResponseHeader,
+from openg2p_fastapi_common.schemas import (
+    G2PPaginationResponse,
+    G2PResponseHeader,
+    G2PResponseStatus,
 )
+from openg2p_fastapi_common.service import BaseService
 from sqlalchemy.ext.asyncio import async_sessionmaker
 
 from ..config import Settings
@@ -26,8 +28,13 @@
 
 class BeneficiarySearchService(BaseService):
     async def search_beneficiaries(
-        self, beneficiary_search_request_payload: BeneficiarySearchRequestPayload
-    ) -> BeneficiarySearchResponsePayload:
+        self, beneficiary_search_request: BeneficiarySearchRequest
+    ) -> BeneficiarySearchResponse:
+        beneficiary_search_request_payload = (
+            beneficiary_search_request.request_body.request_payload
+        )
+        pagination_request = beneficiary_search_request.request_body.pagination_request
+
         session_maker = async_sessionmaker(
             bind=_engine.get("db_engine_bg_task"), expire_on_commit=False
         )
@@ -42,52 +49,63 @@ async def search_beneficiaries(
                         beneficiary_search_request_payload.target_registry
                     )
                 )
-                beneficiary_search_response_payload: BeneficiarySearchResponsePayload = await registry_interface.search_beneficiaries(
+                (
+                    beneficiary_search_response_payload,
+                    total_count,
+                ) = await registry_interface.search_beneficiaries(
                     session,
                     sr_session,
                     beneficiary_search_request_payload.beneficiary_list_id,
                     beneficiary_search_request_payload.target_registry,
-                    beneficiary_search_request_payload.search_query,
-                    beneficiary_search_request_payload.page,
-                    beneficiary_search_request_payload.page_size,
-                    beneficiary_search_request_payload.order_by,
+                    pagination_request.search_text,
+                    pagination_request.current_page,
+                    pagination_request.page_size,
+                    pagination_request.sort_by,
+                )
+
+                # Build pagination response
+                page_size = pagination_request.page_size if pagination_request else 10
+                number_of_pages = (
+                    math.ceil(total_count / page_size) if page_size > 0 else 0
+                )
+                pagination_response = G2PPaginationResponse(
+                    number_of_items=total_count,
+                    number_of_pages=number_of_pages,
+                )
+
+                return BeneficiarySearchResponse(
+                    response_header=G2PResponseHeader(
+                        request_id=beneficiary_search_request.request_header.request_id,
+                        response_timestamp=datetime.now(),
+                        response_status=G2PResponseStatus.SUCCESS,
+                    ),
+                    response_body=BeneficiarySearchResponseBody(
+                        pagination_response=pagination_response,
+                        response_payload=beneficiary_search_response_payload,
+                    ),
                 )
-                return beneficiary_search_response_payload
 
             except Exception as e:
                 _logger.exception("Error searching for beneficiaries.")
                 raise e
 
-    async def construct_beneficiary_search_success_response(
-        self,
-        beneficiary_search_request: BeneficiarySearchRequest,
-        beneficiary_search_response_payload: BeneficiarySearchResponsePayload,
-    ) -> BeneficiarySearchResponse:
-        response = BeneficiarySearchResponse(
-            header=SyncResponseHeader(
-                message_id=beneficiary_search_request.header.message_id,
-                message_ts=datetime.now().isoformat(),
-                action=beneficiary_search_request.header.action,
-                status=StatusEnum.succ,
-            ),
-            message=beneficiary_search_response_payload,
-        )
-        return response
-
     async def construct_beneficiary_search_error_response(
         self,
         beneficiary_search_request: BeneficiarySearchRequest,
         error_code: str,
     ) -> BeneficiarySearchResponse:
         response = BeneficiarySearchResponse(
-            header=SyncResponseHeader(
-                message_id=beneficiary_search_request.header.message_id,
-                message_ts=datetime.now().isoformat(),
-                action=beneficiary_search_request.header.action,
-                status=StatusEnum.rjct,
-                status_reason_message=error_code,
+            response_header=G2PResponseHeader(
+                request_id=beneficiary_search_request.request_header.request_id,
+                response_timestamp=datetime.now(),
+                response_status=G2PResponseStatus.ERROR,
+                response_error_code=error_code,
+            ),
+            response_body=BeneficiarySearchResponseBody(
+                response_payload=BeneficiarySearchResponsePayload(
+                    beneficiary_count=0, beneficiaries=[]
+                ),
             ),
-            message={},
         )
 
         return response

openg2p-pbms-staff-portal-api/src/openg2p_pbms_staff_portal_api/services/disbursement.py

@@ -8,17 +8,19 @@
     DisbursementBatchRequest,
     DisbursementBatchRequestPayload,
     DisbursementBatchResponse,
+    DisbursementBatchResponseBody,
     DisbursementBatchResponsePayload,
     DisbursementEnvelopeRequest,
     DisbursementEnvelopeRequestPayload,
     DisbursementEnvelopeResponse,
+    DisbursementEnvelopeResponseBody,
     DisbursementEnvelopeResponsePayload,
 )
-from openg2p_fastapi_common.service import BaseService
-from openg2p_g2pconnect_common_lib.schemas import (
-    StatusEnum,
-    SyncResponseHeader,
+from openg2p_fastapi_common.schemas import (
+    G2PResponseHeader,
+    G2PResponseStatus,
 )
+from openg2p_fastapi_common.service import BaseService
 from sqlalchemy.ext.asyncio import async_sessionmaker
 
 from ..config import Settings
@@ -73,13 +75,14 @@ async def construct_disbursement_envelope_success_response(
         disbursement_envelope_response_payload: DisbursementEnvelopeResponsePayload,
     ) -> DisbursementEnvelopeResponse:
         disbursement_envelope_response = DisbursementEnvelopeResponse(
-            header=SyncResponseHeader(
-                message_id=disbursement_envelope_request.header.message_id,
-                message_ts=datetime.now().isoformat(),
-                action=disbursement_envelope_request.header.action,
-                status=StatusEnum.succ,
+            response_header=G2PResponseHeader(
+                request_id=disbursement_envelope_request.request_header.request_id,
+                response_timestamp=datetime.now(),
+                response_status=G2PResponseStatus.SUCCESS,
+            ),
+            response_body=DisbursementEnvelopeResponseBody(
+                response_payload=disbursement_envelope_response_payload,
             ),
-            message=disbursement_envelope_response_payload,
         )
         return disbursement_envelope_response
 
@@ -89,14 +92,18 @@ async def construct_disbursement_envelope_error_response(
         error_code: str,
     ) -> DisbursementEnvelopeResponse:
         disbursement_envelope_response = DisbursementEnvelopeResponse(
-            header=SyncResponseHeader(
-                message_id=disbursement_envelope_request.header.message_id,
-                message_ts=datetime.now().isoformat(),
-                action=disbursement_envelope_request.header.action,
-                status=StatusEnum.rjct,
-                status_reason_message=error_code,
+            response_header=G2PResponseHeader(
+                request_id=disbursement_envelope_request.request_header.request_id,
+                response_timestamp=datetime.now(),
+                response_status=G2PResponseStatus.ERROR,
+                response_error_code=error_code,
+            ),
+            response_body=DisbursementEnvelopeResponseBody(
+                response_payload=DisbursementEnvelopeResponsePayload(
+                    beneficiary_list_id=disbursement_envelope_request.request_payload.beneficiary_list_id,
+                    disbursement_envelopes=[],
+                ),
             ),
-            message={},
         )
         return disbursement_envelope_response
 
@@ -143,27 +150,31 @@ async def construct_disbursement_batch_success_response(
         disbursement_batch_response_payload: DisbursementBatchResponsePayload,
     ) -> DisbursementBatchResponse:
         disbursement_batch_response = DisbursementBatchResponse(
-            header=SyncResponseHeader(
-                message_id=disbursement_batch_request.header.message_id,
-                message_ts=datetime.now().isoformat(),
-                action=disbursement_batch_request.header.action,
-                status=StatusEnum.succ,
+            response_header=G2PResponseHeader(
+                request_id=disbursement_batch_request.request_header.request_id,
+                response_timestamp=datetime.now(),
+                response_status=G2PResponseStatus.SUCCESS,
+            ),
+            response_body=DisbursementBatchResponseBody(
+                response_payload=disbursement_batch_response_payload,
             ),
-            message=disbursement_batch_response_payload,
         )
         return disbursement_batch_response
 
     async def construct_disbursement_batch_error_response(
         self, disbursement_batch_request: DisbursementBatchRequest, error_code: str
     ) -> DisbursementBatchResponse:
         disbursement_batch_response = DisbursementBatchResponse(
-            header=SyncResponseHeader(
-                message_id=disbursement_batch_request.header.message_id,
-                message_ts=datetime.now().isoformat(),
-                action=disbursement_batch_request.header.action,
-                status=StatusEnum.rjct,
-                status_reason_message=error_code,
+            response_header=G2PResponseHeader(
+                request_id=disbursement_batch_request.request_header.request_id,
+                response_timestamp=datetime.now(),
+                response_status=G2PResponseStatus.ERROR,
+                response_error_code=error_code,
+            ),
+            response_body=DisbursementBatchResponseBody(
+                response_payload=DisbursementBatchResponsePayload(
+                    disbursement_batches=[],
+                ),
             ),
-            message={},
         )
         return disbursement_batch_response