zenodo: metadata

Signed-off-by: Ilias Koutsakis <[email protected]>

Author: Lilykos

cap/modules/deposit/serializers/zenodo.py

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of CERN Analysis Preservation Framework.
+# Copyright (C) 2020 CERN.
+#
+# CERN Analysis Preservation Framework is free software; you can redistribute
+# it and/or modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# CERN Analysis Preservation Framework is distributed in the hope that it will
+# be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with CERN Analysis Preservation Framework; if not, write to the
+# Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+# MA 02111-1307, USA.
+#
+# In applying this license, CERN does not
+# waive the privileges and immunities granted to it by virtue of its status
+# as an Intergovernmental Organization or submit itself to any jurisdiction.
+# or submit itself to any jurisdiction.
+
+from marshmallow import Schema, fields, ValidationError, \
+    validate, validates, validates_schema
+from pprint import pprint
+import arrow
+
+UPLOAD_TYPES = [
+    'publication',
+    'poster',
+    'presentation',
+    'dataset',
+    'image',
+    'video',
+    'software',
+    'lesson',
+    'physicalobject',
+    'other'
+]
+LICENSES = [
+    'CC-BY-4.0',
+    'CC-BY-1.0',
+    'CC-BY-2.0',
+    'CC-BY-3.0'
+]
+ACCESS_RIGHTS = [
+    'open',
+    '',
+    '',
+    'closed'
+]
+
+
+class ZenodoCreatorsSchema(Schema):
+    name = fields.String(required=True)
+    affiliation = fields.String()
+    orcid = fields.String()
+
+
+class ZenodoDepositMetadataSchema(Schema):
+    title = fields.String(required=True)
+    description = fields.String(required=True)
+    publication_date = fields.String(required=True)
+    version = fields.String()
+
+    keywords = fields.List(fields.String())
+    creators = fields.List(fields.Nested(ZenodoCreatorsSchema), required=True)
+
+    upload_type = fields.String(required=True,
+                                validate=validate.OneOf(UPLOAD_TYPES))
+    license = fields.String(required=True,
+                            validate=validate.OneOf(LICENSES))
+    access_right = fields.String(required=True,
+                                 validate=validate.OneOf(ACCESS_RIGHTS))
+
+    @validates('publication_date')
+    def validate_date(self, value):
+        return True
+
+    @validates('access_right')
+    def validate_access(self, value):
+        return True
+
+    @validates('embargo_date')
+    def validate_embargo_date(self, value):
+        """Validate that embargo date is in the future."""
+        if arrow.get(value).date() <= arrow.utcnow().date():
+            raise ValidationError(
+                'Embargo date must be in the future.',
+                field_names=['embargo_date']
+            )
+
+    @validates_schema()
+    def validate_license(self, data):
+        """Validate license."""
+        # acc = data.get('access_right')
+        # if acc in [AccessRight.OPEN, AccessRight.EMBARGOED] and \
+        #         'license' not in data:
+        #     raise ValidationError(
+        #         _('Required when access right is open or embargoed.'),
+        #         field_names=['license']
+        #     )
+        # if acc == AccessRight.EMBARGOED and 'embargo_date' not in data:
+        #     raise ValidationError(
+        #         _('Required when access right is embargoed.'),
+        #         field_names=['embargo_date']
+        #     )
+        # if acc == AccessRight.RESTRICTED and 'access_conditions' not in data:
+        #     raise ValidationError(
+        #         _('Required when access right is restricted.'),
+        #         field_names=['access_conditions']
+        #     )
+
+
+class ZenodoUploadSchema(Schema):
+    files = fields.List(fields.String, required=True)
+    data = fields.Nested(ZenodoDepositMetadataSchema, default=dict())
+    bucket = fields.String(required=True)
+
+    @validates('files')
+    def validate(self, value):
+        for _file in value:
+            if _file not in ['b', 'c']:
+                raise ValidationError('FILE ERROR')
+
+
+xx = {
+    'data': {
+        'title': 'My first upload yoohoo',
+        'upload_type': 'poster',
+        'description': 'This is my first upload',
+        'creators': [
+            {'name': 'Ilias KoKoKo', 'affiliation': 'Zenodo CAP'}
+        ],
+        'access_right': 'lolo'
+    },
+    'files': ['a'],
+    'bucket': 'bucket'
+}
+
+try:
+    lol = ZenodoUploadSchema().load(xx)
+    pprint(lol)
+except ValidationError as err:
+    pprint(err.messages)