Move base query classes to base.py

This commit is contained in:
Alejandro Avilés 2014-11-19 16:43:29 +01:00
parent 460a9d9e37
commit dd5210deee
5 changed files with 79 additions and 79 deletions

View File

@ -1,75 +0,0 @@
# This file is part of Indico.
# Copyright (C) 2002 - 2014 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 indico_piwik.piwik import PiwikRequest
class PiwikQueryBase(object):
"""Base Piwik query"""
def __init__(self, query_script):
from indico_piwik.plugin import PiwikPlugin
self.request = PiwikRequest(server_url=PiwikPlugin.settings.get('server_api_url'),
site_id=PiwikPlugin.settings.get('site_id_events'),
api_token=PiwikPlugin.settings.get('server_token'),
query_script=query_script)
def call(self, **query_params):
return self.request.call(**query_params)
class PiwikQueryReportBase(PiwikQueryBase):
"""Base Piwik query to request reports"""
def __init__(self):
from indico_piwik.plugin import PiwikPlugin
super(PiwikQueryReportBase, self).__init__(query_script=PiwikPlugin.report_script)
def call(self, date=('last7',), period='day', **query_params):
date = ','.join(map(unicode, date))
return super(PiwikQueryReportBase, self).call(date=date, period=period, **query_params)
class PiwikQueryReportEventBase(PiwikQueryReportBase):
"""Base Piwik query to request reports of events and contributions"""
def __init__(self, event_id, start_date, end_date, contrib_id=None):
super(PiwikQueryReportEventBase, self).__init__()
self.event_id = event_id
self.contrib_id = contrib_id
self.start_date = start_date
self.end_date = end_date
def call(self, segmentation_enabled=True, **query_params):
if segmentation_enabled:
query_params['segment'] = self.get_segmentation()
return super(PiwikQueryReportEventBase, self).call(module='API', date=[self.start_date, self.end_date],
**query_params)
def get_segmentation(self):
segmentation = {'customVariablePageName1': ('==', 'Conference'),
'customVariablePageValue1': ('==', self.event_id)}
if self.contrib_id:
segmentation['customVariablePageName2'] = ('==', 'Contribution')
segmentation['customVariablePageValue2'] = ('==', self.contrib_id)
segments = set()
for name, (equality, value) in segmentation.iteritems():
segment = '{}{}{}'.format(name, equality, value)
segments.add(segment)
return ';'.join(segments)

View File

@ -0,0 +1,75 @@
# This file is part of Indico.
# Copyright (C) 2002 - 2014 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 indico_piwik.piwik import PiwikRequest
class PiwikQueryBase(object):
"""Base Piwik query"""
def __init__(self, query_script):
from indico_piwik.plugin import PiwikPlugin
self.request = PiwikRequest(server_url=PiwikPlugin.settings.get('server_api_url'),
site_id=PiwikPlugin.settings.get('site_id_events'),
api_token=PiwikPlugin.settings.get('server_token'),
query_script=query_script)
def call(self, **query_params):
return self.request.call(**query_params)
class PiwikQueryReportBase(PiwikQueryBase):
"""Base Piwik query to request reports"""
def __init__(self):
from indico_piwik.plugin import PiwikPlugin
super(PiwikQueryReportBase, self).__init__(query_script=PiwikPlugin.report_script)
def call(self, date=('last7',), period='day', **query_params):
date = ','.join(map(unicode, date))
return super(PiwikQueryReportBase, self).call(date=date, period=period, **query_params)
class PiwikQueryReportEventBase(PiwikQueryReportBase):
"""Base Piwik query to request reports of events and contributions"""
def __init__(self, event_id, start_date, end_date, contrib_id=None):
super(PiwikQueryReportEventBase, self).__init__()
self.event_id = event_id
self.contrib_id = contrib_id
self.start_date = start_date
self.end_date = end_date
def call(self, segmentation_enabled=True, **query_params):
if segmentation_enabled:
query_params['segment'] = self.get_segmentation()
return super(PiwikQueryReportEventBase, self).call(module='API', date=[self.start_date, self.end_date],
**query_params)
def get_segmentation(self):
segmentation = {'customVariablePageName1': ('==', 'Conference'),
'customVariablePageValue1': ('==', self.event_id)}
if self.contrib_id:
segmentation['customVariablePageName2'] = ('==', 'Contribution')
segmentation['customVariablePageValue2'] = ('==', self.contrib_id)
segments = set()
for name, (equality, value) in segmentation.iteritems():
segment = '{}{}{}'.format(name, equality, value)
segments.add(segment)
return ';'.join(segments)

View File

@ -18,7 +18,7 @@ from base64 import b64encode
from flask_pluginengine import current_plugin
from . import PiwikQueryReportEventBase
from indico_piwik.queries.base import PiwikQueryReportEventBase
class PiwikQueryReportEventGraphBase(PiwikQueryReportEventBase):

View File

@ -19,8 +19,8 @@ from __future__ import division
from operator import itemgetter
from urllib2 import quote
from . import PiwikQueryReportEventBase
from .utils import get_json_from_remote_server, reduce_json, stringify_seconds
from indico_piwik.queries.base import PiwikQueryReportEventBase
from indico_piwik.queries.utils import get_json_from_remote_server, reduce_json, stringify_seconds
class PiwikQueryReportEventMetricBase(PiwikQueryReportEventBase):

View File

@ -17,7 +17,7 @@
from datetime import datetime
from urllib2 import quote
from . import PiwikQueryBase
from indico_piwik.queries.base import PiwikQueryBase
class PiwikQueryTrackBase(PiwikQueryBase):