[#2798] Integrate objects API to fetch external tasks ("externe taken")

Author: alextreme

requirements/base.in

@@ -94,6 +94,7 @@ git+https://github.com/maykinmedia/django-celery-monitor@74b1252#egg=django_cele
 zgw-consumers
 zgw-consumers-oas
 notifications-api-common
+git+https://github.com/maykinmedia/objects-api-client-django.git#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.20
     #   mozilla-django-oidc-db
     #   notifications-api-common
     #   sentry-sdk
+    #   objects-api-client-django
     #   zgw-consumers
     #   zgw-consumers-oas
 django-admin-index==3.1.0
@@ -274,6 +277,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==4.0.0
     # via -r requirements/base.in
@@ -344,9 +348,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
@@ -417,6 +419,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
+    # via -r requirements/base.in
 odfpy==1.4.1
     # via tablib
 openpyxl==3.0.9
@@ -523,6 +527,7 @@ requests==2.31.0
     #   maykin-python3-saml
     #   messagebird
     #   mozilla-django-oidc
+    #   objects-api-client-django
     #   zgw-consumers
 ruamel-yaml==0.18.10
     # via django-setup-configuration
@@ -551,9 +556,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
@@ -614,6 +617,7 @@ zgw-consumers==0.36.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.20
     #   mozilla-django-oidc-db
     #   notifications-api-common
     #   sentry-sdk
+    #   objects-api-client-django
     #   zgw-consumers
     #   zgw-consumers-oas
 django-admin-index==3.1.0
@@ -462,6 +468,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==4.0.0
     # via
@@ -482,7 +489,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
@@ -558,7 +564,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
@@ -612,7 +617,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
@@ -771,6 +775,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
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
 odfpy==1.4.1
     # via
     #   -c requirements/base.txt
@@ -989,6 +997,7 @@ requests==2.31.0
     #   maykin-python3-saml
     #   messagebird
     #   mozilla-django-oidc
+    #   objects-api-client-django
     #   requests-mock
     #   sphinx
     #   zgw-consumers
@@ -1079,7 +1088,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
@@ -1197,6 +1205,7 @@ zgw-consumers==0.36.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.20
     #   mozilla-django-oidc-db
     #   notifications-api-common
     #   sentry-sdk
+    #   objects-api-client-django
     #   zgw-consumers
     #   zgw-consumers-oas
 django-admin-index==3.1.0
@@ -508,6 +514,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==4.0.0
     # via
@@ -528,7 +535,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
@@ -606,7 +612,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
@@ -673,7 +678,6 @@ fonttools[woff]==4.43.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-    #   fonttools
     #   weasyprint
 freezegun==1.1.0
     # via
@@ -879,6 +883,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
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
 odfpy==1.4.1
     # via
     #   -c requirements/ci.txt
@@ -1139,6 +1147,7 @@ requests==2.31.0
     #   maykin-python3-saml
     #   messagebird
     #   mozilla-django-oidc
+    #   objects-api-client-django
     #   requests-mock
     #   sphinx
     #   zgw-consumers
@@ -1273,7 +1282,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
@@ -1420,6 +1428,7 @@ zgw-consumers==0.36.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/cms/plugins/cms_plugins/__init__.py

@@ -1,9 +1,11 @@
 from .appointments import UserAppointmentsPlugin
+from .tasks import TasksPlugin
 from .userfeed import UserFeedPlugin
 from .videoplayer import VideoPlayerPlugin
 
 __all__ = [
     "UserAppointmentsPlugin",
     "UserFeedPlugin",
+    "TasksPlugin",
     "VideoPlayerPlugin",
 ]

src/open_inwoner/cms/plugins/cms_plugins/tasks.py

@@ -0,0 +1,63 @@
+from django.utils.translation import gettext as _
+
+from cms.plugin_base import CMSPluginBase
+from cms.plugin_pool import plugin_pool
+
+from objectsapiclient.models import Configuration
+
+from ..models import TasksConfig
+
+
+@plugin_pool.register_plugin
+class TasksPlugin(CMSPluginBase):
+    """
+    Uses the Objects API to retrieve and show tasks according to the MijnTaken Objecttypes schema
+    Reuses the UserFeedPlugin template
+    """
+
+    model = TasksConfig
+    name = _("Task list Plugin")
+    render_template = "cms/plugins/tasks/tasks.html"
+    cache = False
+
+    def render(self, context, instance, placeholder):
+        request = context["request"]
+        context["instance"] = instance
+        context["tasks"] = []
+
+        if not request.user.is_authenticated or not (bsn := request.user.bsn):
+            return context
+
+        task_objects = self.get_tasks_by_bsn(user_bsn=bsn)
+        tasks = []
+        for obj in task_objects:
+            task_dict = obj.record["data"]
+            task_dict["task_url"] = obj.url
+            tasks.append(task_dict)
+        context["tasks"] = tasks
+
+        return context
+
+    def get_tasks(self):
+        objects_client = Configuration.get_solo().client
+        return [
+            obj
+            for obj in objects_client.get_objects(
+                object_type_uuid=self.model.object_type
+            )
+        ]
+
+    def get_tasks_by_bsn(self, user_bsn):
+        tasks = []
+        for task in self.get_tasks():
+            data = task.record["data"]
+            identificatie = data["identificatie"]
+
+            if not identificatie or identificatie["type"] != "bsn":
+                continue
+
+            task_bsn = identificatie["value"]
+            if task_bsn and task_bsn == user_bsn:
+                tasks += [task]
+
+        return tasks

src/open_inwoner/cms/plugins/migrations/0006_tasksconfig.py

@@ -0,0 +1,53 @@
+# Generated by Django 4.2.16 on 2024-10-06 13:07
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+import objectsapiclient.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("plugins", "0005_userappointments"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="TasksConfig",
+            fields=[
+                (
+                    "cmsplugin_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        related_name="%(app_label)s_%(class)s",
+                        serialize=False,
+                        to="cms.cmsplugin",
+                    ),
+                ),
+                (
+                    "title",
+                    models.CharField(
+                        default="Mijn Taken",
+                        help_text="The title of the tasks block",
+                        max_length=250,
+                        verbose_name="Title",
+                    ),
+                ),
+                (
+                    "object_type",
+                    objectsapiclient.models.ObjectTypeField(
+                        db_index=False, max_length=100
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("cms.cmsplugin",),
+        ),
+    ]

src/open_inwoner/cms/plugins/models/__init__.py

@@ -1,9 +1,11 @@
 from .appointments import UserAppointments
+from .tasks import TasksConfig
 from .userfeed import UserFeed
 from .videoplayer import VideoPlayer
 
 __all__ = [
     "UserAppointments",
     "UserFeed",
+    "TasksConfig",
     "VideoPlayer",
 ]