oarepo-runtime 1.5.107__py3-none-any.whl → 1.5.109__py3-none-any.whl

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/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/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.dist-info → oarepo_runtime-1.5.109.dist-info}/METADATA

@@ -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.dist-info → oarepo_runtime-1.5.109.dist-info}/RECORD

@@ -76,14 +76,17 @@ oarepo_runtime/records/systemfields/record_status.py,sha256=U3kem4-JkNsT17e0iAl3
 oarepo_runtime/records/systemfields/selectors.py,sha256=Q9jE1smSN3heT2LIpK_jB6bIRjll1kX0AW9AhTsIYiU,2830
 oarepo_runtime/records/systemfields/synthetic.py,sha256=UustvhzcDGuaNZLDeHbWwshoxQR-qRIuHDCct5RXmrI,4287
 oarepo_runtime/resources/__init__.py,sha256=v8BGrOTu_FjKzd0eozV7Q4GoGxyfybsL2cI-tbP5Pys,185
+oarepo_runtime/resources/config.py,sha256=GEM3A7lvGgWUdhBR85uJbaQDKg2-Xk5U-Jm4JmogfFg,1414
 oarepo_runtime/resources/file_resource.py,sha256=Ta3bFce7l0xwqkkOMOEu9mxbB8BbKj5HUHRHmidhnl8,414
 oarepo_runtime/resources/json_serializer.py,sha256=82_-xQEtxKaPakv8R1oBAFbGnxskF_Ve4tcfcy4PetI,963
 oarepo_runtime/resources/localized_ui_json_serializer.py,sha256=3V9cJaG_e1PMXKVX_wKfBp1LmbeForwHyBNYdyha4uQ,1878
+oarepo_runtime/resources/resource.py,sha256=GK5yGnJIjH60wGqqDoOfwMQQFQDLZhJpU4zBJOmABI8,2063
 oarepo_runtime/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 oarepo_runtime/services/components.py,sha256=0aqmuNbGCQhfOI22f6mM2DxuKSTqstGOGyisOiqw9KE,15481
 oarepo_runtime/services/generators.py,sha256=j87HitHA_w2awsz0C5IAAJ0qjg9JMtvdO3dvh6FQyfg,250
 oarepo_runtime/services/results.py,sha256=Ap2mUJHl3V4BSduTrBWPuco0inQVq0QsuCbVhez48uY,5705
 oarepo_runtime/services/search.py,sha256=t0WEe2VrbCzZ06-Jgz7C9-pc9y27BqAgTEXldEHskfk,9409
+oarepo_runtime/services/service.py,sha256=TI2ulEVlSR7HZnfPYltLl8Vf4O9fhJ7rHaV6G4HWbrc,1893
 oarepo_runtime/services/config/__init__.py,sha256=559w4vphVAipa420OwTsxGUP-b7idoqSIX13FSJyVz0,783
 oarepo_runtime/services/config/link_conditions.py,sha256=evPRd5XU76Ok4J-08bBfplbHZ019rl74FpJmO8iM5yg,3298
 oarepo_runtime/services/config/permissions_presets.py,sha256=jV3Ft7xFdBaeShoa3Q3Q-HHWP-wOX4XYDTRzWwUVL7g,7151
@@ -143,9 +146,9 @@ tests/marshmallow_to_json/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 tests/marshmallow_to_json/test_datacite_ui_schema.py,sha256=82iLj8nW45lZOUewpWbLX3mpSkpa9lxo-vK-Qtv_1bU,48552
 tests/marshmallow_to_json/test_simple_schema.py,sha256=izZN9p0v6kovtSZ6AdxBYmK_c6ZOti2_z_wPT_zXIr0,1500
 tests/pkg_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime-1.5.107.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-1.5.107.dist-info/METADATA,sha256=Z_a-shCynRJPgujCqljVNhXARmPVt8Q6lcJ1Eexd_oQ,4721
-oarepo_runtime-1.5.107.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-oarepo_runtime-1.5.107.dist-info/entry_points.txt,sha256=k7O5LZUOGsVeSpB7ulU0txBUNp1CVQG7Q7TJIVTPbzU,491
-oarepo_runtime-1.5.107.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
-oarepo_runtime-1.5.107.dist-info/RECORD,,
+oarepo_runtime-1.5.109.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-1.5.109.dist-info/METADATA,sha256=mUMQ-D-mCSYUFtvaX5WL18tv1L4a6JrclX6bua5RncI,4721
+oarepo_runtime-1.5.109.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+oarepo_runtime-1.5.109.dist-info/entry_points.txt,sha256=k7O5LZUOGsVeSpB7ulU0txBUNp1CVQG7Q7TJIVTPbzU,491
+oarepo_runtime-1.5.109.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
+oarepo_runtime-1.5.109.dist-info/RECORD,,