[19.0][MIG] edi_webservice_oca

edi_webservice_oca/README.rst

@@ -0,0 +1,137 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+==============
+EDI WebService
+==============
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:53a13902ac3279b551922ef5e3577b1cebf49ef7b9eca8bed55ee901b04b50d2
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github
+    :target: https://github.com/OCA/edi-framework/tree/19.0/edi_webservice_oca
+    :alt: OCA/edi-framework
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/edi-framework-19-0/edi-framework-19-0-edi_webservice_oca
+    :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/edi-framework&target_branch=19.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Plug webservice module within EDI framework. Allows to configure attach
+webservices on an EDI backend and/or on an exchange type.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+Go to "EDI -> Config -> Backends" and edit or create one. Find the tab
+"Webservice" and add a webservice. On the webservice record you can
+specify all the general parameters to connect to the service (see
+webservice README for more details).
+
+If you want to take full control on if/how the webservice is used you
+can do it via exchange type's advanced settings.
+
+Hence, assuming your webservice has a URL configured as
+\`\ https://my.endpoint/%7Bpath%7D\ \`:
+
+::
+
+   components:
+     send:
+       usage: webservice.send  # or any custom component usage inheriting from this
+       work_ctx:
+         webservice:
+           method: post  # mandatory
+           url_params:
+             path: endpoint1/foo
+
+For each call related to this type, you'll get a POST request against
+https://my.endpoint/endpoint/foo.
+
+``url_params`` can contain all the keys need for URL interpolation.
+
+In addition, you can user ``url`` to override the full url used for the
+call per exchange type.
+
+If you want to send data as bytes you can use the option send_as_bytes
+like:
+
+::
+
+   [...]
+         webservice:
+           send_as_bytes: true
+   [...]
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi-framework/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/edi-framework/issues/new?body=module:%20edi_webservice_oca%0Aversion:%2019.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
+-------
+
+* Dixmit
+* Camptocamp
+
+Contributors
+------------
+
+-  Enric Tobella <etobella@creublanca.es>
+-  Simone Orsi <simone.orsi@camptocamp.com>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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.
+
+.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
+    :target: https://github.com/etobella
+    :alt: etobella
+.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
+    :target: https://github.com/simahawk
+    :alt: simahawk
+
+Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-etobella| |maintainer-simahawk| 
+
+This module is part of the `OCA/edi-framework <https://github.com/OCA/edi-framework/tree/19.0/edi_webservice_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

edi_webservice_oca/__init__.py

@@ -0,0 +1,2 @@
+from . import components
+from . import models

edi_webservice_oca/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2020 Dixmit
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "EDI WebService",
+    "summary": """
+        Defines webservice integration from EDI Exchange records""",
+    "version": "19.0.1.0.0",
+    "license": "AGPL-3",
+    "development_status": "Beta",
+    "author": "Dixmit, Camptocamp, Odoo Community Association (OCA)",
+    "maintainers": ["etobella", "simahawk"],
+    "website": "https://github.com/OCA/edi-framework",
+    "depends": ["edi_component_oca", "webservice"],
+    "data": ["views/edi_backend.xml", "security/ir.model.access.csv"],
+    "demo": ["demo/edi_backend.xml"],
+}

edi_webservice_oca/components/__init__.py

@@ -0,0 +1 @@
+from . import send

edi_webservice_oca/components/send.py

@@ -0,0 +1,48 @@
+# Copyright 2022 Camptocamp SA
+# @author: Simone Orsi <simahawk@gmail.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import _, exceptions
+
+from odoo.addons.component.core import Component
+
+
+class EDIWebserviceSend(Component):
+    """Generic component for webservice requests.
+
+    Configuration is expected to come from the work ctx key `webservice`.
+    You can easily pass via exchange type advanced settings.
+    """
+
+    _name = "edi.webservice.send"
+    _inherit = [
+        "edi.component.mixin",
+    ]
+    _usage = "webservice.send"
+
+    def __init__(self, work_context):
+        super().__init__(work_context)
+        self.ws_settings = getattr(work_context, "webservice", {})
+        self.webservice_backend = self.backend.webservice_backend_id
+
+    def send(self):
+        method, pargs, kwargs = self._get_call_params()
+        return self.webservice_backend.call(method, *pargs, **kwargs)
+
+    def _get_call_params(self):
+        try:
+            method = self.ws_settings["method"].lower()
+        except KeyError as err:
+            raise exceptions.UserError(
+                _("`method` is required in `webservice` type settings.")
+            ) from err
+        pargs = self.ws_settings.get("pargs", [])
+        kwargs = self.ws_settings.get("kwargs", {})
+        kwargs["data"] = self._get_data()
+        return method, pargs, kwargs
+
+    def _get_data(self):
+        # By sending as bytes `requests` won't try to guess and/or alter the encoding.
+        # TODO: add tests
+        as_bytes = self.ws_settings.get("send_as_bytes")
+        return self.exchange_record._get_file_content(as_bytes=as_bytes)

edi_webservice_oca/demo/edi_backend.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="demo_ws_backend" model="webservice.backend">
+        <field name="name">Demo backend</field>
+        <field name="tech_name">edi_demo_ws</field>
+        <field name="protocol">http</field>
+        <field name="url">https://foo.test/{endpoint}</field>
+        <field name="content_type">application/xml</field>
+        <field name="auth_type">none</field>
+    </record>
+    <record id="demo_edi_backend_type" model="edi.backend.type">
+        <field name="name">Demo backend type WS</field>
+        <field name="code">demo_ws_backend</field>
+    </record>
+    <record id="demo_edi_backend" model="edi.backend">
+        <field name="name">Demo backend w/ WS</field>
+        <field name="backend_type_id" ref="demo_edi_backend_type" />
+        <field name="webservice_backend_id" ref="demo_ws_backend" />
+    </record>
+</odoo>

edi_webservice_oca/i18n/edi_webservice.pot

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* edi_webservice
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 13.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: edi_webservice
+#: model:ir.model,name:edi_webservice.model_edi_backend
+msgid "EDI Backend"
+msgstr ""
+
+#. module: edi_webservice
+#: model:ir.model.fields,field_description:edi_webservice.field_edi_backend__webservice_backend_id
+msgid "Webservice Backend"
+msgstr ""

edi_webservice_oca/i18n/edi_webservice_oca.pot

@@ -0,0 +1,35 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* edi_webservice_oca
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 18.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: edi_webservice_oca
+#: model:ir.model,name:edi_webservice_oca.model_edi_backend
+msgid "EDI Backend"
+msgstr ""
+
+#. module: edi_webservice_oca
+#: model_terms:ir.ui.view,arch_db:edi_webservice_oca.edi_backend_view_form
+msgid "Webservice"
+msgstr ""
+
+#. module: edi_webservice_oca
+#: model:ir.model.fields,field_description:edi_webservice_oca.field_edi_backend__webservice_backend_id
+msgid "Webservice Backend"
+msgstr ""
+
+#. module: edi_webservice_oca
+#. odoo-python
+#: code:addons/edi_webservice_oca/components/send.py:0
+msgid "`method` is required in `webservice` type settings."
+msgstr ""

edi_webservice_oca/i18n/it.po

@@ -0,0 +1,39 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* edi_webservice_oca
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2024-05-13 12:34+0000\n"
+"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
+"Language-Team: none\n"
+"Language: it\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=n != 1;\n"
+"X-Generator: Weblate 4.17\n"
+
+#. module: edi_webservice_oca
+#: model:ir.model,name:edi_webservice_oca.model_edi_backend
+msgid "EDI Backend"
+msgstr "Backend EDI"
+
+#. module: edi_webservice_oca
+#: model_terms:ir.ui.view,arch_db:edi_webservice_oca.edi_backend_view_form
+msgid "Webservice"
+msgstr "Servizio web"
+
+#. module: edi_webservice_oca
+#: model:ir.model.fields,field_description:edi_webservice_oca.field_edi_backend__webservice_backend_id
+msgid "Webservice Backend"
+msgstr "Backend servizio web"
+
+#. module: edi_webservice_oca
+#. odoo-python
+#: code:addons/edi_webservice_oca/components/send.py:0
+#, python-format
+msgid "`method` is required in `webservice` type settings."
+msgstr "`method` è richiesto nelle impostazioni tipo `webservice`."

edi_webservice_oca/models/__init__.py

@@ -0,0 +1 @@
+from . import edi_backend

edi_webservice_oca/models/edi_backend.py

@@ -0,0 +1,37 @@
+# Copyright 2020 Dixmit
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class EdiBackend(models.Model):
+    _inherit = "edi.backend"
+
+    webservice_backend_id = fields.Many2one("webservice.backend")
+    _webservice_actions = ("send", "receive")
+
+    def _get_component_usage_candidates(self, exchange_record, key):
+        candidates = super()._get_component_usage_candidates(exchange_record, key)
+        ws_backend = self.webservice_backend_id.sudo()
+        if not ws_backend or key not in self._webservice_actions:
+            return candidates
+        return [f"webservice.{key}"] + candidates
+
+    def _component_match_attrs(self, exchange_record, key):
+        # Override to inject `webservice_protocol` as match attribute
+        res = super()._component_match_attrs(exchange_record, key)
+        ws_backend = self.webservice_backend_id.sudo()
+        if not ws_backend or key not in self._webservice_actions:
+            return res
+        res["webservice_protocol"] = ws_backend.protocol
+        return res
+
+    def _component_sort_key(self, component_class):
+        res = super()._component_sort_key(component_class)
+        ws_backend = self.webservice_backend_id
+        # Override to give precedence by `webservice_protocol` when needed.
+        if not ws_backend:
+            return res
+        return (
+            1 if getattr(component_class, "_webservice_protocol", False) else 0,
+        ) + res

edi_webservice_oca/pyproject.toml

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