CHANGELOG.md: Release version 0.3.2

CHANGELOG.md

@@ -4,6 +4,10 @@ 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.3.2] - 2018-09-25
+## Changed
+- /item/id route now returns HTTP 404 if an item is not found
+
 ## [0.3.1] - 2018-09-25
 ### Changed
 - Force SolrClient's kazoo dependency to version 2.5.0 to work with Python 3.7

README.md

@@ -15,16 +15,15 @@ Create a virtual environment and run it:
 The API exposes the following endpoints:
 
   - GET `/items` — return views and downloads for all items that Solr knows about¹. Accepts `limit` and `page` query parameters for pagination of results.
-  - GET `/item/id` — return views and downloads for a single item (*id* must be a positive integer).
+  - GET `/item/id` — return views and downloads for a single item (*id* must be a positive integer). Returns HTTP 404 if an item id is not found.
 
-¹ We are querying the Solr statistics core, which technically only knows about all items that have either views or downloads.
+¹ We are querying the Solr statistics core, which technically only knows about items that have either views or downloads.
 
 ## Todo
 
 - Add API documentation
 - Close up DB connection when gunicorn shuts down gracefully
 - Better logging
-- Return HTTP 404 when item_id is nonexistent
 - Tests
 
 ## License

app.py

@@ -47,17 +47,24 @@ class ItemResource:
 
         cursor = db.cursor()
         cursor.execute('SELECT views, downloads FROM items WHERE id={}'.format(item_id))
-        results = cursor.fetchone()
+        if cursor.rowcount == 0:
+            raise falcon.HTTPNotFound(
+                    title='Item not found',
+                    description='The item with id "{}" was not found.'.format(item_id)
+            )
+        else:
+            results = cursor.fetchone()
+
+            statistics = {
+                'id': item_id,
+                'views': results['views'],
+                'downloads': results['downloads']
+            }
+
+            resp.media = statistics
+
         cursor.close()
 
-        statistics = {
-            'id': item_id,
-            'views': results['views'],
-            'downloads': results['downloads']
-        }
-
-        resp.media = statistics
-
 api = falcon.API()
 api.add_route('/items', AllItemsResource())
 api.add_route('/item/{item_id:int}', ItemResource())

indexer.py

@@ -20,17 +20,15 @@
 # ---
 #
 # Connects to a DSpace Solr statistics core and ingests item views and downloads
-# into a Postgres database for use with other applications (an API, for example).
+# into a PostgreSQL database for use by other applications (like an API).
 #
-# This script is written for Python 3 and requires several modules that you can
-# install with pip (I recommend setting up a Python virtual environment first):
+# This script is written for Python 3.5+ and requires several modules that you
+# can install with pip (I recommend using a Python virtual environment):
 #
-#   $ pip install SolrClient
+#   $ pip install SolrClient psycopg2-binary
 #
 # See: https://solrclient.readthedocs.io/en/latest/SolrClient.html
 # See: https://wiki.duraspace.org/display/DSPACE/Solr
-#
-# Tested with Python 3.5 and 3.6.
 
 from database import database_connection
 from solr import solr_connection