Merge pull request #603 from praekeltfoundation/capi-backend-changes

Api to view/update WhatsAppTemplateSendStatus

Author: erikh360

eventstore/serializers.py

@@ -27,6 +27,7 @@
     PrebirthRegistration,
     PublicRegistration,
     ResearchOptinSwitch,
+    WhatsAppTemplateSendStatus,
 )
 
 from .validators import posix_timestamp
@@ -466,3 +467,17 @@ class DeliveryFailureSerializer(serializers.Serializer):
     contact_id = serializers.CharField()
     timestamp = serializers.DateTimeField()
     number_of_failures = serializers.IntegerField(required=False, read_only=True)
+
+
+class WhatsAppTemplateSendStatusSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = WhatsAppTemplateSendStatus
+        fields = "__all__"
+        read_only_fields = (
+            "id",
+            "message_id",
+            "sent_at",
+            "event_received_at",
+            "preferred_channel",
+            "status",
+        )

eventstore/tests/test_views.py

@@ -46,6 +46,7 @@
     PrebirthRegistration,
     PublicRegistration,
     ResearchOptinSwitch,
+    WhatsAppTemplateSendStatus,
 )
 from eventstore.serializers import (
     Covid19TriageSerializer,
@@ -3183,3 +3184,62 @@ def test_dont_update_existing_deliveryfailure(self):
         [df] = DeliveryFailure.objects.all()
         self.assertEqual(str(df.contact_id), "27820001001")
         self.assertEqual(df.number_of_failures, 1)
+
+
+class WhatsAppTemplateSendStatusViewTests(APITestCase):
+    def setUp(self):
+        self.status = WhatsAppTemplateSendStatus.objects.create(
+            message_id="test-message-id"
+        )
+        self.url = reverse("whatsapptemplatesendstatus-detail", args=[self.status.id])
+
+    def test_authentication_required(self):
+        """
+        There must be an authenticated user to make the request
+        """
+        response = self.client.post(self.url)
+        self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)
+
+    def test_permission_required(self):
+        """
+        The authenticated user must have the correct permissions to make the request
+        """
+        user = get_user_model().objects.create_user("test")
+        self.client.force_authenticate(user)
+        response = self.client.post(self.url)
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    def test_get_object(self):
+        """
+        Should be able to get a single object
+        """
+        user = get_user_model().objects.create_user("test")
+
+        user.user_permissions.add(
+            Permission.objects.get(codename="view_whatsapptemplatesendstatus")
+        )
+        self.client.force_authenticate(user)
+
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.json()["id"], str(self.status.id))
+        self.assertEqual(response.json()["message_id"], self.status.message_id)
+
+    def test_change_object(self):
+        """
+        Should be able to update an object
+        """
+        user = get_user_model().objects.create_user("test")
+
+        user.user_permissions.add(
+            Permission.objects.get(codename="change_whatsapptemplatesendstatus")
+        )
+        self.client.force_authenticate(user)
+
+        response = self.client.patch(
+            self.url, {"registration_completed_at": timezone.now()}
+        )
+
+        self.status.refresh_from_db()
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertIsNotNone(self.status.registration_completed_at)

eventstore/views.py

@@ -8,7 +8,12 @@
 from rest_framework import generics, permissions, serializers, status
 from rest_framework.authentication import TokenAuthentication
 from rest_framework.exceptions import ValidationError
-from rest_framework.mixins import CreateModelMixin, ListModelMixin, RetrieveModelMixin
+from rest_framework.mixins import (
+    CreateModelMixin,
+    ListModelMixin,
+    RetrieveModelMixin,
+    UpdateModelMixin,
+)
 from rest_framework.pagination import CursorPagination
 from rest_framework.permissions import DjangoModelPermissions
 from rest_framework.response import Response
@@ -40,6 +45,7 @@
     PrebirthRegistration,
     PublicRegistration,
     ResearchOptinSwitch,
+    WhatsAppTemplateSendStatus,
 )
 from eventstore.serializers import (
     AdaAssessmentNotificationSerializer,
@@ -74,6 +80,7 @@
     PublicRegistrationSerializer,
     ResearchOptinSwitchSerializer,
     TurnOutboundSerializer,
+    WhatsAppTemplateSendStatusSerializer,
     WhatsAppWebhookSerializer,
 )
 from eventstore.tasks import (
@@ -654,3 +661,12 @@ def post(self, request, *args, **kwargs):
             return Response({}, status=status.HTTP_201_CREATED)
 
         return Response({}, status=status.HTTP_200_OK)
+
+
+class WhatsAppTemplateSendStatusViewSet(
+    GenericViewSet, RetrieveModelMixin, UpdateModelMixin
+):
+    queryset = WhatsAppTemplateSendStatus.objects.all()
+    serializer_class = WhatsAppTemplateSendStatusSerializer
+    permission_classes = (DjangoViewModelPermissions,)
+    filter_backends = [filters.DjangoFilterBackend]

ndoh_hub/urls.py

@@ -37,6 +37,7 @@
     PublicRegistrationViewSet,
     ResearchOptinSwitchViewSet,
     WhatsAppEventsViewSet,
+    WhatsAppTemplateSendStatusViewSet,
 )
 from ndoh_hub.decorators import internal_only
 
@@ -74,6 +75,7 @@
 )
 v2router.register("deliveryfailure", DeliveryFailureViewSet)
 v2router.register("events", WhatsAppEventsViewSet)
+v2router.register("whatsapptemplatesendstatus", WhatsAppTemplateSendStatusViewSet)
 
 v3router = routers.DefaultRouter()
 v3router.register("covid19triage", Covid19TriageV2ViewSet, basename="covid19triagev2")