wbmailing 2.2.1__py2.py3-none-any.whl

wbmailing/serializers/__init__.py

@@ -0,0 +1,19 @@
+from .mailing_lists import (
+    MailingListEmailContactThroughModelModelSerializer,
+    MailingListEntryRepresentationSerializer,
+    MailingListListSerializer,
+    MailingListModelSerializer,
+    MailingListRepresentationSerializer,
+    MailingListSubscriberChangeRequestModelSerializer,
+)
+from .mails import (
+    MailEventModelSerializer,
+    MailModelSerializer,
+    MailRepresentationSerializer,
+    MailStatusMassMailModelSerializer,
+    MailTemplateModelSerializer,
+    MailTemplateRepresentationSerializer,
+    MassMailListSerializer,
+    MassMailModelSerializer,
+    MassMailRepresentationSerializer,
+)

wbmailing/serializers/mailing_lists.py

@@ -0,0 +1,209 @@
+from django.dispatch import receiver
+from django.utils.translation import gettext
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+from rest_framework.reverse import reverse
+from wbcore import serializers as wb_serializers
+from wbcore.contrib.directory.serializers import (
+    CompanyModelSerializer,
+    EmailContactRepresentationSerializer,
+    EntryModelSerializer,
+    PersonModelSerializer,
+    PersonRepresentationSerializer,
+)
+from wbcore.signals.serializers import add_instance_additional_resource
+from wbmailing import models
+from wbmailing.models import MailingListEmailContactThroughModel
+
+
+class MailingListRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbmailing:mailinglist-detail")
+
+    class Meta:
+        model = models.MailingList
+        fields = ("id", "title", "_detail")
+
+
+class MailingListEntryRepresentationSerializer(MailingListRepresentationSerializer):
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbmailing:mailinglist-detail")
+
+    def get_filter_params(self, request):
+        entry_id = request.parser_context["view"].kwargs.get("entry_id", None)
+        return {"negative_entry": entry_id}
+
+    class Meta:
+        model = models.MailingList
+        fields = ("id", "title", "_detail")
+
+
+class MailingListListSerializer(wb_serializers.ModelSerializer):
+    nb_subscribers = wb_serializers.IntegerField(read_only=True, label=_("Number of Subscribers"), default=0)
+
+    class Meta:
+        model = models.MailingList
+        fields = (
+            "id",
+            "title",
+            "is_public",
+            "nb_subscribers",
+        )
+
+
+class MailingListModelSerializer(wb_serializers.ModelSerializer):
+    nb_subscribers = wb_serializers.IntegerField(read_only=True, label=_("Number of Subscribers"), default=0)
+
+    @wb_serializers.register_resource()
+    def email_contacts(self, instance, request, user):
+        # Do some something (checks, etc.)
+        return {
+            "mailevent_chart": reverse(
+                "wbmailing:mailing_list-maileventchart-list", args=[instance.id], request=request
+            ),
+            "email_contacts": reverse(
+                "wbmailing:mailing_list-email_contacts-list", args=[instance.id], request=request
+            ),
+        }
+
+    class Meta:
+        model = models.MailingList
+        fields = ("id", "title", "is_public", "nb_subscribers", "_additional_resources")
+
+
+class MailingListEmailContactThroughModelModelSerializer(wb_serializers.ModelSerializer):
+    _email_contact = EmailContactRepresentationSerializer(source="email_contact")
+    _mailing_list = MailingListRepresentationSerializer(source="mailing_list")
+
+    in_charge = wb_serializers.CharField(read_only=True, label=_("Relationship Managers"))
+    expiration_date = wb_serializers.DateField(read_only=True, label=_("Expiration Date"))
+    is_public = wb_serializers.BooleanField(read_only=True, label=_("Public Mailing list"))
+    is_pending_request_change = wb_serializers.BooleanField(
+        read_only=True,
+        default=False,
+        label=_("Pending change request exists"),
+        help_text=_("If true, a pending change request exists for this email and mailing list"),
+    )
+
+    @wb_serializers.register_resource()
+    def delete_from_mailinglist(self, instance, request, user):
+        res = {
+            "requests": f'{reverse("wbmailing:mailinglistsubscriberchangerequest-list", args=[], request=request)}?email_contact={instance.email_contact.id}&mailing_list={instance.mailing_list.id}'
+        }
+        if getattr(instance, "expiration_date", None):
+            res["remove_expiration_date"] = reverse(
+                "wbmailing:mailinglistemailcontact-removeexpirationdate",
+                args=[instance.id],
+                request=request,
+            )
+        if instance.status != MailingListEmailContactThroughModel.Status.SUBSCRIBED:
+            res["delete_from_mailinglist"] = reverse(
+                "wbmailing:mailinglistemailcontact-delete",
+                args=[instance.id],
+                request=request,
+            )
+        else:
+            res["unsubscribe"] = reverse(
+                "wbmailing:mailinglistemailcontact-unsubscribe",
+                args=[instance.id],
+                request=request,
+            )
+        return res
+
+    class Meta:
+        model = MailingListEmailContactThroughModel
+        fields = (
+            "id",
+            "status",
+            "email_contact",
+            "mailing_list",
+            "_email_contact",
+            "_mailing_list",
+            "in_charge",
+            "expiration_date",
+            "is_public",
+            "is_pending_request_change",
+            "_additional_resources",
+        )
+
+
+class MailingListSubscriberChangeRequestModelSerializer(wb_serializers.ModelSerializer):
+    _email_contact = EmailContactRepresentationSerializer(many=False, source="email_contact")
+    _mailing_list = MailingListRepresentationSerializer(many=False, source="mailing_list")
+    _requester = PersonRepresentationSerializer(source="requester", many=False)
+    _approver = PersonRepresentationSerializer(source="approver", many=False)
+
+    approver = wb_serializers.PrimaryKeyRelatedField(read_only=True, label=_("Approver"))
+    requester = wb_serializers.PrimaryKeyRelatedField(read_only=True, label=_("Requester"))
+    created = wb_serializers.DateTimeField(read_only=True, label=_("Created"))
+    updated = wb_serializers.DateTimeField(read_only=True, label=_("Updated"))
+    entry_repr = wb_serializers.CharField(read_only=True)
+    type = wb_serializers.ChoiceField(choices=models.MailingListSubscriberChangeRequest.Type.choices, required=False)
+
+    def validate(self, attrs):
+        instance_id = self.instance.id if self.instance else None
+        email_contact = attrs.get("email_contact", self.instance.email_contact if self.instance else None)
+        mailing_list = attrs.get("mailing_list", self.instance.mailing_list if self.instance else None)
+        if email_contact and mailing_list:
+            if (
+                models.MailingListSubscriberChangeRequest.objects.exclude(id=instance_id)
+                .filter(
+                    email_contact=email_contact,
+                    mailing_list=mailing_list,
+                    status=models.MailingListSubscriberChangeRequest.Status.PENDING.name,
+                )
+                .count()
+                > 0
+            ):
+                raise serializers.ValidationError(
+                    {
+                        "non_field_errors": gettext("There is already a pending request to subscribe {} to {}").format(
+                            email_contact.address, mailing_list.title
+                        )
+                    }
+                )
+        if not email_contact:
+            raise serializers.ValidationError(
+                {"email_contact": gettext("Email contact is missing for this request to be valid")}
+            )
+        return super().validate(attrs)
+
+    def create(self, validated_data):
+        if request := self.context.get("request"):
+            validated_data["requester"] = request.user.profile
+        return super().create(validated_data)
+
+    class Meta:
+        model = models.MailingListSubscriberChangeRequest
+        fields = (
+            "id",
+            "status",
+            "email_contact",
+            "_email_contact",
+            "email_contact",
+            "mailing_list",
+            "_mailing_list",
+            "expiration_date",
+            "type",
+            "created",
+            "updated",
+            "requester",
+            "_requester",
+            "approver",
+            "_approver",
+            "reason",
+            "entry_repr",
+            "_additional_resources",
+        )
+
+
+@receiver(add_instance_additional_resource, sender=CompanyModelSerializer)
+@receiver(add_instance_additional_resource, sender=PersonModelSerializer)
+@receiver(add_instance_additional_resource, sender=EntryModelSerializer)
+def crm_adding_additional_resource(sender, serializer, instance, request, user, **kwargs):
+    return {
+        "mailinglist": reverse("wbmailing:entry-mailinglist-list", args=[instance.id], request=request),
+        "mailinglistsubscriptionrequests": reverse(
+            "wbmailing:entry-mailinglistsubscriberchangerequest-list",
+            args=[instance.id],
+            request=request,
+        ),
+    }

wbmailing/serializers/mails.py

@@ -0,0 +1,251 @@
+from datetime import timedelta
+
+from django.utils import timezone
+from django.utils.translation import gettext
+from django.utils.translation import gettext_lazy as _
+from dynamic_preferences.registries import global_preferences_registry
+from rest_framework import serializers
+from rest_framework.reverse import reverse
+from wbcore import serializers as wb_serializers
+from wbcore.contrib.directory.models import EmailContact
+from wbcore.contrib.directory.serializers import (
+    EmailContactRepresentationSerializer,
+    EntryRepresentationSerializer,
+    PersonRepresentationSerializer,
+)
+from wbmailing import models
+
+from .mailing_lists import MailingListRepresentationSerializer
+
+
+class MailRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbmailing:mail-detail")
+
+    class Meta:
+        model = models.Mail
+        fields = ("id", "subject", "_detail")
+
+
+class MassMailRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbmailing:massmail-detail")
+
+    class Meta:
+        model = models.MassMail
+        fields = ("id", "subject", "_detail")
+
+
+class MailTemplateRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbmailing:mailtemplate-detail")
+
+    class Meta:
+        model = models.MailTemplate
+        fields = ("id", "title", "_detail")
+
+
+class MassMailListSerializer(wb_serializers.ModelSerializer):
+    _creator = PersonRepresentationSerializer(source="creator")
+    _mailing_lists = MailingListRepresentationSerializer(label=_("Mailing List"), source="mailing_lists", many=True)
+    _excluded_mailing_lists = MailingListRepresentationSerializer(
+        label=_("Excluded Mailing List"), source="excluded_mailing_lists", many=True
+    )
+    _template = MailTemplateRepresentationSerializer(source="template")
+    subject = wb_serializers.CharField(required=True, label=_("Subject"))
+
+    class Meta:
+        model = models.MassMail
+        fields = (
+            "id",
+            "status",
+            "mailing_lists",
+            "_mailing_lists",
+            "excluded_mailing_lists",
+            "_excluded_mailing_lists",
+            "from_email",
+            "template",
+            "_template",
+            "subject",
+            "created",
+            "creator",
+            "_creator",
+            "send_at",
+        )
+
+
+class MassMailModelSerializer(MassMailListSerializer):
+    from_email = wb_serializers.CharField(
+        default=lambda: global_preferences_registry.manager()["wbmailing__default_source_mail"], label=_("From")
+    )
+
+    @wb_serializers.register_resource()
+    def send_test_mail(self, instance, request, user):
+        return {
+            "send_test_mail": reverse(
+                "wbmailing:massmail-sendtestmail",
+                args=[instance.id],
+                request=request,
+            )
+        }
+
+    @wb_serializers.register_resource()
+    def mails(self, instance, request, user):
+        return {
+            "mails": reverse(
+                "wbmailing:massmail-mailstatus-list",
+                args=[instance.id],
+                request=request,
+            ),
+            "events": reverse(
+                "wbmailing:massmail-mailevent-list",
+                args=[instance.id],
+                request=request,
+            ),
+        }
+
+    @wb_serializers.register_resource()
+    def analytics(self, instance, request, user):
+        return {
+            "mailstatus_barchart": reverse(
+                "wbmailing:massmail-mailstatusbarchart-list", args=[instance.id], request=request
+            ),
+            "mailclick_barchart": reverse(
+                "wbmailing:massmail-mailclickbarchart-list", args=[instance.id], request=request
+            ),
+            "clients_barchart": reverse(
+                "wbmailing:massmail-clientsbarchart-list", args=[instance.id], request=request
+            ),
+            "country_barchart": reverse(
+                "wbmailing:massmail-countrybarchart-list", args=[instance.id], request=request
+            ),
+            "region_barchart": reverse("wbmailing:massmail-regionbarchart-list", args=[instance.id], request=request),
+        }
+
+    def create(self, validated_data, *args, **kwargs):
+        if request := self.context.get("request"):
+            validated_data["creator"] = request.user.profile
+        return super().create(validated_data, *args, **kwargs)
+
+    class Meta:
+        model = models.MassMail
+        fields = (
+            "id",
+            "status",
+            "mailing_lists",
+            "_mailing_lists",
+            "excluded_mailing_lists",
+            "_excluded_mailing_lists",
+            "from_email",
+            "template",
+            "_template",
+            "subject",
+            "created",
+            "body",
+            "creator",
+            "_creator",
+            "send_at",
+            "attachment_url",
+            "_additional_resources",
+        )
+
+    def validate(self, data):
+        send_at = data.get("send_at", None)
+        if send_at:
+            if send_at < timezone.now() - timedelta(minutes=1):
+                raise serializers.ValidationError(
+                    {"non_field_errors": gettext("Send time shouldn't be earlier than now.")}
+                )
+        return super().validate(data)
+
+
+class MailModelSerializer(wb_serializers.ModelSerializer):
+    from_email = wb_serializers.CharField(
+        default=wb_serializers.CurrentUserDefault(user_attr="email"), label=_("From")
+    )
+    created = wb_serializers.DateTimeField(default=lambda: timezone.now(), label=_("Created"))
+    _mass_mail = MassMailRepresentationSerializer(many=False, source="mass_mail")
+    _template = MailTemplateRepresentationSerializer(many=False, source="template")
+    _to_email = EmailContactRepresentationSerializer(many=True, source="to_email")
+    _cc_email = EmailContactRepresentationSerializer(many=True, source="cc_email")
+    _bcc_email = EmailContactRepresentationSerializer(many=True, source="bcc_email")
+
+    status = wb_serializers.ChoiceField(
+        choices=models.MailEvent.EventType.choices, default=models.MailEvent.EventType.UNKNOWN, read_only=True
+    )
+
+    @wb_serializers.register_resource()
+    def mail_event(self, instance, request, user):
+        return {
+            "mailevent": reverse(
+                "wbmailing:mail-mailevent-list",
+                args=[instance.id],
+                request=request,
+            ),
+            "resend_mail": reverse(
+                "wbmailing:mail-resend",
+                args=[instance.id],
+                request=request,
+            ),
+        }
+
+    class Meta:
+        model = models.Mail
+        fields = (
+            "id",
+            "created",
+            "last_send",
+            "template",
+            "_template",
+            "message_ids",
+            "mass_mail",
+            "_mass_mail",
+            "from_email",
+            "to_email",
+            "_to_email",
+            "cc_email",
+            "_cc_email",
+            "bcc_email",
+            "_bcc_email",
+            "subject",
+            "body",
+            "status",
+            "_additional_resources",
+        )
+
+
+class MailStatusMassMailModelSerializer(wb_serializers.ModelSerializer):
+    mail_id = wb_serializers.CharField(read_only=True)
+    _entry = EntryRepresentationSerializer(source="entry")
+    status = wb_serializers.ChoiceField(
+        choices=(*models.MailEvent.EventType.choices, ("NOT_SENT", gettext("Not Sent"))),
+        default="NOT_SENT",
+        read_only=True,
+    )
+
+    class Meta:
+        model = EmailContact
+        fields = ("id", "entry", "_entry", "address", "status", "mail_id")
+
+
+class MailTemplateModelSerializer(wb_serializers.ModelSerializer):
+    class Meta:
+        model = models.MailTemplate
+        fields = ("id", "title", "template")
+
+
+class MailEventModelSerializer(wb_serializers.ModelSerializer):
+    _mail = MailRepresentationSerializer(source="mail")
+
+    class Meta:
+        model = models.MailEvent
+        fields = (
+            "id",
+            "mail",
+            "_mail",
+            "timestamp",
+            "event_type",
+            "reject_reason",
+            "description",
+            "recipient",
+            "click_url",
+            "ip",
+            "user_agent",
+        )

wbmailing/tasks.py

@@ -0,0 +1,37 @@
+from __future__ import absolute_import, unicode_literals
+
+from datetime import datetime
+
+from celery import shared_task
+from django.db.models import Q
+from django.utils import timezone
+from wbmailing.models import (
+    MailingListEmailContactThroughModel,
+    MailingListSubscriberChangeRequest,
+    MassMail,
+)
+
+
+@shared_task
+def check_and_remove_expired_mailinglist_subscription(date=None):
+    """
+    Shared tasks to expire contact in MailingList.
+    """
+    if not date:
+        date = timezone.now().date()
+    for request in MailingListSubscriberChangeRequest.objects.filter(
+        relationship__status=MailingListEmailContactThroughModel.Status.SUBSCRIBED,
+        expiration_date__isnull=False,
+        expiration_date__lte=date,
+    ).all():
+        request.relationship.change_state(automatically_approve=True, reason="Expired mailing list subscription")
+        request.expiration_date = None
+        request.save()
+
+
+@shared_task
+def periodic_send_mass_mail_as_tasks():
+    mass_mails = MassMail.objects.filter(Q(status=MassMail.Status.SEND_LATER) & Q(send_at__lte=datetime.now()))
+    for mass_mail in mass_mails:
+        mass_mail.send()
+        mass_mail.save()

wbmailing/templatetags/mailing_tags.py

@@ -0,0 +1,22 @@
+from django import template
+from django.utils.html import strip_tags
+
+register = template.Library()
+
+
+@register.filter
+def stripAndsplit(string, sep):
+    """Return the string split by sep.
+
+    Example usage: {{ value|split:"/" }}
+    """
+    return strip_tags(string).split(sep)
+
+
+@register.filter
+def strip(string):
+    """Return the string split by sep.
+
+    Example usage: {{ value|split:"/" }}
+    """
+    return strip_tags(string)

wbmailing/tests/conftest.py

@@ -0,0 +1,30 @@
+from django.apps import apps
+from django.db.models.signals import pre_migrate
+from pytest_factoryboy import register
+from wbcore.contrib.authentication.factories import UserFactory
+from wbcore.contrib.directory.factories import EmailContactFactory, PersonFactory
+from wbcore.contrib.geography.tests.signals import app_pre_migration
+from wbmailing.factories import (
+    MailEventFactory,
+    MailFactory,
+    MailingListEmailContactThroughModelFactory,
+    MailingListFactory,
+    MailingListSubscriberChangeRequestFactory,
+    MailTemplateFactory,
+    MassMailFactory,
+)
+
+register(EmailContactFactory)
+register(PersonFactory)
+register(UserFactory)
+register(MailingListSubscriberChangeRequestFactory)
+register(MailingListEmailContactThroughModelFactory)
+register(MailingListFactory)
+register(MassMailFactory)
+register(MailFactory)
+register(MailEventFactory)
+register(MailTemplateFactory)
+
+from .signals import *
+
+pre_migrate.connect(app_pre_migration, sender=apps.get_app_config("wbmailing"))