Update shipment on cancellation (#33)

Author: gfrn

src/scaup/crud/shipments.py

@@ -304,8 +304,12 @@ def get_shipment_request(shipmentId: int):
 
 
 def handle_callback(shipment_id: int, callback_body: StatusUpdate):
+    columns: dict[str, str | None] = {
+        "status": callback_body.status if callback_body.status != "CREATED" else "Pickup Cancelled"
+    }
+
     updated_shipment = inner_db.session.scalar(
-        update(Shipment).returning(Shipment).filter_by(id=shipment_id).values({"status": callback_body.status})
+        update(Shipment).returning(Shipment).filter_by(id=shipment_id).values(columns)
     )
 
     inner_db.session.commit()

src/scaup/models/shipments.py

@@ -79,8 +79,8 @@ class ShipmentExternal(BaseExternal):
 
 class StatusUpdate(BaseModel):
     origin_url: str
-    journey_type: str
+    journey_type: str | None = None
     status: str
-    tracking_number: str
+    tracking_number: str | None = None
     pickup_confirmation_code: str | None = None
     pickup_confirmation_timestamp: datetime | None

tests/shipments/test_update_status.py

@@ -5,7 +5,7 @@
 
 
 def test_post(client):
-    """Should get shipment details as tree of generic items"""
+    """Should update shipment status"""
     resp = client.post(
         "/shipments/118/update-status",
         params={"token": ""},
@@ -24,3 +24,18 @@ def test_post(client):
     new_status = inner_db.session.scalar(select(Shipment.status).filter(Shipment.id == 118))
 
     assert new_status == "New Status"
+
+
+def test_cancelled(client):
+    """Should treat "CREATED" as a pickup cancellation"""
+    resp = client.post(
+        "/shipments/118/update-status",
+        params={"token": ""},
+        json={"status": "CREATED", "origin_url": "https://fake.com", "pickup_confirmation_timestamp": 1},
+    )
+
+    assert resp.status_code == 200
+
+    new_status = inner_db.session.scalar(select(Shipment.status).filter(Shipment.id == 118))
+
+    assert new_status == "Pickup Cancelled"