byceps/byceps

"""
byceps.announce.handlers.newsletter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Announce newsletter events.

:Copyright: 2014-2024 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from flask_babel import gettext

from byceps.announce.helpers import (
    get_screen_name_or_fallback,
    with_locale,
)
from byceps.events.newsletter import (
    SubscribedToNewsletterEvent,
    UnsubscribedFromNewsletterEvent,
)
from byceps.services.webhooks.models import Announcement, OutgoingWebhook


@with_locale
def announce_subscribed_to_newsletter(
    event_name: str,
    event: SubscribedToNewsletterEvent,
    webhook: OutgoingWebhook,
) -> Announcement | None:
    """Announce that someone has subscribed to a newsletter."""
    user_screen_name = get_screen_name_or_fallback(event.user)

    text = gettext(
        '%(user_screen_name)s has subscribed to newsletter "%(list_title)s".',
        user_screen_name=user_screen_name,
        list_title=event.list_title,
    )

    return Announcement(text)


@with_locale
def announce_unsubscribed_from_newsletter(
    event_name: str,
    event: UnsubscribedFromNewsletterEvent,
    webhook: OutgoingWebhook,
) -> Announcement | None:
    """Announce that someone has unsubscribed from a newsletter."""
    user_screen_name = get_screen_name_or_fallback(event.user)

    text = gettext(
        '%(user_screen_name)s has unsubscribed from newsletter "%(list_title)s".',
        user_screen_name=user_screen_name,
        list_title=event.list_title,
    )

    return Announcement(text)