[MIG] payment_cielo: Migration to 14.0

payment_cielo/README.rst

@@ -1,6 +1,6 @@
-============
-Payent Cielo
-============
+=============
+Payment Cielo
+=============
 
 .. 
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -17,13 +17,13 @@ Payent Cielo
     :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--brazil-lightgray.png?logo=github
-    :target: https://github.com/OCA/l10n-brazil/tree/12.0/payment_cielo
+    :target: https://github.com/OCA/l10n-brazil/tree/14.0/payment_cielo
     :alt: OCA/l10n-brazil
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/l10n-brazil-12-0/l10n-brazil-12-0-payment_cielo
+    :target: https://translation.odoo-community.org/projects/l10n-brazil-14-0/l10n-brazil-14-0-payment_cielo
     :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-brazil&target_branch=12.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/l10n-brazil&target_branch=14.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -67,7 +67,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/l10n-brazil/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-brazil/issues/new?body=module:%20payment_cielo%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/l10n-brazil/issues/new?body=module:%20payment_cielo%0Aversion:%2014.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.
 
@@ -112,6 +112,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-DiegoParadeda| 
 
-This module is part of the `OCA/l10n-brazil <https://github.com/OCA/l10n-brazil/tree/12.0/payment_cielo>`_ project on GitHub.
+This module is part of the `OCA/l10n-brazil <https://github.com/OCA/l10n-brazil/tree/14.0/payment_cielo>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

payment_cielo/__manifest__.py

@@ -2,10 +2,10 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 {
-    "name": "Payent Cielo",
+    "name": "Payment Cielo",
     "summary": """
         Payment Acquirer: Cielo Implementation""",
-    "version": "12.0.3.2.1",
+    "version": "14.0.1.0.0",
     "development_status": "Alpha",
     "license": "AGPL-3",
     "author": "KMEE INFORMATICA LTDA,Odoo Community Association (OCA)",

payment_cielo/controllers/main.py

@@ -31,60 +31,6 @@ def cielo_s2s_create_json_3ds(self, verify_validity=False, **kwargs):
             .s2s_process(kwargs)
         )
 
-        if not token:
-            res = {
-                "result": False,
-            }
-            return res
-
-        res = {
-            "result": True,
-            "short_name": token.short_name,
-            "3d_secure": False,
-            "verified": False,
-        }
-
-        return res
-
-    @http.route(["/payment/cielo/s2s/create_json"], type="json", auth="public")
-    def cielo_s2s_create_json(self, **kwargs):
-        acquirer_id = int(kwargs.get("acquirer_id"))
-        acquirer = request.env["payment.acquirer"].browse(acquirer_id)
-        if not kwargs.get("partner_id"):
-            kwargs["partner_id"] = request.env.user.partner_id.id
-        return acquirer.s2s_process(kwargs).id
-
-    @http.route(["/payment/cielo/s2s/create"], type="http", auth="public")
-    def cielo_s2s_create(self, **post):
-        acquirer_id = int(post.get("acquirer_id"))
-        acquirer = request.env["payment.acquirer"].browse(acquirer_id)
-        error = None
-        try:
-            acquirer.s2s_process(post)
-        except Exception as e:
-            error = str(e)
-
-        return_url = post.get("return_url", "/")
-        if error:
-            separator = "?" if werkzeug.urls.url_parse(return_url).query == "" else "&"
-            return_url += "{}{}".format(
-                separator, werkzeug.urls.url_encode({"error": error})
-            )
-
-        return werkzeug.utils.redirect(return_url)
-
-    @http.route(
-        ["/payment/cielo/s2s/create_json_3ds"], type="json", auth="public", csrf=False
-    )
-    def cielo_s2s_create_json_3ds(self, verify_validity=False, **kwargs):
-        if not kwargs.get("partner_id"):
-            kwargs["partner_id"] = request.env.user.partner_id.id
-        token = (
-            request.env["payment.acquirer"]
-            .browse(int(kwargs.get("acquirer_id")))
-            .s2s_process(kwargs)
-        )
-
         if not token:
             res = {
                 "result": False,
@@ -107,9 +53,8 @@ def cielo_s2s_create_json_3ds(self, verify_validity=False, **kwargs):
 
     @http.route(["/payment/cielo/create_charge"], type="json", auth="public")
     def cielo_create_charge(self, **post):
-        """Create a payment transaction
-
-        Expects the result from the user input from checkout.js popup"""
+        """Create a payment transaction.
+        Expect the result from the user input from checkout.js popup."""
         TX = request.env["payment.transaction"]
         tx = None
         if post.get("tx_ref"):
@@ -153,7 +98,7 @@ def cielo_create_charge(self, **post):
             request.env["payment.transaction"].sudo().with_context(
                 lang=None
             ).form_feedback(response, "cielo")
-        # add the payment transaction into the session to let the page
-        # /payment/process to handle it
+        # Add the payment transaction into the session to let the page
+        # /payment/process handle it.
         PaymentProcessing.add_payment_transaction(tx)
         return "/payment/process"

payment_cielo/data/payment_acquirer_data.xml

@@ -4,7 +4,7 @@
         <record id="payment_acquirer_cielo" model="payment.acquirer">
             <field name="name">Cielo</field>
             <field
-                name="image"
+                name="image_128"
                 type="base64"
                 file="payment_cielo/static/src/img/cielo_icon.png"
             />
@@ -13,7 +13,7 @@
             <field name="company_id" ref="base.main_company" />
             <field name="view_template_id" ref="cielo_form" />
             <field name="registration_view_template_id" ref="cielo_s2s_form" />
-            <field name="environment">test</field>
+            <field name="state">test</field>
             <field
                 name="pre_msg"
             ><![CDATA[

payment_cielo/models/payment_acquirer.py

@@ -11,7 +11,9 @@
 class PaymentAcquirerCielo(models.Model):
     _inherit = "payment.acquirer"
 
-    provider = fields.Selection(selection_add=[("cielo", "Cielo")])
+    provider = fields.Selection(
+        selection_add=[("cielo", "Cielo")], ondelete={"cielo": "set default"}
+    )
     cielo_merchant_key = fields.Char(
         required_if_provider="cielo", groups="base.group_user"
     )
@@ -22,9 +24,8 @@ class PaymentAcquirerCielo(models.Model):
     )
     cielo_image_url = fields.Char("Checkout Image URL", groups="base.group_user")
 
-    @api.multi
     def cielo_s2s_form_validate(self, data):
-        """Validates user input"""
+        """Validate user input"""
         self.ensure_one()
         # mandatory fields
         for field_name in [
@@ -40,10 +41,9 @@ def cielo_s2s_form_validate(self, data):
 
     @api.model
     def cielo_s2s_form_process(self, data):
-        """Saves the payment.token object with data from cielo server
+        """Save the payment.token object with data from Cielo server
 
         Secret card info should be empty by this point.
-
         """
         payment_token = (
             self.env["payment.token"]
@@ -64,31 +64,28 @@ def cielo_s2s_form_process(self, data):
 
     @api.model
     def _get_cielo_api_url(self):
-        """Get cielo API URLs used in all s2s communication
-
-        Takes environment in consideration.
+        """Get Cielo API URLs used in all S2S communication
 
+        Consider state.
         """
-        if self.environment == "test":
+        if self.state == "test":
             return "apisandbox.cieloecommerce.cielo.com.br"
-        if self.environment == "prod":
+        if self.state == "prod":
             return "api.cieloecommerce.cielo.com.br"
 
-    @api.multi
     def _get_cielo_api_headers(self):
-        """Get cielo API headers used in all s2s communication
-
-        Takes environment in consideration. If environment is production
-        merchant_id and merchant_key need to be defined.
+        """Get Cielo API headers used in all S2S communication
 
+        Consider state. If state is production, merchant_id
+        and merchant_key need to be defined.
         """
-        if self.environment == "test":
+        if self.state == "test":
             CIELO_HEADERS = {
                 "MerchantId": "be87a4be-a40d-4a2d-b2c8-b8b6cc19cddd",
                 "MerchantKey": "POHAWRXFBSIXTMTFVBCYSKNWZBMOATDNYUQDGBUE",
                 "Content-Type": "application/json",
             }
-        if self.environment == "prod":
+        if self.state == "prod":
             CIELO_HEADERS = {
                 "MerchantId": self.cielo_merchant_id,
                 "MerchantKey": self.cielo_merchant_key,
@@ -97,7 +94,7 @@ def _get_cielo_api_headers(self):
         return CIELO_HEADERS
 
     def _get_feature_support(self):
-        """Get advanced feature support by provider.
+        """Get advanced feature support by provider
 
         Each provider should add its technical in the corresponding
         key for the following features:

payment_cielo/models/payment_token.py

@@ -45,11 +45,10 @@ class PaymentTokenCielo(models.Model):
     )
 
     def _cielo_tokenize(self, values):
-        """Tokenize card in cielo server.
-
-        Sends card data to cielo and gets back a token. Returns the response
-        dict which still contains all credit card data.
+        """Tokenize card in Cielo server.
 
+        Send card data to Cielo and get back a token. Return the response
+        dict, which still contains all credit card data.
         """
         aquirer_id = self.env.ref("payment_cielo.payment_acquirer_cielo")
         api_url_create_card = "https://%s/1/card" % (aquirer_id._get_cielo_api_url())
@@ -84,13 +83,12 @@ def _cielo_tokenize(self, values):
 
     @api.model
     def cielo_create(self, values):
-        """Treats tokenizing data.
-
-        Calls _cielo_tokenize, formats the response data to the result and
-        removes secret credit card information since it's now stored by cielo.
-        A resulting dict containing card brand, card token, formated name (
-        XXXXXXXXXXXX1234 - Customar Name) and partner_id will be returned.
+        """Treat tokenizing data.
 
+        Call _cielo_tokenize, format the response data to the result and
+        remove secret credit card information since it's now stored by Cielo.
+        Return a resulting dict containing card brand, card token, formatted
+        name (XXXXXXXXXXXX1234 - Customer Name), and partner_id.
         """
         token = self._cielo_tokenize(values)
         if "CardToken" not in token:
@@ -121,7 +119,7 @@ def cielo_create(self, values):
             "cielo_token": values["card_token"],
         }
 
-        # pop credit card info to info sent to create
+        # Pop credit card info from info sent to create
         for field_name in ["card_number", "card_cvc", "card_holder", "card_exp"]:
             res.pop(field_name, None)
         return res

payment_cielo/models/payment_transaction.py

@@ -6,7 +6,7 @@
 
 import requests
 
-from odoo import api, fields, models
+from odoo import fields, models
 
 _logger = logging.getLogger(__name__)
 
@@ -48,10 +48,8 @@ class PaymentTransactionCielo(models.Model):
     )
 
     def _create_cielo_charge(self, acquirer_ref=None, tokenid=None, email=None):
-        """Creates the s2s payment.
-
-        Uses credit card token instead of secret info.
-
+        """Create the s2s payment.
+        Use credit card token instead of secret info.
         """
         api_url_charge = "https://%s/1/sales" % (self.acquirer_id._get_cielo_api_url())
 
@@ -88,17 +86,15 @@ def _create_cielo_charge(self, acquirer_ref=None, tokenid=None, email=None):
         _logger.info("_create_cielo_charge: Values received:\n%s", pprint.pformat(res))
         return res
 
-    @api.multi
     def cielo_s2s_do_transaction(self, **kwargs):
         self.ensure_one()
         result = self._create_cielo_charge(
             acquirer_ref=self.payment_token_id.acquirer_ref, email=self.partner_email
         )
         return self._cielo_s2s_validate_tree(result)
 
-    @api.multi
     def cielo_s2s_capture_transaction(self):
-        """Captures an authorized transaction."""
+        """Capture an authorized transaction."""
         _logger.info(
             "cielo_s2s_capture_transaction: Sending values to URL %s",
             self.cielo_s2s_capture_link,
@@ -113,7 +109,7 @@ def cielo_s2s_capture_transaction(self):
         )
         # analyse result
         if (
-            type(res) == dict
+            isinstance(res, dict)
             and res.get("ProviderReturnMessage")
             and res.get("ProviderReturnMessage") == "Operation Successful"
         ):
@@ -135,9 +131,8 @@ def cielo_s2s_capture_transaction(self):
                 }
             )
 
-    @api.multi
     def cielo_s2s_void_transaction(self):
-        """Voids an authorized transaction."""
+        """Void an authorized transaction."""
         _logger.info(
             "cielo_s2s_void_transaction: Sending values to URL %s",
             self.cielo_s2s_void_link,
@@ -151,7 +146,7 @@ def cielo_s2s_void_transaction(self):
         )
         # analyse result
         if (
-            type(res) == dict
+            isinstance(res, dict)
             and res.get("ProviderReturnMessage")
             and res.get("ProviderReturnMessage") == "Operation Successful"
         ):
@@ -172,15 +167,12 @@ def cielo_s2s_void_transaction(self):
                 }
             )
 
-    @api.multi
     def _cielo_s2s_validate_tree(self, tree):
-        """Validates the transaction.
-
-        This method updates the payment.transaction object describing the
+        """Validate the transaction.
+        Update the payment.transaction object describing the
         actual transaction outcome.
-        Also saves get/capture/void links sent by cielo to make it easier to
+        Save get/capture/void links sent by Cielo to make it easier to
         perform the operations.
-
         """
         self.ensure_one()
         if self.state != "draft":
@@ -190,7 +182,7 @@ def _cielo_s2s_validate_tree(self, tree):
             )
             return True
 
-        if type(tree) != list:
+        if isinstance(tree, dict):
             status = tree.get("Payment").get("Status")
             if status == 1:
                 self.write(
@@ -229,7 +221,7 @@ def _cielo_s2s_validate_tree(self, tree):
                 self._set_transaction_cancel()
                 return False
 
-        elif type(tree) == list:
+        elif isinstance(tree, list):
             error = tree[0].get("Message")
             _logger.warn(error)
             self.sudo().write(