def __init__(self):
self.api = DataCiteUtil()
def __init__(self):
self.api = DataCiteUtil()
class DataCite(PidProvider):
"""
DOI provider using DataCite API.
"""
pid_type = 'doi'
def __init__(self):
self.api = DataCiteUtil()
def _get_url(self, kwargs):
try:
return kwargs['url']
except KeyError:
raise Exception("url keyword argument must be specified.")
def _get_doc(self, kwargs):
try:
return kwargs['doc']
except KeyError:
raise Exception("doc keyword argument must be specified.")
def reserve(self, pid, *args, **kwargs):
""" Reserve a DOI (amounts to upload metadata, but not to mint) """
# Only registered PIDs can be updated.
doc = self._get_doc(kwargs)
try:
self.api.metadata_post(doc)
except DataCiteError as e:
pid.log("RESERVE", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("RESERVE", "Failed with HttpError - %s" % unicode(e))
return False
else:
pid.log("RESERVE", "Successfully reserved in DataCite")
return True
def register(self, pid, *args, **kwargs):
""" Register a DOI via the DataCite API """
url = self._get_url(kwargs)
doc = self._get_doc(kwargs)
try:
# Set metadata for DOI
self.api.metadata_post(doc)
# Mint DOI
self.api.doi_post(pid.pid_value, url)
except DataCiteError as e:
pid.log("REGISTER", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("REGISTER", "Failed with HttpError - %s" % unicode(e))
return False
else:
pid.log("REGISTER", "Successfully registered in DataCite")
return True
def update(self, pid, *args, **kwargs):
"""
Update metadata associated with a DOI.
This can be called before/after a DOI is registered
"""
url = self._get_url(kwargs)
doc = self._get_doc(kwargs)
if pid.is_deleted():
pid.log("UPDATE", "Reactivate in DataCite")
try:
# Set metadata
self.api.metadata_post(doc)
self.api.doi_post(pid.pid_value, url)
except DataCiteError as e:
pid.log("UPDATE", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("UPDATE", "Failed with HttpError - %s" % unicode(e))
return False
else:
if pid.is_deleted():
pid.log(
"UPDATE",
"Successfully updated and possibly registered in DataCite"
)
else:
pid.log("UPDATE", "Successfully updated in DataCite")
return True
def delete(self, pid, *args, **kwargs):
""" Delete a registered DOI """
try:
self.api.metadata_delete(pid.pid_value)
except DataCiteError as e:
pid.log("DELETE", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("DELETE", "Failed with HttpError - %s" % unicode(e))
return False
else:
pid.log("DELETE", "Successfully deleted in DataCite")
return True
def sync_status(self, pid, *args, **kwargs):
""" Synchronize DOI status DataCite MDS """
status = None
try:
self.api.doi_get(pid.pid_value)
status = cfg['PIDSTORE_STATUS_REGISTERED']
except DataCiteGoneError:
status = cfg['PIDSTORE_STATUS_DELETED']
except DataCiteNoContentError:
status = cfg['PIDSTORE_STATUS_REGISTERED']
except DataCiteNotFoundError:
pass
except DataCiteError as e:
pid.log("SYNC", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("SYNC", "Failed with HttpError - %s" % unicode(e))
return False
if status is None:
try:
self.api.metadata_get(pid.pid_value)
status = cfg['PIDSTORE_STATUS_RESERVED']
except DataCiteGoneError:
status = cfg['PIDSTORE_STATUS_DELETED']
except DataCiteNoContentError:
status = cfg['PIDSTORE_STATUS_REGISTERED']
except DataCiteNotFoundError:
pass
except DataCiteError as e:
pid.log("SYNC", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("SYNC", "Failed with HttpError - %s" % unicode(e))
return False
if status is None:
status = cfg['PIDSTORE_STATUS_NEW']
if pid.status != status:
pid.log(
"SYNC", "Fixed status from %s to %s." % (pid.status, status)
)
pid.status = status
return True
@classmethod
def is_provider_for_pid(cls, pid_str):
"""
Check if DataCite is the provider for this DOI
Note: If you e.g. changed DataCite account and received a new prefix,
then this provider can only update and register DOIs for the new
prefix.
"""
return pid_str.startswith("%s/" % cfg['CFG_DATACITE_DOI_PREFIX'])
class DataCite(PidProvider):
"""
DOI provider using DataCite API.
"""
pid_type = 'doi'
def __init__(self):
self.api = DataCiteUtil()
def _get_url(self, kwargs):
try:
return kwargs['url']
except KeyError:
raise Exception("url keyword argument must be specified.")
def _get_doc(self, kwargs):
try:
return kwargs['doc']
except KeyError:
raise Exception("doc keyword argument must be specified.")
def reserve(self, pid, *args, **kwargs):
""" Reserve a DOI (amounts to upload metadata, but not to mint) """
# Only registered PIDs can be updated.
doc = self._get_doc(kwargs)
try:
self.api.metadata_post(doc)
except DataCiteError as e:
pid.log("RESERVE", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("RESERVE", "Failed with HttpError - %s" % unicode(e))
return False
else:
pid.log("RESERVE", "Successfully reserved in DataCite")
return True
def register(self, pid, *args, **kwargs):
""" Register a DOI via the DataCite API """
url = self._get_url(kwargs)
doc = self._get_doc(kwargs)
try:
# Set metadata for DOI
self.api.metadata_post(doc)
# Mint DOI
self.api.doi_post(pid.pid_value, url)
except DataCiteError as e:
pid.log("REGISTER", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("REGISTER", "Failed with HttpError - %s" % unicode(e))
return False
else:
pid.log("REGISTER", "Successfully registered in DataCite")
return True
def update(self, pid, *args, **kwargs):
"""
Update metadata associated with a DOI.
This can be called before/after a DOI is registered
"""
url = self._get_url(kwargs)
doc = self._get_doc(kwargs)
if pid.is_deleted():
pid.log("UPDATE", "Reactivate in DataCite")
try:
# Set metadata
self.api.metadata_post(doc)
self.api.doi_post(pid.pid_value, url)
except DataCiteError as e:
pid.log("UPDATE", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("UPDATE", "Failed with HttpError - %s" % unicode(e))
return False
else:
if pid.is_deleted():
pid.log(
"UPDATE",
"Successfully updated and possibly registered in DataCite")
else:
pid.log("UPDATE", "Successfully updated in DataCite")
return True
def delete(self, pid, *args, **kwargs):
""" Delete a registered DOI """
try:
self.api.metadata_delete(pid.pid_value)
except DataCiteError as e:
pid.log("DELETE", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("DELETE", "Failed with HttpError - %s" % unicode(e))
return False
else:
pid.log("DELETE", "Successfully deleted in DataCite")
return True
def sync_status(self, pid, *args, **kwargs):
""" Synchronize DOI status DataCite MDS """
status = None
try:
self.api.doi_get(pid.pid_value)
status = cfg['PIDSTORE_STATUS_REGISTERED']
except DataCiteGoneError:
status = cfg['PIDSTORE_STATUS_DELETED']
except DataCiteNoContentError:
status = cfg['PIDSTORE_STATUS_REGISTERED']
except DataCiteNotFoundError:
pass
except DataCiteError as e:
pid.log("SYNC", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("SYNC", "Failed with HttpError - %s" % unicode(e))
return False
if status is None:
try:
self.api.metadata_get(pid.pid_value)
status = cfg['PIDSTORE_STATUS_RESERVED']
except DataCiteGoneError:
status = cfg['PIDSTORE_STATUS_DELETED']
except DataCiteNoContentError:
status = cfg['PIDSTORE_STATUS_REGISTERED']
except DataCiteNotFoundError:
pass
except DataCiteError as e:
pid.log("SYNC", "Failed with %s" % e.__class__.__name__)
return False
except HttpError as e:
pid.log("SYNC", "Failed with HttpError - %s" % unicode(e))
return False
if status is None:
status = cfg['PIDSTORE_STATUS_NEW']
if pid.status != status:
pid.log("SYNC",
"Fixed status from %s to %s." % (pid.status, status))
pid.status = status
return True
@classmethod
def is_provider_for_pid(cls, pid_str):
"""
Check if DataCite is the provider for this DOI
Note: If you e.g. changed DataCite account and received a new prefix,
then this provider can only update and register DOIs for the new
prefix.
"""
return pid_str.startswith("%s/" % cfg['CFG_DATACITE_DOI_PREFIX'])
