refactor mails templates, update participation cancelled endpoint, add mass...

refactor mails templates, update participation cancelled endpoint, add mass accept/reject actions in participation admin

oser_backend/tests/test_visits/test_participation_api.py

@@ -49,23 +49,18 @@ class ParticipationEndpointsTest(HyperlinkedAPITestCase):
             expected_status_code=status.HTTP_204_NO_CONTENT)
 
 
-class AbandonTest(APITestCase):
+class ParticipationCancelledTest(APITestCase):
     """Test endpoint to notify a user does not participate to visit anymore."""
 
     def setUp(self):
         self.user = UserFactory.create()
-        self.visit = VisitFactory.create()
-        self.reason = (
-            "Désolé, je ne peux plus venir à cause d'un rendez-vous médical.")
+        VisitFactory.create()
+        self.obj = ParticipationFactory.create()
 
     def perform(self):
-        data = {
-            'user': self.user.pk,
-            'visit': self.visit.pk,
-            'reason': self.reason,
-        }
-        response = self.client.post('/api/participations/abandon/', data=data,
-                                    format='json')
+        data = {'reason': 'Désolé, je ne peux plus venir.'}
+        url = f'/api/participations/{self.obj.pk}/notify_cancelled/'
+        response = self.client.post(url, data=data, format='json')
         return response
 
     def test(self):

oser_backend/visits/admin.py

 """Visits admin panel configuration."""
 
 from django import forms
-from django.contrib import admin
-from .models import Visit, Place, Participation
+from django.contrib import admin, messages
+from django.template.defaultfilters import pluralize
+
+from .models import Participation, Place, Visit
 
 # Register your models here.
 
@@ -71,12 +73,43 @@ class ParticipationInline(admin.StackedInline):
     extra = 0
 
 
+def accept_selected_participations(modeladmin, request, queryset):
+    """Accept selected participations in list view."""
+    for obj in queryset:
+        obj.accepted = True
+        obj.save()
+    count = queryset.count()
+    s = pluralize(count)
+    messages.add_message(request, messages.SUCCESS,
+                         f'{count} participation{s} acceptée{s} avec succès.')
+
+
+accept_selected_participations.short_description = (
+    'Accepter les participations sélectionnées')
+
+
+def reject_selected_participations(modeladmin, request, queryset):
+    """Reject selected participations in list view."""
+    for obj in queryset:
+        obj.accepted = False
+        obj.save()
+    count = queryset.count()
+    s = pluralize(count)
+    messages.add_message(request, messages.SUCCESS,
+                         f'{count} participation{s} acceptée{s} avec succès.')
+
+
+reject_selected_participations.short_description = (
+    'Rejeter les participations sélectionnées')
+
+
 @admin.register(Participation)
 class ParticipationAdmin(admin.ModelAdmin):
     """Admin panel for visit participations."""
 
     list_display = ('visit', 'user', 'accepted', 'present')
     list_filter = ('visit',)
+    actions = [accept_selected_participations, reject_selected_participations]
 
 
 @admin.register(Visit.organizers.through)

oser_backend/visits/notifications.py

@@ -11,10 +11,10 @@ from .models import Visit
 User = get_user_model()
 
 
-class Abandon(Notification):
+class ParticipationCancelled(Notification):
 
-    args = ('user', 'user_email', 'visit', 'date', 'reason',)
-    template_name = 'mails/visits/abandon.md'
+    args = ('user', 'visit', 'reason',)
+    template_name = 'visits/participation_cancelled.md'
     recipients = [settings.VISITS_TEAM_EMAIL]
 
     def get_subject(self):
@@ -22,14 +22,14 @@ class Abandon(Notification):
 
     @classmethod
     def example(cls):
-        return cls(user='John Doe', user_email='john.doe@example.com',
+        return cls(user='John Doe',
                    visit='Visite du Palais de la Découverte',
-                   date=now(), reason='Je ne peux plus venir...')
+                   reason='Je ne peux plus venir...')
 
 
 class Participation(Notification):
 
-    template_name = 'mails/visits/participation.md'
+    template_name = 'visits/participation.md'
     args = ('user', 'visit',)
     accepted: bool
 

oser_backend/visits/serializers.py

@@ -9,8 +9,8 @@ from profiles.models import Tutor
 from users.models import User
 from users.serializers import UserSerializer
 
+from .notifications import ParticipationCancelled
 from .models import Participation, Place, Visit
-from .notifications import Abandon
 
 
 class PlaceSerializer(serializers.ModelSerializer):
@@ -129,35 +129,23 @@ class VisitSerializer(VisitListSerializer):
             'url',)
 
 
-class AbandonSerializer(serializers.Serializer):
-    """Serializer for abandon notifications."""
+class ParticipationCancelledSerializer(serializers.Serializer):
+    """Serializer for sending participation cancelled notifications."""
 
-    user = serializers.PrimaryKeyRelatedField(
-        write_only=True,
-        queryset=User.objects.all(),
-        label='User',
-        help_text='ID of the user who does not participate anymore.')
     reason = serializers.CharField(
         write_only=True,
         label='Reason',
-        help_text='An explanation of why the user abandonned.')
-    visit = serializers.PrimaryKeyRelatedField(
-        write_only=True,
-        label='Visit',
-        help_text='ID of the visit the user has quit.',
-        queryset=Visit.objects.all())
+        help_text='Explain why the user cancelled their participation.')
 
     sent = serializers.BooleanField(read_only=True)
     timestamp = serializers.DateTimeField(read_only=True)
 
-    def create(self, validated_data):
-        user = validated_data['user']
-        visit = validated_data['visit']
+    def update(self, instance: Participation, validated_data):
+        """Send a notification as the user cancelled their participation."""
         reason = validated_data['reason']
 
-        notification = Abandon(
-            user=user, user_email=user.email, visit=visit,
-            date=visit.date, reason=reason)
+        notification = ParticipationCancelled(
+            user=instance.user, visit=instance.visit, reason=reason)
         notification.send()
 
         return notification

oser_backend/visits/signals.py

@@ -16,7 +16,7 @@ def fire_accepted_changed(sender, instance: Participation, created, **kwargs):
         accepted_changed.send(sender=sender, instance=instance)
 
 
-@receiver(accepted_changed, sender=Participation)
+@receiver(accepted_changed)
 def notify_participation(sender, instance: Participation, **kwargs):
     """Send notification to user depending on their participation status.
 

oser_backend/templates/mails/visits/participation.md → oser_backend/visits/templates/visits/participation.md

 {% extends 'mails/notification.md' %}
 
 {% block greeting %}
-Bonjour {{ user.first_name }},
+Bonjour{% if user.first_name %} {{ user.first_name }}{% endif %},
 {% endblock %}
 
 {% block body %}
 Tu as demandé à t'inscrire à la sortie **{{ visit.title }}** organisée le **{{ visit.date|date }}**.
 
 {% if accepted %}
-Nous avons validé ta participation à la sortie. ✅
+Bonne nouvelle : nous avons validé ta participation à la sortie. ✅
 
 En te rendant sur [l'espace sorties]({{ visit.get_site_url }}), tu peux dès à présent:
 
@@ -18,13 +18,13 @@ En te rendant sur [l'espace sorties]({{ visit.get_site_url }}), tu peux dès à
 
 {% else %}
 Malheureusement, en raison du nombre de places limité, tu ne pourras pas participer à cette sortie. 😔
+
 Nous te recontacterons si des places se libèrent suite à des désistements.
 {% endif %}
 {% endblock %}
 
 {% block signature %}
-À bientôt,
-
+À très bientôt,
 Les organisateurs  
 
 Nous contacter : oser.sortie@gmail.fr

oser_backend/templates/mails/visits/abandon.md → oser_backend/visits/templates/visits/participation_cancelled.md

 {% extends 'mails/notification.md' %}
 
 {% block body %}
-{{ user }} s'est désinscrit(e) de la sortie **{{ visit }}** organisée le **{{ date|date }}**. Voici la raison de son désistement :
+{{ user }} s'est désinscrit(e) de la sortie **{{ visit }}** organisée le **{{ visit.date|date }}**. Voici la raison de son désistement :
 
 > {{ reason }}
 
-Vous pouvez contacter {{ user }} grâce à son adresse mail : {{ user_email }}.
+Vous pouvez contacter {{ user }} grâce à son adresse mail : {{ user.email }}.
 {% endblock %}

oser_backend/visits/views.py

@@ -7,7 +7,7 @@ from rest_framework.decorators import action
 from rest_framework.response import Response
 
 from .models import Participation, Place, Visit
-from .serializers import (AbandonSerializer, ParticipationSerializer,
+from .serializers import (ParticipationCancelledSerializer, ParticipationSerializer,
                           PlaceSerializer, VisitListSerializer,
                           VisitSerializer)
 
@@ -174,35 +174,39 @@ class ParticipationsViewSet(mixins.CreateModelMixin,
     permission_classes = [DRYPermissions]
 
     def get_serializer_class(self):
-        if self.action == 'abandon':
-            return AbandonSerializer
+        if self.action == 'notify_cancelled':
+            return ParticipationCancelledSerializer
         return ParticipationSerializer
 
-    @action(methods=['post'], detail=False)
-    def abandon(self, request):
-        """Notify the visits team that a student abandoned a participation.
+    @action(methods=['post'], detail=True)
+    def notify_cancelled(self, request, pk=True):
+        """Notify the visits team that a user cancelled their participation.
 
         An email will be sent to the visits team's email address.
 
+        You should:
+
+        - Call this endpoint **before** you delete the associated
+        participation.
+        - Only call this endpoint if the participation has `accepted = True`,
+        as this is not checked for.
+
         ### Example payload
 
             {
-                "user": 3,
-                "reason": "Désolé, je ne peux plus venir…",
-                "visit": 1
+                "reason": "Désolé, je ne peux plus venir…"
             }
 
         ### Example response
 
             {
-                "user": "John Doe",
-                "reason": "Désolé, je ne peux plus venir…",
-                "visit": "Visite du Palais de la Découverte",
                 "sent": "2018-05-23 22:27:06.313137+00:00",
                 "recipient": "oser.geek@gmail.com"
             }
         """
-        serializer = AbandonSerializer(data=request.data)
+        participation = self.get_object()
+        serializer = ParticipationCancelledSerializer(
+            participation, data=request.data)
         serializer.is_valid(raise_exception=True)
         serializer.save()
         return Response(