python-payway 0.0.9__tar.gz → 0.0.10__tar.gz

{python_payway-0.0.9/python_payway.egg-info → python_payway-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-payway
-Version: 0.0.9
+Version: 0.0.10
 Summary: Python client for working with Westpac's PayWay REST API
 Author-email: Ben Napper <reppan197@gmail.com>
 License: MIT
@@ -281,6 +281,21 @@ PayWay API documentation <https://www.payway.com.au/docs/rest.html>
 It is recommended to use PayWay's Trusted Frame <https://www.payway.com.au/docs/rest.html#trusted-frame>
 when creating a single use token of a card or bank account so your PCI-compliance scope is reduced.  
 
+## Keeping the raw response
+
+Models parsed from a PayWay response keep that response verbatim on `raw`:
+
+```python
+transaction, errors = client.process_payment(payment)
+transaction.raw  # exactly what PayWay returned
+```
+
+Parsing is lossy — keys PayWay sends that the dataclass does not declare are dropped,
+absent keys become `None`, and a few are renamed (`maskedCardNumber` is parsed into
+`card_number`). Store `raw` rather than `to_dict()` if you are persisting responses for
+auditing, reconciliation or dispute resolution. Models you construct yourself, such as a
+`PayWayPayment` you are about to send, leave `raw` as `None`.
+
 ## Fraud
 
 Please follow PayWay's advice about reducing your risk of fraudulent transactions. <https://www.payway.com.au/docs/card-testing.html#card-testing>

{python_payway-0.0.9 → python_payway-0.0.10}/README.md

@@ -258,6 +258,21 @@ PayWay API documentation <https://www.payway.com.au/docs/rest.html>
 It is recommended to use PayWay's Trusted Frame <https://www.payway.com.au/docs/rest.html#trusted-frame>
 when creating a single use token of a card or bank account so your PCI-compliance scope is reduced.  
 
+## Keeping the raw response
+
+Models parsed from a PayWay response keep that response verbatim on `raw`:
+
+```python
+transaction, errors = client.process_payment(payment)
+transaction.raw  # exactly what PayWay returned
+```
+
+Parsing is lossy — keys PayWay sends that the dataclass does not declare are dropped,
+absent keys become `None`, and a few are renamed (`maskedCardNumber` is parsed into
+`card_number`). Store `raw` rather than `to_dict()` if you are persisting responses for
+auditing, reconciliation or dispute resolution. Models you construct yourself, such as a
+`PayWayPayment` you are about to send, leave `raw` as `None`.
+
 ## Fraud
 
 Please follow PayWay's advice about reducing your risk of fraudulent transactions. <https://www.payway.com.au/docs/card-testing.html#card-testing>

{python_payway-0.0.9 → python_payway-0.0.10}/payway/model.py

@@ -15,9 +15,16 @@ class PayWayModel:
         alias:      PayWay key when it is not the camelCase of the field name
         exclude:    omit the field from to_dict output
         from_dict:  callable applied to a non-None raw value when parsing
+
+    Instances built by from_dict keep the response body they were parsed from
+    on ``raw``, unchanged. Parsing is lossy - undeclared PayWay keys are dropped,
+    absent ones become None, and aliases rename them - so callers persisting a
+    response for auditing or dispute resolution should store ``raw``, not
+    ``to_dict()``. Models you build yourself leave it None.
     """
 
     __dataclass_fields__: ClassVar[dict[str, Any]]
+    raw: dict[str, Any] | None = None
 
     def to_dict(self) -> dict[str, Any]:
         result = {}
@@ -39,7 +46,9 @@ class PayWayModel:
             if converter is not None and value is not None:
                 value = converter(value)
             kwargs[f.name] = value
-        return cls(**kwargs)
+        instance = cls(**kwargs)
+        instance.raw = data
+        return instance
 
 
 @dataclass
@@ -65,8 +74,10 @@ class PayWayCard(PayWayModel):
 
     @classmethod
     def from_dict(cls, data: dict[str, Any]) -> PayWayCard:
-        data = {**data, "cardNumber": data.get("maskedCardNumber") or data.get("cardNumber")}
-        return super().from_dict(data)
+        card = super().from_dict({**data, "cardNumber": data.get("maskedCardNumber") or data.get("cardNumber")})
+        # Keep PayWay's own body, not the copy rewritten for the alias above.
+        card.raw = data
+        return card
 
 
 @dataclass

{python_payway-0.0.9 → python_payway-0.0.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-payway"
-version = "0.0.9"
+version = "0.0.10"
 description = "Python client for working with Westpac's PayWay REST API"
 authors = [
     { name = "Ben Napper", email = "reppan197@gmail.com" }

{python_payway-0.0.9 → python_payway-0.0.10/python_payway.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-payway
-Version: 0.0.9
+Version: 0.0.10
 Summary: Python client for working with Westpac's PayWay REST API
 Author-email: Ben Napper <reppan197@gmail.com>
 License: MIT
@@ -281,6 +281,21 @@ PayWay API documentation <https://www.payway.com.au/docs/rest.html>
 It is recommended to use PayWay's Trusted Frame <https://www.payway.com.au/docs/rest.html#trusted-frame>
 when creating a single use token of a card or bank account so your PCI-compliance scope is reduced.  
 
+## Keeping the raw response
+
+Models parsed from a PayWay response keep that response verbatim on `raw`:
+
+```python
+transaction, errors = client.process_payment(payment)
+transaction.raw  # exactly what PayWay returned
+```
+
+Parsing is lossy — keys PayWay sends that the dataclass does not declare are dropped,
+absent keys become `None`, and a few are renamed (`maskedCardNumber` is parsed into
+`card_number`). Store `raw` rather than `to_dict()` if you are persisting responses for
+auditing, reconciliation or dispute resolution. Models you construct yourself, such as a
+`PayWayPayment` you are about to send, leave `raw` as `None`.
+
 ## Fraud
 
 Please follow PayWay's advice about reducing your risk of fraudulent transactions. <https://www.payway.com.au/docs/card-testing.html#card-testing>

{python_payway-0.0.9 → python_payway-0.0.10}/tests/test_client.py

@@ -179,6 +179,29 @@ class TestClient(unittest.TestCase):
         self.assertEqual(transaction.status, "approved")
         self.assertEqual(transaction.response_code, "11")
 
+    @patch("requests.post")
+    def test_process_payment_keeps_the_raw_response(self, mock_post) -> None:
+        """
+        Parsing drops keys PayWay sent, so ``raw`` keeps the body verbatim for
+        callers that persist responses for auditing or dispute resolution.
+        """
+        response = load_json_file("tests/data/transaction.json")
+        mock_post.return_value.status_code = 200
+        mock_post.return_value.json.return_value = response
+        payment = copy.deepcopy(self.payment)
+        payment.customer_number = "1"
+        payment.token = "2bcec36f-7b02-43db-b3ec-bfb65acfe272"
+        payment.order_number = "5200"
+        payment.merchant_id = self.client.merchant_id
+
+        transaction, _ = self.client.process_payment(payment)
+
+        self.assertEqual(transaction.raw, response)
+        # cardScheme and cardType are not modelled, so only raw still has them.
+        self.assertEqual(transaction.raw["creditCard"]["cardScheme"], "visa")
+        self.assertNotIn("cardScheme", transaction.to_dict()["creditCard"])
+        self.assertEqual(transaction.card.raw, response["creditCard"])
+
     @patch("requests.post")
     def test_process_payment_with_idempotency_key(self, mock_post) -> None:
         """