Merge pull request #59 from diging/develop

Prepare next release

Author: jdamerow

.env_app_example

@@ -6,12 +6,14 @@
 export APP_ROOT="edrop/"
 # adjust this property to the host edrop is running on
 export ALLOWED_HOSTS="localhost,127.0.0.1"
-# add hostname of server here: https://myhost.org/
+# add hostname of server here: https://myhost.org
 export CSRF_TRUSTED_ORIGINS=""
 
 export DATA_PATH=/data/files/
 export MEDIA_URL_PATH=/dashboard/files/
 export MEDIA_ROOT_PATH=files
+export LOGLEVEL='INFO' # WARNING, ERROR, INFO, DEBUG
+
 # the following variables also need to be in .docker_env (ugly but not sure how else to get it to work)
 export POSTGRES_DB=postgres
 export POSTGRES_NAME=postgres
@@ -27,4 +29,4 @@ export REDCAP_URL=""
 export GBF_TEST_FLAG='true' # should be true or false
 export GBF_TOKEN="XXX" # token for GBF
 export GBF_URL="" # set to host of GBF api endpoints ending in /
-export GBF_ITEM_NR = "XXX" # the item nr of the kit that should be ordered
+export GBF_ITEM_NR="XXX" # the item nr of the kit that should be ordered

README.md

@@ -101,5 +101,11 @@ supervisorctl -c /etc/supervisor/supervisord.conf restart edrop
 6. If that works, stop and start through systemd.
 7. Edit webserver to proxy eDROP Django app.
 
+## Processing Flow
+
+Below is a diagram that describes the process flow of eDROP Connector.
+
+![eDROP Connector Process Flow](eDROPConnectorFlow.png)
+
 ## Copyright 
 By committing code to this repository, you agree to transfer or license your copyright to the project under its current terms.

eDROPConnectorFlow.png

@@ -12,7 +12,7 @@ echo "Starting $NAME as `whoami`"
 cd $DJANGODIR
 source .env_app
 export DJANGO_SETTINGS_MODULE=$DJANGO_SETTINGS_MODULE
-
+export PYTHONPATH=$DJANGODIR:$PYTHONPATH
 mkdir -p /edrop/logs
 
 # start the cron job

edrop-cron.sh

@@ -14,7 +14,8 @@
 import os, logging
 
 logger = logging.getLogger(__name__)
-logging.basicConfig(format="%(levelname)s: %(name)s: %(message)s")
+LOGLEVEL = os.environ.get('LOGLEVEL', 'INFO').upper()
+logging.basicConfig(format="%(levelname)s: %(name)s: %(message)s", level=LOGLEVEL)
 
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
@@ -141,6 +142,9 @@
 
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 
+# set the timezone in which dates should be displayed when writing to REDCap
+REQUEST_TIMEZONE = os.environ.get('REQUEST_TIMEZONE', "MST")
+
 # REDCap configurations
 REDCAP_INSTRUMENT_ID = "contact"
 REDCAP_FIELD_TO_BE_COMPLETE = "contact_complete"

edrop/settings.py

@@ -79,7 +79,7 @@
             "responses": [
                 {
                     "uuid": "2fdaec13-6d2a-4066-aca5-999dc5b09f1a",
-                    "body": "{\n  \"ShippingConfirmations\": [\n    {\n      \"OrderNumber\": \"EDROP-00001\",\n      \"Shipper\": \"gbf shipping document\",\n      \"ShipVia\": \"customer ship method\",\n      \"ShipDate\": \"2023-01-12\",\n      \"ClientID\": \"XXXX\",\n      \"Tracking\": [\n        \"outbound tracking 1\",\n\t\t\"outbound tracking 2\"\n      ],\n      \"Items\": [\n        {\n          \"ItemNumber\": \"customer item number (serialized example)\",\n          \"LotNumber\": \"gbf lot number\",\n\t\t  \"ExpireDate\": \"kit expire date\",\n          \"SerialNumber\": \"gbf kit serial\",\n          \"ShippedQty\": 1,\n\t\t  \"TubeSerials\" : [\n\t\t\t\"child 1\",\n\t\t\t\"child 1\"\n\t\t  ],\n          \"ReturnTracking\": [\n            \"inbound tracking\"\n          ]\n        },\n\t\t{\n\t\t  \"ItemNumber\": \"customer item number (non serialized example)\",\n          \"LotNumber\": \"gbf lot number\",\n\t\t  \"ExpireDate\": \"kit expire date\",\n          \"ShippedQty\": 5\n\t\t}\n      ]\n    }\n  ]\n}",
+                    "body": "{\n    \"success\": true,\n    \"dataArray\": [\n        {\n            \"format\": \"json\",\n            \"data\": \"{\\r\\n  \\\"ShippingConfirmations\\\": [\\r\\n    {\\r\\n      \\\"OrderNumber\\\": \\\"EDROP-00014\\\",\\r\\n      \\\"Shipper\\\": \\\"\\\",\\r\\n      \\\"ShipVia\\\": \\\"FedEx Ground\\\",\\r\\n      \\\"ShipDate\\\": \\\"2025-01-23\\\",\\r\\n      \\\"ClientID\\\": \\\"\\\",\\r\\n      \\\"Tracking\\\": [\\r\\n        \\\"270000004830\\\"\\r\\n      ],\\r\\n      \\\"Items\\\": [\\r\\n        {\\r\\n          \\\"ItemNumber\\\": \\\"K-BAN-001\\\",\\r\\n          \\\"SerialNumber\\\": \\\"EV-05FCSG\\\",\\r\\n          \\\"ShippedQty\\\": 1,\\r\\n          \\\"ReturnTracking\\\": [\\r\\n            \\\"XXXXXXXXXXXX\\\"\\r\\n          ],\\r\\n          \\\"TubeSerial\\\": [\\r\\n            \\\"SIHIRJT5786\\\"\\r\\n          ]\\r\\n        }\\r\\n      ]\\r\\n    }\\r\\n  ]\\r\\n}\"\n        }\n    ]\n}",
                     "latency": 0,
                     "statusCode": 200,
                     "label": "",

mockoon/gbf.json

@@ -3,4 +3,5 @@ gunicorn==22.0.0
 psycopg2==2.9.10
 dj-static==0.0.6
 requests==2.32.3
-django-apscheduler==0.7.0
+django-apscheduler==0.7.0
+pytz==2024.2

requirements.txt

@@ -3,7 +3,7 @@
 
 # Register your models here.
 class OrderAdmin(admin.ModelAdmin):
-    list_display = ["record_id", "order_number", "tracking_nrs", "order_status", "ship_date"]
+    list_display = ["record_id", "order_number", "tracking_nrs", "return_tracking_nrs", "tube_serials", "order_status", "ship_date"]
 
 
 admin.site.register(Order, OrderAdmin)

track/admin.py

@@ -33,25 +33,29 @@ def _generate_order_number(order):
 def _generate_order_json(order, address_data):
     order_json = {
         "test": settings.GBF_TEST_FLAG,
-        "orderNumber": order.order_number,
-        "shippingInfo": {
-            "address": {
-                "company": f"{address_data['first_name'] if 'first_name' in address_data else ''} {address_data['last_name'] if 'last_name' in address_data else ''}",
-                "addressLine1": address_data['street_1'] if 'street_1' in address_data else '',
-                "addressLine2": address_data['street_2'] if 'street_2' in address_data else '', # in case we add this to redcap, we need to add
-                "city": address_data['city'] if 'city' in address_data else '',
-                "state": address_data['state'] if 'state' in address_data else '',
-                "zipCode": address_data['zip'] if 'zip' in address_data else '',
-                "country": settings.GBF_SHIPPING_COUNTRY,
-                "phone": address_data['phone'] if 'phone' in address_data else '',
-                "residential": True # see GitHub discussion #19 (shipping address)
-            },
-            "shipMethod": settings.GBF_SHIPPING_METHOD,
-        },
-        "lineItems": [
+        "orders": [
             {
-            "itemNumber": settings.GBF_ITEM_NR,
-            "itemQuantity": settings.GBF_ITEM_QUANTITY,
+                "orderNumber": order.order_number,
+                "shippingInfo": {
+                    "address": {
+                        "company": f"{address_data['first_name'] if 'first_name' in address_data else ''} {address_data['last_name'] if 'last_name' in address_data else ''}",
+                        "addressLine1": address_data['street_1'] if 'street_1' in address_data else '',
+                        "addressLine2": address_data['street_2'] if 'street_2' in address_data else '', # in case we add this to redcap, we need to add
+                        "city": address_data['city'] if 'city' in address_data else '',
+                        "state": address_data['state'] if 'state' in address_data else '',
+                        "zipCode": address_data['zip'] if 'zip' in address_data else '',
+                        "country": settings.GBF_SHIPPING_COUNTRY,
+                        "phone": address_data['phone'] if 'phone' in address_data else '',
+                        "residential": True # see GitHub discussion #19 (shipping address)
+                    },
+                    "shipMethod": settings.GBF_SHIPPING_METHOD,
+                },
+                "lineItems": [
+                    {
+                    "itemNumber": settings.GBF_ITEM_NR,
+                    "itemQuantity": settings.GBF_ITEM_QUANTITY,
+                    }
+                ]
             }
         ]
     }
@@ -79,9 +83,16 @@ def _place_order_with_GBF(order_json):
     logger.error("Response from GBF:")
     logger.error(response)
 
+    response_body = response.json()
     if response.status_code != HTTPStatus.OK:
         logger.error("Could not submit order to GBF.")
         logger.error(response)
+        logger.error(response_body)
+        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)
         return False
 
     return True
@@ -93,13 +104,25 @@ def get_order_confirmations(order_numbers):
     - tracking numbers
     - return tracking numbers
 
+    GBF sends json like this:
+    {
+        "success": true,
+        "dataArray": [
+            {
+                "format": "json",
+                "data": "{\r\n  \"ShippingConfirmations\": [\r\n    {\r\n      \"OrderNumber\": \"EDROP-00014\",\r\n      \"Shipper\": \"\",\r\n      \"ShipVia\": \"FedEx Ground\",\r\n      \"ShipDate\": \"2025-01-23\",\r\n      \"ClientID\": \"\",\r\n      \"Tracking\": [\r\n        \"270000004830\"\r\n      ],\r\n      \"Items\": [\r\n        {\r\n          \"ItemNumber\": \"K-BAN-001\",\r\n          \"SerialNumber\": \"EV-05FCSG\",\r\n          \"ShippedQty\": 1,\r\n          \"ReturnTracking\": [\r\n            \"XXXXXXXXXXXX\"\r\n          ],\r\n          \"TubeSerial\": [\r\n            \"SIHIRJT5786\"\r\n          ]\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}"
+            }
+        ]
+    }
+
     Returns:
     -  a dictionary of the form:
     {
         'EDROP-001': {
             'date_kit_shipped': '2023-01-12', 
             'kit_tracking_n': ['outbound tracking 1', 'outbound tracking 2'], 
-            'return_tracking_n': ['inbound tracking', 'inbound tracking2']
+            'return_tracking_n': ['inbound tracking', 'inbound tracking2'],
+            'tube_serial_n': [tube serial1', 'tube serial2']
         }
     }
     """
@@ -108,20 +131,43 @@ def get_order_confirmations(order_numbers):
     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) 
         return None  
 
-    confirmations = response.json()
+    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)
+
+    if "dataArray" not in response_body or not response_body["dataArray"]:
+        logger.info("No GBF confirmations available.")
+        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.")
+        return None
+    
+    if 'data' not in data_object or not data_object["data"]:
+        logger.info("No GBF confirmations available.")
+        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'],
                 #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 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']]
             }  
     return tracking_info   
 

track/gbf.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.1.4 on 2025-01-31 04:31
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('track', '0008_remove_order_return_tracking_nr_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='order',
+            name='tube_serials',
+            field=django.contrib.postgres.fields.ArrayField(base_field=models.CharField(), blank=True, null=True, size=None),
+        ),
+    ]