Minor template tweaks
--- a/README.rst
+++ b/README.rst
@@ -26,7 +26,7 @@
1. Activate you CKAN python environment and install this extension's software::
$ pyenv/bin/activate
- $ pip install -e git+https://github.com/okfn/ckanext-ga-report.git#egg=ckanext-ga-report
+ $ 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::
--- a/ckanext/ga_report/controller.py
+++ b/ckanext/ga_report/controller.py
@@ -1,10 +1,142 @@
import logging
-from ckan.lib.base import BaseController, c, render
-import report_model
+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(str):
+ import calendar
+ from time import strptime
+ d = strptime('2012-10', '%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)))
+ 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):
- return render('index.html')
+ # 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).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')
+
--- a/ckanext/ga_report/plugin.py
+++ b/ckanext/ga_report/plugin.py
@@ -1,13 +1,14 @@
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
+#import gasnippet
+#import commands
+#import dbutil
log = logging.getLogger('ckanext.ga-report')
-class GoogleAnalyticsPlugin(p.SingletonPlugin):
+class GAReportPlugin(p.SingletonPlugin):
implements(p.IConfigurer, inherit=True)
implements(p.IRoutes, inherit=True)
@@ -17,9 +18,24 @@
def after_map(self, map):
map.connect(
- '/data/analytics/index',
- controller='ckanext.ga-report.controller:GaReport',
+ '/data/analytics',
+ controller='ckanext.ga_report.controller:GaReport',
action='index'
+ )
+ map.connect(
+ '/data/analytics_{month}.csv',
+ controller='ckanext.ga_report.controller:GaReport',
+ action='csv'
+ )
+ 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'
)
return map
--- /dev/null
+++ b/ckanext/ga_report/templates/ga_report/publisher/index.html
@@ -1,1 +1,63 @@
+<html xmlns:py="http://genshi.edgewall.org/"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ py:strip="">
+ <py:def function="page_title">Publisher Analytics for ${g.site_title}</py:def>
+
+ <py:match path="primarysidebar">
+ <li class="widget-container boxed widget_text">
+ <h4>Publishers</h4>
+ </li>
+ </py:match>
+
+ <div py:match="content">
+ <h1>Publisher Analytics</h1>
+ <h2>The top 20 publishers</h2>
+
+ <form class="form-inline" action="${h.url_for(controller='ckanext.ga_report.controller:GaPublisherReport',action='index')}" method="get">
+ <div class="controls">
+ <select name="month">
+ <py:for each="val,desc in c.months">
+ <option value='${val}' py:attrs="{'selected': 'selected' if c.month == val else None}">${desc}</option>
+ </py:for>
+ </select>
+ <input class="btn button" type='submit' value="Update"/>
+ </div>
+ </form>
+
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Publisher</th>
+ <th>Dataset Views</th>
+ <th>Visits</th>
+ </tr>
+ <py:for each="publisher, views, visits in c.top_publishers">
+ <tr>
+ <td>${h.link_to(publisher.title, h.url_for(controller='ckanext.ga_report.controller:GaPublisherReport', action='read', id=publisher.name))}
+ </td>
+ <td>${views}</td>
+ <td>${visits}</td>
+ </tr>
+ </py:for>
+ </table>
+
+
+ </div>
+
+ <xi:include href="../../layout.html" />
+
+ <py:def function="optional_footer">
+ <script type='text/javascript'>
+ $('.nav-tabs li a').click(function (e) {
+ e.preventDefault();
+ $(this).tab('show');
+ })
+ </script>
+ </py:def>
+
+</html>
+
+
+
+
--- /dev/null
+++ b/ckanext/ga_report/templates/ga_report/publisher/read.html
@@ -1,1 +1,65 @@
+<html xmlns:py="http://genshi.edgewall.org/"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ py:strip="">
+ <py:def function="page_title">Analytics for ${g.site_title}</py:def>
+
+ <py:match path="primarysidebar">
+ <li class="widget-container boxed widget_text">
+ <h4>${c.publisher.title}</h4>
+ <p>
+ The table shows the top 20 most viewed datasets belonging to ${c.publisher.title}.
+ </p>
+ <p>
+ As well as showing the number of views within ${c.month_desc}, it will also show the
+ number of visitors that viewed each dataset.
+ </p>
+ <p>
+ <p>The dataset list page for <a href="${h.url_for(controller='ckanext.dgu.controllers.publisher:PublisherController', action='read', id=c.publisher.name)}">${c.publisher.title}</a> was viewed ${c.publisher_page_views} times during ${c.month_desc}</p>
+ </p>
+ </li>
+ </py:match>
+
+ <div py:match="content">
+ <h1>Analytics for ${c.publisher.title}</h1>
+
+ <h2>Top 20 most viewed datasets</h2>
+ <p><em>Note: this data does not include API calls</em></p>
+
+ <form class="form-inline" action="${h.url_for(controller='ckanext.ga_report.controller:GaPublisherReport',action='read',id=c.publisher.name)}" method="get">
+ <div class="controls">
+ <select name="month">
+ <py:for each="val,desc in c.months">
+ <option value='${val}' py:attrs="{'selected': 'selected' if c.month == val else None}">${desc}</option>
+ </py:for>
+ </select>
+ <input class="btn button" type='submit' value="Update"/>
+ </div>
+ </form>
+
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Dataset</th>
+ <th>Views</th>
+ <th>Visits</th>
+ </tr>
+ <py:for each="package, views, visits in c.top_packages">
+ <tr>
+ <td>${h.link_to(package.title or package.name, h.url_for(controller='package', action='read', id=package.name))}
+ </td>
+ <td>${views}</td>
+ <td>${visits}</td>
+ </tr>
+ </py:for>
+ </table>
+
+
+ </div>
+
+ <xi:include href="../../layout.html" />
+</html>
+
+
+
+
--- /dev/null
+++ b/ckanext/ga_report/templates/ga_report/site/index.html
@@ -1,1 +1,147 @@
+<html xmlns:py="http://genshi.edgewall.org/"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ py:strip="">
+ <py:def function="page_title">Site analytics</py:def>
+
+ <py:match path="primarysidebar">
+ <li class="widget-container boxed widget_text">
+ <h4>Statistics</h4>
+ </li>
+ <p>It is possible to<a href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='csv',month=c.month)}">export the data</a> as CSV, which contains all of the information for ${c.month_desc}</p>
+
+ </py:match>
+
+ <div py:match="content">
+ <h1>Site statistics</h1>
+
+ <form class="form-inline" action="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='index')}" method="get">
+ <div class="controls">
+ <select name="month">
+ <py:for each="val,desc in c.months">
+ <option value='${val}' py:attrs="{'selected': 'selected' if c.month == val else None}">${desc}</option>
+ </py:for>
+ </select>
+ <input class="btn button" type='submit' value="Update"/>
+ </div>
+ </form>
+
+ <div class="tabbable">
+ <ul class="nav nav-tabs">
+ <li class="active"><a href="#totals" data-toggle="tab">Totals</a></li>
+ <li><a href="#browsers" data-toggle="tab">Browsers</a></li>
+ <li><a href="#os" data-toggle="tab">Operating Systems</a></li>
+ <li><a href="#social_networks" data-toggle="tab">Social Networks</a></li>
+ <li><a href="#languages" data-toggle="tab">Languages</a></li>
+ <li><a href="#country" data-toggle="tab">Country</a></li>
+ </ul>
+ <div class="tab-content">
+ <div class="tab-pane active" id="totals">
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <py:for each="name, value in c.global_totals">
+ <tr>
+ <td>${name}</td>
+ <td>${value}</td>
+ </tr>
+ </py:for>
+ </table>
+ </div>
+ <div class="tab-pane" id="browsers">
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <py:for each="name, value in c.browsers">
+ <tr>
+ <td>${name}</td>
+ <td>${value}</td>
+ </tr>
+ </py:for>
+ </table>
+ </div>
+ <div class="tab-pane" id="os">
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <py:for each="name, value in c.os">
+ <tr>
+ <td>${name}</td>
+ <td>${value}</td>
+ </tr>
+ </py:for>
+ </table>
+ </div>
+ <div class="tab-pane" id="social_networks">
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <py:for each="name, value in c.social_networks">
+ <tr>
+ <td>${name}</td>
+ <td>${value}</td>
+ </tr>
+ </py:for>
+ </table>
+ </div>
+ <div class="tab-pane" id="languages">
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <py:for each="name, value in c.languages">
+ <tr>
+ <td>${name}</td>
+ <td>${value}</td>
+ </tr>
+ </py:for>
+ </table>
+ </div>
+ <div class="tab-pane" id="country">
+ <table class="table table-condensed table-bordered table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <py:for each="name, value in c.country">
+ <tr>
+ <td>${name}</td>
+ <td>${value}</td>
+ </tr>
+ </py:for>
+ </table>
+ </div>
+
+
+ </div>
+ </div>
+
+
+
+ </div>
+
+ <xi:include href="../../layout.html" />
+
+ <py:def function="optional_footer">
+ <script type='text/javascript'>
+ $('.nav-tabs li a').click(function (e) {
+ e.preventDefault();
+ $(this).tab('show');
+ })
+ </script>
+ </py:def>
+</html>
+
+
+
+
--- a/setup.py
+++ b/setup.py
@@ -27,11 +27,12 @@
"""
[ckan.plugins]
# Add plugins here, eg
- ga-report=ckanext.ga_report.plugin:GaReportPlugin
+ 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
""",
)