invenio-pidstore-extra 0.2.0__tar.gz

invenio_pidstore_extra-0.2.0/.gitignore

@@ -0,0 +1,65 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# Idea software family
+.idea/
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+Pipfile
+Pipfile.lock
+uv.lock
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Vim swapfiles
+.*.sw?

invenio_pidstore_extra-0.2.0/.gitlab-ci.yml

@@ -0,0 +1,4 @@
+include:
+  - project: 'ULB/dd-wi/inveniordm/automatization-templating/pipeline-templates'
+    ref: main
+    file: 'package-gitlab-ci.yml'

invenio_pidstore_extra-0.2.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+..
+    Copyright (C) 2025 University of Münster.
+
+    invenio-pidstore-extra is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+Authors
+=======
+
+Module that adds URN minting by DNB epicur service
+
+- University of Münster <forschungsdaten@uni-muenster.de>

invenio_pidstore_extra-0.2.0/CHANGES.rst

@@ -0,0 +1,19 @@
+..
+    Copyright (C) 2024-2025 University of Münster.
+
+    invenio-urn-provider is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+Changes
+=======
+
+Version 0.2.0
+
+- fully integrated the rest wrapper to DNB urn service
+- adapted to InvenioRDM v13
+- added a new component to set a successor of an URN if a new version has been published
+
+Version 0.1.0 (released TBD)
+
+- Initial public release.

invenio_pidstore_extra-0.2.0/CONTRIBUTING.rst

@@ -0,0 +1,8 @@
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Types of Contributions
+----------------------

invenio_pidstore_extra-0.2.0/INSTALL.rst

@@ -0,0 +1,8 @@
+Installation
+============
+
+invenio-pidstore-extra is on PyPI so all you need is:
+
+.. code-block:: console
+
+   $ pip install invenio-pidstore-extra

invenio_pidstore_extra-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2024 University of Münster.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

invenio_pidstore_extra-0.2.0/MANIFEST.in

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024-2025 University of Münster.
+#
+# invenio-urn-provider is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+# TODO: Generate this manifest file by running the following commands:
+# (please sort the lines in this file after running below commands)
+#
+#  git init
+#  git add -A
+#  pip install -e .[all]
+#  check-manifest -u
+
+# added by check-manifest
+include *.in
+include *.rst
+include *.sh
+include *.txt
+include *.yml
+include babel.ini
+recursive-include tests *.ini
+recursive-include tests *.py

invenio_pidstore_extra-0.2.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.3
+Name: invenio_pidstore_extra
+Version: 0.2.0
+Dynamic: Description
+Dynamic: Description-Content-Type
+Summary: Module that adds URN minting by DNB epicur service.
+Project-URL: Homepage, https://github.com/ulbmuenster/invenio-pidstore-extra
+Author-email: University of Münster <forschungsdaten@uni-muenster.de>
+License: MIT
+Keywords: dnb,invenio,rdm,urn
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Requires-Dist: arrow>=1.3.0
+Requires-Dist: flask>=3.1.0
+Requires-Dist: idutils>=1.4.2
+Requires-Dist: invenio-pidstore>=2.0.0
+Requires-Dist: invenio-rdm-records>=17.0.2
+Requires-Dist: invenio-search>=3.0.0
+Requires-Dist: opensearch-dsl>=2.1.0
+Provides-Extra: tests
+Requires-Dist: check-manifest; extra == 'tests'
+Requires-Dist: invenio-app>=2.1.0; extra == 'tests'
+Requires-Dist: pytest-black-ng>=0.4.0; extra == 'tests'
+Requires-Dist: pytest-cov==6.1.1; extra == 'tests'
+Requires-Dist: pytest-docstyle==2.0.1; extra == 'tests'
+Requires-Dist: pytest-env==1.1.5; extra == 'tests'
+Requires-Dist: pytest-invenio>=3.3.0; extra == 'tests'
+Requires-Dist: pytest-isort==4.0.0; extra == 'tests'
+Requires-Dist: pytest-mock>=3.12.0; extra == 'tests'
+Requires-Dist: pytest==8.3.5; extra == 'tests'
+Requires-Dist: sphinx>=4.5.0; extra == 'tests'

invenio_pidstore_extra-0.2.0/README.rst

@@ -0,0 +1,75 @@
+..
+    Copyright (C) 2024-2025 University of Münster.
+
+    invenio-pidstore-extra is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+=======================
+ invenio-pidstore-extra
+=======================
+
+Module that adds URN minting by DNB epicur service.
+
+InvenioRDM supports DOI minting with Datacite out of the box. This module adds support for URN minting by using the
+URN API published by German National Library (DNB).
+
+Configuration
+=============
+
+After adding the module to your InvenioRDM instance you need to add the following snippet to your `invenio.cfg`.
+Make sure you have registered at the DNB and set the config variables below to the correct values!
+
+When putting this to production, set `PIDSTORE_EXTRA_TEST_MODE = False`!
+
+.. code-block:: python
+
+    PIDSTORE_EXTRA_DNB_SANDBOX_URI = "http://127.0.0.1:8000/"
+
+    PIDSTORE_EXTRA_DNB_ENABLED = True
+    PIDSTORE_EXTRA_DNB_USERNAME = "username"
+    PIDSTORE_EXTRA_DNB_PASSWORD = "password"
+    PIDSTORE_EXTRA_DNB_ID_PREFIX = "urn:nbn:de:hbz:6"
+    PIDSTORE_EXTRA_FORMAT = "{prefix}-{id}"
+    PIDSTORE_EXTRA_TEST_MODE = True
+
+    #
+    # Persistent identifiers configuration
+    #
+    from invenio_rdm_records.config import RDM_PERSISTENT_IDENTIFIER_PROVIDERS as DEFAULT_PERSISTENT_IDENTIFIER_PROVIDERS
+    from invenio_pidstore_extra import providers
+
+    RDM_PERSISTENT_IDENTIFIER_PROVIDERS = DEFAULT_PERSISTENT_IDENTIFIER_PROVIDERS + [
+        providers.DnbUrnProvider(
+          "urn",
+          client=providers.DNBUrnClient("dnb", PIDSTORE_EXTRA_DNB_ID_PREFIX, PIDSTORE_EXTRA_DNB_USERNAME, PIDSTORE_EXTRA_DNB_PASSWORD, PIDSTORE_EXTRA_FORMAT),
+          label=_("URN"),
+        ),
+    ]
+
+    from invenio_rdm_records.config import RDM_PERSISTENT_IDENTIFIERS as DEFAULT_PERSISTENT_IDENTIFIERS
+
+    RDM_PERSISTENT_IDENTIFIERS = {
+        **DEFAULT_PERSISTENT_IDENTIFIERS,
+        "urn": {
+          "providers": ["urn"],
+          "required": True,
+          "label": _("URN"),
+          "is_enabled": providers.DnbUrnProvider.is_enabled,
+        },
+    }
+
+    from invenio_pidstore_extra.services.components import URNRelationsComponent
+    from invenio_rdm_records.services.components import DefaultRecordsComponents
+
+    RDM_RECORDS_SERVICE_COMPONENTS = DefaultRecordsComponents + [URNRelationsComponent]
+
+Development
+===========
+
+The flask app `invenio_pidstore_extra.dnb-sandbox.py` contains a very simple implementation of the DNB api to allow testing the URN support when the DNB sandbox is not available or just no user has been provided. You can start it with calling
+
+.. code-block:: console
+
+   flask --app invenio_pidstore_extra.dnb-sandbox run --port=8000
+

invenio_pidstore_extra-0.2.0/babel.ini

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 University of Münster.
+#
+# invenio-pidstore-extra is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+# Extraction from Python source files
+
+[python: **.py]
+encoding = utf-8
+
+# Extraction from Jinja2 templates
+
+[jinja2: **/templates/**.html]
+encoding = utf-8
+extensions = jinja2.ext.autoescape, jinja2.ext.with_
+
+# Extraction from JavaScript files
+
+[javascript: **.js]
+encoding = utf-8
+extract_messages = $._, jQuery._

invenio_pidstore_extra-0.2.0/invenio_pidstore_extra/__init__.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 University of Münster.
+#
+# invenio-pidstore-extra is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Module that adds URN minting by DNB epicur service."""
+
+from .ext import InvenioUrnProvider
+
+__version__ = "0.2.0"
+
+__all__ = ("__version__", "InvenioUrnProvider")

invenio_pidstore_extra-0.2.0/invenio_pidstore_extra/config.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 University of Münster.
+#
+# invenio-pidstore-extra is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Module that adds URN minting by DNB epicur service."""
+
+PIDSTORE_EXTRA_DNB_ENABLED = True
+"""The URN provider is by default enabled (or why would you have installed the module?)."""
+
+PIDSTORE_EXTRA_TEST_MODE = True
+"""Set to 'False' if you want to mint real URN's."""
+
+PIDSTORE_EXTRA_DNB_USERNAME = "username"
+"""A username provided for you by DNB if you have a legal contract."""
+
+PIDSTORE_EXTRA_DNB_PASSWORD = "password"
+"""The corresponding password."""
+
+PIDSTORE_EXTRA_DNB_ID_PREFIX = "urn:nbn:dnb:provider:"
+"""Just an example! Please replace by prefix provided by DNB."""
+
+PIDSTORE_EXTRA_DNB_SANDBOX_URI = "https://api.nbn-resolving.org/sandbox/v2/"
+"""In case the sandbox is not available this setting allows configuration of a different URI."""
+
+PIDSTORE_EXTRA_FORMAT = "{prefix}-{id}"
+"""The format of the URN."""

invenio_pidstore_extra-0.2.0/invenio_pidstore_extra/dnb-sandbox.py

@@ -0,0 +1,204 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 University of Münster.
+#
+# invenio-pidstore-extra is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Simple implementation of DNB URN API."""
+
+import base64
+import random
+
+import arrow
+from flask import Flask, jsonify, request
+
+app = Flask(__name__)
+namespace = "urn:nbn:de:hbz:6-"
+
+
+@app.route("/namespaces/name/<name>", methods=["GET"])
+def namespace_info(name: str):
+    """Implementation of namespaces API."""
+    now = arrow.utcnow().isoformat()
+    return jsonify(
+        {
+            "name": name,
+            "created": now,
+            "lastModified": now,
+            "allowsRegistration": True,
+            "owner": "http://localhost:8000/organisations/id/1",
+            "urnNamingPolicy": "http://localhost:8000/policies/urn-naming/id/no-check",
+            "urlPolicy": "http://localhost:8000/policies/url/id/no-check",
+            "resolverUrl": "",
+            "urns": request.url + "/urns",
+            "urnSuggestion": request.url + "/urn-suggestion",
+            "self": request.url,
+        }
+    )
+
+
+@app.route("/namespaces/name/<name>/urn-suggestion", methods=["GET"])
+def suggest(name: str):
+    """Implementation of suggest API."""
+    return jsonify(
+        {
+            "suggestedUrn": name + str(random.randrange(1000000000, 9999999999, 1)),
+            "namespace": request.url[: request.url.find("/urn-suggestion")],
+            "self": request.url,
+        }
+    )
+
+
+@app.route("/urns", methods=["POST"])
+def register():
+    """Implementation of URN registration API."""
+    now = arrow.utcnow().isoformat()
+    content = request.json
+    return (
+        jsonify(
+            {
+                "urn": content["urn"],
+                "created": now,
+                "lastModified": now,
+                "namespace": "http://localhost:8000/namespaces/name/" + namespace,
+                "successor": None,
+                "urls": request.url + "/urn/" + content["urn"] + "/urls",
+                "myUrls": request.url + "/urn/" + content["urn"] + "/my-urls",
+                "self": request.url + "/urn/" + content["urn"],
+            }
+        ),
+        201,
+    )
+
+
+@app.route("/urns/urn/<urn>", methods=["HEAD"])
+def check_existence(urn: str):
+    """Implementation of check for existence API."""
+    if urn.startswith(namespace):
+        suffix = urn[len(namespace) :]
+        if int(suffix) < 5000000000:
+            return "", 200
+    return "", 404
+
+
+@app.route("/urns/urn/<urn>", methods=["GET"])
+def get_urn(urn: str):
+    """Implementation of get URN API."""
+    if urn.startswith(namespace):
+        suffix = urn[len(namespace) :]
+        if int(suffix) < 5000000000:
+            now = arrow.utcnow().isoformat()
+            return jsonify(
+                {
+                    "urn": urn,
+                    "created": now,
+                    "lastModified": now,
+                    "namespace": "http://localhost:8000/namespaces/name/" + namespace,
+                    "successor": None,
+                    "urls": request.url + "/urls",
+                    "myUrls": request.url + "/my-urls",
+                    "self": request.url,
+                }
+            )
+    return "", 404
+
+
+@app.route("/urns/urn/<urn>/urls", methods=["GET"])
+def get_url(urn: str):
+    """Implementation of get URL API."""
+    return get_urls(urn, "/urls")
+
+
+@app.route("/urns/urn/<urn>/my-urls", methods=["GET"])
+def get_my_url(urn: str):
+    """Implementation of get my URL API."""
+    return get_urls(urn, "/my-urls")
+
+
+@app.route("/urns/urn/<urn>/urls/base64/<encoded>", methods=["GET"])
+def get_single_url(urn: str, encoded: str):
+    """Implementation of get single URL API."""
+    now = arrow.utcnow().isoformat()
+    return jsonify(
+        {
+            "url": base64.b64decode(bytes(encoded, "utf-8")).decode("utf-8"),
+            "created": now,
+            "lastModified": now,
+            "urn": request.url[: request.url.find("/urls")],
+            "owner": "http://localhost:8000/organisations/id/1",
+            "priority": 10,
+            "self": request.url,
+        }
+    )
+
+
+@app.route("/urns/urn/<urn>/urls", methods=["POST"])
+def add_url(urn: str):
+    """Implementation of add URL API."""
+    now = arrow.utcnow().isoformat()
+    content = request.json
+    return jsonify(
+        {
+            "url": content["url"],
+            "created": now,
+            "lastModified": now,
+            "urn": request.url[: request.url.find("/urls")],
+            "owner": "http://localhost:8000/organisations/id/1",
+            "priority": 10,
+            "self": request.url
+            + "/urls/base64/"
+            + base64.b64encode(bytes(content["url"], "utf-8")).decode("utf-8"),
+        }
+    )
+
+
+@app.route("/urns/urn/<urn>/urls/base64/<encoded>", methods=["DELETE"])
+def remove_url(urn: str, encoded: str):
+    """Implementation of remove URL API."""
+    return "", 204
+
+
+@app.route("/urns/urn/<urn>/my-urls", methods=["PATCH"])
+def add_my_url(urn: str):
+    """Implementation of add my URL API."""
+    return "", 204
+
+
+@app.route("/urns/urn/<urn>", methods=["PATCH"])
+def set_successor(urn: str):
+    """Implementation of set successor  API."""
+    return "", 204
+
+
+def get_urls(urn: str, query: str):
+    """Helper method."""
+    if urn.startswith(namespace):
+        suffix = urn[len(namespace) :]
+        if int(suffix) < 5000000000:
+            now = arrow.utcnow().isoformat()
+            find_urls = request.url.rfind(query)
+            return jsonify(
+                {
+                    "totalItems": 1,
+                    "items": [
+                        {
+                            "url": "http://example.org/document-url",
+                            "created": now,
+                            "lastModified": now,
+                            "urn": request.url[:find_urls],
+                            "owner": "http://localhost:8000/organisations/id/1",
+                            "priority": 10,
+                            "self": request.url[:find_urls]
+                            + "/urls/base64/aHR0cDovL2V4YW1wbGUub3JnL2RvY3VtZW50LXVybA==",
+                        }
+                    ],
+                    "self": request.url,
+                }
+            )
+    return "", 404
+
+
+if __name__ == "__main__":
+    app.run()

invenio_pidstore_extra-0.2.0/invenio_pidstore_extra/ext.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 University of Münster.
+#
+# invenio-pidstore-extra is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Module that adds URN minting by DNB epicur service."""
+
+from . import config
+
+
+class InvenioUrnProvider(object):
+    """invenio-pidstore-extra extension."""
+
+    def __init__(self, app=None):
+        """Extension initialization."""
+        if app:
+            self.init_app(app)
+
+    def init_app(self, app):
+        """Flask application initialization."""
+        self.init_config(app)
+        app.extensions["invenio-pidstore-extra"] = self
+
+    def init_config(self, app):
+        """Initialize configuration."""
+        # Use theme's base template if theme is installed
+        for k in dir(config):
+            if k.startswith("PIDSTORE_EXTRA_"):
+                app.config.setdefault(k, getattr(config, k))

invenio_pidstore_extra-0.2.0/invenio_pidstore_extra/providers/__init__.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 University of Münster.
+#
+# invenio-pidstore-extra is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""URN providers."""
+
+
+from .dnb import DNBUrnClient, DnbUrnProvider
+
+__all__ = (DNBUrnClient, DnbUrnProvider)