Add mattermost webhook dispatcher

Refactor common variables abit

app/classes/web/webhook_handler.py

@@ -1,4 +1,3 @@
-import json
 import logging
 from datetime import datetime
 import requests
@@ -8,7 +7,16 @@ from app.classes.shared.helpers import Helpers
 logger = logging.getLogger(__name__)
 helper = Helpers()
 
+
 class WebhookHandler:
+    WEBHOOK_USERNAME = "Crafty Webhooks"
+    WEBHOOK_PFP_URL = (
+        "https://gitlab.com/crafty-controller/crafty-4/-"
+        + "/raw/master/app/frontend/static/assets/images/"
+        + "Crafty_4-0.png"
+    )
+    CRAFTY_VERSION = helper.get_version_string()
+
     @staticmethod
     def get_providers():
         return [
@@ -51,39 +59,34 @@ class WebhookHandler:
         Exception: If there's an error in dispatching the webhook.
 
         Note:
-        Webhook request times out after 10 seconds to prevent indefinite hanging.
+        - Docs: https://discord.com/developers/docs/resources/webhook#execute-webhook
+        - Webhook request times out after 10 seconds to prevent indefinite hanging.
         """
-        # Grab Crafty System version
-        version = helper.get_version_string()
 
         # Get the current UTC datetime
         current_datetime = datetime.utcnow()
 
         # Format the datetime to discord's required UTC string format
         # "YYYY-MM-DDTHH:MM:SS.MSSZ"
-        formatted_datetime = (current_datetime.strftime('%Y-%m-%dT%H:%M:%S.%f')[:-3]
-                            + 'Z')
+        formatted_datetime = (
+            current_datetime.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+        )
 
         # Prepare webhook payload
-        headers={"Content-type": "application/json"}
+        headers = {"Content-type": "application/json"}
         payload = {
-            "username": "Crafty Webhooks",
-            "avatar_url": ("https://gitlab.com/crafty-controller/crafty-4/-"
-                        + "/raw/master/app/frontend/static/assets/images/"
-                        + "Crafty_4-0.png"),
-
+            "username": WebhookHandler.WEBHOOK_USERNAME,
+            "avatar_url": WebhookHandler.WEBHOOK_PFP_URL,
             "embeds": [
                 {
-                "title": title,
-                "description": message,
-                "color": color,
-                "author": {
-                    "name": server_name
-                },
-                "footer": {
-                    "text": f"Crafty Controller v.{version}"
-                },
-                "timestamp": formatted_datetime
+                    "title": title,
+                    "description": message,
+                    "color": color,
+                    "author": {"name": server_name},
+                    "footer": {
+                        "text": f"Crafty Controller v.{WebhookHandler.CRAFTY_VERSION}"
+                    },
+                    "timestamp": formatted_datetime,
                 }
             ],
         }
@@ -95,4 +98,54 @@ class WebhookHandler:
             return "Dispatch successful"
         except requests.RequestException as error:
             logger.error(error)
-            raise RuntimeError(f"Failed to send notification: {error}") from error
+            raise RuntimeError(f"Failed to dispatch notification: {error}") from error
+
+    @staticmethod
+    def send_mattermost_webhook(server_name, title, url, message):
+        """
+        Sends a message to a Mattermost channel via an incoming webhook.
+
+        Parameters:
+        - server_name (str): Name of the server, used as 'author' in the Discord embed.
+        - title (str): Title of the message in the Discord embed.
+        - url (str): URL of the Discord webhook.
+        - message (str): Main content of the message in the Discord embed.
+
+        Returns:
+        str: "Dispatch successful!" if the message is sent successfully, otherwise an
+        exception is raised.
+
+        Raises:
+        Exception: If there's an error in dispatching the webhook.
+
+        Note:
+        - Docs: https://developers.mattermost.com/integrate/webhooks/incoming
+        - Webhook request times out after 10 seconds to prevent indefinite hanging.
+        """
+        # Format the text for Mattermost
+        formatted_text = f"#### {title} \n *Server: {server_name}* \n\n {message}"
+
+        # Prepare webhook payload
+        headers = {"Content-Type": "application/json"}
+        payload = {
+            "text": formatted_text,
+            "username": WebhookHandler.WEBHOOK_USERNAME,
+            "icon_url": WebhookHandler.WEBHOOK_PFP_URL,
+            "props": {
+                "card": (
+                    f"[Crafty Controller "
+                    f"v.{WebhookHandler.CRAFTY_VERSION}](https://craftycontrol.com)"
+                )
+            },
+        }
+
+        # Dispatch webhook
+        try:
+            response = requests.post(url, json=payload, headers=headers, timeout=10)
+            response.raise_for_status()
+            return "Dispatch successful"
+        except requests.RequestException as error:
+            logger.error(error)
+            raise RuntimeError(
+                f"Failed to dispatch notification to Mattermost: {error}"
+            ) from error