bug fixes (#611)

Author: dinesh-aot

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

@@ -11,8 +11,9 @@
 from compliance_api.exceptions import ResourceNotFoundError
 from compliance_api.schemas import (
     CreateInspectionRecordApprovalSchema, CreateIRDownloadRequestSchema, InspectionRecordApprovalSchema,
-    InspectionRecordCreateSchema, InspectionRecordSchema, IRDownloadRequestSchema, ResetInspectionRecordFieldSchema,
-    UpdateInspectionRecordApprovalSchema, UpdateInspectionRecordApprovalStatusSchema, UpdateInspectionRecordSchema)
+    InspectionRecordCreateSchema, InspectionRecordSchema, IRDownloadRequestSchema, RenderRequestSchema,
+    ResetInspectionRecordFieldSchema, UpdateInspectionRecordApprovalSchema, UpdateInspectionRecordApprovalStatusSchema,
+    UpdateInspectionRecordSchema)
 from compliance_api.services import InspectionRecordApprovalService, InspectionRecordService
 from compliance_api.utils.util import cors_preflight
 
@@ -51,6 +52,9 @@
 ir_download_request_create_schema = ApiHelper.convert_ma_schema_to_restx_model(
     API, CreateIRDownloadRequestSchema(), "CreateIRDownloadRequest"
 )
+ir_render_request_model = ApiHelper.convert_ma_schema_to_restx_model(
+    API, RenderRequestSchema(), "IRRenderRequest"
+)
 
 
 @cors_preflight("GET, OPTIONS, POST, PATCH")
@@ -285,23 +289,14 @@ class InspectionRecordPreview(Resource):
     @staticmethod
     @API.response(code=200, description="Success")
     @ApiHelper.swagger_decorators(API, endpoint_description="Preview inspection record")
-    @API.doc(
-        params={
-            "output_format": {
-                "description": "The output format of the inspection record",
-                "type": "string",
-                "required": False,
-                "default": "html",
-                "enum": ["html", "pdf"],
-            }
-        }
-    )
+    @API.expect(ir_render_request_model)
     @auth.require
     def post(
         inspection_id, inspection_record_id
     ):  # pylint: disable=no-self-use, unused-argument
         """Preview inspection record."""
-        output_format = request.json.get("output_format", "html")
+        render_request = RenderRequestSchema().load(API.payload or {})
+        output_format = render_request.get("output_format", "html")
         response, inspection = InspectionRecordService.render(
             inspection_id, inspection_record_id, output_format
         )

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

@@ -7,13 +7,14 @@
 from flask_restx import Namespace, Resource
 
 from compliance_api.auth import auth
-from compliance_api.exceptions import BadRequestError, ResourceNotFoundError
+from compliance_api.exceptions import ResourceNotFoundError
 from compliance_api.services.order.order import OrderService
 from compliance_api.services.order.order_approval import OrderApprovalService
 
 from ..schemas import (
     CreateOrderApprovalSchema, OrderApprovalSchema, OrderCreateSchema, OrderIssueSchema, OrderReplaceSchema,
-    OrderSchema, OrderStatusSchema, OrderUpdateSchema, ResetOrderFieldSchema, UpdateOrderApprovalStatusSchema)
+    OrderSchema, OrderStatusSchema, OrderUpdateSchema, RenderRequestSchema, ResetOrderFieldSchema,
+    UpdateOrderApprovalStatusSchema)
 from ..utils.util import cors_preflight
 from .apihelper import Api as ApiHelper
 
@@ -49,6 +50,9 @@
 reset_order_field_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, ResetOrderFieldSchema(), "ResetOrderField"
 )
+order_render_request_model = ApiHelper.convert_ma_schema_to_restx_model(
+    API, RenderRequestSchema(), "OrderRenderRequest"
+)
 
 order_replace_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, OrderReplaceSchema(), "OrderReplace"
@@ -250,23 +254,12 @@ class OrderPreview(Resource):
     @API.response(code=200, description="Success")
     @API.response(404, "Not Found")
     @ApiHelper.swagger_decorators(API, endpoint_description="Preview order")
-    @API.doc(
-        params={
-            "output_format": {
-                "description": "The output format of the order report",
-                "type": "string",
-                "required": False,
-                "default": "html",
-                "enum": ["html", "pdf"],
-            }
-        }
-    )
+    @API.expect(order_render_request_model)
     @auth.require
     def post(order_id):  # pylint: disable=no-self-use, unused-argument
         """Preview order."""
-        output_format = request.args.get("output_format", "html")
-        if output_format not in ["html", "pdf"]:
-            raise BadRequestError("Invalid output format")
+        render_request = RenderRequestSchema().load(API.payload or {})
+        output_format = render_request.get("output_format", "html")
         response, order = OrderService.render(order_id, output_format)
         if output_format == "pdf":
             return send_file(

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

@@ -8,6 +8,7 @@
 
 from compliance_api.auth import auth
 from compliance_api.exceptions import ResourceNotFoundError
+from compliance_api.schemas import RenderRequestSchema
 from compliance_api.schemas.warning_letter import (
     ResetWarningLetterFieldSchema, WarningLetterCreateSchema, WarningLetterIssueSchema, WarningLetterSchema,
     WarningLetterStatusSchema, WarningLetterUpdateSchema)
@@ -41,6 +42,9 @@
 reset_warning_letter_field_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, ResetWarningLetterFieldSchema(), "ResetWarningLetterField"
 )
+warning_letter_render_request_model = ApiHelper.convert_ma_schema_to_restx_model(
+    API, RenderRequestSchema(), "WarningLetterRenderRequest"
+)
 warning_letter_approval_model = ApiHelper.convert_ma_schema_to_restx_model(
     API, WarningLetterApprovalSchema(), "WarningLetterApproval"
 )
@@ -232,21 +236,12 @@ class WarningLetterPreview(Resource):
     @API.response(code=200, description="Success")
     @API.response(404, "Not Found")
     @ApiHelper.swagger_decorators(API, endpoint_description="Preview warning letter")
-    @API.doc(
-        params={
-            "output_format": {
-                "description": "The output format of the warning letter report",
-                "type": "string",
-                "required": False,
-                "default": "html",
-                "enum": ["html", "pdf"],
-            }
-        }
-    )
+    @API.expect(warning_letter_render_request_model)
     @auth.require
     def post(warning_letter_id):  # pylint: disable=no-self-use, unused-argument
         """Preview warning letter."""
-        output_format = request.json.get("output_format", "html")
+        render_request = RenderRequestSchema().load(API.payload or {})
+        output_format = render_request.get("output_format", "html")
         response, warning_letter = WarningLetterService.render(
             warning_letter_id, output_format
         )

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

@@ -23,7 +23,7 @@
     CaseFileUpdateSchema, EnforcementItemSchema)
 from .charge_recommendation import (
     ChargeRecommendationCreateSchema, ChargeRecommendationSchema, ChargeRecommendationUpdateSchema)
-from .common import KeyValueSchema
+from .common import KeyValueSchema, RenderRequestSchema
 from .complaint import (
     ComplaintCreateSchema, ComplaintFilterSchema, ComplaintSchema, ComplaintSourceContactSchema, ComplaintStatusSchema,
     ComplaintUpdateSchema, RequirementSourceDetailSchema)

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

@@ -12,11 +12,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Common Schema."""
-from marshmallow import Schema, fields
+from marshmallow import Schema, fields, validate
+
+from .base_schema import BaseSchema
 
 
 class KeyValueSchema(Schema):
     """Schema to represent key/value."""
 
     id = fields.Str(metadata={"description": "Unique id in the list"})
     name = fields.Str(metadata={"description": "Name of the list item"})
+
+
+class RenderRequestSchema(BaseSchema):
+    """Schema for document render request."""
+
+    output_format = fields.Str(
+        required=False,
+        missing="html",
+        default="html",
+        validate=validate.OneOf(["html", "pdf"]),
+        metadata={"description": "The output format of the document"}
+    )

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

@@ -1,6 +1,7 @@
 """Schema for IR Download Request."""
 
 from marshmallow import EXCLUDE, fields, post_dump
+
 from compliance_api.models.ir_download_request import IRDownloadRequest as IRDownloadRequestModel
 from compliance_api.utils.constant import INPUT_DATE_TIME_FORMAT
 

compliance-api/src/compliance_api/services/case_file.py

@@ -922,7 +922,7 @@ def _build_enforcement_query(inspection_ids: list):
             and_(
                 OrderModel.inspection_id == InspectionModel.id,
                 OrderModel.order_status.notin_(
-                    [OrderStatusEnum.OPEN, OrderStatusEnum.CLOSED]
+                    [OrderStatusEnum.OPEN, OrderStatusEnum.CLOSED, OrderStatusEnum.RESCINDED]
                 ),
                 OrderModel.is_active.is_(True),
                 OrderModel.is_deleted.is_(False),

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

@@ -27,7 +27,7 @@
 from compliance_api.models import IRStatusOption as IRStatusOptionModel
 from compliance_api.models import Order as OrderModel
 from compliance_api.models import OrderInspectionRequirementMap as OrderInspectionRequirementMapModel
-from compliance_api.models import OrderProgressEnum
+from compliance_api.models import OrderProgressEnum, OrderReplaceStatusEnum
 from compliance_api.models import ViolationTicket as ViolationTicketModel
 from compliance_api.models import WarningLetter as WarningLetterModel
 from compliance_api.models import db
@@ -572,7 +572,7 @@ def _set_order_enforcement_action_object(
         in [
             req_map.inspection_requirement_id
             for req_map in order.order_requirement_maps
-        ]
+        ] and order.order_replace_status == OrderReplaceStatusEnum.ORIGINAL
     ]
     if requirement_orders:
         order = requirement_orders[0]

compliance-api/src/compliance_api/services/inspection_record/inspection_record_builder.py

@@ -115,6 +115,11 @@ def build_officer_details(self):
             if self.existing_ir
             else self.inspection.primary_officer
         )
+        record_prepared_by_position = (
+            self.existing_ir.record_prepared_by_position
+            if self.existing_ir
+            else self.inspection.primary_officer.position
+        )
         self.data["officer_details"] = {
             "primary_officer": {
                 "name": f"{self.inspection.primary_officer.first_name} {self.inspection.primary_officer.last_name}",
@@ -123,7 +128,7 @@ def build_officer_details(self):
             "record_prepared_by": {
                 "name": f"{record_prepared_by.first_name} "
                 f"{record_prepared_by.last_name}",
-                "position": record_prepared_by.position.name,
+                "position": record_prepared_by_position.name,
             },
         }
 

compliance-api/src/compliance_api/services/inspection_requirement.py

@@ -42,7 +42,7 @@
 from compliance_api.models.inspection_record import InspectionRecord as InspectionRecordModel
 from compliance_api.models.order import Order as OrderModel
 from compliance_api.models.order import OrderInspectionRequirementMap as OrderInspectionRequirementMapModel
-from compliance_api.models.order import OrderProgressEnum, OrderStatusEnum
+from compliance_api.models.order import OrderProgressEnum, OrderReplaceStatusEnum, OrderStatusEnum
 from compliance_api.models.order_approval import OrderApproval as OrderApprovalModel
 from compliance_api.models.order_approval import OrderApprovalStatusEnum
 from compliance_api.models.requirement_source import RequirementSource as RequirementSourceOptionModel
@@ -481,6 +481,7 @@ def _get_requirement_order_sub_query():
             OrderInspectionRequirementMapModel.is_deleted.is_(False),
             OrderModel.is_active.is_(True),
             OrderModel.is_deleted.is_(False),
+            OrderModel.order_replace_status == OrderReplaceStatusEnum.ORIGINAL,
         )
         .subquery("requirement_order")
     )