udata 10.3.3.dev35091__py2.py3-none-any.whl → 10.3.3.dev35125__py2.py3-none-any.whl

udata/core/dataset/api.py

@@ -604,8 +604,11 @@ class ResourceAPI(ResourceMixin, API):
     @api.marshal_with(resource_fields)
     def get(self, dataset, rid):
         """Get a resource given its identifier"""
-        if dataset.deleted and not DatasetEditPermission(dataset).can():
-            api.abort(410, "Dataset has been deleted")
+        if not DatasetEditPermission(dataset).can():
+            if dataset.private:
+                api.abort(404)
+            elif dataset.deleted:
+                api.abort(410, "Dataset has been deleted")
         resource = self.get_resource_or_404(dataset, rid)
         return resource
 

udata/core/dataset/apiv2.py

@@ -8,6 +8,7 @@ from flask_restx import marshal
 from udata import search
 from udata.api import API, apiv2, fields
 from udata.core.contact_point.api_fields import contact_point_fields
+from udata.core.dataset.api_fields import license_fields
 from udata.core.organization.api_fields import member_user_with_email_fields
 from udata.core.spatial.api_fields import geojson
 from udata.utils import get_by
@@ -28,7 +29,7 @@ from .api_fields import (
     temporal_coverage_fields,
     user_ref_fields,
 )
-from .constants import DEFAULT_FREQUENCY, DEFAULT_LICENSE, UPDATE_FREQUENCIES
+from .constants import DEFAULT_FREQUENCY, DEFAULT_LICENSE, FULL_OBJECTS_HEADER, UPDATE_FREQUENCIES
 from .models import CommunityResource, Dataset
 from .permissions import DatasetEditPermission, ResourceEditPermission
 from .search import DatasetSearch
@@ -149,11 +150,17 @@ dataset_fields = apiv2.model(
             },
             description="Link to the dataset community resources",
         ),
-        "frequency": fields.String(
-            description="The update frequency",
-            required=True,
+        "frequency": fields.Raw(
+            attribute=lambda d: {
+                "id": d.frequency or DEFAULT_FREQUENCY,
+                "label": UPDATE_FREQUENCIES.get(d.frequency or DEFAULT_FREQUENCY),
+            }
+            if request.headers.get(FULL_OBJECTS_HEADER, False, bool)
+            else d.frequency,
             enum=list(UPDATE_FREQUENCIES),
             default=DEFAULT_FREQUENCY,
+            required=True,
+            description="The update frequency (full Frequency object if `X-Get-Datasets-Full-Objects` is set, ID of the frequency otherwise)",
         ),
         "frequency_date": fields.ISODateTime(
             description=(
@@ -183,8 +190,12 @@ dataset_fields = apiv2.model(
         "spatial": fields.Nested(
             spatial_coverage_fields, allow_null=True, description="The spatial coverage"
         ),
-        "license": fields.String(
-            attribute="license.id", default=DEFAULT_LICENSE["id"], description="The dataset license"
+        "license": fields.Raw(
+            attribute=lambda d: marshal(d.license, license_fields)
+            if request.headers.get(FULL_OBJECTS_HEADER, False, bool)
+            else (d.license.id if d.license is not None else None),
+            default=DEFAULT_LICENSE["id"],
+            description="The dataset license (full License object if `X-Get-Datasets-Full-Objects` is set, ID of the license otherwise)",
         ),
         "uri": fields.UrlFor(
             "api.dataset",
@@ -307,8 +318,11 @@ class DatasetAPI(API):
     @apiv2.marshal_with(dataset_fields)
     def get(self, dataset):
         """Get a dataset given its identifier"""
-        if dataset.deleted and not DatasetEditPermission(dataset).can():
-            apiv2.abort(410, "Dataset has been deleted")
+        if not DatasetEditPermission(dataset).can():
+            if dataset.private:
+                apiv2.abort(404)
+            elif dataset.deleted:
+                apiv2.abort(410, "Dataset has been deleted")
         return dataset
 
 
@@ -321,8 +335,11 @@ class DatasetExtrasAPI(API):
     @apiv2.doc("get_dataset_extras")
     def get(self, dataset):
         """Get a dataset extras given its identifier"""
-        if dataset.deleted and not DatasetEditPermission(dataset).can():
-            apiv2.abort(410, "Dataset has been deleted")
+        if not DatasetEditPermission(dataset).can():
+            if dataset.private:
+                apiv2.abort(404)
+            elif dataset.deleted:
+                apiv2.abort(410, "Dataset has been deleted")
         return dataset.extras
 
     @apiv2.secure
@@ -370,6 +387,11 @@ class ResourcesAPI(API):
     @apiv2.marshal_with(resource_page_fields)
     def get(self, dataset):
         """Get the given dataset resources, paginated."""
+        if not DatasetEditPermission(dataset).can():
+            if dataset.private:
+                apiv2.abort(404)
+            elif dataset.deleted:
+                apiv2.abort(410, "Dataset has been deleted")
         args = resources_parser.parse_args()
         page = args["page"]
         page_size = args["page_size"]
@@ -410,6 +432,11 @@ class ResourceAPI(API):
     def get(self, rid):
         dataset = Dataset.objects(resources__id=rid).first()
         if dataset:
+            if not DatasetEditPermission(dataset).can():
+                if dataset.private:
+                    apiv2.abort(404)
+                elif dataset.deleted:
+                    apiv2.abort(410, "Dataset has been deleted")
             resource = get_by(dataset.resources, "id", rid)
         else:
             resource = CommunityResource.objects(id=rid).first()
@@ -436,8 +463,11 @@ class ResourceExtrasAPI(ResourceMixin, API):
     @apiv2.doc("get_resource_extras")
     def get(self, dataset, rid):
         """Get a resource extras given its identifier"""
-        if dataset.deleted and not DatasetEditPermission(dataset).can():
-            apiv2.abort(410, "Dataset has been deleted")
+        if not DatasetEditPermission(dataset).can():
+            if dataset.private:
+                apiv2.abort(404)
+            elif dataset.deleted:
+                apiv2.abort(410, "Dataset has been deleted")
         resource = self.get_resource_or_404(dataset, rid)
         return resource.extras
 

udata/core/dataset/constants.py

@@ -89,3 +89,5 @@ SCHEMA_CACHE_DURATION = 60 * 5  # In seconds
 
 TITLE_SIZE_LIMIT = 350
 DESCRIPTION_SIZE_LIMIT = 100000
+
+FULL_OBJECTS_HEADER = "X-Get-Datasets-Full-Objects"

udata/core/spatial/api_fields.py

@@ -1,4 +1,8 @@
+from flask import request
+from flask_restx import marshal
+
 from udata.api import api, fields
+from udata.core.dataset.constants import FULL_OBJECTS_HEADER
 
 GEOM_TYPES = ("Point", "LineString", "Polygon", "MultiPoint", "MultiLineString", "MultiPolygon")
 
@@ -66,9 +70,18 @@ spatial_coverage_fields = api.model(
         "geom": fields.Nested(
             geojson, allow_null=True, description="A multipolygon for the whole coverage"
         ),
-        "zones": fields.List(fields.String, description="The covered zones identifiers"),
-        "granularity": fields.String(
-            default="other", description="The spatial/territorial granularity"
+        "zones": fields.Raw(
+            attribute=lambda s: marshal(s.zones, zone_fields)
+            if request.headers.get(FULL_OBJECTS_HEADER, False, bool)
+            else [str(z) for z in s.zones],
+            description="The covered zones identifiers (full GeoZone objects if `X-Get-Datasets-Full-Objects` is set, IDs of the zones otherwise)",
+        ),
+        "granularity": fields.Raw(
+            attribute=lambda s: {"id": s.granularity or "other", "name": s.granularity_label}
+            if request.headers.get(FULL_OBJECTS_HEADER, False, bool)
+            else s.granularity,
+            default="other",
+            description="The spatial/territorial granularity (full Granularity object if `X-Get-Datasets-Full-Objects` is set, ID of the granularity otherwise)",
         ),
     },
 )

udata/tests/api/test_datasets_api.py

@@ -19,6 +19,7 @@ from udata.core.dataset.api_fields import (
     resource_harvest_fields,
 )
 from udata.core.dataset.constants import (
+    FULL_OBJECTS_HEADER,
     LEGACY_FREQUENCIES,
     RESOURCE_TYPES,
     UPDATE_FREQUENCIES,
@@ -37,7 +38,7 @@ from udata.core.dataset.models import (
     ResourceMixin,
 )
 from udata.core.organization.factories import OrganizationFactory
-from udata.core.spatial.factories import SpatialCoverageFactory
+from udata.core.spatial.factories import GeoLevelFactory, SpatialCoverageFactory
 from udata.core.topic.factories import TopicFactory
 from udata.core.user.factories import AdminFactory, UserFactory
 from udata.i18n import gettext as _
@@ -506,6 +507,41 @@ class DatasetAPITest(APITestCase):
         response = self.get(url_for("api.dataset", dataset=dataset))
         self.assert200(response)
 
+    def test_dataset_api_get_with_full_objects(self):
+        """It should fetch a private dataset from the API if user is authorized"""
+        license = LicenseFactory(id="lov2", title="Licence Ouverte Version 2.0")
+        paca, bdr, arles = create_geozones_fixtures()
+        country = GeoLevelFactory(id="country", name="Pays", admin_level=10)
+
+        dataset = DatasetFactory(
+            frequency="monthly",
+            license=license,
+            spatial=SpatialCoverageFactory(zones=[paca.id], granularity=country.id),
+        )
+
+        response = self.get(url_for("apiv2.dataset", dataset=dataset))
+        self.assert200(response)
+        assert response.json["frequency"] == "monthly"
+        assert response.json["license"] == "lov2"
+        assert response.json["spatial"]["zones"][0] == paca.id
+        assert response.json["spatial"]["granularity"] == "country"
+
+        response = self.get(
+            url_for("apiv2.dataset", dataset=dataset),
+            headers={
+                FULL_OBJECTS_HEADER: "True",
+            },
+        )
+        self.assert200(response)
+        assert response.json["frequency"]["id"] == "monthly"
+        assert response.json["frequency"]["label"] == "Mensuelle"
+        assert response.json["license"]["id"] == "lov2"
+        assert response.json["license"]["title"] == license.title
+        assert response.json["spatial"]["zones"][0]["id"] == paca.id
+        assert response.json["spatial"]["zones"][0]["name"] == paca.name
+        assert response.json["spatial"]["granularity"]["id"] == "country"
+        assert response.json["spatial"]["granularity"]["name"] == country.name
+
     def test_dataset_api_create(self):
         """It should create a dataset from the API"""
         data = DatasetFactory.as_dict()

{udata-10.3.3.dev35091.dist-info → udata-10.3.3.dev35125.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 10.3.3.dev35091
+Version: 10.3.3.dev35125
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -142,7 +142,8 @@ It is collectively taken care of by members of the
 ## Current (in progress)
 
 - Improve reuse api perfs by adding a mask on datasets [#3309](https://github.com/opendatateam/udata/pull/3309)
-- Private objects should return 404 by api [#3311](https://github.com/opendatateam/udata/pull/3311)
+- Private objects should return 404 by api [#3311](https://github.com/opendatateam/udata/pull/3311) [#3316](https://github.com/opendatateam/udata/pull/3316)
+- Allow returning full sub-objects (license, frequency, zones and granularity) for datasets APIv2 [#3310](https://github.com/opendatateam/udata/pull/3310)
 - Add `featured` to dataset default mask [#3313](https://github.com/opendatateam/udata/pull/3313)
 
 ## 10.3.2 (2025-05-06)

{udata-10.3.3.dev35091.dist-info → udata-10.3.3.dev35125.dist-info}/RECORD

@@ -94,11 +94,11 @@ udata/core/dataservices/tasks.py,sha256=d2tG1l6u8-eUKUYBOgnCsQLbLmLgJXU-DOzZWhhL
 udata/core/dataset/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/dataset/actions.py,sha256=mX6xox0PiMrbcAPZ3VZsI26rfM-ciYfEXxN6sqqImKA,1222
 udata/core/dataset/activities.py,sha256=v8k1jwhdx62Z2ARZq8Q-x86OWSsBK99hRloPl74OCgA,1502
-udata/core/dataset/api.py,sha256=gMpY3w1BhXtPPiHC7UZ0bfIFyp34Jwio0NaUmwutmVg,33201
+udata/core/dataset/api.py,sha256=jElQZuguc514Eb0cWdquEfosP1yB79hEQ52SV_SvLx8,33282
 udata/core/dataset/api_fields.py,sha256=SLuzWoPdMLPX28WQ9DRGUPKS27vlltiFeiTo6jXa55Q,17549
-udata/core/dataset/apiv2.py,sha256=5tBsbEbF7kjUHP0X9Xd6qDSI9bqNBgYvRaWs0n3r1OM,17803
+udata/core/dataset/apiv2.py,sha256=tpnIIk4UIQPOWUSjvxfBonTO8cbBEZSHKFItg0SnUws,19235
 udata/core/dataset/commands.py,sha256=__hPAk_6iHtgMnEG51ux0vbNWJHxUjXhi1ukH4hF5jY,3714
-udata/core/dataset/constants.py,sha256=44uFvmL7xRF73Kag3rdaVli6CIP-3ZN8obhmsqHYJIM,2918
+udata/core/dataset/constants.py,sha256=fKn21GzRShZv6pzKy3TvEK1cevQ9H3dOFE-xTRuE0lA,2971
 udata/core/dataset/csv.py,sha256=aNJOytbFbH8OCYr6hyaSaqFSa94Xb3dvBd3QGZHJRsA,3633
 udata/core/dataset/events.py,sha256=bSM0nFEX14r4JHc-bAM-7OOuD3JAxUIpw9GgXbOsUyw,4078
 udata/core/dataset/exceptions.py,sha256=uKiayLSpSzsnLvClObS6hOO0qXEqvURKN7_w8eimQNU,498
@@ -202,7 +202,7 @@ udata/core/spam/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 udata/core/spam/tests/test_spam.py,sha256=Yu06Z3hU-XPX51mvdgH_nHQFeug_PXWy6P7QxNDaKEI,677
 udata/core/spatial/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/spatial/api.py,sha256=xuff3vcZjKm6z6FyFLFsuuVUDlCC8o0-JhUXkc-4pmc,5658
-udata/core/spatial/api_fields.py,sha256=ZEmgzRrcMr944h3EqN5sLTIeLy-a1VlvxAGDD8NXGIY,2816
+udata/core/spatial/api_fields.py,sha256=6YVv7w6UyX_m7uGKNtexw8EOQk_I39GWlwCb3Qj_IiQ,3513
 udata/core/spatial/commands.py,sha256=BMYAZqueaU6QlfN4ny4fsMF9l7rcjPp73mj8CIilyZ0,6931
 udata/core/spatial/constants.py,sha256=T024yKsXuBkaZ1MAFZPfLh2X_EFFVQ7Sfg4VHCmZQM4,147
 udata/core/spatial/factories.py,sha256=-eQupRrIOQLouw9Bvv4UBqizFKQ4l4CHZBht2cv7irE,3096
@@ -626,7 +626,7 @@ udata/tests/api/test_auth_api.py,sha256=OMRlY0OQt60j5N4A-N3HdWTuffOjRlFHkz5a3jJF
 udata/tests/api/test_base_api.py,sha256=2w_vz0eEuq3P3aN-ByvxGc3VZAo7XtgatFfcrzf2uEU,2244
 udata/tests/api/test_contact_points.py,sha256=X_RWD_xCfR8WchhHfKEt5mxMHY77OmTyguNKCsZftdE,5337
 udata/tests/api/test_dataservices_api.py,sha256=fNpeHl4SMvci3QrC414X6KGorv7NS1y8LsGxcSMjjZY,25729
-udata/tests/api/test_datasets_api.py,sha256=0MuIxHimP24waJPu91aXR1HOyBO_YgsPp7KOkB8hkuk,94872
+udata/tests/api/test_datasets_api.py,sha256=dZXx9uz6Ni1qj2SxCgcmsvfzX8eCobqCVDaYHG4VZEY,96551
 udata/tests/api/test_fields.py,sha256=OW85Z5MES5HeWOpapeem8OvR1cIcrqW-xMWpdZO4LZ8,1033
 udata/tests/api/test_follow_api.py,sha256=XP6I96JUNT6xjGcQOF7pug_T_i67HzCiOGLaPdpfpEQ,4912
 udata/tests/api/test_me_api.py,sha256=YPd8zmR3zwJKtpSqz8nY1nOOMyXs66INeBwyhg5D0Us,13846
@@ -726,9 +726,9 @@ udata/translations/pt/LC_MESSAGES/udata.mo,sha256=ViV14tUmjSydHS0TWG_mFikKQfyUaT
 udata/translations/pt/LC_MESSAGES/udata.po,sha256=rzAD_MVoV54TmN3w1ECz3H2Ru5pM7hWMVH03SkY28Q8,47250
 udata/translations/sr/LC_MESSAGES/udata.mo,sha256=EHX1_D-Uglj38832G7BrA0QC5IuY3p8dKqi9T0DgPmE,29169
 udata/translations/sr/LC_MESSAGES/udata.po,sha256=3PMnbVhKVJh6Q8ABi1ZTZ8Dcf-sMjngLJZqLbonJoec,54225
-udata-10.3.3.dev35091.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-udata-10.3.3.dev35091.dist-info/METADATA,sha256=xmwqnPVt3J6JKkTa3QniKR_hmPu9B1pxhmpMACyd6_c,145683
-udata-10.3.3.dev35091.dist-info/WHEEL,sha256=Kh9pAotZVRFj97E15yTA4iADqXdQfIVTHcNaZTjxeGM,110
-udata-10.3.3.dev35091.dist-info/entry_points.txt,sha256=ETvkR4r6G1duBsh_V_fGWENQy17GTFuobi95MYBAl1A,498
-udata-10.3.3.dev35091.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
-udata-10.3.3.dev35091.dist-info/RECORD,,
+udata-10.3.3.dev35125.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+udata-10.3.3.dev35125.dist-info/METADATA,sha256=3zpBEJCmrAbYIycc2NazRDRY0YMNr8KeofQ4L9bEL5M,145895
+udata-10.3.3.dev35125.dist-info/WHEEL,sha256=Kh9pAotZVRFj97E15yTA4iADqXdQfIVTHcNaZTjxeGM,110
+udata-10.3.3.dev35125.dist-info/entry_points.txt,sha256=ETvkR4r6G1duBsh_V_fGWENQy17GTFuobi95MYBAl1A,498
+udata-10.3.3.dev35125.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
+udata-10.3.3.dev35125.dist-info/RECORD,,