feat: working examples

Author: ClarksonAdam

sandbox/api/app.py

@@ -67,7 +67,7 @@ def get_related_persons() -> Union[dict, tuple]:
 
     try:
         # Check Headers
-        if errors := check_for_errors(request):
+        if errors := check_for_errors(request, "identifier"):
             return errors
 
         identifier = remove_system(request.args.get("identifier"))
@@ -137,51 +137,42 @@ def get_consent() -> Union[dict, tuple]:
         Union[dict, tuple]: Response for GET /Consent
     """
     try:
+        # Check Headers
+        if errors := check_for_errors(request, "performer:identifier"):
+            return errors
+
         performer_identifier = remove_system(request.args.get("performer:identifier"))
         status = request.args.get("status")
         _include = request.args.get("_include")
 
-        print(performer_identifier);
-
-        # Invalid status params
-        if (status != "active" and status != None):
-            return generate_response(load_json_file(CONSENT__STATUS_PARAM_INVALID), 400)
-
-        # Invalid include params
-        if (
-            _include != CONSENT_PERFORMER
-            and _include != CONSENT_PATIENT
-            and _include != f"{CONSENT_PATIENT},{CONSENT_PERFORMER}"
-            and _include != f"{CONSENT_PERFORMER},{CONSENT_PATIENT}"
-            and _include != None
-        ):
-            return generate_response(load_json_file(BAD_REQUEST_INCLUDE_PARAM_INVALID), 400)
-
         # Single consenting adult relationship
         if (performer_identifier == "9000000010"):
-            check_for_consent_include_params(
+            return check_for_consent_include_params(
                 _include,
+                logger,
                 CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
                 CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
             )
         # Single mother child relationship
         elif (performer_identifier == "9000000019"):
-            check_for_consent_include_params(
+            return check_for_consent_include_params(
                 _include,
+                logger,
                 CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
-                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH,
+                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH
             )
         # Filtering
         elif (performer_identifier == "9000000017"):
-            check_for_consent_filtering_params(
+            return check_for_consent_filtering_params(
                 status,
                 CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
                 CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
                 CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE
             )
         elif (performer_identifier == "9000000022"):
-            check_for_consent_include_params(
+            return check_for_consent_include_params(
                 _include,
+                logger,
                 CONSENT__MULTIPLE_RELATIONSHIPS,
                 CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH,
                 CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT,
@@ -191,7 +182,8 @@ def get_consent() -> Union[dict, tuple]:
         elif (performer_identifier == "9000000025"):
             return generate_response_from_example(CONSENT__NO_RELATIONSHIPS, 200)
         else:
-            return generate_response(load_json_file(NOT_FOUND), 400)
+            logger.error(f"Performer identifier {performer_identifier} not does not match examples")
+            return generate_response_from_example(NOT_FOUND, 404)
 
     except Exception as e:
         logger.error(e)

sandbox/api/constants.py

@@ -1,4 +1,3 @@
-NOT_FOUND = "./api/responses/not_found.json"
 EMPTY_RESPONSE = "./api/responses/GET_RelatedPerson/no_relationships.json"
 LIST_RELATIONSHIP = (
     "./api/responses/GET_RelatedPerson/list_relationship_9000000017.json"
@@ -35,7 +34,11 @@
 
 # Common examples
 INTERNAL_SERVER_ERROR_EXAMPLE = "./api/examples/errors/internal-server-error.yaml"
-BAD_REQUEST_INCLUDE_PARAM_INVALID = "./api/examples/errors/bad_request_include_param_invalid.json"
+BAD_REQUEST_INCLUDE_PARAM_INVALID = "./api/examples/errors/invalid-include-parameter.yaml"
+NOT_FOUND = "./api/examples/errors/not-found.yaml"
+MISSING_IDENTIFIER = "./api/examples/errors/missing-identifier.yaml"
+INVALID_IDENTIFIER = "./api/examples/errors/invalid-identifier.yaml"
+
 # Consent examples
 consent_dir = "./api/examples/GET_Consent/"
 CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE = consent_dir + "filtered-relationships-status-active.yaml"
@@ -56,4 +59,4 @@
 CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH = (
     consent_dir + "single-mother-child-relationship-include-performer-patient.yaml"
 )
-CONSENT__STATUS_PARAM_INVALID = consent_dir + "bad_request_status_param_invalid.json"
+CONSENT__STATUS_PARAM_INVALID = consent_dir + "/errors/invalid-status-parameter.yaml"

sandbox/api/utils.py

@@ -1,20 +1,22 @@
+import logging
 from json import dumps, load
 from typing import Any, Optional
 
 from flask import Response, Request
 from yaml import CLoader as Loader
 from yaml import load as yaml_load
+
 from .constants import (
     EMPTY_RESPONSE,
     PATIENT_IDENTIFIERS,
     NOT_FOUND,
     INCLUDE_FLAG,
     RELATED_IDENTIFIERS,
     CONSENT_PERFORMER,
-    CONSENT_PATIENT, INTERNAL_SERVER_ERROR_EXAMPLE
+    CONSENT_PATIENT, INTERNAL_SERVER_ERROR_EXAMPLE, CONSENT__STATUS_PARAM_INVALID, BAD_REQUEST_INCLUDE_PARAM_INVALID,
+    MISSING_IDENTIFIER, INVALID_IDENTIFIER
 )
 
-
 FHIR_MIMETYPE = "application/fhir+json"
 
 
@@ -24,32 +26,36 @@ def load_json_file(file_name: str) -> dict:
         return load(file)
 
 
-def check_for_errors(request: Request) -> Optional[tuple]:
+def check_for_errors(request: Request, identifier_key : str) -> Optional[tuple]:
     """Check for shared in the request headers and arguments
 
     Args:
         request (Request): Flask request object
+        identifier_key (str) : The key to get the identifier by (e.g. "identifier")
 
     Returns:
         Optional[tuple]: Tuple with response and status code if error is found
     """
-    identifier = request.args.get("identifier")
-    identifier_without_system = remove_system(request.args.get("identifier"))
+    identifier = request.args.get(identifier_key)
+    identifier_without_system = remove_system(request.args.get(identifier_key))
+
+    print(f"Identifier = {identifier}")
+    print(f"Identifier_without_system = {identifier_without_system}")
 
     if not identifier:
         return (
-            load_json_file(
-                "./api/responses/bad_request_identifier_missing.json"
-            ),
-            400,
+            generate_response_from_example(
+                "./api/examples/errors/missing-identifier.yaml"
+            ,
+            400)
         )
     elif identifier and len(identifier_without_system) != 10:
         # invalid identifier
         return (
-            load_json_file(
-                "./api/responses/bad_request_identifier_invalid.json"
-            ),
-            400,
+            generate_response_from_example(
+                "./api/examples/errors/invalid-identifier.yaml"
+            ,
+            400)
         )
     elif (
         isinstance(identifier, str)
@@ -58,10 +64,10 @@ def check_for_errors(request: Request) -> Optional[tuple]:
     ):
         # invalid identifier system
         return (
-            load_json_file(
-                "./api/responses/bad_request_identifier_invalid_system.json"
-            ),
-            400,
+            generate_response_from_example(
+                "./api/examples/errors/invalid-identifier-system.yaml"
+            ,
+            400)
         )
 
 
@@ -77,10 +83,10 @@ def check_for_empty(identifier: str, patient_identifier: str) -> Response:
     """
     if identifier and identifier not in PATIENT_IDENTIFIERS:
         # Request with identifier - but its not in a list of identifiers
-        return generate_response(load_json_file(NOT_FOUND), 404)
+        return generate_response_from_example(NOT_FOUND, 404)
     elif patient_identifier and (patient_identifier not in RELATED_IDENTIFIERS):
         # Request with patient:identifier - but its not in a list of identifiers
-        return generate_response(load_json_file(NOT_FOUND), 404)
+        return generate_response_from_example(NOT_FOUND, 404)
     elif identifier == "9000000033":
         # Request with identifier for empty record
         return generate_response(load_json_file(EMPTY_RESPONSE))
@@ -187,6 +193,7 @@ def generate_response_from_example(example_path: str, status_code: int) -> Respo
 
 def check_for_consent_include_params(
     _include : str,
+    logger: logging.Logger,
     include_none_response_yaml: str,
     include_both_response_yaml : str,
     include_patient_response_yaml: str = None,
@@ -196,6 +203,7 @@ def check_for_consent_include_params(
 
     Args:
         _include (str): The include parameter supplied to the request
+        logger (logging.Logger): Logger instance to use for error logging
         include_none_response_yaml (str): The file to return when include params are empty
         include_both_response_yaml (str): The file to return when include param matches with Consent:performer,Consent:patient
         include_patient_response_yaml (str): (optional) The file to return when include param matches with Consent:patient
@@ -204,14 +212,30 @@ def check_for_consent_include_params(
     Returns:
         response: Resultant Response object based on input.
     """
-    if (_include == CONSENT_PERFORMER):
-        return generate_response_from_example(include_performer_response_yaml, 200)
+    if (
+        _include != CONSENT_PERFORMER
+        and _include != CONSENT_PATIENT
+        and _include != f"{CONSENT_PATIENT},{CONSENT_PERFORMER}"
+        and _include != f"{CONSENT_PERFORMER},{CONSENT_PATIENT}"
+        and _include != None
+    ):
+        return generate_response_from_example(BAD_REQUEST_INCLUDE_PARAM_INVALID, 400)
+    elif (_include == CONSENT_PERFORMER):
+        if include_performer_response_yaml:
+            return generate_response_from_example(include_performer_response_yaml, 200)
+        else:
+            logger.error("No consent performer example provided")
+            return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
     elif (_include == CONSENT_PATIENT):
-        return generate_response_from_example(include_patient_response_yaml, 200)
-    elif (_include == f"{CONSENT_PATIENT},{CONSENT_PERFORMER}" or f"{CONSENT_PERFORMER},{CONSENT_PATIENT}"):
+        if include_performer_response_yaml:
+            return generate_response_from_example(include_patient_response_yaml, 200)
+        else:
+            logger.error("No consent:patient example provided")
+            return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
+    elif (_include == f"{CONSENT_PATIENT},{CONSENT_PERFORMER}" or _include == f"{CONSENT_PERFORMER},{CONSENT_PATIENT}"):
         return generate_response_from_example(include_both_response_yaml, 200)
     else:
-        return generate_response(load_json_file(include_none_response_yaml), 200)
+        return generate_response_from_example(include_none_response_yaml, 200)
 
 
 def check_for_consent_filtering_params(
@@ -232,10 +256,10 @@ def check_for_consent_filtering_params(
         response: Resultant Response object based on input.
     """
     if (status == "active"):
-        return generate_response_from_example( status_active_response_yaml, 200)
+        return generate_response_from_example(status_active_response_yaml, 200)
     elif (status == "inactive"):
         return generate_response_from_example(status_inactive_response_yaml, 200)
-    elif (status == "proposed,active" or status == "active,proposed"):
+    elif (status == "proposed,inactive" or status == "inactive,proposed"):
         return generate_response_from_example(status_proposed_and_inactive_response_yaml, 200)
     else:
-        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
+        return generate_response_from_example(CONSENT__STATUS_PARAM_INVALID, 400)