CHANGELOG.md: Update and move to 0.4.3 release

They are faster.

.travis.yml

@@ -2,8 +2,10 @@ language: python
 python:
   - "3.5"
   - "3.6"
-  - "3.7"
-install:
-  - pip install -r requirements.txt
+  - "3.7-dev"
+script: pip install -r requirements.txt
+branches:
+  only:
+    - master
 
 # vim: ts=2 sw=2 et

CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [0.4.3] - 2018-10-17
+## Changed
+- Use pip install as script for Travis CI
+
+## Improved
+- Documentation for deployment and testing
+
+## [0.4.2] - 2018-10-04
+### Changed
+- README.md introduction and requirements
+- Use ujson instead of json
+- Iterate directly on SQL cursor in `/items` route
+
+### Fixed
+- Logic error in SQL for item views
+
+## [0.4.1] - 2018-09-26
+### Changed
+- Use execute_values() to batch insert records to PostgreSQL
+
 ## [0.4.0] - 2018-09-25
 ### Fixed
 - Invalid OnCalendar syntax in dspace-statistics-indexer.timer

README.md

@@ -1,16 +1,42 @@
-# DSpace Statistics API
-A quick and dirty REST API to expose Solr view and download statistics for items in a DSpace repository.
+# DSpace Statistics API [![Build Status](https://travis-ci.org/alanorth/dspace-statistics-api.svg?branch=master)](https://travis-ci.org/alanorth/dspace-statistics-api)
+A simple REST API to expose Solr view and download statistics for items in a DSpace repository. This project contains a standalone indexing component and a WSGI application.
 
-Written and tested in Python 3.5, 3.6, and 3.7. Requires PostgreSQL version 9.5 or greater for [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT).
+## Requirements
 
-## Installation
-Create a virtual environment and run it:
+- Python 3.5+
+- PostgreSQL version 9.5+ (due to [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT))
+- DSpace 4+ with [Solr usage statistics enabled](https://wiki.duraspace.org/display/DSDOC5x/SOLR+Statistics)
+
+## Installation and Testing
+Create a Python virtual environment and install the dependencies:
 
     $ python -m venv venv
     $ . venv/bin/activate
     $ pip install -r requirements.txt
+
+Set up the environment variables for Solr and PostgreSQL:
+
+    $ export SOLR_SERVER=http://localhost:8080/solr
+    $ export DATABASE_NAME=dspacestatistics
+    $ export DATABASE_USER=dspacestatistics
+    $ export DATABASE_PASS=dspacestatistics
+    $ export DATABASE_HOST=localhost
+
+Index the Solr statistics core to populate the PostgreSQL database:
+
+    $ ./indexer.py
+
+Run the REST API:
+
     $ gunicorn app:api
 
+Test to see if there are any statistics:
+
+    $ curl 'http://localhost:8000/items?limit=1'
+
+## Deployment
+There are example systemd service and timer units in the `contrib` directory.
+
 ## Using the API
 The API exposes the following endpoints:
 
@@ -22,9 +48,13 @@ The API exposes the following endpoints:
 ## Todo
 
 - Add API documentation
-- Close up DB connection when gunicorn shuts down gracefully
+- Close DB connection when gunicorn shuts down gracefully
 - Better logging
 - Tests
+- Check if database exists (try/except)
+- Version API
+- Use JSON in PostgreSQL
+- Switch to [Python 3.6+ f-string syntax](https://realpython.com/python-f-strings/)
 
 ## License
 This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).

app.py

@@ -22,16 +22,16 @@ class AllItemsResource:
 
         # get statistics, ordered by id, and use limit and offset to page through results
         cursor.execute('SELECT id, views, downloads FROM items ORDER BY id ASC LIMIT {} OFFSET {}'.format(limit, offset))
-        results = cursor.fetchmany(limit)
-        cursor.close()
 
         # create a list to hold dicts of item stats
         statistics = list()
 
         # iterate over results and build statistics object
-        for item in results:
+        for item in cursor:
             statistics.append({ 'id': item['id'], 'views': item['views'], 'downloads': item['downloads'] })
 
+        cursor.close()
+
         message = {
                 'currentPage': page,
                 'totalPages': pages,

database.py

@@ -2,8 +2,7 @@ from config import DATABASE_NAME
 from config import DATABASE_USER
 from config import DATABASE_PASS
 from config import DATABASE_HOST
-import psycopg2
-import psycopg2.extras
+import psycopg2, psycopg2.extras
 
 def database_connection():
     connection = psycopg2.connect("dbname={} user={} password={} host='{}'".format(DATABASE_NAME, DATABASE_USER, DATABASE_PASS, DATABASE_HOST), cursor_factory=psycopg2.extras.DictCursor)

indexer.py

@@ -31,7 +31,8 @@
 # See: https://wiki.duraspace.org/display/DSPACE/Solr
 
 from database import database_connection
-import json
+import ujson
+import psycopg2.extras
 from solr import solr_connection
 
 def index_views():
@@ -55,7 +56,7 @@ def index_views():
     }, rows=0)
 
     # get total number of distinct facets (countDistinct)
-    results_totalNumFacets = json.loads(res.get_json())['stats']['stats_fields']['id']['countDistinct']
+    results_totalNumFacets = ujson.loads(res.get_json())['stats']['stats_fields']['id']['countDistinct']
 
     # divide results into "pages" (cast to int to effectively round down)
     results_per_page = 100
@@ -64,6 +65,9 @@ def index_views():
 
     cursor = db.cursor()
 
+    # create an empty list to store values for batch insertion
+    data = []
+
     while results_current_page <= results_num_pages:
         print('Indexing item views (page {} of {})'.format(results_current_page, results_num_pages))
 
@@ -77,19 +81,20 @@ def index_views():
             'facet.offset':results_current_page * results_per_page
         }, rows=0)
 
-        # check number of facets returned in the last query
-        #results_currentNumFacets = len(res.get_facets()['id'])
-
         # SolrClient's get_facets() returns a dict of dicts
         views = res.get_facets()
         # in this case iterate over the 'id' dict and get the item ids and views
         for item_id, item_views in views['id'].items():
-            cursor.execute('''INSERT INTO items(id, views) VALUES(%s, %s)
-                           ON CONFLICT(id) DO UPDATE SET downloads=excluded.views''',
-                           (item_id, item_views))
+            data.append((item_id, item_views))
 
+        # do a batch insert of values from the current "page" of results
+        sql = 'INSERT INTO items(id, views) VALUES %s ON CONFLICT(id) DO UPDATE SET views=excluded.views'
+        psycopg2.extras.execute_values(cursor, sql, data, template='(%s, %s)')
         db.commit()
 
+        # clear all items from the list so we can populate it with the next batch
+        data.clear()
+
         results_current_page += 1
 
     cursor.close()
@@ -110,7 +115,7 @@ def index_downloads():
     }, rows=0)
 
     # get total number of distinct facets (countDistinct)
-    results_totalNumFacets = json.loads(res.get_json())['stats']['stats_fields']['owningItem']['countDistinct']
+    results_totalNumFacets = ujson.loads(res.get_json())['stats']['stats_fields']['owningItem']['countDistinct']
 
     # divide results into "pages" (cast to int to effectively round down)
     results_per_page = 100
@@ -119,6 +124,9 @@ def index_downloads():
 
     cursor = db.cursor()
 
+    # create an empty list to store values for batch insertion
+    data = []
+
     while results_current_page <= results_num_pages:
         print('Indexing item downloads (page {} of {})'.format(results_current_page, results_num_pages))
 
@@ -136,12 +144,16 @@ def index_downloads():
         downloads = res.get_facets()
         # in this case iterate over the 'owningItem' dict and get the item ids and downloads
         for item_id, item_downloads in downloads['owningItem'].items():
-            cursor.execute('''INSERT INTO items(id, downloads) VALUES(%s, %s)
-                           ON CONFLICT(id) DO UPDATE SET downloads=excluded.downloads''',
-                           (item_id, item_downloads))
+            data.append((item_id, item_downloads))
 
+        # do a batch insert of values from the current "page" of results
+        sql = 'INSERT INTO items(id, downloads) VALUES %s ON CONFLICT(id) DO UPDATE SET downloads=excluded.downloads'
+        psycopg2.extras.execute_values(cursor, sql, data, template='(%s, %s)')
         db.commit()
 
+        # clear all items from the list so we can populate it with the next batch
+        data.clear()
+
         results_current_page += 1
 
     cursor.close()

requirements.txt

@@ -9,4 +9,5 @@ python-mimeparse==1.6.0
 requests==2.19.1
 six==1.11.0
 SolrClient==0.2.1
+ujson==1.35
 urllib3==1.23