[MIG] payment_redsys: Migration to 17.0

payment_redsys/README.rst

@@ -17,20 +17,20 @@ Pasarela de pago Redsys
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fl10n--spain-lightgray.png?logo=github
-    :target: https://github.com/OCA/l10n-spain/tree/16.0/payment_redsys
+    :target: https://github.com/OCA/l10n-spain/tree/17.0/payment_redsys
     :alt: OCA/l10n-spain
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/l10n-spain-16-0/l10n-spain-16-0-payment_redsys
+    :target: https://translation.odoo-community.org/projects/l10n-spain-17-0/l10n-spain-17-0-payment_redsys
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/l10n-spain&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/l10n-spain&target_branch=17.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-Este módulo añade la opción de pago a través de la pasarela de Redsys, pudiendo
-seleccionar entre los métodos de pago: pago con tarjeta, pago por transferencia,
-domiciliación y Bizum.
+Este módulo añade la opción de pago a través de la pasarela de Redsys,
+pudiendo seleccionar entre los métodos de pago: pago con tarjeta, pago
+por transferencia, domiciliación y Bizum.
 
 **Table of contents**
 
@@ -40,72 +40,68 @@ domiciliación y Bizum.
 Installation
 ============
 
-Para utilizar este módulo, necesita la biblioteca `pycryptodome
-<https://pypi.python.org/pypi/pycryptodome>`_ instalada en su sistema::
+Para utilizar este módulo, necesita la biblioteca
+`pycryptodome <https://pypi.python.org/pypi/pycryptodome>`__ instalada
+en su sistema:
 
-    pip3 install pycryptodome
+::
+
+   pip3 install pycryptodome
 
 Configuration
 =============
 
 Parámetros
-~~~~~~~~~~
-
-* **Nombre del comercio**: Indicaremos el nombre del comercio.
-
-* **Número de comercio (FUC)**: Indicaremos el número de comercio que
-  nuestra entidad nos ha comunicado.
-
-* **Clave secreta de encriptación**: Indicaremos la clave de encriptación
-  que tiene el comercio.
-
-* **Número de terminal**: Indicaremos el terminal del TPV.
-
-* **Tipo de firma**: Seleccionaremos el tipo de firma del comercio.
-
-* **Tipo de moneda**: Seleccionaremos la moneda de nuestro terminal TPV
-  (Normalmente EUR - Euros).
-
-* **Tipo de transacción**: Indicaremos el tipo de transacción, 0.
-
-* **Idioma TPV**: Indicaremos el idioma en el TPV.
-
-* **Método de pago**: Indicaremos qué tipo de pago se debe aceptar, pago con
-  tarjeta, Bizum u otro de los disponibles.
-
-* **Porcentaje de pago**: Indicar el porcentaje de pago que se permite, si
-  se deja a 0.0 se entiende 100%.
+----------
+
+-  **Nombre del comercio**: Indicaremos el nombre del comercio.
+-  **Número de comercio (FUC)**: Indicaremos el número de comercio que
+   nuestra entidad nos ha comunicado.
+-  **Clave secreta de encriptación**: Indicaremos la clave de
+   encriptación que tiene el comercio.
+-  **Número de terminal**: Indicaremos el terminal del TPV.
+-  **Tipo de firma**: Seleccionaremos el tipo de firma del comercio.
+-  **Tipo de moneda**: Seleccionaremos la moneda de nuestro terminal TPV
+   (Normalmente EUR - Euros).
+-  **Tipo de transacción**: Indicaremos el tipo de transacción, 0.
+-  **Idioma TPV**: Indicaremos el idioma en el TPV.
+-  **Método de pago**: Indicaremos qué tipo de pago se debe aceptar,
+   pago con tarjeta, Bizum u otro de los disponibles.
+-  **Porcentaje de pago**: Indicar el porcentaje de pago que se permite,
+   si se deja a 0.0 se entiende 100%.
 
 Nota
-~~~~
+----
 
-Se tiene que verificar la configuración del comercio en el
-módulo de administración de Redsys, donde la opción “Parámetros en las
-URLs” debe tener el valor “SI”.
+Se tiene que verificar la configuración del comercio en el módulo de
+administración de Redsys, donde la opción “Parámetros en las URLs” debe
+tener el valor “SI”.
 
-En caso de que exista más de una base de datos en la instalación, cuando la
-pasarela de pago envía el formulario a "/payment/redsys/return" odoo no sabe
-con que base de datos procesar esta información, por lo que hay que establecer
-los parametros **dbfilter** y **dbname** en el archivo de configuración.
+En caso de que exista más de una base de datos en la instalación, cuando
+la pasarela de pago envía el formulario a "/payment/redsys/return" odoo
+no sabe con que base de datos procesar esta información, por lo que hay
+que establecer los parametros **dbfilter** y **dbname** en el archivo de
+configuración.
 
-Para mostrar simultáneamente en el comercio electrónico varios de los métodos
-de pago que proporciona Redsys, como pago con tarjeta y Bizum por ejemplo,
-debemos duplicar el medio de pago y escoger en el campo método de pago el que
-corresponda en cada caso.
+Para mostrar simultáneamente en el comercio electrónico varios de los
+métodos de pago que proporciona Redsys, como pago con tarjeta y Bizum
+por ejemplo, debemos duplicar el medio de pago y escoger en el campo
+método de pago el que corresponda en cada caso.
 
-En el caso de Bizum, el titular del TPV deberá solicitar al banco su activación.
+En el caso de Bizum, el titular del TPV deberá solicitar al banco su
+activación.
 
 Known issues / Roadmap
 ======================
 
-De acuerdo a los requisitos de Redsys, el tamaño máximo del número de pedido
-resultante (``Ds_Order``) es de 12 caracteres. Este addon trunca dicho
-dato en el comienzo de la transacción, con el resultado de que, aunque Redsys
-la aceptará, no se finalizará el pedido pedido en Odoo al retornar y entregará
-un Error 500 a Redsys.
-Para evitar esto, es recomendable seleccionar secuencias de pedido que se
-ajusten a esta limitación, en particular de 10 o menos caracteres, al ser la
-referencia un número extendido a partir del pedido, que incluye un guion y un
+De acuerdo a los requisitos de Redsys, el tamaño máximo del número de
+pedido resultante (``Ds_Order``) es de 12 caracteres. Este addon trunca
+dicho dato en el comienzo de la transacción, con el resultado de que,
+aunque Redsys la aceptará, no se finalizará el pedido pedido en Odoo al
+retornar y entregará un Error 500 a Redsys. Para evitar esto, es
+recomendable seleccionar secuencias de pedido que se ajusten a esta
+limitación, en particular de 10 o menos caracteres, al ser la referencia
+un número extendido a partir del pedido, que incluye un guion y un
 número secuencial para posibles repeticiones de pago.
 
 Bug Tracker
@@ -114,48 +110,52 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/l10n-spain/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/l10n-spain/issues/new?body=module:%20payment_redsys%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/l10n-spain/issues/new?body=module:%20payment_redsys%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
 Credits
 =======
 
 Authors
-~~~~~~~
+-------
 
 * Tecnativa
 
 Contributors
-~~~~~~~~~~~~
+------------
+
+-  `Tecnativa <https://www.tecnativa.com>`__:
 
-* `Tecnativa <https://www.tecnativa.com>`_:
+   -  Sergio Teruel
+   -  Carlos Dauden
+   -  Carlos Roca
+   -  João Marques
 
-  * Sergio Teruel
-  * Carlos Dauden
-  * Carlos Roca
-  * João Marques
+-  Isaac Gallart <igallart@puntsistemes.es>
+-  `Acysos S.L. <https://www.acysos.com>`__:
 
-* Isaac Gallart <igallart@puntsistemes.es>
+   -  Ignacio Ibeas <ignacio@acysos.com>
 
-* `Acysos S.L. <https://www.acysos.com>`_:
+-  `Planes Asesoria y Soluciones Informaticas
+   S.L. <https://www.planesnet.com>`__:
 
-  * Ignacio Ibeas <ignacio@acysos.com>
+   -  Luis Planes <luis@planesnet.com>
 
-* `Planes Asesoria y Soluciones Informaticas  S.L. <https://www.planesnet.com>`_:
+-  `Studio73 <https://www.studio73.es/>`__:
 
-  * Luis Planes <luis@planesnet.com>
+   -  Rafa Ferri <rafa.ferri@studio73.es>
 
-* `Studio73 <https://www.studio73.es/>`_:
+-  `Factor Libre <https://factorlibre.com/>`__:
 
-  * Rafa Ferri <rafa.ferri@studio73.es>
+   -  Pablo De Andrés <pablo.deandres@factorlibre.com>
 
-* `Factor Libre <https://factorlibre.com/>`_:
+-  `APSL <https://apsl.tech>`__:
 
-  * Pablo De Andrés <pablo.deandres@factorlibre.com>
+   -  Antoni Marroig toni.marroig1@gmail.com
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -167,6 +167,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-This module is part of the `OCA/l10n-spain <https://github.com/OCA/l10n-spain/tree/16.0/payment_redsys>`_ project on GitHub.
+This module is part of the `OCA/l10n-spain <https://github.com/OCA/l10n-spain/tree/17.0/payment_redsys>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

payment_redsys/__manifest__.py

@@ -5,7 +5,7 @@
     "name": "Pasarela de pago Redsys",
     "category": "Payment Acquirer",
     "summary": "Payment Acquirer: Redsys Implementation",
-    "version": "16.0.1.0.1",
+    "version": "17.0.1.0.1",
     "author": "Tecnativa, Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/l10n-spain",
     "depends": ["payment", "website_sale"],

payment_redsys/data/payment_redsys.xml

@@ -2,6 +2,18 @@
 <!-- Copyright 2016-2017 Tecnativa - Sergio Teruel
      License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3). -->
 <odoo noupdate="1">
+    <record id="payment_method_redsys" model="account.payment.method">
+        <field name="name">Redsys</field>
+        <field name="code">redsys</field>
+        <field name="payment_type">inbound</field>
+    </record>
+
+    <record id="payment_method_cc_bizum" model="payment.method">
+        <field name="name">Bizum</field>
+        <field name="code">Bizum</field>
+        <field name="image" type="base64" file="payment_redsys/static/img/bizum.png" />
+    </record>
+
     <record id="payment_provider_redsys" model="payment.provider">
         <field name="name">Redsys</field>
         <field
@@ -21,16 +33,12 @@
             name="pre_msg"
         ><![CDATA[
 <p>You will be redirected to the Redsys payment gateway after clicking on the payment button.</p>]]></field>
-    </record>
-    <record id="payment_icon_cc_bizum" model="payment.icon">
-        <field name="name">Bizum</field>
-        <field name="image" type="base64" file="payment_redsys/static/img/bizum.png" />
-    </record>
-
-    <record id="payment_method_redsys" model="account.payment.method">
-        <field name="name">Redsys</field>
-        <field name="code">redsys</field>
-        <field name="payment_type">inbound</field>
+        <field
+            name="payment_method_ids"
+            eval="[Command.set([
+                         ref('payment_redsys.payment_method_cc_bizum'),
+                     ])]"
+        />
     </record>
 
 </odoo>

payment_redsys/models/payment_transaction.py

@@ -47,7 +47,7 @@ def _get_tx_from_notification_data(self, provider, data):
         if not reference or not pay_id or not shasign:
             error_msg = (
                 "Redsys: received data with missing reference"
-                " (%s) or pay_id (%s) or shashign (%s)" % (reference, pay_id, shasign)
+                " ({reference}) or pay_id ({pay_id}) or shashign ({shasign})"
             )
             if not test_env:
                 _logger.info(error_msg)
@@ -68,8 +68,8 @@ def _get_tx_from_notification_data(self, provider, data):
             )
             if shasign_check != shasign:
                 error_msg = (
-                    "Redsys: invalid shasign, received %s, computed %s, "
-                    "for data %s" % (shasign, shasign_check, data)
+                    "Redsys: invalid shasign, received {shasign}, computed {shasign_check}, "
+                    "for data {data}"
                 )
                 _logger.info(error_msg)
                 raise ValidationError(error_msg)

payment_redsys/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

payment_redsys/readme/CONFIGURE.md

@@ -0,0 +1,37 @@
+## Parámetros
+
+- **Nombre del comercio**: Indicaremos el nombre del comercio.
+- **Número de comercio (FUC)**: Indicaremos el número de comercio que
+  nuestra entidad nos ha comunicado.
+- **Clave secreta de encriptación**: Indicaremos la clave de
+  encriptación que tiene el comercio.
+- **Número de terminal**: Indicaremos el terminal del TPV.
+- **Tipo de firma**: Seleccionaremos el tipo de firma del comercio.
+- **Tipo de moneda**: Seleccionaremos la moneda de nuestro terminal TPV
+  (Normalmente EUR - Euros).
+- **Tipo de transacción**: Indicaremos el tipo de transacción, 0.
+- **Idioma TPV**: Indicaremos el idioma en el TPV.
+- **Método de pago**: Indicaremos qué tipo de pago se debe aceptar, pago
+  con tarjeta, Bizum u otro de los disponibles.
+- **Porcentaje de pago**: Indicar el porcentaje de pago que se permite,
+  si se deja a 0.0 se entiende 100%.
+
+## Nota
+
+Se tiene que verificar la configuración del comercio en el módulo de
+administración de Redsys, donde la opción “Parámetros en las URLs” debe
+tener el valor “SI”.
+
+En caso de que exista más de una base de datos en la instalación, cuando
+la pasarela de pago envía el formulario a "/payment/redsys/return" odoo
+no sabe con que base de datos procesar esta información, por lo que hay
+que establecer los parametros **dbfilter** y **dbname** en el archivo de
+configuración.
+
+Para mostrar simultáneamente en el comercio electrónico varios de los
+métodos de pago que proporciona Redsys, como pago con tarjeta y Bizum
+por ejemplo, debemos duplicar el medio de pago y escoger en el campo
+método de pago el que corresponda en cada caso.
+
+En el caso de Bizum, el titular del TPV deberá solicitar al banco su
+activación.