add AbstractOrder.return_order

CHANGELOG

@@ -1,6 +1,10 @@
 django-plans changelog
 ======================
 
+1.1.0 (unreleased)
+------------------
+* Add `AbstractOrder.return_order()`
+
 1.0.6
 -----
 * Simplify the query generated by get_initial_number

demo/example/wsgi.py

@@ -13,6 +13,7 @@
 framework.
 
 """
+
 import os
 
 from django.core.wsgi import get_wsgi_application

docs/source/index.rst

@@ -47,6 +47,7 @@ Contributors:
 * Victor Safronovich <[email protected]>
 * Dominik Kozaczko <http://dominik.kozaczko.info>
 * Petr Dlouhý <[email protected]>
+* BlenderKit <[email protected]>
 
 Source code:
 https://github.com/cypreess/django-plans

plans/admin.py

@@ -151,6 +151,14 @@ def make_order_completed(modeladmin, request, queryset):
 make_order_completed.short_description = _("Make selected orders completed")
 
 
+def make_order_returned(modeladmin, request, queryset):
+    for order in queryset:
+        order.return_order()
+
+
+make_order_returned.short_description = _("Make selected orders returned")
+
+
 def make_order_invoice(modeladmin, request, queryset):
     for order in queryset:
         if (
@@ -192,7 +200,7 @@ class OrderAdmin(admin.ModelAdmin):
     )
     readonly_fields = ("created", "updated_at")
     list_display_links = list_display
-    actions = [make_order_completed, make_order_invoice]
+    actions = [make_order_completed, make_order_returned, make_order_invoice]
     inlines = (InvoiceInline,)
 
     def queryset(self, request):

plans/base/models.py

@@ -310,6 +310,13 @@ def get_plan_extended_until(self, plan, pricing):
             return self.expire
         return self.get_plan_extended_from(plan) + timedelta(days=pricing.period)
 
+    def get_plan_reduced_until(self, pricing):
+        if self.expire is None:
+            return self.expire
+        if pricing is None:
+            return self.expire
+        return self.expire - timedelta(days=pricing.period)
+
     def plan_autorenew_at(self):
         """
         Helper function which calculates when the plan autorenewal will occur
@@ -430,6 +437,16 @@ def extend_account(self, plan, pricing):
 
         return status
 
+    def reduce_account(self, pricing):
+        """
+        Manages reducing account after returning an order
+        :param pricing: if pricing is None then nothing is changed
+        :return:
+        """
+        if pricing is not None:
+            self.expire = self.get_plan_reduced_until(pricing)
+            self.save()
+
     def expire_account(self):
         """manages account expiration"""
 
@@ -831,6 +848,34 @@ def complete_order(self):
         else:
             return False
 
+    def return_order(self):
+        if self.status != self.STATUS.RETURNED:
+            if self.status == self.STATUS.COMPLETED:
+                if self.pricing is not None:
+                    extended_from = self.plan_extended_from
+                    if extended_from is None:
+                        extended_from = self.completed
+                    # Should never happen, but make sure we reduce for the same number of days as we extended.
+                    if (
+                        self.plan_extended_until is None
+                        or extended_from is None
+                        or self.plan_extended_until - extended_from
+                        != timedelta(days=self.pricing.period)
+                    ):
+                        raise ValueError(
+                            f"Invalid order state: completed={self.completed}, "
+                            f"plan_extended_from={self.plan_extended_from}, "
+                            f"plan_extended_until={self.plan_extended_until}, "
+                            f"pricing.period={self.pricing.period}"
+                        )
+                self.user.userplan.reduce_account(self.pricing)
+            elif self.status != self.STATUS.NOT_VALID:
+                raise ValueError(
+                    f"Cannot return order with status other than COMPLETED and NOT_VALID: {self.status}"
+                )
+            self.status = self.STATUS.RETURNED
+            self.save()
+
     def get_invoices_proforma(self):
         return AbstractInvoice.get_concrete_model().proforma.filter(order=self)