Made sure the csv is served as an attachment
--- a/README.rst
+++ b/README.rst
@@ -26,16 +26,15 @@
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::
googleanalytics.id = UA-1010101-1
- googleanalytics.username = googleaccount@gmail.com
- googleanalytics.password = googlepassword
+ 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 password 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.
+ 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)::
--- a/ckanext/ga_report/command.py
+++ b/ckanext/ga_report/command.py
@@ -1,7 +1,10 @@
import logging
+import datetime
from ckan.lib.cli import CkanCommand
-# No other CKAN imports allowed until _load_config is run, or logging is disabled
+# No other CKAN imports allowed until _load_config is run,
+# or logging is disabled
+
class InitDB(CkanCommand):
"""Initialise the extension's database tables
@@ -46,9 +49,10 @@
assuming it is correct.
"""
from ga_auth import init_service
- initialize_service('token.dat',
- self.args[0] if self.args
- else 'credentials.json')
+ 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
@@ -62,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__
@@ -73,24 +76,26 @@
def command(self):
self._load_config()
- from ga_auth import init_service
+ 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'
+ print ('Have you correctly run the getauthtoken task and '
+ 'specified the correct file here')
return
- from download_analytics import DownloadAnalytics
- from ga_auth import get_profile_id
downloader = DownloadAnalytics(svc, profile_id=get_profile_id(svc))
- time_period = self.args[1] if self.args and len(self.args) > 1 else 'latest'
+ 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:
- 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
@@ -1,10 +1,311 @@
+import re
+import csv
+import sys
import logging
-from ckan.lib.base import BaseController, c, render
-import report_model
+import operator
+import collections
+from ckan.lib.base import BaseController, c, render, request, response, abort
+
+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
+
+ q = model.Session.query(GA_Stat)
+ if month != 'all':
+ q = q.filter(GA_Stat.period_name==month)
+ entries = q.order_by('GA_Stat.period_name, GA_Stat.stat_name, GA_Stat.key').all()
+
+ response.headers['Content-Type'] = "text/csv; charset=utf-8"
+ response.headers['Content-Disposition'] = str('attachment; filename=stats_%s.csv' % (month,))
+
+ 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_desc = 'all time'
+ c.month = request.params.get('month', '')
+ if c.month:
+ c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month])
+
+ q = model.Session.query(GA_Stat).\
+ filter(GA_Stat.stat_name=='Totals')
+ if c.month:
+ q = q.filter(GA_Stat.period_name==c.month)
+ entries = q.order_by('ga_stat.key').all()
+
+ def clean_key(key, val):
+ if key in ['Average time on site', 'Pages per visit', 'Percent new visits']:
+ val = "%.2f" % round(float(val), 2)
+ if key == 'Average time on site':
+ mins, secs = divmod(float(val), 60)
+ hours, mins = divmod(mins, 60)
+ val = '%02d:%02d:%02d (%s seconds) ' % (hours, mins, secs, val)
+ key = '%s *' % key
+ if key in ['Bounces', 'Total pageviews']:
+ val = int(val)
+ return key, val
+
+ c.global_totals = []
+ if c.month:
+ for e in entries:
+ key, val = clean_key(e.key, e.value)
+ c.global_totals.append((key, val))
+ else:
+ d = collections.defaultdict(list)
+ for e in entries:
+ d[e.key].append(float(e.value))
+ for k, v in d.iteritems():
+ if k in ['Bounces', 'Total pageviews']:
+ v = sum(v)
+ else:
+ v = float(sum(v))/len(v)
+ key, val = clean_key(k,v)
+ c.global_totals.append((key, val))
+ c.global_totals = sorted(c.global_totals, key=operator.itemgetter(0))
+
+ keys = {
+ 'Browser versions': 'browsers',
+ 'Operating Systems versions': 'os',
+ 'Social sources': 'social_networks',
+ 'Languages': 'languages',
+ 'Country': 'country'
+ }
+
+ browser_version_re = re.compile("(.*)\((.*)\)")
+ for k, v in keys.iteritems():
+
+ def clean_field(key):
+ if k != 'Browser versions':
+ return key
+ m = browser_version_re.match(key)
+ browser = m.groups()[0].strip()
+ ver = m.groups()[1]
+ parts = ver.split('.')
+ if len(parts) > 1:
+ if parts[1][0] == '0':
+ ver = parts[0]
+ else:
+ ver = "%s.%s" % (parts[0],parts[1])
+ if browser in ['Safari','Android Browser']: # Special case complex version nums
+ ver = parts[0]
+ if len(ver) > 2:
+ ver = "%s%sX" % (ver[0], ver[1])
+
+ return "%s (%s)" % (browser, ver,)
+
+ q = model.Session.query(GA_Stat).\
+ filter(GA_Stat.stat_name==k)
+ if c.month:
+ entries = []
+ q = q.filter(GA_Stat.period_name==c.month).\
+ order_by('ga_stat.value::int desc')
+
+ d = collections.defaultdict(int)
+ for e in q.all():
+ d[clean_field(e.key)] += int(e.value)
+ entries = []
+ for key, val in d.iteritems():
+ entries.append((key,val,))
+ entries = sorted(entries, key=operator.itemgetter(1), reverse=True)
+
+ setattr(c, v, [(k,v) for k,v 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 csv(self, month):
+
+ c.month = month if not month =='all' else ''
+ response.headers['Content-Type'] = "text/csv; charset=utf-8"
+ response.headers['Content-Disposition'] = str('attachment; filename=publishers_%s.csv' % (month,))
+
+ writer = csv.writer(response)
+ writer.writerow(["Publisher", "Views", "Visits", "Period Name"])
+
+ for publisher,view,visit in self._get_publishers(None):
+ writer.writerow([publisher.title.encode('utf-8'),
+ view,
+ visit,
+ month])
+
+
+
+ def publisher_csv(self, id, month):
+
+ c.month = month if not month =='all' else ''
+ c.publisher = model.Group.get(id)
+ if not c.publisher:
+ abort(404, 'A publisher with that name could not be found')
+
+ packages = self._get_packages(c.publisher)
+ response.headers['Content-Type'] = "text/csv; charset=utf-8"
+ response.headers['Content-Disposition'] = \
+ str('attachment; filename=%s_%s.csv' % (c.publisher.name, month,))
+
+ writer = csv.writer(response)
+ writer.writerow(["Publisher", "Views", "Visits", "Period Name"])
+
+ for package,view,visit in packages:
+ writer.writerow([package.title.encode('utf-8'),
+ view,
+ visit,
+ month])
+
+
+
+ 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.month_desc = 'all time'
+ if c.month:
+ c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month])
+
+ c.top_publishers = self._get_publishers()
+
+ return render('ga_report/publisher/index.html')
+
+ def _get_publishers(self, limit=20):
+ connection = model.Session.connection()
+ q = """
+ select department_id, sum(pageviews::int) views, sum(visitors::int) visits
+ from ga_url
+ where department_id <> ''"""
+ if c.month:
+ q = q + """
+ and period_name=%s
+ """
+ q = q + """
+ group by department_id order by views desc
+ """
+ if limit:
+ q = q + " limit %s;" % (limit)
+
+ # Add this back (before and period_name =%s) if you want to ignore publisher
+ # homepage views
+ # and not url like '/publisher/%%'
+
+ top_publishers = []
+ res = connection.execute(q, c.month)
+
+ for row in res:
+ g = model.Group.get(row[0])
+ if g:
+ top_publishers.append((g, row[1], row[2]))
+ return top_publishers
+
+ def _get_packages(self, publisher, count=-1):
+ if count == -1:
+ count = sys.maxint
+
+ top_packages = []
+ q = model.Session.query(GA_Url).\
+ filter(GA_Url.department_id==publisher.name).\
+ filter(GA_Url.url.like('/dataset/%'))
+ if c.month:
+ q = q.filter(GA_Url.period_name==c.month)
+ q = q.order_by('ga_url.pageviews::int desc')
+
+ if c.month:
+ for entry in q[:count]:
+ p = model.Package.get(entry.url[len('/dataset/'):])
+ top_packages.append((p,entry.pageviews,entry.visitors))
+ else:
+ ds = {}
+ for entry in q.all():
+ if len(ds) >= count:
+ break
+ p = model.Package.get(entry.url[len('/dataset/'):])
+ if not p in ds:
+ ds[p] = {'views':0, 'visits': 0}
+ ds[p]['views'] = ds[p]['views'] + int(entry.pageviews)
+ ds[p]['visits'] = ds[p]['visits'] + int(entry.visitors)
+
+ results = []
+ for k, v in ds.iteritems():
+ results.append((k,v['views'],v['visits']))
+
+ top_packages = sorted(results, key=operator.itemgetter(1), reverse=True)
+ return top_packages
+
+
+ def read(self, id):
+ count = 20
+
+ c.publisher = model.Group.get(id)
+ if not c.publisher:
+ abort(404, 'A publisher with that name could not be found')
+ 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', '')
+ if not c.month:
+ c.month_desc = 'all time'
+ else:
+ c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month])
+
+ c.publisher_page_views = 0
+ q = model.Session.query(GA_Url).\
+ filter(GA_Url.url=='/publisher/%s' % c.publisher.name)
+ if c.month:
+ entry = q.filter(GA_Url.period_name==c.month).first()
+ c.publisher_page_views = entry.pageviews if entry else 0
+ else:
+ for e in q.all():
+ c.publisher_page_views = c.publisher_page_views + int(e.pageviews)
+
+ c.top_packages = self._get_packages(c.publisher, 20)
+
+ return render('ga_report/publisher/read.html')
+
--- a/ckanext/ga_report/download_analytics.py
+++ b/ckanext/ga_report/download_analytics.py
@@ -1,3 +1,4 @@
+import os
import logging
import datetime
@@ -20,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':
@@ -36,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:
@@ -84,22 +94,27 @@
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)
- log.info('Storing Analytics for period "%s"',
+
+ 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)
-
-
- def download(self, start_date, end_date):
+ 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')
- # url
- #query = 'ga:pagePath=~^%s,ga:pagePath=~^%s' % \
- # (PACKAGE_URL, self.resource_url_tag)
- query = 'ga:pagePath=~^/dataset/'
- #query = 'ga:pagePath=~^/User/'
- metrics = 'ga:uniquePageviews'
+ query = 'ga:pagePath=%s$' % path
+ metrics = 'ga:uniquePageviews, ga:visitors'
sort = '-ga:uniquePageviews'
# Supported query params at
@@ -110,35 +125,184 @@
start_date=start_date,
metrics=metrics,
sort=sort,
- end_date=end_date).execute()
- self.print_results(results)
-
-# for entry in GA.ga_query(query_filter=query,
-# from_date=start_date,
-# metrics=metrics,
-# sort=sort,
-# to_date=end_date):
-# print entry, type(entry)
-# import pdb; pdb.set_trace()
-# for dim in entry.dimension:
-# if dim.name == "ga:pagePath":
-# package = dim.value
-# count = entry.get_metric(
-# 'ga:uniquePageviews').value or 0
-# packages[package] = int(count)
- return []
-
- def print_results(self, results):
- import pprint
- pprint.pprint(results)
- if results:
- print 'Profile: %s' % results.get('profileInfo').get('profileName')
+ 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')
- print 'Total Visits: %s' % results.get('rows', [[-1]])[0][0]
- else:
- print 'No results found'
+
+ 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)
+
--- a/ckanext/ga_report/ga_auth.py
+++ b/ckanext/ga_report/ga_auth.py
@@ -1,3 +1,4 @@
+import os
import httplib2
from apiclient.discovery import build
from oauth2client.client import flow_from_clientsecrets
@@ -7,12 +8,12 @@
from pylons import config
-def _prepare_credentials( token_filename, credentials_filename ):
+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 )
+ storage = Storage(token_filename)
credentials = storage.get()
if credentials is None or credentials.invalid:
@@ -23,7 +24,8 @@
return credentials
-def init_service( token_file, credentials_file ):
+
+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
@@ -40,15 +42,24 @@
def get_profile_id(service):
"""
Get the profile ID for this user and the service specified by the
- 'googleanalytics.id' configuration option.
+ '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
- accountId = accounts.get('items')[0].get('id')
+ 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()
@@ -56,3 +67,4 @@
return profiles.get('items')[0].get('id')
return None
+
--- a/ckanext/ga_report/ga_model.py
+++ b/ckanext/ga_report/ga_model.py
@@ -3,30 +3,80 @@
from sqlalchemy import Table, Column, MetaData
from sqlalchemy import types
-from sqlalchemy.sql import select, text
+from sqlalchemy.sql import select
+from sqlalchemy.orm import mapper
from sqlalchemy import func
import ckan.model as model
-from ckan.model.types import JsonType
from ckan.lib.base import *