Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 140 additions & 0 deletions edi_webservice_component_oca/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
========================
EDI WebService Component
========================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:3bab37ebd62518d7fd581efa6c8d7c9b3c3f493f3514089083bb4cf8024e1a68
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/licence-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/18.0/edi_webservice_component_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-18-0/edi-framework-18-0-edi_webservice_component_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=18.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

**Deprecated.** Provides the ``component``-based ``edi.webservice.send``
integration for EDI Exchange records (configured via an exchange type's
advanced settings, under ``components: send: usage: webservice.send``),
kept only for backward compatibility with existing setups - including
any custom ``_inherit`` of this component.

It used to be part of ``edi_webservice_oca`` itself; it now lives here
so that installing ``edi_webservice_oca`` no longer requires
``component`` unless you actually need this integration style.

**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_component_oca%0Aversion:%2018.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/18.0/edi_webservice_component_oca>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions edi_webservice_component_oca/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import components
from . import models
18 changes: 18 additions & 0 deletions edi_webservice_component_oca/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Copyright 2020 Dixmit
# Copyright 2022 Camptocamp SA
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

{
"name": "EDI WebService Component",
"summary": """
Component-based webservice send for EDI Exchange records -
legacy integration style, superseded by edi_webservice_core_oca's
handler""",
"version": "18.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_webservice_core_oca", "edi_component_oca"],
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from requests import Response

from odoo import _, exceptions
from odoo import exceptions

from odoo.addons.component.core import Component

Expand Down Expand Up @@ -42,7 +42,7 @@ def _get_call_params(self):
method = self.ws_settings["method"].lower()
except KeyError as err:
raise exceptions.UserError(
_("`method` is required in `webservice` type settings.")
self.env._("`method` is required in `webservice` type settings.")
) from err
pargs = self.ws_settings.get("pargs", [])
kwargs = self.ws_settings.get("kwargs", {})
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Copyright 2020 Dixmit
# Copyright 2025 Camptocamp SA
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

from odoo import fields, models
from odoo import 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):
Expand Down
3 changes: 3 additions & 0 deletions edi_webservice_component_oca/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ Hence, assuming your webservice has a URL configured as
work_ctx:
webservice:
method: post # mandatory
url_params:
path: endpoint1/foo
kwargs:
url_params:
path: endpoint1/foo

For each call related to this type, you'll get a POST request against
https://my.endpoint/endpoint/foo.
Expand Down
2 changes: 2 additions & 0 deletions edi_webservice_component_oca/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Enric Tobella \<<etobella@creublanca.es>\>
- Simone Orsi \<<simone.orsi@camptocamp.com>\>
14 changes: 14 additions & 0 deletions edi_webservice_component_oca/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Provides the `component`-based `edi.webservice.send` integration for EDI
Exchange records (configured via an exchange type's advanced settings,
under `components: send: usage: webservice.send`), for setups that still
rely on it - including any custom `_inherit` of this component.

It used to be part of `edi_webservice_oca` itself; it now lives here so
that installing `edi_webservice_oca` no longer requires `component`
unless you actually need this integration style.

This module itself is not deprecated: it's the supported way to get
`component`-based integration on demand. The integration *style* is the
legacy one, though - new exchange types should use the model-based
handler in `edi_webservice_core_oca` instead (selected via
`send_model_id`).
Loading
Loading