oarepo-runtime 1.5.107__tar.gz → 1.5.109__tar.gz

{oarepo_runtime-1.5.107/oarepo_runtime.egg-info → oarepo_runtime-1.5.109}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.107
+Version: 1.5.109
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

oarepo_runtime-1.5.109/oarepo_runtime/resources/config.py

@@ -0,0 +1,50 @@
+import marshmallow as ma
+from flask_resources import (
+    JSONDeserializer,
+    JSONSerializer,
+    RequestBodyParser,
+    ResponseHandler,
+)
+from invenio_drafts_resources.resources import RecordResourceConfig
+from invenio_rdm_records.resources.args import RDMSearchRequestArgsSchema
+from invenio_rdm_records.resources.config import (
+    RDMRecordResourceConfig,
+)
+from invenio_records_resources.resources.records.headers import etag_headers
+
+record_serializers = {
+    "application/json": ResponseHandler(JSONSerializer(), headers=etag_headers),
+}
+
+
+class BaseRecordResourceConfig(RDMRecordResourceConfig):
+    """Record resource configuration."""
+
+    blueprint_name = None
+    url_prefix = None
+
+    routes = RecordResourceConfig.routes
+
+    routes["delete-record"] = "/<pid_value>/delete"
+    routes["restore-record"] = "/<pid_value>/restore"
+    routes["set-record-quota"] = "/<pid_value>/quota"
+    routes["set-user-quota"] = "/users/<pid_value>/quota"
+    routes["all-prefix"] = "/all"
+
+    request_view_args = {
+        "pid_value": ma.fields.Str(),
+    }
+
+    request_read_args = {
+        "style": ma.fields.Str(),
+        "locale": ma.fields.Str(),
+        "include_deleted": ma.fields.Bool(),
+    }
+
+    request_body_parsers = {
+        "application/json": RequestBodyParser(JSONDeserializer()),
+    }
+
+    request_search_args = RDMSearchRequestArgsSchema
+
+    response_handlers = record_serializers

oarepo_runtime-1.5.109/oarepo_runtime/resources/resource.py

@@ -0,0 +1,59 @@
+from flask import g
+from flask_resources import (
+    resource_requestctx,
+    response_handler,
+    route,
+)
+from invenio_rdm_records.resources import RDMRecordResource
+from invenio_records_resources.resources.records.resource import (
+    request_extra_args,
+    request_search_args,
+    request_view_args,
+)
+from invenio_records_resources.resources.records.utils import search_preference
+
+
+class BaseRecordResource(RDMRecordResource):
+
+    def create_url_rules(self):
+        """Create the URL rules for the record resource."""
+
+        def p(route):
+            """Prefix a route with the URL prefix."""
+            return f"{self.config.url_prefix}{route}"
+
+        def s(route):
+            """Suffix a route with the URL prefix."""
+            return f"{route}{self.config.url_prefix}"
+
+        routes = self.config.routes
+        url_rules = super(RDMRecordResource, self).create_url_rules()
+        url_rules += [
+            route("DELETE", p(routes["delete-record"]), self.delete_record),
+            route("POST", p(routes["restore-record"]), self.restore_record),
+            route("POST", p(routes["set-record-quota"]), self.set_record_quota),
+            # TODO: move to users?
+            route("POST", routes["set-user-quota"], self.set_user_quota),
+            route("GET", s(routes["all-prefix"]), self.search_all_records),
+        ]
+
+        return url_rules
+
+    @request_extra_args
+    @request_search_args
+    @request_view_args
+    @response_handler(many=True)
+    def search_all_records(self):
+        """Perform a search over all records. Permission generators for search_all_records
+        and read_all_records must be in place and must be used to filter the results so that
+        no information is leaked.
+
+        GET /all/records
+        """
+        hits = self.service.search_all_records(
+            identity=g.identity,
+            params=resource_requestctx.args,
+            search_preference=search_preference(),
+            expand=resource_requestctx.args.get("expand", False),
+        )
+        return hits.to_dict(), 200

oarepo_runtime-1.5.109/oarepo_runtime/services/service.py

@@ -0,0 +1,61 @@
+"""An extension to invenio RDM service that includes a search across all records
+(published, draft and deleted).
+without any filtering. Permission `can_read_all_records` and `search_all_records`
+were added and must be used to filter the results so that no information is leaked.
+"""
+
+from invenio_rdm_records.services import RDMRecordService
+from invenio_records_resources.services import LinksTemplate
+
+
+class SearchAllRecordsService(RDMRecordService):
+    def search_all_records(
+        self,
+        identity,
+        params=None,
+        search_preference=None,
+        expand=False,
+        extra_filter=None,
+        **kwargs,
+    ):
+        """Search for drafts records matching the querystring."""
+        self.require_permission(
+            identity,
+            "search_all_records",
+            params=params,
+            extra_filter=extra_filter,
+            **kwargs,
+        )
+        # Prepare and execute the search
+        params = params or {}
+
+        search_opts = (
+            getattr(self.config, "search_all", None) or self.config.search_drafts
+        )
+
+        search_result = self._search(
+            "search_all",
+            identity,
+            params,
+            search_preference,
+            record_cls=self.draft_cls,
+            search_opts=search_opts,
+            extra_filter=extra_filter,
+            permission_action="read_all_records",
+            **kwargs,
+        ).execute()
+
+        return self.result_list(
+            self,
+            identity,
+            search_result,
+            params,
+            links_tpl=LinksTemplate(
+                getattr(self.config, "links_search_drafts")
+                or self.config.links_search_drafts,
+                context={"args": params},
+            ),
+            links_item_tpl=self.links_item_tpl,
+            expandable_fields=self.expandable_fields,
+            expand=expand,
+        )

{oarepo_runtime-1.5.107 → oarepo_runtime-1.5.109/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.107
+Version: 1.5.109
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.107 → oarepo_runtime-1.5.109}/oarepo_runtime.egg-info/SOURCES.txt

@@ -88,14 +88,17 @@ oarepo_runtime/records/systemfields/record_status.py
 oarepo_runtime/records/systemfields/selectors.py
 oarepo_runtime/records/systemfields/synthetic.py
 oarepo_runtime/resources/__init__.py
+oarepo_runtime/resources/config.py
 oarepo_runtime/resources/file_resource.py
 oarepo_runtime/resources/json_serializer.py
 oarepo_runtime/resources/localized_ui_json_serializer.py
+oarepo_runtime/resources/resource.py
 oarepo_runtime/services/__init__.py
 oarepo_runtime/services/components.py
 oarepo_runtime/services/generators.py
 oarepo_runtime/services/results.py
 oarepo_runtime/services/search.py
+oarepo_runtime/services/service.py
 oarepo_runtime/services/config/__init__.py
 oarepo_runtime/services/config/link_conditions.py
 oarepo_runtime/services/config/permissions_presets.py

{oarepo_runtime-1.5.107 → oarepo_runtime-1.5.109}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.5.107
+version = 1.5.109
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md