wbmailing 1.43.1__py2.py3-none-any.whl

wbmailing/tests/tests.py

@@ -0,0 +1,142 @@
+from unittest.mock import patch
+
+import pytest
+from django.contrib.admin import AdminSite
+from django.core import mail
+from django.forms.models import model_to_dict
+from django.template import Context, Template
+from rest_framework import status
+from rest_framework.serializers import ValidationError
+from rest_framework.test import APIRequestFactory
+from wbcore.contrib.directory.factories import EmailContactFactory
+from wbcore.test import GenerateTest, default_config
+from wbcore.test.utils import get_kwargs, get_model_factory
+from wbmailing.admin import MailAdmin, MassMailAdmin
+from wbmailing.factories import ToEmailMailFactory
+from wbmailing.models import Mail, MailingListSubscriberChangeRequest, MassMail
+from wbmailing.models.mails import send_mail_as_task
+from wbmailing.serializers import MailingListSubscriberChangeRequestModelSerializer
+from wbmailing.templatetags.mailing_tags import strip, stripAndsplit
+from wbmailing.viewsets import MailingListSubscriberChangeRequestModelViewSet
+
+config = {}
+for key, value in default_config.items():
+    config[key] = list(
+        filter(
+            lambda x: x.__module__.startswith("wbmailing")
+            and x.__name__
+            not in [
+                "ClientsBarChartViewSet",
+                "CountryBarChartViewSet",
+                "RegionBarChartViewSet",
+                "MailStatusBarChartViewSet",
+                "MailClickBarChartViewSet",
+                "AbstractRawDataChartViewSet",
+            ],
+            value,
+        )
+    )
+
+
+@pytest.mark.django_db
+@GenerateTest(config)
+class TestProject:
+    pass
+
+
+@pytest.mark.django_db
+class TestSpecificAdmin:
+    def test_send_test_mail(self, mass_mail_factory, user):
+        request = APIRequestFactory().get("")
+        request.user = user
+        EmailContactFactory(address=request.user.email)
+        mass_mail_factory()
+        qs = MassMail.objects.all()
+        mma = MassMailAdmin(MassMail, AdminSite())
+        nb_mail_send = len(mail.outbox)
+        mma.send_test_mail(request, qs)
+        assert len(mail.outbox) == nb_mail_send + 1
+
+    @patch("wbmailing.models.mails.send_mail_as_task.delay")
+    def test_MailAdmin(self, send_mail_as_task, user):
+        request = APIRequestFactory().get("")
+        request.user = user
+        ToEmailMailFactory()
+        qs = Mail.objects.all()
+
+        ma = MailAdmin(Mail, AdminSite())
+        ma.send_mails(request, qs)
+        send_mail_as_task.assert_called()
+        assert send_mail_as_task.call_count == 1
+
+    def test_send_mail_as_task(self):
+        obj = ToEmailMailFactory.create()
+        context = {}
+        if obj.to_email.count() == 1:
+            context = {"salutation": obj.to_email.first().entry.salutation}
+        rendered_subject = Template(obj.subject).render(Context(context))
+        msg = {
+            "subject": rendered_subject,
+            "body": obj.body,
+            "from_email": obj.from_email,
+            "to": list(obj.to_email.values_list("address", flat=True)),
+            "bcc": list(obj.bcc_email.values_list("address", flat=True)),
+            "cc": list(obj.cc_email.values_list("address", flat=True)),
+            "mail_id": obj.id,
+        }
+        if obj.mass_mail:
+            msg["mass_mail_id"] = obj.mass_mail.id
+        assert len(mail.outbox) == 0
+        send_mail_as_task(**msg)
+        assert len(mail.outbox) == 1
+
+    def test_stripAndsplit(self):
+        string = "diego loic is the best man"
+        result = stripAndsplit(string, " ")
+        assert len(result) == 6
+
+    def test_strip(self):
+        string = "diego/loic/is/the/best/man"
+        string = strip(string)
+        result = stripAndsplit(string, " ")
+        assert len(result) == 1
+
+    def test_validate_email_contact(self, mailing_list, mailing_list_subscriber_change_request_factory, user):
+        request = APIRequestFactory().post("")
+        request.user = user
+        request.parser_context = {}
+        request.data = {"crm_profile": request.user.profile.id}
+        serializer = MailingListSubscriberChangeRequestModelSerializer(
+            mailing_list_subscriber_change_request_factory(mailing_list=mailing_list), context={"request": request}
+        )
+        data = model_to_dict(mailing_list_subscriber_change_request_factory.build(mailing_list=mailing_list))
+        del data["email_contact"]
+        assert serializer.validate(data)  # this is fine because the instance is still in the serializer
+
+        serializer = MailingListSubscriberChangeRequestModelSerializer(context={"request": request})
+        with pytest.raises((ValidationError)):
+            serializer.validate(data)
+
+    @pytest.mark.parametrize("mvs", [MailingListSubscriberChangeRequestModelViewSet])
+    def test_approveall(self, mvs, user):
+        request = APIRequestFactory().get("")
+        request.user = user
+        factory = get_model_factory(mvs().get_serializer_class().Meta.model)
+        for i in range(2):
+            obj = factory()
+        kwargs = get_kwargs(obj, mvs, request)
+        assert (
+            MailingListSubscriberChangeRequest.objects.filter(
+                status=MailingListSubscriberChangeRequest.Status.PENDING
+            ).count()
+            == 2
+        )
+        response = mvs(kwargs=kwargs).approveall(request=request)
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data
+        assert (
+            MailingListSubscriberChangeRequest.objects.filter(
+                status=MailingListSubscriberChangeRequest.Status.APPROVED
+            ).count()
+            == 2
+        )

wbmailing/urls.py

@@ -0,0 +1,90 @@
+from django.urls import include, path
+from wbcore.routers import WBCoreRouter
+from wbmailing import viewsets
+
+router = WBCoreRouter()
+router.register(r"mailinglist", viewsets.MailingListModelViewSet)
+router.register(r"mailrepresentation", viewsets.MailRepresentationViewSet, basename="mailrepresentation")
+router.register(
+    r"mailinglistrepresentation", viewsets.MailingListRepresentationViewSet, basename="mailinglistrepresentation"
+)
+router.register(
+    r"mailtemplaterepresentation", viewsets.MailTemplateRepresentationViewSet, basename="mailtemplaterepresentation"
+)
+router.register(r"massmailrepresentation", viewsets.MassMailRepresentationViewSet, basename="massmailrepresentation")
+
+
+router.register(r"massmail", viewsets.MassMailModelViewSet)
+router.register(r"mailevent", viewsets.MailEventModelViewSet)
+router.register(r"mail", viewsets.MailModelViewSet)
+router.register(r"mailtemplate", viewsets.MailTemplateModelViewSet)
+router.register(
+    r"mailinglistsubscriberchangerequest",
+    viewsets.MailingListSubscriberChangeRequestModelViewSet,
+    basename="mailinglistsubscriberchangerequest",
+)
+router.register(
+    "mailinglistemailcontact",
+    viewsets.MailingListEmailContactThroughModelModelViewSet,
+    basename="mailinglistemailcontact",
+)
+
+entry_router = WBCoreRouter()
+entry_router.register(r"mailinglist", viewsets.MailingListEntryModelViewSet, basename="entry-mailinglist")
+
+
+entry_router.register(
+    r"mailinglistsubscriberchangerequest",
+    viewsets.MailingListSubscriberRequestEntryModelViewSet,
+    basename="entry-mailinglistsubscriberchangerequest",
+)
+
+mailinglist_router = WBCoreRouter()
+mailinglist_router.register(
+    r"mailinglistsubscriberchangerequest",
+    viewsets.MailingListSubscriberRequestMailingListModelViewSet,
+    basename="mailing_list-mailinglistsubscriberchangerequest",
+)
+mailinglist_router.register(
+    r"email_contacts",
+    viewsets.EmailContactMailingListModelViewSet,
+    basename="mailing_list-email_contacts",
+)
+mailinglist_router.register(
+    r"maileventchart", viewsets.MailMailingListChartViewSet, basename="mailing_list-maileventchart"
+)
+
+
+mail_router = WBCoreRouter()
+mail_router.register(r"mailevent", viewsets.MailEventMailModelViewSet, basename="mail-mailevent")
+
+massmail_router = WBCoreRouter()
+massmail_router.register(r"mailstatus", viewsets.MailStatusMassMailModelViewSet, basename="massmail-mailstatus")
+massmail_router.register(
+    r"mailstatusbarchart", viewsets.MailStatusBarChartViewSet, basename="massmail-mailstatusbarchart"
+)
+massmail_router.register(
+    r"mailclickbarchart", viewsets.MailClickBarChartViewSet, basename="massmail-mailclickbarchart"
+)
+massmail_router.register(r"clientsbarchart", viewsets.ClientsBarChartViewSet, basename="massmail-clientsbarchart")
+massmail_router.register(r"countrybarchart", viewsets.CountryBarChartViewSet, basename="massmail-countrybarchart")
+massmail_router.register(r"regionbarchart", viewsets.RegionBarChartViewSet, basename="massmail-regionbarchart")
+massmail_router.register("mailevent", viewsets.MailEventMassMailMailModelViewSet, basename="massmail-mailevent")
+
+urlpatterns = [
+    path("", include(router.urls)),
+    path("entry/<int:entry_id>/", include(entry_router.urls)),
+    path("mailing_list/<int:mailing_list_id>/", include(mailinglist_router.urls)),
+    path("mail/<int:mail_id>/", include(mail_router.urls)),
+    path("massmail/<int:mass_mail_id>/", include(massmail_router.urls)),
+    path(
+        "manage_mailing_list_subscriptions/<int:email_contact_id>/",
+        viewsets.ManageMailingListSubscriptions.as_view(),
+        name="manage_mailing_list_subscriptions",
+    ),
+    path(
+        "unsubscribe/<int:email_contact_id>/<int:mailing_list_id>/",
+        viewsets.UnsubscribeView.as_view(),
+        name="unsubscribe",
+    ),
+]

wbmailing/viewsets/__init__.py

@@ -0,0 +1,32 @@
+from .analytics import (
+    ClientsBarChartViewSet,
+    CountryBarChartViewSet,
+    MailClickBarChartViewSet,
+    MailStatusBarChartViewSet,
+    RegionBarChartViewSet,
+)
+from .mailing_lists import (
+    EmailContactMailingListModelViewSet,
+    MailingListEmailContactThroughModelModelViewSet,
+    MailingListEntryModelViewSet,
+    MailingListModelViewSet,
+    MailingListRepresentationViewSet,
+    MailingListSubscriberChangeRequestModelViewSet,
+    MailingListSubscriberRequestEntryModelViewSet,
+    MailingListSubscriberRequestMailingListModelViewSet,
+    ManageMailingListSubscriptions,
+    UnsubscribeView,
+)
+from .mails import (
+    MailEventModelViewSet,
+    MailEventMailModelViewSet,
+    MailEventMassMailMailModelViewSet,
+    MailMailingListChartViewSet,
+    MailModelViewSet,
+    MailRepresentationViewSet,
+    MailStatusMassMailModelViewSet,
+    MailTemplateModelViewSet,
+    MailTemplateRepresentationViewSet,
+    MassMailModelViewSet,
+    MassMailRepresentationViewSet,
+)

wbmailing/viewsets/analytics.py

@@ -0,0 +1,110 @@
+from typing import TYPE_CHECKING
+
+import pandas as pd
+import plotly.express as px
+import plotly.graph_objects as go
+from django.db.models import QuerySet
+from wbcore import viewsets
+from wbmailing.models import Mail, MailEvent
+
+if TYPE_CHECKING:
+    from plotly.graph_objs._figure import Figure
+
+
+class MailStatusBarChartViewSet(viewsets.ChartViewSet):
+    IDENTIFIER = "wbmailing:mailstatus-barchart"
+    queryset = MailEvent.objects.all()
+
+    def get_queryset(self) -> QuerySet[Mail]:
+        mass_mail_id = self.kwargs["mass_mail_id"]
+
+        return super().get_queryset().filter(mail__mass_mail_id=mass_mail_id)
+
+    def get_plotly(self, queryset: QuerySet[Mail]) -> "Figure":
+        df = pd.DataFrame(queryset.values("event_type"))
+        df["count"] = 1
+
+        df = df.groupby(["event_type"])["count"].count().reset_index().sort_values(by="count")
+        fig = px.bar(df, x="count", y="event_type", orientation="h")
+        fig.update_layout(
+            yaxis={"showticklabels": True, "title": None},
+            xaxis={"title": "Number"},
+            title={"text": "Mail Status", "x": 0.5},
+        )
+        return fig
+
+
+class MailClickBarChartViewSet(viewsets.ChartViewSet):
+    IDENTIFIER = "wbmailing:mailclick-barchart"
+    queryset = MailEvent.objects.all()
+
+    def get_queryset(self) -> QuerySet[MailEvent]:
+        mass_mail_id = self.kwargs["mass_mail_id"]
+
+        return super().get_queryset().filter(mail__mass_mail_id=mass_mail_id, event_type=MailEvent.EventType.CLICKED)
+
+    def get_plotly(self, queryset: QuerySet[MailEvent]) -> "Figure":
+        df = pd.DataFrame(queryset.values("click_url"))
+        df["count"] = 1
+        df = df.groupby(["click_url"])["count"].count().reset_index().sort_values(by="count")
+        fig = go.Figure(layout=dict(template="plotly"))  # noqa THis is necessary to prevent some racing condition
+        fig = px.bar(df, x="count", y="click_url", text="click_url", orientation="h")
+        fig.update_layout(
+            yaxis={"visible": False, "showticklabels": False},
+            xaxis={"title": "Number of clicks"},
+            title={"text": "Clicked URLs", "x": 0.5},
+        )
+        return fig
+
+
+class AbstractRawDataChartViewSet(viewsets.ChartViewSet):
+    queryset = MailEvent.objects.all()
+    ANALYTICS_PROPERTY: str
+
+    def get_queryset(self) -> QuerySet[MailEvent]:
+        mass_mail_id = self.kwargs["mass_mail_id"]
+
+        return super().get_queryset().filter(mail__mass_mail_id=mass_mail_id, event_type=MailEvent.EventType.OPENED)
+
+    def get_plotly(self, queryset: QuerySet[MailEvent]) -> "Figure":
+        df = pd.DataFrame(queryset.values(self.ANALYTICS_PROPERTY))
+        df["count"] = 1
+        df = df.groupby(self.ANALYTICS_PROPERTY)["count"].count().reset_index().sort_values(by="count")
+        fig = go.Figure()
+        if not df.empty:
+            fig = px.bar(df, x=self.ANALYTICS_PROPERTY, y="count")
+            fig.update_layout(
+                xaxis={"showticklabels": True, "title": None},
+                yaxis={"showticklabels": True, "title": "Number"},
+            )
+        return fig
+
+
+class ClientsBarChartViewSet(AbstractRawDataChartViewSet):
+    IDENTIFIER = "wbmailing:client-barchart"
+    ANALYTICS_PROPERTY = "raw_data__Client__Name"
+
+    def get_plotly(self, queryset: QuerySet[MailEvent]) -> "Figure":
+        fig = super().get_plotly(queryset)
+        fig.update_layout(title={"text": "Platforms", "x": 0.5})
+        return fig
+
+
+class CountryBarChartViewSet(AbstractRawDataChartViewSet):
+    IDENTIFIER = "wbmailing:country-barchart"
+    ANALYTICS_PROPERTY = "raw_data__Geo__Country"
+
+    def get_plotly(self, queryset: QuerySet[MailEvent]) -> "Figure":
+        fig = super().get_plotly(queryset)
+        fig.update_layout(title={"text": "Countries", "x": 0.5})
+        return fig
+
+
+class RegionBarChartViewSet(AbstractRawDataChartViewSet):
+    IDENTIFIER = "wbmailing:region-barchart"
+    ANALYTICS_PROPERTY = "raw_data__Geo__Region"
+
+    def get_plotly(self, queryset: QuerySet[MailEvent]) -> "Figure":
+        fig = super().get_plotly(queryset)
+        fig.update_layout(title={"text": "Regions", "x": 0.5})
+        return fig

wbmailing/viewsets/buttons/__init__.py

@@ -0,0 +1,10 @@
+from .mailing_lists import (
+    MailingListButtonConfig,
+    MailingListEmailContactThroughModelButtonConfig,
+    MailingListSubcriptionRequestButtonConfig,
+)
+from .mails import (
+    MailButtonConfig,
+    MailStatusMassMailButtonConfig,
+    MassMailButtonConfig,
+)

wbmailing/viewsets/buttons/mailing_lists.py

@@ -0,0 +1,91 @@
+from django.dispatch import receiver
+from django.utils.translation import gettext as _
+from rest_framework.reverse import reverse
+from wbcore.contrib.directory.viewsets import (
+    CompanyModelViewSet,
+    EntryModelViewSet,
+    PersonModelViewSet,
+)
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+from wbcore.signals.instance_buttons import add_instance_button
+
+
+class MailingListSubcriptionRequestButtonConfig(ButtonViewConfig):
+    def get_custom_buttons(self):
+        if not hasattr(self.view.kwargs, "pk"):
+            user = self.request.user
+            if user.is_superuser or user.has_perm("wbmailing.administrate_mailinglistsubscriberchangerequest"):
+                return {
+                    bt.ActionButton(
+                        method=RequestType.GET,
+                        identifiers=("wbmailing:mailinglistsubscriberchangerequest",),
+                        endpoint=reverse(
+                            "wbmailing:mailinglistsubscriberchangerequest-approveall", args=[], request=self.request
+                        ),
+                        label=_("Approve All"),
+                        description_fields=_(
+                            """
+                        <p>Do you really want to approve all pending subscriptions requests?</p>
+                        """
+                        ),
+                        action_label=_("Approving all pending subscription requests"),
+                        title=_("Approve all pending subscription requests"),
+                    )
+                }
+        return {}
+
+
+class MailingListButtonConfig(ButtonViewConfig):
+    def get_custom_instance_buttons(self):
+        return {
+            bt.WidgetButton(key="mailevent_chart", label=_("Mail Penetration"), icon=WBIcon.FEEDBACK.icon),
+        }
+
+    def get_custom_list_instance_buttons(self):
+        return self.get_custom_instance_buttons()
+
+
+class MailingListEmailContactThroughModelButtonConfig(ButtonViewConfig):
+    def get_custom_list_instance_buttons(self):
+        return {
+            bt.WidgetButton(key="requests", label="Changes Request History", icon=WBIcon.DATA_LIST.icon),
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("directory:email_contacts",),
+                key="delete_from_mailinglist",
+                label=_("Delete"),
+                icon=WBIcon.DELETE.icon,
+                description_fields=_(
+                    "<p> Are you sure you want to delete {{_entry.computed_str}} from this mailinglist? Check with your compliance team if you are not sure</p>"
+                ),
+                title=_("Delete"),
+                action_label=_("Deletion"),
+            ),
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("directory:email_contacts",),
+                key="unsubscribe",
+                label=_("Unsubscribe"),
+                icon=WBIcon.UNDO.icon,
+                description_fields=_(
+                    "<p> Are you sure you want to unsubscribe {{_entry.computed_str}} from this mailinglist? Until the entry exists, the user won't be able to resubscribe</p>"
+                ),
+                title=_("Unsubscribe"),
+                action_label=_("Unsubscribing"),
+            ),
+        }
+
+
+@receiver(add_instance_button, sender=PersonModelViewSet)
+@receiver(add_instance_button, sender=EntryModelViewSet)
+@receiver(add_instance_button, sender=CompanyModelViewSet)
+def crm_adding_instance_buttons_ep(sender, many, *args, **kwargs):
+    if not many:
+        return bt.DropDownButton(
+            label=_("Mailing"),
+            icon=WBIcon.UNFOLD.icon,
+            buttons=(bt.WidgetButton(key="mailinglist", label=_("Mailing"), icon=WBIcon.MAIL.icon),),
+        )

wbmailing/viewsets/buttons/mails.py

@@ -0,0 +1,98 @@
+from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy
+from rest_framework.reverse import reverse
+from wbcore import serializers as wb_serializers
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    create_simple_display,
+)
+from wbmailing.models import MassMail
+
+
+class MassMailButtonConfig(ButtonViewConfig):
+    def get_custom_instance_buttons(self):
+        class SendTestMailActionButtonSerializer(wb_serializers.Serializer):
+            to_test_email = wb_serializers.CharField(label=gettext_lazy("Send To"), default=self.request.user.email)
+
+            class Meta:
+                fields = ["to_test_email"]
+
+        return {
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("wbmailing:entry-mailinglist",),
+                action_label=_("Sending test mail"),
+                key="send_test_mail",
+                description_fields=_("<p>Are you sure you want to send a test mail?</p>"),
+                serializer=SendTestMailActionButtonSerializer,
+                icon=WBIcon.CHART_SWITCHES.icon,
+                title=_("Test Mail"),
+                label=_("Test Mail"),
+                instance_display=create_simple_display([["to_test_email"]]),
+            ),
+            bt.WidgetButton(key="mails", label=_("Mails' Status"), icon=WBIcon.MAIL_OPEN.icon),
+        }
+
+
+class MailButtonConfig(ButtonViewConfig):
+    def get_custom_instance_buttons(self):
+        title = gettext_lazy("Resend Mail")
+        action_label = gettext_lazy("Resending mail")
+        description = gettext_lazy("<p>Are you sure you want to resend the mail?</p>")
+        icon = WBIcon.REPLACE.icon
+        try:
+            mail = self.view.get_object()
+            if not mail.events.exists():
+                title = gettext_lazy("Send Mail")
+                action_label = gettext_lazy("Sending mail")
+                description = gettext_lazy("<p>Are you sure you want to send the mail?</p>")
+                icon = WBIcon.SEND.icon
+        except AssertionError:
+            pass
+        return {
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("wbmailing:mail",),
+                action_label=action_label,
+                key="resend_mail",
+                description_fields=description,
+                icon=icon,
+                title=title,
+                label=title,
+            )
+        }
+
+    def get_custom_list_instance_buttons(self):
+        return self.get_custom_instance_buttons()
+
+
+class MailStatusMassMailButtonConfig(ButtonViewConfig):
+    def get_custom_buttons(self):
+        if not self.view.kwargs.get("pk", None) and (mass_mail_id := self.view.kwargs.get("mass_mail_id", None)):
+            mass_mail = MassMail.objects.get(id=mass_mail_id)
+            if mass_mail.status == MassMail.Status.SENT:
+                return {
+                    bt.ActionButton(
+                        method=RequestType.PATCH,
+                        identifiers=("wbmailing:massmail",),
+                        endpoint=reverse(
+                            "wbmailing:massmail-mailstatus-resendbouncedmails",
+                            args=[mass_mail_id],
+                            request=self.request,
+                        ),
+                        label=_("Resend Bounced Emails"),
+                        description_fields=_(
+                            """
+                        <p>Do not abuse this function! Doing so will likely degrade your mailing reputation.</p>
+                        <p>If you are sure, please confirm</>
+                        <p>
+                        """
+                        ),
+                        action_label=_("Resending bounced emails"),
+                        title=_("Resend Bounced Emails"),
+                    )
+                }
+        return set()

wbmailing/viewsets/display/__init__.py

@@ -0,0 +1,16 @@
+from .mailing_lists import (
+    EmailContactMailingListDisplayConfig,
+    MailingListDisplayConfig,
+    MailingListEntryCompanyDisplayConfig,
+    MailingListEntryDisplayConfig,
+    MailingListSubscriberChangeRequestDisplayConfig,
+    MailingListSubscriberRequestEntryDisplayConfig,
+    MailingListSubscriberRequestMailingListDisplayConfig,
+)
+from .mails import (
+    MailDisplayConfig,
+    MailEventDisplayConfig,
+    MailStatusMassMailDisplayConfig,
+    MailTemplateDisplayConfig,
+    MassMailDisplayConfig,
+)