[16.0][ADD] base_external_system_http

Author: ntsirintanis

base_external_system_http/README.rst

@@ -1,20 +1,25 @@
-# Copyright 2023 Therp BV <https://therp.nl>.
+# Copyright 2026 Therp BV <https://therp.nl>.
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 {
     "name": "External System HTTP",
-    "version": "10.0.1.0.0",
+    "version": "16.0.1.0.0",
     "author": "Therp BV, Odoo Community Association (OCA)",
+    "maintainers": ["NL66278", "ntsirintanis"],
     "license": "AGPL-3",
     "category": "Base",
-    "website": "https://github.com/OCA/server-tools",
+    "website": "https://github.com/OCA/server-backend",
     "summary": "HTTP Connector for External Systems",
     "depends": ["base_external_system"],
     "data": [
+        "security/ir.model.access.csv",
         "demo/external_system_demo.xml",
         "demo/external_system_endpoint_demo.xml",
-        "security/ir.model.access.csv",
         "views/external_system.xml",
     ],
+    "demo": [
+        "demo/external_system_demo.xml",
+        "demo/external_system_endpoint_demo.xml",
+    ],
     "installable": True,
     "application": False,
 }

base_external_system_http/__manifest__.py

@@ -1,14 +1,13 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8" ?>
 <!--
-    Copyright 2023 Therp BV.
+    Copyright 2026 Therp BV.
     License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 -->
 <odoo>
 
     <record id="external_system_github" model="external.system">
         <field name="name">Example Connection to GitHub for Testing</field>
         <field name="system_type">external.system.adapter.http</field>
-        <field name="scheme">https</field>
         <field name="host">github.com</field>
         <field name="remote_path">/OCA</field>
         <field name="company_ids" eval="[(5, 0), (4, ref('base.main_company'))]" />

base_external_system_http/demo/external_system_demo.xml

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8" ?>
 <!--
-    Copyright 2023 Therp BV.
+    Copyright 2026 Therp BV.
     License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 -->
 <odoo>

base_external_system_http/demo/external_system_endpoint_demo.xml

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-# Copyright 2023 Therp BV <https://therp.nl>.
+# Copyright 2026 Therp BV <https://therp.nl>.
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 
 from odoo import fields, models
@@ -13,5 +12,6 @@ class ExternalSystem(models.Model):
     endpoint_ids = fields.One2many(
         comodel_name="external.system.endpoint",
         inverse_name="system_id",
+        string="Endpoints",
         help="Endpoints on remote system",
     )

base_external_system_http/models/external_system.py

@@ -1,101 +1,157 @@
-# -*- coding: utf-8 -*-
-# Copyright 2023 Therp BV <https://therp.nl>.
+# Copyright 2026 Therp BV <https://therp.nl>.
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
-"""Extend base adapter model for connections through http(s)."""
-import json
+"""HTTP(S) adapter for :class:`external.system`."""
+
 import logging
 
 import requests
+from requests import exceptions as req_exc
 
-from odoo import _, api, fields, models
-from odoo.exceptions import UserError
-
-# You must initialize logging, otherwise you'll not see debug output.
-logging.basicConfig()
-logging.getLogger().setLevel(logging.DEBUG)
-requests_log = logging.getLogger("requests.packages.urllib3")
-requests_log.setLevel(logging.DEBUG)
-requests_log.propagate = True
-
+from odoo import _, models
+from odoo.exceptions import UserError, ValidationError
 
-_logger = logging.getLogger(__name__)  # pylint: disable=invalid-name
+_logger = logging.getLogger(__name__)
 
 
-class ExternalSystemAdapterHTTP(models.AbstractModel):
-    """HTTP external system Adapter"""
+class ExternalSystemAdapterHTTP(models.Model):
+    """HTTP external system adapter."""
 
-    _inherit = "external.system.adapter"
     _name = "external.system.adapter.http"
-    _description = __doc__
+    _inherit = "external.system.adapter"
+    _description = "External System HTTP"
 
-    @api.model
     def external_get_client(self):
-        """Return self as the client."""
+        self.ensure_one()
         return self
 
-    @api.model
     def external_destroy_client(self, client):
-        """If needed logout of server."""
-        pass
+        self.ensure_one()
+        return super().external_destroy_client(client)
 
-    def get(self, endpoint=None, params=None, **kwargs):
-        """Pass transparantly to request.get, but check response."""
+    def external_test_connection(self):
+        """Test connection in the UI by doing a GET on the base URL."""
+        self.ensure_one()
+        try:
+            self.get(endpoint=None)
+        except ValidationError:
+            raise
+        except Exception as exc:
+            raise ValidationError(_("Connection failed.\n\nDETAIL: %s") % exc) from exc
+        return super().external_test_connection()
+
+    def get(self, endpoint=None, params=None, timeout=16, **kwargs):
+        """GET helper."""
+        self.ensure_one()
+        url = self._get_url(endpoint=endpoint)
+        _logger.debug("Will GET %s", url)
+        try:
+            response = requests.get(url, params=params, timeout=timeout, **kwargs)
+        except req_exc.RequestException as exc:
+            _logger.error("GET %s failed: %s", url, exc)
+            raise ValidationError(
+                _("GET request failed for %(url)s.\n\nDETAIL: %(detail)s")
+                % {"url": url, "detail": exc}
+            ) from exc
+        return self._return_checked_response(endpoint, response)
+
+    def post(self, endpoint=None, data=None, json=None, timeout=16, **kwargs):
+        """POST helper."""
+        self.ensure_one()
         url = self._get_url(endpoint=endpoint)
-        _logger.debug("Will get data from %s", url)
-        response = requests.get(url, params=params, **kwargs)
-        if response.status_code != 200:
-            message = _("Data could not be retrieved from endpoint %s: %s") % (
-                endpoint,
-                str(response.text),
+        _logger.debug("Will POST %s", url)
+        try:
+            response = requests.post(
+                url, data=data, json=json, timeout=timeout, **kwargs
             )
-            _logger.error(message)
-            raise UserError(message)
-        _logger.info(
-            _("Data succesfully retrieved from endpoint %s"),
-            endpoint,
-        )
-        return response
+        except req_exc.RequestException as exc:
+            _logger.error("POST %s failed: %s", url, exc)
+            raise ValidationError(
+                _("POST request failed for %(url)s.\n\nDETAIL: %(detail)s")
+                % {"url": url, "detail": exc}
+            ) from exc
+        return self._return_checked_response(endpoint, response)
 
-    def post(self, endpoint=None, data=None, json=None, **kwargs):
-        """Post data to http server."""
+    def put(self, endpoint=None, data=None, json=None, timeout=16, **kwargs):
+        """PUT helper."""
+        self.ensure_one()
         url = self._get_url(endpoint=endpoint)
-        _logger.debug("Will post data to %s", url)
-        response = requests.post(url, data=data, json=json, **kwargs)
-        if response.status_code not in (200, 201):
-            message = _("Data could not be pushed to endpoint %s: %s") % (
-                endpoint,
-                str(response.text),
+        _logger.debug("Will PUT %s", url)
+        try:
+            response = requests.put(
+                url, data=data, json=json, timeout=timeout, **kwargs
             )
-            _logger.error(message)
-            raise UserError(message)
+        except req_exc.RequestException as exc:
+            _logger.error("PUT %s failed: %s", url, exc)
+            raise ValidationError(
+                _("PUT request failed for %(url)s.\n\nDETAIL: %(detail)s")
+                % {"url": url, "detail": exc}
+            ) from exc
+        return self._return_checked_response(endpoint, response)
 
-    def _get_url(self, endpoint=None, url_suffix=None):
-        """Make full url for endpoint.
+    def delete(self, endpoint=None, params=None, timeout=16, **kwargs):
+        """DELETE helper."""
+        self.ensure_one()
+        url = self._get_url(endpoint=endpoint)
+        _logger.debug("Will DELETE %s", url)
+        try:
+            response = requests.delete(url, params=params, timeout=timeout, **kwargs)
+        except req_exc.RequestException as exc:
+            _logger.error("DELETE %s failed: %s", url, exc)
+            raise ValidationError(
+                _("DELETE request failed for %(url)s.\n\nDETAIL: %(detail)s")
+                % {"url": url, "detail": exc}
+            ) from exc
+        return self._return_checked_response(endpoint, response)
 
-        The configured remote_path, endpoint and the passed url_suffix
-        must, if used, always start with "/".
-        """
+    def _get_url(self, endpoint=None, url_suffix=None):
+        """Build full URL for an endpoint"""
+        self.ensure_one()
         system = self.system_id
+        endpoint_record = None
         if endpoint:
-            endpoint_model = self.env["external.system.endpoint"]
-            endpoint_record = endpoint_model.search(
-                [
-                    ("system_id", "=", system.id),
-                    ("name", "=", endpoint),
-                ],
-                limit=1
+            endpoint_record = self.env["external.system.endpoint"].search(
+                [("system_id", "=", system.id), ("name", "=", endpoint)],
+                limit=1,
             )
             if not endpoint_record:
                 raise UserError(
-                    _("Endpoint %s not found on system %s")
-                    % (endpoint, system.name)
+                    _("Endpoint %(endpoint)s not found on system %(system_name)s")
+                    % {"endpoint": endpoint, "system_name": system.name}
                 )
-        url = "%(scheme)s://%(host)s%(port)s%(remote_path)s%(endpoint)s%(url_suffix)s" % {
-            "scheme": system.scheme or "https",
-            "host": system.host,
-            "port": ":" + str(system.port) if system.port else "",
-            "remote_path": system.remote_path if system.remote_path else "",
-            "endpoint": endpoint_record.endpoint if endpoint else "",
-            "url_suffix": url_suffix if url_suffix else "",
-        }
-        return url
+        host = (system.host or "").strip()
+        if host.startswith(("http://", "https://")):
+            base = host.rstrip("/")
+        else:
+            base = ("https://" + host).rstrip("/")
+        port = ":" + str(system.port) if system.port else ""
+        remote_path = (system.remote_path or "").rstrip("/")
+        endpoint_path = endpoint_record.endpoint if endpoint_record else ""
+        suffix = url_suffix or ""
+        return f"{base}{port}{remote_path}{endpoint_path}{suffix}"
+
+    def _return_checked_response(self, endpoint, response):
+        """Validate response."""
+        if response.status_code >= 400:
+            text = response.text or ""
+            _logger.error(
+                "Got response with statuscode %(status)s from endpoint %(endpoint)s: %(text)s",
+                {
+                    "status": str(response.status_code),
+                    "endpoint": endpoint or "<base>",
+                    "text": text,
+                },
+            )
+            raise ValidationError(
+                _(
+                    "Communication failure with %(endpoint)s "
+                    "(HTTP %(status)s).\n\nDETAIL: %(detail)s"
+                )
+                % {
+                    "endpoint": endpoint or "<base>",
+                    "status": response.status_code,
+                    "detail": (text or "").strip(),
+                }
+            )
+
+        _logger.info("Succesfull communication with endpoint %s", endpoint or "<base>")
+        return response

base_external_system_http/models/external_system_adapter_http.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-# Copyright 2023 Therp BV <https://therp.nl>.
+# Copyright 2026 Therp BV <https://therp.nl>.
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 """Endpoint on remote system to get from or post to."""
 

base_external_system_http/models/external_system_endpoint.py

@@ -0,0 +1,2 @@
+* Ronald Portier (Therp BV)
+* Nikos Tsirintanis <ntsirintanis@therp.nl>

base_external_system_http/readme/CONTRIBUTORS.rst

@@ -0,0 +1,8 @@
+This module provides an HTTP(S) adapter for the ``base_external_system`` framework.
+
+It allows Odoo to communicate with external systems over HTTP using a consistent
+adapter interface, supporting GET, POST and PUT requests, endpoint resolution,
+and connection testing.
+
+The adapter itself acts as the client and is yielded via the standard
+``system.client()`` context manager.

base_external_system_http/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+* Optional authentication helpers
+* Optional persistent session support