oarepo-doi 1.0.2__tar.gz

oarepo_doi-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2021 CESNET.
+
+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.

oarepo_doi-1.0.2/MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include oarepo_doi *
+prune tests
+prune thesis

oarepo_doi-1.0.2/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: oarepo-doi
+Version: 1.0.2
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: invenio-requests
+Requires-Dist: oarepo-requests
+Provides-Extra: tests
+Requires-Dist: oarepo-model-builder-tests; extra == "tests"
+Requires-Dist: oarepo-requests; extra == "tests"
+
+# OARepo DOI

oarepo_doi-1.0.2/README.md

@@ -0,0 +1 @@
+# OARepo DOI

oarepo_doi-1.0.2/oarepo_doi/actions/doi.py

@@ -0,0 +1,74 @@
+from invenio_requests.customizations import actions
+from flask import current_app
+from oarepo_doi.api import create_doi, edit_doi
+
+class CreateDoiAction(actions.CreateAction):
+    log_event = True
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.mode = current_app.config.get("DATACITE_MODE")
+        self.url = current_app.config.get("DATACITE_URL")
+        self.mapping = current_app.config.get("DATACITE_MAPPING")
+
+        self.username = None
+        self.password = None
+        self.prefix = None
+
+    def credentials(self, community):
+        credentials_def = current_app.config.get("DATACITE_CREDENTIALS")
+
+        community_credentials = getattr(credentials_def, community, None)
+        if community_credentials is None and "DATACITE_CREDENTIALS_DEFAULT" in current_app.config:
+            community_credentials = current_app.config.get("DATACITE_CREDENTIALS_DEFAULT")
+        self.username = community_credentials["username"]
+        self.password = community_credentials["password"]
+        self.prefix = community_credentials["prefix"]
+
+    def execute(self, identity, uow, *args, **kwargs):
+
+        topic = self.request.topic.resolve()
+        self.credentials(topic['parent']['communities']['default'])
+
+        if topic.is_draft:
+            create_doi(self, topic, topic["metadata"], None)
+        else:
+            create_doi(self, topic, topic["metadata"], "publish")
+        super().execute(identity, uow)
+
+
+class EditDoiAction(actions.AcceptAction):
+    log_event = True
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.mode = current_app.config.get("DATACITE_MODE")
+        self.url = current_app.config.get("DATACITE_URL")
+        self.mapping = current_app.config.get("DATACITE_MAPPING")
+
+        self.username = None
+        self.password = None
+        self.prefix = None
+
+    def credentials(self, community):
+        credentials_def = current_app.config.get("DATACITE_CREDENTIALS")
+
+        community_credentials = getattr(credentials_def, community, None)
+        if community_credentials is None and "DATACITE_CREDENTIALS_DEFAULT" in current_app.config:
+            community_credentials = current_app.config.get("DATACITE_CREDENTIALS_DEFAULT")
+        self.username = community_credentials["username"]
+        self.password = community_credentials["password"]
+        self.prefix = community_credentials["prefix"]
+
+    def execute(self, identity, uow, *args, **kwargs):
+
+        topic = self.request.topic.resolve()
+        self.credentials(topic['parent']['communities']['default'])
+        if topic.is_draft:
+            edit_doi(self, topic, None)
+        else:
+            edit_doi(self, topic, "publish")
+
+        super().execute(identity, uow)

oarepo_doi-1.0.2/oarepo_doi/api.py

@@ -0,0 +1,59 @@
+import requests
+import json
+from invenio_base.utils import obj_or_import_string
+from flask import current_app
+
+
+def create_doi(service, record, data, event = None ):
+    """ if event = None, doi will be created as a draft."""
+
+    mapping = obj_or_import_string(service.mapping[record.schema])()
+    errors = mapping.metadata_check(data)
+    if len(errors) > 0 and event:
+        return #todo: dois can not be published with missing mandatory values
+
+    request_metadata = mapping.create_datacite_payload(data)
+
+    if event:
+        request_metadata["data"]["attributes"]["event"] = event
+
+    request_metadata["data"]["attributes"]["prefix"] = service.prefix
+
+    request = requests.post(url=service.url, json=request_metadata, headers={'Content-type': 'application/vnd.api+json'},
+                            auth=(service.username, service.password)
+                            )
+
+    if request.status_code != 201:
+        raise requests.ConnectionError("Expected status code 201, but got {}".format(request.status_code))
+
+    content = request.content.decode('utf-8')
+    json_content = json.loads(content)
+    doi_value = json_content['data']['id']
+    mapping.add_doi(record, data, doi_value)
+
+
+def edit_doi(service, record, event = None):
+    """ edit existing draft """
+
+    mapping = obj_or_import_string(service.mapping[record.schema])()
+    errors = mapping.metadata_check(record)
+    if len(errors) > 0 and event:
+        return #todo: dois can not be published with missing mandatory values
+    doi_value = mapping.get_doi(record)
+    if doi_value:
+        if not service.url.endswith('/'):
+            url = service.url + '/'
+        else:
+            url = service.url
+        url = url + doi_value.replace("/", "%2F")
+
+        request_metadata = mapping.create_datacite_payload(record)
+        if event:
+            request_metadata["data"]["attributes"]["event"] = event
+
+        request = requests.put(url=url, json=request_metadata, headers={'Content-type': 'application/vnd.api+json'},
+                    auth=(service.username, service.password))
+
+        if request.status_code != 200:
+            raise requests.ConnectionError("Expected status code 200, but got {}".format(request.status_code))
+

oarepo_doi-1.0.2/oarepo_doi/ext.py

@@ -0,0 +1,20 @@
+
+class OARepoDOI(object):
+    """OARepo DOI 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["oarepo-doi"] = self
+
+    def init_config(self, app):
+        """Initialize configuration."""
+        if "DATACITE_URL" not in app.config:
+            app.config["DATACITE_URL"] = 'https://api.datacite.org/dois'
+        if "DATACITE_MODE" not in app.config:
+            app.config["DATACITE_MODE"] = "ON_EVENT"

oarepo_doi-1.0.2/oarepo_doi/services/components/__init__.py

@@ -0,0 +1,57 @@
+import json
+import requests
+from invenio_records_resources.services.records.components import ServiceComponent
+from flask import current_app
+from invenio_base.utils import obj_or_import_string
+
+from oarepo_doi.api import create_doi, edit_doi
+
+
+class DoiComponent(ServiceComponent):
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.mode = current_app.config.get("DATACITE_MODE")
+        self.url = current_app.config.get("DATACITE_URL")
+        self.mapping = current_app.config.get("DATACITE_MAPPING")
+
+        self.username = None
+        self.password = None
+        self.prefix = None
+
+
+
+    def credentials(self, community):
+        credentials_def = current_app.config.get("DATACITE_CREDENTIALS")
+
+        community_credentials = getattr(credentials_def, community, None)
+        if community_credentials is None and "DATACITE_CREDENTIALS_DEFAULT" in current_app.config:
+            community_credentials = current_app.config.get("DATACITE_CREDENTIALS_DEFAULT")
+        self.username = community_credentials["username"]
+        self.password = community_credentials["password"]
+        self.prefix = community_credentials["prefix"]
+
+    def create(self, identity, data=None, record=None, **kwargs):
+
+        if self.mode == "AUTOMATIC_DRAFT":
+            self.credentials(data['parent']['communities']['default'])
+            create_doi(self, record,data, None)
+
+    def update_draft(self, identity, data=None, record=None, **kwargs):
+        if self.mode == "AUTOMATIC_DRAFT":
+            self.credentials(data['parent']['communities']['default'])
+            edit_doi(self, record)
+
+    def update(self, identity, data=None, record=None, **kwargs):
+        if self.mode == "AUTOMATIC_DRAFT" or self.mode == "AUTOMATIC":
+            self.credentials(data['parent']['communities']['default'])
+            edit_doi(self, record)
+
+    def publish(self, identity, data=None, record=None, **kwargs):
+        if self.mode == "AUTOMATIC":
+            self.credentials(data['parent']['communities']['default'])
+            create_doi(self, record, data, "publish")
+        if self.mode == "AUTOMATIC_DRAFT":
+            self.credentials(data['parent']['communities']['default'])
+            edit_doi(self, record, "publish")

oarepo_doi-1.0.2/oarepo_doi/types/doi.py

@@ -0,0 +1,28 @@
+from invenio_requests.customizations import RequestType
+from oarepo_runtime.i18n import lazy_gettext as _
+from ..actions.doi import CreateDoiAction, EditDoiAction
+from oarepo_requests.types.ref_types import ModelRefTypes
+
+class CreateDoiRequestType(RequestType):
+    type_id = "create_doi"
+    name = _("create_doi")
+
+    available_actions = {
+        **RequestType.available_actions,
+        "accept": CreateDoiAction,
+    }
+
+    receiver_can_be_none = True
+    allowed_topic_ref_types = ModelRefTypes(published=True, draft=True)
+
+class EditDoiRequestType(RequestType):
+    type_id = "edit_doi"
+    name = _("edit_doi")
+
+    available_actions = {
+        **RequestType.available_actions,
+        "accept": EditDoiAction,
+    }
+
+    receiver_can_be_none = True
+    allowed_topic_ref_types = ModelRefTypes(published=True, draft=True)

oarepo_doi-1.0.2/oarepo_doi.egg-info/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: oarepo-doi
+Version: 1.0.2
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: invenio-requests
+Requires-Dist: oarepo-requests
+Provides-Extra: tests
+Requires-Dist: oarepo-model-builder-tests; extra == "tests"
+Requires-Dist: oarepo-requests; extra == "tests"
+
+# OARepo DOI

oarepo_doi-1.0.2/oarepo_doi.egg-info/SOURCES.txt

@@ -0,0 +1,28 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+oarepo_doi/__init__.py
+oarepo_doi/api.py
+oarepo_doi/ext.py
+oarepo_doi.egg-info/PKG-INFO
+oarepo_doi.egg-info/SOURCES.txt
+oarepo_doi.egg-info/dependency_links.txt
+oarepo_doi.egg-info/entry_points.txt
+oarepo_doi.egg-info/requires.txt
+oarepo_doi.egg-info/top_level.txt
+oarepo_doi/__pycache__/__init__.cpython-310.pyc
+oarepo_doi/__pycache__/api.cpython-310.pyc
+oarepo_doi/__pycache__/ext.cpython-310.pyc
+oarepo_doi/actions/__init__.py
+oarepo_doi/actions/doi.py
+oarepo_doi/actions/__pycache__/__init__.cpython-310.pyc
+oarepo_doi/actions/__pycache__/doi.cpython-310.pyc
+oarepo_doi/services/__init__.py
+oarepo_doi/services/components/__init__.py
+oarepo_doi/types/__init__.py
+oarepo_doi/types/doi.py
+oarepo_doi/types/__pycache__/__init__.cpython-310.pyc
+oarepo_doi/types/__pycache__/doi.cpython-310.pyc

oarepo_doi-1.0.2/oarepo_doi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

oarepo_doi-1.0.2/oarepo_doi.egg-info/entry_points.txt

@@ -0,0 +1,9 @@
+[invenio_base.api_apps]
+oarepodoi = oarepo_doi.ext:OARepoDOI
+
+[invenio_base.apps]
+oarepo_doi = oarepo_doi.ext:OARepoDOI
+
+[invenio_requests.types]
+create-doi-request = oarepo_doi.types.doi:CreateDoiRequestType
+edit-doi-request = oarepo_doi.types.doi:EditDoiRequestType

oarepo_doi-1.0.2/oarepo_doi.egg-info/requires.txt

@@ -0,0 +1,6 @@
+invenio-requests
+oarepo-requests
+
+[tests]
+oarepo-model-builder-tests
+oarepo-requests

oarepo_doi-1.0.2/oarepo_doi.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+oarepo_doi
+tests

oarepo_doi-1.0.2/pyproject.toml

@@ -0,0 +1,3 @@
+[build_system]
+requires = ["setuptools", "wheel", "babel>2.8"]
+build-backend = "setuptools.build_meta"

oarepo_doi-1.0.2/setup.cfg

@@ -0,0 +1,40 @@
+[metadata]
+name = oarepo-doi
+version = 1.0.2
+description = 
+authors = Alzbeta Pokorna <lili3@cesnet.cz>
+readme = README.md
+long_description = file:README.md
+long_description_content_type = text/markdown
+
+[options]
+python = >=3.10
+install_requires = 
+	invenio-requests
+	oarepo-requests
+packages = find:
+
+[tool.setuptools.packages.find]
+include = ['oarepo_requests.*']
+
+[options.package_data]
+* = *.json, *.rst, *.md, *.json5, *.jinja2
+
+[options.extras_require]
+tests = 
+	oarepo-model-builder-tests
+	oarepo-requests
+
+[options.entry_points]
+invenio_base.apps = 
+	oarepo_doi = oarepo_doi.ext:OARepoDOI
+invenio_base.api_apps = 
+	oarepodoi = oarepo_doi.ext:OARepoDOI
+invenio_requests.types = 
+	create-doi-request = oarepo_doi.types.doi:CreateDoiRequestType
+	edit-doi-request = oarepo_doi.types.doi:EditDoiRequestType
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

oarepo_doi-1.0.2/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()