Feature: Do Good Hours

bluebottle/activities/messages.py

@@ -1,13 +1,15 @@
-from pytz import timezone
+from datetime import timedelta
 
-from django.urls import reverse
+from django.db.models import Sum, Q
 from django.template.defaultfilters import time, date
+from django.urls import reverse
+from django.utils.timezone import get_current_timezone, now
+from django.utils.translation import pgettext_lazy as pgettext
+from pytz import timezone
 
 from bluebottle.initiatives.models import InitiativePlatformSettings
-from django.utils.timezone import get_current_timezone
-
 from bluebottle.notifications.messages import TransitionMessage
-from django.utils.translation import pgettext_lazy as pgettext
+from bluebottle.notifications.models import Message
 from bluebottle.utils.utils import get_current_host, get_current_language
 
 
@@ -445,3 +447,64 @@ def get_recipients(self):
             return [self.obj.team.owner]
         else:
             return []
+
+
+class BaseDoGoodHoursReminderNotification(TransitionMessage):
+
+    @property
+    def action_link(self):
+        return self.obj.get_absolute_url()
+
+    action_title = pgettext('email', 'Find activities')
+
+    send_once = True
+
+    def already_send(self, recipient):
+        return Message.objects.filter(
+            template=self.get_template(),
+            recipient=recipient,
+            sent__year=now().year
+        ).count() > 0
+
+    def get_recipients(self):
+        """members with do good hours"""
+        from bluebottle.members.models import Member
+        from bluebottle.members.models import MemberPlatformSettings
+
+        year = now().year
+        do_good_hours = timedelta(hours=MemberPlatformSettings.load().do_good_hours)
+
+        members = Member.objects.annotate(
+            hours=Sum(
+                'contributor__contributions__timecontribution__value',
+                filter=(
+                    Q(contributor__contributions__start__year=year) &
+                    Q(contributor__contributions__status__in=['new', 'succeeded'])
+                )
+            ),
+        ).filter(
+            Q(hours__lt=do_good_hours) | Q(hours__isnull=True),
+            is_active=True,
+            receive_reminder_emails=True
+        ).distinct()
+        return members
+
+
+class DoGoodHoursReminderQ1Notification(BaseDoGoodHoursReminderNotification):
+    subject = pgettext('email', "Are you ready to do good? Q1")
+    template = 'messages/do-good-hours/reminder-q1'
+
+
+class DoGoodHoursReminderQ2Notification(BaseDoGoodHoursReminderNotification):
+    subject = pgettext('email', "Are you ready to do good? Q2")
+    template = 'messages/do-good-hours/reminder-q2'
+
+
+class DoGoodHoursReminderQ3Notification(BaseDoGoodHoursReminderNotification):
+    subject = pgettext('email', "Are you ready to do good? Q3")
+    template = 'messages/do-good-hours/reminder-q3'
+
+
+class DoGoodHoursReminderQ4Notification(BaseDoGoodHoursReminderNotification):
+    subject = pgettext('email', "Are you ready to do good? Q4")
+    template = 'messages/do-good-hours/reminder-q4'

bluebottle/activities/tasks.py

@@ -1,19 +1,18 @@
 import logging
+from datetime import date
 
 from celery.schedules import crontab
 from celery.task import periodic_task
-
-from bluebottle.clients.models import Client
-from bluebottle.clients.utils import LocalTenant
-
 from elasticsearch_dsl.query import Nested, Q, FunctionScore, ConstantScore, MatchAll
 
-from bluebottle.initiatives.models import InitiativePlatformSettings
 from bluebottle.activities.documents import activity
+from bluebottle.activities.messages import MatchingActivitiesNotification, DoGoodHoursReminderQ1Notification, \
+    DoGoodHoursReminderQ4Notification, DoGoodHoursReminderQ3Notification, DoGoodHoursReminderQ2Notification
 from bluebottle.activities.models import Activity
-from bluebottle.activities.messages import MatchingActivitiesNotification
-from bluebottle.members.models import Member
-
+from bluebottle.clients.models import Client
+from bluebottle.clients.utils import LocalTenant
+from bluebottle.initiatives.models import InitiativePlatformSettings
+from bluebottle.members.models import Member, MemberPlatformSettings
 
 logger = logging.getLogger('bluebottle')
 
@@ -123,3 +122,36 @@ def recommend():
                             )
                         except Exception as e:
                             logger.error(e)
+
+
+@periodic_task(
+    run_every=(crontab(minute=0, hour=10)),
+    name="do_good_hours_reminder",
+    ignore_result=True
+)
+def do_good_hours_reminder():
+
+    for tenant in Client.objects.all():
+        with LocalTenant(tenant, clear_tenant=True):
+            settings = MemberPlatformSettings.objects.get()
+            if settings.do_good_hours:
+                q1 = date.today().replace(month=1, day=1)
+                q2 = date.today().replace(month=4, day=1)
+                q3 = date.today().replace(month=7, day=1)
+                q4 = date.today().replace(month=10, day=1)
+                notification = None
+                today = date.today()
+                if settings.reminder_q1 and today == q1:
+                    notification = DoGoodHoursReminderQ1Notification(settings)
+                if settings.reminder_q2 and today == q2:
+                    notification = DoGoodHoursReminderQ2Notification(settings)
+                if settings.reminder_q3 and today == q3:
+                    notification = DoGoodHoursReminderQ3Notification(settings)
+                if settings.reminder_q4 and today == q4:
+                    notification = DoGoodHoursReminderQ4Notification(settings)
+
+                if notification:
+                    try:
+                        notification.compose_and_send()
+                    except Exception as e:
+                        logger.error(e)

bluebottle/activities/templates/mails/messages/do-good-hours/reminder-base.html

@@ -0,0 +1,13 @@
+{% extends "base.mail.html" %}
+{% load i18n %}
+
+{% block content %}
+    <p>
+        {% blocktrans context 'email' %}Hi {{ recipient_name }},{% endblocktrans %}
+    </p>
+    {% block message %}{% endblock %}
+{% endblock %}
+
+{% block action %}
+    <a href="{{ action_link }}" class="action-email">{{ action_title }}</a>
+{% endblock %}`

bluebottle/activities/templates/mails/messages/do-good-hours/reminder-q1.html

@@ -0,0 +1,8 @@
+{% extends "mails/messages/do-good-hours/reminder-base.html" %}
+{% load i18n %}
+
+{% block message %}
+    {% blocktrans context 'email' %}
+        First reminder
+    {% endblocktrans %}
+{% endblock %}

bluebottle/activities/templates/mails/messages/do-good-hours/reminder-q2.html

@@ -0,0 +1,8 @@
+{% extends "mails/messages/do-good-hours/reminder-base.html" %}
+{% load i18n %}
+
+{% block message %}
+    {% blocktrans context 'email' %}
+        Second reminder
+    {% endblocktrans %}
+{% endblock %}

bluebottle/activities/templates/mails/messages/do-good-hours/reminder-q3.html

@@ -0,0 +1,8 @@
+{% extends "mails/messages/do-good-hours/reminder-base.html" %}
+{% load i18n %}
+
+{% block message %}
+    {% blocktrans context 'email' %}
+        Third reminder
+    {% endblocktrans %}
+{% endblock %}

bluebottle/activities/templates/mails/messages/do-good-hours/reminder-q4.html

@@ -0,0 +1,8 @@
+{% extends "mails/messages/do-good-hours/reminder-base.html" %}
+{% load i18n %}
+
+{% block message %}
+    {% blocktrans context 'email' %}
+        Fourth reminder
+    {% endblocktrans %}
+{% endblock %}

bluebottle/activities/tests/test_notifications.py

@@ -1,17 +1,25 @@
+from datetime import timedelta
+
+from django.utils.timezone import now
+
 from bluebottle.activities.messages import (
     ActivityRejectedNotification, ActivityCancelledNotification,
     ActivitySucceededNotification, ActivityRestoredNotification,
     ActivityExpiredNotification, TeamAddedMessage,
     TeamAppliedMessage, TeamCancelledMessage,
     TeamCancelledTeamCaptainMessage, TeamWithdrawnActivityOwnerMessage,
     TeamWithdrawnMessage, TeamMemberAddedMessage, TeamMemberWithdrewMessage,
-    TeamMemberRemovedMessage, TeamReappliedMessage, TeamCaptainAcceptedMessage
+    TeamMemberRemovedMessage, TeamReappliedMessage, TeamCaptainAcceptedMessage, DoGoodHoursReminderQ1Notification,
+    DoGoodHoursReminderQ3Notification, DoGoodHoursReminderQ2Notification, DoGoodHoursReminderQ4Notification
 )
 from bluebottle.activities.tests.factories import TeamFactory
+from bluebottle.members.models import MemberPlatformSettings, Member
+from bluebottle.notifications.models import NotificationPlatformSettings
 from bluebottle.test.factory_models.accounts import BlueBottleUserFactory
 from bluebottle.test.utils import NotificationTestCase
 from bluebottle.time_based.tests.factories import (
-    DateActivityFactory, PeriodActivityFactory, PeriodParticipantFactory
+    DateActivityFactory, PeriodActivityFactory, PeriodParticipantFactory, DateActivitySlotFactory,
+    DateParticipantFactory, SlotParticipantFactory
 )
 
 
@@ -260,3 +268,107 @@ def test_team_member_removed_notification(self):
 
         self.assertActionLink(self.obj.activity.get_absolute_url())
         self.assertActionTitle('View activity')
+
+
+class DoGoodHoursReminderNotificationTestCase(NotificationTestCase):
+
+    def setUp(self):
+        self.obj = NotificationPlatformSettings.load()
+        self.obj = MemberPlatformSettings.load()
+        self.obj.do_good_hours = 8
+        self.obj.save()
+        activity = DateActivityFactory.create(
+            slots=[],
+            slot_selection='free',
+        )
+
+        slot1 = DateActivitySlotFactory.create(
+            start=now() - timedelta(days=2),
+            duration=timedelta(hours=4),
+            activity=activity
+        )
+        slot2 = DateActivitySlotFactory.create(
+            start=now() - timedelta(days=1),
+            duration=timedelta(hours=4),
+            activity=activity
+        )
+        old_slot = DateActivitySlotFactory.create(
+            start=now().replace(year=2011),
+            duration=timedelta(hours=8),
+            activity=activity
+        )
+
+        self.active_user = BlueBottleUserFactory.create(first_name='Active')
+        part1 = DateParticipantFactory.create(
+            user=self.active_user,
+            activity=activity
+        )
+        SlotParticipantFactory.create(
+            participant=part1,
+            slot=slot1
+        )
+        SlotParticipantFactory.create(
+            participant=part1,
+            slot=slot2
+        )
+        self.moderate_user = BlueBottleUserFactory.create(first_name='Moderate')
+        part2 = DateParticipantFactory.create(
+            user=self.moderate_user,
+            activity=activity
+        )
+        SlotParticipantFactory.create(
+            participant=part2,
+            slot=slot1
+        )
+        SlotParticipantFactory.create(
+            participant=part2,
+            slot=old_slot
+        )
+        self.passive_user = BlueBottleUserFactory.create(first_name='Passive')
+        part3 = DateParticipantFactory.create(
+            user=self.passive_user,
+            activity=activity
+        )
+
+        SlotParticipantFactory.create(
+            participant=part3,
+            slot=old_slot
+        )
+
+        Member.objects.exclude(id__in=[
+            self.active_user.id,
+            self.passive_user.id,
+            self.moderate_user.id,
+        ]).update(receive_reminder_emails=False)
+
+    def test_reminder_q1(self):
+        self.message_class = DoGoodHoursReminderQ1Notification
+        self.create()
+        self.assertRecipients([self.moderate_user, self.passive_user])
+        self.assertSubject("Are you ready to do good? Q1")
+        self.assertBodyContains('First reminder')
+        self.assertActionTitle('Find activities')
+
+    def test_reminder_q2(self):
+        self.message_class = DoGoodHoursReminderQ2Notification
+        self.create()
+        self.assertRecipients([self.moderate_user, self.passive_user])
+        self.assertSubject("Are you ready to do good? Q2")
+        self.assertBodyContains('Second reminder')
+        self.assertActionTitle('Find activities')
+
+    def test_reminder_q3(self):
+        self.message_class = DoGoodHoursReminderQ3Notification
+        self.create()
+        self.assertRecipients([self.moderate_user, self.passive_user])
+        self.assertSubject("Are you ready to do good? Q3")
+        self.assertBodyContains('Third reminder')
+        self.assertActionTitle('Find activities')
+
+    def test_reminder_q4(self):
+        self.message_class = DoGoodHoursReminderQ4Notification
+        self.create()
+        self.assertRecipients([self.moderate_user, self.passive_user])
+        self.assertSubject("Are you ready to do good? Q4")
+        self.assertBodyContains('Fourth reminder')
+        self.assertActionTitle('Find activities')