[18.0][MIG] usability_webhooks

usability_webhooks/README.rst

@@ -0,0 +1,220 @@
+====================
+REST API for Webhook
+====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:118b3dcbe0ecd2d2813ecb16117bddb07226db7b09f60de3924b570ea6e2dfc4
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-ecosoft--odoo%2Fecosoft--addons-lightgray.png?logo=github
+    :target: https://github.com/ecosoft-odoo/ecosoft-addons/tree/18.0/usability_webhooks
+    :alt: ecosoft-odoo/ecosoft-addons
+
+|badge1| |badge2| |badge3|
+
+This module is base webhooks standard and keep all log that interface
+
+Step to see logs:
+
+1. Go to Settings > Technical > API Configuration > API Logs
+2. this table will keep all log that interface '/api/create_data' or '/api/create_update_data'
+3. Users can used this table for test API by click 'Update API'
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Before sending a REST API request to Odoo, an initial call to authenticate the API is necessary.
+You can achieve this by calling the ``/web/session/authenticate`` route.
+
+The authentication format requires a header with ``Content-type`` set to ``application/json``,
+and the body should include:
+
+.. code-block:: python
+
+   {
+      "jsonrpc": "2.0",
+      "method": "call",
+      "params": {
+         "db": "<db_name>",
+         "login": "<username>",
+         "password": "<password>"
+      }
+   }
+
+Following successful authentication, you can proceed with five API routes:
+
+1. ``/api/create_data``: This route allows the creation of new data only.
+   The format for creating data should be in the following structure:
+
+   .. code-block:: python
+
+      {
+         "params": {
+            "model": "<model name>",
+            "vals": {
+               "payload": {
+                  "field1": "value1",
+                  ...
+               },
+               "result_field": ["field1", ...]  # optional
+            }
+         }
+      }
+
+2. ``/api/create_update_data``: This route facilitates updating data.
+   If the data does not exist, it will automatically create it.
+   The format follows that of ``create_data``, but it requires a unique key in the field to update the values.
+
+   .. code-block:: python
+
+      {
+         "params": {
+            "model": "<model name>",
+            "vals": {
+               "search_key": {
+                  "<key_field>": "value",  # can be ID or name search string
+               },
+               "payload": {
+                  "field1": "value1",
+                  ...
+               },
+               "result_field": ["field1", ...]  # optional
+            }
+         }
+      }
+
+3. ``/api/update_data``: This route allows updating existing data,
+   using a unique key in the field to find the desired data and update values in that recordset.
+
+   .. code-block:: python
+
+      {
+         "params": {
+            "model": "<model name>",
+            "vals": {
+               "search_key": {
+                  "<key_field>": "value",  # can be ID or name search string
+               },
+               "payload": {
+                  "field1": "value1",
+                  ...
+               }
+            }
+         }
+      }
+
+4. ``/api/search_data``: This route allows you to search for the value of a desired field in a model
+   by using a search domain to find the desired recordset. You can also limit and order the resulting data.
+
+   .. code-block:: python
+
+      {
+         "params": {
+            "model": "<model name>",
+            "vals": {
+               "payload": {
+                  "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...],
+                  "search_domain": "[('field', 'operator', 'value')]",
+                  "limit": 1,
+                  "order": "field1 , field2 desc, ..."
+               }
+            }
+         }
+      }
+
+5. ``/api/call_function``: This route allows you to call a function on a model object based on the provided input.
+
+   **Parameters**:
+      - **name** (*str*): The name of the model to perform the function on.
+      - **method** (*str*): The name of the function to call.
+      - **parameter** (*dict*): A dictionary containing the arguments to pass to the function (if any).
+
+   .. code-block:: python
+
+      {
+         "params": {
+            "model": "<model name>",
+            "vals": {
+               "search_key": {
+                  "<key_field>": "value",  # can be ID or name search string
+               },
+               "payload": {
+                  "method": "<method>",
+                  "parameter": {"<key>": "<value>", ...}
+               }
+            }
+         }
+      }
+
+**Note**:
+If you want to attach a file to a record, you can add the key "attachment_ids" at any level of the payload.
+
+   **Example Request with Attachment**:
+
+   .. code-block:: python
+
+      {
+         "params": {
+            "model": "<model name>",
+            "vals": {
+               "search_key": {
+                  "<key_field>": "value",  # can be ID or name search string
+               },
+               "payload": {
+                  "attachment_ids": [
+                     {
+                        "name": "<file_name>",
+                        "datas": "<base64_encoded_data>"
+                     }
+                  ],
+                  ...
+               }
+            }
+         }
+      }
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/ecosoft-odoo/ecosoft-addons/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/ecosoft-odoo/ecosoft-addons/issues/new?body=module:%20usability_webhooks%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Ecosoft
+
+Contributors
+~~~~~~~~~~~~
+
+* Kitti Upariphutthiphong <[email protected]>
+* Saran Lim. <[email protected]>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is part of the `ecosoft-odoo/ecosoft-addons <https://github.com/ecosoft-odoo/ecosoft-addons/tree/18.0/usability_webhooks>`_ project on GitHub.
+
+You are welcome to contribute.

usability_webhooks/__init__.py

@@ -0,0 +1,4 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import controllers
+from . import models

usability_webhooks/__manifest__.py

@@ -0,0 +1,18 @@
+# Copyright 2022 Ecosoft Co., Ltd. (http://ecosoft.co.th)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "REST API for Webhook",
+    "version": "18.0.1.0.0",
+    "license": "AGPL-3",
+    "category": "Tools",
+    "author": "Ecosoft, Odoo Community Association (OCA)",
+    "website": "https://github.com/ecosoft-odoo/ecosoft-addons",
+    "depends": ["base", "mail"],
+    "data": [
+        "security/ir.model.access.csv",
+        "data/config_parameter.xml",
+        "data/ir_cron.xml",
+        "views/api_log.xml",
+    ],
+}

usability_webhooks/controllers/__init__.py

@@ -0,0 +1,4 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import main
+from . import utils

usability_webhooks/controllers/main.py

@@ -0,0 +1,88 @@
+# Copyright 2022 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+import ast
+import json
+import traceback
+
+from odoo import http
+from odoo.http import request
+
+
+class WebhookController(http.Controller):
+    def _call_function_api(self, model, vals, function):
+        """
+        This function will call the function from webhook.utils
+        Can be hook to add something before or after the function
+        """
+        return getattr(request.env["webhook.utils"], function)(model, vals)
+
+    def _create_api_logs(self, model, vals, function):
+        # Add logs
+        data_dict = {
+            "data": json.dumps(vals),
+            "model": model,
+            "route": f"/api/{function}",
+            "function_name": function,
+        }
+
+        ICP = request.env["ir.config_parameter"]
+        rollback_state_failed = ICP.sudo().get_param("webhook.rollback_state_failed")
+        rollback_except = ICP.sudo().get_param("webhook.rollback_except")
+        try:
+            res = self._call_function_api(model, vals, function)
+            state = "done" if res["is_success"] else "failed"
+            data_dict.update({"result": res, "state": state})
+            # Not success, rollback all data (if config in system parameter)
+            if not res["is_success"] and rollback_state_failed:
+                request.env.cr.rollback()
+        except Exception:
+            res = {
+                "is_success": False,
+                "messages": traceback.format_exc(),
+            }
+            data_dict.update({"result": res, "state": "failed"})
+            # Error from odoo exception,
+            # rollback all data (if config in system parameter)
+            if rollback_except:
+                request.env.cr.rollback()
+        if vals["is_create_log"]:
+            request.env["api.log"].create(data_dict)
+        return res
+
+    def _set_create_logs(self, param, vals):
+        ICP = request.env["ir.config_parameter"]
+        is_create_log = ICP.sudo().get_param(param)
+        # convert str to bool
+        is_create_log = ast.literal_eval(is_create_log.capitalize())
+        vals.update({"is_create_log": is_create_log})
+
+    @http.route("/api/create_data", type="json", auth="user")
+    def create_data(self, model, vals):
+        self._set_create_logs("webhook.create_data_log", vals)
+        res = self._create_api_logs(model, vals, "create_data")
+        return res
+
+    @http.route("/api/update_data", type="json", auth="user")
+    def update_data(self, model, vals):
+        self._set_create_logs("webhook.update_data_log", vals)
+        res = self._create_api_logs(model, vals, "update_data")
+        return res
+
+    @http.route("/api/create_update_data", type="json", auth="user")
+    def create_update_data(self, model, vals):
+        self._set_create_logs("webhook.create_update_data_log", vals)
+        res = self._create_api_logs(model, vals, "create_update_data")
+        return res
+
+    @http.route("/api/search_data", type="json", auth="user")
+    def search_data(self, model, vals):
+        self._set_create_logs("webhook.search_data_log", vals)
+        res = self._create_api_logs(model, vals, "search_data")
+        return res
+
+    @http.route("/api/call_function", type="json", auth="user")
+    def call_function(self, model, vals):
+        self._set_create_logs("webhook.call_function_log", vals)
+        res = self._create_api_logs(model, vals, "call_function")
+        return res