Merge pull request #66 from diging/develop

prepare release

Author: jdamerow

edrop/settings.py

@@ -15,8 +15,7 @@
 
 logger = logging.getLogger(__name__)
 LOGLEVEL = os.environ.get('LOGLEVEL', 'INFO').upper()
-logging.basicConfig(format="%(levelname)s: %(name)s: %(message)s", level=LOGLEVEL)
-
+logging.basicConfig(format="%(asctime)s - %(levelname)s: %(name)s: %(funcName)s: %(message)s", level=LOGLEVEL)
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
@@ -146,10 +145,31 @@
 REQUEST_TIMEZONE = os.environ.get('REQUEST_TIMEZONE', "MST")
 
 # REDCap configurations
-REDCAP_INSTRUMENT_ID = "contact"
-REDCAP_FIELD_TO_BE_COMPLETE = "contact_complete"
+REDCAP_CITY = 'city'
+REDCAP_CONSENT_COMPLETE = 'consent_complete'
+REDCAP_CONTACT_COMPLETE = 'contact_complete'
+REDCAP_DATE_KIT_REQUEST = 'date_kit_request'
+REDCAP_DATE_KIT_SHIPPED = 'date_kit_shipped'
+REDCAP_FIELD_TO_BE_COMPLETE = 'contact_complete'
+REDCAP_FIRST_NAME = 'first_name'
+REDCAP_INSTRUMENT_ID = 'contact'
+REDCAP_KIT_ORDER_N = 'kit_order_n'
+REDCAP_KIT_STATUS = 'kit_status'
+REDCAP_KIT_STATUS_ORDER_VAL = 'ORD'
+REDCAP_KIT_STATUS_TRACK_VAL = 'TRN'
+REDCAP_KIT_TRACKING_COMPLETE = 'kit_tracking_complete'
+REDCAP_KIT_TRACKING_COMPLETE_VAL = '1'
+REDCAP_KIT_TRACKING_N = 'kit_tracking_n'
+REDCAP_KIT_TRACKING_RETURN_N = 'kit_tracking_return_n'
+REDCAP_LAST_NAME = 'last_name'
+REDCAP_RECORD_ID = 'record_id'
+REDCAP_STATE = 'state'
+REDCAP_STREET_1 = 'street_1'
+REDCAP_STREET_2 = 'street_2'
 REDCAP_TOKEN = os.environ.get('REDCAP_TOKEN')
+REDCAP_TUBESERIAL = 'tubeserial'
 REDCAP_URL = os.environ.get('REDCAP_URL')
+REDCAP_ZIP = 'zip'
 
 #GBF configurations
 GBF_TOKEN = os.environ.get('GBF_TOKEN')
@@ -161,4 +181,4 @@
 GBF_ITEM_QUANTITY = 1.0
 GBF_SHIPPING_METHOD = os.environ.get('GBF_SHIPPING_METHOD', "FedEx Ground")
 
-CRON_JOB_FREQUENCEY = "*/1" # Should run the GBG check job once a day
+CRON_JOB_FREQUENCY = "*/1" # Should run the GBG check job once a day

supervisord.conf

@@ -18,6 +18,7 @@ stopwaitsecs = 600
 ; send SIGKILL to its whole process group instead,
 ; taking care of its children as well.
 killasgroup=true
+stopasgroup=true
 
 ; if rabbitmq is supervised, set its priority higher
 ; so it starts first
@@ -40,6 +41,7 @@ stopwaitsecs = 600
 ; send SIGKILL to its whole process group instead,
 ; taking care of its children as well.
 killasgroup=true
+stopasgroup=true
 
 ; if rabbitmq is supervised, set its priority higher
 ; so it starts first

track/admin.py

@@ -1,9 +1,40 @@
 from django.contrib import admin
 from track.models import *
+from django.http import HttpResponseRedirect
+from django.urls import path
+import logging
+from track import orders
+
+logger = logging.getLogger(__name__)
+
 
 # Register your models here.
 class OrderAdmin(admin.ModelAdmin):
+    change_list_template = "track/check_orders.html"
+
     list_display = ["record_id", "order_number", "tracking_nrs", "return_tracking_nrs", "tube_serials", "order_status", "ship_date"]
 
+class ConfirmationCheckLogAdmin(admin.ModelAdmin):
+    list_display = ["id", "job_id", "start_time", "end_time", "is_complete"]
+    fields = ("job_id", "apscheduler", "orders", "gbf", "redcap", "end_time", "is_complete")
+    
+    def get_urls(self):
+        urls = super().get_urls()
+        my_urls = [
+            path('check_order_status/', self.call_check_order_status),
+        ]
+        return my_urls + urls
+    
+    def call_check_order_status(self, request):
+        logger.info("Initiatied check for tracking info") 
+        orders.check_orders_shipping_info()
+        logger.info("Tracking info check completed.")
+        return HttpResponseRedirect("../")
+
+class OrderLogAdmin(admin.ModelAdmin):
+    list_display = ["id", "order_number", "start_time", "end_time", "is_complete"]
+    fields = ("order_number", "redcap", "orders", "gbf", "end_time", "is_complete")
 
-admin.site.register(Order, OrderAdmin)
+admin.site.register(Order, OrderAdmin)
+admin.site.register(OrderLog, OrderLogAdmin)
+admin.site.register(ConfirmationCheckLog, ConfirmationCheckLogAdmin)

track/api.py

@@ -4,6 +4,7 @@
 from django.conf import settings
 from track.models import *
 import track.orders as orders
+from track.exceptions import REDCapError
 
 import logging
 logger = logging.getLogger(__name__)
@@ -31,7 +32,11 @@ def initiate_order(request):
         return HttpResponse(status=HTTPStatus.OK)
 
     # create a new order only if no order exists
-    order = orders.place_order(record_id, request.POST.get('project_id'), request.POST.get('project_url'))
+    try:
+        order = orders.place_order(record_id, request.POST.get('project_id'), request.POST.get('project_url'))
+    except REDCapError as e:
+        return HttpResponse(status=HTTPStatus.INTERNAL_SERVER_ERROR)
+    
     if not order:
         logger.error("Endpoint was called with contact_complete = 2 but REDCap order actually does not have contact_complete = 2.")
         return HttpResponse(status=HTTPStatus.BAD_REQUEST)

track/exceptions.py

@@ -0,0 +1,8 @@
+class REDCapError(Exception):
+    """
+    Exception raised for issues with REDCap.
+    """
+
+    def __init__(self, message="There was an issue with connecting to REDCap."):
+        self.message = message
+        super().__init__(self.message)

track/gbf.py

@@ -1,9 +1,14 @@
 from django.conf import settings
 import requests, json
 from http import HTTPStatus
-import logging
+import logging, inspect
+
+from track.models import *
+from track.log_manager import LogManager
 
 logger = logging.getLogger(__name__)
+log_manager = LogManager()
+
 
 def create_order(order, adress_data):
     """
@@ -16,13 +21,20 @@ def create_order(order, adress_data):
     order.order_number = order_number
     order.save()
 
+    log_manager.start_order_log(order_number)
     # generate order json
     order_json = _generate_order_json(order, adress_data)
-    logger.error("Sending to GBF:")
-    logger.error(order_json)
+
+    # we cannot store PII (which the shipping address is, 
+    # so this is here just for testing purposes and should not be executed in production)
+    #logger.error(order_json)
+
+    message = f"Placing order {order.order_number} with GBF."
+    log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, message, order_number)
+    logger.info(message)
 
     # make order with GBF
-    return _place_order_with_GBF(order_json)
+    return _place_order_with_GBF(order_json, order_number)
 
 def _generate_order_number(order):
     """
@@ -62,8 +74,7 @@ def _generate_order_json(order, address_data):
 
     return json.dumps(order_json)
 
-
-def _place_order_with_GBF(order_json):
+def _place_order_with_GBF(order_json, order_number):
     """
     Makes a POST request to the GBF endpoint /oap/api/order with the proper
     order Json. 
@@ -74,27 +85,52 @@ def _place_order_with_GBF(order_json):
     """
     # make post request to GBF
     # By default requests should be made as "test" via an environment variable.
-    # Once we go live, the environemnt variable needs to be set to true explictly,
+    # Once we go live, the environemnt variable needs to be set to true explictly.
     headers = {
         'Authorization': f'Bearer {settings.GBF_TOKEN}',
         'Content-Type': 'application/json'
         }
+
     response = requests.post(f"{settings.GBF_URL}oap/api/order", data=order_json, headers=headers)
-    logger.error("Response from GBF:")
-    logger.error(response)
+    
+    message = "Response from GBF:"
+    log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, message, order_number)
+    logger.info(message)
+
+    log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, response, order_number)
+    logger.info(response)
 
     response_body = response.json()
+    log_manager.append_to_gbf_log(LogManager.LEVEL_DEBUG, response_body, order_number)
+    logger.debug(response_body)
     if response.status_code != HTTPStatus.OK:
-        logger.error("Could not submit order to GBF.")
-        logger.error(response)
-        logger.error(response_body)
+        message = f"Could not submit order {order_number} to GBF."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message, order_number)
+        logger.error(message)
+
+        message = response
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message, order_number)
+        logger.error(message)
+        
+        message = {response_body}
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message, order_number)
+        logger.error(message)
         return False
 
     if "success" not in response_body or response_body["success"] != True:
-        logger.error("Could not submit order to GBF.")
-        logger.error(response_body)
+        message = f"Could not submit order {order_number} to GBF."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message, order_number)
+        logger.error(message)
+        
+        message = response_body
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message, order_number)
+        logger.error(message)
         return False
 
+    message = f'Order {order_number} has been successfully placed with GBF!'
+    log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, message, order_number)
+    logger.info(message)
+    log_manager.complete_log(order_number)
     return True
 
 def get_order_confirmations(order_numbers):
@@ -126,48 +162,72 @@ def get_order_confirmations(order_numbers):
         }
     }
     """
+    message = f"Getting GBF Order Confirmations for the following order numbers: {order_numbers}"
+    log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, message)
+    logger.info(message)
+
     headers = {'Authorization': f'Bearer {settings.GBF_TOKEN}'}
     content = {'orderNumbers': order_numbers, 'format': 'json'}
+    logger.debug('Sending to GBF:')
+    logger.debug(content)
+    log_manager.append_to_gbf_log(LogManager.LEVEL_DEBUG, content)
     try:
         response = requests.post(f"{settings.GBF_URL}oap/api/confirm2", data=content, headers=headers)
         response.raise_for_status()  # Raises an exception for bad status codes
+        
         logger.debug(response.json())
     except requests.exceptions.HTTPError as err:
-        logger.error(f"Could not get order confirmation from GBF.")
-        logger.error(err) 
+        message = f"Could not get order confirmation from GBF for the following order numbers: {order_numbers}."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message)
+        logger.error(message)
+        
+        message = err
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message)
+        logger.error(message)
         return None  
 
     response_body = response.json()
     # if for some reason GBF does not return a success response
     if response_body['success'] != True:
-        logger.error("GBF returned success is false.")
-        logger.error(response_body)
+        message = "GBF returned success is false."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message)
+        logger.error(message)
+
+        message = response_body
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message)
+        logger.error(message)
 
     if "dataArray" not in response_body or not response_body["dataArray"]:
-        logger.info("No GBF confirmations available.")
+        message = "No GBF confirmations available."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, message)
+        logger.info(message)
         return None
 
     # GBF sends one object in a list in 'dataArray', so we'll use the first one
     data_object = response_body["dataArray"][0]
     if 'format' not in data_object or data_object["format"] != "json":
-        logger.error("GBF did not send json back.")
+        message = "GBF did not send json back."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_ERROR, message)
+        logger.error(message)
         return None
 
     if 'data' not in data_object or not data_object["data"]:
-        logger.info("No GBF confirmations available.")
+        message = "No GBF confirmations available."
+        log_manager.append_to_gbf_log(LogManager.LEVEL_INFO, message)
+        logger.info(message)
         return None
 
     confirmations = json.loads(data_object["data"])
     tracking_info = {}
     if "ShippingConfirmations" in confirmations:
         for shipping_confirmation in confirmations['ShippingConfirmations']:
             tracking_info[shipping_confirmation['OrderNumber']] = {
-                'date_kit_shipped': shipping_confirmation['ShipDate'],
-                'kit_tracking_n': shipping_confirmation['Tracking'],
+                'date_kit_shipped': shipping_confirmation['ShipDate'] if 'ShipDate' in shipping_confirmation else None,
+                'kit_tracking_n': shipping_confirmation['Tracking'] if 'Tracking' in shipping_confirmation else None,
                 #filter for items with return tracking numbers and returns tracking numbers
-                'return_tracking_n': [return_track for item in shipping_confirmation['Items'] if 'ReturnTracking' in item for return_track in item['ReturnTracking']],
+                'return_tracking_n': [return_track if 'Items' in shipping_confirmation else None for item in shipping_confirmation['Items'] if 'ReturnTracking' in item for return_track in item['ReturnTracking']],
                 #filter for items with return tracking numbers and returns tracking numbers
-                'tube_serial_n': [tube_serial for item in shipping_confirmation['Items'] if 'TubeSerial' in item for tube_serial in item['TubeSerial']]
+                'tube_serial_n': [tube_serial if 'Items' in shipping_confirmation else None for item in shipping_confirmation['Items'] if 'TubeSerial' in item for tube_serial in item['TubeSerial']]
             }  
     return tracking_info