Tidying up
--- 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/command.py
+++ b/ckanext/ga_report/command.py
@@ -66,8 +66,7 @@
And where <time-period> is:
all - data for all time
latest - (default) just the 'latest' data
- YYYY-MM-DD - just data for all time periods going
- back to (and including) this date
+ YYYY-MM - just data for the specific month
"""
summary = __doc__.split('\n')[0]
usage = __doc__
@@ -96,6 +95,7 @@
elif time_period == 'latest':
downloader.latest()
else:
- since_date = datetime.datetime.strptime(time_period, '%Y-%m-%d')
- downloader.since_date(since_date)
+ # The month to use
+ for_date = datetime.datetime.strptime(time_period, '%Y-%m')
+ downloader.specific_month(for_date)
--- a/ckanext/ga_report/controller.py
+++ b/ckanext/ga_report/controller.py
@@ -10,10 +10,10 @@
log = logging.getLogger('ckanext.ga-report')
-def _get_month_name(str):
+def _get_month_name(strdate):
import calendar
from time import strptime
- d = strptime('2012-10', '%Y-%m')
+ d = strptime(strdate, '%Y-%m')
return '%s %s' % (calendar.month_name[d.tm_mon], d.tm_year)
@@ -21,7 +21,7 @@
months = []
vals = model.Session.query(cls.period_name).distinct().all()
for m in vals:
- months.append( (m[0], _get_month_name(m)))
+ months.append( (m[0], _get_month_name(m[0])))
return sorted(months, key=operator.itemgetter(0), reverse=True)
@@ -34,7 +34,6 @@
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)
@@ -58,7 +57,8 @@
entries = model.Session.query(GA_Stat).\
filter(GA_Stat.stat_name=='Totals').\
- filter(GA_Stat.period_name==c.month).all()
+ 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 = {
@@ -87,6 +87,7 @@
"""
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)
--- a/ckanext/ga_report/download_analytics.py
+++ b/ckanext/ga_report/download_analytics.py
@@ -21,8 +21,17 @@
self.profile_id = profile_id
- def all_(self):
- self.since_date(datetime.datetime(2010, 1, 1))
+ 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':
@@ -37,13 +46,13 @@
self.download_and_store(periods)
- def since_date(self, since_date):
+ 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 = since_date.year
- month = since_date.month
+ 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:
@@ -85,7 +94,7 @@
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))
@@ -95,7 +104,7 @@
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 )
--- a/ckanext/ga_report/plugin.py
+++ b/ckanext/ga_report/plugin.py
@@ -18,17 +18,7 @@
def after_map(self, map):
map.connect(
- '/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/',
+ '/data/analytics/publisher',
controller='ckanext.ga_report.controller:GaPublisherReport',
action='index'
)
@@ -37,6 +27,16 @@
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
--- a/ckanext/ga_report/templates/ga_report/publisher/index.html
+++ b/ckanext/ga_report/templates/ga_report/publisher/index.html
@@ -4,6 +4,12 @@
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>
--- a/ckanext/ga_report/templates/ga_report/publisher/read.html
+++ b/ckanext/ga_report/templates/ga_report/publisher/read.html
@@ -4,6 +4,21 @@
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>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>View the <a href="${h.url_for(controller='ckanext.ga_report.controller:GaPublisherReport', action='index')}">publishers</a> leaderboard</p>
+ </li>
+ </py:match>
<div py:match="content">
<h1>Analytics for ${c.publisher.title}</h1>
@@ -21,8 +36,6 @@
<input class="btn button" type='submit' value="Update"/>
</div>
</form>
-
- <p><a href="${h.url_for(controller='ckanext.dgu.controllers.publisher:PublisherController', action='read', id=c.publisher.name)}">${c.publisher.title} dataset list</a> was viewed ${c.publisher_page_views} times in ${c.month_desc}</p>
<table class="table table-condensed table-bordered table-striped">
<tr>
--- a/ckanext/ga_report/templates/ga_report/site/index.html
+++ b/ckanext/ga_report/templates/ga_report/site/index.html
@@ -4,6 +4,14 @@
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>
+ <p>It is possible to <a href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='csv',month=c.month)}">export the analytics data</a> as a CSV file, which contains all of the information for ${c.month_desc}</p>
+
+ </li>
+ </py:match>
<div py:match="content">
<h1>Site statistics</h1>
@@ -18,8 +26,6 @@
<input class="btn button" type='submit' value="Update"/>
</div>
</form>
-
- <p><a href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='csv',month=c.month)}">Export data</a> as CSV</p>
<div class="tabbable">
<ul class="nav nav-tabs">
--- a/ckanext/ga_report/tests/test_api.py
+++ b/ckanext/ga_report/tests/test_api.py
@@ -32,7 +32,7 @@
svc = init_service("token.dat", "credentials.json")
downloader = DownloadAnalytics(svc, profile_id=get_profile_id(svc))
try:
- downloader.since_date(datetime.datetime.now() - datetime.timedelta(days=-30))
+ downloader.for_date(datetime.datetime.now() - datetime.timedelta(days=-30))
except Exception as e:
assert False, e
--- a/setup.py
+++ b/setup.py
@@ -32,6 +32,7 @@
[paste.paster_command]
loadanalytics = ckanext.ga_report.command:LoadAnalytics
initdb = ckanext.ga_report.command:InitDB
+ getauthtoken = ckanext.ga_report.command:GetAuthToken
""",
)