Adding cli_notifier.py

Author: Lucas-C

README.md

@@ -84,7 +84,7 @@ The `linkbacks.py` module can be used as script to test this plugin behavior:
     export SITEURL=...
     python path/to/pelican/plugins/linkbacks/linkbacks.py $pelican_generated_html_file
 
-Optionally the `colorama` package can be installed to get colored logs in the output.
+To test sending a notification for a given URL to an endpoint, you can use the `cli_notifier.py` script.
 
 
 ## Contributing
@@ -108,7 +108,7 @@ With a valid configuration in `~/.config/pypoetry/`:
 ## Linter & tests
 To execute them:
 
-    pylint pelican/plugins/linkbacks/
+    pylint *.py pelican/plugins/linkbacks/
     pytest
 
 ### Integration tests

cli_notifier.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+# USAGE: ./cli_notifier.py [pingback|webmention] $source_url $link_url
+import logging, os, sys
+from pelican.plugins.linkbacks import LinkbackConfig, PingbackNotifier, WebmentionNotifier
+
+def main(kind, source_url, link_url):
+    logging.basicConfig(format="%(levelname)s [%(name)s] %(message)s",
+                        datefmt="%H:%M:%S", level=logging.DEBUG)
+    config = LinkbackConfig(os.environ)
+    notifier_class = PingbackNotifier if kind == "pingback" else WebmentionNotifier
+    notifier = notifier_class(source_url, link_url, config)
+    notifier.discover_server_uri()
+    if notifier.server_uri:
+        print(f"{notifier.kind} URI detected: {notifier.server_uri} - Now sending notification...")
+        notifier.send()
+
+if __name__ == '__main__':
+    main(*sys.argv[1:])

pelican/plugins/linkbacks/linkbacks.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from abc import ABC, abstractmethod
 from collections import defaultdict
 from contextlib import closing
@@ -228,7 +229,7 @@ class Notifier(ABC):
     * server_uri: URL of the notification endpoint
     """
     @abstractmethod
-    def discover_server_uri(self):
+    def discover_server_uri(self, resp_content=None, resp_headers=None):
         """
         Sets .server_uri if a notification endpoint is found for target_url.
         Must be called before calling send().
@@ -379,37 +380,4 @@ def cli(html_filepath):
         cache.dump_to_json()
 
 if __name__ == '__main__':
-    try:  # Optional logs coloring:
-        from colorama import Back, Fore, Style
-        # Recipe from: https://chezsoi.org/lucas/blog/colored-logs-in-python.html
-        class ColorLogsWrapper:
-            COLOR_MAP = {
-                'debug': Fore.CYAN,
-                'info': Fore.GREEN,
-                'warning': Fore.YELLOW,
-                'error': Fore.RED,
-                'critical': Back.RED,
-            }
-            def __init__(self, logger):
-                self.logger = logger
-            def __getattr__(self, attr_name):
-                if attr_name == 'warn':
-                    attr_name = 'warning'
-                if attr_name not in 'debug info warning error critical':
-                    return getattr(self.logger, attr_name)
-                log_level = getattr(logging, attr_name.upper())
-                # mimicking logging/__init__.py behaviour
-                if not self.logger.isEnabledFor(log_level):
-                    return None
-                def wrapped_attr(msg, *args, **kwargs):
-                    style_prefix = self.COLOR_MAP[attr_name]
-                    msg = style_prefix + msg + Style.RESET_ALL
-                    # We call _.log directly to not increase the callstack
-                    # so that Logger.findCaller extract the corrects filename/lineno
-                    # pylint: disable=protected-access
-                    return self.logger._log(log_level, msg, args, **kwargs)
-                return wrapped_attr
-        LOGGER = ColorLogsWrapper(LOGGER)
-    except ImportError:
-        print("colorama not available - Logs coloring disabled")
     cli(sys.argv[1])