1
0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-07-14 08:51:17 +02:00
A simple REST API to expose Solr view and download statistics for items in a DSpace repository.
Go to file
Alan Orth 1912363899
All checks were successful
continuous-integration/drone/push Build is passing
Merge pull request #42 from ilri/renovate/pytest-7.x-lockfile
Update dependency pytest to v7.4.4
2024-01-05 16:53:21 +03:00
.github/workflows .github: update workflow 2023-12-09 13:58:01 +03:00
contrib contrib: Update systemd unit files for refactor 2018-10-28 11:14:21 +02:00
dspace_statistics_api Apply fixes from fixit 2023-12-09 13:57:55 +03:00
tests tests: Fix totalPages 2021-04-06 08:54:54 +03:00
.drone.yml Update postgres Docker tag to v15 2023-05-30 08:01:58 +00:00
.flake8 Enable Flake8 validation in Hound CI 2018-11-04 00:48:06 +02:00
.gitignore .gitignore: Ignore .egg-info 2021-03-14 21:50:47 +02:00
CHANGELOG.md CHANGELOG.md: add note about falcon 3.1.1 2022-11-21 10:51:43 +03:00
LICENSE.txt Add GPLv3 license 2018-09-18 14:16:07 +03:00
poetry.lock Merge pull request #42 from ilri/renovate/pytest-7.x-lockfile 2024-01-05 16:53:21 +03:00
pyproject.toml Update dependency flake8 to v7 2024-01-05 01:26:48 +00:00
pytest.ini pytest.ini: Change --strict to --strict-markers 2020-12-14 19:07:02 +02:00
README.md Recommend Python 3.8+ 2023-05-30 10:23:10 +03:00
renovate.json Add renovate.json 2023-05-30 08:11:28 +03:00
requirements-dev.txt Update requirements 2023-05-30 11:00:46 +03:00
requirements.txt Update requirements 2023-05-30 11:00:46 +03:00

DSpace Statistics API

Build Status Build and Test Code style: black

DSpace stores item view and download events in a Solr "statistics" core. This information is available for use in the various DSpace user interfaces, but is not exposed externally via any APIs. The DSpace 4/5/6 REST API, for example, only exposes metadata about communities, collections, items, and bitstreams.

This project contains an indexer and a Falcon-based web application to make the item, community, and collection statistics available via a simple REST API. You can read more about the Solr queries used to gather the item view and download statistics on the DSpace wiki.

If you use the DSpace Statistics API please cite:

Orth, A. 2018. DSpace statistics API. Nairobi, Kenya: ILRI. https://hdl.handle.net/10568/99143.

Requirements

Installation

Create a Python virtual environment and install the dependencies:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt

Running

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:

$ python -m dspace_statistics_api.indexer

Run the REST API:

$ gunicorn dspace_statistics_api.app

Test to see if there are any statistics:

$ curl 'http://localhost:8000/items?limit=1'

Testing

Install development packages using pip:

$ pip install -r requirements-dev.txt

Run tests:

$ pytest

Deployment

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:

  • GET /return a basic API documentation page.
  • GET /itemsreturn views and downloads for all items that Solr knows about¹. Accepts limit and page query parameters for pagination of results (limit must be an integer between 1 and 100, and page must be an integer greater than or equal to 0).
  • POST /itemsreturn views and downloads for an arbitrary list of items with an optional date range. Accepts limit, page, dateFrom, and dateTo parameters².
  • GET /item/idreturn views and downloads for a single item (id must be a UUID). Returns HTTP 404 if an item id is not found.
  • GET /communitiesreturn views and downloads for all communities that Solr knows about¹. Accepts limit and page query parameters for pagination of results (limit must be an integer between 1 and 100, and page must be an integer greater than or equal to 0).
  • POST /communitiesreturn views and downloads for an arbitrary list of communities with an optional date range. Accepts limit, page, dateFrom, and dateTo parameters².
  • GET /community/idreturn views and downloads for a single community (id must be a UUID). Returns HTTP 404 if a community id is not found.
  • GET /collectionsreturn views and downloads for all collections that Solr knows about¹. Accepts limit and page query parameters for pagination of results (limit must be an integer between 1 and 100, and page must be an integer greater than or equal to 0).
  • POST /collectionsreturn views and downloads for an arbitrary list of collections with an optional date range. Accepts limit, page, dateFrom, and dateTo parameters².
  • GET /collection/idreturn views and downloads for a single collection (id must be a UUID). Returns HTTP 404 if an collection id is not found.

The id is the internal UUID for an item, community, or collection. You can get these from the standard DSpace REST API.

¹ We are querying the Solr statistics core, which technically only knows about items, communities, or collections that have either views or downloads. If an item, community, or collection is not present here you can assume it has zero views and zero downloads, but not necessarily that it does not exist in the repository.

² POST requests to /items, /communities, and /collections should be in JSON format with the following parameters (substitute the "items" list for communities or collections accordingly):

{
    "limit": 100, // optional, integer between 0 and 100, default 100
    "page": 0, // optional, integer greater than 0, default 0
    "dateFrom": "2020-01-01T00:00:00Z", // optional, default *
    "dateTo": "2020-09-09T00:00:00Z", // optional, default *
    "items": [
        "f44cf173-2344-4eb2-8f00-ee55df32c76f",
        "2324aa41-e9de-4a2b-bc36-16241464683e",
        "8542f9da-9ce1-4614-abf4-f2e3fdb4b305",
        "0fe573e7-042a-4240-a4d9-753b61233908"
    ]
}

TODO

  • Better logging
  • Version API (or at least include a /version endpoint?)
    • Probably use /status with a version in the response
  • Use JSON in PostgreSQL
  • Add top items endpoint, perhaps /top/items or /items/top?
    • Actually we could add /items?limit=10&sort=views

License

This work is licensed under the GPLv3.

The license allows you to use and modify the work for personal and commercial purposes, but if you distribute the work you must provide users with a means to access the source code for the version you are distributing. Read more about the GPLv3 at TL;DR Legal.