CHANGELOG.md: Move unreleased changes to v0.5.0

We only need Solr in the indexing component, not for the API itself.

CHANGELOG.md

@@ -4,6 +4,13 @@ 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.5.0] - 2018-10-24
+## Added
+- Example nginx configuration to README.md
+
+## Changed
+- Don't initialize Solr connection in API
+
 ### [0.4.3] - 2018-10-17
 ## Changed
 - Use pip install as script for Travis CI

README.md

@@ -35,7 +35,26 @@ 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.
+There are example systemd service and timer units in the `contrib` directory. The API service listens on localhost by default so you will need to expose it publicly using a web server like nginx.
+
+An example nginx configuration is:
+
+```
+server {
+    #...
+
+    location ~ /rest/statistics/?(.*) {
+        access_log /var/log/nginx/statistics.log;
+        proxy_pass http://statistics_api/$1$is_args$args;
+    }
+}
+
+upstream statistics_api {
+    server 127.0.0.1:5000;
+}
+```
+
+This would expose the API at `/rest/statistics`.
 
 ## Using the API
 The API exposes the following endpoints:

app.py

@@ -1,10 +1,8 @@
 from database import database_connection
 import falcon
-from solr import solr_connection
 
 db = database_connection()
 db.set_session(readonly=True)
-solr = solr_connection()
 
 class AllItemsResource:
     def on_get(self, req, resp):
@@ -65,6 +63,9 @@ class ItemResource:
 
         cursor.close()
 
+def on_exit(api):
+    print("Shutting down DB")
+
 api = falcon.API()
 api.add_route('/items', AllItemsResource())
 api.add_route('/item/{item_id:int}', ItemResource())

contrib/dspace-statistics-api.service

@@ -9,8 +9,8 @@ Environment=DATABASE_PASS=dspacestatistics
 Environment=DATABASE_HOST=localhost
 User=nobody
 Group=nogroup
-WorkingDirectory=/opt/ilri/dspace-statistics-api
-ExecStart=/opt/ilri/dspace-statistics-api/venv/bin/gunicorn \
+WorkingDirectory=/var/lib/dspace-statistics-api
+ExecStart=/var/lib/dspace-statistics-api/venv/bin/gunicorn \
           --bind 127.0.0.1:5000                             \
           app:api
 ExecReload=/bin/kill -s HUP $MAINPID

contrib/dspace-statistics-indexer.service

@@ -10,8 +10,8 @@ Environment=DATABASE_PASS=dspacestatistics
 Environment=DATABASE_HOST=localhost
 User=nobody
 Group=nogroup
-WorkingDirectory=/opt/ilri/dspace-statistics-api
-ExecStart=/opt/ilri/dspace-statistics-api/venv/bin/python indexer.py
+WorkingDirectory=/var/lib/dspace-statistics-api
+ExecStart=/var/lib/dspace-statistics-api/venv/bin/python indexer.py
 
 [Install]
 WantedBy=multi-user.target