Merge pull request #567 from maykinmedia/issue/525-deprecate-nummer

🐛 [#525] deprecate nummer & add referentienummer

Author: Floris272

src/openklant/components/klantinteracties/api/filterset/internetaken.py

@@ -33,11 +33,13 @@ class Meta:
         model = InterneTaak
         fields = (
             "nummer",
+            "referentienummer",
             "status",
             "toegewezen_op",
             "actoren__naam",
             "klantcontact__uuid",
             "klantcontact__nummer",
+            "klantcontact__referentienummer",
             "toegewezen_aan_actor__uuid",
             "toegewezen_aan_actor__url",
             "aanleidinggevend_klantcontact__uuid",

src/openklant/components/klantinteracties/api/filterset/klantcontacten.py

@@ -106,6 +106,7 @@ class Meta:
             "was_onderwerpobject__onderwerpobjectidentificator_object_id",
             "was_onderwerpobject__onderwerpobjectidentificator_code_register",
             "nummer",
+            "referentienummer",
             "kanaal",
             "onderwerp",
             "inhoud",
@@ -162,6 +163,12 @@ class BetrokkeneFilterSet(FilterSet):
         help_text=_("Zoek betrokkene object op basis van het klantcontact nummer"),
         method="filter_had_klantcontact_nummer",
     )
+    had_klantcontact__referentienummer = filters.CharFilter(
+        help_text=_(
+            "Zoek betrokkene object op basis van het klantcontact referentienummer"
+        ),
+        method="filter_had_klantcontact_referentienummer",
+    )
     had_klantcontact__url = URLViewFilter(
         help_text=_("Zoek betrokkene object op basis van het klantcontact url"),
         field_name="klantcontact__uuid",
@@ -229,6 +236,7 @@ class Meta:
             "contactnaam_voorvoegsel_achternaam",
             "contactnaam_achternaam",
             "had_klantcontact__nummer",
+            "had_klantcontact__referentienummer",
             "had_klantcontact__uuid",
             "had_klantcontact__url",
             "verstrektedigitaal_adres__adres",
@@ -250,6 +258,12 @@ def filter_had_klantcontact_nummer(self, queryset, name, value):
         except ValueError:
             return queryset.none()
 
+    def filter_had_klantcontact_referentienummer(self, queryset, name, value):
+        try:
+            return queryset.filter(klantcontact__referentienummer=value)
+        except ValueError:
+            return queryset.none()
+
     def filter_digitaaladres_adres(self, queryset, name, value):
         return queryset.filter(digitaaladres__adres=value)
 

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

@@ -35,7 +35,7 @@ class Meta:
         }
 
 
-@extend_schema_serializer(deprecate_fields=["toegewezen_aan_actor"])
+@extend_schema_serializer(deprecate_fields=["toegewezen_aan_actor", "nummer"])
 class InterneTaakSerializer(serializers.HyperlinkedModelSerializer):
     toegewezen_aan_actor = ActorForeignKeySerializer(
         required=False,
@@ -64,6 +64,7 @@ class Meta:
             "uuid",
             "url",
             "nummer",
+            "referentienummer",
             "gevraagde_handeling",
             "aanleidinggevend_klantcontact",
             "toegewezen_aan_actor",

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

@@ -2,7 +2,7 @@
 from django.utils.translation import gettext_lazy as _
 
 import structlog
-from drf_spectacular.utils import extend_schema_field
+from drf_spectacular.utils import extend_schema_field, extend_schema_serializer
 from rest_framework import serializers
 from vng_api_common.serializers import GegevensGroepSerializer, NestedGegevensGroepMixin
 
@@ -261,6 +261,7 @@ def create(self, validated_data):
         return super().create(validated_data)
 
 
+@extend_schema_serializer(deprecate_fields=["nummer"])
 class KlantcontactSerializer(serializers.HyperlinkedModelSerializer):
     from openklant.components.klantinteracties.api.serializers.internetaken import (
         InterneTaakForeignKeySerializer,
@@ -325,6 +326,7 @@ class Meta:
             "had_betrokkenen",
             "leidde_tot_interne_taken",
             "nummer",
+            "referentienummer",
             "kanaal",
             "onderwerp",
             "inhoud",

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

@@ -467,6 +467,7 @@ def create(self, validated_data):
         return super().create(validated_data)
 
 
+@extend_schema_serializer(deprecate_fields=["nummer"])
 class PartijSerializer(NestedGegevensGroepMixin, PolymorphicSerializer):
     from openklant.components.klantinteracties.api.serializers.rekeningnummers import (
         RekeningnummerForeignKeySerializer,

src/openklant/components/klantinteracties/api/tests/partijen/test_partij.py

@@ -325,16 +325,8 @@ def test_create_partij(self):
                 },
             )
 
-        with self.subTest("auto_generate_max_nummer_plus_one"):
-            data["nummer"] = ""
-            response = self.client.post(list_url, data)
-
-            self.assertEqual(response.status_code, status.HTTP_201_CREATED)
-            response_data = response.json()
-            self.assertEqual(response_data["nummer"], "1298329193")
-
-        with self.subTest("auto_generate_nummer_unique_validation"):
-            data["nummer"] = "1298329193"
+        with self.subTest("nummer_unique_validation"):
+            data["nummer"] = "1298329192"
             response = self.client.post(list_url, data)
 
             self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
@@ -344,19 +336,6 @@ def test_create_partij(self):
                 error["reason"], "Er bestaat al een partij met eenzelfde nummer."
             )
 
-        with self.subTest("auto_generate_nummer_over_10_characters_error_message"):
-            PartijFactory.create(nummer="9999999999")
-            data["nummer"] = ""
-            response = self.client.post(list_url, data)
-
-            self.assertEqual(response.status_code, status.HTTP_409_CONFLICT)
-            response_data = response.json()
-            self.assertEqual(
-                response_data["detail"],
-                "Er kon niet automatisch een opvolgend nummer worden gegenereerd. "
-                "Het maximaal aantal tekens is bereikt.",
-            )
-
         with self.subTest("voorkeurs_adres_must_be_given_digitaal_adres_validation"):
             data["nummer"] = "1298329194"
             data["voorkeursDigitaalAdres"] = {"uuid": str(digitaal_adres2.uuid)}

src/openklant/components/klantinteracties/api/tests/test_filters.py

@@ -581,6 +581,33 @@ def test_filter_had_klantcontact_nummer(self):
 
             self.assertEqual(response.json()["count"], 0)
 
+    def test_filter_had_klantcontact_referentienummer(self):
+        klantcontact = KlantcontactFactory.create(referentienummer="6237172371")
+        klantcontact2 = KlantcontactFactory.create(referentienummer="9999999999")
+        betrokkene = BetrokkeneFactory.create(klantcontact=klantcontact)
+        BetrokkeneFactory.create(klantcontact=klantcontact2)
+
+        with self.subTest("happy flow"):
+            response = self.client.get(
+                self.url,
+                {"hadKlantcontact__referentienummer": str(6237172371)},
+            )
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+            data = response.json()["results"]
+
+            self.assertEqual(1, len(data))
+            self.assertEqual(str(betrokkene.uuid), data[0]["uuid"])
+
+        with self.subTest("no_matches_found_return_nothing"):
+            response = self.client.get(
+                self.url,
+                {"hadKlantcontact__referentienummer": "8584395394"},
+            )
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+            self.assertEqual(response.json()["count"], 0)
+
     def test_filter_verstrektedigitaal_adres_url(self):
         betrokkene = BetrokkeneFactory.create()
         betrokkene2 = BetrokkeneFactory.create()

src/openklant/components/klantinteracties/api/tests/test_internetaken.py

@@ -88,16 +88,8 @@ def test_create_internetaak(self):
             InterneTaak.objects.filter(afgehandeld_op="2024-01-01T12:00:00Z").exists()
         )
 
-        with self.subTest("auto_generate_max_nummer_plus_one"):
-            data["nummer"] = ""
-            response = self.client.post(list_url, data)
-
-            self.assertEqual(response.status_code, status.HTTP_201_CREATED)
-            response_data = response.json()
-            self.assertEqual(response_data["nummer"], "1312312313")
-
-        with self.subTest("auto_generate_nummer_unique_validation"):
-            data["nummer"] = "1312312313"
+        with self.subTest("nummer_unique_validation"):
+            data["nummer"] = "1312312312"
             response = self.client.post(list_url, data)
 
             self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
@@ -107,19 +99,6 @@ def test_create_internetaak(self):
                 "Er bestaat al een interne taak met eenzelfde nummer.",
             )
 
-        with self.subTest("auto_generate_nummer_over_10_characters_error_message"):
-            InterneTaakFactory.create(nummer="9999999999")
-            data["nummer"] = ""
-            response = self.client.post(list_url, data)
-
-            self.assertEqual(response.status_code, status.HTTP_409_CONFLICT)
-            response_data = response.json()
-            self.assertEqual(
-                response_data["detail"],
-                "Er kon niet automatisch een opvolgend nummer worden gegenereerd. "
-                "Het maximaal aantal tekens is bereikt.",
-            )
-
     @freeze_time("2024-01-01T12:00:00Z")
     def test_create_internetaak_with_status_te_verwerken(self):
         actor = ActorFactory.create()

src/openklant/components/klantinteracties/api/tests/test_klantcontacten.py

@@ -150,16 +150,8 @@ def test_create_klantcontact(self):
         self.assertTrue(data["indicatieContactGelukt"])
         self.assertTrue(data["vertrouwelijk"])
 
-        with self.subTest("auto_generate_max_nummer_plus_one"):
-            data["nummer"] = ""
-            response = self.client.post(list_url, data)
-
-            self.assertEqual(response.status_code, status.HTTP_201_CREATED)
-            response_data = response.json()
-            self.assertEqual(response_data["nummer"], "1234567891")
-
-        with self.subTest("auto_generate_nummer_unique_validation"):
-            data["nummer"] = "1234567891"
+        with self.subTest("nummer_unique_validation"):
+            data["nummer"] = "1234567890"
             response = self.client.post(list_url, data)
 
             self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
@@ -169,19 +161,6 @@ def test_create_klantcontact(self):
                 "Er bestaat al een klantcontact met eenzelfde nummer.",
             )
 
-        with self.subTest("auto_generate_nummer_over_10_characters_error_message"):
-            KlantcontactFactory.create(nummer="9999999999")
-            data["nummer"] = ""
-            response = self.client.post(list_url, data)
-
-            self.assertEqual(response.status_code, status.HTTP_409_CONFLICT)
-            response_data = response.json()
-            self.assertEqual(
-                response_data["detail"],
-                "Er kon niet automatisch een opvolgend nummer worden gegenereerd. "
-                "Het maximaal aantal tekens is bereikt.",
-            )
-
     def test_create_klantcontact_with_reverse_lookup_fields(self):
         list_url = reverse("klantinteracties:klantcontact-list")
         data = {
@@ -2189,6 +2168,7 @@ def test_create_success(self):
                 "leiddeTotInterneTaken": [],
                 "metadata": {},
                 "nummer": "7948723947",
+                "referentienummer": None,
                 "omvatteBijlagen": [],
                 "onderwerp": "changed",
                 "plaatsgevondenOp": "2020-08-24T14:15:22Z",
@@ -2659,6 +2639,7 @@ def test_create_without_betrokkene_and_onderwerpobject(self):
                 "leiddeTotInterneTaken": [],
                 "metadata": {},
                 "nummer": "7948723947",
+                "referentienummer": None,
                 "omvatteBijlagen": [],
                 "onderwerp": "changed",
                 "plaatsgevondenOp": "2020-08-24T14:15:22Z",

src/openklant/components/klantinteracties/api/viewsets/internetaken.py

@@ -1,7 +1,7 @@
 from django.db import transaction
 
 import structlog
-from drf_spectacular.utils import extend_schema, extend_schema_view
+from drf_spectacular.utils import OpenApiParameter, extend_schema, extend_schema_view
 from notifications_api_common.viewsets import NotificationViewSetMixin
 from rest_framework import viewsets
 from vng_api_common.pagination import DynamicPageSizePagination
@@ -32,6 +32,10 @@
     list=extend_schema(
         summary="Alle interne taken opvragen.",
         description="Alle interne taken opvragen.",
+        parameters=[
+            OpenApiParameter(name="nummer", deprecated=True),
+            OpenApiParameter(name="klantcontact__nummer", deprecated=True),
+        ],
     ),
     retrieve=extend_schema(
         summary="Een specifiek interne taak opvragen.",