invenio-vocabularies 9.1.2__py2.py3-none-any.whl

invenio_vocabularies/contrib/funders/resources.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2022 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Funder vocabulary resources."""
+
+from .funders import record_type
+
+FundersResourceConfig = record_type.resource_config_cls
+
+FundersResource = record_type.resource_cls

invenio_vocabularies/contrib/funders/schema.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021-2022 CERN.
+# Copyright (C) 2024 California Institute of Technology.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Funders schema."""
+
+from functools import partial
+
+from invenio_i18n import lazy_gettext as _
+from marshmallow import (
+    ValidationError,
+    fields,
+    post_load,
+    pre_dump,
+    validate,
+    validates_schema,
+)
+from marshmallow_utils.fields import IdentifierSet, SanitizedUnicode
+from marshmallow_utils.schemas import IdentifierSchema
+
+from ...services.schema import BaseVocabularySchema, ContribVocabularyRelationSchema
+from .config import funder_schemes
+
+
+class FunderRelationSchema(ContribVocabularyRelationSchema):
+    """Funder schema."""
+
+    ftf_name = "name"
+    parent_field_name = "funder"
+    name = SanitizedUnicode(
+        validate=validate.Length(min=1, error=_("Name cannot be blank."))
+    )
+
+
+class FunderSchema(BaseVocabularySchema):
+    """Service schema for funders."""
+
+    name = SanitizedUnicode(
+        required=True, validate=validate.Length(min=1, error=_("Name cannot be blank."))
+    )
+    country = SanitizedUnicode()
+    country_name = SanitizedUnicode()
+    location_name = SanitizedUnicode()
+    identifiers = IdentifierSet(
+        fields.Nested(
+            partial(
+                IdentifierSchema,
+                allowed_schemes=funder_schemes,
+                identifier_required=False,
+            )
+        )
+    )
+
+    id = SanitizedUnicode(
+        validate=validate.Length(min=1, error=_("PID cannot be blank."))
+    )
+
+    acronym = SanitizedUnicode()
+    aliases = fields.List(SanitizedUnicode())
+    status = SanitizedUnicode()
+    types = fields.List(SanitizedUnicode())
+
+    @validates_schema
+    def validate_id(self, data, **kwargs):
+        """Validates ID."""
+        is_create = "record" not in self.context
+        if is_create and "id" not in data:
+            raise ValidationError(_("Missing PID."), "id")
+        if not is_create:
+            data.pop("id", None)
+
+    @post_load(pass_many=False)
+    def move_id(self, data, **kwargs):
+        """Moves id to pid."""
+        if "id" in data:
+            data["pid"] = data.pop("id")
+        return data
+
+    @pre_dump(pass_many=False)
+    def extract_pid_value(self, data, **kwargs):
+        """Extracts the PID value."""
+        data["id"] = data.pid.pid_value
+        return data

invenio_vocabularies/contrib/funders/serializer.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-2024 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Localization serializer for Funders."""
+
+from marshmallow import Schema, fields
+
+from invenio_vocabularies.resources import L10NString
+
+
+class IdentifierSchema(Schema):
+    """Identifier scheme."""
+
+    identifier = fields.String(dump_only=True)
+    scheme = fields.String(dump_only=True)
+
+
+class FunderL10NItemSchema(Schema):
+    """Funder serializer schema."""
+
+    id = fields.String(dump_only=True)
+    title = L10NString(data_key="title_l10n")
+    description = L10NString(data_key="description_l10n")
+    props = fields.Dict(dump_only=True)
+    name = fields.String(dump_only=True)
+    country = fields.String(dump_only=True)
+    country_name = fields.String(dump_only=True)
+    identifiers = fields.List(fields.Nested(IdentifierSchema), dump_only=True)

invenio_vocabularies/contrib/funders/services.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary affiliations."""
+
+from .funders import record_type
+
+FundersServiceConfig = record_type.service_config_cls
+
+FundersService = record_type.service_cls

invenio_vocabularies/contrib/names/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Names module."""
+
+from .resources import NamesResource, NamesResourceConfig
+from .services import NamesService, NamesServiceConfig
+
+__all__ = (
+    "NamesResource",
+    "NamesResourceConfig",
+    "NamesService",
+    "NamesServiceConfig",
+)

invenio_vocabularies/contrib/names/api.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary names."""
+
+from .names import record_type
+
+Name = record_type.record_cls

invenio_vocabularies/contrib/names/components.py

@@ -0,0 +1,24 @@
+#
+# This file is part of Invenio.
+# Copyright (C) 2024 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Names service components."""
+
+from invenio_records_resources.services.records.components import ServiceComponent
+
+
+class InternalIDComponent(ServiceComponent):
+    """Service component for internal id field."""
+
+    field = "internal_id"
+
+    def create(self, identity, data=None, record=None, **kwargs):
+        """Create handler."""
+        setattr(record, self.field, data.pop(self.field, None))
+
+    def update(self, identity, data=None, record=None, **kwargs):
+        """Update handler."""
+        setattr(record, self.field, data.pop(self.field, None))

invenio_vocabularies/contrib/names/config.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021-2024 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary names configuration."""
+
+from flask import current_app
+from invenio_i18n import lazy_gettext as _
+from invenio_records_resources.services import SearchOptions
+from invenio_records_resources.services.records.components import (
+    DataComponent,
+    RelationsComponent,
+)
+from invenio_records_resources.services.records.queryparser import (
+    CompositeSuggestQueryParser,
+)
+from werkzeug.local import LocalProxy
+
+from ...services.components import PIDComponent
+from .components import InternalIDComponent
+
+names_schemes = LocalProxy(lambda: current_app.config["VOCABULARIES_NAMES_SCHEMES"])
+
+
+class NamesSearchOptions(SearchOptions):
+    """Search options."""
+
+    suggest_parser_cls = CompositeSuggestQueryParser.factory(
+        fields=[
+            "name^5",
+            # We boost the affiliation acronym fields, since they're short and more
+            # likely to be used in a query.
+            "affiliations.acronym.keyword^3",
+            "affiliations.acronym",
+            "affiliations.name",
+            # Allow to search identifiers directly (e.g. ORCID)
+            "identifiers.identifier",
+        ],
+    )
+
+    sort_default = "bestmatch"
+
+    sort_default_no_query = "name"
+
+    sort_options = {
+        "bestmatch": dict(
+            title=_("Best match"),
+            fields=["_score"],  # ES defaults to desc on `_score` field
+        ),
+        "name": dict(
+            title=_("Name"),
+            fields=["name_sort"],
+        ),
+        "newest": dict(
+            title=_("Newest"),
+            fields=["-created"],
+        ),
+        "oldest": dict(
+            title=_("Oldest"),
+            fields=["created"],
+        ),
+    }
+
+
+service_components = [
+    # Order of components are important!
+    InternalIDComponent,
+    DataComponent,
+    PIDComponent,
+    RelationsComponent,
+]