Merge pull request #245 from dinesh-aot/COMP-359

inspection record approval

Author: dinesh-aot

compliance-api/migrations/versions/80afcd35ad35_change_info_inspection_records.py

@@ -0,0 +1,54 @@
+"""change_info_inspection_records
+
+Revision ID: 80afcd35ad35
+Revises: e85b901b6ba6
+Create Date: 2025-03-19 10:50:46.569040
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '80afcd35ad35'
+down_revision = 'e85b901b6ba6'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('inspection_record_approvals', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('approved_date', sa.DateTime(timezone=True), nullable=True, comment='The approved date'))
+
+    with op.batch_alter_table('inspection_record_approvals_version', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('approved_date', sa.DateTime(timezone=True), autoincrement=False, nullable=True, comment='The approved date'))
+        batch_op.add_column(sa.Column('approved_date_mod', sa.Boolean(), server_default=sa.text('false'), nullable=False))
+
+    with op.batch_alter_table('inspection_records', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('field_change_info', sa.JSON(), nullable=True, comment='To indicate if selected fields have changed or not'))
+
+    with op.batch_alter_table('inspection_records_version', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('field_change_info', sa.JSON(), autoincrement=False, nullable=True, comment='To indicate if selected fields have changed or not'))
+        batch_op.add_column(sa.Column('field_change_info_mod', sa.Boolean(), server_default=sa.text('false'), nullable=False))
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('inspection_records_version', schema=None) as batch_op:
+        batch_op.drop_column('field_change_info_mod')
+        batch_op.drop_column('field_change_info')
+
+    with op.batch_alter_table('inspection_records', schema=None) as batch_op:
+        batch_op.drop_column('field_change_info')
+
+    with op.batch_alter_table('inspection_record_approvals_version', schema=None) as batch_op:
+        batch_op.drop_column('approved_date_mod')
+        batch_op.drop_column('approved_date')
+
+    with op.batch_alter_table('inspection_record_approvals', schema=None) as batch_op:
+        batch_op.drop_column('approved_date')
+
+    # ### end Alembic commands ###

compliance-api/src/compliance_api/models/__init__.py

@@ -32,8 +32,8 @@
     InspectionOtherAttendance, InspectionReqDetailDocument, InspectionReqEnforcementMap, InspectionReqSourceDetail,
     InspectionRequirement, InspectionRequirementImage, InspectionRequirementTypeEnum, InspectionStatusEnum,
     InspectionType, InspectionTypeOption, IRStatusOption)
-from .inspection_record import InspectionRecord
-from .inspection_record_approval import InspectionRecordApproval
+from .inspection_record import InspectionRecord, IRProgressEnum
+from .inspection_record_approval import InspectionRecordApproval, IRApprovalStatusEnum
 from .position import Position
 from .project import Project
 from .req_source_document_map import RequirementSourceDocumentMap

compliance-api/src/compliance_api/models/inspection_record.py

@@ -2,7 +2,7 @@
 
 from enum import Enum
 
-from sqlalchemy import Column, DateTime
+from sqlalchemy import JSON, Column, DateTime
 from sqlalchemy import Enum as SqlEnum
 from sqlalchemy import ForeignKey, Integer, String
 from sqlalchemy.orm import relationship
@@ -61,6 +61,11 @@ class InspectionRecord(BaseModelVersioned):
     finding_statement = Column(
         String, nullable=True, comment="Finding statement from the inspection"
     )
+    field_change_info = Column(
+        JSON,
+        nullable=True,
+        comment="To indicate if selected fields have changed or not",
+    )
     enforcement_summary = Column(
         String, nullable=True, comment="Summary of enforcement action"
     )

compliance-api/src/compliance_api/models/inspection_record_approval.py

@@ -68,6 +68,11 @@ class InspectionRecordApproval(BaseModelVersioned):
         comment="State of the inspection record",
         default=IRApprovalStatusEnum.DECISION_PENDING,
     )
+    approved_date = Column(
+        DateTime(timezone=True),
+        nullable=True,
+        comment="The approved date",
+    )
     approved_by = relationship(
         "StaffUser", foreign_keys=[approved_by_id], lazy="joined"
     )
@@ -87,3 +92,40 @@ def create_inspection_record_approval(
         session.add(inspection_record_approval)
         session.flush()
         return inspection_record_approval
+
+    @classmethod
+    def get_approvals_by_ir(cls, inspection_record_id: int):
+        """Return all the approval entries by inspection record id."""
+        return (
+            cls.query.filter(
+                cls.inspection_record_id == inspection_record_id,
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .order_by(cls.created_date.desc())
+            .all()
+        )
+
+    @classmethod
+    def get_latest_approval_by_ir(cls, inspection_record_id: int):
+        """Return all the approval entries by inspection record id."""
+        return (
+            cls.query.filter(
+                cls.inspection_record_id == inspection_record_id,
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .order_by(cls.created_date.desc())
+            .first()
+        )
+
+    @classmethod
+    @with_session
+    def update_approval(cls, approval_id, approval_update_data, session=None):
+        """Update the inspection record approval."""
+        approval = cls.find_by_id(approval_id)
+        if not approval:
+            return None
+        approval.update(approval_update_data, commit=False)
+        session.flush()
+        return approval

compliance-api/src/compliance_api/resources/inspection_record.py

@@ -7,16 +7,18 @@
 from compliance_api.auth import auth
 from compliance_api.exceptions import ResourceNotFoundError
 from compliance_api.schemas import (
-    InspectionRecordCreateSchema, InspectionRecordSchema, ResetInspectionRecordFieldSchema,
+    CreateInspectionRecordApprovalSchema, InspectionRecordApprovalSchema, InspectionRecordCreateSchema,
+    InspectionRecordSchema, ResetInspectionRecordFieldSchema, UpdateInspectionRecordApprovalSchema,
     UpdateInspectionRecordSchema)
-from compliance_api.services import InspectionRecordService
+from compliance_api.services import InspectionRecordApprovalService, InspectionRecordService
 from compliance_api.utils.enum import PermissionEnum
 from compliance_api.utils.util import cors_preflight
 
 from .apihelper import Api as ApiHelper
 
 
-API = Namespace("inspection-records", description="Endpoints for Inspection Record")
+API = Namespace("inspection-records",
+                description="Endpoints for Inspection Record")
 
 ir_create_request_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, InspectionRecordCreateSchema(), "IRCreateRequest"
@@ -27,12 +29,21 @@
 ir_update_request_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, UpdateInspectionRecordSchema(), "UpdateInspection"
 )
+ir_approval_create_request = ApiHelper.convert_ma_schema_to_restx_model(
+    API, CreateInspectionRecordApprovalSchema(), "IRApproval"
+)
+ir_approval_schema = ApiHelper.convert_ma_schema_to_restx_model(
+    API, InspectionRecordApprovalSchema(), "IRApproval"
+)
+ir_approval_update_request = ApiHelper.convert_ma_schema_to_restx_model(
+    API, UpdateInspectionRecordApprovalSchema(), "IRApprovalUpdate"
+)
 ir_reset_field_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, ResetInspectionRecordFieldSchema(), "ResetInspectionField"
 )
 
 
-@cors_preflight("GET, OPTIONS, POST")
+@cors_preflight("GET, OPTIONS, POST, PATCH")
 @API.route("", methods=["POST", "GET", "OPTIONS"])
 class InspectionRecords(Resource):
     """Resource for managing inspection records."""
@@ -61,7 +72,8 @@ def get(inspection_id):
     def post(inspection_id):
         """Create a agency."""
         ir_create_request = InspectionRecordCreateSchema().load(API.payload)
-        created_ir = InspectionRecordService.create(ir_create_request, inspection_id)
+        created_ir = InspectionRecordService.create(
+            ir_create_request, inspection_id)
         return InspectionRecordSchema().dump(created_ir), HTTPStatus.CREATED
 
 
@@ -79,7 +91,8 @@ class InspectionRecord(Resource):
     @auth.require
     def get(inspection_record_id):
         """Fetch inspection record by id."""
-        inspection_record = InspectionRecordService.get_by_id(inspection_record_id)
+        inspection_record = InspectionRecordService.get_by_id(
+            inspection_record_id)
         if not inspection_record:
             raise ResourceNotFoundError(
                 f"No inspection found for the given ID : {inspection_record_id}"
@@ -99,12 +112,95 @@ def patch(inspection_id, inspection_record_id):
         updated_ir = InspectionRecordService.update(
             inspection_id, inspection_record_id, ir_update_data
         )
-        if not updated_ir:
-            raise ResourceNotFoundError("Inspection record not found")
         return InspectionRecordSchema().dump(updated_ir), HTTPStatus.OK
 
 
 @cors_preflight("PATCH, OPTIONS")
+@API.route("/<int:inspection_record_id>/switch-to-final", methods=["PATCH", "OPTIONS"])
+class InspectionRecordFinal(Resource):
+    """Resource to handle InspectionRecord."""
+
+    @staticmethod
+    @API.response(code=200, description="Sucess", model=ir_list_model)
+    @API.expect(ir_update_request_model)
+    @ApiHelper.swagger_decorators(API, endpoint_description="Switch to FINAL IR")
+    @API.response(404, "Not Found")
+    @auth.require
+    def patch(inspection_id, inspection_record_id):
+        """Swith IR to FINAL."""
+        final_ir = InspectionRecordService.switch_to_final(
+            inspection_id, inspection_record_id
+        )
+        return InspectionRecordSchema().dump(final_ir), HTTPStatus.OK
+
+
+@cors_preflight("GET, OPTIONS, POST, PATCH")
+@API.route("/<int:inspection_record_id>/approvals", methods=["POST", "GET", "OPTIONS"])
+class InspectionRecordApprovals(Resource):
+    """Resource for managing inspection records."""
+
+    @staticmethod
+    @API.response(code=200, description="Success", model=[ir_approval_schema])
+    @ApiHelper.swagger_decorators(
+        API, endpoint_description="Fetch all inspection record approvals"
+    )
+    @auth.require
+    def get(inspection_id, inspection_record_id):  # pylint: disable=no-self-use, unused-argument
+        """Fetch all inspection record approvals."""
+        approvals = InspectionRecordApprovalService.get_all_approvals(
+            inspection_record_id
+        )
+        approval_schema = InspectionRecordApprovalSchema(many=True)
+        return approval_schema.dump(approvals), HTTPStatus.OK
+
+    @staticmethod
+    @auth.require
+    @ApiHelper.swagger_decorators(
+        API, endpoint_description="Create an inspection record approval"
+    )
+    @API.expect(ir_approval_create_request)
+    @API.response(
+        code=201, model=ir_approval_schema, description="IRApprovalRequestCreated"
+    )
+    @API.response(400, "Bad Request")
+    def post(inspection_id, inspection_record_id):
+        """Create a agency."""
+        ir_approval_request = CreateInspectionRecordApprovalSchema().load(API.payload)
+        created_aproval = InspectionRecordApprovalService.create_approval(
+            ir_approval_request, inspection_id, inspection_record_id
+        )
+        return (
+            InspectionRecordApprovalSchema().dump(created_aproval),
+            HTTPStatus.CREATED,
+        )
+
+
+@cors_preflight("OPTIONS, PATCH, GET")
+@API.route(
+    "/<int:inspection_record_id>/approvals/<int:approval_id>",
+    methods=["PATCH", "GET", "OPTIONS"],
+)
+class InspectionRecordApproval(Resource):
+    """Resource for managing inspection record approval."""
+
+    @staticmethod
+    @API.response(code=200, description="Sucess", model=ir_approval_schema)
+    @API.expect(ir_approval_update_request)
+    @ApiHelper.swagger_decorators(
+        API, endpoint_description="Update inspection record approval"
+    )
+    @API.response(404, "Not Found")
+    @API.response(400, "Bad Request")
+    @auth.require
+    def patch(inspection_id, inspection_record_id, approval_id):
+        """Update inspection record approval."""
+        approval_update_data = UpdateInspectionRecordApprovalSchema().load(API.payload)
+        updated_approval = InspectionRecordApprovalService.update_approval(
+            inspection_id, inspection_record_id, approval_id, approval_update_data
+        )
+        return InspectionRecordApprovalSchema().dump(updated_approval), HTTPStatus.OK
+
+
 @API.route("/<int:inspection_record_id>/reset", methods=["PATCH", "OPTIONS"])
 class InspectionRecordReset(Resource):
     """Resource for resetting inspection record fields."""

compliance-api/src/compliance_api/schemas/__init__.py

@@ -27,6 +27,8 @@
 from .inspection import (
     InspectionAttendanceSchema, InspectionCreateSchema, InspectionOfficerSchema, InspectionSchema,
     InspectionStatusSchema, InspectionUpdateSchema)
+from .inspection_approval import (
+    CreateInspectionRecordApprovalSchema, InspectionRecordApprovalSchema, UpdateInspectionRecordApprovalSchema)
 from .inspection_record import (
     InspectionRecordCreateSchema, InspectionRecordSchema, ResetInspectionRecordFieldSchema,
     UpdateInspectionRecordSchema)

compliance-api/src/compliance_api/schemas/inspection.py

@@ -390,15 +390,15 @@ def extract_status_value(
             data["status"] = status_enum.value
         return data
 
-    @validates_schema
-    def validate_status(
-        self, data, **kwargs
-    ):  # pylint: disable=no-self-use, unused-argument
-        """Ensure only Closed and Canceled status are passed."""
-        # Retrieve the context to access other fields
-        status = data.get("status")
-        if status not in [InspectionStatusEnum.CANCELED, InspectionStatusEnum.CLOSED]:
-            raise ValidationError(
-                "Invalid status value passed",
-                field_name="status",
-            )
+    # @validates_schema
+    # def validate_status(
+    #     self, data, **kwargs
+    # ):  # pylint: disable=no-self-use, unused-argument
+    #     """Ensure only Closed and Canceled status are passed."""
+    #     # Retrieve the context to access other fields
+    #     status = data.get("status")
+    #     if status not in [InspectionStatusEnum.CANCELED, InspectionStatusEnum.CLOSED]:
+    #         raise ValidationError(
+    #             "Invalid status value passed",
+    #             field_name="status",
+    #         )