Add support for specifing safe not encode strings (#12)

Author: marcoacierno

pythonit_toolkit/emails/backends/ses.py

@@ -3,6 +3,7 @@
 import html
 import boto3
 from pythonit_toolkit.emails.templates import EmailTemplate
+from pythonit_toolkit.emails.utils import SafeString
 
 from .base import EmailBackend
 
@@ -35,4 +36,12 @@ def send_email(
         )
 
     def encode_vars(self, variables: dict[str, str]) -> dict[str, str]:
-        return {key: html.escape(value) for key, value in variables.items()}
+        vars = dict()
+
+        for key, value in variables.items():
+            if not isinstance(value, SafeString):
+                value = html.escape(value)
+
+            vars[key] = str(value)
+
+        return vars

pythonit_toolkit/emails/utils.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 import importlib
 
 from .backends.base import EmailBackend
@@ -18,3 +19,18 @@ def get_email_backend(backend_path: str, **options: dict[str, str]) -> EmailBack
         EMAIL_BACKEND_CACHE[backend_path] = instance
 
     return instance
+
+
+@dataclass
+class SafeString(str):
+    original_str: str
+
+    def __str__(self) -> str:
+        return self.original_str
+
+
+def mark_safe(string: str) -> SafeString:
+    if string is None:
+        raise ValueError("string cannot be None")
+
+    return SafeString(string)

tests/emails/backends/test_ses.py

@@ -1,5 +1,5 @@
 from unittest.mock import patch
-
+from pythonit_toolkit.emails.utils import mark_safe
 from pythonit_toolkit.emails.backends.ses import SESEmailBackend
 from pythonit_toolkit.emails.templates import EmailTemplate
 from ward import test
@@ -94,3 +94,27 @@ async def _():
         ReplyToAddresses=[],
         ConfigurationSetName='primary',
     )
+
+
+@test("safe string variables are not encoded")
+async def _():
+    with patch("pythonit_toolkit.emails.backends.ses.boto3") as mock_boto:
+        SESEmailBackend("production").send_email(
+            template=EmailTemplate.RESET_PASSWORD,
+            subject="Subject",
+            from_="test@email.it",
+            to="destination@email.it",
+            variables={
+                "safe": mark_safe('<a href="https://google.it">link</a>'),
+                "not_safe": '<a href="https://google.it">link</a>',
+            },
+        )
+
+    mock_boto.client.return_value.send_templated_email.assert_called_once_with(
+        Source="test@email.it",
+        Destination={"ToAddresses": ["destination@email.it"]},
+        Template="pythonit-production-reset-password",
+        TemplateData='{"subject": "Subject", "safe": "<a href=\\"https://google.it\\">link</a>", "not_safe": "&lt;a href=&quot;https://google.it&quot;&gt;link&lt;/a&gt;"}',
+        ReplyToAddresses=[],
+        ConfigurationSetName='primary',
+    )

tests/emails/test_utils.py

@@ -1,7 +1,7 @@
 from unittest.mock import patch
 
-from pythonit_toolkit.emails.utils import get_email_backend
-from ward import test
+from pythonit_toolkit.emails.utils import SafeString, get_email_backend, mark_safe
+from ward import test, raises
 
 
 class TestBackend:
@@ -26,7 +26,8 @@ async def _():
     assert "tests.emails.test_utils.TestBackend" in str(type(loaded_backend))
 
     with patch("pythonit_toolkit.emails.utils.importlib.import_module") as mock:
-        loaded_backend = get_email_backend("tests.emails.test_utils.TestBackend")
+        loaded_backend = get_email_backend(
+            "tests.emails.test_utils.TestBackend")
 
     assert "tests.emails.test_utils.TestBackend" in str(type(loaded_backend))
     assert not mock.called
@@ -46,3 +47,25 @@ async def _():
     )
     assert loaded_backend.a == 1
     assert loaded_backend.b == 2
+
+
+@test("mark safe")
+async def _():
+    safe_string = mark_safe("abc")
+
+    assert isinstance(safe_string, SafeString)
+    assert str(safe_string) == "abc"
+
+
+@test("mark safe with empty string")
+async def _():
+    safe_string = mark_safe("")
+
+    assert isinstance(safe_string, SafeString)
+    assert str(safe_string) == ""
+
+
+@test("None cannot be converted to safe string")
+async def _():
+    with raises(ValueError):
+        mark_safe(None)