udata 9.0.1.dev29468__py2.py3-none-any.whl → 9.0.1.dev29504__py2.py3-none-any.whl

udata/api_fields.py

@@ -96,6 +96,7 @@ def generate_fields(**kwargs):
         read_fields = {}
         write_fields = {}
         sortables = []
+        filterables = []
 
         read_fields['id'] = restx_fields.String(required=True)
 
@@ -106,6 +107,23 @@ def generate_fields(**kwargs):
             if info.get('sortable', False):
                 sortables.append(key)
 
+            filterable = info.get('filterable', None)
+            if filterable is not None:
+                if 'key' not in filterable:
+                    filterable['key'] = key
+                if 'column' not in filterable:
+                    filterable['column'] = key
+
+                if 'constraints' not in filterable:
+                    filterable['constraints'] = []
+                    if isinstance(field, mongo_fields.ReferenceField) or (isinstance(field, mongo_fields.ListField) and isinstance(field.field, mongo_fields.ReferenceField)):
+                        filterable['constraints'].append('objectid')
+
+                # We may add more information later here:
+                # - type of mongo query to execute (right now only simple =)
+
+                filterables.append(filterable)
+
             read, write = convert_db_to_field(key, field)
 
             if read:
@@ -159,6 +177,9 @@ def generate_fields(**kwargs):
             choices = sortables + ['-' + k for k in sortables]
             parser.add_argument('sort', type=str, location='args', choices=choices, help='The field (and direction) on which sorting apply')
 
+        for filterable in filterables:
+            parser.add_argument(filterable['key'], type=str, location='args')
+
         cls.__index_parser__ = parser
         def apply_sort_filters_and_pagination(base_query):
             args = cls.__index_parser__.parse_args()
@@ -166,6 +187,16 @@ def generate_fields(**kwargs):
             if sortables and args['sort']:
                 base_query = base_query.order_by(args['sort'])
 
+            for filterable in filterables:
+                if args.get(filterable['key']):
+                    for constraint in filterable['constraints']:
+                        if constraint == 'objectid' and not ObjectId.is_valid(args[filterable['key']]):
+                            api.abort(400, f'`{filterable["key"]}` must be an identifier')
+
+                    base_query = base_query.filter(**{
+                        filterable['column']: args[filterable['key']],
+                    })
+
             if paginable:
                 base_query = base_query.paginate(args['page'], args['page_size'])
 

udata/core/dataservices/models.py

@@ -113,7 +113,10 @@ class Dataservice(WithMetrics, Owned, db.Document):
                 db.ReferenceField(Dataset),
                 nested_fields=datasets_api_fields.dataset_fields,
             )
-        )
+        ),
+        filterable={
+            'key': 'dataset',
+        },
     )
 
     @function_field(description="Link to the API endpoint for this dataservice")

udata/harvest/api.py

@@ -1,3 +1,4 @@
+from bson import ObjectId
 from werkzeug.exceptions import BadRequest
 from flask import request
 
@@ -190,6 +191,10 @@ class SourcesAPI(API):
     def get(self):
         '''List all harvest sources'''
         args = source_parser.parse_args()
+
+        if args.get('owner') and not ObjectId.is_valid(args.get('owner')):
+            api.abort(400, '`owner` arg must be an identifier')
+
         return actions.paginate_sources(args.get('owner'),
                                         page=args['page'],
                                         page_size=args['page_size'],

udata/tests/api/test_dataservices_api.py

@@ -85,23 +85,30 @@ class DataserviceAPITest(APITestCase):
 
 
     def test_dataservice_api_index(self):
+        dataset_a = DatasetFactory()
+        dataset_b = DatasetFactory()
+
         self.login()
         self.post(url_for('api.dataservices'), {
             'title': 'B',
             'base_api_url': 'https://example.org/B',
+            'datasets': [dataset_b.id],
         })
         self.post(url_for('api.dataservices'), {
             'title': 'C',
             'base_api_url': 'https://example.org/C',
+            'datasets': [dataset_a.id, dataset_b.id],
         })
         self.post(url_for('api.dataservices'), {
             'title': 'A',
             'base_api_url': 'https://example.org/A',
+            'datasets': [dataset_a.id],
         })
-        response = self.post(url_for('api.dataservices'), {
+        self.post(url_for('api.dataservices'), {
             'title': 'X',
             'base_api_url': 'https://example.org/X',
             'private': True,
+            'datasets': [dataset_a.id],
         })
 
         self.assertEqual(Dataservice.objects.count(), 4)
@@ -115,8 +122,12 @@ class DataserviceAPITest(APITestCase):
         self.assertEqual(response.json['total'], 3)
         self.assertEqual(len(response.json['data']), 3)
         self.assertEqual(response.json['data'][0]['title'], 'B')
+        self.assertEqual(response.json['data'][0]['datasets'][0]['id'], str(dataset_b.id))
         self.assertEqual(response.json['data'][1]['title'], 'C')
+        self.assertEqual(response.json['data'][1]['datasets'][0]['id'], str(dataset_a.id))
+        self.assertEqual(response.json['data'][1]['datasets'][1]['id'], str(dataset_b.id))
         self.assertEqual(response.json['data'][2]['title'], 'A')
+        self.assertEqual(response.json['data'][2]['datasets'][0]['id'], str(dataset_a.id))
 
         response = self.get(url_for('api.dataservices', sort='title'))
         self.assert200(response)
@@ -153,6 +164,20 @@ class DataserviceAPITest(APITestCase):
         self.assertEqual(len(response.json['data']), 1)
         self.assertEqual(response.json['data'][0]['title'], 'B')
 
+        response = self.get(url_for('api.dataservices', sort='title', dataset=str(dataset_a.id)))
+        self.assert200(response)
+
+        self.assertEqual(response.json['total'], 2)
+        self.assertEqual(response.json['data'][0]['title'], 'A')
+        self.assertEqual(response.json['data'][0]['datasets'][0]['id'], str(dataset_a.id))
+        self.assertEqual(response.json['data'][1]['title'], 'C')
+        self.assertEqual(response.json['data'][1]['datasets'][0]['id'], str(dataset_a.id))
+        self.assertEqual(response.json['data'][1]['datasets'][1]['id'], str(dataset_b.id))
+
+    def test_dataservice_api_index_with_wrong_dataset_id(self):
+        response = self.get(url_for('api.dataservices', sort='title', dataset=str("xxx")))
+        self.assert400(response)
+
     def test_dataservice_api_create_with_validation_error(self):
         self.login()
         response = self.post(url_for('api.dataservices'), {

{udata-9.0.1.dev29468.dist-info → udata-9.0.1.dev29504.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 9.0.1.dev29468
+Version: 9.0.1.dev29504
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -138,8 +138,10 @@ It is collectively taken care of by members of the
 ## Current (in progress)
 
 - Refactor catalog exports [#3052](https://github.com/opendatateam/udata/pull/3052)
+- Add a filter to filter dataservices by dataset [#3056](https://github.com/opendatateam/udata/pull/3056)
 - Fix reuses' datasets references [#3057](https://github.com/opendatateam/udata/pull/3057)
 - Save and show harvest logs [#3053](https://github.com/opendatateam/udata/pull/3053)
+- Fix missing `ObjectId` validation on `/sources` endpoint [#3060](https://github.com/opendatateam/udata/pull/3060)
 
 ## 9.0.0 (2024-06-07)
 

{udata-9.0.1.dev29468.dist-info → udata-9.0.1.dev29504.dist-info}/RECORD

@@ -1,7 +1,7 @@
 tasks/__init__.py,sha256=CnVhb_TV-6nMhxVR6itnBmvuU2OSCs02AfNB4irVBTE,8132
 tasks/helpers.py,sha256=k_HiuiEJNgQLvWdeHqczPOAcrYpFjEepBeKo7EQzY8M,994
 udata/__init__.py,sha256=SslifvQytly1ztvHCc4bdlP3Va1F5UV60hSJC6a_guk,101
-udata/api_fields.py,sha256=myHkndhedV3g9cn2FWBu1Hx24Fy-fxaGedEP1ZMOoi0,11506
+udata/api_fields.py,sha256=PMD206aJmntO4wizzL5Bv9_qU3HivAHRNO9ypV4nlXg,12959
 udata/app.py,sha256=6upwrImLaWrSYtsXPW1zH84_oRxp3B6XFuocMe2D6NU,7329
 udata/assets.py,sha256=aMa-MnAEXVSTavptSn2V8sUE6jL_N0MrYCQ6_QpsuHs,645
 udata/entrypoints.py,sha256=8bZUvZ8ICO3kZxa8xDUaen6YS_OAGNKHFvaD7d8BOk0,2687
@@ -80,7 +80,7 @@ udata/core/contact_point/forms.py,sha256=ggLhSJ1IRn5MclrhydckjAxwr4fFZxgAD4huSSu
 udata/core/contact_point/models.py,sha256=NlNKureCpzgTLJuGviZPjNx-ABYRp4j2L-ur9Gmixao,324
 udata/core/dataservices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/dataservices/api.py,sha256=rjCU55NNGgCDRlurfhJUT2byBGJWN5coM8b7AApzEew,3090
-udata/core/dataservices/models.py,sha256=6cE7tQ6GahnFaz1U_8yNmJqlCzoHQxZdet4qXQaqa7k,4449
+udata/core/dataservices/models.py,sha256=rCJW_Bh9Ovc5oL_RH69nyexRYH_JPpudCT_L-RKzsvc,4512
 udata/core/dataservices/permissions.py,sha256=X9Bh8e0pnx6OgeEf6NowXZUiwyreUa6UY479B16cCqs,175
 udata/core/dataservices/tasks.py,sha256=NOWcTPoLasMrrvq9EkwQMGlUbQQmi_l3s815K-mtZTM,971
 udata/core/dataset/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -267,7 +267,7 @@ udata/frontend/csv.py,sha256=SDV8GMhNpHyE9NYy9cfHulsFUzwclfc7roWAAm-PZ9M,8257
 udata/frontend/markdown.py,sha256=41bOiU6AKng4U-5v3otBed3dyCu63NI9fnznUQThbIk,4377
 udata/harvest/__init__.py,sha256=C4y5w4vGb_F9Opy62lzV3eHo4DkNyRgPCq-wsarPXiQ,28
 udata/harvest/actions.py,sha256=6f9bkIITLHes0vGU-yioRGfFOghAS3nXThXEVKaHFpA,10082
-udata/harvest/api.py,sha256=dK-3useKbaKtZL3NL6R0mPgeuPHBruPK958oeXxqg_Y,14378
+udata/harvest/api.py,sha256=GDFqjAyKh4a22QDniyZZC9AyTFi4ndhS94VzW6plBZE,14545
 udata/harvest/commands.py,sha256=Vo1KxO7GAOgQ87khqlGIyjZIlwAOlQ8ztadqmWdMvwk,4922
 udata/harvest/csv.py,sha256=c2fPnMB6q99wRxLncl8L0ILcdF4SI8Lsl8tViNrcW6A,396
 udata/harvest/exceptions.py,sha256=YaXw0ESmSCcibfUmP5uc1uRedKD2mvUBXUOnbaSXtNw,299
@@ -590,7 +590,7 @@ udata/tests/api/__init__.py,sha256=gIIB9OPiSs1A-u1bEIHlOesaCQzJ08SOLPuJd34LesE,1
 udata/tests/api/test_auth_api.py,sha256=3Zhn2A29poZIcCJ_R9_-LkR3xOFUTw1aTquiZVXQ2F0,20306
 udata/tests/api/test_base_api.py,sha256=DRX5nuFIj51GFmMIAxUzoW1yiq1apNgr1vS4U4agzeg,2319
 udata/tests/api/test_contact_points.py,sha256=MJm8B06iaUqIZCqxll3NViFwUCxwqZZ4u9e9s1h8MgU,1056
-udata/tests/api/test_dataservices_api.py,sha256=eIo0b18BSSRocyf9pTChzDnKotxxLMq8R1tX53JdH_M,9743
+udata/tests/api/test_dataservices_api.py,sha256=51NU5d4iqfJT8iiyi0aLdWXDqZLvmyD-qh-Sflk9Lsg,11122
 udata/tests/api/test_datasets_api.py,sha256=zqRtC61NvYUNum4kBTjA1W87JAIobA4k564rm-U6c98,81704
 udata/tests/api/test_fields.py,sha256=OW85Z5MES5HeWOpapeem8OvR1cIcrqW-xMWpdZO4LZ8,1033
 udata/tests/api/test_follow_api.py,sha256=0h54P_Dfbo07u6tg0Rbai1WWgWb19ZLN2HGv4oLCWfg,3383
@@ -685,9 +685,9 @@ udata/translations/pt/LC_MESSAGES/udata.mo,sha256=uttB2K8VsqzkEQG-5HfTtFms_3LtV9
 udata/translations/pt/LC_MESSAGES/udata.po,sha256=8Ql1Lp7Z9KLnvp-qRxw-NhFu1p35Xj-q6Jg9JHsYhcw,43733
 udata/translations/sr/LC_MESSAGES/udata.mo,sha256=US8beNIMPxP5h-zD_jfP1TheDDd4DdRVS5UIiY5XVZ8,28553
 udata/translations/sr/LC_MESSAGES/udata.po,sha256=TM0yMDvKRljyOzgZZMlTX6OfpF6OC4Ngf_9Zc8n6ayA,50313
-udata-9.0.1.dev29468.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-udata-9.0.1.dev29468.dist-info/METADATA,sha256=eUDNQF9Yl-zU7kLY9aCI32D0i3m3rIMjrBH53m_I6BE,124274
-udata-9.0.1.dev29468.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-udata-9.0.1.dev29468.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
-udata-9.0.1.dev29468.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
-udata-9.0.1.dev29468.dist-info/RECORD,,
+udata-9.0.1.dev29504.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+udata-9.0.1.dev29504.dist-info/METADATA,sha256=4pr78Vn0p9iHB9HmYAtWWp6mw6yOqRuvdlFg40cmuWg,124496
+udata-9.0.1.dev29504.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+udata-9.0.1.dev29504.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
+udata-9.0.1.dev29504.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
+udata-9.0.1.dev29504.dist-info/RECORD,,