Move things around for readability in uncloud_pay models and serializer

uncloud/uncloud_pay/models.py

@@ -10,6 +10,7 @@ from calendar import monthrange
 
 import uuid
 
+# Define DecimalField properties, used to represent amounts of money.
 AMOUNT_MAX_DIGITS=10
 AMOUNT_DECIMALS=2
 
@@ -23,6 +24,70 @@ class RecurringPeriod(models.TextChoices):
     PER_HOUR   = 'HOUR', _('Per Hour')
     PER_SECOND = 'SECOND', _('Per Second')
 
+###
+# Payments and Payment Methods.
+
+class Payment(models.Model):
+    uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+
+    owner = models.ForeignKey(get_user_model(),
+            on_delete=models.CASCADE)
+
+    amount = models.DecimalField(
+            default=0.0,
+            max_digits=AMOUNT_MAX_DIGITS,
+            decimal_places=AMOUNT_DECIMALS,
+            validators=[MinValueValidator(0)])
+
+    source = models.CharField(max_length=256,
+                              choices = (
+                                  ('wire', 'Wire Transfer'),
+                                  ('stripe', 'Stripe'),
+                                  ('voucher', 'Voucher'),
+                                  ('referral', 'Referral'),
+                                  ('unknown', 'Unknown')
+                              ),
+                              default='unknown')
+    timestamp = models.DateTimeField(editable=False, auto_now_add=True)
+
+class PaymentMethod(models.Model):
+    uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+    owner = models.ForeignKey(get_user_model(),
+            on_delete=models.CASCADE,
+            editable=False)
+    source = models.CharField(max_length=256,
+            choices = (
+                ('stripe', 'Stripe'),
+                ('unknown', 'Unknown'),
+                ),
+            default='stripe')
+    description = models.TextField()
+    primary = models.BooleanField(default=True)
+
+    # Only used for "Stripe" source
+    stripe_card_id = models.CharField(max_length=32, blank=True, null=True)
+
+    def charge(self, amount):
+        if amount > 0: # Make sure we don't charge negative amount by errors...
+            if self.source == 'stripe':
+                # TODO: wire to stripe, see meooow-payv1/strip_utils.py
+                payment = Payment(owner=self.owner, source=self.source, amount=amount)
+                payment.save() # TODO: Check return status
+
+                return True
+            else:
+                # We do not handle that source yet.
+                return False
+        else:
+            return False
+
+    class Meta:
+        unique_together = [['owner', 'primary']]
+
+
+###
+# Bills & Payments.
+
 class Bill(models.Model):
     uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     owner = models.ForeignKey(get_user_model(),
@@ -56,6 +121,10 @@ class Bill(models.Model):
         return self.ending_date < timezone.now()
 
 class BillRecord():
+    """
+    Entry of a bill, dynamically generated from order records.
+    """
+
     def __init__(self, bill, order_record):
         self.bill = bill
         self.order = order_record.order
@@ -114,6 +183,9 @@ class BillRecord():
             raise Exception('Unsupported recurring period: {}.'.
                     format(record.recurring_period))
 
+###
+# Orders.
+
 # /!\ BIG FAT WARNING /!\ #
 #
 # Order are assumed IMMUTABLE and used as SOURCE OF TRUST for generating
@@ -190,63 +262,12 @@ class OrderRecord(models.Model):
     def ending_date(self):
         return self.order.ending_date
 
-class PaymentMethod(models.Model):
-    uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
-    owner = models.ForeignKey(get_user_model(),
-            on_delete=models.CASCADE,
-            editable=False)
-    source = models.CharField(max_length=256,
-            choices = (
-                ('stripe', 'Stripe'),
-                ('unknown', 'Unknown'),
-                ),
-            default='stripe')
-    description = models.TextField()
-    primary = models.BooleanField(default=True)
 
-    # Only used for "Stripe" source
-    stripe_card_id = models.CharField(max_length=32, blank=True, null=True)
-
-    def charge(self, amount):
-        if amount > 0: # Make sure we don't charge negative amount by errors...
-            if self.source == 'stripe':
-                # TODO: wire to stripe, see meooow-payv1/strip_utils.py
-                payment = Payment(owner=self.owner, source=self.source, amount=amount)
-                payment.save() # TODO: Check return status
-
-                return True
-            else:
-                # We do not handle that source yet.
-                return False
-        else:
-            return False
-
-    class Meta:
-        unique_together = [['owner', 'primary']]
-
-class Payment(models.Model):
-    uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
-
-    owner = models.ForeignKey(get_user_model(),
-            on_delete=models.CASCADE)
-
-    amount = models.DecimalField(
-            default=0.0,
-            max_digits=AMOUNT_MAX_DIGITS,
-            decimal_places=AMOUNT_DECIMALS,
-            validators=[MinValueValidator(0)])
-
-    source = models.CharField(max_length=256,
-                              choices = (
-                                  ('wire', 'Wire Transfer'),
-                                  ('stripe', 'Stripe'),
-                                  ('voucher', 'Voucher'),
-                                  ('referral', 'Referral'),
-                                  ('unknown', 'Unknown')
-                              ),
-                              default='unknown')
-    timestamp = models.DateTimeField(editable=False, auto_now_add=True)
+###
+# Products
 
+# Abstract (= no database representation) class used as parent for products
+# (e.g.  uncloud_vm.models.VMProduct).
 class Product(models.Model):
     uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     owner = models.ForeignKey(get_user_model(),