WIP Refactor all nested endpoints to use an injected resource path

Author: Tom Hendrikx

mollie/api/objects/balance.py

@@ -63,9 +63,9 @@ def pending_amount(self):
     def get_report(self, **params: Any) -> BalanceReport:
         from ..resources import BalanceReports
 
-        return BalanceReports(self.client, self).get_report(params=params)
+        return BalanceReports(self.client, resource_path=f"balances/{self.id}/report").get_report(params=params)
 
     def get_transactions(self, **params: Any) -> ObjectList:
         from ..resources import BalanceTransactions
 
-        return BalanceTransactions(self.client, self).list(params=params)
+        return BalanceTransactions(self.client, resource_path=f"balances/{self.id}/transactions").list(params=params)

mollie/api/objects/balance_report.py

@@ -2,12 +2,6 @@
 
 
 class BalanceReport(ObjectBase):
-    @classmethod
-    def get_resource_class(cls, client):
-        from ..resources import BalanceReports
-
-        return BalanceReports(client)
-
     @property
     def resource(self):
         return self._get_property("resource")

mollie/api/objects/payment.py

@@ -193,14 +193,14 @@ def chargebacks(self):
         """Return the chargebacks related to this payment."""
         from ..resources import PaymentChargebacks
 
-        return PaymentChargebacks(self.client, self)
+        return PaymentChargebacks(self.client, resource_path=f"payments/{self.id}/chargebacks")
 
     @property
     def captures(self):
         """Return the captures related to this payment"""
         from ..resources import PaymentCaptures
 
-        return PaymentCaptures(self.client, self)
+        return PaymentCaptures(self.client, resource_path=f"payments/{self.id}/captures")
 
     def get_settlement(self):
         """Return the settlement for this payment."""

mollie/api/objects/profile.py

@@ -71,7 +71,7 @@ def created_at(self):
     def chargebacks(self):
         from ..resources import ProfileChargebacks
 
-        return ProfileChargebacks(self.client, self)
+        return ProfileChargebacks(self.client, resource_path=f"chargebacks?profileId={self.id}")
 
     @property
     def methods(self):

mollie/api/objects/settlement.py

@@ -86,14 +86,14 @@ def chargebacks(self):
         """Return the chargebacks related to this settlement."""
         from ..resources import SettlementChargebacks
 
-        return SettlementChargebacks(self.client, self)
+        return SettlementChargebacks(self.client, resource_path=f"settlements/{self.id}/chargebacks")
 
     @property
     def captures(self):
         """Return the captures related to this settlement."""
         from ..resources import SettlementCaptures
 
-        return SettlementCaptures(self.client, self)
+        return SettlementCaptures(self.client, resource_path=f"settlements/{self.id}/captures")
 
     def get_invoice(self):
         """Return the invoice related to this settlement."""

mollie/api/resources/balances.py

@@ -1,13 +1,10 @@
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from mollie.api.objects.balance import Balance
 from mollie.api.objects.balance_report import BalanceReport
 from mollie.api.objects.balance_transaction import BalanceTransaction
 from mollie.api.resources.base import ResourceBase, ResourceGetMixin, ResourceListMixin
 
-if TYPE_CHECKING:
-    from ..client import Client
-
 
 class Balances(ResourceGetMixin, ResourceListMixin):
     RESOURCE_ID_PREFIX: str = "bal_"
@@ -42,38 +39,19 @@ def get(self, resource_id: str, **params: Any) -> Balance:
 
 
 class BalanceReports(ResourceBase):
-
-    _balance: "Balance"
-
-    def __init__(self, client: "Client", balance: "Balance") -> None:
-        self._balance = balance
-        super().__init__(client)
-
     def get_resource_object(self, result: dict) -> BalanceReport:
         from ..objects.balance_report import BalanceReport
 
         return BalanceReport(result, self.client)
 
-    def get_resource_path(self) -> str:
-        return f"balances/{self._balance.id}/report"
-
     def get_report(self, **params: Any) -> BalanceReport:
         path = self.get_resource_path()
         result = self.perform_api_call(self.REST_READ, path, params=params)
         return self.get_resource_object(result)
 
 
 class BalanceTransactions(ResourceListMixin):
-    _balance: "Balance"
-
-    def __init__(self, client: "Client", balance: "Balance") -> None:
-        self._balance = balance
-        super().__init__(client)
-
     def get_resource_object(self, result: dict) -> BalanceTransaction:
         from ..objects.balance_transaction import BalanceTransaction
 
         return BalanceTransaction(result, self.client)
-
-    def get_resource_path(self) -> str:
-        return f"balances/{self._balance.id}/transactions"

mollie/api/resources/captures.py

@@ -1,13 +1,8 @@
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from ..objects.capture import Capture
 from .base import ResourceBase, ResourceGetMixin, ResourceListMixin
 
-if TYPE_CHECKING:
-    from ..client import Client
-    from ..objects.payment import Payment
-    from ..objects.settlement import Settlement
-
 __all__ = [
     "PaymentCaptures",
     "SettlementCaptures",
@@ -24,15 +19,6 @@ def get_resource_object(self, result: dict) -> Capture:
 class PaymentCaptures(CapturesBase, ResourceGetMixin, ResourceListMixin):
     """Resource handler for the `/payments/:payment_id:/captures` endpoint."""
 
-    _payment: "Payment"
-
-    def __init__(self, client: "Client", payment: "Payment") -> None:
-        self._payment = payment
-        super().__init__(client)
-
-    def get_resource_path(self) -> str:
-        return f"payments/{self._payment.id}/captures"
-
     def get(self, resource_id: str, **params: Any) -> Capture:
         self.validate_resource_id(resource_id, "capture ID")
         return super().get(resource_id, **params)
@@ -41,11 +27,4 @@ def get(self, resource_id: str, **params: Any) -> Capture:
 class SettlementCaptures(CapturesBase, ResourceListMixin):
     """Resource handler for the `/settlements/:settlement_id:/captures` endpoint."""
 
-    _settlement: "Settlement"
-
-    def __init__(self, client: "Client", settlement: "Settlement") -> None:
-        self._settlement = settlement
-        super().__init__(client)
-
-    def get_resource_path(self) -> str:
-        return f"settlements/{self._settlement.id}/captures"
+    pass

mollie/api/resources/chargebacks.py

@@ -1,15 +1,8 @@
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from ..objects.chargeback import Chargeback
-from ..objects.list import ObjectList
 from .base import ResourceBase, ResourceGetMixin, ResourceListMixin
 
-if TYPE_CHECKING:
-    from ..client import Client
-    from ..objects.payment import Payment
-    from ..objects.profile import Profile
-    from ..objects.settlement import Settlement
-
 __all__ = [
     "Chargebacks",
     "PaymentChargebacks",
@@ -34,15 +27,6 @@ class Chargebacks(ChargebacksBase, ResourceListMixin):
 class PaymentChargebacks(ChargebacksBase, ResourceGetMixin, ResourceListMixin):
     """Resource handler for the `/payments/:payment_id:/chargebacks` endpoint."""
 
-    _payment: "Payment"
-
-    def __init__(self, client: "Client", payment: "Payment") -> None:
-        self._payment = payment
-        super().__init__(client)
-
-    def get_resource_path(self) -> str:
-        return f"payments/{self._payment.id}/chargebacks"
-
     def get(self, resource_id: str, **params: Any) -> Chargeback:
         self.validate_resource_id(resource_id, "chargeback ID")
         return super().get(resource_id, **params)
@@ -51,30 +35,14 @@ def get(self, resource_id: str, **params: Any) -> Chargeback:
 class SettlementChargebacks(ChargebacksBase, ResourceListMixin):
     """Resource handler for the `/settlements/:settlement_id:/chargebacks` endpoint."""
 
-    _settlement: "Settlement"
-
-    def __init__(self, client: "Client", settlement: "Settlement") -> None:
-        self._settlement = settlement
-        super().__init__(client)
-
-    def get_resource_path(self) -> str:
-        return f"settlements/{self._settlement.id}/chargebacks"
+    pass
 
 
-class ProfileChargebacks(ChargebacksBase):
+class ProfileChargebacks(Chargebacks):
     """
     Resource handler for the `/chargebacks?profileId=:profile_id:` endpoint.
 
-    This is separate from the `Chargebacks` resource handler to make it easier to inject the profileId.
+    This is completely equal to Chargebacks, just here for completeness.
     """
 
-    _profile: "Profile"
-
-    def __init__(self, client: "Client", profile: "Profile") -> None:
-        self._profile = profile
-        super().__init__(client)
-
-    def list(self, **params: Any) -> ObjectList:
-        # Set the profileId in the query params
-        params.update({"profileId": self._profile.id})
-        return Chargebacks(self.client).list(**params)
+    pass

tests/responses/balance_transactions_list.json

@@ -32,10 +32,12 @@
       "type": "text/html"
     },
     "self": {
-      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/transactions?limit=5",
+      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/transactions?limit=1",
       "type": "application/hal+json"
     },
     "previous": null,
-    "next": null
+    "next": {
+      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/transactions?limit=1&from=baltr_QM24QwzUWR4ev4Xfgyt29B"
+    }
   }
-}
+}

tests/responses/balance_transactions_list_more.json

@@ -0,0 +1,41 @@
+{
+  "count": 1,
+  "_embedded": {
+    "balance_transactions": [
+       {
+         "resource": "balance_transaction",
+         "id": "baltr_QM24QwzUWR4ev4Xfgyt29B",
+         "type": "refund",
+         "resultAmount": {
+           "value": "-10.33",
+           "currency": "EUR"
+         },
+         "initialAmount": {
+           "value": "-10.00",
+           "currency": "EUR"
+         },
+         "deductions": {
+           "value": "-0.25",
+           "currency": "EUR"
+         },
+         "createdAt": "2021-01-10T12:06:28+00:00",
+         "context": {
+           "paymentId": "tr_7UhSN1zuXT",
+           "refundId": "re_4qqhO89gsX"
+         }
+       }
+    ]
+  },
+  "_links": {
+    "documentation": {
+      "href": "https://docs.mollie.com/reference/v2/balances-api/list-balance-transactions",
+      "type": "text/html"
+    },
+    "self": {
+      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/transactions?limit=1&from=baltr_QM24QwzUWR4ev4Xfgyt29B",
+      "type": "application/hal+json"
+    },
+    "previous": null,
+    "next": null
+  }
+}