Merge pull request #396 from MySecondLanguage/test-case-written-for-order-fullfillment

Test case written for order fullfillment

Author: MySecondLanguage

nxtbn/core/enum_perms.py

@@ -9,6 +9,8 @@ class PermissionsEnum(models.TextChoices):
     CAN_DELIVER_ORDER = "can_deliver_order"
     CAN_UPDATE_ORDER_PYMENT_TERM = "can_update_order_payment_term"
     CAN_UPDATE_ORDER_PAYMENT_METHOD = "can_update_order_payment_method"
+    CAN_FULLFILL_ORDER = "can_fullfill_order" #  Directly fullfill order, will not check lifecycle
+    
 
     CAN_INITIATE_PAYMENT_REFUND = "CAN_INITIATE_PAYMENT_REFUND"
 

nxtbn/order/api/dashboard/serializers.py

@@ -213,6 +213,8 @@ def validate(self, attrs):
                 raise serializers.ValidationError(_("Order is already shipped or delivered."))
             if current_status == OrderStatus.RETURNED:
                 raise serializers.ValidationError(_("Returned orders cannot be re-shipped."))
+            if current_status != OrderStatus.PACKED:
+                raise serializers.ValidationError(_("Order must be packed before it can be shipped."))
 
         if new_status == OrderStatus.DELIVERED:
             if current_status == OrderStatus.CANCELLED:

nxtbn/order/api/dashboard/urls.py

@@ -10,6 +10,7 @@
     path('create-customer/', order_views.CreateCustomAPIView.as_view(), name='create-customer'),
     path('orders/<uuid:alias>/', order_views.OrderDetailView.as_view(), name='order-detail'),
     path('orders/status/update/<uuid:alias>/', order_views.OrderStatusUpdateAPIView.as_view(), name='order-status-update'),
+    path('orders/fulfill/<uuid:alias>/', order_views.OrderMarkAsFullfiledAPIView.as_view(), name='order-fulfillment-status-update'),
     path('orders/payment-term/update/<uuid:alias>/', order_views.OrderPaymentTermUpdateAPIView.as_view(), name='order-payment-term-update'),
     path('orders/payment-method/update/<uuid:alias>/', order_views.OrderPaymentMethodUpdateAPIView.as_view(), name='order-payment-method-update'),
     path('orders/return-request/', order_views.ReturnRequestAPIView.as_view(), name='return-request'),

nxtbn/order/api/dashboard/views.py

@@ -9,6 +9,7 @@
 
 from rest_framework.views import APIView
 from django.db.models import Sum, Count, F
+from django.db import transaction
 from django.db.models.functions import TruncMonth, TruncDay, TruncWeek, TruncHour
 
 from django.utils import timezone
@@ -40,6 +41,9 @@
 
 from calendar import monthrange, day_name
 from nxtbn.warehouse.utils import adjust_stocks_returned_items
+from nxtbn.warehouse.utils import deduct_reservation_on_packed_for_dispatch, release_stock
+from nxtbn.order import OrderStockReservationStatus, ReturnReceiveStatus
+
 
 
 
@@ -429,8 +433,6 @@ def check_permissions(self, request):
         status = request.data.get('status')
         user = request.user
 
-        print(status, 'status')
-
         permission_map = {
             OrderStatus.CANCELLED: PermissionsEnum.CAN_CANCEL_ORDER,
             OrderStatus.SHIPPED: PermissionsEnum.CAN_SHIP_ORDER,
@@ -440,14 +442,42 @@ def check_permissions(self, request):
         }
 
         required_permission = permission_map.get(status)
-        print(required_permission, 'required_permission')
         if required_permission and not has_required_perm(user, required_permission, Order):
             self.permission_denied(
                 request,
                 message=_("You do not have permission to perform this action."),
                 code='permission_denied'
             )
 
+class OrderMarkAsFullfiledAPIView(generics.GenericAPIView):
+    queryset = Order.objects.all()
+    serializer_class = OrderStatusUpdateSerializer
+    permission_classes = (GranularPermission, )
+    required_perm = PermissionsEnum.CAN_FULLFILL_ORDER
+
+    def patch(self, request, *args, **kwargs):
+        with transaction.atomic():
+            instance = Order.objects.get(alias=kwargs['alias'])
+
+            if instance.status == OrderStatus.DELIVERED:
+                raise ValidationError("Order is already marked as fulfilled.")
+            
+            if instance.status == OrderStatus.CANCELLED:
+                raise ValidationError("Cannot mark a cancelled order as fulfilled.")
+            
+            if instance.status == OrderStatus.RETURNED:
+                raise ValidationError("Cannot mark a returned order as fulfilled.")
+            
+            # Now check stock and reservation
+            if instance.reservation_status == OrderStockReservationStatus.DISPATCHED: # do nothing if already dispatched
+                pass
+            else:
+                deduct_reservation_on_packed_for_dispatch(instance)
+
+            instance.status = OrderStatus.DELIVERED
+            instance.save()
+            return Response({"message": "Order marked as fulfilled."}, status=status.HTTP_200_OK)
+
 class OrderPaymentTermUpdateAPIView(generics.UpdateAPIView):
     model = Order
     permission_classes = (GranularPermission, )

nxtbn/order/migrations/0039_alter_order_options.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.2.11 on 2025-02-20 14:31
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("order", "0038_alter_order_reservation_status"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="order",
+            options={
+                "ordering": ("-created_at",),
+                "permissions": [
+                    ("can_approve_order", "Can approve order"),
+                    ("can_cancel_order", "Can cancel order"),
+                    ("can_ship_order", "Can ship order"),
+                    ("can_pack_order", "Can process order"),
+                    ("can_deliver_order", "Can deliver order"),
+                    ("can_update_order_payment_term", "Can update order payment term"),
+                    (
+                        "can_update_order_payment_method",
+                        "Can update order payment method",
+                    ),
+                    ("can_fullfill_order", "Can fullfill order"),
+                ],
+            },
+        ),
+    ]

nxtbn/order/models.py

@@ -258,6 +258,7 @@ class Meta:
             (PermissionsEnum.CAN_DELIVER_ORDER, 'Can deliver order'),
             (PermissionsEnum.CAN_UPDATE_ORDER_PYMENT_TERM, 'Can update order payment term'),
             (PermissionsEnum.CAN_UPDATE_ORDER_PAYMENT_METHOD, 'Can update order payment method'),
+            (PermissionsEnum.CAN_FULLFILL_ORDER, 'Can fullfill order'), # Directly fullfill order, will not check order lifecycle
         ]
 
     def save(self, *args, **kwargs):

nxtbn/order/proccesor/views.py

@@ -72,7 +72,6 @@ def get_shipping_rate_instance(shipping_method_id, address, total_weight):
                     region__isnull=True,
                     city__isnull=True
                 ).first()
-                print(rate, 'rate for country')
                 return rate
 
         # Global
@@ -84,7 +83,6 @@ def get_shipping_rate_instance(shipping_method_id, address, total_weight):
                     region__isnull=True,
                     city__isnull=True
                 ).first()
-                print(rate, 'rate for global')
                 return rate
         else:
             raise serializers.ValidationError({"details": "We don't ship to this location."})

nxtbn/order/tests/test_order_reservation_cancel_shipped_merge_return_sc.py

@@ -251,11 +251,11 @@ def test_order_back_order_allowed(self):
         # Now Ship the successfull order
         order_status_update_url = reverse('order-status-update', args=[order_out_of_stock_response_with_stock_tracking_bo.data['order_alias']])
         approve = self.auth_client.patch(order_status_update_url, {"status": OrderStatus.APPROVED}, format='json')
-        processing = self.auth_client.patch(order_status_update_url, {"status": OrderStatus.PACKED}, format='json')
+        packed = self.auth_client.patch(order_status_update_url, {"status": OrderStatus.PACKED}, format='json')
         shipped = self.auth_client.patch(order_status_update_url, {"status": OrderStatus.SHIPPED}, format='json')
 
         self.assertEqual(approve.status_code, status.HTTP_200_OK)
-        self.assertEqual(processing.status_code, status.HTTP_200_OK)
+        self.assertEqual(packed.status_code, status.HTTP_400_BAD_REQUEST) # as order is not reserved, mean is not in stock, so packing should not be allowed
 
         self.assertEqual(shipped.status_code, status.HTTP_400_BAD_REQUEST) # as order is not reserved, it should not be shipped
 
@@ -288,6 +288,10 @@ def test_order_back_order_allowed(self):
         self.assertEqual(remained_stock_without_bo, 15)
         self.assertEqual(reserved_stock_without_bo, 8)
 
+        # now pack
+        packed = self.auth_client.patch(order_status_update_url, {"status": OrderStatus.PACKED}, format='json')
+        self.assertEqual(packed.status_code, status.HTTP_200_OK) # as order is reserved, it should be packed
+
         # as enough stock is available and order is reserved, now ship the order
         shipped = self.auth_client.put(order_status_update_url, {"status": OrderStatus.SHIPPED}, format='json')
         self.assertEqual(shipped.status_code, status.HTTP_200_OK)