From: Ross Jones Date: Thu, 25 Oct 2012 14:46:14 +0000 Subject: Changing the content disposition, just in case X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-ga-report.git&a=commitdiff&h=ba298984a30670c5cdf1c532059c9137d04d47e0 --- Changing the content disposition, just in case --- --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ *.py[co] +*.py~ +.gitignore # Packages *.egg @@ -13,6 +15,10 @@ develop-eggs .installed.cfg +# Private info +credentials.json +token.dat + # Installer logs pip-log.txt --- a/README.md +++ /dev/null @@ -1,4 +1,1 @@ -ckanext-ga-report -================= -For creating detailed reports of CKAN analytics, sliced by group --- /dev/null +++ b/README.rst @@ -1,1 +1,102 @@ +ckanext-ga-report +================= +**Status:** Development + +**CKAN Version:** 1.7.1+ + + +Overview +-------- + +For creating detailed reports of CKAN analytics, including totals per group. + +Whereas ckanext-googleanalytics focusses on providing page view stats a recent period and for all time (aimed at end users), ckanext-ga-report is more interested in building regular periodic reports (more for site managers to monitor). + +Contents of this extension: + + * Use the CLI tool to download Google Analytics data for each time period into this extension's database tables + + * Users can view the data as web page reports + + +Installation +------------ + +1. Activate you CKAN python environment and install this extension's software:: + + $ pyenv/bin/activate + $ pip install -e git+https://github.com/datagovuk/ckanext-ga-report.git#egg=ckanext-ga-report + +2. Ensure you development.ini (or similar) contains the info about your Google Analytics account and configuration:: + + googleanalytics.id = UA-1010101-1 + googleanalytics.account = Account name (i.e. data.gov.uk, see top level item at https://www.google.com/analytics) + ga-report.period = monthly + + Note that your credentials will be readable by system administrators on your server. Rather than use sensitive account details, it is suggested you give access to the GA account to a new Google account that you create just for this purpose. + +3. Set up this extension's database tables using a paster command. (Ensure your CKAN pyenv is still activated, run the command from ``src/ckanext-ga-report``, alter the ``--config`` option to point to your site config file):: + + $ paster initdb --config=../ckan/development.ini + +4. Enable the extension in your CKAN config file by adding it to ``ckan.plugins``:: + + ckan.plugins = ga-report + + +Authorization +-------------- + +Before you can access the data, you need to set up the OAUTH details which you can do by following the `instructions `_ the outcome of which will be a file called credentials.json which should look like credentials.json.template with the relevant fields completed. These steps are below for convenience: + +1. Visit the `Google APIs Console `_ + +2. Sign-in and create a project or use an existing project. + +3. In the `Services pane `_ , activate Analytics API for your project. If prompted, read and accept the terms of service. + +4. Go to the `API Access pane `_ + +5. Click Create an OAuth 2.0 client ID.... + +6. Fill out the Branding Information fields and click Next. + +7. In Client ID Settings, set Application type to Installed application. + +8. Click Create client ID + +9. The details you need below are Client ID, Client secret, and Redirect URIs + + +Once you have set up your credentials.json file you can generate an oauth token file by using the +following command, which will store your oauth token in a file called token.dat once you have finished +giving permission in the browser:: + + $ paster getauthtoken --config=../ckan/development.ini + + +Tutorial +-------- + +Download some GA data and store it in CKAN's db. (Ensure your CKAN pyenv is still activated, run the command from ``src/ckanext-ga-report``, alter the ``--config`` option to point to your site config file) and specifying the name of your auth file (token.dat by default) from the previous step:: + + $ paster loadanalytics token.dat latest --config=../ckan/development.ini + +The value after the token file is how much data you want to retrieve, this can be + +* **all** - data for all time (since 2010) + +* **latest** - (default) just the 'latest' data + +* **YYYY-MM-DD** - just data for all time periods going back to (and including) this date + + + +Software Licence +================ + +This software is developed by Cabinet Office. It is Crown Copyright and opened up under the Open Government Licence (OGL) (which is compatible with Creative Commons Attibution License). + +OGL terms: http://www.nationalarchives.gov.uk/doc/open-government-licence/ + --- /dev/null +++ b/ckanext/__init__.py @@ -1,1 +1,8 @@ +# this is a namespace package +try: + import pkg_resources + pkg_resources.declare_namespace(__name__) +except ImportError: + import pkgutil + __path__ = pkgutil.extend_path(__path__, __name__) --- /dev/null +++ b/ckanext/ga_report/__init__.py @@ -1,1 +1,8 @@ +# this is a namespace package +try: + import pkg_resources + pkg_resources.declare_namespace(__name__) +except ImportError: + import pkgutil + __path__ = pkgutil.extend_path(__path__, __name__) --- /dev/null +++ b/ckanext/ga_report/command.py @@ -1,1 +1,101 @@ +import logging +import datetime +from ckan.lib.cli import CkanCommand +# No other CKAN imports allowed until _load_config is run, +# or logging is disabled + + +class InitDB(CkanCommand): + """Initialise the extension's database tables + """ + summary = __doc__.split('\n')[0] + usage = __doc__ + max_args = 0 + min_args = 0 + + def command(self): + self._load_config() + + import ckan.model as model + model.Session.remove() + model.Session.configure(bind=model.meta.engine) + log = logging.getLogger('ckanext.ga-report') + + import ga_model + ga_model.init_tables() + log.info("DB tables are setup") + + +class GetAuthToken(CkanCommand): + """ Get's the Google auth token + + Usage: paster getauthtoken + + Where is the file name containing the details + for the service (obtained from https://code.google.com/apis/console). + By default this is set to credentials.json + """ + summary = __doc__.split('\n')[0] + usage = __doc__ + max_args = 0 + min_args = 0 + + def command(self): + """ + In this case we don't want a valid service, but rather just to + force the user through the auth flow. We allow this to complete to + act as a form of verification instead of just getting the token and + assuming it is correct. + """ + from ga_auth import init_service + init_service('token.dat', + self.args[0] if self.args + else 'credentials.json') + + +class LoadAnalytics(CkanCommand): + """Get data from Google Analytics API and save it + in the ga_model + + Usage: paster loadanalytics + + Where is the name of the auth token file from + the getauthtoken step. + + And where is: + all - data for all time + latest - (default) just the 'latest' data + YYYY-MM - just data for the specific month + """ + summary = __doc__.split('\n')[0] + usage = __doc__ + max_args = 2 + min_args = 1 + + def command(self): + self._load_config() + + from download_analytics import DownloadAnalytics + from ga_auth import (init_service, get_profile_id) + + try: + svc = init_service(self.args[0], None) + except TypeError: + print ('Have you correctly run the getauthtoken task and ' + 'specified the correct file here') + return + + downloader = DownloadAnalytics(svc, profile_id=get_profile_id(svc)) + + time_period = self.args[1] if self.args and len(self.args) > 1 \ + else 'latest' + if time_period == 'all': + downloader.all_() + elif time_period == 'latest': + downloader.latest() + else: + # The month to use + for_date = datetime.datetime.strptime(time_period, '%Y-%m') + downloader.specific_month(for_date) + --- /dev/null +++ b/ckanext/ga_report/controller.py @@ -1,1 +1,144 @@ +import logging +import operator +from ckan.lib.base import BaseController, c, render, request, response +import sqlalchemy +from sqlalchemy import func, cast, Integer +import ckan.model as model +from ga_model import GA_Url, GA_Stat + +log = logging.getLogger('ckanext.ga-report') + + +def _get_month_name(strdate): + import calendar + from time import strptime + d = strptime(strdate, '%Y-%m') + return '%s %s' % (calendar.month_name[d.tm_mon], d.tm_year) + + +def _month_details(cls): + months = [] + vals = model.Session.query(cls.period_name).distinct().all() + for m in vals: + months.append( (m[0], _get_month_name(m[0]))) + return sorted(months, key=operator.itemgetter(0), reverse=True) + + +class GaReport(BaseController): + + def csv(self, month): + import csv + + entries = model.Session.query(GA_Stat).\ + filter(GA_Stat.period_name==month).\ + order_by('GA_Stat.stat_name, GA_Stat.key').all() + + #response.headers['Content-disposition'] = 'attachment; filename=dgu_analytics_%s.csv' % (month,) + response.headers['Content-Type'] = "text/csv; charset=utf-8" + + writer = csv.writer(response) + writer.writerow(["Period", "Statistic", "Key", "Value"]) + + for entry in entries: + writer.writerow([entry.period_name.encode('utf-8'), + entry.stat_name.encode('utf-8'), + entry.key.encode('utf-8'), + entry.value.encode('utf-8')]) + + def index(self): + + # Get the month details by fetching distinct values and determining the + # month names from the values. + c.months = _month_details(GA_Stat) + + # Work out which month to show, based on query params of the first item + c.month = request.params.get('month', c.months[0][0] if c.months else '') + c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) + + entries = model.Session.query(GA_Stat).\ + filter(GA_Stat.stat_name=='Totals').\ + filter(GA_Stat.period_name==c.month).\ + order_by('ga_stat.key').all() + c.global_totals = [(s.key, s.value) for s in entries ] + + keys = { + 'Browser versions': 'browsers', + 'Operating Systems versions': 'os', + 'Social sources': 'social_networks', + 'Languages': 'languages', + 'Country': 'country' + } + + for k, v in keys.iteritems(): + entries = model.Session.query(GA_Stat).\ + filter(GA_Stat.stat_name==k).\ + filter(GA_Stat.period_name==c.month).\ + order_by('ga_stat.value::int desc').all() + setattr(c, v, [(s.key, s.value) for s in entries ]) + + + return render('ga_report/site/index.html') + + +class GaPublisherReport(BaseController): + """ + Displays the pageview and visit count for specific publishers based on + the datasets associated with the publisher. + """ + + def index(self): + + # Get the month details by fetching distinct values and determining the + # month names from the values. + c.months = _month_details(GA_Url) + + # Work out which month to show, based on query params of the first item + c.month = request.params.get('month', c.months[0][0] if c.months else '') + c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) + + connection = model.Session.connection() + q = """ + select department_id, sum(pageviews::int) views, sum(visitors::int) visits + from ga_url + where department_id <> '' + and not url like '/publisher/%%' + and period_name=%s + group by department_id order by views desc limit 20; + """ + c.top_publishers = [] + res = connection.execute(q, c.month) + for row in res: + c.top_publishers.append((model.Group.get(row[0]), row[1], row[2])) + + return render('ga_report/publisher/index.html') + + + def read(self, id): + c.publisher = model.Group.get(id) + c.top_packages = [] # package, dataset_views in c.top_packages + + # Get the month details by fetching distinct values and determining the + # month names from the values. + c.months = _month_details(GA_Url) + + # Work out which month to show, based on query params of the first item + c.month = request.params.get('month', c.months[0][0] if c.months else '') + c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) + + entry = model.Session.query(GA_Url).\ + filter(GA_Url.url=='/publisher/%s' % c.publisher.name).\ + filter(GA_Url.period_name==c.month).first() + c.publisher_page_views = entry.pageviews if entry else 0 + + entries = model.Session.query(GA_Url).\ + filter(GA_Url.department_id==c.publisher.name).\ + filter(GA_Url.period_name==c.month).\ + order_by('ga_url.pageviews::int desc')[:20] + for entry in entries: + if entry.url.startswith('/dataset/'): + p = model.Package.get(entry.url[len('/dataset/'):]) + c.top_packages.append((p,entry.pageviews,entry.visitors)) + + return render('ga_report/publisher/read.html') + --- /dev/null +++ b/ckanext/ga_report/download_analytics.py @@ -1,1 +1,308 @@ - +import os +import logging +import datetime + +from pylons import config + +import ga_model + +#from ga_client import GA + +log = logging.getLogger('ckanext.ga-report') + +FORMAT_MONTH = '%Y-%m' + +class DownloadAnalytics(object): + '''Downloads and stores analytics info''' + + def __init__(self, service=None, profile_id=None): + self.period = config['ga-report.period'] + self.service = service + self.profile_id = profile_id + + + def specific_month(self, date): + import calendar + + first_of_this_month = datetime.datetime(date.year, date.month, 1) + _, last_day_of_month = calendar.monthrange(int(date.year), int(date.month)) + last_of_this_month = datetime.datetime(date.year, date.month, last_day_of_month) + periods = ((date.strftime(FORMAT_MONTH), + last_day_of_month, + first_of_this_month, last_of_this_month),) + self.download_and_store(periods) + + + def latest(self): + if self.period == 'monthly': + # from first of this month to today + now = datetime.datetime.now() + first_of_this_month = datetime.datetime(now.year, now.month, 1) + periods = ((now.strftime(FORMAT_MONTH), + now.day, + first_of_this_month, now),) + else: + raise NotImplementedError + self.download_and_store(periods) + + + def for_date(self, for_date): + assert isinstance(since_date, datetime.datetime) + periods = [] # (period_name, period_complete_day, start_date, end_date) + if self.period == 'monthly': + first_of_the_months_until_now = [] + year = for_date.year + month = for_date.month + now = datetime.datetime.now() + first_of_this_month = datetime.datetime(now.year, now.month, 1) + while True: + first_of_the_month = datetime.datetime(year, month, 1) + if first_of_the_month == first_of_this_month: + periods.append((now.strftime(FORMAT_MONTH), + now.day, + first_of_this_month, now)) + break + elif first_of_the_month < first_of_this_month: + in_the_next_month = first_of_the_month + datetime.timedelta(40) + last_of_the_month = datetime.datetime(in_the_next_month.year, + in_the_next_month.month, 1)\ + - datetime.timedelta(1) + periods.append((now.strftime(FORMAT_MONTH), 0, + first_of_the_month, last_of_the_month)) + else: + # first_of_the_month has got to the future somehow + break + month += 1 + if month > 12: + year += 1 + month = 1 + else: + raise NotImplementedError + self.download_and_store(periods) + + @staticmethod + def get_full_period_name(period_name, period_complete_day): + if period_complete_day: + return period_name + ' (up to %ith)' % period_complete_day + else: + return period_name + + + def download_and_store(self, periods): + for period_name, period_complete_day, start_date, end_date in periods: + log.info('Downloading Analytics for period "%s" (%s - %s)', + self.get_full_period_name(period_name, period_complete_day), + start_date.strftime('%Y %m %d'), + end_date.strftime('%Y %m %d')) + + data = self.download(start_date, end_date, '~/dataset/[a-z0-9-_]+') + log.info('Storing Dataset Analytics for period "%s"', + self.get_full_period_name(period_name, period_complete_day)) + self.store(period_name, period_complete_day, data, ) + + data = self.download(start_date, end_date, '~/publisher/[a-z0-9-_]+') + log.info('Storing Publisher Analytics for period "%s"', + self.get_full_period_name(period_name, period_complete_day)) + self.store(period_name, period_complete_day, data,) + + ga_model.update_publisher_stats(period_name) # about 30 seconds. + self.sitewide_stats( period_name ) + + + def download(self, start_date, end_date, path='~/dataset/[a-z0-9-_]+'): + '''Get data from GA for a given time period''' + start_date = start_date.strftime('%Y-%m-%d') + end_date = end_date.strftime('%Y-%m-%d') + query = 'ga:pagePath=%s$' % path + metrics = 'ga:uniquePageviews, ga:visitors' + sort = '-ga:uniquePageviews' + + # Supported query params at + # https://developers.google.com/analytics/devguides/reporting/core/v3/reference + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + filters=query, + start_date=start_date, + metrics=metrics, + sort=sort, + dimensions="ga:pagePath", + max_results=10000, + end_date=end_date).execute() + + if os.getenv('DEBUG'): + import pprint + pprint.pprint(results) + print 'Total results: %s' % results.get('totalResults') + + packages = [] + for entry in results.get('rows'): + (loc,pageviews,visits) = entry + packages.append( ('http:/' + loc, pageviews, visits,) ) # Temporary hack + return dict(url=packages) + + def store(self, period_name, period_complete_day, data): + if 'url' in data: + ga_model.update_url_stats(period_name, period_complete_day, data['url']) + + def sitewide_stats(self, period_name): + import calendar + year, month = period_name.split('-') + _, last_day_of_month = calendar.monthrange(int(year), int(month)) + + start_date = '%s-01' % period_name + end_date = '%s-%s' % (period_name, last_day_of_month) + print 'Sitewide_stats for %s (%s -> %s)' % (period_name, start_date, end_date) + + funcs = ['_totals_stats', '_social_stats', '_os_stats', + '_locale_stats', '_browser_stats', '_mobile_stats'] + for f in funcs: + print ' + Fetching %s stats' % f.split('_')[1] + getattr(self, f)(start_date, end_date, period_name) + + def _get_results(result_data, f): + data = {} + for result in result_data: + key = f(result) + data[key] = data.get(key,0) + result[1] + return data + + def _totals_stats(self, start_date, end_date, period_name): + """ Fetches distinct totals, total pageviews etc """ + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:uniquePageviews', + sort='-ga:uniquePageviews', + max_results=10000, + end_date=end_date).execute() + result_data = results.get('rows') + ga_model.update_sitewide_stats(period_name, "Totals", {'Total pageviews': result_data[0][0]}) + + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:pageviewsPerVisit,ga:bounces,ga:avgTimeOnSite,ga:percentNewVisits', + max_results=10000, + end_date=end_date).execute() + result_data = results.get('rows') + data = { + 'Pages per visit': result_data[0][0], + 'Bounces': result_data[0][1], + 'Average time on site': result_data[0][2], + 'Percent new visits': result_data[0][3], + } + ga_model.update_sitewide_stats(period_name, "Totals", data) + + + def _locale_stats(self, start_date, end_date, period_name): + """ Fetches stats about language and country """ + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:uniquePageviews', + sort='-ga:uniquePageviews', + dimensions="ga:language,ga:country", + max_results=10000, + end_date=end_date).execute() + result_data = results.get('rows') + data = {} + for result in result_data: + data[result[0]] = data.get(result[0], 0) + int(result[2]) + ga_model.update_sitewide_stats(period_name, "Languages", data) + + data = {} + for result in result_data: + data[result[1]] = data.get(result[1], 0) + int(result[2]) + ga_model.update_sitewide_stats(period_name, "Country", data) + + + def _social_stats(self, start_date, end_date, period_name): + """ Finds out which social sites people are referred from """ + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:uniquePageviews', + sort='-ga:uniquePageviews', + dimensions="ga:socialNetwork,ga:referralPath", + max_results=10000, + end_date=end_date).execute() + result_data = results.get('rows') + twitter_links = [] + data = {} + for result in result_data: + if not result[0] == '(not set)': + data[result[0]] = data.get(result[0], 0) + int(result[2]) + if result[0] == 'Twitter': + twitter_links.append(result[1]) + ga_model.update_sitewide_stats(period_name, "Social sources", data) + + + def _os_stats(self, start_date, end_date, period_name): + """ Operating system stats """ + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:uniquePageviews', + sort='-ga:uniquePageviews', + dimensions="ga:operatingSystem,ga:operatingSystemVersion", + max_results=10000, + end_date=end_date).execute() + result_data = results.get('rows') + data = {} + for result in result_data: + data[result[0]] = data.get(result[0], 0) + int(result[2]) + ga_model.update_sitewide_stats(period_name, "Operating Systems", data) + + data = {} + for result in result_data: + key = "%s (%s)" % (result[0],result[1]) + data[key] = result[2] + ga_model.update_sitewide_stats(period_name, "Operating Systems versions", data) + + + def _browser_stats(self, start_date, end_date, period_name): + """ Information about browsers and browser versions """ + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:uniquePageviews', + sort='-ga:uniquePageviews', + dimensions="ga:browser,ga:browserVersion", + max_results=10000, + end_date=end_date).execute() + result_data = results.get('rows') + data = {} + for result in result_data: + data[result[0]] = data.get(result[0], 0) + int(result[2]) + ga_model.update_sitewide_stats(period_name, "Browsers", data) + + data = {} + for result in result_data: + key = "%s (%s)" % (result[0], result[1]) + data[key] = result[2] + ga_model.update_sitewide_stats(period_name, "Browser versions", data) + + + def _mobile_stats(self, start_date, end_date, period_name): + """ Info about mobile devices """ + + results = self.service.data().ga().get( + ids='ga:' + self.profile_id, + start_date=start_date, + metrics='ga:uniquePageviews', + sort='-ga:uniquePageviews', + dimensions="ga:mobileDeviceBranding, ga:mobileDeviceInfo", + max_results=10000, + end_date=end_date).execute() + + result_data = results.get('rows') + data = {} + for result in result_data: + data[result[0]] = data.get(result[0], 0) + int(result[2]) + ga_model.update_sitewide_stats(period_name, "Mobile brands", data) + + data = {} + for result in result_data: + data[result[1]] = data.get(result[1], 0) + int(result[2]) + ga_model.update_sitewide_stats(period_name, "Mobile devices", data) + --- /dev/null +++ b/ckanext/ga_report/ga_auth.py @@ -1,1 +1,70 @@ +import os +import httplib2 +from apiclient.discovery import build +from oauth2client.client import flow_from_clientsecrets +from oauth2client.file import Storage +from oauth2client.tools import run +from pylons import config + + +def _prepare_credentials(token_filename, credentials_filename): + """ + Either returns the user's oauth credentials or uses the credentials + file to generate a token (by forcing the user to login in the browser) + """ + storage = Storage(token_filename) + credentials = storage.get() + + if credentials is None or credentials.invalid: + flow = flow_from_clientsecrets(credentials_filename, + scope='https://www.googleapis.com/auth/analytics.readonly', + message="Can't find the credentials file") + credentials = run(flow, storage) + + return credentials + + +def init_service(token_file, credentials_file): + """ + Given a file containing the user's oauth token (and another with + credentials in case we need to generate the token) will return a + service object representing the analytics API. + """ + http = httplib2.Http() + + credentials = _prepare_credentials(token_file, credentials_file) + http = credentials.authorize(http) # authorize the http object + + return build('analytics', 'v3', http=http) + + +def get_profile_id(service): + """ + Get the profile ID for this user and the service specified by the + 'googleanalytics.id' configuration option. This function iterates + over all of the accounts available to the user who invoked the + service to find one where the account name matches (in case the + user has several). + """ + accounts = service.management().accounts().list().execute() + + if not accounts.get('items'): + return None + + accountName = config.get('googleanalytics.account') + webPropertyId = config.get('googleanalytics.id') + for acc in accounts.get('items'): + if acc.get('name') == accountName: + accountId = acc.get('id') + + webproperties = service.management().webproperties().list(accountId=accountId).execute() + + profiles = service.management().profiles().list( + accountId=accountId, webPropertyId=webPropertyId).execute() + + if profiles.get('items'): + return profiles.get('items')[0].get('id') + + return None + --- /dev/null +++ b/ckanext/ga_report/ga_model.py @@ -1,1 +1,250 @@ - +import re +import uuid + +from sqlalchemy import Table, Column, MetaData +from sqlalchemy import types +from sqlalchemy.sql import select +from sqlalchemy.orm import mapper +from sqlalchemy import func + +import ckan.model as model +from ckan.lib.base import * + +def make_uuid(): + return unicode(uuid.uuid4()) + + + +class GA_Url(object): + + def __init__(self, **kwargs): + for k,v in kwargs.items(): + setattr(self, k, v) + +class GA_Stat(object): + + def __init__(self, **kwargs): + for k,v in kwargs.items(): + setattr(self, k, v) + +class GA_Publisher(object): + + def __init__(self, **kwargs): + for k,v in kwargs.items(): + setattr(self, k, v) + + +metadata = MetaData() +url_table = Table('ga_url', metadata, + Column('id', types.UnicodeText, primary_key=True, + default=make_uuid), + Column('period_name', types.UnicodeText), + Column('period_complete_day', types.Integer), + Column('pageviews', types.UnicodeText), + Column('visitors', types.UnicodeText), + Column('url', types.UnicodeText), + Column('department_id', types.UnicodeText), + ) +mapper(GA_Url, url_table) + +stat_table = Table('ga_stat', metadata, + Column('id', types.UnicodeText, primary_key=True, + default=make_uuid), + Column('period_name', types.UnicodeText), + Column('stat_name', types.UnicodeText), + Column('key', types.UnicodeText), + Column('value', types.UnicodeText), ) +mapper(GA_Stat, stat_table) + + +pub_table = Table('ga_publisher', metadata, + Column('id', types.UnicodeText, primary_key=True, + default=make_uuid), + Column('period_name', types.UnicodeText), + Column('publisher_name', types.UnicodeText), + Column('views', types.UnicodeText), + Column('visitors', types.UnicodeText), + Column('toplevel', types.Boolean, default=False), + Column('subpublishercount', types.Integer, default=0), + Column('parent', types.UnicodeText), +) +mapper(GA_Publisher, pub_table) + + +def init_tables(): + metadata.create_all(model.meta.engine) + + +cached_tables = {} + + +def get_table(name): + if name not in cached_tables: + meta = MetaData() + meta.reflect(bind=model.meta.engine) + table = meta.tables[name] + cached_tables[name] = table + return cached_tables[name] + + +def _normalize_url(url): + '''Strip off the hostname etc. Do this before storing it. + + >>> normalize_url('http://data.gov.uk/dataset/weekly_fuel_prices') + '/dataset/weekly_fuel_prices' + ''' + url = re.sub('https?://(www\.)?data.gov.uk', '', url) + return url + + +def _get_department_id_of_url(url): + # e.g. /dataset/fuel_prices + # e.g. /dataset/fuel_prices/resource/e63380d4 + dataset_match = re.match('/dataset/([^/]+)(/.*)?', url) + if dataset_match: + dataset_ref = dataset_match.groups()[0] + dataset = model.Package.get(dataset_ref) + if dataset: + publisher_groups = dataset.get_groups('publisher') + if publisher_groups: + return publisher_groups[0].name + else: + publisher_match = re.match('/publisher/([^/]+)(/.*)?', url) + if publisher_match: + return publisher_match.groups()[0] + + +def update_sitewide_stats(period_name, stat_name, data): + for k,v in data.iteritems(): + item = model.Session.query(GA_Stat).\ + filter(GA_Stat.period_name==period_name).\ + filter(GA_Stat.key==k).\ + filter(GA_Stat.stat_name==stat_name).first() + if item: + item.period_name = period_name + item.key = k + item.value = v + model.Session.add(item) + else: + # create the row + values = {'id': make_uuid(), + 'period_name': period_name, + 'key': k, + 'value': v, + 'stat_name': stat_name + } + model.Session.add(GA_Stat(**values)) + model.Session.commit() + + + +def update_url_stats(period_name, period_complete_day, url_data): + for url, views, visitors in url_data: + url = _normalize_url(url) + department_id = _get_department_id_of_url(url) + + # see if the row for this url & month is in the table already + item = model.Session.query(GA_Url).\ + filter(GA_Url.period_name==period_name).\ + filter(GA_Url.url==url).first() + if item: + item.period_name = period_name + item.pageviews = views + item.visitors = visitors + item.department_id = department_id + model.Session.add(item) + else: + # create the row + values = {'id': make_uuid(), + 'period_name': period_name, + 'period_complete_day': period_complete_day, + 'url': url, + 'pageviews': views, + 'visitors': visitors, + 'department_id': department_id + } + model.Session.add(GA_Url(**values)) + model.Session.commit() + + + +def update_publisher_stats(period_name): + """ + Updates the publisher stats from the data retrieved for /dataset/* + and /publisher/*. Will run against each dataset and generates the + totals for the entire tree beneath each publisher. + """ + toplevel = get_top_level() + publishers = model.Session.query(model.Group).\ + filter(model.Group.type=='publisher').\ + filter(model.Group.state=='active').all() + for publisher in publishers: + views, visitors, subpub = update_publisher(period_name, publisher, publisher.name) + parent, parents = '', publisher.get_groups('publisher') + if parents: + parent = parents[0].name + item = model.Session.query(GA_Publisher).\ + filter(GA_Publisher.period_name==period_name).\ + filter(GA_Publisher.publisher_name==publisher.name).first() + if item: + item.views = views + item.visitors = visitors + item.publisher_name = publisher.name + item.toplevel = publisher in toplevel + item.subpublishercount = subpub + item.parent = parent + model.Session.add(item) + else: + # create the row + values = {'id': make_uuid(), + 'period_name': period_name, + 'publisher_name': publisher.name, + 'views': views, + 'visitors': visitors, + 'toplevel': publisher in toplevel, + 'subpublishercount': subpub, + 'parent': parent + } + model.Session.add(GA_Publisher(**values)) + model.Session.commit() + + +def update_publisher(period_name, pub, part=''): + views,visitors,subpub = 0, 0, 0 + for publisher in go_down_tree(pub): + subpub = subpub + 1 + items = model.Session.query(GA_Url).\ + filter(GA_Url.period_name==period_name).\ + filter(GA_Url.department_id==publisher.name).all() + for item in items: + views = views + int(item.pageviews) + visitors = visitors + int(item.visitors) + + return views, visitors, (subpub-1) + + +def get_top_level(): + '''Returns the top level publishers.''' + return model.Session.query(model.Group).\ + outerjoin(model.Member, model.Member.table_id == model.Group.id and \ + model.Member.table_name == 'group' and \ + model.Member.state == 'active').\ + filter(model.Member.id==None).\ + filter(model.Group.type=='publisher').\ + order_by(model.Group.name).all() + +def get_children(publisher): + '''Finds child publishers for the given publisher (object). (Not recursive)''' + from ckan.model.group import HIERARCHY_CTE + return model.Session.query(model.Group).\ + from_statement(HIERARCHY_CTE).params(id=publisher.id, type='publisher').\ + all() + +def go_down_tree(publisher): + '''Provided with a publisher object, it walks down the hierarchy and yields each publisher, + including the one you supply.''' + yield publisher + for child in get_children(publisher): + for grandchild in go_down_tree(child): + yield grandchild + --- /dev/null +++ b/ckanext/ga_report/plugin.py @@ -1,1 +1,42 @@ +import logging +import ckan.lib.helpers as h +import ckan.plugins as p +from ckan.plugins import implements, toolkit +#import gasnippet +#import commands +#import dbutil +log = logging.getLogger('ckanext.ga-report') + +class GAReportPlugin(p.SingletonPlugin): + implements(p.IConfigurer, inherit=True) + implements(p.IRoutes, inherit=True) + + def update_config(self, config): + toolkit.add_template_directory(config, 'templates') + toolkit.add_public_directory(config, 'public') + + def after_map(self, map): + map.connect( + '/data/analytics/publisher/', + controller='ckanext.ga_report.controller:GaPublisherReport', + action='index' + ) + map.connect( + '/data/analytics/publisher/{id}', + controller='ckanext.ga_report.controller:GaPublisherReport', + action='read' + ) + map.connect( + '/data/analytics', + controller='ckanext.ga_report.controller:GaReport', + action='index' + ) + map.connect( + '/data/analytics/data_{month}.csv', + controller='ckanext.ga_report.controller:GaReport', + action='csv' + ) + return map + + --- /dev/null +++ b/ckanext/ga_report/report_model.py --- /dev/null +++ b/ckanext/ga_report/templates/ga_report/publisher/index.html @@ -1,1 +1,63 @@ + + Publisher Analytics for ${g.site_title} + + +
  • +

    Publishers

    +
    • +     + +
    +

    Publisher Analytics

    +

    The top 20 publishers

    + +
    +
    + + +
    +
    + + + + + + + + + + + + + + +
    PublisherDataset ViewsVisits
    ${h.link_to(publisher.title, h.url_for(controller='ckanext.ga_report.controller:GaPublisherReport', action='read', id=publisher.name))} + ${views}${visits}
    + + +
    + + + + + + + + + + + + --- /dev/null +++ b/ckanext/ga_report/templates/ga_report/publisher/read.html @@ -1,1 +1,64 @@ + + Analytics for ${g.site_title} + + +
  • +

    ${c.publisher.title}

    +

    + The table shows the top 20 most viewed datasets belonging to ${c.publisher.title}. +

    +

    + As well as showing the number of views within ${c.month_desc}, it will also show the + number of visitors that viewed each dataset. +

    +

    The dataset list page for ${c.publisher.title} was viewed ${c.publisher_page_views} times during ${c.month_desc}

    +

    View the publishers leaderboard

    +
    • +     + +
    +

    Analytics for ${c.publisher.title}

    + +

    Top 20 most viewed datasets

    +

    Note: this data does not include API calls

    + +
    +
    + + +
    +
    + + + + + + + + + + + + + + +
    DatasetViewsVisits
    ${h.link_to(package.title or package.name, h.url_for(controller='package', action='read', id=package.name))} + ${views}${visits}
    + + +
    + + + + + + + --- /dev/null +++ b/ckanext/ga_report/templates/ga_report/site/index.html @@ -1,1 +1,147 @@ + + Site analytics + + +
  • +

    Statistics

    +

    It is possible to export the analytics data as a CSV file, which contains all of the information for ${c.month_desc}

    + +
    • +     + +
    +

    Site statistics

    + +
    +
    + + +
    +
    + +
    + +
    +
    + + + + + + + + + + + +
    NameValue
    ${name}${value}
    +
    +
    + + + + + + + + + + + +
    NameValue
    ${name}${value}
    +
    +
    + + + + + + + + + + + +
    NameValue
    ${name}${value}
    +
    +
    + + + + + + + + + + + +
    NameValue
    ${name}${value}
    +
    +
    + + + + + + + + + + + +
    NameValue
    ${name}${value}
    +
    +
    + + + + + + + + + + + +
    NameValue
    ${name}${value}
    +
    + + +
    +
    + + + +
    + + + + + + + + + + + --- /dev/null +++ b/ckanext/ga_report/tests/test_api.py @@ -1,1 +1,38 @@ +import os +import datetime +from nose.tools import assert_equal +from ckanext.ga_report.download_analytics import DownloadAnalytics +from ckanext.ga_report.ga_auth import (init_service, get_profile_id) +from ckanext.ga_report.ga_model import init_tables +class TestAPI: + + @classmethod + def setup_class(cls): + if not os.path.exists("token.dat") or not os.path.exists("credentials.json"): + print '*' * 60 + print "Tests may not run without first having run the auth process" + print '*' * 60 + init_tables() + + @classmethod + def teardown_class(cls): + pass + + def test_latest(self): + svc = init_service("token.dat", "credentials.json") + try: + downloader = DownloadAnalytics(svc, profile_id=get_profile_id(svc)) + downloader.latest() + except Exception as e: + assert False, e + + + def test_since(self): + svc = init_service("token.dat", "credentials.json") + downloader = DownloadAnalytics(svc, profile_id=get_profile_id(svc)) + try: + downloader.for_date(datetime.datetime.now() - datetime.timedelta(days=-30)) + except Exception as e: + assert False, e + --- /dev/null +++ b/ckanext/ga_report/tests/test_auth.py @@ -1,1 +1,41 @@ +import os +from nose.tools import assert_equal +from ckanext.ga_report.ga_auth import (init_service, get_profile_id) +class TestAuth: + + @classmethod + def setup_class(cls): + if not os.path.exists("token.dat") or not os.path.exists("credentials.json"): + print '*' * 60 + print "Tests may not run without first having run the auth process" + print '*' * 60 + + @classmethod + def teardown_class(cls): + pass + + def test_init(self): + try: + res = init_service(None, None) + assert False, "Init service worked without credentials or tokens" + except TypeError: + pass + + def test_init_with_token(self): + res = init_service("token.dat", None) + assert res is not None, "Init service worked without credentials" + + def test_init_with_token_and_credentials(self): + res = init_service("token.dat", "credentials.json") + assert res is not None, "Unable to create service with valid details" + + def test_init_with_redentials(self): + #res = init_service("", "credentials.json") + # Triggers the auth flow via the browser + pass + + def test_get_profile(self): + svc = init_service("token.dat", "credentials.json") + profile = get_profile_id(svc) + assert profile is not None, "Unable to find a profile given configured UA id and user details" --- /dev/null +++ b/credentials.json.template @@ -1,1 +1,11 @@ +{ + "installed": { + "client_id": "", + "client_secret": "", + "redirect_uris": [""], + "auth_uri": "https://accounts.google.com/o/oauth2/auth", + "token_uri": "https://accounts.google.com/o/oauth2/token" + } +} + --- /dev/null +++ b/setup.py @@ -1,1 +1,38 @@ +from setuptools import setup, find_packages +import sys, os +version = '0.1' + +setup( + name='ckanext-ga-report', + version=version, + description="GA reporting for CKAN", + long_description="""\ + """, + classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers + keywords='', + author='David Read', + author_email='david.read@hackneyworkshop.com', + url='', + license='', + packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), + namespace_packages=['ckanext', 'ckanext.ga_report'], + include_package_data=True, + zip_safe=False, + install_requires=[ + 'gdata', + 'google-api-python-client' + ], + entry_points=\ + """ + [ckan.plugins] + # Add plugins here, eg + ga-report=ckanext.ga_report.plugin:GAReportPlugin + + [paste.paster_command] + loadanalytics = ckanext.ga_report.command:LoadAnalytics + initdb = ckanext.ga_report.command:InitDB + getauthtoken = ckanext.ga_report.command:GetAuthToken + """, +) +