oarepo-runtime 2.0.0.dev30__tar.gz → 2.0.0.dev31__tar.gz

{oarepo_runtime-2.0.0.dev30 → oarepo_runtime-2.0.0.dev31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev30
+Version: 2.0.0.dev31
 Summary: A set of runtime extensions of Invenio repository
 Project-URL: Homepage, https://github.com/oarepo/oarepo-runtime
 License-Expression: MIT

{oarepo_runtime-2.0.0.dev30 → oarepo_runtime-2.0.0.dev31}/oarepo_runtime/__init__.py

@@ -19,6 +19,6 @@ from .api import Model
 from .ext import OARepoRuntime
 from .proxies import current_runtime
 
-__version__ = "2.0.0dev30"
+__version__ = "2.0.0dev31"
 
 __all__ = ("Model", "OARepoRuntime", "__version__", "current_runtime")

{oarepo_runtime-2.0.0.dev30 → oarepo_runtime-2.0.0.dev31}/oarepo_runtime/info/views.py

@@ -16,13 +16,12 @@ import logging
 import os
 import re
 from functools import cached_property
-from typing import TYPE_CHECKING, Any, ClassVar, cast
+from typing import TYPE_CHECKING, Any, ClassVar, Protocol, cast
 from urllib.parse import urljoin, urlparse, urlunparse
 
 import marshmallow as ma
 from flask import Blueprint, Flask, current_app, request, url_for
 from flask_resources import (
-    Resource,
     ResourceConfig,
     from_conf,
     request_parser,
@@ -30,6 +29,7 @@ from flask_resources import (
     response_handler,
     route,
 )
+from flask_resources.resources import Resource as BaseResource
 from invenio_base import invenio_url_for
 from invenio_base.utils import obj_or_import_string
 from invenio_jsonschemas import current_jsonschemas
@@ -38,16 +38,30 @@ from invenio_records_resources.proxies import (
 )
 from werkzeug.routing import BuildError
 
+from oarepo_runtime.proxies import current_runtime
+
 if TYPE_CHECKING:
     from invenio_records.systemfields import ConstantField
     from invenio_records_resources.records.api import Record
 
     from oarepo_runtime import Model
-from oarepo_runtime.proxies import current_runtime
 
 logger = logging.getLogger("oarepo_runtime.info")
 
 
+class InfoComponent(Protocol):
+    """Info component protocol."""
+
+    def __init__(self, resource: InfoResource) -> None:
+        """Create the component."""
+
+    def repository(self, data: dict) -> None:
+        """Modify repository info endpoint data."""
+
+    def model(self, data: list[dict]) -> None:
+        """Modify model info endpoint data."""
+
+
 class InfoConfig(ResourceConfig):
     """Info resource config."""
 
@@ -62,16 +76,19 @@ class InfoConfig(ResourceConfig):
         self.app = app
 
     @cached_property
-    def components(self) -> tuple[object, ...]:
+    def components(self) -> tuple[type[InfoComponent], ...]:
         """Get the components for the info resource from config."""
-        return tuple(obj_or_import_string(x) for x in self.app.config.get("INFO_ENDPOINT_COMPONENTS", []))
+        return tuple(
+            cast("type[InfoComponent]", obj_or_import_string(x))
+            for x in self.app.config.get("INFO_ENDPOINT_COMPONENTS", [])
+        )
 
 
 schema_view_args = request_parser(from_conf("schema_view_args"), location="view_args")
 model_view_args = request_parser(from_conf("model_view_args"), location="view_args")
 
 
-class InfoResource(Resource):
+class InfoResource(BaseResource):
     """Info resource."""
 
     def create_url_rules(self) -> list[dict[str, Any]]:
@@ -149,6 +166,7 @@ class InfoResource(Resource):
             feature_keys.append("files")
         return feature_keys
 
+    # TODO: this should be done differently - we should add this to the model
     def _get_model_html_endpoint(self, model: Model) -> Any:
         base = self._get_model_api_endpoint(model)
         if not base:
@@ -160,7 +178,7 @@ class InfoResource(Resource):
         try:
             alias = model.api_blueprint_name
             return model.api_url("search", type=alias, _external=True)
-        except BuildError:
+        except BuildError:  # pragma: no cover
             logger.exception("Failed to get model api endpoint")
             return None
 
@@ -181,7 +199,7 @@ class InfoResource(Resource):
             service = model.service
             service_class = model.service.__class__
             if not service or not isinstance(service, service_class):
-                continue
+                continue  # pragma: no cover - sanity check
 
             model_features = self._get_model_features(model)
 

oarepo_runtime-2.0.0.dev31/oarepo_runtime/services/config/permissions.py

@@ -0,0 +1,82 @@
+# mypy: disable-error-code="assignment"
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""Everyone permissions."""
+
+from __future__ import annotations
+
+from invenio_records_permissions import RecordPermissionPolicy
+from invenio_records_permissions.generators import AnyUser, Generator, SystemProcess
+
+
+class EveryonePermissionPolicy(RecordPermissionPolicy):
+    """Record policy for read-only repository."""
+
+    can_search: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_read: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_create: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_update: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_delete: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_manage: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+
+    can_create_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_set_content_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_get_content_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_commit_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_read_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_update_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_delete_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_list_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_manage_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+
+    can_edit: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_new_version: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_search_drafts: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_read_draft: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_search_versions: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_update_draft: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_delete_draft: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_publish: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_create_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_set_content_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_get_content_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_commit_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_read_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_update_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_delete_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+
+    can_add_community: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_remove_community: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+
+    can_read_deleted: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_manage_record_access: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_lift_embargo: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+
+    can_draft_media_create_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_media_read_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_media_set_content_files: tuple[Generator, ...] = (
+        SystemProcess(),
+        AnyUser(),
+    )
+    can_draft_media_get_content_files: tuple[Generator, ...] = (
+        SystemProcess(),
+        AnyUser(),
+    )
+    can_draft_media_commit_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_media_update_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_draft_media_delete_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+
+    can_media_read_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_media_get_content_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_media_create_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_media_set_content_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_media_commit_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_media_update_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())
+    can_media_delete_files: tuple[Generator, ...] = (SystemProcess(), AnyUser())

oarepo_runtime-2.0.0.dev31/oarepo_runtime/services/records/links.py

@@ -0,0 +1,65 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""Utility for rendering URI template links."""
+
+from __future__ import annotations
+
+from invenio_records_resources.services.base.links import EndpointLink
+
+
+def rdm_pagination_record_endpoint_links(endpoint: str, params: list[str] | None = None) -> dict[str, EndpointLink]:
+    """Create pagination links (prev/self/next) from the same endpoint.
+
+    These links are used on a record instance where we want to have a list of something,
+    for example /records/<pid>/versions.
+
+    Note: using RecordEndpointLink here is fragile as it normally expects
+    a record as the first argument to vars, but here we pass pagination
+    as the first argument to vars. Because pagination does not have pid_value
+    attribute, the vars method will just skip adding pid_value to vars and
+    the pid_value must be passed via params. This is done in invenio_rdm_records'
+    service but not in invenio_drafts_resources service, where the parameter is
+    called "id" instead of "pid_value". That is why this function is called rdm_...
+    """
+    params = [*(params or []), "pid_value"]
+    return {
+        "prev": EndpointLink(
+            endpoint,
+            when=lambda pagination, _ctx: pagination.has_prev,
+            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.prev_page.page}),
+            params=params,
+        ),
+        "self": EndpointLink(endpoint, params=params),
+        "next": EndpointLink(
+            endpoint,
+            when=lambda pagination, _ctx: pagination.has_next,
+            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.next_page.page}),
+            params=params,
+        ),
+    }
+
+
+def pagination_endpoint_links_html(endpoint: str, params: list[str] | None = None) -> dict[str, EndpointLink]:
+    """Create pagination links (prev/self/next) from the same endpoint."""
+    return {
+        "prev_html": EndpointLink(
+            endpoint,
+            when=lambda pagination, _ctx: pagination.has_prev,
+            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.prev_page.page}),
+            params=params,
+        ),
+        "self_html": EndpointLink(endpoint, params=params),
+        "next_html": EndpointLink(
+            endpoint,
+            when=lambda pagination, _ctx: pagination.has_next,
+            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.next_page.page}),
+            params=params,
+        ),
+    }

{oarepo_runtime-2.0.0.dev30 → oarepo_runtime-2.0.0.dev31}/oarepo_runtime/services/schema/ui.py

@@ -73,7 +73,13 @@ class LocalizedDate(LocalizedMixin, FormatDate):
 class FormatTimeString(FormatTime):
     """Time formater."""
 
-    def parse(self, value: Any, as_time: bool = False, as_date: bool = False, as_datetime: bool = False) -> Any:
+    def parse(
+        self,
+        value: Any,
+        as_time: bool = False,
+        as_date: bool = False,
+        as_datetime: bool = False,
+    ) -> Any:
         """Parse date value."""
         if value and isinstance(value, str) and as_time:
             match = re.match(r"^(\d|0\d|1\d|2[0-3]):(\d|[0-5]\d|60)(:(\d|[0-5]\d|60))?$", value)
@@ -98,7 +104,12 @@ class MultilayerFormatEDTF(BabelFormatField):
             return format_edtf(value, format=self._format, locale=self.locale)
 
     def parse(
-        self, value: str, as_time: bool = False, as_date: bool = False, as_datetime: bool = False, **kwargs: Any
+        self,
+        value: str,
+        as_time: bool = False,
+        as_date: bool = False,
+        as_datetime: bool = False,
+        **kwargs: Any,
     ) -> Any:
         """Parse date value."""
         _, _, _ = as_time, as_date, as_datetime

oarepo_runtime-2.0.0.dev30/oarepo_runtime/services/config/permissions.py

@@ -1,87 +0,0 @@
-# mypy: disable-error-code="assignment"
-#
-# Copyright (c) 2025 CESNET z.s.p.o.
-#
-# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
-#
-# oarepo-runtime is free software; you can redistribute it and/or modify it
-# under the terms of the MIT License; see LICENSE file for more details.
-#
-
-"""Everyone permissions."""
-
-from __future__ import annotations
-
-from collections.abc import Collection
-from typing import ClassVar
-
-from invenio_records_permissions import RecordPermissionPolicy
-from invenio_records_permissions.generators import AnyUser, Generator, SystemProcess
-
-type GeneratorList = Collection[Generator]
-
-
-class EveryonePermissionPolicy(RecordPermissionPolicy):
-    """Record policy for read-only repository."""
-
-    can_search: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_read: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_create: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_update: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_delete: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_manage: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-
-    can_create_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_set_content_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_get_content_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_commit_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_read_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_update_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_delete_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_list_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_manage_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-
-    can_edit: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_new_version: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_search_drafts: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_read_draft: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_search_versions: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_update_draft: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_delete_draft: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_publish: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_create_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_set_content_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_get_content_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_commit_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_read_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_update_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_delete_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-
-    can_add_community: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_remove_community: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-
-    can_read_deleted: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_manage_record_access: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_lift_embargo: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-
-    can_draft_media_create_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_media_read_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_media_set_content_files: ClassVar[GeneratorList] = (
-        SystemProcess(),
-        AnyUser(),
-    )
-    can_draft_media_get_content_files: ClassVar[GeneratorList] = (
-        SystemProcess(),
-        AnyUser(),
-    )
-    can_draft_media_commit_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_media_update_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_draft_media_delete_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-
-    can_media_read_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_media_get_content_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_media_create_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_media_set_content_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_media_commit_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_media_update_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())
-    can_media_delete_files: ClassVar[GeneratorList] = (SystemProcess(), AnyUser())

oarepo_runtime-2.0.0.dev30/oarepo_runtime/services/records/links.py

@@ -1,33 +0,0 @@
-#
-# Copyright (c) 2025 CESNET z.s.p.o.
-#
-# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
-#
-# oarepo-runtime is free software; you can redistribute it and/or modify it
-# under the terms of the MIT License; see LICENSE file for more details.
-#
-
-"""Utility for rendering URI template links."""
-
-from __future__ import annotations
-
-from invenio_records_resources.services.base.links import EndpointLink
-
-
-def pagination_endpoint_links_html(endpoint: str, params: list[str] | None = None) -> dict[str, EndpointLink]:
-    """Create pagination links (prev/self/next) from the same endpoint."""
-    return {
-        "prev_html": EndpointLink(
-            endpoint,
-            when=lambda pagination, _ctx: pagination.has_prev,
-            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.prev_page.page}),
-            params=params,
-        ),
-        "self_html": EndpointLink(endpoint, params=params),
-        "next_html": EndpointLink(
-            endpoint,
-            when=lambda pagination, _ctx: pagination.has_next,
-            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.next_page.page}),
-            params=params,
-        ),
-    }