Refactor UpcomingInvoice so it's no longer a subclass of Invoice (dj-…

…stripe#1077) This is to allow Invoice to use ManyToManyFields.
lsanpablo · Dec 14, 2019 · 7ea0953 · 7ea0953
1 parent ea3fe3a
commit 7ea0953
Show file tree

Hide file tree

Showing 11 changed files with 541 additions and 25 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -9,6 +9,7 @@ History
 - Changed ``JSONField`` dependency package from `jsonfield`_ to `jsonfield2`_, for Django 3 compatibility (see `Warning about safe uninstall of jsonfield on upgrade`_). Note that Django 2.1 requires jsonfield<3.1.
 - Added support for Django 3.0 (requires jsonfield2>=3.0.3).
 - Added support for python 3.8.
+- Refactored ``UpcomingInvoice``, so it's no longer a subclass of ``Invoice`` (to allow ``Invoice`` to use ``ManyToManyFields``).
 - Dropped previously-deprecated ``Account`` fields (see https://stripe.com/docs/upgrades#2019-02-19 ):
     - ``.business_name``
     - ``.business_primary_color``

diff --git a/djstripe/migrations/0009_delete_upcominginvoice.py b/djstripe/migrations/0009_delete_upcominginvoice.py
@@ -0,0 +1,14 @@
+# Generated by Django 3.0 on 2019-12-14 00:49
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("djstripe", "0008_auto_20191212_1434"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(name="UpcomingInvoice",),
+    ]
diff --git a/djstripe/migrations/0010_upcominginvoice.py b/djstripe/migrations/0010_upcominginvoice.py
diff --git a/djstripe/models/billing.py b/djstripe/models/billing.py
@@ -124,28 +124,13 @@ def human_readable(self):
         )
 
 
-class Invoice(StripeModel):
+class BaseInvoice(StripeModel):
     """
-    Invoices are statements of what a customer owes for a particular billing
-    period, including subscriptions, invoice items, and any automatic proration
-    adjustments if necessary.
-
-    Once an invoice is created, payment is automatically attempted. Note that
-    the payment, while automatic, does not happen exactly at the time of invoice
-    creation. If you have configured webhooks, the invoice will wait until one
-    hour after the last webhook is successfully sent (or the last webhook times
-    out after failing).
-
-    Any customer credit on the account is applied before determining how much is
-    due for that invoice (the amount that will be actually charged).
-    If the amount due for the invoice is less than 50 cents (the minimum for a
-    charge), we add the amount to the customer's running account balance to be
-    added to the next invoice. If this amount is negative, it will act as a
-    credit to offset the next invoice. Note that the customer account balance
-    does not include unpaid invoices; it only includes balances that need to be
-    taken into account when calculating the amount due for the next invoice.
+    The abstract base model shared by Invoice and UpcomingInvoice
 
-    Stripe documentation: https://stripe.com/docs/api/python#invoices
+    Note:
+    Most fields are defined on BaseInvoice so they're available to both models.
+    ManyToManyFields are an exception, since UpcomingInvoice doesn't exist in the db.
     """
 
     stripe_class = stripe.Invoice
@@ -228,7 +213,9 @@ class Invoice(StripeModel):
         "Charge",
         on_delete=models.CASCADE,
         null=True,
-        related_name="latest_invoice",
+        # we need to use the %(class)s placeholder to avoid related name
+        # clashes between Invoice and UpcomingInvoice
+        related_name="latest_%(class)s",
         help_text="The latest charge generated for this invoice, if any.",
     )
     # deprecated, will be removed in 2.2
@@ -252,7 +239,9 @@ class Invoice(StripeModel):
     customer = models.ForeignKey(
         "Customer",
         on_delete=models.CASCADE,
-        related_name="invoices",
+        # we need to use the %(class)s placeholder to avoid related name
+        # clashes between Invoice and UpcomingInvoice
+        related_name="%(class)ss",
         help_text="The customer associated with this invoice.",
     )
     customer_address = JSONField(
@@ -432,7 +421,9 @@ class Invoice(StripeModel):
     subscription = models.ForeignKey(
         "Subscription",
         null=True,
-        related_name="invoices",
+        # we need to use the %(class)s placeholder to avoid related name
+        # clashes between Invoice and UpcomingInvoice
+        related_name="%(class)ss",
         on_delete=models.SET_NULL,
         help_text="The subscription that this invoice was prepared for, if any.",
     )
@@ -479,7 +470,8 @@ class Invoice(StripeModel):
         ),
     )
 
-    class Meta(object):
+    class Meta:
+        abstract = True
         ordering = ["-created"]
 
     def __str__(self):
@@ -688,7 +680,45 @@ def plan(self):
             return self.subscription.plan
 
 
-class UpcomingInvoice(Invoice):
+class Invoice(BaseInvoice):
+    """
+    Invoices are statements of what a customer owes for a particular billing
+    period, including subscriptions, invoice items, and any automatic proration
+    adjustments if necessary.
+
+    Once an invoice is created, payment is automatically attempted. Note that
+    the payment, while automatic, does not happen exactly at the time of invoice
+    creation. If you have configured webhooks, the invoice will wait until one
+    hour after the last webhook is successfully sent (or the last webhook times
+    out after failing).
+
+    Any customer credit on the account is applied before determining how much is
+    due for that invoice (the amount that will be actually charged).
+    If the amount due for the invoice is less than 50 cents (the minimum for a
+    charge), we add the amount to the customer's running account balance to be
+    added to the next invoice. If this amount is negative, it will act as a
+    credit to offset the next invoice. Note that the customer account balance
+    does not include unpaid invoices; it only includes balances that need to be
+    taken into account when calculating the amount due for the next invoice.
+
+    Stripe documentation: https://stripe.com/docs/api/python#invoices
+    """
+
+    # Note:
+    # Most fields are defined on BaseInvoice so they're shared with UpcomingInvoice.
+    # ManyToManyFields are an exception, since UpcomingInvoice doesn't exist in the db.
+
+
+class UpcomingInvoice(BaseInvoice):
+    """
+    The preview of an upcoming invoice - does not exist in the Django database.
+
+    See BaseInvoice.upcoming()
+
+    Logically it should be set abstract, but that doesn't quite work since we
+    do actually want to instantiate the model and use relations.
+    """
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._invoiceitems = []

diff --git a/tests/test_charge.py b/tests/test_charge.py
@@ -44,12 +44,14 @@ def setUp(self):
         self.account = default_account()
         self.default_expected_blank_fks = {
             "djstripe.Charge.dispute",
+            "djstripe.Charge.latest_upcominginvoice (related name)",
             "djstripe.Charge.transfer",
             "djstripe.Customer.coupon",
             "djstripe.Customer.default_payment_method",
             "djstripe.Invoice.default_payment_method",
             "djstripe.PaymentIntent.on_behalf_of",
             "djstripe.PaymentIntent.payment_method",
+            "djstripe.PaymentIntent.upcominginvoice (related name)",
             "djstripe.Subscription.pending_setup_intent",
         }
 

diff --git a/tests/test_customer.py b/tests/test_customer.py
@@ -712,13 +712,15 @@ def test_refund_charge(
                 "djstripe.Account.branding_icon",
                 "djstripe.Charge.dispute",
                 "djstripe.Charge.latest_invoice (related name)",
+                "djstripe.Charge.latest_upcominginvoice (related name)",
                 "djstripe.Charge.invoice",
                 "djstripe.Charge.transfer",
                 "djstripe.Customer.coupon",
                 "djstripe.Customer.default_payment_method",
                 "djstripe.PaymentIntent.invoice (related name)",
                 "djstripe.PaymentIntent.on_behalf_of",
                 "djstripe.PaymentIntent.payment_method",
+                "djstripe.PaymentIntent.upcominginvoice (related name)",
             },
         )
 
@@ -739,13 +741,15 @@ def test_refund_charge(
                 "djstripe.Account.branding_icon",
                 "djstripe.Charge.dispute",
                 "djstripe.Charge.latest_invoice (related name)",
+                "djstripe.Charge.latest_upcominginvoice (related name)",
                 "djstripe.Charge.invoice",
                 "djstripe.Charge.transfer",
                 "djstripe.Customer.coupon",
                 "djstripe.Customer.default_payment_method",
                 "djstripe.PaymentIntent.invoice (related name)",
                 "djstripe.PaymentIntent.on_behalf_of",
                 "djstripe.PaymentIntent.payment_method",
+                "djstripe.PaymentIntent.upcominginvoice (related name)",
             },
         )
 
@@ -797,13 +801,15 @@ def test_refund_charge_object_returned(
                 "djstripe.Account.branding_icon",
                 "djstripe.Charge.dispute",
                 "djstripe.Charge.latest_invoice (related name)",
+                "djstripe.Charge.latest_upcominginvoice (related name)",
                 "djstripe.Charge.invoice",
                 "djstripe.Charge.transfer",
                 "djstripe.Customer.coupon",
                 "djstripe.Customer.default_payment_method",
                 "djstripe.PaymentIntent.invoice (related name)",
                 "djstripe.PaymentIntent.on_behalf_of",
                 "djstripe.PaymentIntent.payment_method",
+                "djstripe.PaymentIntent.upcominginvoice (related name)",
             },
         )
 
@@ -818,13 +824,15 @@ def test_refund_charge_object_returned(
                 "djstripe.Account.branding_icon",
                 "djstripe.Charge.dispute",
                 "djstripe.Charge.latest_invoice (related name)",
+                "djstripe.Charge.latest_upcominginvoice (related name)",
                 "djstripe.Charge.invoice",
                 "djstripe.Charge.transfer",
                 "djstripe.Customer.coupon",
                 "djstripe.Customer.default_payment_method",
                 "djstripe.PaymentIntent.invoice (related name)",
                 "djstripe.PaymentIntent.on_behalf_of",
                 "djstripe.PaymentIntent.payment_method",
+                "djstripe.PaymentIntent.upcominginvoice (related name)",
             },
         )
 

diff --git a/tests/test_invoice.py b/tests/test_invoice.py
@@ -42,12 +42,14 @@ def setUp(self):
             "djstripe.Account.branding_logo",
             "djstripe.Account.branding_icon",
             "djstripe.Charge.dispute",
+            "djstripe.Charge.latest_upcominginvoice (related name)",
             "djstripe.Charge.transfer",
             "djstripe.Customer.coupon",
             "djstripe.Customer.default_payment_method",
             "djstripe.Invoice.default_payment_method",
             "djstripe.PaymentIntent.on_behalf_of",
             "djstripe.PaymentIntent.payment_method",
+            "djstripe.PaymentIntent.upcominginvoice (related name)",
             "djstripe.Subscription.pending_setup_intent",
         }
 

diff --git a/tests/test_invoiceitem.py b/tests/test_invoiceitem.py
@@ -32,6 +32,7 @@ def setUp(self):
             "djstripe.Account.branding_logo",
             "djstripe.Account.branding_icon",
             "djstripe.Charge.dispute",
+            "djstripe.Charge.latest_upcominginvoice (related name)",
             "djstripe.Charge.payment_intent",
             "djstripe.Charge.payment_method",
             "djstripe.Charge.transfer",

diff --git a/tests/test_payment_intent.py b/tests/test_payment_intent.py
@@ -28,6 +28,7 @@ def test_sync_from_stripe_data(self, customer_retrieve_mock):
                 "djstripe.PaymentIntent.invoice (related name)",
                 "djstripe.PaymentIntent.on_behalf_of",
                 "djstripe.PaymentIntent.payment_method",
+                "djstripe.PaymentIntent.upcominginvoice (related name)",
             },
         )
 

diff --git a/tests/test_refund.py b/tests/test_refund.py
@@ -38,12 +38,14 @@ def setUp(self):
             "djstripe.Account.branding_logo",
             "djstripe.Account.branding_icon",
             "djstripe.Charge.dispute",
+            "djstripe.Charge.latest_upcominginvoice (related name)",
             "djstripe.Charge.transfer",
             "djstripe.Customer.coupon",
             "djstripe.Customer.default_payment_method",
             "djstripe.Invoice.default_payment_method",
             "djstripe.PaymentIntent.on_behalf_of",
             "djstripe.PaymentIntent.payment_method",
+            "djstripe.PaymentIntent.upcominginvoice (related name)",
             "djstripe.Subscription.pending_setup_intent",
             "djstripe.Refund.failure_balance_transaction",
         }

diff --git a/tests/test_session.py b/tests/test_session.py
@@ -40,6 +40,7 @@ def test_sync_from_stripe_data(
                 "djstripe.PaymentIntent.invoice (related name)",
                 "djstripe.PaymentIntent.on_behalf_of",
                 "djstripe.PaymentIntent.payment_method",
+                "djstripe.PaymentIntent.upcominginvoice (related name)",
                 "djstripe.Session.subscription",
             },
         )