udata 9.1.4.dev31143__py2.py3-none-any.whl → 9.1.4.dev31168__py2.py3-none-any.whl

udata/core/activity/api.py

@@ -1,5 +1,6 @@
 import logging
 
+from bson import ObjectId
 from mongoengine.errors import DoesNotExist
 
 from udata.api import API, api, fields
@@ -61,13 +62,19 @@ activity_parser.add_argument(
     help="Filter activities for that particular organization",
     location="args",
 )
+activity_parser.add_argument(
+    "related_to",
+    type=str,
+    help="Filter activities for that particular object id (ex : reuse, dataset, etc.)",
+    location="args",
+)
 
 
 @api.route("/activity", endpoint="activity")
 class SiteActivityAPI(API):
     @api.doc("activity")
     @api.expect(activity_parser)
-    @api.marshal_list_with(activity_page_fields)
+    @api.marshal_with(activity_page_fields)
     def get(self):
         """Fetch site activity, optionally filtered by user of org."""
         args = activity_parser.parse_args()
@@ -79,6 +86,12 @@ class SiteActivityAPI(API):
         if args["user"]:
             qs = qs(actor=args["user"])
 
+        if args["related_to"]:
+            if not ObjectId.is_valid(args["related_to"]):
+                api.abort(400, "`related_to` arg must be an identifier")
+
+            qs = qs(related_to=args["related_to"])
+
         qs = qs.order_by("-created_at")
         qs = qs.paginate(args["page"], args["page_size"])
 

udata/tests/api/test_activities_api.py

@@ -0,0 +1,69 @@
+import pytest
+from flask import url_for
+from werkzeug.test import TestResponse
+
+from udata.core.activity.models import Activity
+from udata.core.dataset.factories import DatasetFactory
+from udata.core.dataset.models import Dataset
+from udata.core.reuse.factories import ReuseFactory
+from udata.core.reuse.models import Reuse
+from udata.core.user.factories import UserFactory
+from udata.mongo import db
+from udata.tests.helpers import assert200, assert400
+
+pytestmark = [
+    pytest.mark.usefixtures("clean_db"),
+]
+
+
+class FakeDatasetActivity(Activity):
+    key = "fakeDataset"
+    related_to = db.ReferenceField(Dataset, required=True)
+
+
+class FakeReuseActivity(Activity):
+    key = "fakeReuse"
+    related_to = db.ReferenceField(Reuse, required=True)
+
+
+class ActivityAPITest:
+    modules = []
+
+    def test_activity_api_list(self, api) -> None:
+        """It should fetch an activity list from the API"""
+        activities: list[Activity] = [
+            FakeDatasetActivity.objects.create(actor=UserFactory(), related_to=DatasetFactory()),
+            FakeReuseActivity.objects.create(actor=UserFactory(), related_to=ReuseFactory()),
+        ]
+
+        response: TestResponse = api.get(url_for("api.activity"))
+        assert200(response)
+        assert len(response.json["data"]) == len(activities)
+
+    def test_activity_api_list_filter_by_bogus_related_to(self, api) -> None:
+        """It should return a 400 error if the `related_to` parameter isn't a valid ObjectId."""
+        response: TestResponse = api.get(url_for("api.activity", related_to="foobar"))
+        assert400(response)
+
+    def test_activity_api_list_filtered_by_related_to(self, api) -> None:
+        """It should only return activities that correspond to the `related_to` parameter."""
+        dataset1: Dataset = DatasetFactory()
+        dataset2: Dataset = DatasetFactory()
+        reuse: Reuse = ReuseFactory()
+        _activities: list[Activity] = [
+            FakeDatasetActivity.objects.create(actor=UserFactory(), related_to=dataset1),
+            FakeDatasetActivity.objects.create(actor=UserFactory(), related_to=dataset1),
+            FakeDatasetActivity.objects.create(actor=UserFactory(), related_to=dataset2),
+            FakeReuseActivity.objects.create(actor=UserFactory(), related_to=reuse),
+        ]
+
+        response: TestResponse = api.get(url_for("api.activity", related_to=dataset1.id))
+        assert200(response)
+        len(response.json["data"]) == 2
+        assert response.json["data"][0]["related_to"] == dataset1.title
+        assert response.json["data"][1]["related_to"] == dataset1.title
+
+        response: TestResponse = api.get(url_for("api.activity", related_to=reuse.id))
+        assert200(response)
+        len(response.json["data"]) == 1
+        assert response.json["data"][0]["related_to"] == reuse.title

{udata-9.1.4.dev31143.dist-info → udata-9.1.4.dev31168.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 9.1.4.dev31143
+Version: 9.1.4.dev31168
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -145,6 +145,7 @@ It is collectively taken care of by members of the
 - Convert reuse to new API system [#3066](https://github.com/opendatateam/udata/pull/3066)
 - Fix circular import error [#3128](https://github.com/opendatateam/udata/pull/3128)
 - Add an option to specify the port when using `inv serve` [#3123](https://github.com/opendatateam/udata/pull/3123)
+- Add a new `related_to` filter parameter to the activities API endpoint [#3127](https://github.com/opendatateam/udata/pull/3127)
 
 ## 9.1.3 (2024-08-01)
 

{udata-9.1.4.dev31143.dist-info → udata-9.1.4.dev31168.dist-info}/RECORD

@@ -56,7 +56,7 @@ udata/commands/tests/test_fixtures.py,sha256=kFwqWA3Ha0mnCR5EE5aPz6jv3hfPheuwOMY
 udata/core/__init__.py,sha256=O7C9WWCXiLWnWPnPbFRszWhOmvRQiI4gD-5qkWvPGRo,385
 udata/core/owned.py,sha256=UEg5tp-ZunzC2avCdholpqibDIUZgFBsXS7BEcdnBy0,4567
 udata/core/activity/__init__.py,sha256=OaiFyq7HB4xL4SuMPD1N8IFNpntwx9ZayVzelciOieI,298
-udata/core/activity/api.py,sha256=blVYf3unQbkYbm8FY7jv0w7_W52Frghmj2vYATh9Tsc,3445
+udata/core/activity/api.py,sha256=QFSLSVf65f-jz0dyVuMqaXm6qB4m-YlGnjqK33suwI8,3854
 udata/core/activity/models.py,sha256=Ln9YUsdCBMFmUlw5GA2gIJ50sMorMFzZGo8u8sy7pIE,2072
 udata/core/activity/signals.py,sha256=Io2A43as3yR-DZ5R3wzM_bTpn528pxWsZDUFZ9xtj2Y,191
 udata/core/activity/tasks.py,sha256=lEnISnHXPMeeErWIhJbSYOlxnrc6yAKC-T28qTEWQn0,1235
@@ -597,6 +597,7 @@ udata/tests/test_transfer.py,sha256=_0pBwYs3T7OSZ7bO3KmQ81SjwCJyT4EVf8YYHXOkwdk,
 udata/tests/test_uris.py,sha256=MxafZ0SyzSNRomVpZnH1ChzWaHOi1MQiXe1gmKnBc6o,8517
 udata/tests/test_utils.py,sha256=3BGnlvw-GOE6tLHQteo-uUeYuzq4rsjePOuytFGkpOg,7967
 udata/tests/api/__init__.py,sha256=y4sL7LD1-KwONHF0q_Rhk2W6BmGUlp7Uz2JnX3e27sk,1218
+udata/tests/api/test_activities_api.py,sha256=RjDDeNle3T-ydVnh6BRypqxAE_244-DXaKkuUCT0HVU,2823
 udata/tests/api/test_auth_api.py,sha256=0Y_JXQ4x8jvc_pp4g3H6gZ_X0QVGM6TaZ2IN9LeOWEg,21657
 udata/tests/api/test_base_api.py,sha256=2w_vz0eEuq3P3aN-ByvxGc3VZAo7XtgatFfcrzf2uEU,2244
 udata/tests/api/test_contact_points.py,sha256=pyakkKnM4lH_asuEoXq9lQyJC9to6ZxSp4QQrHh1c1U,1041
@@ -696,9 +697,9 @@ udata/translations/pt/LC_MESSAGES/udata.mo,sha256=WpPzAqVd2Onv_kz45ULUySKPLrpjcc
 udata/translations/pt/LC_MESSAGES/udata.po,sha256=18Op9RUITewoDRewlOdYzzq6gjsf1lsvepACV1d7zxs,44976
 udata/translations/sr/LC_MESSAGES/udata.mo,sha256=NIYRNhVoETZUvIvWm3cCW7DtMBAnS2vXzZjMF5ZzD_c,28500
 udata/translations/sr/LC_MESSAGES/udata.po,sha256=rQB-4V4WJ7bURj6g2j653vItr5TMHadcLQxec7_fDmg,51545
-udata-9.1.4.dev31143.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-udata-9.1.4.dev31143.dist-info/METADATA,sha256=cmYTKnza6rM9zflVa1Wbm7oSsIaxzVpHMVD87-hNuUY,128887
-udata-9.1.4.dev31143.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-udata-9.1.4.dev31143.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
-udata-9.1.4.dev31143.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
-udata-9.1.4.dev31143.dist-info/RECORD,,
+udata-9.1.4.dev31168.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+udata-9.1.4.dev31168.dist-info/METADATA,sha256=YZ2NedcM5hDUSpvuREmEnsk_Fr0O4r5Ftx1CXTD_eI0,129017
+udata-9.1.4.dev31168.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+udata-9.1.4.dev31168.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
+udata-9.1.4.dev31168.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
+udata-9.1.4.dev31168.dist-info/RECORD,,