python-redsys 2.0.0__py3-none-any.whl → 2.2.0__py3-none-any.whl

redsys/threeds.py

@@ -1,20 +1,25 @@
-"""Builders for the Ds_Merchant_EMV3DS object used in 3-D Secure v2 (REST direct connection).
+"""Builders for the ``Ds_Merchant_EMV3DS`` object of 3-D Secure v2 on the direct connection.
 
-Flow: inicia (`card_data`) -> authorize (`authentication_data`) -> [challenge] ->
-finalize (`challenge_response`). See docs/direct-connection.md. The
-EMV3DS sub-field names are case-sensitive and passed through verbatim.
+The step numbers follow docs/direct-connection.md. The sub-field names are case-sensitive.
 
-Each function returns the dict to assign to a request's `emv3ds` field, e.g.
+    client.payment(emv3ds=threeds.authentication_data(..., three_ds_comp_ind=emv3ds.METHOD_COMPLETED), ...)
+"""
 
-    from redsys import threeds
+from base64 import urlsafe_b64encode
+from json import dumps
 
-    response = client.inicia(..., emv3ds=threeds.card_data()).send()
-"""
+from redsys.api import emv3ds
 
 
 def card_data() -> dict:
-    """EMV3DS payload for the iniciaPeticionREST call (step 1)."""
-    return {'threeDSInfo': 'CardData'}
+    """``emv3ds`` of the 3-D Secure initialization, iniciaPeticionREST (step 1)."""
+    return {'threeDSInfo': emv3ds.CARD_DATA}
+
+
+def method_data(*, three_ds_server_trans_id, notification_url) -> str:
+    """Value of the ``threeDSMethodData`` form field the browser posts to ``threeDSMethodURL`` (step 2)."""
+    payload = {'threeDSServerTransID': three_ds_server_trans_id, 'threeDSMethodNotificationURL': notification_url}
+    return urlsafe_b64encode(dumps(payload, separators=(',', ':')).encode('utf-8')).decode('ascii').rstrip('=')
 
 
 def browser_info(
@@ -30,7 +35,7 @@ def browser_info(
     javascript_enabled=True,
     ip=None,
 ) -> dict:
-    """Cardholder browser data the merchant page collects for the authorization."""
+    """Cardholder browser data, collected by the merchant page, for ``authentication_data()``."""
     data = {
         'browserAcceptHeader': accept_header,
         'browserUserAgent': user_agent,
@@ -48,11 +53,11 @@ def browser_info(
 
 
 def authentication_data(
-    *, three_ds_server_trans_id, notification_url, protocol_version, browser, three_ds_comp_ind='Y'
+    *, three_ds_server_trans_id, notification_url, protocol_version, browser, three_ds_comp_ind=emv3ds.METHOD_COMPLETED
 ) -> dict:
-    """EMV3DS payload for the authorization call (step 3). `browser` is `browser_info(...)`."""
+    """``emv3ds`` of the authentication (step 3); ``browser`` is ``browser_info(...)``."""
     data = {
-        'threeDSInfo': 'AuthenticationData',
+        'threeDSInfo': emv3ds.AUTHENTICATION_DATA,
         'protocolVersion': protocol_version,
         'threeDSServerTransID': three_ds_server_trans_id,
         'notificationURL': notification_url,
@@ -63,5 +68,5 @@ def authentication_data(
 
 
 def challenge_response(*, cres, protocol_version) -> dict:
-    """EMV3DS payload to finalize the authorization after the challenge (step 5)."""
-    return {'threeDSInfo': 'ChallengeResponse', 'protocolVersion': protocol_version, 'cres': cres}
+    """``emv3ds`` of the operation after the challenge (step 5)."""
+    return {'threeDSInfo': emv3ds.CHALLENGE_RESPONSE, 'protocolVersion': protocol_version, 'cres': cres}

python_redsys-2.0.0.dist-info/METADATA

@@ -1,214 +0,0 @@
-Metadata-Version: 2.4
-Name: python-redsys
-Version: 2.0.0
-Summary: A simple, lightweight client to handle payments through the RedSys platform.
-Author-email: David Díaz <d.diazp@gmail.com>
-License-Expression: Apache-2.0
-Project-URL: Homepage, https://github.com/ddiazpinto/python-redsys
-Project-URL: Source, https://github.com/ddiazpinto/python-redsys
-Keywords: redsys,sermepa,tpv,payments,psd2
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-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
-Classifier: Topic :: Office/Business :: Financial
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: NOTICE
-Requires-Dist: cryptography>=49
-Requires-Dist: pydantic>=2.13
-Provides-Extra: http
-Requires-Dist: httpx>=0.26; extra == "http"
-Dynamic: license-file
-
-# Welcome to python-redsys!
-
-[![CI](https://github.com/ddiazpinto/python-redsys/actions/workflows/ci.yml/badge.svg)](https://github.com/ddiazpinto/python-redsys/actions/workflows/ci.yml) [![Coverage](https://codecov.io/gh/ddiazpinto/python-redsys/branch/master/graph/badge.svg)](https://codecov.io/gh/ddiazpinto/python-redsys) [![PyPI](https://img.shields.io/pypi/v/python-redsys.svg)](https://pypi.org/project/python-redsys/) ![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg) [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
-
-A simple, lightweight client to handle payments through the RedSys platform, covering both connection types it defines: *redirect connection* (browser form POST) and *direct connection* (server-to-server REST).
-
-The library builds the signed request and verifies and parses the response. The redirect form is submitted by the cardholder's browser; the direct REST call is made by the integrator's HTTP client or by the optional `http` extra (`httpx`).
-
-For Django, see [django-redsys](https://github.com/ddiazpinto/django-redsys).
-
-## Installation
-
-```bash
-pip install python-redsys
-
-# optional: the direct-connection sender (httpx)
-pip install "python-redsys[http]"
-```
-
-Requires Python 3.10+. Runtime dependencies: `cryptography` and `pydantic` (v2).
-
-## Upgrading from 1.x
-
-2.0 has a new API. The [migration guide](docs/migration-1x-to-2x.md) lists every change; 1.x receives fixes until 2026-12-31.
-
-## Usage
-
-The client is the single entry point: an operation method (`payment`, `preauthorization`, `confirmation`, `refund`, `cancellation`) returns a `Request`, with `.to_dict()` for the redirect POST fields and `.send()` for the direct REST call. Fields are validated on construction; `amount` is a `Decimal`. A parameter the library does not model yet is passed by its wire name (`Ds_Merchant_...`), sent as given, with an `UnknownParameterWarning`.
-
-## Using *redirect connection*
-
-### 1. Build a signed request
-
-```python
-from decimal import Decimal, ROUND_HALF_UP
-from redsys import currencies
-from redsys.clients import RedirectClient
-
-client = RedirectClient(
-    secret_key="123456789abcdef",
-    merchant_code="100000001",
-    terminal=1,
-    sandbox=False,
-)
-
-post_parameters = client.payment(
-    order="000000001",
-    currency=currencies.EUR,
-    # 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",
-).to_dict()  # Ds_SignatureVersion / Ds_MerchantParameters / Ds_Signature
-```
-
-Bizum: add `pay_methods="z"` (and optionally `bizum_mobile_number`) to the payment.
-
-### 2. Communication step
-
-Auto-submit an HTML form (`method="POST"`) to `client.endpoint` with the three `post_parameters` fields. 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
-
-`parse_response()` accepts the received parameters (callback form fields or REST JSON body) and raises `ValueError` on signature mismatch.
-
-```python
-response = client.parse_response(received)  # received: the Ds_* dict RedSys posted back
-
-if response.is_paid():
-    ...  # actions after a successful payment
-else:
-    raise Exception(f"declined with code {response.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.response_code` is the raw RedSys code; meanings are listed in [`docs/response-codes.md`](docs/response-codes.md). Decoded fields (`response.order`, `response.amount` as a `Decimal`, ...) read off the model; parameters the library does not list are kept under their wire name in `response.model_extra`.
-
-## Using *direct connection* (REST)
-
-The direct connection exchanges the same signed envelope server-to-server as JSON. Build the operation with the same methods: `.send()` performs the call, `.to_dict()` returns the JSON body for your own HTTP client.
-
-With the optional sender (`pip install "python-redsys[http]"`):
-
-```python
-from decimal import Decimal
-from redsys import currencies
-from redsys.clients import DirectClient
-
-client = DirectClient(secret_key="123456789abcdef", merchant_code="100000001",
-                      terminal=1, sandbox=True)
-
-response = client.refund(
-    order="000000001", amount=Decimal("10.56"), currency=currencies.EUR,
-).send()  # signs, POSTs, verifies, parses
-response.is_refunded()
-```
-
-Asynchronous (`httpx.AsyncClient`), with `send()` awaitable:
-
-```python
-from redsys.clients import AsyncDirectClient
-
-client = AsyncDirectClient(secret_key="123456789abcdef", merchant_code="100000001",
-                           terminal=1, sandbox=True)
-response = await client.payment(
-    order="000000001", amount=Decimal("10.56"), currency=currencies.EUR,
-    pan="...", expiry_date="2512", cvv2="...",
-).send()
-```
-
-Transport-agnostic (do your own HTTP):
-
-```python
-body = client.refund(order="000000001", amount=Decimal("10.56"),
-                     currency=currencies.EUR).to_dict()  # JSON body to POST
-# ... POST body to client.endpoint with your HTTP client ...
-response = client.parse_response(received_json)  # verifies and parses
-```
-
-`parse_response()` raises `redsys.exceptions.ResponseError` when RedSys answers with an error code instead of a signed result.
-
-## inSite (hosted fields)
-
-inSite captures the card in the browser via RedSys's JavaScript and yields an `idoper` token, keeping the PAN off your server. The card-capture JS is the front-end's responsibility; the backend completes the operation as a direct payment carrying the token:
-
-```python
-client.payment(order="000000001", amount=Decimal("10.56"), currency=currencies.EUR,
-               idoper="<token from the inSite JS>").send()
-```
-
-## Tokenization and recurring (COF / MIT)
-
-Store a card on the first payment and charge it later without card data. The first payment requests a token and flags the credential-on-file intent; RedSys returns a token and a COF transaction id that subsequent merchant-initiated charges reuse.
-
-```python
-from decimal import Decimal
-from redsys import cof, currencies, sca
-from redsys.clients import DirectClient
-
-client = DirectClient(secret_key="123456789abcdef", merchant_code="100000001",
-                      terminal=1, sandbox=True)
-
-# 1. First payment, request a token (cardholder present)
-response = client.payment(
-    order="000000001", amount=Decimal("10.56"), currency=currencies.EUR,
-    pan="...", expiry_date="YYMM", cvv2="...",
-    identifier=cof.REQUEST_TOKEN, cof_ini=cof.INITIAL, cof_type=cof.RECURRING,
-).send()
-token, cof_txnid = response.identifier, response.cof_txnid
-
-# 2. Later merchant-initiated charge, no card data
-client.payment(
-    order="000000002", amount=Decimal("10.56"), currency=currencies.EUR,
-    identifier=token, cof_ini=cof.SUBSEQUENT, cof_type=cof.RECURRING, cof_txnid=cof_txnid,
-    excep_sca=sca.MIT, direct_payment="true",
-).send()
-```
-
-`redsys.cof` provides the indicator constants (`INITIAL`/`SUBSEQUENT`, `RECURRING`/`INSTALLMENT`/...) and the `REQUEST_TOKEN` sentinel. The periodic fields (`sum_total`, `date_frequency`, `charge_expiry_date`) are also accepted by `DirectClient.payment()`. `redsys.sca` holds the PSD2 exemption codes for `excep_sca` (`LWV`, `TRA`, `MIT`, `COR`, `ATD`); `sca.QUERY` on `inicia()` asks which exemptions the card allows, returned in `response.excep_sca`.
-
-## Signature versions
-
-`signature_version` on the client constructor selects the scheme; the constants are in `redsys.clients`.
-
-- `HMAC_SHA512_V2` (AES-128 + HMAC-SHA512): the default, as in RedSys's redirection guide and libraries.
-- `HMAC_SHA512_V1`: the same algorithm with padded encoding, as in the REST guide.
-- `HMAC_SHA256_V1` (3DES): legacy, still accepted by RedSys.
-
-## Reference
-
-- [`docs/response-codes.md`](docs/response-codes.md): response-code meanings.
-- [`docs/redirect-connection.md`](docs/redirect-connection.md) / [`docs/direct-connection.md`](docs/direct-connection.md): connection-type protocol reference.
-
-## Contributing
-
-Dev setup, checks and live tests are in [`CONTRIBUTING.md`](CONTRIBUTING.md); contributors are listed in [`CONTRIBUTORS.md`](CONTRIBUTORS.md).

python_redsys-2.0.0.dist-info/RECORD

@@ -1,20 +0,0 @@
-python_redsys-2.0.0.dist-info/licenses/LICENSE,sha256=qsc7MUj20dcRHbyjIJn2jSbGRMaBOuHk8F9leaomY_4,11360
-python_redsys-2.0.0.dist-info/licenses/NOTICE,sha256=6tlv5QuzsbfmGxsQNEcN7Uopzyp7vgD54xb-_L4DGyE,201
-redsys/__init__.py,sha256=bhpyzXB0Y-3FORBJlV4dZ3vnrz1jSc-sbZ9hyb7itFo,138
-redsys/clients.py,sha256=4_lM6c6ofb13z_GNMa4d7pTCn2R6zbSRYrKJLfNdejA,10710
-redsys/crypto.py,sha256=GOm8RkDYnD83fMNwey-bxLg3vWf6xbNzWbza6m23M9M,5480
-redsys/exceptions.py,sha256=MqknsHm4sI5iAelrYcAuqSC70u1hhqdLyvA27vKcLHY,601
-redsys/models.py,sha256=UzvCBrYgwixTS-b4PjMaeLCg7txNlWkcs0vmWeX94SM,15765
-redsys/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-redsys/request.py,sha256=dVAQ0zSVmdyUPjnERo_62xilNQk3-LGJTbR6im_y0fQ,2408
-redsys/threeds.py,sha256=IheD2mWVD9Pw7efRP6_a170LVppSSlKpyxhUJVI3LnU,2244
-redsys/api/__init__.py,sha256=tjuisAfTqUpk7cdQq8ZayZk1cwaJ1ntqt1zgVbLamyw,111
-redsys/api/cof.py,sha256=fEf9ugVvOMs-jAzXkXDQl4NshyZuSYvbYfqnRH8otrk,660
-redsys/api/currencies.py,sha256=GufqxjAb941KMZ2S2mJJ980Xz4naJ2GgkcOVwuPx0ms,1043
-redsys/api/languages.py,sha256=GPw7JB-CWDyGo6vhcPZDzpjGuwkojFCz1gyfx13wlek,872
-redsys/api/sca.py,sha256=09b9LV9dvBADDTfHnReMR3OuM38ViVRqQs_hLQFBEoE,786
-redsys/api/transactions.py,sha256=HYmaEXsfAb9-Kc9WlTGTetEA23vM1aGsQQua2Ukk3PM,732
-python_redsys-2.0.0.dist-info/METADATA,sha256=lWRxu0v6tYC3RHfS3Rp29hXH8zL6c6scMm7anIUVY3k,9793
-python_redsys-2.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-python_redsys-2.0.0.dist-info/top_level.txt,sha256=79TrHj--FP5SDyZO42-NUsiYJmHiQX42txZigHOqghY,7
-python_redsys-2.0.0.dist-info/RECORD,,