From e49ce2191caf98516b2fd04890ea5ba7f5fa7722 Mon Sep 17 00:00:00 2001 From: Daniel Reis Date: Sun, 15 Jun 2025 20:50:04 +0100 Subject: [PATCH] [ADD] webservice_base: light dropin replacement for `webservice` --- webservice_base/README.rst | 230 +++++++ webservice_base/__init__.py | 1 + webservice_base/__manifest__.py | 23 + webservice_base/i18n/fr.po | 404 +++++++++++++ webservice_base/i18n/it.po | 454 ++++++++++++++ webservice_base/i18n/webservice_base.pot | 398 ++++++++++++ webservice_base/models/__init__.py | 2 + webservice_base/models/webservice_backend.py | 98 +++ .../models/webservice_request_adapter.py | 83 +++ webservice_base/pyproject.toml | 3 + webservice_base/readme/CONFIGURE.md | 21 + webservice_base/readme/CONTRIBUTORS.md | 3 + webservice_base/readme/DESCRIPTION.md | 24 + webservice_base/readme/USAGE.md | 73 +++ webservice_base/security/ir.model.access.csv | 2 + webservice_base/security/ir_rule.xml | 10 + webservice_base/static/description/icon.png | Bin 0 -> 9455 bytes webservice_base/static/description/index.html | 567 ++++++++++++++++++ webservice_base/tests/__init__.py | 2 + webservice_base/tests/common.py | 70 +++ webservice_base/tests/test_utils.py | 14 + webservice_base/tests/test_webservice.py | 216 +++++++ webservice_base/utils.py | 25 + webservice_base/views/webservice_backend.xml | 102 ++++ 24 files changed, 2825 insertions(+) create mode 100644 webservice_base/README.rst create mode 100644 webservice_base/__init__.py create mode 100644 webservice_base/__manifest__.py create mode 100644 webservice_base/i18n/fr.po create mode 100644 webservice_base/i18n/it.po create mode 100644 webservice_base/i18n/webservice_base.pot create mode 100644 webservice_base/models/__init__.py create mode 100644 webservice_base/models/webservice_backend.py create mode 100644 webservice_base/models/webservice_request_adapter.py create mode 100644 webservice_base/pyproject.toml create mode 100644 webservice_base/readme/CONFIGURE.md create mode 100644 webservice_base/readme/CONTRIBUTORS.md create mode 100644 webservice_base/readme/DESCRIPTION.md create mode 100644 webservice_base/readme/USAGE.md create mode 100644 webservice_base/security/ir.model.access.csv create mode 100644 webservice_base/security/ir_rule.xml create mode 100644 webservice_base/static/description/icon.png create mode 100644 webservice_base/static/description/index.html create mode 100644 webservice_base/tests/__init__.py create mode 100644 webservice_base/tests/common.py create mode 100644 webservice_base/tests/test_utils.py create mode 100644 webservice_base/tests/test_webservice.py create mode 100644 webservice_base/utils.py create mode 100644 webservice_base/views/webservice_backend.xml diff --git a/webservice_base/README.rst b/webservice_base/README.rst new file mode 100644 index 00000000..bbbfadca --- /dev/null +++ b/webservice_base/README.rst @@ -0,0 +1,230 @@ +=============== +WebService Base +=============== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:ad7f19cee6c43ff3b4e9901cd1fd7be8b4ec5b0c5a73c7fad30497bdb0f27037 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png + :target: https://odoo-community.org/page/development-status + :alt: Production/Stable +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb--api-lightgray.png?logo=github + :target: https://github.com/OCA/web-api/tree/18.0/webservice_base + :alt: OCA/web-api +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-api-18-0/web-api-18-0-webservice_base + :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/web-api&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module creates WebService frameworks to be used globally. + +It introduces support for HTTP Request protocol. The webservice HTTP +call returns by default the content of the response. A ``content_only`` +parameter can be passed to get the full response object. + +This addon is a simplified version of the ``webservice`` module. In most +cases, you can install ``webservice_base`` instead of ``webservice`` as +a drop-in replacement when you need to define a backend and perform HTTP +requests from server-side code. + +It comes with no additional dependencies. For the original +implementation relying on ``component`` objects, see the ``webservice`` +addon module. + +This work is derived from that module, removing the ``component`` and +``server_env`` dependencies to make it lighter. As a design decision, +using ``component`` seems to an an additional abstraction layer (and +dependency) that brings little benefit, and removing it brings the +implementation closer to Odoo's framework design patterns. + +Main differences with ``webservice``: + +- ``webservice_base`` focuses on direct usage from Odoo models (no + component registry layer). +- It provides a lightweight configuration model + (``webservice.backend``) and a request adapter + (``webservice.request.adapter``). +- Features that depend on ``server_environment`` and component-based + extensibility are not part of ``webservice_base``. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure ``webservice_base``: + +1. Enable developer mode. + +2. Go to *Settings > Technical > WebService Backend*. + +3. Create a backend record: + + - **Protocol**: select ``HTTP Request`` + + - **URL**: base URL of the remote service, for example + ``https://api.example.com/`` + + - **Content Type**: set a default ``Content-Type`` header (optional) + + - **Authentication**: + + - **Public**: no authentication + - **Username & password**: set ``Username`` and ``Password`` + - **API Key**: set ``API Key header`` (for example + ``Authorization`` or ``X-Api-Key``) and ``API Key`` + +4. (Optional) Tune timeouts: + + - ``Connect timeout``: seconds to establish the TCP connection + - ``Read timeout``: seconds to wait for the response + +The backend record can be used directly from server-side code using the +``call()`` helper or the inherited adapter methods (``get``, ``post``, +``put``). + +Usage +===== + +This module is meant to be used from server-side code. + +Basic usage +=========== + +1. Create a ``webservice.backend`` record (see *Configuration*). +2. From Python code, fetch the backend and call HTTP methods. + +Example: simple GET +------------------- + +.. code:: python + + backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") + result = backend.call("get", url="api/v1/ping") + +- If ``url`` is relative, it is joined with the backend ``url``. +- If ``url`` is an absolute URL, it is used as-is. + +Example: POST JSON payload +-------------------------- + +.. code:: python + + import json + + backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") + payload = {"name": "John"} + + result = backend.call( + "post", + url="api/v1/contacts", + data=json.dumps(payload), + headers={"Accept": "application/json"}, + content_type="application/json", + ) + +Getting the full ``requests.Response`` +-------------------------------------- + +By default, calls return ``response.content``. To get the full +``requests.Response``, set ``content_only`` to ``False``: + +.. code:: python + + backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") + response = backend.call("get", url="api/v1/ping", content_only=False) + status_code = response.status_code + body = response.content + +Timeouts +-------- + +You can override timeouts per call using ``timeout`` (as accepted by +``requests``): + +- A single number applies to both the connect and read timeouts. +- A tuple ``(connect_timeout, read_timeout)`` allows setting them + separately. + +.. code:: python + + backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") + result = backend.call("get", url="api/v1/ping", timeout=(2, 10)) + +URL formatting with parameters +------------------------------ + +If your backend URL or endpoint contains format placeholders, pass +``url_params``: + +.. code:: python + + backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") + backend.url = "https://api.example.com/{version}/" + result = backend.call("get", url="resources/{resource_id}", url_params={"version": "v1", "resource_id": 42}) + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Creu Blanca +* Camptocamp + +Contributors +------------ + +- Enric Tobella +- Alexandre Fayolle +- Daniel Reis + +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 + +Current `maintainer `__: + +|maintainer-etobella| + +This module is part of the `OCA/web-api `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/webservice_base/__init__.py b/webservice_base/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/webservice_base/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/webservice_base/__manifest__.py b/webservice_base/__manifest__.py new file mode 100644 index 00000000..7129bae3 --- /dev/null +++ b/webservice_base/__manifest__.py @@ -0,0 +1,23 @@ +# Copyright 2020 Creu Blanca +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +{ + "name": "WebService Base", + "summary": """Defines webservice abstract definition to be used generally""", + "version": "18.0.1.1.0", + "license": "LGPL-3", + "development_status": "Production/Stable", + "maintainers": ["etobella"], + "author": "Creu Blanca, Camptocamp, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/web-api", + "depends": ["base"], + "external_dependencies": {"python": ["requests-oauthlib", "oauthlib", "responses"]}, + "data": [ + "security/ir.model.access.csv", + "security/ir_rule.xml", + "views/webservice_backend.xml", + ], + "demo": [], +} diff --git a/webservice_base/i18n/fr.po b/webservice_base/i18n/fr.po new file mode 100644 index 00000000..ce9ed64c --- /dev/null +++ b/webservice_base/i18n/fr.po @@ -0,0 +1,404 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * webservice +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2021-06-17 15:48+0000\n" +"Last-Translator: Yves Le Doeuff \n" +"Language-Team: none\n" +"Language: fr\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.3.2\n" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__api_key +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__api_key +msgid "API Key" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_env_default +msgid "API Key Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__api_key_header +msgid "API Key header" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_header_env_default +msgid "API Key header Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_audience +msgid "Audience" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_audience_env_default +msgid "Audience Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__auth_type +msgid "Auth Type" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_auth_type_env_default +msgid "Auth Type Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_authorization_url +msgid "Authorization URL" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_authorization_url_env_default +msgid "Authorization URL Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__oauth2_flow__backend_application +msgid "Backend Application (Client Credentials Grant)" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_clientid +msgid "Client ID" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_clientid_env_default +msgid "Client ID Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_client_secret +msgid "Client Secret" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_client_secret_env_default +msgid "Client Secret Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__company_id +msgid "Company" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__content_type +msgid "Content Type" +msgstr "Type de contenu" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_content_type_env_default +msgid "Content Type Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__create_uid +msgid "Created by" +msgstr "Créé par" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__create_date +msgid "Created on" +msgstr "Crée le" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__display_name +msgid "Display Name" +msgstr "Afficher Nom" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/x-www-form-urlencoded +msgid "Form" +msgstr "Formulaire" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__protocol__http +msgid "HTTP Request" +msgstr "Requête HTTP" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__id +msgid "ID" +msgstr "ID" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/json +msgid "JSON" +msgstr "JSON" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__write_uid +msgid "Last Updated by" +msgstr "Dernière mise à jour par" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__write_date +msgid "Last Updated on" +msgstr "Dernière mise à jour le" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__name +msgid "Name" +msgstr "Nom" + +#. module: webservice +#: model_terms:ir.ui.view,arch_db:webservice.webservice_backend_form_view +msgid "OAuth Authorize" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__oauth2 +msgid "OAuth2" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_flow +msgid "Oauth2 Flow" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_flow_env_default +msgid "Oauth2 Flow Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_scope +msgid "Oauth2 Scope" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_scope_env_default +msgid "Oauth2 Scope Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_state +msgid "Oauth2 State" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_token +msgid "Oauth2 Token" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__password +msgid "Password" +msgstr "Mot de passe" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_password_env_default +msgid "Password Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__protocol +msgid "Protocol" +msgstr "Protocole" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_protocol_env_default +msgid "Protocol Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__none +msgid "Public" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__redirect_url +msgid "Redirect Url" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__server_env_defaults +msgid "Server Env Defaults" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__tech_name +msgid "Tech Name" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__redirect_url +msgid "The redirect URL to be used as part of the OAuth2 authorisation flow" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_token_url +msgid "Token URL" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_token_url_env_default +msgid "Token URL Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__tech_name +msgid "Unique name for technical purposes. Eg: server env keys." +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__url +msgid "Url" +msgstr "Url" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_url_env_default +msgid "Url Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__username +msgid "Username" +msgstr "nom d'utilisateur :" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__user_pwd +msgid "Username & password" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_username_env_default +msgid "Username Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__oauth2_flow__web_application +msgid "Web Application (Authorization Code Grant)" +msgstr "" + +#. module: webservice +#: model:ir.actions.act_window,name:webservice.webservice_backend_act_window +#: model:ir.model,name:webservice.model_webservice_backend +#: model:ir.ui.menu,name:webservice.webservice_backend_menu +msgid "WebService Backend" +msgstr "" + +#. module: webservice +#. odoo-python +#: code:addons/webservice/models/webservice_backend.py:0 +msgid "" +"Webservice '%(name)s' requires '%(auth_type)s' authentication. However, the " +"following field(s) are not set: %(fields)s" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_env_is_editable +msgid "X Api Key Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_header_env_is_editable +msgid "X Api Key Header Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_auth_type_env_is_editable +msgid "X Auth Type Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_content_type_env_is_editable +msgid "X Content Type Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_audience_env_is_editable +msgid "X Oauth2 Audience Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_authorization_url_env_is_editable +msgid "X Oauth2 Authorization Url Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_client_secret_env_is_editable +msgid "X Oauth2 Client Secret Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_clientid_env_is_editable +msgid "X Oauth2 Clientid Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_flow_env_is_editable +msgid "X Oauth2 Flow Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_scope_env_is_editable +msgid "X Oauth2 Scope Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_token_url_env_is_editable +msgid "X Oauth2 Token Url Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_password_env_is_editable +msgid "X Password Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_protocol_env_is_editable +msgid "X Protocol Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_url_env_is_editable +msgid "X Url Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_username_env_is_editable +msgid "X Username Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/xml +msgid "XML" +msgstr "XLM" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_state +msgid "" +"random key generated when authorization flow starts to ensure that no CSRF " +"attack happen" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_scope +#: model:ir.model.fields,help:webservice.field_webservice_backend__x_oauth2_scope_env_default +msgid "scope of the the authorization" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_token +msgid "the OAuth2 token (serialized JSON)" +msgstr "" + +#~ msgid "Last Modified on" +#~ msgstr "Dernière modification le" diff --git a/webservice_base/i18n/it.po b/webservice_base/i18n/it.po new file mode 100644 index 00000000..26f891e0 --- /dev/null +++ b/webservice_base/i18n/it.po @@ -0,0 +1,454 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * webservice +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2025-05-16 09:24+0000\n" +"Last-Translator: mymage \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 5.10.4\n" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__api_key +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__api_key +msgid "API Key" +msgstr "Chiave API" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_env_default +msgid "API Key Env Default" +msgstr "Chiave API predefinita dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__api_key_header +msgid "API Key header" +msgstr "Intestazione chiave API" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_header_env_default +msgid "API Key header Env Default" +msgstr "Intestazione chiave API predefinita dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_audience +msgid "Audience" +msgstr "Audience" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_audience_env_default +msgid "Audience Env Default" +msgstr "Audience predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__auth_type +msgid "Auth Type" +msgstr "Tipo autorizzazione" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_auth_type_env_default +msgid "Auth Type Env Default" +msgstr "Tipo autoizzazione predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_authorization_url +msgid "Authorization URL" +msgstr "URL autorizzazione" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_authorization_url_env_default +msgid "Authorization URL Env Default" +msgstr "URL autorizzazione predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__oauth2_flow__backend_application +msgid "Backend Application (Client Credentials Grant)" +msgstr "Applicazione backend (concessione credenziali client)" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_clientid +msgid "Client ID" +msgstr "ID client" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_clientid_env_default +msgid "Client ID Env Default" +msgstr "ID client predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_client_secret +msgid "Client Secret" +msgstr "Chiave segreta client" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_client_secret_env_default +msgid "Client Secret Env Default" +msgstr "Chiave csegreta client predefinita dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__company_id +msgid "Company" +msgstr "Azienda" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__content_type +msgid "Content Type" +msgstr "Tipo di contenuto" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_content_type_env_default +msgid "Content Type Env Default" +msgstr "Tipo contenuto predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__create_uid +msgid "Created by" +msgstr "Creato da" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__create_date +msgid "Created on" +msgstr "Creato il" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__display_name +msgid "Display Name" +msgstr "Nome visualizzato" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/x-www-form-urlencoded +msgid "Form" +msgstr "Maschera" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__protocol__http +msgid "HTTP Request" +msgstr "Richiesta HTTP" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__id +msgid "ID" +msgstr "ID" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/json +msgid "JSON" +msgstr "JSON" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__write_uid +msgid "Last Updated by" +msgstr "Ultimo aggiornamento di" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__write_date +msgid "Last Updated on" +msgstr "Ultimo aggiornamento il" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__name +msgid "Name" +msgstr "Nome" + +#. module: webservice +#: model_terms:ir.ui.view,arch_db:webservice.webservice_backend_form_view +msgid "OAuth Authorize" +msgstr "Autorizzazione OAuth" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__oauth2 +msgid "OAuth2" +msgstr "OAuth2" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_flow +msgid "Oauth2 Flow" +msgstr "Flusso OAuth2" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_flow_env_default +msgid "Oauth2 Flow Env Default" +msgstr "Flusso OAuth2 predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_scope +msgid "Oauth2 Scope" +msgstr "Ambito OAuth2" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_scope_env_default +msgid "Oauth2 Scope Env Default" +msgstr "Ambito OAuth2 predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_state +msgid "Oauth2 State" +msgstr "Stato OAuth2" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_token +msgid "Oauth2 Token" +msgstr "Token OAuth2" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__password +msgid "Password" +msgstr "Password" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_password_env_default +msgid "Password Env Default" +msgstr "Password predefinita dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__protocol +msgid "Protocol" +msgstr "Protcollo" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_protocol_env_default +msgid "Protocol Env Default" +msgstr "Protocollo predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__none +msgid "Public" +msgstr "Pubblico" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__redirect_url +msgid "Redirect Url" +msgstr "URL inoltro" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__server_env_defaults +msgid "Server Env Defaults" +msgstr "Predefiniti ambiente server" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__tech_name +msgid "Tech Name" +msgstr "Nome tecnico" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__redirect_url +msgid "The redirect URL to be used as part of the OAuth2 authorisation flow" +msgstr "" +"L'URL di inoltro da utilizzare come parte del flusso di autorizzazione OAuth2" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_token_url +msgid "Token URL" +msgstr "URL token" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_token_url_env_default +msgid "Token URL Env Default" +msgstr "URL token predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__tech_name +msgid "Unique name for technical purposes. Eg: server env keys." +msgstr "Nome univoco per motivi tecnici. Es: chiavi server ambiente." + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__url +msgid "Url" +msgstr "URL" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_url_env_default +msgid "Url Env Default" +msgstr "URL predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__username +msgid "Username" +msgstr "Nome utente" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__user_pwd +msgid "Username & password" +msgstr "Nome utente e password" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_username_env_default +msgid "Username Env Default" +msgstr "Nome utente predefinito dell'ambiente" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__oauth2_flow__web_application +msgid "Web Application (Authorization Code Grant)" +msgstr "Applicazione Web (Concessione codice autorizzazione)" + +#. module: webservice +#: model:ir.actions.act_window,name:webservice.webservice_backend_act_window +#: model:ir.model,name:webservice.model_webservice_backend +#: model:ir.ui.menu,name:webservice.webservice_backend_menu +msgid "WebService Backend" +msgstr "Backend servizio web" + +#. module: webservice +#. odoo-python +#: code:addons/webservice/models/webservice_backend.py:0 +msgid "" +"Webservice '%(name)s' requires '%(auth_type)s' authentication. However, the " +"following field(s) are not set %(fields)s" +msgstr "" +"Il webservice '%(name)s' richiede autentIcazione '%(auth_type)s'. Comunque, " +"i seguenti campi non sono calorizzati: %(fields)s" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_env_is_editable +msgid "X Api Key Env Is Editable" +msgstr "La chiave API X ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_header_env_is_editable +msgid "X Api Key Header Env Is Editable" +msgstr "La chiave API X testata è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_auth_type_env_is_editable +msgid "X Auth Type Env Is Editable" +msgstr "Il tipo autorizzazione x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_content_type_env_is_editable +msgid "X Content Type Env Is Editable" +msgstr "Il tipo contenuto x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_audience_env_is_editable +msgid "X Oauth2 Audience Env Is Editable" +msgstr "Oauth2 pubblica x è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_authorization_url_env_is_editable +msgid "X Oauth2 Authorization Url Env Is Editable" +msgstr "L'autorizzazione oauth2 x è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_client_secret_env_is_editable +msgid "X Oauth2 Client Secret Env Is Editable" +msgstr "La chiave segreta client oauth2 x è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_clientid_env_is_editable +msgid "X Oauth2 Clientid Env Is Editable" +msgstr "Clientid oauth2 x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_flow_env_is_editable +msgid "X Oauth2 Flow Env Is Editable" +msgstr "Il flusso oauth2 x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_scope_env_is_editable +msgid "X Oauth2 Scope Env Is Editable" +msgstr "L'ambito oauth2 x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_token_url_env_is_editable +msgid "X Oauth2 Token Url Env Is Editable" +msgstr "L'URL token oauth2 x è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_password_env_is_editable +msgid "X Password Env Is Editable" +msgstr "La password x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_protocol_env_is_editable +msgid "X Protocol Env Is Editable" +msgstr "Il protocollo x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_url_env_is_editable +msgid "X Url Env Is Editable" +msgstr "L'URL x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_username_env_is_editable +msgid "X Username Env Is Editable" +msgstr "L'username x ambiente è modificabile" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/xml +msgid "XML" +msgstr "XML" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_state +msgid "" +"random key generated when authorization flow starts to ensure that no CSRF " +"attack happen" +msgstr "" +"chiave causale generata quando il flusso autorizzazione inizia per " +"assicurare che non si verifichi un accatto CSRF" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_scope +#: model:ir.model.fields,help:webservice.field_webservice_backend__x_oauth2_scope_env_default +msgid "scope of the the authorization" +msgstr "ambito dell'autorizzazione" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_token +msgid "the OAuth2 token (serialized JSON)" +msgstr "il token OAuth2 (JSON serializzato)" + +#~ msgid "Api Key Env Is Editable" +#~ msgstr "La chiave API ambene è modificabile" + +#~ msgid "Api Key Header Env Is Editable" +#~ msgstr "L'intestazione chiave API ambene è modificabile" + +#~ msgid "Auth Type Env Is Editable" +#~ msgstr "Il tipo autrizzazione ambiente è modificabile" + +#~ msgid "Content Type Env Is Editable" +#~ msgstr "Il tipo contenuto ambiente è modificabile" + +#~ msgid "Last Modified on" +#~ msgstr "Ultima modifica il" + +#~ msgid "Oauth2 Audience Env Is Editable" +#~ msgstr "Audience OAuth2 ambiente è modificabile" + +#~ msgid "Oauth2 Authorization Url Env Is Editable" +#~ msgstr "URL autorizzazione OAuth2 è modificabile" + +#~ msgid "Oauth2 Client Secret Env Is Editable" +#~ msgstr "Chiave segreta OAuth client è modificabile" + +#~ msgid "Oauth2 Clientid Env Is Editable" +#~ msgstr "ID client OAuth2 ambiente è modificabile" + +#~ msgid "Oauth2 Flow Env Is Editable" +#~ msgstr "Flusso OAuth2 ambiente è modificabile" + +#~ msgid "Oauth2 Scope Env Is Editable" +#~ msgstr "Ambito OAuth2 ambiente è modificabile" + +#~ msgid "Oauth2 Token Url Env Is Editable" +#~ msgstr "URL token OAuth2 ambiente è modificabile" + +#~ msgid "Password Env Is Editable" +#~ msgstr "Password ambiente è modificabile" + +#~ msgid "Protocol Env Is Editable" +#~ msgstr "Protocollo ambiente è modificabile" + +#~ msgid "Url Env Is Editable" +#~ msgstr "URL ambiene è modificabile" + +#~ msgid "Username Env Is Editable" +#~ msgstr "Nome utente ambiente è modificabile" diff --git a/webservice_base/i18n/webservice_base.pot b/webservice_base/i18n/webservice_base.pot new file mode 100644 index 00000000..e7df0c99 --- /dev/null +++ b/webservice_base/i18n/webservice_base.pot @@ -0,0 +1,398 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * webservice +# +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: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__api_key +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__api_key +msgid "API Key" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_env_default +msgid "API Key Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__api_key_header +msgid "API Key header" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_header_env_default +msgid "API Key header Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_audience +msgid "Audience" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_audience_env_default +msgid "Audience Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__auth_type +msgid "Auth Type" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_auth_type_env_default +msgid "Auth Type Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_authorization_url +msgid "Authorization URL" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_authorization_url_env_default +msgid "Authorization URL Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__oauth2_flow__backend_application +msgid "Backend Application (Client Credentials Grant)" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_clientid +msgid "Client ID" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_clientid_env_default +msgid "Client ID Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_client_secret +msgid "Client Secret" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_client_secret_env_default +msgid "Client Secret Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__company_id +msgid "Company" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__content_type +msgid "Content Type" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_content_type_env_default +msgid "Content Type Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__create_uid +msgid "Created by" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__create_date +msgid "Created on" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__display_name +msgid "Display Name" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/x-www-form-urlencoded +msgid "Form" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__protocol__http +msgid "HTTP Request" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__id +msgid "ID" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/json +msgid "JSON" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__write_date +msgid "Last Updated on" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__name +msgid "Name" +msgstr "" + +#. module: webservice +#: model_terms:ir.ui.view,arch_db:webservice.webservice_backend_form_view +msgid "OAuth Authorize" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__oauth2 +msgid "OAuth2" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_flow +msgid "Oauth2 Flow" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_flow_env_default +msgid "Oauth2 Flow Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_scope +msgid "Oauth2 Scope" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_scope_env_default +msgid "Oauth2 Scope Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_state +msgid "Oauth2 State" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_token +msgid "Oauth2 Token" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__password +msgid "Password" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_password_env_default +msgid "Password Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__protocol +msgid "Protocol" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_protocol_env_default +msgid "Protocol Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__none +msgid "Public" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__redirect_url +msgid "Redirect Url" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__server_env_defaults +msgid "Server Env Defaults" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__tech_name +msgid "Tech Name" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__redirect_url +msgid "The redirect URL to be used as part of the OAuth2 authorisation flow" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__oauth2_token_url +msgid "Token URL" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_token_url_env_default +msgid "Token URL Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__tech_name +msgid "Unique name for technical purposes. Eg: server env keys." +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__url +msgid "Url" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_url_env_default +msgid "Url Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__username +msgid "Username" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__auth_type__user_pwd +msgid "Username & password" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_username_env_default +msgid "Username Env Default" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__oauth2_flow__web_application +msgid "Web Application (Authorization Code Grant)" +msgstr "" + +#. module: webservice +#: model:ir.actions.act_window,name:webservice.webservice_backend_act_window +#: model:ir.model,name:webservice.model_webservice_backend +#: model:ir.ui.menu,name:webservice.webservice_backend_menu +msgid "WebService Backend" +msgstr "" + +#. module: webservice +#. odoo-python +#: code:addons/webservice/models/webservice_backend.py:0 +msgid "" +"Webservice '%(name)s' requires '%(auth_type)s' authentication. However, the " +"following field(s) are not set: %(fields)s" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_env_is_editable +msgid "X Api Key Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_api_key_header_env_is_editable +msgid "X Api Key Header Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_auth_type_env_is_editable +msgid "X Auth Type Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_content_type_env_is_editable +msgid "X Content Type Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_audience_env_is_editable +msgid "X Oauth2 Audience Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_authorization_url_env_is_editable +msgid "X Oauth2 Authorization Url Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_client_secret_env_is_editable +msgid "X Oauth2 Client Secret Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_clientid_env_is_editable +msgid "X Oauth2 Clientid Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_flow_env_is_editable +msgid "X Oauth2 Flow Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_scope_env_is_editable +msgid "X Oauth2 Scope Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_oauth2_token_url_env_is_editable +msgid "X Oauth2 Token Url Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_password_env_is_editable +msgid "X Password Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_protocol_env_is_editable +msgid "X Protocol Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_url_env_is_editable +msgid "X Url Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,field_description:webservice.field_webservice_backend__x_username_env_is_editable +msgid "X Username Env Is Editable" +msgstr "" + +#. module: webservice +#: model:ir.model.fields.selection,name:webservice.selection__webservice_backend__content_type__application/xml +msgid "XML" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_state +msgid "" +"random key generated when authorization flow starts to ensure that no CSRF " +"attack happen" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_scope +#: model:ir.model.fields,help:webservice.field_webservice_backend__x_oauth2_scope_env_default +msgid "scope of the the authorization" +msgstr "" + +#. module: webservice +#: model:ir.model.fields,help:webservice.field_webservice_backend__oauth2_token +msgid "the OAuth2 token (serialized JSON)" +msgstr "" diff --git a/webservice_base/models/__init__.py b/webservice_base/models/__init__.py new file mode 100644 index 00000000..4e364b45 --- /dev/null +++ b/webservice_base/models/__init__.py @@ -0,0 +1,2 @@ +from . import webservice_request_adapter +from . import webservice_backend diff --git a/webservice_base/models/webservice_backend.py b/webservice_base/models/webservice_backend.py new file mode 100644 index 00000000..282ce68b --- /dev/null +++ b/webservice_base/models/webservice_backend.py @@ -0,0 +1,98 @@ +# Copyright 2020 Creu Blanca +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# @author Alexandre Fayolle +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). +import logging + +from odoo import _, api, exceptions, fields, models + +_logger = logging.getLogger(__name__) + + +class WebserviceBackend(models.Model): + _name = "webservice.backend" + _inherit = ["webservice.request.adapter"] + _description = "WebService Backend" + + name = fields.Char(required=True) + tech_name = fields.Char(required=True) + protocol = fields.Selection([("http", "HTTP Request")], required=True) + url = fields.Char(required=True) + auth_type = fields.Selection( + selection=[ + ("none", "Public"), + ("user_pwd", "Username & password"), + ("api_key", "API Key"), + ("oauth2", "OAuth2"), + ], + required=True, + ) + connect_timeout = fields.Integer(default=5, help="In seconds") + read_timeout = fields.Integer(default=30, help="In seconds") + username = fields.Char(auth_type="user_pwd") + password = fields.Char(auth_type="user_pwd") + api_key = fields.Char(string="API Key", auth_type="api_key") + api_key_header = fields.Char(string="API Key header", auth_type="api_key") + content_type = fields.Selection( + [ + ("application/json", "JSON"), + ("application/xml", "XML"), + ("application/x-www-form-urlencoded", "Form"), + ], + ) + company_id = fields.Many2one("res.company", string="Company") + + @api.model + def get_by_tech_name(self, tech_name): + backend = self.search( + [ + ("tech_name", "=", tech_name), + "|", + ("company_id", "=", self.env.company.id), + ("company_id", "=", False), + ], + limit=1, + order="company_id desc, id desc", + ) + if not backend: + raise exceptions.UserError( + _("No WebService Backend found for tech name '%(tech_name)s'.") + % {"tech_name": tech_name} + ) + return backend + + @api.constrains("auth_type") + def _check_auth_type(self): + all_fields = self._fields.items() + auth_fields = [x for x in all_fields if hasattr(x[1], "auth_type")] + for rec in self: + needed_fields = [x for x in auth_fields if x[1].auth_type == rec.auth_type] + missing_fields = [x for x in needed_fields if not rec[x[0]]] + if needed_fields and missing_fields: + missing = [x[1] for x in missing_fields] + raise exceptions.UserError(rec._msg_missing_auth_param(missing)) + + def _msg_missing_auth_param(self, missing_fields): + def get_selection_value(fname): + return self._fields.get(fname).convert_to_export(self[fname], self) + + return _( + "Webservice '%(name)s' requires '%(auth_type)s' authentication. " + "However, the following field(s) are not set: %(fields)s" + ) % { + "name": self.name, + "auth_type": get_selection_value("auth_type"), + "fields": ", ".join([f.string for f in missing_fields]), + } + + # TODO: remove? + def _valid_field_parameter(self, field, name): + extra_params = ("auth_type",) + return name in extra_params or super()._valid_field_parameter(field, name) + + def call(self, method, *args, **kwargs): + _logger.debug("backend %s: call %s %s %s", self.name, method, args, kwargs) + response = getattr(self, method)(*args, **kwargs) + _logger.debug("backend %s: response: \n%s", self.name, response) + return response diff --git a/webservice_base/models/webservice_request_adapter.py b/webservice_base/models/webservice_request_adapter.py new file mode 100644 index 00000000..97cf73ac --- /dev/null +++ b/webservice_base/models/webservice_request_adapter.py @@ -0,0 +1,83 @@ +# Copyright 2020 Creu Blanca +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import logging + +import requests + +from odoo import models + +from ..utils import sanitize_url_for_log + +_logger = logging.getLogger(__name__) + + +class WebserviceRequestAdapter(models.AbstractModel): + _name = "webservice.request.adapter" + _description = "Webservice Requests Adapter" + + # PUBLIC API + + def get(self, **kwargs): + return self._request("get", **kwargs) + + def post(self, **kwargs): + return self._request("post", **kwargs) + + def put(self, **kwargs): + return self._request("put", **kwargs) + + # PRIVATE IMPLEMENTATION + + def _request(self, method, url=None, url_params=None, **kwargs): + content_only = kwargs.pop("content_only", True) + url, req_kwargs = self._prepare_request(url, url_params, **kwargs) + _logger.debug("%s call to %s", method, sanitize_url_for_log(url)) + response = self._request_do(method, url, **req_kwargs) + response.raise_for_status() + if content_only: + return response.content + return response + + def _prepare_request(self, url=None, url_params=None, **kwargs): + url = self._get_url(url=url, url_params=url_params) + req_kwargs = kwargs.copy() + req_kwargs.update( + { + "auth": self._get_auth(**kwargs), + "headers": self._get_headers(**kwargs), + } + ) + return url, req_kwargs + + def _request_do(self, method, url=None, **kwargs): + timeout = kwargs.pop( + "timeout", + ( + self.connect_timeout, + self.read_timeout, + ), + ) + return requests.request(method, url, timeout=timeout, **kwargs) + + def _get_url(self, url=None, url_params=None, **kwargs): + url = url or self.get("url") + url_params = url_params or kwargs + return url.format(**url_params) + + def _get_auth(self, auth=False, **kwargs): + if auth: + return auth + if self.auth_type == "user_pwd" and self.username and self.password: + return self.username, self.password + return None + + def _get_headers(self, content_type=False, headers=False, **kwargs): + headers = headers or {} + if content_type or self.content_type: + headers["Content-Type"] = content_type or self.content_type + if self.auth_type == "api_key": + headers[self.api_key_header] = self.api_key + return headers diff --git a/webservice_base/pyproject.toml b/webservice_base/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/webservice_base/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/webservice_base/readme/CONFIGURE.md b/webservice_base/readme/CONFIGURE.md new file mode 100644 index 00000000..fd79578a --- /dev/null +++ b/webservice_base/readme/CONFIGURE.md @@ -0,0 +1,21 @@ +To configure `webservice_base`: + +1. Enable developer mode. +2. Go to *Settings > Technical > WebService Backend*. +3. Create a backend record: + + - **Protocol**: select `HTTP Request` + - **URL**: base URL of the remote service, for example `https://api.example.com/` + - **Content Type**: set a default `Content-Type` header (optional) + - **Authentication**: + + - **Public**: no authentication + - **Username & password**: set `Username` and `Password` + - **API Key**: set `API Key header` (for example `Authorization` or `X-Api-Key`) and `API Key` + +4. (Optional) Tune timeouts: + + - `Connect timeout`: seconds to establish the TCP connection + - `Read timeout`: seconds to wait for the response + +The backend record can be used directly from server-side code using the `call()` helper or the inherited adapter methods (`get`, `post`, `put`). diff --git a/webservice_base/readme/CONTRIBUTORS.md b/webservice_base/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..6f21e09d --- /dev/null +++ b/webservice_base/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- Enric Tobella \<\> +- Alexandre Fayolle \<\> +- Daniel Reis \<\> diff --git a/webservice_base/readme/DESCRIPTION.md b/webservice_base/readme/DESCRIPTION.md new file mode 100644 index 00000000..abcf314d --- /dev/null +++ b/webservice_base/readme/DESCRIPTION.md @@ -0,0 +1,24 @@ +This module creates WebService frameworks to be used globally. + +It introduces support for HTTP Request protocol. +The webservice HTTP call returns by default the content of the response. +A `content_only` parameter can be passed to get the full response object. + +This addon is a simplified version of the `webservice` module. +In most cases, you can install `webservice_base` instead of `webservice` as a drop-in replacement when you need to define a backend and perform HTTP requests from server-side code. + +It comes with no additional dependencies. +For the original implementation relying on `component` objects, +see the `webservice` addon module. + +This work is derived from that module, +removing the `component` and `server_env` dependencies to make it lighter. +As a design decision, using `component` seems to an an additional abstraction layer +(and dependency) that brings little benefit, and removing it brings the implementation +closer to Odoo's framework design patterns. + +Main differences with `webservice`: + +- `webservice_base` focuses on direct usage from Odoo models (no component registry layer). +- It provides a lightweight configuration model (`webservice.backend`) and a request adapter (`webservice.request.adapter`). +- Features that depend on `server_environment` and component-based extensibility are not part of `webservice_base`. diff --git a/webservice_base/readme/USAGE.md b/webservice_base/readme/USAGE.md new file mode 100644 index 00000000..57fe9ef9 --- /dev/null +++ b/webservice_base/readme/USAGE.md @@ -0,0 +1,73 @@ +This module is meant to be used from server-side code. + +Basic usage +=========== + +1. Create a `webservice.backend` record (see *Configuration*). +2. From Python code, fetch the backend and call HTTP methods. + +Example: simple GET +------------------- + +```python +backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") +result = backend.call("get", url="api/v1/ping") +``` + +- If `url` is relative, it is joined with the backend `url`. +- If `url` is an absolute URL, it is used as-is. + +Example: POST JSON payload +------------------------- + +```python +import json + +backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") +payload = {"name": "John"} + +result = backend.call( + "post", + url="api/v1/contacts", + data=json.dumps(payload), + headers={"Accept": "application/json"}, + content_type="application/json", +) +``` + +Getting the full `requests.Response` +----------------------------------- + +By default, calls return `response.content`. +To get the full `requests.Response`, set `content_only` to `False`: + +```python +backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") +response = backend.call("get", url="api/v1/ping", content_only=False) +status_code = response.status_code +body = response.content +``` + +Timeouts +-------- + +You can override timeouts per call using `timeout` (as accepted by `requests`): + +- A single number applies to both the connect and read timeouts. +- A tuple `(connect_timeout, read_timeout)` allows setting them separately. + +```python +backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") +result = backend.call("get", url="api/v1/ping", timeout=(2, 10)) +``` + +URL formatting with parameters +------------------------------ + +If your backend URL or endpoint contains format placeholders, pass `url_params`: + +```python +backend = self.env["webservice.backend"].get_by_tech_name("demo_ws") +backend.url = "https://api.example.com/{version}/" +result = backend.call("get", url="resources/{resource_id}", url_params={"version": "v1", "resource_id": 42}) +``` diff --git a/webservice_base/security/ir.model.access.csv b/webservice_base/security/ir.model.access.csv new file mode 100644 index 00000000..f8bb5166 --- /dev/null +++ b/webservice_base/security/ir.model.access.csv @@ -0,0 +1,2 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_webservice_backend_edit,webservice_backend edit,model_webservice_backend,base.group_system,1,1,1,1 diff --git a/webservice_base/security/ir_rule.xml b/webservice_base/security/ir_rule.xml new file mode 100644 index 00000000..367dfb6c --- /dev/null +++ b/webservice_base/security/ir_rule.xml @@ -0,0 +1,10 @@ + + + + webservice_backend multi-company + + + ['|', ('company_id','=',False), ('company_id', 'in', company_ids)] + + + diff --git a/webservice_base/static/description/icon.png b/webservice_base/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/webservice_base/static/description/index.html b/webservice_base/static/description/index.html new file mode 100644 index 00000000..4203268a --- /dev/null +++ b/webservice_base/static/description/index.html @@ -0,0 +1,567 @@ + + + + + +WebService Base + + + +
+

WebService Base

+ + +

Production/Stable License: LGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

+

This module creates WebService frameworks to be used globally.

+

It introduces support for HTTP Request protocol. The webservice HTTP +call returns by default the content of the response. A content_only +parameter can be passed to get the full response object.

+

This addon is a simplified version of the webservice module. In most +cases, you can install webservice_base instead of webservice as +a drop-in replacement when you need to define a backend and perform HTTP +requests from server-side code.

+

It comes with no additional dependencies. For the original +implementation relying on component objects, see the webservice +addon module.

+

This work is derived from that module, removing the component and +server_env dependencies to make it lighter. As a design decision, +using component seems to an an additional abstraction layer (and +dependency) that brings little benefit, and removing it brings the +implementation closer to Odoo’s framework design patterns.

+

Main differences with webservice:

+
    +
  • webservice_base focuses on direct usage from Odoo models (no +component registry layer).
    • +
  • It provides a lightweight configuration model +(webservice.backend) and a request adapter +(webservice.request.adapter).
    • +
  • Features that depend on server_environment and component-based +extensibility are not part of webservice_base.
    • +
+

Table of contents

+ +
+

Configuration

+

To configure webservice_base:

+
    +
  1. Enable developer mode.
    2. +
  2. Go to Settings > Technical > WebService Backend.
    3. +
  3. Create a backend record:
      +
    • Protocol: select HTTP Request
      • +
    • URL: base URL of the remote service, for example +https://api.example.com/
      • +
    • Content Type: set a default Content-Type header (optional)
      • +
    • Authentication:
        +
      • Public: no authentication
        • +
      • Username & password: set Username and Password
        • +
      • API Key: set API Key header (for example +Authorization or X-Api-Key) and API Key
        • +
      +
      • +
    +
    4. +
  4. (Optional) Tune timeouts:
      +
    • Connect timeout: seconds to establish the TCP connection
      • +
    • Read timeout: seconds to wait for the response
      • +
    +
    5. +
+

The backend record can be used directly from server-side code using the +call() helper or the inherited adapter methods (get, post, +put).

+
+
+

Usage

+

This module is meant to be used from server-side code.

+
+
+

Basic usage

+
    +
  1. Create a webservice.backend record (see Configuration).
    2. +
  2. From Python code, fetch the backend and call HTTP methods.
    3. +
+
+

Example: simple GET

+
+backend = self.env["webservice.backend"].get_by_tech_name("demo_ws")
+result = backend.call("get", url="api/v1/ping")
+
+
    +
  • If url is relative, it is joined with the backend url.
    • +
  • If url is an absolute URL, it is used as-is.
    • +
+
+
+

Example: POST JSON payload

+
+import json
+
+backend = self.env["webservice.backend"].get_by_tech_name("demo_ws")
+payload = {"name": "John"}
+
+result = backend.call(
+    "post",
+    url="api/v1/contacts",
+    data=json.dumps(payload),
+    headers={"Accept": "application/json"},
+    content_type="application/json",
+)
+
+
+
+

Getting the full requests.Response

+

By default, calls return response.content. To get the full +requests.Response, set content_only to False:

+
+backend = self.env["webservice.backend"].get_by_tech_name("demo_ws")
+response = backend.call("get", url="api/v1/ping", content_only=False)
+status_code = response.status_code
+body = response.content
+
+
+
+

Timeouts

+

You can override timeouts per call using timeout (as accepted by +requests):

+
    +
  • A single number applies to both the connect and read timeouts.
    • +
  • A tuple (connect_timeout, read_timeout) allows setting them +separately.
    • +
+
+backend = self.env["webservice.backend"].get_by_tech_name("demo_ws")
+result = backend.call("get", url="api/v1/ping", timeout=(2, 10))
+
+
+
+

URL formatting with parameters

+

If your backend URL or endpoint contains format placeholders, pass +url_params:

+
+backend = self.env["webservice.backend"].get_by_tech_name("demo_ws")
+backend.url = "https://api.example.com/{version}/"
+result = backend.call("get", url="resources/{resource_id}", url_params={"version": "v1", "resource_id": 42})
+
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Creu Blanca
    • +
  • Camptocamp
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainer:

+

etobella

+

This module is part of the OCA/web-api project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/webservice_base/tests/__init__.py b/webservice_base/tests/__init__.py new file mode 100644 index 00000000..6aad0d72 --- /dev/null +++ b/webservice_base/tests/__init__.py @@ -0,0 +1,2 @@ +from . import test_webservice +from . import test_utils diff --git a/webservice_base/tests/common.py b/webservice_base/tests/common.py new file mode 100644 index 00000000..ff2dde77 --- /dev/null +++ b/webservice_base/tests/common.py @@ -0,0 +1,70 @@ +# Copyright 2020 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +from contextlib import contextmanager +from unittest import mock +from urllib.parse import urlparse + +from requests import PreparedRequest, Session + +from odoo.tests.common import tagged + +from odoo.addons.component.tests.common import TransactionComponentCase + + +@tagged("-at_install", "post_install") +class CommonWebService(TransactionComponentCase): + @classmethod + def _setup_context(cls): + return dict( + cls.env.context, + tracking_disable=True, + queue_job__no_delay=True, + ) + + @classmethod + def _setup_env(cls): + cls.env = cls.env(context=cls._setup_context()) + + @classmethod + def _setup_records(cls): + pass + + @classmethod + def setUpClass(cls): + cls._super_send = Session.send + super().setUpClass() + cls._setup_env() + cls._setup_records() + + @classmethod + def _request_handler(cls, s: Session, r: PreparedRequest, /, **kw): + if urlparse(r.url).netloc in ("localhost.demo.odoo", "custom.url"): + return cls._super_send(s, r) + return super()._request_handler(s, r, **kw) + + +@contextmanager +def mock_cursor(cr): + # Preserve the original methods and attributes + org_close = cr.close + org_autocommit = cr._cnx.autocommit + org_commit = cr.commit + + try: + # Mock methods and attributes + cr.close = mock.Mock() + cr.commit = mock.Mock() + # Mocking the autocommit attribute + mock_autocommit = mock.PropertyMock(return_value=False) + type(cr._cnx).autocommit = mock_autocommit + + # Mock the cursor method to return the current cr + with mock.patch("odoo.sql_db.Connection.cursor", return_value=cr): + yield cr + + finally: + # Restore the original methods and attributes + cr.close = org_close + cr.commit = org_commit + # Restore the original autocommit property + type(cr._cnx).autocommit = org_autocommit diff --git a/webservice_base/tests/test_utils.py b/webservice_base/tests/test_utils.py new file mode 100644 index 00000000..b02bca4a --- /dev/null +++ b/webservice_base/tests/test_utils.py @@ -0,0 +1,14 @@ +# Copyright 2023 Camptocamp SA +# @author Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +from odoo.tests.common import BaseCase + +from odoo.addons.webservice_base.utils import sanitize_url_for_log + + +class TestUtils(BaseCase): + def test_url_cleanup(self): + url = "https://custom.url/?a=1&apikey=secret&password=moresecret" + self.assertEqual(sanitize_url_for_log(url), "https://custom.url/?a=1") diff --git a/webservice_base/tests/test_webservice.py b/webservice_base/tests/test_webservice.py new file mode 100644 index 00000000..3c7fc312 --- /dev/null +++ b/webservice_base/tests/test_webservice.py @@ -0,0 +1,216 @@ +# Copyright 2020 Creu Blanca +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +import responses +from requests import auth +from requests import exceptions as http_exceptions + +from odoo import exceptions + +from .common import CommonWebService + + +class TestWebService(CommonWebService): + @classmethod + def _setup_records(cls): + res = super()._setup_records() + cls.url = "https://localhost.demo.odoo/" + cls.webservice = cls.env["webservice.backend"].create( + { + "name": "WebService", + "protocol": "http", + "url": cls.url, + "content_type": "application/xml", + "tech_name": "demo_ws", + "auth_type": "none", + } + ) + return res + + def test_web_service_not_found(self): + with self.assertRaises(http_exceptions.ConnectionError): + self.webservice.call("get") + + def test_auth_validation(self): + msg = ( + r"Webservice 'WebService' " + r"requires 'Username & password' authentication. " + r"However, the following field\(s\) are not valued: Username, Password" + ) + with self.assertRaisesRegex(exceptions.UserError, msg): + self.webservice.write( + { + "auth_type": "user_pwd", + } + ) + + msg = ( + r"Webservice 'WebService' " + r"requires 'Username & password' authentication. " + r"However, the following field\(s\) are not valued: Password" + ) + with self.assertRaisesRegex(exceptions.UserError, msg): + self.webservice.write({"auth_type": "user_pwd", "username": "user"}) + + msg = ( + r"Webservice 'WebService' " + r"requires 'API Key' authentication. " + r"However, the following field\(s\) are not valued: API Key, API Key header" + ) + with self.assertRaisesRegex(exceptions.UserError, msg): + self.webservice.write( + { + "auth_type": "api_key", + } + ) + + msg = ( + r"Webservice 'WebService' " + r"requires 'API Key' authentication. " + r"However, the following field\(s\) are not valued: API Key header" + ) + with self.assertRaisesRegex(exceptions.UserError, msg): + self.webservice.write( + { + "auth_type": "api_key", + "api_key": "foo", + } + ) + + @responses.activate + def test_web_service_get(self): + responses.add(responses.GET, self.url, body="{}") + result = self.webservice.call("get") + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + + @responses.activate + def test_web_service_get_url_combine(self): + endpoint = "api/test" + responses.add(responses.GET, self.url + endpoint, body="{}") + result = self.webservice.call("get", url="api/test") + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + + @responses.activate + def test_web_service_get_url_combine_full_url(self): + endpoint = "api/test" + responses.add(responses.GET, self.url + endpoint, body="{}") + result = self.webservice.call("get", url="https://localhost.demo.odoo/api/test") + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + + @responses.activate + def test_web_service_post(self): + responses.add(responses.POST, self.url, body="{}") + result = self.webservice.call("post", data="demo_response") + self.assertEqual(result, b"{}") + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + self.assertEqual(responses.calls[0].request.body, "demo_response") + + @responses.activate + def test_web_service_put(self): + responses.add(responses.PUT, self.url, body="{}") + result = self.webservice.call("put", data="demo_response") + self.assertEqual(result, b"{}") + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + self.assertEqual(responses.calls[0].request.body, "demo_response") + + @responses.activate + def test_web_service_backend_username(self): + self.webservice.write( + {"auth_type": "user_pwd", "username": "user", "password": "pass"} + ) + responses.add(responses.GET, self.url, body="{}") + result = self.webservice.call("get") + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + data = auth._basic_auth_str("user", "pass") + self.assertEqual(responses.calls[0].request.headers["Authorization"], data) + + @responses.activate + def test_web_service_username(self): + self.webservice.write( + {"auth_type": "user_pwd", "username": "user", "password": "pass"} + ) + responses.add(responses.GET, self.url, body="{}") + result = self.webservice.call("get", auth=("user2", "pass2")) + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + data = auth._basic_auth_str("user2", "pass2") + self.assertEqual(responses.calls[0].request.headers["Authorization"], data) + + @responses.activate + def test_web_service_backend_api_key(self): + self.webservice.write( + {"auth_type": "api_key", "api_key": "123xyz", "api_key_header": "Api-Key"} + ) + responses.add(responses.POST, self.url, body="{}") + result = self.webservice.call("post") + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + self.assertEqual(responses.calls[0].request.headers["Api-Key"], "123xyz") + + @responses.activate + def test_web_service_headers(self): + responses.add(responses.GET, self.url, body="{}") + result = self.webservice.call("get", headers={"demo_header": "HEADER"}) + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + self.assertEqual(responses.calls[0].request.headers["demo_header"], "HEADER") + + @responses.activate + def test_web_service_call_args(self): + url = "https://custom.url" + responses.add(responses.POST, url, body="{}") + result = self.webservice.call( + "post", url=url, headers={"demo_header": "HEADER"} + ) + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 1) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + self.assertEqual(responses.calls[0].request.headers["demo_header"], "HEADER") + + url = self.url + "custom/path" + self.webservice.url += "{endpoint}" + responses.add(responses.POST, url, body="{}") + result = self.webservice.call( + "post", + url_params={"endpoint": "custom/path"}, + headers={"demo_header": "HEADER"}, + ) + self.assertEqual(result, b"{}") + self.assertEqual(len(responses.calls), 2) + self.assertEqual( + responses.calls[0].request.headers["Content-Type"], "application/xml" + ) + self.assertEqual(responses.calls[0].request.headers["demo_header"], "HEADER") diff --git a/webservice_base/utils.py b/webservice_base/utils.py new file mode 100644 index 00000000..778e61da --- /dev/null +++ b/webservice_base/utils.py @@ -0,0 +1,25 @@ +# Copyright 2023 Camptocamp SA +# @author Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from urllib.parse import parse_qs, urlencode, urlparse, urlunparse + + +def sanitize_url_for_log(url, blacklisted_keys=None): + """Sanitize url to avoid loggin sensitive data""" + blacklisted_keys = blacklisted_keys or ("apikey", "password", "pwd") + parsed = urlparse(url) + query = parse_qs(parsed.query, keep_blank_values=False) + clean_query = {} + + def is_blacklisted(k): + for bl_key in blacklisted_keys: + if bl_key.lower() in k.lower(): + return True + + for k, v in query.items(): + if not is_blacklisted(k): + clean_query[k] = v + + parsed = parsed._replace(query=urlencode(clean_query, True)) + return urlunparse(parsed) diff --git a/webservice_base/views/webservice_backend.xml b/webservice_base/views/webservice_backend.xml new file mode 100644 index 00000000..3cd7dfba --- /dev/null +++ b/webservice_base/views/webservice_backend.xml @@ -0,0 +1,102 @@ + + + webservice.backend.form (in webservice) + webservice.backend + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + webservice.backend.search (in webservice) + webservice.backend + + + + + + + + + + + + webservice.backend.tree (in webservice) + webservice.backend + + + + + + + + + + + + + WebService Backend + webservice.backend + list,form + [] + {} + + + + WebService Backend + + + + +