postrider 0.1__tar.gz

postrider-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 HorsemanWSGI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

postrider-0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include src *.py *.txt
+recursive-include docs *.txt

postrider-0.1/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: postrider
+Version: 0.1
+Summary: Mailbox management for batched or delayed email delivery
+Author-email: Souheil Chelfouh <trollfot@gmail.com>
+Maintainer-email: Souheil Chelfouh <trollfot@gmail.com>
+License: MIT
+Project-URL: Source Code, https://github.com/HorsemanWSGI/postrider
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Communications :: Email
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: dynaconf
+Requires-Dist: minicli
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+postrider
+*********
+
+Mailbox-based e-mail delivery/queuing system.
+
+
+Running fake server
+-------------------
+
+  $ sudo python -m smtpd -n -c DebuggingServer localhost:25
+
+
+Starting the worker
+-------------------
+
+  $ postrider sender post.toml
+
+
+Adding a test mail
+------------------
+
+  $ postrider testmail post.toml BOXNAME

postrider-0.1/README.rst

@@ -0,0 +1,22 @@
+postrider
+*********
+
+Mailbox-based e-mail delivery/queuing system.
+
+
+Running fake server
+-------------------
+
+  $ sudo python -m smtpd -n -c DebuggingServer localhost:25
+
+
+Starting the worker
+-------------------
+
+  $ postrider sender post.toml
+
+
+Adding a test mail
+------------------
+
+  $ postrider testmail post.toml BOXNAME

postrider-0.1/docs/CREDITS.txt

@@ -0,0 +1 @@
+Souheil Chelfouh

postrider-0.1/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "postrider"
+version = "0.1"
+license = {text = "MIT"}
+authors = [{name = "Souheil Chelfouh", email = "trollfot@gmail.com"}]
+maintainers = [{name = "Souheil Chelfouh", email = "trollfot@gmail.com"}]
+classifiers = [
+  "Environment :: Web Environment", "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Topic :: Communications :: Email"
+]
+description = "Mailbox management for batched or delayed email delivery"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">=3.9"
+dependencies = ["dynaconf", "minicli"]
+
+[project.urls]
+"Source Code" = "https://github.com/HorsemanWSGI/postrider"
+
+[project.optional-dependencies]
+test = ["pytest"]
+
+[project.scripts]
+postrider = "postrider:clirunner"

postrider-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

postrider-0.1/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

postrider-0.1/src/postrider/__init__.py

@@ -0,0 +1,111 @@
+import logging
+import typing as t
+from io import IOBase
+from mailbox import Mailbox, Maildir
+from pathlib import Path
+from email.utils import make_msgid
+from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
+from email.mime.application import MIMEApplication
+from minicli import cli, run
+from .mailer import SMTPConfiguration, Courrier
+from .queue import ProcessorThread
+
+
+def create_message(
+    origin: str,
+    targets: str,
+    subject: str,
+    text: str,
+    html: str = None,
+    files: list[Path | str | IOBase] = None,
+):
+    msg = MIMEMultipart("alternative")
+    msg["From"] = origin
+    msg["To"] = ",".join(targets)
+    msg["Subject"] = subject
+    msg.set_charset("utf-8")
+
+    part1 = MIMEText(text, "plain")
+    part1.set_charset("utf-8")
+    msg.attach(part1)
+
+    if html is not None:
+        part2 = MIMEText(html, "html")
+        part2.set_charset("utf-8")
+        msg.attach(part2)
+
+    if files:
+        for name, f in files.items():
+            if isinstance(f, str):
+                with open(f, "rb") as fd:
+                    part = MIMEApplication(fd.read(), Name=name)
+            elif isinstance(f, Path):
+                with f.open("rb") as fd:
+                    part = MIMEApplication(fd.read(), Name=name)
+            elif isinstance(f, IOBase):
+                part = MIMEApplication(f.read(), Name=name)
+            part["Content-Disposition"] = f'attachment; filename="{name}"'
+            msg.attach(part)
+
+    return msg
+
+
+def configure_logging(settings, debug: bool = False):
+    import sys
+    import logging
+
+    log_level = logging.DEBUG if debug else settings.logging.level
+    stream_handler = logging.StreamHandler(stream=sys.stdout)
+    stream_handler.setLevel(log_level)
+    logging.basicConfig(
+        level=log_level,
+        format="%(asctime)s %(levelname)s %(module)s %(message)s",
+        handlers=[stream_handler],
+    )
+    logger = logging.getLogger("postrider")
+    return logger
+
+
+@cli
+def sender(config: Path, forever: bool = True, debug: bool = False):
+    from dynaconf import Dynaconf
+
+    settings = Dynaconf(settings_files=[config])
+    logger = configure_logging(settings, debug=debug)
+    logger.info("Start Mail Sender")
+    mailer = Courrier(SMTPConfiguration(**settings.smtp))
+
+    workers = {}
+    for name, conf in settings.box.items():
+        path = Path(conf.path).resolve()
+        assert path not in workers
+        mailbox = Maildir(path)
+        interval = settings.worker[name].get("interval", 5.0)
+        workers[path] = ProcessorThread(mailer, mailbox, interval)
+
+    for name, worker in workers.items():
+        worker.start()
+
+    for name, worker in workers.items():
+        worker.join()
+
+
+@cli
+def testmail(config: Path, boxname: str):
+    from dynaconf import Dynaconf
+
+    settings = Dynaconf(settings_files=[config])
+    mailbox = Maildir(settings.box[boxname].path)
+    msg = create_message(
+        "test@test.org", ["trollfot@gmail.com"], "This is a subject", "This is my email"
+    )
+    mailbox.add(msg)
+
+
+def clirunner():
+    run()
+
+
+if __name__ == "__main__":
+    run()

postrider-0.1/src/postrider/mailer.py

@@ -0,0 +1,43 @@
+import typing as t
+import smtplib
+import logging
+from contextlib import contextmanager
+
+
+class SMTPConfiguration(t.NamedTuple):
+    port: int = 25
+    host: str = "localhost"
+    user: str = None
+    password: str = None
+    debug: bool = False
+
+
+class Courrier:
+
+    def __init__(self, config: SMTPConfiguration):
+        self.config = config
+
+    def connect(self):
+        server = smtplib.SMTP(self.config.host, str(self.config.port))
+        server.set_debuglevel(self.config.debug)
+        code, response = server.ehlo()
+        if code < 200 or code >= 300:
+            raise RuntimeError(
+                'Error sending EHLO to the SMTP server '
+                f'(code={code}, response={response})'
+            )
+        # If we can encrypt this session, do it
+        if server.has_extn("STARTTLS"):
+            server.starttls()
+            server.ehlo()  # re-identify ourselves over TLS connection
+        if self.config.user:
+            server.login(self.config.user, self.config.password)
+        return server
+
+    @contextmanager
+    def sender(self):
+        server = self.connect()
+        try:
+            yield server.send_message
+        finally:
+            server.close()

postrider-0.1/src/postrider/queue.py

@@ -0,0 +1,51 @@
+import time
+import logging
+import threading
+
+
+logger = logging.getLogger(__name__)
+
+
+class ProcessorThread(threading.Thread):
+
+    _running: bool = False
+
+    def __init__(self, mailer, mailbox, interval: float):
+        super().__init__(name=__name__)
+        self.mailer = mailer
+        self.mailbox = mailbox
+        self.interval = interval
+        self.daemon = True
+
+    def stop(self):
+        if self._running:
+            self._running = False
+
+    def salvo(self):
+        self.mailbox.lock()
+        try:
+            with self.mailer.sender() as sender:
+                for key, message in self.mailbox.iteritems():
+                    if not self._running:
+                        logger.warning('Processor was stopped.')
+                        raise StopIteration('Thread has stopped running')
+                    logger.debug(f'Sending {key}.')
+                    sender(message)
+                    logger.debug(f'Discarding {key}.')
+                    self.mailbox.discard(key)
+        finally:
+            self.mailbox.close()
+
+    def run(self, forever: bool = True):
+        self._running = True
+        self.salvo()
+        if forever:
+            time.sleep(self.interval)
+            while self._running:
+                try:
+                    self.salvo()
+                    logger.debug(f'Sleeping for {self.interval}.')
+                    time.sleep(self.interval)
+                except:
+                    self._running = False
+                    raise

postrider-0.1/src/postrider.egg-info/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: postrider
+Version: 0.1
+Summary: Mailbox management for batched or delayed email delivery
+Author-email: Souheil Chelfouh <trollfot@gmail.com>
+Maintainer-email: Souheil Chelfouh <trollfot@gmail.com>
+License: MIT
+Project-URL: Source Code, https://github.com/HorsemanWSGI/postrider
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Communications :: Email
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: dynaconf
+Requires-Dist: minicli
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+postrider
+*********
+
+Mailbox-based e-mail delivery/queuing system.
+
+
+Running fake server
+-------------------
+
+  $ sudo python -m smtpd -n -c DebuggingServer localhost:25
+
+
+Starting the worker
+-------------------
+
+  $ postrider sender post.toml
+
+
+Adding a test mail
+------------------
+
+  $ postrider testmail post.toml BOXNAME

postrider-0.1/src/postrider.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+setup.py
+docs/CREDITS.txt
+src/postrider/__init__.py
+src/postrider/mailer.py
+src/postrider/queue.py
+src/postrider.egg-info/PKG-INFO
+src/postrider.egg-info/SOURCES.txt
+src/postrider.egg-info/dependency_links.txt
+src/postrider.egg-info/entry_points.txt
+src/postrider.egg-info/requires.txt
+src/postrider.egg-info/top_level.txt

postrider-0.1/src/postrider.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

postrider-0.1/src/postrider.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+postrider = postrider:clirunner

postrider-0.1/src/postrider.egg-info/requires.txt

@@ -0,0 +1,5 @@
+dynaconf
+minicli
+
+[test]
+pytest

postrider-0.1/src/postrider.egg-info/top_level.txt

@@ -0,0 +1 @@
+postrider