✨ [#234] Validate DigitaalAdres.adres if type is email

src/openklant/components/klantinteracties/api/serializers/digitaal_adres.py

@@ -6,7 +6,10 @@
 from openklant.components.klantinteracties.api.serializers.constants import (
     SERIALIZER_PATH,
 )
-from openklant.components.klantinteracties.api.validators import digitaal_adres_exists
+from openklant.components.klantinteracties.api.validators import (
+    OptionalEmailValidator,
+    digitaal_adres_exists,
+)
 from openklant.components.klantinteracties.models.digitaal_adres import DigitaalAdres
 from openklant.components.klantinteracties.models.klantcontacten import Betrokkene
 from openklant.components.klantinteracties.models.partijen import Partij
@@ -85,6 +88,7 @@ class Meta:
                 "help_text": _("De unieke URL van dit digitaal adres binnen deze API."),
             },
         }
+        validators = [OptionalEmailValidator()]
 
     @transaction.atomic
     def update(self, instance, validated_data):

src/openklant/components/klantinteracties/api/validators.py

@@ -1,9 +1,12 @@
+from django.core.exceptions import ValidationError
+from django.core.validators import EmailValidator
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
-from rest_framework import serializers
+from rest_framework import exceptions, serializers
 from rest_framework.validators import UniqueTogetherValidator, qs_filter
 
+from openklant.components.klantinteracties.constants import SoortDigitaalAdres
 from openklant.components.klantinteracties.models.actoren import Actor
 from openklant.components.klantinteracties.models.constants import SoortPartij
 from openklant.components.klantinteracties.models.digitaal_adres import DigitaalAdres
@@ -23,6 +26,7 @@
     PartijIdentificator,
 )
 from openklant.components.klantinteracties.models.rekeningnummers import Rekeningnummer
+from openklant.utils.serializers import get_field_value
 
 
 class FKUniqueTogetherValidator(UniqueTogetherValidator):
@@ -166,3 +170,22 @@ def Rekeningnummer_exists(value):
         Rekeningnummer.objects.get(uuid=str(value))
     except Rekeningnummer.DoesNotExist:
         raise serializers.ValidationError(_("Rekeningnummer object bestaat niet."))
+
+
+class OptionalEmailValidator(EmailValidator):
+    """
+    EmailValidator for SoortDigitaalAdres that only attempts to validate if
+    `SoortDigitaalAdres` is `email
+    """
+
+    requires_context = True
+
+    def __call__(self, attrs: dict, serializer):
+        if (
+            get_field_value(serializer, attrs, "soort_digitaal_adres")
+            == SoortDigitaalAdres.email
+        ):
+            try:
+                super().__call__(get_field_value(serializer, attrs, "adres"))
+            except ValidationError as e:
+                raise exceptions.ValidationError({"adres": e.message})

src/openklant/utils/serializers.py

@@ -1,5 +1,8 @@
+from typing import Any
+
 from django.utils.module_loading import import_string
 
+from rest_framework.serializers import Serializer
 from rest_framework_nested.serializers import NestedHyperlinkedRelatedField
 
 
@@ -46,3 +49,23 @@ def to_representation(self, value):
             value = value.all()
 
         return serializer.to_representation(value)
+
+
+def get_field_value(
+    serializer: Serializer, attrs: dict[str, Any], field_name: str
+) -> Any:
+    """
+    Helper function to retrieve a field value from either the attrs (new data)
+    or the instance (existing data during updates).
+
+    :param serializer: The serializer instance
+    :param attrs: The attributes passed to `.validate`
+    :param field_name: The name of the field to retrieve
+    :return: The value of the field, or None if not present
+    """
+    if field_name in attrs:
+        return attrs.get(field_name)
+    # Fallback to instance value if it exists
+    if serializer.instance:
+        return getattr(serializer.instance, field_name, None)
+    return None