python-redsys 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

python_redsys-1.2.2.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: python-redsys
+Version: 1.2.2
+Summary: A simple, lightweight client to handle payments through the RedSys platform.
+License: MIT
+License-File: LICENSE
+Author: David Díaz
+Author-email: d.diazp@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: pycryptodome (>=3.19.1,<4.0.0)
+Project-URL: Homepage, https://github.com/ddiazpinto/python-redsys
+Description-Content-Type: text/markdown
+
+# Welcome to python-redsys!
+
+[![CI](https://github.com/ddiazpinto/python-redsys/actions/workflows/python-app.yml/badge.svg?branch=release/1.x)](https://github.com/ddiazpinto/python-redsys/actions/workflows/python-app.yml?query=branch%3Arelease%2F1.x) [![PyPI](https://img.shields.io/pypi/v/python-redsys.svg)](https://pypi.org/project/python-redsys/) ![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-blue.svg) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ddiazpinto/python-redsys/blob/release/1.x/LICENSE)
+
+A simple, lightweight client to handle payments through the RedSys platform, using its *redirect connection* (browser form POST).
+
+The library only builds the signed request and verifies/parses the response. It makes no network or browser calls of its own: the payment form is submitted from the cardholder's browser.
+
+## Installation
+
+```bash
+pip install "python-redsys>=1.2,<2"
+
+# or with Poetry
+poetry add "python-redsys@^1.2"
+```
+
+Requires Python 3.8+. Runtime dependency: `pycryptodome`.
+
+## Usage
+
+The client prepares a request from a dict of parameters and verifies the response. Parameter values are validated on construction (`ValueError` on an unknown parameter or an invalid value, `TypeError` when `amount` is not a `Decimal`); `order` has 12 characters (4 digits followed by 8 alphanumerics), and `amount` is a `Decimal`, serialized to integer minor units on the wire. The allowed values for `currency`, `transaction_type` and `consumer_language` are in `redsys.constants`.
+
+## Using *redirect connection*
+
+### 1. Build a signed request
+
+```python
+from decimal import Decimal, ROUND_HALF_UP
+from redsys.client import RedirectClient
+from redsys.constants import EUR, STANDARD_PAYMENT
+
+client = RedirectClient(secret_key="sq7HjrUOBfKmC576ILgskD5srU870gJ7")
+
+post_parameters = client.prepare_request({
+    "merchant_code": "999008881",
+    "terminal": "1",
+    "transaction_type": STANDARD_PAYMENT,
+    "currency": EUR,
+    "order": "000000000001",
+    # The amount is a Decimal; pre-quantize to two decimals.
+    "amount": Decimal("10.56489").quantize(Decimal(".01"), ROUND_HALF_UP),
+    "merchant_url": "https://example.com/redsys/response",
+    "url_ok": "https://example.com/ok",
+    "url_ko": "https://example.com/ko",
+    "merchant_name": "Example Commerce",
+    "product_description": "Products of Example Commerce",
+})  # Ds_SignatureVersion / Ds_MerchantParameters / Ds_Signature
+```
+
+The secret key, merchant code `999008881` and terminal `1` are the RedSys public test merchant's. `Ds_MerchantParameters` and `Ds_Signature` are returned as `bytes`; decode them before rendering them in an HTML form.
+
+Bizum: add `"payment_method": "z"` (and optionally `"mobile_number"`) to the parameters.
+
+### 2. Communication step
+
+Auto-submit an HTML form (`method="POST"`) with the three `post_parameters` fields to the RedSys endpoint:
+
+- Test: `https://sis-t.redsys.es:25443/sis/realizarPago`
+- Production: `https://sis.redsys.es/sis/realizarPago`
+
+RedSys notifies the result both as a server-to-server POST to `merchant_url` and as a browser redirect to `url_ok` / `url_ko`.
+
+### 3. Verify and read the response
+
+`create_response()` takes the received `Ds_Signature` and `Ds_MerchantParameters` and raises `ValueError` on signature mismatch.
+
+```python
+response = client.create_response(signature, merchant_parameters)  # as RedSys posted them back
+
+if response.is_paid:
+    ...  # actions after a successful payment
+else:
+    raise Exception(f"declined with code {response.code}")
+```
+
+Response predicates (per the RedSys documentation):
+
+- `response.is_paid`: response code between 0 and 99.
+- `response.is_canceled`: response code 400.
+- `response.is_refunded`: response code 900.
+- `response.is_authorized`: paid, refunded or canceled.
+
+`response.code` is the RedSys code as an `int`, and `response.message` its Spanish description (`None` for a code without one). Decoded fields (`response.order`, `response.amount` as a `Decimal`, ...) read as attributes, `None` when absent; `response.parameters` holds every decoded parameter: listed ones under their attribute name (`amount`), unlisted ones under their original `Ds_*` key.
+
+## Signature version
+
+The 1.x line signs with `HMAC_SHA256_V1` (3DES + HMAC-SHA256), the legacy scheme still accepted by RedSys. `HMAC_SHA512_V1` requires 2.x.
+
+## Support
+
+The 1.x line receives fixes until 2026-12-31.
+
+## Contributing
+
+Contributions that keep the *lightweight* philosophy are welcome.
+

python_redsys-1.2.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+redsys/__init__.py,sha256=k234cuEigYkeydQvG5NyAl4pPAyCQSjL65UvOkeTak8,138
+redsys/client.py,sha256=ervLX4FbzDfWjh_SO2SFyY9IT0PZ5aIcVZdYy4mUO7Q,3937
+redsys/constants.py,sha256=lJYgbmikxh0b9iVM4M5XFWBWVvdFY27OkcXSLluHSsQ,2497
+redsys/request.py,sha256=IEzlRi34JgDBRRyaBHtIrAZ38fADL977RdBFaeWDdbY,5304
+redsys/response.py,sha256=YDihLSIE388Ib53qr9PUtGsWqLqj1zFdjbgn9x_i-8A,5585
+redsys/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+redsys/tests/test_client.py,sha256=oND8W9y6O6MkDLNxnBpd8UDShwKWoAW3SgKmWDOXHrw,3858
+redsys/tests/test_request.py,sha256=FONigjMNdaug2DwillYKCLPK-gzIYZSVUZmcm9QkCms,3110
+redsys/tests/test_response.py,sha256=K1QP7eRyBum88LXG6IOQtno8FZNxoVHUv-GJU83k5OI,1777
+python_redsys-1.2.2.dist-info/METADATA,sha256=PXqNlioj4tNFrfUXhiPZ1P77pgIJne39Q_oD4sXto4U,5517
+python_redsys-1.2.2.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+python_redsys-1.2.2.dist-info/licenses/LICENSE,sha256=Ku6mJcUOcHd2aZ4o2Jh4Tjkx1oZT-iT0VCyUNvm2IXU,1257
+python_redsys-1.2.2.dist-info/RECORD,,

{python_redsys-1.2.0.dist-info → python_redsys-1.2.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.7.0
+Generator: poetry-core 2.5.0
 Root-Is-Purelib: true
 Tag: py3-none-any

redsys/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "1.2.0"
+__version__ = "1.2.2"
 __version_info__ = tuple(int(num) if num.isdigit() else num for num in __version__.replace("-", ".", 1).split("."))

redsys/request.py

@@ -77,9 +77,11 @@ class Request:
     their values according to the platform specifications
     """
 
-    _parameters: Dict[str, Any] = {}
+    _parameters: Dict[str, Any]
 
     def __init__(self, parameters: Dict[str, Any]) -> None:
+        # __setattr__ only handles merchant parameters, so the per-instance store is set directly.
+        object.__setattr__(self, "_parameters", {})
         for key, value in parameters.items():
             if key in MERCHANT_PARAMETERS_MAP:
                 if check := getattr(self, f"check_{str(key)}", None):
@@ -90,7 +92,7 @@ class Request:
 
     def __getattr__(self, item: str) -> Any:
         if item in MERCHANT_PARAMETERS_MAP:
-            return self._parameters[item]
+            return self._parameters.get(item)
 
     def __setattr__(self, key, value):
         if key in MERCHANT_PARAMETERS_MAP:

redsys/response.py

@@ -93,9 +93,11 @@ class Response:
     Defines a response
     """
 
-    _parameters: Dict[str, Any] = {}
+    _parameters: Dict[str, Any]
 
     def __init__(self, parameters: Dict[str, Any]):
+        # __setattr__ only handles merchant parameters, so the per-instance store is set directly.
+        object.__setattr__(self, "_parameters", {})
         MERCHANT_PARAMETERS_MAP_REVERSE = {value: key for key, value in MERCHANT_PARAMETERS_MAP.items()}
         for key, value in parameters.items():
             reversed_parameter = MERCHANT_PARAMETERS_MAP_REVERSE.get(key, key)
@@ -104,7 +106,7 @@ class Response:
 
     def __getattr__(self, item: str) -> Any:
         if item in MERCHANT_PARAMETERS_MAP:
-            return self._parameters[item]
+            return self._parameters.get(item)
 
     def __setattr__(self, key: str, value: Any):
         if key in MERCHANT_PARAMETERS_MAP:
@@ -133,7 +135,10 @@ class Response:
 
     @property
     def message(self):
-        return RESPONSE_MAP["0000"] if self.is_paid else RESPONSE_MAP[self.response]
+        if self.is_paid:
+            return RESPONSE_MAP["0000"]
+        # RedSys sends 4-digit codes ("0190"); the map keys drop the leading zeros ("190").
+        return RESPONSE_MAP.get(self.response) or RESPONSE_MAP.get(str(self.code))
 
     @property
     def parameters(self):

redsys/tests/test_request.py

@@ -63,3 +63,12 @@ class TestRequest:
         merchant_url = "".join(choice("abcdefghijklmnopqrtsuvwxyz-0123456789") for _ in range(251))
         with pytest.raises(ValueError):
             assert Request.check_merchant_url(merchant_url)
+
+    def test_requests_do_not_share_parameters(self):
+        first = Request(
+            {"order": "000000000001", "amount": D("1.00"), "currency": EUR, "mobile_number": "+34700000000"}
+        )
+        second = Request({"order": "000000000002", "amount": D("2.00"), "currency": EUR})
+        assert "Ds_Merchant_Bizum_MobileNumber" not in second.prepare_parameters()
+        assert second.mobile_number is None
+        assert first.prepare_parameters()["Ds_Merchant_Bizum_MobileNumber"] == "+34700000000"

redsys/tests/test_response.py

@@ -1,3 +1,5 @@
+from decimal import Decimal
+
 from redsys.response import Response
 
 
@@ -21,3 +23,17 @@ class TestResponse:
         assert response.is_paid is True
         assert response.is_canceled is False
         assert response.is_refunded is False
+
+    def test_responses_do_not_share_parameters(self):
+        first = Response({"Ds_Response": "0000", "Ds_Order": "000000000001", "Ds_Amount": "100"})
+        second = Response({"Ds_Response": "0190", "Ds_Order": "000000000002"})
+        assert "amount" not in second.parameters
+        assert second.amount is None
+        assert first.amount == Decimal("1.00")
+
+    def test_message_for_four_digit_codes(self):
+        assert Response({"Ds_Response": "0190"}).message == "Denegación del emisor sin especificar motivo"
+        assert Response({"Ds_Response": "0900"}).message == "Transacción autorizada para devoluciones y confirmaciones"
+        assert Response({"Ds_Response": "0400"}).message == "Transacción autorizada para anulaciones"
+        assert Response({"Ds_Response": "9915"}).message == "A petición del usuario se ha cancelado el pago"
+        assert Response({"Ds_Response": "0105"}).message is None

python_redsys-1.2.0.dist-info/METADATA

@@ -1,135 +0,0 @@
-Metadata-Version: 2.1
-Name: python-redsys
-Version: 1.2.0
-Summary: A simple, clean and less dependant client to handle payments through Redsys.
-Home-page: https://github.com/systemallica/python-redsys
-License: MIT
-Author: Andrés Reverón Molina
-Author-email: andres@reveronmolina.me
-Requires-Python: >=3.8,<4.0
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: pycryptodome (>=3.19.0,<4.0.0)
-Description-Content-Type: text/markdown
-
-
-[![PyPI version](https://badge.fury.io/py/python-redsys.svg)](https://badge.fury.io/py/python-redsys)
-
-# Welcome to python-redsys!
-
-A simple, clean and less dependant client to handle payments through the
-Redsys platform using one of the available methods: _redirect connection_ or (secure method).
-
-The purpose of this library is to provide a normalized interface between
-Redsys and other Python applications.
-
-**About RedirectClient**
-
-Although _redirect connection_ depends on a webserver to resolve the
-communication step, the RedirectClient provided in this library does not
-assume any kind of procedure to resolve that step; it merely prepares
-the necessary parameters to make a request and handles the corresponding
-response parameters. That's what less dependant means.
-
-## Example using _redirect connection_
-
-### 0. Install python-redsys
-
-You can add python-redsys to your project with pip:
-> pip install python-redsys
-
-Or with poetry:
-> poetry add python-redsys
-
-### 1. Instantiate the redirect client
-
-```python
-from decimal import Decimal as D, ROUND_HALF_UP
-from redsys.constants import EUR, STANDARD_PAYMENT
-from redsys.client import RedirectClient
-
-secret_key = "123456789abcdef"
-client = RedirectClient(secret_key)
-```
-
-### 2. Set up the request parameters
-
-```python
-parameters = {
-  "merchant_code": "100000001",
-  "terminal": "1",
-  "transaction_type": STANDARD_PAYMENT,
-  "currency": EUR,
-  "order": "000000001",
-  "amount": D("10.56489").quantize(D(".01"), ROUND_HALF_UP),
-  "merchant_data": "test merchant data",
-  "merchant_name": "Example Commerce",
-  "titular": "Example Ltd.",
-  "product_description": "Products of Example Commerce",
-  "merchant_url": "https://example.com/redsys/response",
-}
-```
-
-### 3. Prepare the request
-
-This method returns a dict with the necessary post parameters that are
-needed during the communication step.
-
-```python
-args = client.prepare_request(parameters)
-```
-
-### 4. Communication step
-
-Redirect the _user-agent_ to the corresponding Redsys' endpoint using
-the post parameters given in the previous step.
-
-After the payment process is finished, Redsys will respond making a
-request to the `merchant_url` defined in step 2.
-
-### 5. Create and check the response
-
-Create the response object using the received parameters from Redsys.
-The method `create_response()` throws a `ValueError` in case the
-received signature is not equal to the calculated one using the
-given `merchant_parameters`. This normally means that the response **is
-not coming from Redsys** or that it **has been compromised**.
-
-```python
-signature = "YqFenHc2HpB273l8c995...."
-merchant_parameters = "AndvIh66VZdkC5TG3nYL5j4XfCnFFbo3VkOu9TAeTs58fxddgc..."
-response = client.create_response(signature, merchant_parameters)
-if response.is_paid:
-    # Do the corresponding actions after a successful payment
-else:
-    # Do the corresponding actions after a failed payment
-    raise Exception(response.code, response.message)
-```
-
-**Methods for checking the response:**
-
-According to the Redsys documentation:
-
-- `response.is_paid`: Returns `True` if the response code is
-  between 0 and 99 (both included).
-- `response.is_canceled`: Returns `True` if the response code
-  is 400.
-- `response.is_refunded`: Returns `True` if the response code
-  is 900.
-- `response.is_authorized`: Returns `True` if the response is
-  **paid**, **refunded** or **canceled**.
-
-Also, you can directly access the code or the message defined in Redsys
-documentation using `response.code` or `response.message`.
-
-## Contributions
-
-Please, feel free to send any contribution that maintains the _less
-dependant_ philosophy.
-

python_redsys-1.2.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-redsys/__init__.py,sha256=mBK19nPR_NOqZ1AHA73PWWuxqU4gDY1nssPXujFjOo0,138
-redsys/client.py,sha256=ervLX4FbzDfWjh_SO2SFyY9IT0PZ5aIcVZdYy4mUO7Q,3937
-redsys/constants.py,sha256=lJYgbmikxh0b9iVM4M5XFWBWVvdFY27OkcXSLluHSsQ,2497
-redsys/request.py,sha256=t9zStQ4QcRfMA7xDU-Qt6zKAyUA5bzvmD0aoCjjHgi4,5154
-redsys/response.py,sha256=qJaeuCUfzGc3dBRS_yzBWGJ6yWtZLj0P4ioOGsr5e8Y,5280
-redsys/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-redsys/tests/test_client.py,sha256=oND8W9y6O6MkDLNxnBpd8UDShwKWoAW3SgKmWDOXHrw,3858
-redsys/tests/test_request.py,sha256=QRD-m7O9AVokpu2SgcirXqMU17GDn0tqzFyjkeneHHE,2601
-redsys/tests/test_response.py,sha256=Q7rQ6TXUWBnIoNlqTWAwzTFq5gv_naEYZ1r8RYid18c,826
-python_redsys-1.2.0.dist-info/LICENSE,sha256=Ku6mJcUOcHd2aZ4o2Jh4Tjkx1oZT-iT0VCyUNvm2IXU,1257
-python_redsys-1.2.0.dist-info/METADATA,sha256=tYputxvq5_laNsEPPSs-Y5A3gBjzhzzqljryn2KOdb4,4413
-python_redsys-1.2.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-python_redsys-1.2.0.dist-info/RECORD,,