udata 10.6.1.dev36082__py2.py3-none-any.whl → 10.6.1.dev36098__py2.py3-none-any.whl

udata/core/linkable.py

@@ -0,0 +1,16 @@
+class Linkable:
+    def _link_id(self, **kwargs):
+        return self.id if kwargs.get("_useId", False) else self.slug
+
+    def _self_api_url_kwargs(self, **kwargs):
+        # Default to external
+        kwargs["_external"] = kwargs.pop("_external", True)
+
+        # Remove own private data
+        kwargs.pop("_useId", None)
+        kwargs.pop("_mailCampaign", None)
+
+        return kwargs
+
+    def url_for(self, **kwargs):
+        return self.self_web_url(**kwargs) or self.self_api_url(**kwargs)

udata/core/organization/api.py

@@ -498,6 +498,7 @@ class OrganizationSuggestAPI(API):
                 "acronym": org.acronym,
                 "slug": org.slug,
                 "image_url": org.logo,
+                "page": org.self_web_url(),
             }
             for org in orgs.order_by(SUGGEST_SORTING).limit(args["size"])
         ]

udata/core/organization/api_fields.py

@@ -13,21 +13,18 @@ org_ref_fields = api.inherit(
     {
         "name": fields.String(description="The organization name", readonly=True),
         "acronym": fields.String(description="The organization acronym"),
-        "uri": fields.UrlFor(
-            "api.organization",
-            lambda o: {"org": o},
-            description="The organization API URI",
-            readonly=True,
-        ),
         "slug": fields.String(
             description="The organization string used as permalink", required=True
         ),
-        "page": fields.UrlFor(
-            "organizations.show",
-            lambda o: {"org": o},
+        "uri": fields.String(
+            attribute=lambda o: o.self_api_url(),
+            description="The API URI for this organization",
+            readonly=True,
+        ),
+        "page": fields.String(
+            attribute=lambda o: o.self_web_url(),
             description="The organization web page URL",
             readonly=True,
-            fallback_endpoint="api.organization",
         ),
         "logo": fields.ImageField(original=True, description="The organization logo URL"),
         "logo_thumbnail": fields.ImageField(
@@ -151,18 +148,15 @@ org_fields = api.model(
             description="The organization metrics",
             readonly=True,
         ),
-        "uri": fields.UrlFor(
-            "api.organization",
-            lambda o: {"org": o},
-            description="The organization API URI",
+        "uri": fields.String(
+            attribute=lambda o: o.self_api_url(),
+            description="The API URI for this organization",
             readonly=True,
         ),
-        "page": fields.UrlFor(
-            "organizations.show",
-            lambda o: {"org": o},
-            description="The organization page URL",
+        "page": fields.String(
+            attribute=lambda o: o.self_web_url(),
+            description="The organization web page URL",
             readonly=True,
-            fallback_endpoint="api.organization",
         ),
         "logo": fields.ImageField(original=True, description="The organization logo URL"),
         "logo_thumbnail": fields.ImageField(
@@ -211,12 +205,6 @@ org_suggestion_fields = api.model(
         "image_url": fields.ImageField(
             size=BIGGEST_LOGO_SIZE, description="The organization logo URL", readonly=True
         ),
-        "page": fields.UrlFor(
-            "organizations.show_redirect",
-            lambda o: {"org": o["slug"]},
-            description="The organization web page URL",
-            readonly=True,
-            fallback_endpoint="api.organization",
-        ),
+        "page": fields.String(description="The organization web page URL", readonly=True),
     },
 )

udata/core/organization/csv.py

@@ -13,7 +13,7 @@ class OrganizationCsvAdapter(csv.Adapter):
         "name",
         "acronym",
         "slug",
-        ("url", "external_url"),
+        ("url", lambda o: o.url_for()),
         "description",
         ("logo", lambda o: o.logo(external=True)),
         ("badges", lambda o: ",".join([badge.kind for badge in o.badges])),

udata/core/organization/models.py

@@ -2,20 +2,21 @@ from datetime import datetime
 from itertools import chain
 
 from blinker import Signal
+from flask import url_for
 from mongoengine.signals import post_save, pre_save
 from werkzeug.utils import cached_property
 
 from udata.api_fields import field
 from udata.core.activity.models import Auditable
 from udata.core.badges.models import Badge, BadgeMixin, BadgesList
+from udata.core.linkable import Linkable
 from udata.core.metrics.helpers import get_stock_metrics
 from udata.core.metrics.models import WithMetrics
 from udata.core.storages import avatars, default_image_basename
 from udata.frontend.markdown import mdstrip
 from udata.i18n import lazy_gettext as _
-from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
-from udata.uris import endpoint_for
+from udata.uris import cdata_url
 
 from .constants import (
     ASSOCIATION,
@@ -112,7 +113,9 @@ class OrganizationBadgeMixin(BadgeMixin):
     __badges__ = BADGES
 
 
-class Organization(Auditable, WithMetrics, OrganizationBadgeMixin, db.Datetimed, db.Document):
+class Organization(
+    Auditable, WithMetrics, OrganizationBadgeMixin, Linkable, db.Datetimed, db.Document
+):
     name = field(db.StringField(required=True))
     acronym = field(db.StringField(max_length=128))
     slug = field(
@@ -189,19 +192,13 @@ class Organization(Auditable, WithMetrics, OrganizationBadgeMixin, db.Datetimed,
     def pre_save(cls, sender, document, **kwargs):
         cls.before_save.send(document)
 
-    def url_for(self, *args, **kwargs):
-        return endpoint_for("organizations.show", "api.organization", org=self, *args, **kwargs)
+    def self_web_url(self, **kwargs):
+        return cdata_url(f"/organizations/{self._link_id(**kwargs)}/", **kwargs)
 
-    display_url = property(url_for)
-
-    @property
-    def external_url(self):
-        return self.url_for(_external=True)
-
-    @property
-    def external_url_with_campaign(self):
-        extras = get_mail_campaign_dict()
-        return self.url_for(_external=True, **extras)
+    def self_api_url(self, **kwargs):
+        return url_for(
+            "api.organization", org=self._link_id(**kwargs), **self._self_api_url_kwargs(**kwargs)
+        )
 
     @property
     def pending_requests(self):
@@ -283,7 +280,7 @@ class Organization(Auditable, WithMetrics, OrganizationBadgeMixin, db.Datetimed,
             "@type": type_,
             "@id": str(self.id),
             "alternateName": self.slug,
-            "url": endpoint_for("organizations.show", "api.organization", org=self, _external=True),
+            "url": self.url_for(),
             "name": self.name,
             "dateCreated": self.created_at.isoformat(),
             "dateModified": self.last_modified.isoformat(),

udata/core/organization/rdf.py

@@ -10,7 +10,6 @@ from rdflib.namespace import FOAF, RDF, RDFS
 from udata.core.dataservices.rdf import dataservice_to_rdf
 from udata.core.dataset.rdf import dataset_to_rdf
 from udata.rdf import DCAT, DCT, namespace_manager, paginate_catalog
-from udata.uris import endpoint_for
 from udata.utils import Paginable
 
 
@@ -20,10 +19,7 @@ def organization_to_rdf(org, graph=None):
     """
     graph = graph or Graph(namespace_manager=namespace_manager)
     if org.id:
-        org_url = endpoint_for(
-            "organizations.show_redirect", "api.organization", org=org.id, _external=True
-        )
-        id = URIRef(org_url)
+        id = URIRef(org.url_for(_useId=True))
     else:
         id = BNode()
     o = graph.resource(id)

udata/core/post/api.py

@@ -48,15 +48,15 @@ post_fields = api.model(
         ),
         "published": fields.ISODateTime(description="The post publication date", readonly=True),
         "body_type": fields.String(description="HTML or markdown body type", default="markdown"),
-        "uri": fields.UrlFor(
-            "api.post", lambda o: {"post": o}, description="The post API URI", readonly=True
+        "uri": fields.String(
+            attribute=lambda p: p.self_api_url(),
+            description="The API URI for this post",
+            readonly=True,
         ),
-        "page": fields.UrlFor(
-            "posts.show",
-            lambda o: {"post": o},
-            description="The post page URL",
+        "page": fields.String(
+            attribute=lambda p: p.self_web_url(),
+            description="The post web page URL",
             readonly=True,
-            fallback_endpoint="api.post",
         ),
     },
     mask="*,datasets{id,title,acronym,uri,page},reuses{id,title,image,image_thumbnail,uri,page}",
@@ -130,7 +130,7 @@ class PostsAtomFeedAPI(API):
                 description=post.headline,
                 content=md(post.content),
                 author_name="data.gouv.fr",
-                link=post.external_url,
+                link=post.url_for(),
                 updateddate=post.last_modified,
                 pubdate=post.published,
             )

udata/core/post/models.py

@@ -1,9 +1,10 @@
 from flask import url_for
 
+from udata.core.linkable import Linkable
 from udata.core.storages import default_image_basename, images
 from udata.i18n import lazy_gettext as _
-from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
+from udata.uris import cdata_url
 
 from .constants import BODY_TYPES, IMAGE_SIZES
 
@@ -15,7 +16,7 @@ class PostQuerySet(db.BaseQuerySet):
         return self(published__ne=None).order_by("-published")
 
 
-class Post(db.Datetimed, db.Document):
+class Post(db.Datetimed, Linkable, db.Document):
     name = db.StringField(max_length=255, required=True)
     slug = db.SlugField(
         max_length=255, required=True, populate_from="name", update=True, follow=True
@@ -56,21 +57,13 @@ class Post(db.Datetimed, db.Document):
     def __str__(self):
         return self.name or ""
 
-    def url_for(self, *args, **kwargs):
-        return url_for("posts.show", post=self, *args, **kwargs)
+    def self_web_url(self, **kwargs):
+        return cdata_url(f"/posts/{self._link_id(**kwargs)}/", **kwargs)
 
-    @property
-    def display_url(self):
-        return self.url_for()
-
-    @property
-    def external_url(self):
-        return self.url_for(_external=True)
-
-    @property
-    def external_url_with_campaign(self):
-        extras = get_mail_campaign_dict()
-        return self.url_for(_external=True, **extras)
+    def self_api_url(self, **kwargs):
+        return url_for(
+            "api.post", post=self._link_id(**kwargs), **self._self_api_url_kwargs(**kwargs)
+        )
 
     def count_discussions(self):
         # There are no metrics on Post to store discussions count

udata/core/reports/models.py

@@ -1,13 +1,13 @@
 from datetime import datetime
 
 from bson import DBRef
+from flask import url_for
 from mongoengine import DO_NOTHING, NULLIFY, signals
 
 from udata.api_fields import field, function_field, generate_fields
 from udata.core.user.api_fields import user_ref_fields
 from udata.core.user.models import User
 from udata.mongo import db
-from udata.uris import endpoint_for
 
 from .constants import REPORT_REASONS_CHOICES, REPORTABLE_MODELS
 
@@ -48,7 +48,7 @@ class Report(db.Document):
 
     @function_field(description="Link to the API endpoint for this report")
     def self_api_url(self):
-        return endpoint_for("api.report", report=self, _external=True)
+        return url_for("api.report", report=self, _external=True)
 
     @classmethod
     def mark_as_deleted_soft_delete(cls, sender, document, **kwargs):

udata/core/reuse/api.py

@@ -150,10 +150,10 @@ class ReusesAtomFeedAPI(API):
             author_uri = None
             if reuse.organization:
                 author_name = reuse.organization.name
-                author_uri = reuse.organization.external_url
+                author_uri = reuse.organization.url_for()
             elif reuse.owner:
                 author_name = reuse.owner.fullname
-                author_uri = reuse.owner.external_url
+                author_uri = reuse.owner.url_for()
             feed.add_item(
                 reuse.title,
                 unique_id=reuse.id,
@@ -161,7 +161,7 @@ class ReusesAtomFeedAPI(API):
                 content=md(reuse.description),
                 author_name=author_name,
                 author_link=author_uri,
-                link=reuse.external_url,
+                link=reuse.url_for(),
                 updateddate=reuse.last_modified,
                 pubdate=reuse.created_at,
             )
@@ -320,6 +320,7 @@ class ReusesSuggestAPI(API):
                 "title": reuse.title,
                 "slug": reuse.slug,
                 "image_url": reuse.image,
+                "page": reuse.self_web_url(),
             }
             for reuse in reuses.order_by(SUGGEST_SORTING).limit(args["size"])
         ]

udata/core/reuse/api_fields.py

@@ -30,13 +30,7 @@ reuse_suggestion_fields = api.model(
         "image_url": fields.ImageField(
             size=BIGGEST_IMAGE_SIZE, description="The reuse thumbnail URL", readonly=True
         ),
-        "page": fields.UrlFor(
-            "reuses.show_redirect",
-            lambda o: {"reuse": o["slug"]},
-            description="The reuse page URL",
-            readonly=True,
-            fallback_endpoint="api.reuse",
-        ),
+        "page": fields.String(description="The reuse web page URL", readonly=True),
     },
 )
 

udata/core/reuse/csv.py

@@ -9,7 +9,7 @@ class ReuseCsvAdapter(csv.Adapter):
         "id",
         "title",
         "slug",
-        ("url", "external_url"),
+        ("url", lambda r: r.url_for()),
         "type",
         "description",
         ("remote_url", "url"),

udata/core/reuse/models.py

@@ -1,20 +1,21 @@
 from blinker import Signal
+from flask import url_for
 from mongoengine.signals import post_save, pre_save
 from werkzeug.utils import cached_property
 
 from udata.api_fields import field, function_field, generate_fields
 from udata.core.activity.models import Auditable
 from udata.core.dataset.api_fields import dataset_fields
+from udata.core.linkable import Linkable
 from udata.core.metrics.helpers import get_stock_metrics
 from udata.core.owned import Owned, OwnedQuerySet
 from udata.core.reuse.api_fields import BIGGEST_IMAGE_SIZE, reuse_permissions_fields
 from udata.core.storages import default_image_basename, images
 from udata.frontend.markdown import mdstrip
 from udata.i18n import lazy_gettext as _
-from udata.mail import get_mail_campaign_dict
 from udata.models import Badge, BadgeMixin, BadgesList, WithMetrics, db
 from udata.mongo.errors import FieldValidationError
-from udata.uris import endpoint_for
+from udata.uris import cdata_url
 from udata.utils import hash_url
 
 from .constants import IMAGE_MAX_SIZE, IMAGE_SIZES, REUSE_TOPICS, REUSE_TYPES
@@ -62,7 +63,7 @@ class ReuseBadgeMixin(BadgeMixin):
     additional_filters={"organization_badge": "organization.badges"},
     mask="*,datasets{id,title,uri,page}",
 )
-class Reuse(db.Datetimed, Auditable, WithMetrics, ReuseBadgeMixin, Owned, db.Document):
+class Reuse(db.Datetimed, Auditable, WithMetrics, ReuseBadgeMixin, Linkable, Owned, db.Document):
     title = field(
         db.StringField(required=True),
         sortable=True,
@@ -187,20 +188,21 @@ class Reuse(db.Datetimed, Auditable, WithMetrics, ReuseBadgeMixin, Owned, db.Doc
         # Emit before_save
         cls.before_save.send(document)
 
-    def url_for(self, *args, **kwargs):
-        return endpoint_for("reuses.show", "api.reuse", reuse=self, *args, **kwargs)
+    def self_web_url(self, **kwargs):
+        return cdata_url(f"/reuses/{self._link_id(**kwargs)}/", **kwargs)
 
-    display_url = property(url_for)
+    def self_api_url(self, **kwargs):
+        return url_for(
+            "api.reuse", reuse=self._link_id(**kwargs), **self._self_api_url_kwargs(**kwargs)
+        )
 
     @function_field(description="Link to the API endpoint for this reuse", show_as_ref=True)
-    def uri(self):
-        return endpoint_for("api.reuse", reuse=self, _external=True)
+    def uri(self, *args, **kwargs):
+        return self.self_api_url(*args, **kwargs)
 
     @function_field(description="Link to the udata web page for this reuse", show_as_ref=True)
-    def page(self):
-        return endpoint_for(
-            "reuses.show", reuse=self, _external=True, fallback_endpoint="api.reuse"
-        )
+    def page(self, *args, **kwargs):
+        return self.self_web_url(*args, **kwargs)
 
     @property
     @function_field(
@@ -222,15 +224,6 @@ class Reuse(db.Datetimed, Auditable, WithMetrics, ReuseBadgeMixin, Owned, db.Doc
     def is_hidden(self):
         return len(self.datasets) == 0 or self.private or self.deleted
 
-    @property
-    def external_url(self):
-        return self.url_for(_external=True)
-
-    @property
-    def external_url_with_campaign(self):
-        extras = get_mail_campaign_dict()
-        return self.url_for(_external=True, **extras)
-
     @property
     def type_label(self):
         return REUSE_TYPES[self.type]
@@ -263,7 +256,7 @@ class Reuse(db.Datetimed, Auditable, WithMetrics, ReuseBadgeMixin, Owned, db.Doc
             "alternateName": self.slug,
             "dateCreated": self.created_at.isoformat(),
             "dateModified": self.last_modified.isoformat(),
-            "url": endpoint_for("reuses.show", "api.reuse", reuse=self, _external=True),
+            "url": self.url_for(),
             "name": self.title,
             "isBasedOnUrl": self.url,
         }

udata/core/site/rdf.py

@@ -11,13 +11,12 @@ from udata.core.dataset.rdf import dataset_to_rdf
 from udata.core.organization.rdf import organization_to_rdf
 from udata.core.user.rdf import user_to_rdf
 from udata.rdf import DCAT, DCT, namespace_manager, paginate_catalog
-from udata.uris import endpoint_for
+from udata.uris import homepage_url
 from udata.utils import Paginable
 
 
 def build_catalog(site, datasets, dataservices=[], format=None):
     """Build the DCAT catalog for this site"""
-    site_url = endpoint_for("site.home_redirect", "api.site", _external=True)
     catalog_url = url_for("api.site_rdf_catalog", _external=True)
     graph = Graph(namespace_manager=namespace_manager)
     catalog = graph.resource(URIRef(catalog_url))
@@ -26,7 +25,7 @@ def build_catalog(site, datasets, dataservices=[], format=None):
     catalog.set(DCT.title, Literal(site.title))
     catalog.set(DCT.description, Literal(f"{site.title}"))
     catalog.set(DCT.language, Literal(current_app.config["DEFAULT_LANGUAGE"]))
-    catalog.set(FOAF.homepage, URIRef(site_url))
+    catalog.set(FOAF.homepage, URIRef(homepage_url(_external=True)))
 
     publisher = graph.resource(BNode())
     publisher.set(RDF.type, FOAF.Organization)

udata/core/spatial/models.py

@@ -6,9 +6,7 @@ from werkzeug.utils import cached_property
 from udata.app import cache
 from udata.core.metrics.models import WithMetrics
 from udata.i18n import _, get_locale, language
-from udata.mail import get_mail_campaign_dict
 from udata.mongo import db
-from udata.uris import endpoint_for
 
 from . import geoids
 from .constants import ADMIN_LEVEL_MAX, ADMIN_LEVEL_MIN, BASE_GRANULARITIES
@@ -93,16 +91,11 @@ class GeoZone(WithMetrics, db.Document):
 
     @property
     def url(self):
-        return endpoint_for("territories.territory", territory=self)
+        return None
 
     @property
     def external_url(self):
-        return endpoint_for("territories.territory", territory=self, _external=True)
-
-    @property
-    def external_url_with_campaign(self):
-        extras = get_mail_campaign_dict()
-        return endpoint_for("territories.territory", territory=self, _external=True, **extras)
+        return None
 
     def count_datasets(self):
         from udata.models import Dataset

udata/core/topic/api.py

@@ -1,4 +1,5 @@
 import mongoengine
+from flask import url_for
 from flask_security import current_user
 
 from udata.api import API, api, fields
@@ -58,15 +59,10 @@ topic_fields = api.model(
         "owner": fields.Nested(
             user_ref_fields, description="The owner user", readonly=True, allow_null=True
         ),
-        "uri": fields.UrlFor(
-            "api.topic", lambda o: {"topic": o}, description="The topic API URI", readonly=True
-        ),
-        "page": fields.UrlFor(
-            "topics.display",
-            lambda o: {"topic": o},
-            description="The topic page URL",
+        "uri": fields.String(
+            attribute=lambda t: url_for("api.topic", topic=t),
+            description="The topic API URI",
             readonly=True,
-            fallback_endpoint="api.topic",
         ),
         "extras": fields.Raw(description="Extras attributes as key-value pairs"),
     },

udata/core/topic/apiv2.py

@@ -93,15 +93,10 @@ topic_fields = apiv2.model(
         "owner": fields.Nested(
             user_ref_fields, description="The owner user", readonly=True, allow_null=True
         ),
-        "uri": fields.UrlFor(
-            "api.topic", lambda o: {"topic": o}, description="The topic API URI", readonly=True
-        ),
-        "page": fields.UrlFor(
-            "topics.display",
-            lambda o: {"topic": o},
-            description="The topic page URL",
+        "uri": fields.String(
+            attribute=lambda t: url_for("api.topic", topic=t),
+            description="The topic API URI",
             readonly=True,
-            fallback_endpoint="api.topic",
         ),
         "extras": fields.Raw(description="Extras attributes as key-value pairs"),
     },

udata/core/topic/models.py

@@ -1,5 +1,4 @@
 from blinker import Signal
-from flask import url_for
 from mongoengine.signals import post_save, pre_save
 
 from udata.api_fields import field
@@ -57,10 +56,6 @@ class Topic(db.Datetimed, Auditable, db.Document, Owned):
         for dataset in datasets_list_dif:
             reindex.delay("Dataset", str(dataset.pk))
 
-    @property
-    def display_url(self):
-        return url_for("topics.display", topic=self)
-
     def count_discussions(self):
         # There are no metrics on Topic to store discussions count
         pass

udata/core/user/api_fields.py

@@ -10,15 +10,15 @@ user_ref_fields = api.inherit(
         "first_name": fields.String(description="The user first name", readonly=True),
         "last_name": fields.String(description="The user larst name", readonly=True),
         "slug": fields.String(description="The user permalink string", required=True),
-        "page": fields.UrlFor(
-            "users.show",
-            lambda u: {"user": u},
-            description="The user profile page URL",
+        "uri": fields.String(
+            attribute=lambda u: u.self_api_url(),
+            description="The API URI for this user",
             readonly=True,
-            fallback_endpoint="api.user",
         ),
-        "uri": fields.UrlFor(
-            "api.user", lambda o: {"user": o}, description="The user API URI", required=True
+        "page": fields.String(
+            attribute=lambda u: u.self_web_url(),
+            description="The user web page URL",
+            readonly=True,
         ),
         "avatar": fields.ImageField(original=True, description="The user avatar URL"),
         "avatar_thumbnail": fields.ImageField(
@@ -66,15 +66,15 @@ user_fields = api.model(
             description="The user last connection date (only present for global admins and on /me)",
             readonly=True,
         ),
-        "page": fields.UrlFor(
-            "users.show",
-            lambda u: {"user": u},
-            description="The user profile page URL",
+        "uri": fields.String(
+            attribute=lambda u: u.self_api_url(),
+            description="The API URI for this user",
             readonly=True,
-            fallback_endpoint="api.user",
         ),
-        "uri": fields.UrlFor(
-            "api.user", lambda o: {"user": o}, description="The user API URI", required=True
+        "page": fields.String(
+            attribute=lambda u: u.self_web_url(),
+            description="The user web page URL",
+            readonly=True,
         ),
         "metrics": fields.Raw(
             attribute=lambda o: o.get_metrics(), description="The user metrics", readonly=True