mirror of
https://github.com/lucaspalomodevelop/indico-plugins.git
synced 2026-03-12 23:27:22 +00:00
76 lines
3.1 KiB
Python
76 lines
3.1 KiB
Python
# This file is part of Indico.
|
|
# Copyright (C) 2002 - 2017 European Organization for Nuclear Research (CERN).
|
|
#
|
|
# Indico 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 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# Indico 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 Indico; if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
from flask_pluginengine import depends
|
|
|
|
from indico.core.plugins import IndicoPlugin, PluginCategory
|
|
from indico_importer.plugin import ImporterPlugin
|
|
|
|
|
|
@depends('importer')
|
|
class ImporterSourcePluginBase(IndicoPlugin):
|
|
"""Base class for importer engine plugins"""
|
|
|
|
importer_engine_classes = None
|
|
category = PluginCategory.importers
|
|
|
|
def init(self):
|
|
super(ImporterSourcePluginBase, self).init()
|
|
for engine_class in self.importer_engine_classes:
|
|
importer_engine = engine_class()
|
|
ImporterPlugin.instance.register_importer_engine(importer_engine, self)
|
|
|
|
|
|
class ImporterEngineBase(object):
|
|
"""Base class for data importers"""
|
|
|
|
_id = ''
|
|
name = ''
|
|
|
|
def import_data(self, query, size):
|
|
"""Fetch and converts data from external source.
|
|
|
|
:param query: A search phrase send to the importer.
|
|
:param size: Number of records to fetch from external source.
|
|
:return: List of dictionaries with the following format (all keys are optional)
|
|
[{"recordId" : idOfTheRecordInExternalSource,
|
|
"title": eventTitle,
|
|
"primaryAuthor": {"firstName": primaryAuthorFirstName,
|
|
"familyName": primaryAuthorFamilyName,
|
|
"affiliation": primaryAuthorAffiliation},
|
|
"speaker": {"firstName": speakerFirstName,
|
|
"familyName": speakerFamilyName,
|
|
"affiliation": speakerAffiliation},
|
|
"secondaryAuthor": {"firstName": secondaryAuthorFirstName,
|
|
"familyName": secondaryAuthorFamilyName,
|
|
"affiliation": secondaryAuthorAffiliation},
|
|
"summary": eventSummary,
|
|
"meetingName": nameOfTheEventMeeting,
|
|
"materials": [{"name": nameOfTheLink,
|
|
"url": linkDestination},
|
|
...],
|
|
"reportNumbers": [reportNumber, ...]
|
|
"startDateTime": {"time" : eventStartTime,
|
|
"date" : eventStartDate},
|
|
"endDateTime": {"time" : eventEndTime,
|
|
"date" : eventEndDate}
|
|
"place": eventPlace},
|
|
...]
|
|
"""
|
|
raise NotImplementedError
|