Mijn Berichten demo (VNG Hackathon 2024)

requirements/base.in

@@ -94,6 +94,7 @@ git+https://github.com/maykinmedia/django-celery-monitor@513dc28#egg=django_cele
 zgw-consumers
 zgw-consumers-oas
 notifications-api-common
+git+https://github.com/maykinmedia/objects-api-client-django.git@f499caf#egg=objects-api-client-django
 
 # 2FA SMS verification
 oath

requirements/base.txt

@@ -16,6 +16,8 @@ asgiref==3.7.2
     # via django
 asn1crypto==1.5.1
     # via webauthn
+async-timeout==4.0.3
+    # via redis
 attrs==21.2.0
     # via
     #   glom
@@ -146,6 +148,7 @@ django==4.2.16
     #   mozilla-django-oidc
     #   mozilla-django-oidc-db
     #   notifications-api-common
+    #   objects-api-client-django
     #   zgw-consumers
     #   zgw-consumers-oas
 django-admin-index==3.1.0
@@ -272,6 +275,7 @@ django-solo==2.2.0
     #   django-open-forms-client
     #   mozilla-django-oidc-db
     #   notifications-api-common
+    #   objects-api-client-django
     #   zgw-consumers
 django-timeline-logger==3.0.0
     # via -r requirements/base.in
@@ -340,9 +344,7 @@ faker==27.0.0
 fontawesomefree==6.4.2
     # via -r requirements/base.in
 fonttools[woff]==4.43.0
-    # via
-    #   fonttools
-    #   weasyprint
+    # via weasyprint
 furl==2.1.3
     # via
     #   -r requirements/base.in
@@ -411,6 +413,8 @@ notifications-api-common==0.2.2
     # via -r requirements/base.in
 oath==1.4.4
     # via -r requirements/base.in
+objects-api-client-django @ git+https://github.com/maykinmedia/objects-api-client-django.git@f499caf
+    # via -r requirements/base.in
 odfpy==1.4.1
     # via tablib
 openpyxl==3.0.9
@@ -508,6 +512,7 @@ requests==2.31.0
     #   maykin-python3-saml
     #   messagebird
     #   mozilla-django-oidc
+    #   objects-api-client-django
     #   zgw-consumers
 sentry-sdk==1.38.0
     # via -r requirements/base.in
@@ -532,9 +537,7 @@ sqlparse==0.4.4
 svglib==1.5.1
     # via easy-thumbnails
 tablib[html,ods,xls,xlsx,yaml]==3.1.0
-    # via
-    #   django-import-export
-    #   tablib
+    # via django-import-export
 tinycss2==1.1.1
     # via
     #   -r requirements/base.in
@@ -594,6 +597,7 @@ zgw-consumers==0.35.1
     # via
     #   -r requirements/base.in
     #   notifications-api-common
+    #   objects-api-client-django
 zgw-consumers-oas==1.0.0
     # via -r requirements/base.in
 zopfli==0.1.9

requirements/ci.txt

@@ -37,6 +37,11 @@ asn1crypto==1.5.1
     #   webauthn
 astroid==2.15.8
     # via pylint
+async-timeout==4.0.3
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   redis
 attrs==21.2.0
     # via
     #   -c requirements/base.txt
@@ -238,6 +243,7 @@ django==4.2.16
     #   mozilla-django-oidc
     #   mozilla-django-oidc-db
     #   notifications-api-common
+    #   objects-api-client-django
     #   zgw-consumers
     #   zgw-consumers-oas
 django-admin-index==3.1.0
@@ -460,6 +466,7 @@ django-solo==2.2.0
     #   django-open-forms-client
     #   mozilla-django-oidc-db
     #   notifications-api-common
+    #   objects-api-client-django
     #   zgw-consumers
 django-timeline-logger==3.0.0
     # via
@@ -480,7 +487,6 @@ django-two-factor-auth[phonenumberslite,webauthn]==1.16.0
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
-    #   django-two-factor-auth
     #   maykin-2fa
 django-view-breadcrumbs==2.5.1
     # via
@@ -553,7 +559,6 @@ easy-thumbnails[svg]==2.8.5
     #   -r requirements/base.txt
     #   django-filer
     #   djangocms-picture
-    #   easy-thumbnails
 ecs-logging==2.1.0
     # via
     #   -c requirements/base.txt
@@ -607,7 +612,6 @@ fonttools[woff]==4.43.0
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
-    #   fonttools
     #   weasyprint
 freezegun==1.1.0
     # via -r requirements/test-tools.in
@@ -764,6 +768,10 @@ oath==1.4.4
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
+objects-api-client-django @ git+https://github.com/maykinmedia/objects-api-client-django.git@f499caf
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
 odfpy==1.4.1
     # via
     #   -c requirements/base.txt
@@ -839,7 +847,6 @@ pydantic[email]==2.6.4
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
-    #   pydantic
 pydantic-core==2.16.3
     # via
     #   -c requirements/base.txt
@@ -973,6 +980,7 @@ requests==2.31.0
     #   maykin-python3-saml
     #   messagebird
     #   mozilla-django-oidc
+    #   objects-api-client-django
     #   requests-mock
     #   sphinx
     #   zgw-consumers
@@ -1050,7 +1058,6 @@ tablib[html,ods,xls,xlsx,yaml]==3.1.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   django-import-export
-    #   tablib
 tblib==1.7.0
     # via -r requirements/test-tools.in
 tinycss2==1.1.1
@@ -1167,6 +1174,7 @@ zgw-consumers==0.35.1
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   notifications-api-common
+    #   objects-api-client-django
 zgw-consumers-oas==1.0.0
     # via
     #   -c requirements/base.txt

requirements/dev.txt

@@ -43,6 +43,11 @@ astroid==2.15.8
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   pylint
+async-timeout==4.0.3
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   redis
 attrs==21.2.0
     # via
     #   -c requirements/ci.txt
@@ -278,6 +283,7 @@ django==4.2.16
     #   mozilla-django-oidc
     #   mozilla-django-oidc-db
     #   notifications-api-common
+    #   objects-api-client-django
     #   zgw-consumers
     #   zgw-consumers-oas
 django-admin-index==3.1.0
@@ -506,6 +512,7 @@ django-solo==2.2.0
     #   django-open-forms-client
     #   mozilla-django-oidc-db
     #   notifications-api-common
+    #   objects-api-client-django
     #   zgw-consumers
 django-timeline-logger==3.0.0
     # via
@@ -526,7 +533,6 @@ django-two-factor-auth[phonenumberslite,webauthn]==1.16.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-    #   django-two-factor-auth
     #   maykin-2fa
 django-view-breadcrumbs==2.5.1
     # via
@@ -603,7 +609,6 @@ easy-thumbnails[svg]==2.8.5
     #   -r requirements/ci.txt
     #   django-filer
     #   djangocms-picture
-    #   easy-thumbnails
 ecs-logging==2.1.0
     # via
     #   -c requirements/ci.txt
@@ -670,7 +675,6 @@ fonttools[woff]==4.43.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-    #   fonttools
     #   weasyprint
 freezegun==1.1.0
     # via
@@ -874,6 +878,10 @@ oath==1.4.4
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+objects-api-client-django @ git+https://github.com/maykinmedia/objects-api-client-django.git@f499caf
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
 odfpy==1.4.1
     # via
     #   -c requirements/ci.txt
@@ -974,7 +982,6 @@ pydantic[email]==2.6.4
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-    #   pydantic
 pydantic-core==2.16.3
     # via
     #   -c requirements/ci.txt
@@ -1125,6 +1132,7 @@ requests==2.31.0
     #   maykin-python3-saml
     #   messagebird
     #   mozilla-django-oidc
+    #   objects-api-client-django
     #   requests-mock
     #   sphinx
     #   zgw-consumers
@@ -1244,7 +1252,6 @@ tablib[html,ods,xls,xlsx,yaml]==3.1.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-import-export
-    #   tablib
 tblib==1.7.0
     # via
     #   -c requirements/ci.txt
@@ -1390,6 +1397,7 @@ zgw-consumers==0.35.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   notifications-api-common
+    #   objects-api-client-django
 zgw-consumers-oas==1.0.0
     # via
     #   -c requirements/ci.txt

src/open_inwoner/berichten/api_models.py

@@ -0,0 +1,50 @@
+# generated by datamodel-codegen:
+#   filename:  bericht.json
+#   timestamp: 2024-10-07T14:27:37+00:00
+
+from __future__ import annotations
+
+from datetime import date
+from typing import List, Optional
+
+from pydantic import BaseModel, Field, constr
+from typing_extensions import Literal
+
+
+class Identificatie(BaseModel):
+    type: Literal["bsn", "kvk"] = "bsn"
+    value: Optional[constr(pattern=r"^[0-9]+$")] = None  # noqa: F722
+
+
+class Bericht(BaseModel):
+    object_uuid: str = Field(..., description="UUID van het onderliggende object")
+    onderwerp: str = Field(..., description="Onderwerp van het bericht")
+    bericht_tekst: str = Field(
+        ...,
+        description="Tekst van het bericht. Mag URL bevatten en /r/n voor newline. Geen verdere opmaak mogelijk.",
+    )
+    publicatiedatum: date = Field(
+        ...,
+        description="Tijdstip van verwerken van het bericht of de PublicatieDatum indien deze is ingevuld",
+    )
+    einddatum_handelingstermijn: Optional[date] = Field(
+        None, description="Termijn waarbinnen de geadresseerde moet reageren"
+    )
+    referentie: Optional[str] = Field(None, description="TODO")
+    handelingsperspectief: Optional[
+        Literal["betalen", "informatie verstrekken", "informatie ontvangen", "TODO"]
+    ] = Field(None, description="TODO: Benodigde reactie van de geadresseerde")
+    geopend: bool = Field(
+        ...,
+        description="Het bericht is door de geadresseerde geopend of nog niet geopend",
+    )
+    bericht_type: Literal[
+        "notificatie", "betaalverzoek", "uitnodiging", "verzoek", "TODO"
+    ] = Field(..., description="Type bericht")
+    identificatie: Identificatie = Field(..., description="TODO")
+    # TODO: Should be AnyUrl
+    bijlages: List[str] = Field(
+        ...,
+        description="TODO",
+        examples=[["https://documenten.nl/api/v1/enkelvoudiginformatieobjecten/1"]],
+    )

src/open_inwoner/berichten/services.py

@@ -0,0 +1,66 @@
+import datetime
+from typing import Literal
+
+from objectsapiclient.client import Client as ObjectenClient
+from objectsapiclient.models import Configuration
+
+from open_inwoner.berichten.api_models import Bericht
+
+
+class BerichtenService:
+
+    client: ObjectenClient
+
+    def __init__(self, client: ObjectenClient | None = None):
+        self.client = client or Configuration.get_solo().client
+
+    def fetch_berichten_for_bsn(self, bsn: str):
+        return self.fetch_berichten_for_identificatie("bsn", bsn)
+
+    def fetch_berichten_for_kvk(self, kvk: str):
+        return self.fetch_berichten_for_identificatie("kvk", kvk)
+
+    def fetch_berichten_for_identificatie(
+        self, identificatie_type: Literal["bsn", "kvk"], identificatie_value: str
+    ):
+        objects = self.client.get_objects(
+            object_type_uuid="98b9b5dd-9c2c-44ba-b5bf-13edaed668f9",
+            data_attrs=[
+                f"identificatie__type__exact__{identificatie_type}",
+                f"identificatie__value__exact__{identificatie_value}",
+            ],
+        )
+
+        return [
+            Bericht.model_validate(obj.record["data"] | {"object_uuid": obj.uuid})
+            for obj in objects
+        ]
+
+    def fetch_bericht(self, uuid: str):
+        obj = self.client.get_object(uuid)
+
+        return Bericht.model_validate(obj.record["data"] | {"object_uuid": obj.uuid})
+
+    def update_object(self, uuid: str, updated_data: dict):
+
+        # TODO: the PATCH method in the Objects API does not appear to work as
+        # expected. It validates the partial against the JSON Schema, so in this
+        # case you have to supply an object that is valid according to the
+        # schema. We thus have to do our own merging.
+
+        # Also: we are usign the underlying API directly to avoid going back and
+        # forth between camel and snake case.
+        existing_obj = self.client.objects_api.retrieve("object", uuid=uuid)
+        existing_data = existing_obj["record"]["data"]
+        self.client.objects_api.partial_update(
+            "object",
+            {
+                "record": {
+                    "startAt": datetime.date.today().isoformat(),
+                    "data": existing_data | updated_data,
+                }
+            },
+            uuid=uuid,
+        )
+        # Refresh the object and build the Bericht model
+        return self.client.get_object(uuid)