udata 10.0.1.dev32359__py2.py3-none-any.whl → 10.0.1.dev32405__py2.py3-none-any.whl

udata/api_fields.py

@@ -94,6 +94,8 @@ def convert_db_to_field(key, field, info) -> tuple[Callable | None, Callable | N
         params["min_length"] = field.min_length
         params["max_length"] = field.max_length
         params["enum"] = field.choices
+        if field.validation:
+            params["validation"] = validation_to_type(field.validation)
     elif isinstance(field, mongo_fields.ObjectIdField):
         constructor = restx_fields.String
     elif isinstance(field, mongo_fields.FloatField):
@@ -287,7 +289,7 @@ def generate_fields(**kwargs) -> Callable:
                 if not isinstance(
                     field, mongo_fields.ReferenceField | mongo_fields.LazyReferenceField
                 ):
-                    raise Exception("Cannot use additional_filters on not a ref.")
+                    raise Exception("Cannot use additional_filters on a field that is not a ref.")
 
                 ref_model: db.Document = field.document_type
 
@@ -678,9 +680,34 @@ def compute_filter(column: str, field, info, filterable) -> dict:
             filterable["type"] = boolean
         else:
             filterable["type"] = str
+    if field.validation:
+        filterable["type"] = validation_to_type(field.validation)
 
     filterable["choices"] = info.get("choices", None)
     if hasattr(field, "choices") and field.choices:
         filterable["choices"] = field.choices
 
     return filterable
+
+
+def validation_to_type(validation: Callable) -> Callable:
+    """Convert a mongo field's validation function to a ReqParser's type.
+
+    In flask_restx.ReqParser, validation is done by setting the param's type to
+    a callable that will either raise, or return the parsed value.
+
+    In mongo, a field's validation function cannot return anything, so this
+    helper wraps the mongo field's validation to return the value if it validated.
+    """
+    from udata.models import db
+
+    def wrapper(value: str) -> str:
+        try:
+            validation(value)
+        except db.ValidationError:
+            raise
+        return value
+
+    wrapper.__schema__ = {"type": "string", "format": "my-custom-format"}
+
+    return wrapper

udata/core/badges/tests/test_model.py

@@ -15,8 +15,13 @@ BADGES = {
 }
 
 
+def validate_badge(value):
+    if value not in Fake.__badges__.keys():
+        raise db.ValidationError("Unknown badge type")
+
+
 class FakeBadge(Badge):
-    kind = db.StringField(required=True, choices=list(BADGES.keys()))
+    kind = db.StringField(required=True, validation=validate_badge)
 
 
 class FakeBadgeMixin(BadgeMixin):
@@ -34,12 +39,6 @@ class BadgeMixinTest(DBTestMixin, TestCase):
         fake = Fake.objects.create()
         self.assertIsInstance(fake.badges, (list, tuple))
 
-    def test_choices(self):
-        """It should have a choice list on the badge field."""
-        self.assertEqual(
-            Fake._fields["badges"].field.document_type.kind.choices, list(Fake.__badges__.keys())
-        )
-
     def test_get_badge_found(self):
         """It allow to get a badge by kind if present"""
         fake = Fake.objects.create()
@@ -155,3 +154,19 @@ class BadgeMixinTest(DBTestMixin, TestCase):
         with self.assertRaises(db.ValidationError):
             fake = Fake.objects.create()
             fake.add_badge("unknown")
+
+    def test_validation(self):
+        """It should validate default badges as well as extended ones"""
+        # Model badges can be extended in plugins, for example in udata-front
+        # for french only badges.
+        Fake.__badges__["new"] = "new"
+
+        fake = FakeBadge(kind="test")
+        fake.validate()
+
+        fake = FakeBadge(kind="new")
+        fake.validate()
+
+        with self.assertRaises(db.ValidationError):
+            fake = FakeBadge(kind="doesnotexist")
+            fake.validate()

udata/core/dataservices/models.py

@@ -128,6 +128,7 @@ class Dataservice(WithMetrics, Owned, db.Document):
     description = field(db.StringField(default=""), description="In markdown")
     base_api_url = field(db.URLField(), sortable=True)
     endpoint_description_url = field(db.URLField())
+    business_documentation_url = field(db.URLField())
     authorization_request_url = field(db.URLField())
     availability = field(db.FloatField(min=0, max=100), example="99.99")
     rate_limiting = field(db.StringField())

udata/core/dataset/models.py

@@ -521,8 +521,13 @@ class Resource(ResourceMixin, WithMetrics, db.EmbeddedDocument):
         self.dataset.save(*args, **kwargs)
 
 
+def validate_badge(value):
+    if value not in Dataset.__badges__.keys():
+        raise db.ValidationError("Unknown badge type")
+
+
 class DatasetBadge(Badge):
-    kind = db.StringField(required=True, choices=list(BADGES.keys()))
+    kind = db.StringField(required=True, validation=validate_badge)
 
 
 class DatasetBadgeMixin(BadgeMixin):

udata/core/organization/models.py

@@ -95,8 +95,13 @@ class OrganizationQuerySet(db.BaseQuerySet):
         return self(badges__kind=kind)
 
 
+def validate_badge(value):
+    if value not in Organization.__badges__.keys():
+        raise db.ValidationError("Unknown badge type")
+
+
 class OrganizationBadge(Badge):
-    kind = db.StringField(required=True, choices=list(BADGES.keys()))
+    kind = db.StringField(required=True, validation=validate_badge)
 
 
 class OrganizationBadgeMixin(BadgeMixin):

udata/core/reuse/models.py

@@ -35,8 +35,13 @@ def check_url_does_not_exists(url):
         raise FieldValidationError(_("This URL is already registered"), field="url")
 
 
+def validate_badge(value):
+    if value not in Reuse.__badges__.keys():
+        raise db.ValidationError("Unknown badge type")
+
+
 class ReuseBadge(Badge):
-    kind = db.StringField(required=True, choices=list(BADGES.keys()))
+    kind = db.StringField(required=True, validation=validate_badge)
 
 
 class ReuseBadgeMixin(BadgeMixin):

udata/tests/organization/test_organization_model.py

@@ -4,10 +4,10 @@ import udata.core.organization.constants as org_constants
 from udata.core.dataset.factories import DatasetFactory, HiddenDatasetFactory
 from udata.core.followers.signals import on_follow, on_unfollow
 from udata.core.organization.factories import OrganizationFactory
-from udata.core.organization.models import Organization
+from udata.core.organization.models import Organization, OrganizationBadge
 from udata.core.reuse.factories import ReuseFactory, VisibleReuseFactory
 from udata.core.user.factories import UserFactory
-from udata.models import Dataset, Follow, Member, Reuse
+from udata.models import Dataset, Follow, Member, Reuse, db
 from udata.tests.helpers import assert_emit
 
 from .. import DBTestMixin, TestCase
@@ -71,3 +71,21 @@ class OrganizationModelTest(TestCase, DBTestMixin):
         associations = list(Organization.objects.with_badge(org_constants.ASSOCIATION))
         assert len(associations) == 1
         assert org_certified_association in associations
+
+
+class OrganizationBadgeTest(DBTestMixin, TestCase):
+    # Model badges can be extended in plugins, for example in udata-front
+    # for french only badges.
+    Organization.__badges__["new"] = "new"
+
+    def test_validation(self):
+        """It should validate default badges as well as extended ones"""
+        badge = OrganizationBadge(kind="public-service")
+        badge.validate()
+
+        badge = OrganizationBadge(kind="new")
+        badge.validate()
+
+        with self.assertRaises(db.ValidationError):
+            badge = OrganizationBadge(kind="doesnotexist")
+            badge.validate()

udata/tests/reuse/test_reuse_model.py

@@ -5,9 +5,10 @@ from udata.core.dataset.factories import DatasetFactory
 from udata.core.discussions.factories import DiscussionFactory
 from udata.core.organization.factories import OrganizationFactory
 from udata.core.reuse.factories import ReuseFactory, VisibleReuseFactory
+from udata.core.reuse.models import Reuse, ReuseBadge
 from udata.core.user.factories import UserFactory
 from udata.i18n import gettext as _
-from udata.models import Reuse
+from udata.models import db
 from udata.tests.helpers import assert_emit
 
 from .. import DBTestMixin, TestCase
@@ -124,3 +125,18 @@ class ReuseModelTest(TestCase, DBTestMixin):
         reuse.private = True
         reuse.save()
         self.assertEqual(reuse.private, True)
+
+
+class ReuseBadgeTest(DBTestMixin, TestCase):
+    # Model badges can be extended in plugins, for example in udata-front
+    # for french only badges.
+    Reuse.__badges__["new"] = "new"
+
+    def test_validation(self):
+        """It should validate default badges as well as extended ones"""
+        badge = ReuseBadge(kind="new")
+        badge.validate()
+
+        with self.assertRaises(db.ValidationError):
+            badge = ReuseBadge(kind="doesnotexist")
+            badge.validate()

{udata-10.0.1.dev32359.dist-info → udata-10.0.1.dev32405.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 10.0.1.dev32359
+Version: 10.0.1.dev32405
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -141,6 +141,8 @@ It is collectively taken care of by members of the
 ## Current (in progress)
 
 - Add more comments and types in the `api_field.py` "lib" [#3174](https://github.com/opendatateam/udata/pull/3174)
+- Allow overriding of badges (for example in plugins like udata-front) [#3191](https://github.com/opendatateam/udata/pull/3191)
+- Add business documentation url property on dataservice [#3193](https://github.com/opendatateam/udata/pull/3193)
 
 ## 10.0.0 (2024-11-07)
 

{udata-10.0.1.dev32359.dist-info → udata-10.0.1.dev32405.dist-info}/RECORD

@@ -1,7 +1,7 @@
 tasks/__init__.py,sha256=nubUI6ljumym4uv6NvAJEkWHtsdurFpEGSq-AxDWYDM,8153
 tasks/helpers.py,sha256=70fS9tI_m0DTWmKx9Zl5-LG-nxdz_ZaPyvvsFkN2r48,1091
 udata/__init__.py,sha256=VLpep3pCtT5bA1tTfgPooU04eEqTfDj4l1Ji5umePX0,102
-udata/api_fields.py,sha256=z1L_ykNO6GoZP0i-RvlYTv6GwoP0NtGFdfZMLWe8qTc,28784
+udata/api_fields.py,sha256=BG4VhH5rBO-FmfDGuX7LO8R-7LL5EE6o1eDP2MDnpS4,29723
 udata/app.py,sha256=xjk2D3EgboYBpTwBwdIxd2klt2yMoWMyCrkry5fz0LA,7292
 udata/assets.py,sha256=H5Hrc2vnKM0IFLyWfLXmJ2Kj35w1i8W1D8Cgy8_cUj4,657
 udata/cors.py,sha256=gPTIXnO5nWziCKAHqU9GNuBKaIzr7RRtbjZBd2RdE2k,3155
@@ -72,7 +72,7 @@ udata/core/badges/signals.py,sha256=gD68zbdL-mM0epJp8MbkBhqcgqKd2_U-pEEUpwoII7w,
 udata/core/badges/tasks.py,sha256=gkp3gfXGb8-uqpb9U9P2aPz2Eb_g3Lol0K5IRsaJ2yg,432
 udata/core/badges/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/badges/tests/test_commands.py,sha256=dSM8VV9CByPJYv11BUlfh4WIV2KLy7GceBXJ0DFSKpY,1276
-udata/core/badges/tests/test_model.py,sha256=FL4bU8urgm7raq9xaoPsUV1MhmM6q4-oNqkpw3Volrg,4731
+udata/core/badges/tests/test_model.py,sha256=FRyh4RkVHaL3cA9UROvD5fRXBB1GfPZ824k2-F4fHBg,5143
 udata/core/contact_point/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/contact_point/api.py,sha256=hK5fanw-QZvenqu2XQW5xKmhPNPGK6xplUWqaMy_Il4,1951
 udata/core/contact_point/api_fields.py,sha256=IECdDFG9OzbQP8USXhUKAbEdVWiA6xO4ffcEB4zTTWQ,1073
@@ -83,7 +83,7 @@ udata/core/dataservices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG
 udata/core/dataservices/api.py,sha256=XybQOFfnYU2SVQ-LXW4jXmCfIDuF6oEc3VuDfMCiRj0,7371
 udata/core/dataservices/apiv2.py,sha256=XIqJq58uLtxtt52iKYo7Fl0ZXv9Sz72uA7JIGwP8Qos,995
 udata/core/dataservices/factories.py,sha256=LDk8vvG0zhW8J-ZX5LoJQDU13pqeIyjQ05muuMro_eA,876
-udata/core/dataservices/models.py,sha256=p9tn-YTrd01WHHke49EMx3msH9Fu49XtdQsII9sAJXE,8488
+udata/core/dataservices/models.py,sha256=8XhhlhGzIr8S3n7yVbqo4Z8b_cieUKUwNNp4-dSbbqs,8542
 udata/core/dataservices/permissions.py,sha256=98zM_R4v2ZtRubflB7ajaVQz-DVc-pZBMgtKUYy34oI,169
 udata/core/dataservices/rdf.py,sha256=PTye9_DeeOdpSa48NkcQNqRR15_LeUsvkjJ21nvLAhI,5428
 udata/core/dataservices/search.py,sha256=htjh3sq3tDuD2qwgRgZsW6ClrHLF6hMwYO4nfBO0Hr4,4171
@@ -101,7 +101,7 @@ udata/core/dataset/events.py,sha256=bSM0nFEX14r4JHc-bAM-7OOuD3JAxUIpw9GgXbOsUyw,
 udata/core/dataset/exceptions.py,sha256=uKiayLSpSzsnLvClObS6hOO0qXEqvURKN7_w8eimQNU,498
 udata/core/dataset/factories.py,sha256=fRDWDlybR_ud4pDs1-ntWuYHKtV9LMHeBOBp2SmTT6M,9006
 udata/core/dataset/forms.py,sha256=H2oeAD8XckMugnwUcyuKv7o1Xq1rEIlLz9FtxujqbIE,6196
-udata/core/dataset/models.py,sha256=1x5zfKQAHBTCxhxz4sl-EK9BEVYsUVyBORULOg55FTU,37382
+udata/core/dataset/models.py,sha256=9iaZ072KauirHZDH1SwIazOFxNjCg1MyBWepouKH3Ig,37511
 udata/core/dataset/permissions.py,sha256=zXQ6kU-Ni3Pl5tDtat-ZPupug9InsNeCN7xRLc2Vcrc,1097
 udata/core/dataset/preview.py,sha256=IwCqiNTjjXbtA_SSKF52pwnzKKEz0GyYM95QNn2Dkog,2561
 udata/core/dataset/rdf.py,sha256=YqsRPrrcwWaV13hflpcEOaN3VXpWW3X8VRtUT2qJH60,26383
@@ -149,7 +149,7 @@ udata/core/organization/csv.py,sha256=j6BJvXE8_6c-IWOPOg0C-j9KiCushoG1FQxzKVBDj2
 udata/core/organization/factories.py,sha256=g8ubBcz79xbjvpunZ02IDOakFg1KE6cXjNkE9vFyFAc,624
 udata/core/organization/forms.py,sha256=tscDb1_yOpbTx3ahl8ttA7oDkX9jIyzLc4gOf6WbN3s,3552
 udata/core/organization/metrics.py,sha256=UlHOBOph9s_QW-X7dkEivVITdyZ0ku9kLKl7BmSpGTI,778
-udata/core/organization/models.py,sha256=NLxw5fp0GzUxdjH_Hvu4F0OXa7Y7inkqrfgPiZoIPjI,8811
+udata/core/organization/models.py,sha256=pOVtlWgXQ_HxWZASJ7W5vusove-gqZ6o2TNsP2IbAjA,8945
 udata/core/organization/notifications.py,sha256=i_36-l2y7fOGmnBmr5NDWmGGmrGRaCWbU-6XS4c2wQs,917
 udata/core/organization/permissions.py,sha256=GD-9TMtRppVCPaC1ysXYrONvGJV-ArzAOXm2XMKf9yo,1256
 udata/core/organization/rdf.py,sha256=GmWliHFf356cUiXfNuK56b-O-zRNQqxLKJhNULGVcKA,1940
@@ -178,7 +178,7 @@ udata/core/reuse/constants.py,sha256=JgDBrjOKSt9q0auv9rjzbGsch83H-Oi8YXAKeI5hO4o
 udata/core/reuse/csv.py,sha256=4TcQbk4kWN_HbnpEUfgfW9_x7ZqNDk5s4YuJ839p3EE,896
 udata/core/reuse/factories.py,sha256=GrQqYTIvwQrwkvJrbTr38-2faFW_PC99gn3yOVpgFec,850
 udata/core/reuse/metrics.py,sha256=sVh7BlW3OKRvFDHFyD4pPUV91jOOhj8qeWbBkLPn5Gg,176
-udata/core/reuse/models.py,sha256=YitJhFFvyxG5XGt76Y7Q_kfiA_ixxtRu9b3dVceXBDM,8290
+udata/core/reuse/models.py,sha256=ZB5KKpqYqwghOMqynT_wL6OwIozt5UQYrpNqLEahPQA,8417
 udata/core/reuse/permissions.py,sha256=j-ancS7gvLl5vJu0TNYqpYD-2So-UzoDE4IHLxRoMGg,621
 udata/core/reuse/search.py,sha256=y1DwXYkBMBwuhn62CULkU1NNo89IYp0Ae7U01jcnjBY,3137
 udata/core/reuse/signals.py,sha256=nDrEUpYKN0AdYiEbrR0z3nzXzjaRcD8SAMutwIDsQPM,155
@@ -668,11 +668,11 @@ udata/tests/frontend/test_markdown.py,sha256=8E0XjByzmsY-RGdF2ESoL9Rklkfz3vcdJWK
 udata/tests/organization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/tests/organization/test_csv_adapter.py,sha256=vgTVbPMqKipcdg7wi99pHk9ZNhqtuU-yneEaVW3pZmU,1564
 udata/tests/organization/test_notifications.py,sha256=PGmME5BbYVtcPffeSE1sx47J6iAfm4RDAZIRv_MXDFE,1366
-udata/tests/organization/test_organization_model.py,sha256=JIYgVmgs71r9KCplyEOdHC8qSncr4ER9fZWiGgL5hEs,3060
+udata/tests/organization/test_organization_model.py,sha256=clRck_ZNSIBI0VaugrInK6dUkw3yBaly6TtVqmLzfEY,3684
 udata/tests/organization/test_organization_rdf.py,sha256=v_gC4BI0hCFKDkK0CMmZO6PBwqe--pc0OLhyftZpQeg,8086
 udata/tests/organization/test_organization_tasks.py,sha256=ehPirwfLqaEcnJ9TLk3jGw3Xh-CVx1WXhvIDFYrT2iQ,2845
 udata/tests/reuse/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-udata/tests/reuse/test_reuse_model.py,sha256=ro_p0GmDvkaP6jQmCxDDLiGBFetDInjn9McnHRglWZY,3989
+udata/tests/reuse/test_reuse_model.py,sha256=Q862yC-kXE2cM8on-2-B7JEeP9rLgAENi9z3OpDvt5M,4530
 udata/tests/reuse/test_reuse_task.py,sha256=4gMsKHjGafb6kpRKnqF167Htd-Ff0tRD4iQajW1e_lg,1380
 udata/tests/search/__init__.py,sha256=ub8kS6vG9EjzkJ-9sAR7j1eLSYpud1Gzry4MQ8fpgxM,1493
 udata/tests/search/test_adapter.py,sha256=mi-M53JQSPYxU8ahkqtfyIrIyhz_cC_ATdLbWWa3onM,6941
@@ -705,9 +705,9 @@ udata/translations/pt/LC_MESSAGES/udata.mo,sha256=TpMlhwj07t7CPkzXn-qmHG4aTq6ZT7
 udata/translations/pt/LC_MESSAGES/udata.po,sha256=vRqSEt9Jds--Wic-hYMkdjYaWzeHFnUn3wD5XvQL-qE,44877
 udata/translations/sr/LC_MESSAGES/udata.mo,sha256=bc-BmgT91ZJJB9DKc5YDsHqyxBhOjDJdbOy-UPo-NjA,28163
 udata/translations/sr/LC_MESSAGES/udata.po,sha256=BKVmr4M88pfgZMU4sHIyDObV5M9E8ezZ9m7jviy2PE4,51369
-udata-10.0.1.dev32359.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-udata-10.0.1.dev32359.dist-info/METADATA,sha256=hPcO_cGu0iLmqjkyWoUmvQcqLk1CSeJp4NxsYsACGho,134253
-udata-10.0.1.dev32359.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-udata-10.0.1.dev32359.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
-udata-10.0.1.dev32359.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
-udata-10.0.1.dev32359.dist-info/RECORD,,
+udata-10.0.1.dev32405.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+udata-10.0.1.dev32405.dist-info/METADATA,sha256=kO-jT8H6rlN7tnOKx3tuIh4Bw5U8X6Nf_Rq8ygFzmtg,134495
+udata-10.0.1.dev32405.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+udata-10.0.1.dev32405.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
+udata-10.0.1.dev32405.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
+udata-10.0.1.dev32405.dist-info/RECORD,,