fix(refactor): spliting and generic notifications

Author: Safenein

src/moodle_painkillers/__init__.py

@@ -7,12 +7,15 @@
 import bs4
 import requests as rq
 
-from .desktop_notifications import send_notification
+from .notifications import send_notification
 from .moodle_authenticate import MoodleAuthenticatedSession
 
 log = logging.getLogger(__name__)
 
 
+NOTIFICATION_TITLE = "Moodle Presence Registration"
+
+
 try:
     from rich.logging import RichHandler
     from rich.traceback import install as install_rich_traceback
@@ -166,7 +169,7 @@ def wrapper(*args, **kwargs):
             return func(*args, **kwargs)
         except Exception as e:
             log.error(f"An error occurred: {str(e)}")
-            _ = send_notification(str(e))
+            send_notification(str(e), title=NOTIFICATION_TITLE)
             raise e
 
     return wrapper

src/moodle_painkillers/desktop_notifications.py

@@ -0,0 +1,69 @@
+import platform
+from logging import getLogger
+
+from .discord import send_notification as send_discord_notification
+
+log = getLogger(__name__)
+
+
+match (platform.system()):
+    case "Windows":
+        from .windows import send_notification as _send_notification
+
+        send_sys_notification = _send_notification
+    case "Darwin":  # macOS
+        from .macos import send_notification as _send_notification
+
+        send_sys_notification = _send_notification
+    case "Linux":
+        from .linux import send_notification as _send_notification
+
+        send_sys_notification = _send_notification
+    case _ as system:
+        log.warning(f"Desktop notifications not supported on {system}")
+
+        def send_sys_notification(message: str, title: str) -> None:
+            _ = message, title
+            raise ImportError(
+                f"Desktop notifications not supported on {system}"
+            )
+
+
+def send_notification(
+    message: str, *, title: str, discord_webhook: str | None = None
+) -> None:
+    """
+    Send a desktop notification with the given message across different operating systems.
+
+    Dependencies:
+        - Windows: win10toast package (pip install win10toast)
+        - macOS: AppleScript or pync package (pip install pync)
+        - Linux: notify-send command
+
+    Args:
+        message (str): The message to display in the notification
+
+    Returns:
+        bool: True if notification was sent successfully, False otherwise
+    """
+    assert isinstance(message, str), "Message must be a string"
+    assert (
+        isinstance(discord_webhook, str) or discord_webhook is None
+    ), "Discord webhook must be a string or None"
+    system = platform.system()
+
+    log.info(f"Sending notification: {message}")
+
+    if discord_webhook:
+        send_discord_notification(message, discord_webhook=discord_webhook)
+
+    log.debug(f"Sending notification on {system} platform")
+
+    try:
+        send_sys_notification(message, title)
+    except ImportError as e:
+        log.exception(f"Failed to setup notification: {e}")
+        raise
+    except Exception as e:
+        log.exception(f"Failed to send notification: {e}")
+        raise

src/moodle_painkillers/notifications/__init__.py

@@ -1,14 +1,13 @@
 import json
 import logging
-import os
 
 import requests as rq
 
 # Set up logger for this module
 log = logging.getLogger(__name__)
 
 
-def send_discord_notification(message: str, *, discord_webhook: str) -> None:
+def send_notification(message: str, *, discord_webhook: str) -> None:
     data = {
         "content": f"{message}",
     }
@@ -18,8 +17,6 @@ def send_discord_notification(message: str, *, discord_webhook: str) -> None:
             data=json.dumps(data),
             headers={"Content-Type": "application/json"},
         )
-        log.info(
-            f"Notification Discord envoyée: {res.status_code}, {res.text}"
-        )
+        log.info(f"Notification Discord envoyée: {res.status_code}, {res.text}")
     except Exception as e:
         log.error(f"Erreur d'envoi de notification Discord: {str(e)}")

src/moodle_painkillers/discord.py renamed to src/moodle_painkillers/notifications/discord.py

@@ -0,0 +1,23 @@
+import subprocess
+import shutil
+from logging import getLogger
+
+log = getLogger(__name__)
+
+
+def send_notification(message: str, title: str) -> None:
+    """Send a notification on Linux systems"""
+    assert isinstance(message, str), "Message must be a string"
+    assert isinstance(title, str), "Title must be a string"
+
+    try:
+        log.debug("Attempting to send Linux notification")
+        cmd = ["notify-send", title, message]
+        _ = subprocess.run(cmd, check=True)
+        log.info("Linux notification sent successfully")
+    except subprocess.SubprocessError as e:
+        log.fatal(f"Could not send notification on Linux: {e}")
+        raise
+    except FileNotFoundError as e:
+        log.fatal(f"Could not send notification on Linux: {e}")
+        raise ImportError("notify-send command not found. Please install libnotify package")

src/moodle_painkillers/notifications/linux.py

@@ -0,0 +1,24 @@
+import shutil
+from logging import getLogger
+
+import pync  # pyright: ignore[reportMissingImports]
+
+log = getLogger(__name__)
+
+
+if not shutil.which("terminal-notifier"):
+    raise ImportError("terminal-notifier not found. Install using brew!")
+log.debug("pync module loaded successfully for macOS notifications")
+
+
+def send_notification(message: str, title: str) -> None:
+    """Send a notification on macOS systems"""
+    assert isinstance(message, str), "Message must be a string"
+    assert isinstance(title, str), "Title must be a string"
+
+    if not pync:
+        raise ImportError("pync package is required for macOS notifications")
+
+    log.debug("Attempting to send macOS notification via pync")
+    pync.notify(message, title=title)
+    log.info("macOS notification sent successfully via pync")

src/moodle_painkillers/notifications/macos.py

@@ -0,0 +1,19 @@
+from logging import getLogger
+
+import win10toast  # pyright: ignore[reportMissingImports]
+
+log = getLogger(__name__)
+
+
+def send_notification(message: str, title: str) -> None:
+    """Send a notification on Windows systems"""
+    assert isinstance(message, str), "Message must be a string"
+    assert isinstance(title, str), "Title must be a string"
+
+    if not win10toast:
+        raise ImportError("win10toast package is required for Windows notifications")
+
+    log.debug("Attempting to send Windows notification")
+    toaster = win10toast.ToastNotifier()
+    toaster.show_toast(title, message, duration=5)
+    log.info("Windows notification sent successfully")

src/moodle_painkillers/notifications/windows.py

@@ -244,7 +244,7 @@ def failing_func():
         assert excinfo.value == test_exception
 
         # Verify send_notification was called with the exception message
-        mock_send_notification.assert_called_once_with("test error")
+        mock_send_notification.assert_called_once_with('test error', title='Moodle Presence Registration')
 
     @patch("moodle_painkillers.send_notification")
     def test_with_arguments(self, mock_send_notification):