Merge 3aa900521d50c9194f5b1797282b4eab0ebf0634 into 8196d28e886e38b64e43ec4e9e2f952950148735

Start development on 1.4.5-dev.

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+ignore = E501

.github/workflows/python-app.yml

@@ -0,0 +1,58 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Build and Test
+
+on: ['push', 'pull_request']
+
+jobs:
+  build:
+
+    runs-on: ubuntu-22.04
+
+    services:
+      database:
+        image: postgres:15-alpine
+        env:
+          # password for postgres user in the Docker container
+          POSTGRES_PASSWORD: postgres
+          # default database to create
+          POSTGRES_DB: dspacestatistics
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+        cache: 'poetry'
+    - run: poetry install
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Set up PostgreSQL
+      run: |
+        pg_isready -U postgres -d dspacestatistics
+        createuser -U postgres dspacestatistics
+        psql -U postgres -c "ALTER USER dspacestatistics WITH PASSWORD 'dspacestatistics'"
+        psql -U postgres -d dspacestatistics < tests/dspacestatistics.sql
+      env:
+        PGHOST: localhost
+        PGPASSWORD: postgres
+    - name: Test with pytest
+      run: |
+        poetry run pytest
+      env:
+        PGHOST: localhost
+        PGPASSWORD: dspacestatistics

.gitignore

@@ -1,2 +1,3 @@
 __pycache__
 venv
+*.egg-info

CHANGELOG.md

@@ -0,0 +1,274 @@
+# Changelog
+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).
+
+## Unreleased
+
+## 1.4.4 - 2024-09-11
+### Changed
+- Update recommended Python version to 3.8+
+- Use PostgreSQL 15 in CI
+- Use Python 3.12 in CI
+
+### Updated
+- Falcon 3.1.3, a minor change for us, but good to be using a current upstream
+version
+
+### Removed
+- Drone CI
+
+## 1.4.3 - 2022-03-26
+### Updated
+- Update dependencies with `poetry update`
+- Falcon 3.1.0, a minor change for us, but good to be using a current upstream
+version
+
+## 1.4.2 - 2021-04-14
+### Updated
+- Update dependencies with `poetry update`
+- Falcon 3.0.0, a minor change for us, but good to be using a current upstream
+version
+
+### Fixed
+- Bug in several of the "valid page" tests
+
+### Added
+- GitHub Actions workflow to build and test the API
+
+## [1.4.1] - 2021-01-14
+### Changed
+- Limit Solr query to UUIDs to avoid errors with unmigrated legacy stats (https://github.com/ilri/dspace-statistics-api/issues/12)
+
+### Updated
+- Dev dependencies
+
+## [1.4.0] - 2020-12-27
+### Added
+- indexer.py now indexes views and downloads for communities and collections
+- API endpoints for /communities, /community/id, /collections, and /collections/id
+- Swagger UI interface on /swagger
+- /status page which lists the API version
+
+### Changed
+- Add ORDER BY to /items resource to make sure results are returned
+deterministically
+- Use `fl` parameter in indexer to return only the field we are faceting by
+- Minor refactoring of imports for PEP8 style
+- More correct calculation of `totalPages` parameter in REST API response
+
+## [1.3.2] - 2020-11-18
+### Fixed
+- Minor issue with limit parameter (> 0)
+- Minor issue with limit parameter (<= 100)
+
+### Changed
+- Minor refactor in Solr bot filtering
+
+### Updated
+- Run poetry update
+
+## [1.3.1] - 2020-10-06
+### Changed
+- Fix issue with requirements.txt caused by poetry's export
+
+## [1.3.0] - 2020-10-06
+### Changed
+- Minor refactoring of indexer
+
+### Added
+- Ability to get statistics for arbitrary items and date ranges by POSTing a JSON-formatted request to /items as opposed to the current `GET /items` which returns pre-indexed all-time stats for all items
+
+### Updated
+- Run pipenv update, bringing minor updates to pytest, psycopg2-binary, etc
+
+## [1.2.1] - 2020-03-02
+### Changed
+- Help text in API docs should reference UUIDs
+- Sample SQL file for tests should use UUIDs
+
+## [1.2.0] - 2020-03-02
+### Changed
+- Remove Python 3.5 from TravisCI because black requires Python >= 3.6
+- Adapt API for DSpace 6+ UUIDs
+  - This requires dropping the statistics database and re-indexing
+
+### Updated
+- Run pipenv update, bringing requests 2.23.0 and pytest 5.3.5
+
+## [1.1.1] - 2019-11-27
+### Added
+- Configuration for automatic sorting of imports with isort
+- Configuration for automatic code formatting with black
+
+### Updated
+- Run pipenv update, bringing psycopg2 2.8.4, requests 2.22.0, pytest 5.3.1,
+and gunicorn 20.0.4
+
+### Changed
+- Use Ubuntu 18.04 "Bionic" for TravisCI builds
+- Use Python 3.8.0 for pipenv
+- Minor syntax issues highlighted by flake8
+
+## [1.1.0] - 2019-05-05
+### Updated
+- Falcon 2.0.0 (@alanorth)
+
+## [1.0.0] - 2019-04-15
+### Added
+- Build configuration for build.sr.ht
+
+### Updated
+- Run pipenv update, bringing pytest version 4.4.0, psycopg-binary 2.8.2, etc
+- sr.ht and TravisCI configuration to disable emojis and animation to keep logs clean
+
+### Changed
+- Use vanilla requests library instead of SolrClient
+- Use one-based paging in indexer output (for human readability)
+
+## [0.9.0] - 2019-01-22
+### Updated
+- pytest version 4.0.0
+- Fix indexing of sharded statistics cores (#10)
+- Handle case of missing views/downloads gracefully
+
+## [0.8.1] - 2018-11-14
+### Changed
+- README.md to recommend using vanilla Python virtual environments and pip instead of pipenv
+- Regenerate pipenv environment to capture only direct dependencies
+
+### Added
+- `requirements-dev.txt` for installing development packages with pip
+
+## [0.8.0] - 2018-11-11
+### Changed
+- Properly handle database connection errors
+
+### Added
+- API tests with pytest
+
+## [0.7.0] - 2018-11-07
+### Added
+- Ability to configure PostgreSQL database port with DATABASE_PORT environment variable (defaults to 5432)
+- Hound CI configuration to validate pull requests against PEP 8 code style with Flake8
+- Configuration for [pipenv](https://pipenv.readthedocs.io/en/latest/)
+
+### Changed
+- Use a database management class with Python context management to automatically open/close connections and cursors
+
+### Changed
+- Validate code against PEP 8 style guide with Flake8
+
+## [0.6.1] - 2018-10-31
+### Added
+- API documentation at root path (/)
+
+## [0.6.0] - 2018-10-31
+### Changed
+- Refactor project structure (note breaking changes to API and indexing invocation, see contrib and README.md)
+
+## [0.5.2] - 2018-10-28
+### Changed
+- Update library versions in requirements.txt
+
+## [0.5.1] - 2018-10-24
+### Changed
+- Use Python's native json instead of ujson
+
+## [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
+
+### 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
+- Major logic error in indexer.py
+
+## [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
+- Add Python 3.7 to Travis CI configuration
+
+## [0.3.0] - 2018-09-25
+### Added
+- requirements.txt for pip
+- Travis CI build configuration for Python 3.5 and 3.6
+- Documentation on using the API
+
+### Changed
+- The "all items" route from / to /items
+
+## [0.2.1] - 2018-09-24
+### Changed
+- Environment settings in example systemd unit files
+- Use psycopg2.extras.DictCursor for PostgreSQL connection
+
+## [0.2.0] - 2018-09-24
+### Changed
+- Use PostgreSQL instead of SQLite because UPSERT support needs a very new libsqlite3 whereas it's already in PostgreSQL 9.5+
+
+## [0.1.0] - 2018-09-24
+### Changed
+- Rename project to "DSpace Statistics API"
+- Use read-only database connection in API
+- Update systemd units for CGSpace→DSpace rename
+- Use UPSERT to simplify database schema and Python logic
+
+### Added
+- Example systemd service and timer unit for indexer service
+- Add top-level route to expose all item statistics
+
+### Removed
+- Ability to customize SOLR_CORE variable
+
+## [0.0.4] - 2018-09-23
+### Added
+- Added example systemd unit file for API
+- Added indexer.py to ingest views and downloads from Solr to a SQLite database
+
+### Changed
+- Refactor Solr configuration and connection
+- /item route now expects id as part of the URI instead of a query parameter: /item/id
+- View and download stats are now fetched from a SQLite database
+
+## [0.0.3] - 2018-09-20
+### Changed
+- Refactor environment variables into config module
+- Simplify Solr query for "downloads"
+- Optimize Solr query by using rows=0
+- Fix Solr queries for item views
+
+## [0.0.2] - 2018-09-18
+### Added
+- Ability to get Solr parameters from environment (`SOLR_SERVER` and `SOLR_CORE`)
+
+## [0.0.1] - 2018-09-18
+- Initial release

LICENSE.txt

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,13 +1,133 @@
-# CGSpace Statistics API
+<h1 align="center">DSpace Statistics API</h1>
-A quick and dirty REST API to expose Solr view and download statistics for items in a DSpace repository.
 
-Written and tested in Python 3.6. SolrClient (0.2.1) does not currently run in Python 3.7.0.
+<p align="center">
+<a href="https://github.com/ilri/dspace-statistics-api/actions"><img alt="Build and Test" src="https://github.com/ilri/dspace-statistics-api/actions/workflows/python-app.yml/badge.svg"></a>
+<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+</p>
+
+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](https://wiki.lyrasis.org/display/DSDOC5x/REST+API), for example, only exposes _metadata_ about communities, collections, items, and bitstreams.
+
+- If your DSpace is version 4 or 5, use [dspace-statistics-api v1.1.1](https://github.com/ilri/dspace-statistics-api/releases/tag/v1.1.1)
+- If your DSpace is version 6+, use [dspace-statistics-api v1.2.0 or greater](https://github.com/ilri/dspace-statistics-api/releases/tag/v1.2.0)
+  - Please make sure your statistics have been migrated from integers to UUIDs with the [solr-upgrade-statistics-6x](https://wiki.lyrasis.org/display/DSDOC6x/SOLR+Statistics+Maintenance) command
+
+This project contains an indexer and a [Falcon-based](https://falcon.readthedocs.io/) 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](https://wiki.lyrasis.org/display/DSPACE/Solr).
+
+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
+
+- Python 3.8+
+- PostgreSQL version 9.5+ (due to [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT))
+- DSpace with [Solr usage statistics enabled](https://wiki.lyrasis.org/display/DSDOC5x/SOLR+Statistics) (tested with 5.8+ and 6.3)
 
 ## Installation
-Create a virtual environment and run it:
+Create a Python virtual environment and install the dependencies:
 
-    $ virtualenv -p /usr/bin/python3.6 venv
+    $ python3 -m venv venv
-    $ . venv/bin/activate
+    $ source venv/bin/activate
-    $ pip install falcon gunicorn SolrClient
+    $ pip install -r requirements.txt
-    $ gunicorn app:api
 
+## 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 `/items` — return 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 `/items` — return views and downloads for an arbitrary list of items with an optional date range. Accepts `limit`, `page`, `dateFrom`, and `dateTo` parameters².
+  - GET `/item/id` — return views and downloads for a single item (`id` must be a UUID). Returns HTTP 404 if an item id is not found.
+  - GET `/communities` — return 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 `/communities` — return views and downloads for an arbitrary list of communities with an optional date range. Accepts `limit`, `page`, `dateFrom`, and `dateTo` parameters².
+  - GET `/community/id` — return views and downloads for a single community (`id` must be a UUID). Returns HTTP 404 if a community id is not found.
+  - GET `/collections` — return 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 `/collections` — return views and downloads for an arbitrary list of collections with an optional date range. Accepts `limit`, `page`, `dateFrom`, and `dateTo` parameters².
+  - GET `/collection/id` — return 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](https://www.gnu.org/licenses/gpl-3.0.en.html).
+
+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](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).

app.py

@@ -1,44 +0,0 @@
-# Tested with Python 3.6
-# See DSpace Solr docs for tips about parameters
-# https://wiki.duraspace.org/display/DSPACE/Solr
-
-import falcon
-from SolrClient import SolrClient
-
-solr_server = 'http://localhost:3000/solr'
-solr_core = 'statistics'
-
-class ItemResource:
-    def on_get(self, req, resp):
-        """Handles GET requests"""
-        # Return HTTPBadRequest if id parameter is not present and valid
-        item_id = req.get_param_as_int("id", required=True, min=0)
-
-        solr = SolrClient(solr_server)
-
-        # Get views
-        res = solr.query(solr_core, {
-            'q':'type:0',
-            'fq':'owningItem:{0} AND isBot:false AND statistics_type:view AND -bundleName:ORIGINAL'.format(item_id)
-        })
-
-        views = res.get_num_found()
-
-        # Get downloads
-        res = solr.query(solr_core, {
-            'q':'type:0',
-            'fq':'owningItem:{0} AND isBot:false AND statistics_type:view AND -(bundleName:[* TO *] -bundleName:ORIGINAL)'.format(item_id)
-        })
-
-        downloads = res.get_num_found() 
-
-        statistics = {
-            'id': item_id,
-            'views': views,
-            'downloads': downloads
-        }
-
-        resp.media = statistics
-
-api = falcon.API()
-api.add_route('/item', ItemResource())

contrib/dspace-statistics-api.service

@@ -0,0 +1,20 @@
+[Unit]
+Description=DSpace Statistics API
+After=network.target
+
+[Service]
+Environment=DATABASE_NAME=dspacestatistics
+Environment=DATABASE_USER=dspacestatistics
+Environment=DATABASE_PASS=dspacestatistics
+Environment=DATABASE_HOST=localhost
+User=nobody
+Group=nogroup
+WorkingDirectory=/var/lib/dspace-statistics-api
+ExecStart=/var/lib/dspace-statistics-api/venv/bin/gunicorn \
+          --bind 127.0.0.1:5000                             \
+          dspace_statistics_api.app
+ExecReload=/bin/kill -s HUP $MAINPID
+ExecStop=/bin/kill -s TERM $MAINPID
+
+[Install]
+WantedBy=multi-user.target

contrib/dspace-statistics-indexer.service

@@ -0,0 +1,17 @@
+[Unit]
+Description=DSpace Statistics Indexer
+After=tomcat7.target
+
+[Service]
+Environment=SOLR_SERVER=http://localhost:8081/solr
+Environment=DATABASE_NAME=dspacestatistics
+Environment=DATABASE_USER=dspacestatistics
+Environment=DATABASE_PASS=dspacestatistics
+Environment=DATABASE_HOST=localhost
+User=nobody
+Group=nogroup
+WorkingDirectory=/var/lib/dspace-statistics-api
+ExecStart=/var/lib/dspace-statistics-api/venv/bin/python -m dspace_statistics_api.indexer
+
+[Install]
+WantedBy=multi-user.target

contrib/dspace-statistics-indexer.timer

@@ -0,0 +1,12 @@
+[Unit]
+Description=DSpace Statistics Indexer
+
+[Timer]
+# twice a day, at 6AM and 6PM
+OnCalendar=*-*-* 06,18:00:00
+# Add a random delay of 0–3600 seconds
+RandomizedDelaySec=3600
+Persistent=true
+
+[Install]
+WantedBy=timers.target

dspace_statistics_api/app.py

@@ -0,0 +1,259 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import json
+import math
+
+import falcon
+import psycopg2.extras
+from falcon_swagger_ui import register_swaggerui_app
+
+from .config import DSPACE_STATISTICS_API_URL, VERSION
+from .database import DatabaseManager
+from .stats import get_downloads, get_views
+from .util import set_statistics_scope, validate_post_parameters
+
+
+class RootResource:
+    def on_get(self, req, resp):
+        resp.status = falcon.HTTP_200
+        resp.content_type = "text/html"
+        docs_html = (
+            "<!DOCTYPE html>"
+            '<html lang="en-US">'
+            "    <head>"
+            '        <meta charset="UTF-8">'
+            "        <title>DSpace Statistics API</title>"
+            "    </head>"
+            "    <body>"
+            f"        <h1>DSpace Statistics API {VERSION}</h1>"
+            f"        <p>This site is running the <a href=\"https://github.com/ilri/dspace-statistics-api\" title=\"DSpace Statistics API project\">DSpace Statistics API</a>. For more information see the project's README.md or the interactive <a href=\"{DSPACE_STATISTICS_API_URL + '/swagger'}\">Swagger UI</a> built into this API.</p>"
+            "    </body>"
+            "</html"
+        )
+
+        resp.text = docs_html
+
+
+class StatusResource:
+    def on_get(self, req, resp):
+        message = {"version": VERSION}
+
+        resp.status = falcon.HTTP_200
+        resp.media = message
+
+
+class OpenAPIJSONResource:
+    def on_get(self, req, resp):
+        resp.status = falcon.HTTP_200
+        resp.content_type = "text/html"
+        with open("dspace_statistics_api/docs/openapi.json", "r") as f:
+            # Load the openapi.json schema
+            data = json.load(f)
+
+            # Swagger assumes your API is at the root of the current host unless
+            # you configure a "servers" block in the schema. The problem is that
+            # I want this to work in both development and production, so we need
+            # to make this configurable.
+            #
+            # If the DSPACE_STATISTICS_API_URL is configured then we will add a
+            # server entry to the openapi.json schema before sending it.
+            if DSPACE_STATISTICS_API_URL != "":
+                data["servers"] = [{"url": DSPACE_STATISTICS_API_URL}]
+
+            # Set the version in the schema so Swagger UI can display it
+            data["info"]["version"] = VERSION
+
+            resp.text = json.dumps(data)
+
+
+class AllStatisticsResource:
+    @falcon.before(set_statistics_scope)
+    def on_get(self, req, resp):
+        """Handles GET requests"""
+        # Return HTTPBadRequest if id parameter is not present and valid
+        limit = req.get_param_as_int("limit", min_value=1, max_value=100) or 100
+        page = req.get_param_as_int("page", min_value=0) or 0
+        offset = limit * page
+
+        with DatabaseManager() as db:
+            db.set_session(readonly=True)
+
+            with db.cursor() as cursor:
+                # get total number of communities/collections/items so we can estimate the pages
+                cursor.execute(f"SELECT COUNT(id) FROM {req.context.statistics_scope}")
+                pages = math.ceil(cursor.fetchone()[0] / limit)
+
+                # get statistics and use limit and offset to page through results
+                cursor.execute(
+                    f"SELECT id, views, downloads FROM {req.context.statistics_scope} ORDER BY id LIMIT %s OFFSET %s",
+                    [limit, offset],
+                )
+
+                # create a list to hold dicts of stats
+                statistics = []
+
+                # iterate over results and build statistics object
+                for result in cursor:
+                    statistics.append(
+                        {
+                            "id": str(result["id"]),
+                            "views": result["views"],
+                            "downloads": result["downloads"],
+                        }
+                    )
+
+        message = {
+            "currentPage": page,
+            "totalPages": pages,
+            "limit": limit,
+            "statistics": statistics,
+        }
+
+        resp.media = message
+
+    @falcon.before(set_statistics_scope)
+    @falcon.before(validate_post_parameters)
+    def on_post(self, req, resp):
+        """Handles POST requests.
+
+        Uses two `before` hooks to set the statistics "scope" and validate the
+        POST parameters. The "scope" is the type of statistics we want, which
+        will be items, communities, or collections, depending on the request.
+        """
+
+        # Build the Solr date string, ie: [* TO *]
+        if req.context.dateFrom and req.context.dateTo:
+            solr_date_string = f"[{req.context.dateFrom} TO {req.context.dateTo}]"
+        elif not req.context.dateFrom and req.context.dateTo:
+            solr_date_string = f"[* TO {req.context.dateTo}]"
+        elif req.context.dateFrom and not req.context.dateTo:
+            solr_date_string = f"[{req.context.dateFrom} TO *]"
+        else:
+            solr_date_string = "[* TO *]"
+
+        # Helper variables to make working with pages/items/results easier and
+        # to make the code easier to understand
+        number_of_elements: int = len(req.context.elements)
+        pages: int = math.ceil(number_of_elements / req.context.limit)
+        first_element: int = req.context.page * req.context.limit
+        last_element: int = first_element + req.context.limit
+        # Get a subset of the POSTed items based on our limit. Note that Python
+        # list slicing and indexing are both zero based, but the first and last
+        # items in a slice can be confusing. See this ASCII diagram:
+        #
+        #                 +---+---+---+---+---+---+
+        #                 | P | y | t | h | o | n |
+        #                 +---+---+---+---+---+---+
+        # Slice position: 0   1   2   3   4   5   6
+        # Index position:   0   1   2   3   4   5
+        #
+        # So if we have a list of items with 240 items:
+        #
+        #   1st set: items[0:100] would give items at indexes 0 to 99
+        #   2nd set: items[100:200] would give items at indexes 100 to 199
+        #   3rd set: items[200:300] would give items at indexes 200 to 239
+        elements_subset: list = req.context.elements[first_element:last_element]
+
+        views: dict = get_views(
+            solr_date_string, elements_subset, req.context.views_facet_field
+        )
+        downloads: dict = get_downloads(
+            solr_date_string, elements_subset, req.context.downloads_facet_field
+        )
+
+        # create a list to hold dicts of stats
+        statistics = []
+
+        # iterate over views dict to extract views and use the element id as an
+        # index to the downloads dict to extract downloads.
+        for k, v in views.items():
+            statistics.append({"id": k, "views": v, "downloads": downloads[k]})
+
+        message = {
+            "currentPage": req.context.page,
+            "totalPages": pages,
+            "limit": req.context.limit,
+            "statistics": statistics,
+        }
+
+        resp.status = falcon.HTTP_200
+        resp.media = message
+
+
+class SingleStatisticsResource:
+    @falcon.before(set_statistics_scope)
+    def on_get(self, req, resp, id_):
+        """Handles GET requests"""
+
+        # Adapt Python’s uuid.UUID type to PostgreSQL’s uuid
+        # See: https://www.psycopg.org/docs/extras.html
+        psycopg2.extras.register_uuid()
+
+        with DatabaseManager() as db:
+            db.set_session(readonly=True)
+
+            with db.cursor() as cursor:
+                cursor = db.cursor()
+                cursor.execute(
+                    f"SELECT views, downloads FROM {req.context.database} WHERE id=%s",
+                    [str(id_)],
+                )
+                if cursor.rowcount == 0:
+                    raise falcon.HTTPNotFound(
+                        title=f"{req.context.statistics_scope} not found",
+                        description=f'The {req.context.statistics_scope} with id "{str(id_)}" was not found.',
+                    )
+                else:
+                    results = cursor.fetchone()
+
+                    statistics = {
+                        "id": str(id_),
+                        "views": results["views"],
+                        "downloads": results["downloads"],
+                    }
+
+                    resp.media = statistics
+
+
+app = application = falcon.App()
+app.add_route("/", RootResource())
+app.add_route("/status", StatusResource())
+
+# Item routes
+app.add_route("/items", AllStatisticsResource())
+app.add_route("/item/{id_:uuid}", SingleStatisticsResource())
+
+# Community routes
+app.add_route("/communities", AllStatisticsResource())
+app.add_route("/community/{id_:uuid}", SingleStatisticsResource())
+
+# Collection routes
+app.add_route("/collections", AllStatisticsResource())
+app.add_route("/collection/{id_:uuid}", SingleStatisticsResource())
+
+# Route to the Swagger UI Openapp schema
+app.add_route("/docs/openapi.json", OpenAPIJSONResource())
+
+# Path to host the Swagger UI. Keep in mind that Falcon will add a route for
+# this automatically when we register Swagger and the path will be relative
+# to the Falcon app like all other routes, not the absolute root.
+SWAGGERUI_PATH = "/swagger"
+
+# The *absolute* path to the OpenJSON schema. This must be absolute because
+# it will be requested by the client and must resolve absolutely. Note: the
+# name of this variable is misleading because it is actually the schema URL
+# but we pass it into the register_swaggerui_app() function as the app_url
+# parameter.
+SWAGGERUI_API_URL = f"{DSPACE_STATISTICS_API_URL}/docs/openapi.json"
+
+register_swaggerui_app(
+    app,
+    SWAGGERUI_PATH,
+    SWAGGERUI_API_URL,
+    config={
+        "supportedSubmitMethods": ["get", "post"],
+    },
+    uri_prefix=DSPACE_STATISTICS_API_URL,
+)
+
+# vim: set sw=4 ts=4 expandtab:

dspace_statistics_api/config.py

@@ -0,0 +1,23 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import os
+
+# Check if Solr connection information was provided in the environment
+SOLR_SERVER = os.environ.get("SOLR_SERVER", "http://localhost:8080/solr")
+
+DATABASE_NAME = os.environ.get("DATABASE_NAME", "dspacestatistics")
+DATABASE_USER = os.environ.get("DATABASE_USER", "dspacestatistics")
+DATABASE_PASS = os.environ.get("DATABASE_PASS", "dspacestatistics")
+DATABASE_HOST = os.environ.get("DATABASE_HOST", "localhost")
+DATABASE_PORT = os.environ.get("DATABASE_PORT", "5432")
+
+# URL to DSpace Statistics API, which will be used as a prefix to API calls in
+# the Swagger UI. An empty string will allow this to work out of the box in a
+# local development environment, but for production it should be set to a value
+# like "/rest/statistics", assuming that the statistics API is deployed next to
+# the vanilla DSpace REST API.
+DSPACE_STATISTICS_API_URL = os.environ.get("DSPACE_STATISTICS_API_URL", "")
+
+VERSION = "1.4.5-dev"
+
+# vim: set sw=4 ts=4 expandtab:

dspace_statistics_api/database.py

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import falcon
+import psycopg2
+import psycopg2.extras
+
+from .config import (
+    DATABASE_HOST,
+    DATABASE_NAME,
+    DATABASE_PASS,
+    DATABASE_PORT,
+    DATABASE_USER,
+)
+
+
+class DatabaseManager:
+    """Manage database connection."""
+
+    def __init__(self):
+        self._connection_uri = f"dbname={DATABASE_NAME} user={DATABASE_USER} password={DATABASE_PASS} host={DATABASE_HOST} port={DATABASE_PORT}"
+
+    def __enter__(self):
+        try:
+            self._connection = psycopg2.connect(
+                self._connection_uri, cursor_factory=psycopg2.extras.DictCursor
+            )
+        except psycopg2.OperationalError:
+            title = "500 Internal Server Error"
+            description = "Could not connect to database"
+            raise falcon.HTTPInternalServerError(title, description)
+
+        return self._connection
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        self._connection.close()
+
+
+# vim: set sw=4 ts=4 expandtab:

dspace_statistics_api/docs/openapi.json

@@ -0,0 +1,616 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "version": "1.4.5-dev",
+    "title": "DSpace Statistics API",
+    "description": "A [Falcon-based](https://falcon.readthedocs.io/) web application to make DSpace's item, community, and collection statistics available via a simple REST API. This Swagger interface is powered by [falcon-swagger-ui](https://github.com/rdidyk/falcon-swagger-ui).",
+    "license": {
+      "name": "GPLv3.0",
+      "url": "https://www.gnu.org/licenses/gpl-3.0.en.html"
+    }
+  },
+  "paths": {
+    "/item/{item_uuid}": {
+      "get": {
+        "summary": "Statistics for a specific item",
+        "operationId": "getItem",
+        "tags": [
+          "item"
+        ],
+        "parameters": [
+          {
+            "name": "item_uuid",
+            "in": "path",
+            "required": true,
+            "description": "The UUID of the item to retrieve",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "example": "9596aeff-0b90-47d3-9fec-02d578920507"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Expected response to a valid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SingleElementResponse"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Item not found"
+          }
+        }
+      }
+    },
+    "/items": {
+      "get": {
+        "summary": "Get statistics for all items",
+        "operationId": "getItems",
+        "tags": [
+          "items"
+        ],
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "How many items to return at once (optional)",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 1,
+              "maximum": 100,
+              "default": 100,
+              "example": 100
+            }
+          },
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Page of results to start on (optional)",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 0,
+              "default": 0,
+              "example": 0
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A paged array of items",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SingleElementResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request"
+          }
+        }
+      },
+      "post": {
+        "summary": "Get statistics for a list of items with an optional date range",
+        "operationId": "postItems",
+        "tags": [
+          "items"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "limit": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 1,
+                    "maximum": 100,
+                    "default": 100
+                  },
+                  "page": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 0,
+                    "default": 0
+                  },
+                  "dateFrom": {
+                    "type": "string",
+                    "format": "date"
+                  },
+                  "dateTo": {
+                    "type": "string",
+                    "format": "date"
+                  },
+                  "items": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "format": "uuid"
+                    }
+                  }
+                },
+                "example": {
+                  "limit": 100,
+                  "page": 0,
+                  "dateFrom": "2020-01-01T00:00:00Z",
+                  "dateTo": "2020-12-31T00:00:00Z",
+                  "items": [
+                    "f44cf173-2344-4eb2-8f00-ee55df32c76f",
+                    "2324aa41-e9de-4a2b-bc36-16241464683e",
+                    "8542f9da-9ce1-4614-abf4-f2e3fdb4b305",
+                    "0fe573e7-042a-4240-a4d9-753b61233908"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Expected response to a valid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "currentPage": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "limit": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "totalPages": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "statistics": {
+                      "$ref": "#/components/schemas/ListOfElements"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request"
+          }
+        }
+      }
+    },
+    "/community/{community_uuid}": {
+      "get": {
+        "summary": "Statistics for a specific community",
+        "operationId": "getCommunity",
+        "tags": [
+          "community"
+        ],
+        "parameters": [
+          {
+            "name": "community_uuid",
+            "in": "path",
+            "required": true,
+            "description": "The UUID of the community to retrieve",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "example": "bde7139c-d321-46bb-aef6-ae70799e5edb"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Expected response to a valid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SingleElementResponse"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Community not found"
+          }
+        }
+      }
+    },
+    "/communities": {
+      "get": {
+        "summary": "Get statistics for all communities",
+        "operationId": "getCommunities",
+        "tags": [
+          "communities"
+        ],
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "How many communities to return at once (optional)",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 1,
+              "maximum": 100,
+              "default": 100,
+              "example": 100
+            }
+          },
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Zero-based page of results to start on (optional)",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 0,
+              "default": 0,
+              "example": 0
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A paged array of communities",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SingleElementResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request"
+          }
+        }
+      },
+      "post": {
+        "summary": "Get statistics for a list of communities with an optional date range",
+        "operationId": "postCommunities",
+        "tags": [
+          "communities"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "limit": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 1,
+                    "maximum": 100,
+                    "default": 100
+                  },
+                  "page": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 0,
+                    "default": 0
+                  },
+                  "dateFrom": {
+                    "type": "string",
+                    "format": "date"
+                  },
+                  "dateTo": {
+                    "type": "string",
+                    "format": "date"
+                  },
+                  "communities": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "format": "uuid"
+                    }
+                  }
+                },
+                "example": {
+                  "limit": 100,
+                  "page": 0,
+                  "dateFrom": "2020-01-01T00:00:00Z",
+                  "dateTo": "2020-12-31T00:00:00Z",
+                  "communities": [
+                    "bde7139c-d321-46bb-aef6-ae70799e5edb",
+                    "8a8aeed1-077e-4360-bdf8-a5f3020193b1",
+                    "47d0498a-203c-407d-afb8-1d44bf29badc",
+                    "d3fe99a9-e27d-4035-9339-084c93228c82"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Expected response to a valid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "currentPage": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "limit": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "totalPages": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "statistics": {
+                      "$ref": "#/components/schemas/ListOfElements"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request"
+          }
+        }
+      }
+    },
+    "/collection/{collection_uuid}": {
+      "get": {
+        "summary": "Statistics for a specific collection",
+        "operationId": "getCollection",
+        "tags": [
+          "collection"
+        ],
+        "parameters": [
+          {
+            "name": "collection_uuid",
+            "in": "path",
+            "required": true,
+            "description": "The UUID of the collection to retrieve",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "example": "49dc95d8-bf2f-4e68-b30f-41ea266c37ae"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Expected response to a valid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SingleElementResponse"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Collection not found"
+          }
+        }
+      }
+    },
+    "/collections": {
+      "get": {
+        "summary": "Get statistics for all collections",
+        "operationId": "getCollections",
+        "tags": [
+          "collections"
+        ],
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "How many collections to return at once (optional)",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 1,
+              "maximum": 100,
+              "default": 100,
+              "example": 100
+            }
+          },
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Zero-based page of results to start on (optional)",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 0,
+              "default": 0,
+              "example": 0
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A paged array of collections",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SingleElementResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request"
+          }
+        }
+      },
+      "post": {
+        "summary": "Get statistics for a list of collections with an optional date range",
+        "operationId": "postCollections",
+        "tags": [
+          "collections"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "limit": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 1,
+                    "maximum": 100,
+                    "default": 100
+                  },
+                  "page": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 0,
+                    "default": 0
+                  },
+                  "dateFrom": {
+                    "type": "string",
+                    "format": "date"
+                  },
+                  "dateTo": {
+                    "type": "string",
+                    "format": "date"
+                  },
+                  "collections": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "format": "uuid"
+                    }
+                  }
+                },
+                "example": {
+                  "limit": 100,
+                  "page": 0,
+                  "dateFrom": "2020-01-01T00:00:00Z",
+                  "dateTo": "2020-12-31T00:00:00Z",
+                  "collections": [
+                    "5eeef6cf-b91b-42d0-9549-ea61bc8a758f",
+                    "6aac3269-b4a9-4924-a24d-9e6ee2b410d2",
+                    "551698dd-cd2b-4327-948e-54b5eb6deda5",
+                    "39358713-bbaf-4149-a453-e2b18c09fd5d"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Expected response to a valid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "currentPage": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "limit": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "totalPages": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "statistics": {
+                      "$ref": "#/components/schemas/ListOfElements"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request"
+          }
+        }
+      }
+    },
+    "/status": {
+      "get": {
+        "summary": "Get API status",
+        "operationId": "getStatus",
+        "tags": [
+          "status"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "version": {
+                      "type": "string",
+                      "example": "1.4.0-dev"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not Allowed"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SingleElementResponse": {
+        "type": "object",
+        "required": [
+          "id",
+          "views",
+          "downloads"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "views": {
+            "type": "integer",
+            "example": 450
+          },
+          "downloads": {
+            "type": "integer",
+            "example": 1337
+          }
+        }
+      },
+      "ListOfElements": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/SingleElementResponse"
+        }
+      }
+    }
+  }
+}

dspace_statistics_api/indexer.py

@@ -0,0 +1,231 @@
+# SPDX-License-Identifier: GPL-3.0-only
+#
+# indexer.py
+#
+# Connects to a DSpace Solr statistics core and ingests views and downloads for
+# communities, collections, and items into a PostgreSQL database.
+#
+# This script is written for Python 3.6+ and requires several modules that you
+# can install with pip (I recommend using a Python virtual environment):
+#
+#   $ pip install psycopg2-binary
+#
+# See: https://wiki.duraspace.org/display/DSPACE/Solr
+
+import math
+
+import psycopg2.extras
+import requests
+
+from .config import SOLR_SERVER
+from .database import DatabaseManager
+from .util import get_statistics_shards
+
+
+def index_views(indexType: str, facetField: str):
+    # get total number of distinct facets for items with a minimum of 1 view,
+    # otherwise Solr returns all kinds of weird ids that are actually not in
+    # the database. Also, stats are expensive, but we need stats.calcdistinct
+    # so we can get the countDistinct summary to calculate how many pages of
+    # results we have.
+    #
+    # see: https://lucene.apache.org/solr/guide/6_6/the-stats-component.html
+    solr_query_params = {
+        "q": f"type:2 AND {facetField}:/.{{36}}/",
+        "fq": "-isBot:true AND statistics_type:view",
+        "fl": facetField,
+        "facet": "true",
+        "facet.field": facetField,
+        "facet.mincount": 1,
+        "facet.limit": 1,
+        "facet.offset": 0,
+        "stats": "true",
+        "stats.field": facetField,
+        "stats.calcdistinct": "true",
+        "shards": shards,
+        "rows": 0,
+        "wt": "json",
+    }
+
+    solr_url = SOLR_SERVER + "/statistics/select"
+
+    res = requests.get(solr_url, params=solr_query_params)
+
+    try:
+        # get total number of distinct facets (countDistinct)
+        results_totalNumFacets = res.json()["stats"]["stats_fields"][facetField][
+            "countDistinct"
+        ]
+    except TypeError:
+        print(f"{indexType}: no views, exiting.")
+
+        exit(0)
+
+    # divide results into "pages" and round up to next integer
+    results_per_page = 100
+    results_num_pages = math.ceil(results_totalNumFacets / results_per_page)
+    results_current_page = 0
+
+    with DatabaseManager() as db:
+        with db.cursor() as cursor:
+            # create an empty list to store values for batch insertion
+            data = []
+
+            while results_current_page <= results_num_pages:
+                # "pages" are zero based, but one based is more human readable
+                print(
+                    f"{indexType}: indexing views (page {results_current_page + 1} of {results_num_pages + 1})"
+                )
+
+                solr_query_params = {
+                    "q": f"type:2 AND {facetField}:/.{{36}}/",
+                    "fq": "-isBot:true AND statistics_type:view",
+                    "fl": facetField,
+                    "facet": "true",
+                    "facet.field": facetField,
+                    "facet.mincount": 1,
+                    "facet.limit": results_per_page,
+                    "facet.offset": results_current_page * results_per_page,
+                    "shards": shards,
+                    "rows": 0,
+                    "wt": "json",
+                    "json.nl": "map",  # return facets as a dict instead of a flat list
+                }
+
+                res = requests.get(solr_url, params=solr_query_params)
+
+                # Solr returns facets as a dict of dicts (see json.nl parameter)
+                views = res.json()["facet_counts"]["facet_fields"]
+                # iterate over the facetField dict and get the ids and views
+                for id_, views in views[facetField].items():
+                    data.append((id_, views))
+
+                # do a batch insert of values from the current "page" of results
+                sql = f"INSERT INTO {indexType}(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
+
+
+def index_downloads(indexType: str, facetField: str):
+    # get the total number of distinct facets for items with at least 1 download
+    solr_query_params = {
+        "q": f"type:0 AND {facetField}:/.{{36}}/",
+        "fq": "-isBot:true AND statistics_type:view AND bundleName:ORIGINAL",
+        "fl": facetField,
+        "facet": "true",
+        "facet.field": facetField,
+        "facet.mincount": 1,
+        "facet.limit": 1,
+        "facet.offset": 0,
+        "stats": "true",
+        "stats.field": facetField,
+        "stats.calcdistinct": "true",
+        "shards": shards,
+        "rows": 0,
+        "wt": "json",
+    }
+
+    solr_url = SOLR_SERVER + "/statistics/select"
+
+    res = requests.get(solr_url, params=solr_query_params)
+
+    try:
+        # get total number of distinct facets (countDistinct)
+        results_totalNumFacets = res.json()["stats"]["stats_fields"][facetField][
+            "countDistinct"
+        ]
+    except TypeError:
+        print(f"{indexType}: no downloads, exiting.")
+
+        exit(0)
+
+    results_per_page = 100
+    results_num_pages = math.ceil(results_totalNumFacets / results_per_page)
+    results_current_page = 0
+
+    with DatabaseManager() as db:
+        with db.cursor() as cursor:
+            # create an empty list to store values for batch insertion
+            data = []
+
+            while results_current_page <= results_num_pages:
+                # "pages" are zero based, but one based is more human readable
+                print(
+                    f"{indexType}: indexing downloads (page {results_current_page + 1} of {results_num_pages + 1})"
+                )
+
+                solr_query_params = {
+                    "q": f"type:0 AND {facetField}:/.{{36}}/",
+                    "fq": "-isBot:true AND statistics_type:view AND bundleName:ORIGINAL",
+                    "fl": facetField,
+                    "facet": "true",
+                    "facet.field": facetField,
+                    "facet.mincount": 1,
+                    "facet.limit": results_per_page,
+                    "facet.offset": results_current_page * results_per_page,
+                    "shards": shards,
+                    "rows": 0,
+                    "wt": "json",
+                    "json.nl": "map",  # return facets as a dict instead of a flat list
+                }
+
+                res = requests.get(solr_url, params=solr_query_params)
+
+                # Solr returns facets as a dict of dicts (see json.nl parameter)
+                downloads = res.json()["facet_counts"]["facet_fields"]
+                # iterate over the facetField dict and get the item ids and downloads
+                for id_, downloads in downloads[facetField].items():
+                    data.append((id_, downloads))
+
+                # do a batch insert of values from the current "page" of results
+                sql = f"INSERT INTO {indexType}(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
+
+
+with DatabaseManager() as db:
+    with db.cursor() as cursor:
+        # create table to store item views and downloads
+        cursor.execute(
+            """CREATE TABLE IF NOT EXISTS items
+                  (id UUID PRIMARY KEY, views INT DEFAULT 0, downloads INT DEFAULT 0)"""
+        )
+        # create table to store community views and downloads
+        cursor.execute(
+            """CREATE TABLE IF NOT EXISTS communities
+                  (id UUID PRIMARY KEY, views INT DEFAULT 0, downloads INT DEFAULT 0)"""
+        )
+        # create table to store collection views and downloads
+        cursor.execute(
+            """CREATE TABLE IF NOT EXISTS collections
+                  (id UUID PRIMARY KEY, views INT DEFAULT 0, downloads INT DEFAULT 0)"""
+        )
+
+    # commit the table creation before closing the database connection
+    db.commit()
+
+shards = get_statistics_shards()
+
+# Index views and downloads for items, communities, and collections. Here the
+# first parameter is the type of indexing to perform, and the second parameter
+# is the field to facet by in Solr's statistics to get this information.
+
+index_views("items", "id")
+index_views("communities", "owningComm")
+index_views("collections", "owningColl")
+
+index_downloads("items", "owningItem")
+index_downloads("communities", "owningComm")
+index_downloads("collections", "owningColl")
+
+# vim: set sw=4 ts=4 expandtab:

dspace_statistics_api/stats.py

@@ -0,0 +1,126 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import requests
+
+from .config import SOLR_SERVER
+from .util import get_statistics_shards
+
+
+def get_views(solr_date_string: str, elements: list, facetField: str):
+    """
+    Get view statistics for a list of elements from Solr. Depending on the req-
+    uest this could be items, communities, or collections.
+
+    :parameter solr_date_string (str): Solr date string, for example "[* TO *]"
+    :parameter elements (list): a list of IDs
+    :parameter facetField (str): Solr field to facet by, for example "id"
+    :returns: A dict of IDs and views
+    """
+    shards = get_statistics_shards()
+
+    # Join the UUIDs with "OR" and escape the hyphens for Solr
+    solr_elements_string: str = " OR ".join(elements).replace("-", r"\-")
+
+    solr_query_params = {
+        "q": f"{facetField}:({solr_elements_string})",
+        "fq": f"type:2 AND -isBot:true AND statistics_type:view AND time:{solr_date_string}",
+        "fl": facetField,
+        "facet": "true",
+        "facet.field": facetField,
+        "facet.mincount": 1,
+        "shards": shards,
+        "rows": 0,
+        "wt": "json",
+        "json.nl": "map",  # return facets as a dict instead of a flat list
+    }
+
+    solr_url = SOLR_SERVER + "/statistics/select"
+    res = requests.get(solr_url, params=solr_query_params)
+
+    # Create an empty dict to store views
+    data = {}
+
+    # Solr returns facets as a dict of dicts (see the json.nl parameter)
+    views = res.json()["facet_counts"]["facet_fields"]
+    # iterate over the facetField dict and ids and views
+    for id_, views in views[facetField].items():
+        # For items we can rely on Solr returning facets for the *only* the ids
+        # in our query, but for communities and collections, the owningComm and
+        # owningColl fields are multi-value so Solr will return facets with the
+        # values in our query as well as *any others* that happen to be present
+        # in the field (which looks like Solr returning unrelated results until
+        # you realize that the field is multi-value and this is correct).
+        #
+        # To work around this I make sure that each id in the returned dict are
+        # present in the elements list POSTed by the user.
+        if id_ in elements:
+            data[id_] = views
+
+    # Check if any ids have missing stats so we can set them to 0
+    if len(data) < len(elements):
+        # List comprehension to get a list of ids (keys) in the data
+        data_ids = [k for k, v in data.items()]
+        for element_id in elements:
+            if element_id not in data_ids:
+                data[element_id] = 0
+                continue
+
+    return data
+
+
+def get_downloads(solr_date_string: str, elements: list, facetField: str):
+    """
+    Get download statistics for a list of items from Solr. Depending on the req-
+    uest this could be items, communities, or collections.
+
+    :parameter solr_date_string (str): Solr date string, for example "[* TO *]"
+    :parameter elements (list): a list of IDs
+    :parameter facetField (str): Solr field to facet by, for example "id"
+    :returns: A dict of IDs and downloads
+    """
+    shards = get_statistics_shards()
+
+    # Join the UUIDs with "OR" and escape the hyphens for Solr
+    solr_elements_string: str = " OR ".join(elements).replace("-", r"\-")
+
+    solr_query_params = {
+        "q": f"{facetField}:({solr_elements_string})",
+        "fq": f"type:0 AND -isBot:true AND statistics_type:view AND bundleName:ORIGINAL AND time:{solr_date_string}",
+        "fl": facetField,
+        "facet": "true",
+        "facet.field": facetField,
+        "facet.mincount": 1,
+        "shards": shards,
+        "rows": 0,
+        "wt": "json",
+        "json.nl": "map",  # return facets as a dict instead of a flat list
+    }
+
+    solr_url = SOLR_SERVER + "/statistics/select"
+    res = requests.get(solr_url, params=solr_query_params)
+
+    # Create an empty dict to store downloads
+    data = {}
+
+    # Solr returns facets as a dict of dicts (see the json.nl parameter)
+    downloads = res.json()["facet_counts"]["facet_fields"]
+    # Iterate over the facetField dict and get the ids and downloads
+    for id_, downloads in downloads[facetField].items():
+        # Make sure that each id in the returned dict are present in the
+        # elements list POSTed by the user.
+        if id_ in elements:
+            data[id_] = downloads
+
+    # Check if any elements have missing stats so we can set them to 0
+    if len(data) < len(elements):
+        # List comprehension to get a list of ids (keys) in the data
+        data_ids = [k for k, v in data.items()]
+        for element_id in elements:
+            if element_id not in data_ids:
+                data[element_id] = 0
+                continue
+
+    return data
+
+
+# vim: set sw=4 ts=4 expandtab:

dspace_statistics_api/util.py

@@ -0,0 +1,193 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import datetime
+import json
+import re
+
+import falcon
+import requests
+
+from .config import SOLR_SERVER
+
+
+def get_statistics_shards():
+    """Enumerate the cores in Solr to determine if statistics have been sharded into
+    yearly shards by DSpace's stats-util or not (for example: statistics-2018).
+
+    Returns:
+        str:A list of Solr statistics shards separated by commas.
+    """
+
+    # Initialize an empty list for statistics core years
+    statistics_core_years = []
+
+    # URL for Solr status to check active cores
+    solr_query_params = {"action": "STATUS", "wt": "json"}
+    solr_url = SOLR_SERVER + "/admin/cores"
+    res = requests.get(solr_url, params=solr_query_params)
+
+    if res.status_code == requests.codes.ok:
+        data = res.json()
+
+        # Iterate over active cores from Solr's STATUS response (cores are in
+        # the status array of this response).
+        for core in data["status"]:
+            # Pattern to match, for example: statistics-2018
+            pattern = re.compile("^statistics-[0-9]{4}$")
+
+            if not pattern.match(core):
+                continue
+
+            # Append current core to list
+            statistics_core_years.append(core)
+
+    # Initialize a string to hold our shards (may end up being empty if the Solr
+    # core has not been processed by stats-util).
+    shards = str()
+
+    if len(statistics_core_years) > 0:
+        # Begin building a string of shards starting with the default one
+        shards = f"{SOLR_SERVER}/statistics"
+
+        for core in statistics_core_years:
+            # Create a comma-separated list of shards to pass to our Solr query
+            #
+            # See: https://wiki.apache.org/solr/DistributedSearch
+            shards += f",{SOLR_SERVER}/{core}"
+
+    # Return the string of shards, which may actually be empty. Solr doesn't
+    # seem to mind if the shards query parameter is empty and I haven't seen
+    # any negative performance impact so this should be fine.
+    return shards
+
+
+def is_valid_date(date):
+    try:
+        # Solr date format is: 2020-01-01T00:00:00Z
+        # See: https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
+        datetime.datetime.strptime(date, "%Y-%m-%dT%H:%M:%SZ")
+
+        return True
+    except ValueError:
+        raise falcon.HTTPBadRequest(
+            title="Invalid parameter",
+            description=f"Invalid date format: {date}. The value must be in format: 2020-01-01T00:00:00Z.",
+        )
+
+
+def validate_post_parameters(req, resp, resource, params):
+    """Check the POSTed request parameters for the `/items`, `/communities` and
+    `/collections` endpoints.
+
+    Meant to be used as a `before` hook.
+    """
+
+    # Only attempt to read the POSTed request if its length is not 0 (or
+    # rather, in the Python sense, if length is not a False-y value).
+    if req.content_length:
+        doc = json.load(req.bounded_stream)
+    else:
+        raise falcon.HTTPBadRequest(
+            title="Invalid request", description="Request body is empty."
+        )
+
+    # Parse date parameters from request body (will raise an HTTPBadRequest
+    # from is_valid_date() if any parameters are invalid)
+    if "dateFrom" in doc and is_valid_date(doc["dateFrom"]):
+        req.context.dateFrom = doc["dateFrom"]
+    else:
+        req.context.dateFrom = None
+
+    if "dateTo" in doc and is_valid_date(doc["dateTo"]):
+        req.context.dateTo = doc["dateTo"]
+    else:
+        req.context.dateTo = None
+
+    # Parse the limit parameter from the POST request body
+    if "limit" in doc:
+        if isinstance(doc["limit"], int) and 0 < doc["limit"] <= 100:
+            req.context.limit = doc["limit"]
+        else:
+            raise falcon.HTTPBadRequest(
+                title="Invalid parameter",
+                description='The "limit" parameter is invalid. The value must be an integer between 1 and 100.',
+            )
+    else:
+        req.context.limit = 100
+
+    # Parse the page parameter from the POST request body
+    if "page" in doc:
+        if isinstance(doc["page"], int) and doc["page"] >= 0:
+            req.context.page = doc["page"]
+        else:
+            raise falcon.HTTPBadRequest(
+                title="Invalid parameter",
+                description='The "page" parameter is invalid. The value must be at least 0.',
+            )
+    else:
+        req.context.page = 0
+
+    # Parse the list of elements from the POST request body
+    if req.context.statistics_scope in doc:
+        if (
+            isinstance(doc[req.context.statistics_scope], list)
+            and len(doc[req.context.statistics_scope]) > 0
+        ):
+            req.context.elements = doc[req.context.statistics_scope]
+        else:
+            raise falcon.HTTPBadRequest(
+                title="Invalid parameter",
+                description=f'The "{req.context.statistics_scope}" parameter is invalid. The value must be a comma-separated list of UUIDs.',
+            )
+    else:
+        req.context.elements = []
+
+
+def set_statistics_scope(req, resp, resource, params):
+    """Set the statistics scope (item, collection, or community) of the request
+    as well as the appropriate database (for GET requests) and Solr facet fields
+    (for POST requests).
+
+    Meant to be used as a `before` hook.
+    """
+
+    # Extract the scope from the request path. This is *guaranteed* to be one
+    # of the following values because we only send requests matching these few
+    # patterns to routes using this set_statistics_scope hook.
+    #
+    # Note: this regex is ordered so that "items" and "collections" match before
+    # "item" and "collection".
+    req.context.statistics_scope = re.findall(
+        r"^/(communities|community|collections|collection|items|item)", req.path
+    )[0]
+
+    # Set the correct database based on the statistics_scope. The database is
+    # used for all GET requests where statistics are returned directly from the
+    # database. In this case we can return early.
+    if req.method == "GET":
+        if re.findall(r"^(item|items)$", req.context.statistics_scope):
+            req.context.database = "items"
+        elif re.findall(r"^(community|communities)$", req.context.statistics_scope):
+            req.context.database = "communities"
+        elif re.findall(r"^(collection|collections)$", req.context.statistics_scope):
+            req.context.database = "collections"
+
+        # GET requests only need the scope and the database so we can return now
+        return
+
+    # If the current request is for a plural items, communities, or collections
+    # that includes a list of element ids POSTed with the request body then we
+    # need to set the Solr facet field so we can get the live results.
+    if req.method == "POST":
+        if req.context.statistics_scope == "items":
+            req.context.views_facet_field = "id"
+            req.context.downloads_facet_field = "owningItem"
+        elif req.context.statistics_scope == "communities":
+            req.context.views_facet_field = "owningComm"
+            req.context.downloads_facet_field = "owningComm"
+        elif req.context.statistics_scope == "collections":
+            req.context.views_facet_field = "owningColl"
+            req.context.downloads_facet_field = "owningColl"
+
+
+# vim: set sw=4 ts=4 expandtab:

poetry.lock

@@ -0,0 +1,622 @@
+# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.
+
+[[package]]
+name = "black"
+version = "24.8.0"
+description = "The uncompromising code formatter."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "black-24.8.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:09cdeb74d494ec023ded657f7092ba518e8cf78fa8386155e4a03fdcc44679e6"},
+    {file = "black-24.8.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:81c6742da39f33b08e791da38410f32e27d632260e599df7245cccee2064afeb"},
+    {file = "black-24.8.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:707a1ca89221bc8a1a64fb5e15ef39cd755633daa672a9db7498d1c19de66a42"},
+    {file = "black-24.8.0-cp310-cp310-win_amd64.whl", hash = "sha256:d6417535d99c37cee4091a2f24eb2b6d5ec42b144d50f1f2e436d9fe1916fe1a"},
+    {file = "black-24.8.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:fb6e2c0b86bbd43dee042e48059c9ad7830abd5c94b0bc518c0eeec57c3eddc1"},
+    {file = "black-24.8.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:837fd281f1908d0076844bc2b801ad2d369c78c45cf800cad7b61686051041af"},
+    {file = "black-24.8.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:62e8730977f0b77998029da7971fa896ceefa2c4c4933fcd593fa599ecbf97a4"},
+    {file = "black-24.8.0-cp311-cp311-win_amd64.whl", hash = "sha256:72901b4913cbac8972ad911dc4098d5753704d1f3c56e44ae8dce99eecb0e3af"},
+    {file = "black-24.8.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:7c046c1d1eeb7aea9335da62472481d3bbf3fd986e093cffd35f4385c94ae368"},
+    {file = "black-24.8.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:649f6d84ccbae73ab767e206772cc2d7a393a001070a4c814a546afd0d423aed"},
+    {file = "black-24.8.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:2b59b250fdba5f9a9cd9d0ece6e6d993d91ce877d121d161e4698af3eb9c1018"},
+    {file = "black-24.8.0-cp312-cp312-win_amd64.whl", hash = "sha256:6e55d30d44bed36593c3163b9bc63bf58b3b30e4611e4d88a0c3c239930ed5b2"},
+    {file = "black-24.8.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:505289f17ceda596658ae81b61ebbe2d9b25aa78067035184ed0a9d855d18afd"},
+    {file = "black-24.8.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:b19c9ad992c7883ad84c9b22aaa73562a16b819c1d8db7a1a1a49fb7ec13c7d2"},
+    {file = "black-24.8.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1f13f7f386f86f8121d76599114bb8c17b69d962137fc70efe56137727c7047e"},
+    {file = "black-24.8.0-cp38-cp38-win_amd64.whl", hash = "sha256:f490dbd59680d809ca31efdae20e634f3fae27fba3ce0ba3208333b713bc3920"},
+    {file = "black-24.8.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:eab4dd44ce80dea27dc69db40dab62d4ca96112f87996bca68cd75639aeb2e4c"},
+    {file = "black-24.8.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3c4285573d4897a7610054af5a890bde7c65cb466040c5f0c8b732812d7f0e5e"},
+    {file = "black-24.8.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9e84e33b37be070ba135176c123ae52a51f82306def9f7d063ee302ecab2cf47"},
+    {file = "black-24.8.0-cp39-cp39-win_amd64.whl", hash = "sha256:73bbf84ed136e45d451a260c6b73ed674652f90a2b3211d6a35e78054563a9bb"},
+    {file = "black-24.8.0-py3-none-any.whl", hash = "sha256:972085c618ee94f402da1af548a4f218c754ea7e5dc70acb168bfaca4c2542ed"},
+    {file = "black-24.8.0.tar.gz", hash = "sha256:2500945420b6784c38b9ee885af039f5e7471ef284ab03fa35ecdde4688cd83f"},
+]
+
+[package.dependencies]
+click = ">=8.0.0"
+mypy-extensions = ">=0.4.3"
+packaging = ">=22.0"
+pathspec = ">=0.9.0"
+platformdirs = ">=2"
+tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
+typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""}
+
+[package.extras]
+colorama = ["colorama (>=0.4.3)"]
+d = ["aiohttp (>=3.7.4)", "aiohttp (>=3.7.4,!=3.9.0)"]
+jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"]
+uvloop = ["uvloop (>=0.15.2)"]
+
+[[package]]
+name = "certifi"
+version = "2024.8.30"
+description = "Python package for providing Mozilla's CA Bundle."
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "certifi-2024.8.30-py3-none-any.whl", hash = "sha256:922820b53db7a7257ffbda3f597266d435245903d80737e34f8a45ff3e3230d8"},
+    {file = "certifi-2024.8.30.tar.gz", hash = "sha256:bec941d2aa8195e248a60b31ff9f0558284cf01a52591ceda73ea9afffd69fd9"},
+]
+
+[[package]]
+name = "charset-normalizer"
+version = "3.3.2"
+description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet."
+optional = false
+python-versions = ">=3.7.0"
+files = [
+    {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"},
+    {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"},
+    {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"},
+    {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"},
+    {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"},
+    {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"},
+    {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"},
+    {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"},
+]
+
+[[package]]
+name = "click"
+version = "8.1.7"
+description = "Composable command line interface toolkit"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"},
+    {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"},
+]
+
+[package.dependencies]
+colorama = {version = "*", markers = "platform_system == \"Windows\""}
+
+[[package]]
+name = "colorama"
+version = "0.4.6"
+description = "Cross-platform colored terminal text."
+optional = false
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+files = [
+    {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
+    {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
+]
+
+[[package]]
+name = "exceptiongroup"
+version = "1.2.2"
+description = "Backport of PEP 654 (exception groups)"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"},
+    {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"},
+]
+
+[package.extras]
+test = ["pytest (>=6)"]
+
+[[package]]
+name = "falcon"
+version = "3.1.3"
+description = "The ultra-reliable, fast ASGI+WSGI framework for building data plane APIs at scale."
+optional = false
+python-versions = ">=3.5"
+files = [
+    {file = "falcon-3.1.3-cp310-cp310-macosx_11_0_x86_64.whl", hash = "sha256:094d295a767e2aa84f07bec6b23e9ebe2e43cde81d9d583bef037168bd775ad6"},
+    {file = "falcon-3.1.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8b203408040e87e8323e1c1921b106353fa5fe5dc05c9b3f4881acb3af03f556"},
+    {file = "falcon-3.1.3-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d56d9a9886387585ce4547354c9929bf5743394df04a17df6ed51ad6bb58a4cc"},
+    {file = "falcon-3.1.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1c335f1118a6e42f08cf30d56914a0bc0d470aa6db7619fdc4c546b184f38248"},
+    {file = "falcon-3.1.3-cp310-cp310-win_amd64.whl", hash = "sha256:cb6b6a79d096b3a1f2f37f66f46a2cf18deb575db6dee9935057e6036d98d01f"},
+    {file = "falcon-3.1.3-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:508fdf30617cf1fa5c9d3058c14124dc8e5f7e316e26dca22d974f916493fd0e"},
+    {file = "falcon-3.1.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ca3c6cbcba90e272f60581fb3c4561cdcd0ac6d19672f5a11a04309b1d23fa66"},
+    {file = "falcon-3.1.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7471aab646875d4478377065246a4115aaf3c0801a6eb4b6871f9836c8ef60b1"},
+    {file = "falcon-3.1.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:51bbbfa1ecb1d50bed9f8ae940b0f1049d958e945f1a08891769d40cfabe6fb2"},
+    {file = "falcon-3.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:24aa51ba4145f05649976c33664971ef36f92846208bd9d4d4158ceb51bc753f"},
+    {file = "falcon-3.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:7a1ee54bf19d9c7f998edd8ac21ab8ead1e2f73c24822237eb5485890979a25d"},
+    {file = "falcon-3.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:db78171113a3920f0f33d8dd26364527a362db2d1c3376a95778653ff87dea24"},
+    {file = "falcon-3.1.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:656e738e0e220f4503e4f07747b564f4459da159a1f32ec6d2478efb651278dd"},
+    {file = "falcon-3.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e19a0a3827821bcf754a9b24217e3b8b4750f7eb437c4a8c461135a86ca9b1c5"},
+    {file = "falcon-3.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:d52a05be5c2ef364853cdc6d97056dd880a534016db73b95f5a6ebc652577533"},
+    {file = "falcon-3.1.3-cp36-cp36m-macosx_10_14_x86_64.whl", hash = "sha256:d78a6cfe2d135632673def489a19474e2508d83475c7662c4fa63be0ba82dd81"},
+    {file = "falcon-3.1.3-cp36-cp36m-win_amd64.whl", hash = "sha256:adc23ced91c4690042a11a0515c5cfe93eeeb7d063940900aee85f8eae7460ec"},
+    {file = "falcon-3.1.3-cp37-cp37m-macosx_11_0_x86_64.whl", hash = "sha256:d6b7131e85dff13abaacb4ff479c456256f0d57b262b1fb1771180f7535cc902"},
+    {file = "falcon-3.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:57d51f556ece73766f07ede57f17fa65dbbc2cc5e1c7075fb606f727464ad71e"},
+    {file = "falcon-3.1.3-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7b210c05b38a8d655e16aa3ae2befaa70ecfb49bef73c0c1995566b22afcfdd1"},
+    {file = "falcon-3.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:04a92f159d392098a11d14b8ca71d17129d8b1ef37b7a3577f1f8bcb7b3aecba"},
+    {file = "falcon-3.1.3-cp37-cp37m-win_amd64.whl", hash = "sha256:9c82cb54bbf67861febe80d394c9b7bfa0d2e16cc998b69bfff4e8b003c721a2"},
+    {file = "falcon-3.1.3-cp38-cp38-macosx_11_0_x86_64.whl", hash = "sha256:56e8a4728fb0193e2ccd5301d864fd9743a989cc228e709e5c49ff1025cc1a4f"},
+    {file = "falcon-3.1.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:12432c3f6bce46fe4eec3db6db8d2df1abe43a7531219356f1ba859db207e57b"},
+    {file = "falcon-3.1.3-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e1f622d73111912021b8311d1e5d1eabef484217d2d30abe3d237533cb225ce9"},
+    {file = "falcon-3.1.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:19b2ce8a613a29a9eaf8243ca285ebf80464e8a6489dff60425f850fb5548936"},
+    {file = "falcon-3.1.3-cp38-cp38-win_amd64.whl", hash = "sha256:3cda76fb21568aa058ce454fa6272ca5b2582ebb0efcb7ae0090d3bf6d0db5af"},
+    {file = "falcon-3.1.3-cp39-cp39-macosx_11_0_x86_64.whl", hash = "sha256:cbd40435e99255e40ccfa849e4809cd1638fd8eccc08931fc9d355a6840a7332"},
+    {file = "falcon-3.1.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c6319883789ee3abcbde2dc10fed8016cc3d9a05018ae59944838b892101111a"},
+    {file = "falcon-3.1.3-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:796a57046b0717bff5ac488235c37ea63834a5cfc2c9291c5eeaa43c53e5e24c"},
+    {file = "falcon-3.1.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9e2fe54081f1cedc71462eff8dca074045d14380a4bca163882c6c4353f65af2"},
+    {file = "falcon-3.1.3-cp39-cp39-win_amd64.whl", hash = "sha256:ad37c46322122f34e228be4fe7ae5fcfedb630eef788a198fbdff5971091d5dc"},
+    {file = "falcon-3.1.3.tar.gz", hash = "sha256:23335dbccd44f29e85ec55f2f35d5a0bc12bd7a509f641ab81f5c64b65626263"},
+]
+
+[[package]]
+name = "falcon-swagger-ui"
+version = "1.2.1"
+description = "Swagger UI Application for Falcon"
+optional = false
+python-versions = "*"
+files = []
+develop = false
+
+[package.dependencies]
+falcon = "*"
+Jinja2 = "*"
+
+[package.source]
+type = "git"
+url = "https://github.com/alanorth/falcon-swagger-ui.git"
+reference = "falcon3-update-swagger-ui"
+resolved_reference = "c019c270b479c03d9276e20fd95488495b0943f6"
+
+[[package]]
+name = "flake8"
+version = "7.1.1"
+description = "the modular source code checker: pep8 pyflakes and co"
+optional = false
+python-versions = ">=3.8.1"
+files = [
+    {file = "flake8-7.1.1-py2.py3-none-any.whl", hash = "sha256:597477df7860daa5aa0fdd84bf5208a043ab96b8e96ab708770ae0364dd03213"},
+    {file = "flake8-7.1.1.tar.gz", hash = "sha256:049d058491e228e03e67b390f311bbf88fce2dbaa8fa673e7aea87b7198b8d38"},
+]
+
+[package.dependencies]
+mccabe = ">=0.7.0,<0.8.0"
+pycodestyle = ">=2.12.0,<2.13.0"
+pyflakes = ">=3.2.0,<3.3.0"
+
+[[package]]
+name = "gunicorn"
+version = "23.0.0"
+description = "WSGI HTTP Server for UNIX"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "gunicorn-23.0.0-py3-none-any.whl", hash = "sha256:ec400d38950de4dfd418cff8328b2c8faed0edb0d517d3394e457c317908ca4d"},
+    {file = "gunicorn-23.0.0.tar.gz", hash = "sha256:f014447a0101dc57e294f6c18ca6b40227a4c90e9bdb586042628030cba004ec"},
+]
+
+[package.dependencies]
+packaging = "*"
+
+[package.extras]
+eventlet = ["eventlet (>=0.24.1,!=0.36.0)"]
+gevent = ["gevent (>=1.4.0)"]
+setproctitle = ["setproctitle"]
+testing = ["coverage", "eventlet", "gevent", "pytest", "pytest-cov"]
+tornado = ["tornado (>=0.2)"]
+
+[[package]]
+name = "idna"
+version = "3.8"
+description = "Internationalized Domain Names in Applications (IDNA)"
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "idna-3.8-py3-none-any.whl", hash = "sha256:050b4e5baadcd44d760cedbd2b8e639f2ff89bbc7a5730fcc662954303377aac"},
+    {file = "idna-3.8.tar.gz", hash = "sha256:d838c2c0ed6fced7693d5e8ab8e734d5f8fda53a039c0164afb0b82e771e3603"},
+]
+
+[[package]]
+name = "iniconfig"
+version = "2.0.0"
+description = "brain-dead simple config-ini parsing"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"},
+    {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"},
+]
+
+[[package]]
+name = "isort"
+version = "5.13.2"
+description = "A Python utility / library to sort Python imports."
+optional = false
+python-versions = ">=3.8.0"
+files = [
+    {file = "isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6"},
+    {file = "isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109"},
+]
+
+[package.extras]
+colors = ["colorama (>=0.4.6)"]
+
+[[package]]
+name = "jinja2"
+version = "3.1.4"
+description = "A very fast and expressive template engine."
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"},
+    {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"},
+]
+
+[package.dependencies]
+MarkupSafe = ">=2.0"
+
+[package.extras]
+i18n = ["Babel (>=2.7)"]
+
+[[package]]
+name = "markupsafe"
+version = "2.1.5"
+description = "Safely add untrusted strings to HTML/XML markup."
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"},
+    {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"},
+]
+
+[[package]]
+name = "mccabe"
+version = "0.7.0"
+description = "McCabe checker, plugin for flake8"
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"},
+    {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"},
+]
+
+[[package]]
+name = "mypy-extensions"
+version = "1.0.0"
+description = "Type system extensions for programs checked with the mypy type checker."
+optional = false
+python-versions = ">=3.5"
+files = [
+    {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"},
+    {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"},
+]
+
+[[package]]
+name = "packaging"
+version = "24.1"
+description = "Core utilities for Python packages"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "packaging-24.1-py3-none-any.whl", hash = "sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124"},
+    {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"},
+]
+
+[[package]]
+name = "pathspec"
+version = "0.12.1"
+description = "Utility library for gitignore style pattern matching of file paths."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08"},
+    {file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"},
+]
+
+[[package]]
+name = "platformdirs"
+version = "4.3.2"
+description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "platformdirs-4.3.2-py3-none-any.whl", hash = "sha256:eb1c8582560b34ed4ba105009a4badf7f6f85768b30126f351328507b2beb617"},
+    {file = "platformdirs-4.3.2.tar.gz", hash = "sha256:9e5e27a08aa095dd127b9f2e764d74254f482fef22b0970773bfba79d091ab8c"},
+]
+
+[package.extras]
+docs = ["furo (>=2024.8.6)", "proselint (>=0.14)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4)"]
+test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=8.3.2)", "pytest-cov (>=5)", "pytest-mock (>=3.14)"]
+type = ["mypy (>=1.11.2)"]
+
+[[package]]
+name = "pluggy"
+version = "1.5.0"
+description = "plugin and hook calling mechanisms for python"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"},
+    {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"},
+]
+
+[package.extras]
+dev = ["pre-commit", "tox"]
+testing = ["pytest", "pytest-benchmark"]
+
+[[package]]
+name = "psycopg2"
+version = "2.9.9"
+description = "psycopg2 - Python-PostgreSQL Database Adapter"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "psycopg2-2.9.9-cp310-cp310-win32.whl", hash = "sha256:38a8dcc6856f569068b47de286b472b7c473ac7977243593a288ebce0dc89516"},
+    {file = "psycopg2-2.9.9-cp310-cp310-win_amd64.whl", hash = "sha256:426f9f29bde126913a20a96ff8ce7d73fd8a216cfb323b1f04da402d452853c3"},
+    {file = "psycopg2-2.9.9-cp311-cp311-win32.whl", hash = "sha256:ade01303ccf7ae12c356a5e10911c9e1c51136003a9a1d92f7aa9d010fb98372"},
+    {file = "psycopg2-2.9.9-cp311-cp311-win_amd64.whl", hash = "sha256:121081ea2e76729acfb0673ff33755e8703d45e926e416cb59bae3a86c6a4981"},
+    {file = "psycopg2-2.9.9-cp312-cp312-win32.whl", hash = "sha256:d735786acc7dd25815e89cc4ad529a43af779db2e25aa7c626de864127e5a024"},
+    {file = "psycopg2-2.9.9-cp312-cp312-win_amd64.whl", hash = "sha256:a7653d00b732afb6fc597e29c50ad28087dcb4fbfb28e86092277a559ae4e693"},
+    {file = "psycopg2-2.9.9-cp37-cp37m-win32.whl", hash = "sha256:5e0d98cade4f0e0304d7d6f25bbfbc5bd186e07b38eac65379309c4ca3193efa"},
+    {file = "psycopg2-2.9.9-cp37-cp37m-win_amd64.whl", hash = "sha256:7e2dacf8b009a1c1e843b5213a87f7c544b2b042476ed7755be813eaf4e8347a"},
+    {file = "psycopg2-2.9.9-cp38-cp38-win32.whl", hash = "sha256:ff432630e510709564c01dafdbe996cb552e0b9f3f065eb89bdce5bd31fabf4c"},
+    {file = "psycopg2-2.9.9-cp38-cp38-win_amd64.whl", hash = "sha256:bac58c024c9922c23550af2a581998624d6e02350f4ae9c5f0bc642c633a2d5e"},
+    {file = "psycopg2-2.9.9-cp39-cp39-win32.whl", hash = "sha256:c92811b2d4c9b6ea0285942b2e7cac98a59e166d59c588fe5cfe1eda58e72d59"},
+    {file = "psycopg2-2.9.9-cp39-cp39-win_amd64.whl", hash = "sha256:de80739447af31525feddeb8effd640782cf5998e1a4e9192ebdf829717e3913"},
+    {file = "psycopg2-2.9.9.tar.gz", hash = "sha256:d1454bde93fb1e224166811694d600e746430c006fbb031ea06ecc2ea41bf156"},
+]
+
+[[package]]
+name = "pycodestyle"
+version = "2.12.1"
+description = "Python style guide checker"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pycodestyle-2.12.1-py2.py3-none-any.whl", hash = "sha256:46f0fb92069a7c28ab7bb558f05bfc0110dac69a0cd23c61ea0040283a9d78b3"},
+    {file = "pycodestyle-2.12.1.tar.gz", hash = "sha256:6838eae08bbce4f6accd5d5572075c63626a15ee3e6f842df996bf62f6d73521"},
+]
+
+[[package]]
+name = "pyflakes"
+version = "3.2.0"
+description = "passive checker of Python programs"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pyflakes-3.2.0-py2.py3-none-any.whl", hash = "sha256:84b5be138a2dfbb40689ca07e2152deb896a65c3a3e24c251c5c62489568074a"},
+    {file = "pyflakes-3.2.0.tar.gz", hash = "sha256:1c61603ff154621fb2a9172037d84dca3500def8c8b630657d1701f026f8af3f"},
+]
+
+[[package]]
+name = "pytest"
+version = "8.3.5"
+description = "pytest: simple powerful testing with Python"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pytest-8.3.5-py3-none-any.whl", hash = "sha256:c69214aa47deac29fad6c2a4f590b9c4a9fdb16a403176fe154b79c0b4d4d820"},
+    {file = "pytest-8.3.5.tar.gz", hash = "sha256:f4efe70cc14e511565ac476b57c279e12a855b11f48f212af1080ef2263d3845"},
+]
+
+[package.dependencies]
+colorama = {version = "*", markers = "sys_platform == \"win32\""}
+exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
+iniconfig = "*"
+packaging = "*"
+pluggy = ">=1.5,<2"
+tomli = {version = ">=1", markers = "python_version < \"3.11\""}
+
+[package.extras]
+dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
+
+[[package]]
+name = "requests"
+version = "2.32.3"
+description = "Python HTTP for Humans."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6"},
+    {file = "requests-2.32.3.tar.gz", hash = "sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"},
+]
+
+[package.dependencies]
+certifi = ">=2017.4.17"
+charset-normalizer = ">=2,<4"
+idna = ">=2.5,<4"
+urllib3 = ">=1.21.1,<3"
+
+[package.extras]
+socks = ["PySocks (>=1.5.6,!=1.5.7)"]
+use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"]
+
+[[package]]
+name = "tomli"
+version = "2.0.1"
+description = "A lil' TOML parser"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
+    {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
+]
+
+[[package]]
+name = "typing-extensions"
+version = "4.12.2"
+description = "Backported and Experimental Type Hints for Python 3.8+"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
+    {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
+]
+
+[[package]]
+name = "urllib3"
+version = "2.2.2"
+description = "HTTP library with thread-safe connection pooling, file post, and more."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "urllib3-2.2.2-py3-none-any.whl", hash = "sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472"},
+    {file = "urllib3-2.2.2.tar.gz", hash = "sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168"},
+]
+
+[package.extras]
+brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"]
+h2 = ["h2 (>=4,<5)"]
+socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"]
+zstd = ["zstandard (>=0.18.0)"]
+
+[metadata]
+lock-version = "2.0"
+python-versions = "^3.8.1"
+content-hash = "5292bd71cfd9083c8ed605886e0ac6a4a35f975228a459ccc809e318dce7e294"

pyproject.toml

@@ -0,0 +1,28 @@
+[tool.poetry]
+name = "dspace-statistics-api"
+version = "1.4.5-dev"
+description = "A simple REST API to expose Solr view and download statistics for items, communities, and collections in a DSpace repository."
+authors = ["Alan Orth <aorth@mjanja.ch>"]
+license = "GPL-3.0-only"
+
+[tool.poetry.dependencies]
+python = "^3.8.1"
+gunicorn = "^23.0.0"
+falcon = "^3.1.3"
+psycopg2 = "^2.9.9"
+requests = "^2.32.3"
+falcon-swagger-ui = {git = "https://github.com/alanorth/falcon-swagger-ui.git", rev="falcon3-update-swagger-ui"}
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.0.0"
+flake8 = "^7.1.1"
+isort = "^5.13.2"
+pytest = "^8.3.3"
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"
+
+[tool.isort]
+profile = "black"
+line_length=88

pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+addopts= -rsxX -s -v --strict-markers
+filterwarnings =
+    error::UserWarning

renovate.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ],
+  "pip_requirements": {
+      "enabled": false
+  }
+}

requirements-dev.txt

@@ -0,0 +1,29 @@
+black==24.8.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+certifi==2024.8.30 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+charset-normalizer==3.3.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+click==8.1.7 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+colorama==0.4.6 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0" and (sys_platform == "win32" or platform_system == "Windows")
+exceptiongroup==1.2.2 ; python_full_version >= "3.8.1" and python_version < "3.11"
+falcon-swagger-ui @ git+https://github.com/alanorth/falcon-swagger-ui.git@c019c270b479c03d9276e20fd95488495b0943f6 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+falcon==3.1.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+flake8==7.1.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+gunicorn==23.0.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+idna==3.8 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+iniconfig==2.0.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+isort==5.13.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+jinja2==3.1.4 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+markupsafe==2.1.5 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+mccabe==0.7.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+mypy-extensions==1.0.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+packaging==24.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pathspec==0.12.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+platformdirs==4.3.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pluggy==1.5.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+psycopg2==2.9.9 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pycodestyle==2.12.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pyflakes==3.2.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pytest==8.3.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+requests==2.32.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+tomli==2.0.1 ; python_full_version >= "3.8.1" and python_version < "3.11"
+typing-extensions==4.12.2 ; python_full_version >= "3.8.1" and python_version < "3.11"
+urllib3==2.2.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"

requirements.txt

@@ -0,0 +1,12 @@
+certifi==2024.8.30 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+charset-normalizer==3.3.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+falcon-swagger-ui @ git+https://github.com/alanorth/falcon-swagger-ui.git@c019c270b479c03d9276e20fd95488495b0943f6 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+falcon==3.1.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+gunicorn==23.0.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+idna==3.8 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+jinja2==3.1.4 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+markupsafe==2.1.5 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+packaging==24.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+psycopg2==2.9.9 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+requests==2.32.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+urllib3==2.2.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"

tests/test_api_collections.py

@@ -0,0 +1,379 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import json
+from unittest.mock import patch
+
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
+
+
+@pytest.fixture
+def client():
+    return testing.TestClient(app)
+
+
+def test_get_collection(client):
+    """Test requesting a single collection."""
+
+    response = client.simulate_get("/collection/8ea4b611-1f59-4d4e-b78d-a9921a72cfe7")
+    response_doc = json.loads(response.text)
+
+    assert isinstance(response_doc["downloads"], int)
+    assert isinstance(response_doc["id"], str)
+    assert isinstance(response_doc["views"], int)
+    assert response.status_code == 200
+
+
+def test_get_missing_collection(client):
+    """Test requesting a single non-existing collection."""
+
+    response = client.simulate_get("/collection/508abe0a-689f-402e-885d-2f6b02e7a39c")
+
+    assert response.status_code == 404
+
+
+def test_get_collections(client):
+    """Test requesting 100 collections."""
+
+    response = client.simulate_get("/collections", query_string="limit=100")
+    response_doc = json.loads(response.text)
+
+    assert isinstance(response_doc["currentPage"], int)
+    assert isinstance(response_doc["totalPages"], int)
+    assert isinstance(response_doc["statistics"], list)
+    assert response.status_code == 200
+
+
+def test_get_collections_invalid_limit(client):
+    """Test requesting 100 collections with an invalid limit parameter."""
+
+    response = client.simulate_get("/collections", query_string="limit=101")
+
+    assert response.status_code == 400
+
+
+def test_get_collections_invalid_page(client):
+    """Test requesting 100 collections with an invalid page parameter."""
+
+    response = client.simulate_get("/collections", query_string="page=-1")
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_collections_valid_dateFrom(client):
+    """Test POSTing a request to /collections with a valid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00Z",
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_collections_valid_dateFrom_mocked(client):
+    """Mock test POSTing a request to /collections with a valid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00Z",
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    get_views_return_value = {
+        "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 21,
+        "260548c8-fda4-4dc8-a979-03495753cdd5": 0,
+    }
+    get_downloads_return_value = {
+        "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 575,
+        "260548c8-fda4-4dc8-a979-03495753cdd5": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_collections_invalid_dateFrom(client):
+    """Test POSTing a request to /collections with an invalid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00",
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_collections_valid_dateTo(client):
+    """Test POSTing a request to /collections with a valid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateTo": "2020-01-01T00:00:00Z",
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_collections_valid_dateTo_mocked(client):
+    """Mock test POSTing a request to /collections with a valid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateTo": "2020-01-01T00:00:00Z",
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    get_views_return_value = {
+        "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 21,
+        "260548c8-fda4-4dc8-a979-03495753cdd5": 0,
+    }
+    get_downloads_return_value = {
+        "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 575,
+        "260548c8-fda4-4dc8-a979-03495753cdd5": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_collections_invalid_dateTo(client):
+    """Test POSTing a request to /collections with an invalid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00",
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_collections_valid_limit(client):
+    """Test POSTing a request to /collections with a valid limit parameter in the request body."""
+
+    request_body = {
+        "limit": 1,
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 1
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 1
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+
+
+def test_post_collections_valid_limit_mocked(client):
+    """Mock test POSTing a request to /collections with a valid limit parameter in the request body."""
+
+    request_body = {
+        "limit": 1,
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    get_views_return_value = {"8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 21}
+    get_downloads_return_value = {"8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 575}
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 1
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 1
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+
+
+def test_post_collections_invalid_limit(client):
+    """Test POSTing a request to /collections with an invalid limit parameter in the request body."""
+
+    request_body = {
+        "limit": -1,
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_collections_valid_page(client):
+    """Test POSTing a request to /collections with a valid page parameter in the request body."""
+
+    request_body = {
+        "page": 0,
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert response.json["totalPages"] == 1
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_collections_valid_page_mocked(client):
+    """Mock test POSTing a request to /collections with a valid page parameter in the request body."""
+
+    request_body = {
+        "page": 0,
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    get_views_return_value = {
+        "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 21,
+        "260548c8-fda4-4dc8-a979-03495753cdd5": 0,
+    }
+    get_downloads_return_value = {
+        "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7": 575,
+        "260548c8-fda4-4dc8-a979-03495753cdd5": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_collections_invalid_page(client):
+    """Test POSTing a request to /collections with an invalid page parameter in the request body."""
+
+    request_body = {
+        "page": -1,
+        "collections": [
+            "8ea4b611-1f59-4d4e-b78d-a9921a72cfe7",
+            "260548c8-fda4-4dc8-a979-03495753cdd5",
+        ],
+    }
+
+    response = client.simulate_post("/collections", json=request_body)
+
+    assert response.status_code == 400
+
+
+# vim: set sw=4 ts=4 expandtab:

tests/test_api_communities.py

@@ -0,0 +1,379 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import json
+from unittest.mock import patch
+
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
+
+
+@pytest.fixture
+def client():
+    return testing.TestClient(app)
+
+
+def test_get_community(client):
+    """Test requesting a single community."""
+
+    response = client.simulate_get("/community/bde7139c-d321-46bb-aef6-ae70799e5edb")
+    response_doc = json.loads(response.text)
+
+    assert isinstance(response_doc["downloads"], int)
+    assert isinstance(response_doc["id"], str)
+    assert isinstance(response_doc["views"], int)
+    assert response.status_code == 200
+
+
+def test_get_missing_community(client):
+    """Test requesting a single non-existing community."""
+
+    response = client.simulate_get("/item/dec6bfc6-efeb-4f74-8436-79fa80bb5c21")
+
+    assert response.status_code == 404
+
+
+def test_get_communities(client):
+    """Test requesting 100 communities."""
+
+    response = client.simulate_get("/communities", query_string="limit=100")
+    response_doc = json.loads(response.text)
+
+    assert isinstance(response_doc["currentPage"], int)
+    assert isinstance(response_doc["totalPages"], int)
+    assert isinstance(response_doc["statistics"], list)
+    assert response.status_code == 200
+
+
+def test_get_communities_invalid_limit(client):
+    """Test requesting 100 communities with an invalid limit parameter."""
+
+    response = client.simulate_get("/communities", query_string="limit=101")
+
+    assert response.status_code == 400
+
+
+def test_get_communities_invalid_page(client):
+    """Test requesting 100 communities with an invalid page parameter."""
+
+    response = client.simulate_get("/communities", query_string="page=-1")
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_communities_valid_dateFrom(client):
+    """Test POSTing a request to /communities with a valid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00Z",
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_communities_valid_dateFrom_mocked(client):
+    """Mock test POSTing a request to /communities with a valid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00Z",
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    get_views_return_value = {
+        "bde7139c-d321-46bb-aef6-ae70799e5edb": 309,
+        "2a920a61-b08a-4642-8e5d-2639c6702b1f": 0,
+    }
+    get_downloads_return_value = {
+        "bde7139c-d321-46bb-aef6-ae70799e5edb": 400,
+        "2a920a61-b08a-4642-8e5d-2639c6702b1f": 290,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_communities_invalid_dateFrom(client):
+    """Test POSTing a request to /communities with an invalid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00",
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_communities_valid_dateTo(client):
+    """Test POSTing a request to /communities with a valid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateTo": "2020-01-01T00:00:00Z",
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_communities_valid_dateTo_mocked(client):
+    """Mock test POSTing a request to /communities with a valid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateTo": "2020-01-01T00:00:00Z",
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    get_views_return_value = {
+        "bde7139c-d321-46bb-aef6-ae70799e5edb": 21,
+        "2a920a61-b08a-4642-8e5d-2639c6702b1f": 0,
+    }
+    get_downloads_return_value = {
+        "bde7139c-d321-46bb-aef6-ae70799e5edb": 575,
+        "2a920a61-b08a-4642-8e5d-2639c6702b1f": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_communities_invalid_dateTo(client):
+    """Test POSTing a request to /communities with an invalid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00",
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_communities_valid_limit(client):
+    """Test POSTing a request to /communities with a valid limit parameter in the request body."""
+
+    request_body = {
+        "limit": 1,
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 1
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 1
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+
+
+def test_post_communities_valid_limit_mocked(client):
+    """Mock test POSTing a request to /communities with a valid limit parameter in the request body."""
+
+    request_body = {
+        "limit": 1,
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    get_views_return_value = {"bde7139c-d321-46bb-aef6-ae70799e5edb": 200}
+    get_downloads_return_value = {"bde7139c-d321-46bb-aef6-ae70799e5edb": 309}
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 1
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 1
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+
+
+def test_post_communities_invalid_limit(client):
+    """Test POSTing a request to /communities with an invalid limit parameter in the request body."""
+
+    request_body = {
+        "limit": -1,
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_communities_valid_page(client):
+    """Test POSTing a request to /communities with a valid page parameter in the request body."""
+
+    request_body = {
+        "page": 0,
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert response.json["totalPages"] == 1
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_communities_valid_page_mocked(client):
+    """Mock test POSTing a request to communities with a valid page parameter in the request body."""
+
+    request_body = {
+        "page": 0,
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    get_views_return_value = {
+        "bde7139c-d321-46bb-aef6-ae70799e5edb": 21,
+        "2a920a61-b08a-4642-8e5d-2639c6702b1f": 0,
+    }
+    get_downloads_return_value = {
+        "bde7139c-d321-46bb-aef6-ae70799e5edb": 575,
+        "2a920a61-b08a-4642-8e5d-2639c6702b1f": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_communities_invalid_page(client):
+    """Test POSTing a request to /communities with an invalid page parameter in the request body."""
+
+    request_body = {
+        "page": -1,
+        "communities": [
+            "bde7139c-d321-46bb-aef6-ae70799e5edb",
+            "2a920a61-b08a-4642-8e5d-2639c6702b1f",
+        ],
+    }
+
+    response = client.simulate_post("/communities", json=request_body)
+
+    assert response.status_code == 400
+
+
+# vim: set sw=4 ts=4 expandtab:

tests/test_api_docs.py

@@ -0,0 +1,50 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
+
+
+@pytest.fixture
+def client():
+    return testing.TestClient(app)
+
+
+def test_get_docs(client):
+    """Test requesting the documentation at the root."""
+
+    response = client.simulate_get("/")
+
+    assert isinstance(response.content, bytes)
+    assert response.status_code == 200
+
+
+def test_get_openapi_json(client):
+    """Test requesting the OpenAPI JSON schema."""
+
+    response = client.simulate_get("/docs/openapi.json")
+
+    assert isinstance(response.content, bytes)
+    assert response.status_code == 200
+
+
+def test_get_swagger_ui(client):
+    """Test requesting the Swagger UI."""
+
+    response = client.simulate_get("/swagger")
+
+    assert isinstance(response.content, bytes)
+    assert response.status_code == 200
+
+
+def test_get_status(client):
+    """Test requesting the status page."""
+
+    response = client.simulate_get("/status")
+
+    assert isinstance(response.content, bytes)
+    assert response.status_code == 200
+
+
+# vim: set sw=4 ts=4 expandtab:

tests/test_api_items.py

@@ -0,0 +1,379 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
+import json
+from unittest.mock import patch
+
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
+
+
+@pytest.fixture
+def client():
+    return testing.TestClient(app)
+
+
+def test_get_item(client):
+    """Test requesting a single item."""
+
+    response = client.simulate_get("/item/fd8a46d5-1480-4e69-b187-cd3db96d8e4d")
+    response_doc = json.loads(response.text)
+
+    assert isinstance(response_doc["downloads"], int)
+    assert isinstance(response_doc["id"], str)
+    assert isinstance(response_doc["views"], int)
+    assert response.status_code == 200
+
+
+def test_get_missing_item(client):
+    """Test requesting a single non-existing item."""
+
+    response = client.simulate_get("/item/c3910974-c3a5-4053-9dce-104aa7bb1620")
+
+    assert response.status_code == 404
+
+
+def test_get_items(client):
+    """Test requesting 100 items."""
+
+    response = client.simulate_get("/items", query_string="limit=100")
+    response_doc = json.loads(response.text)
+
+    assert isinstance(response_doc["currentPage"], int)
+    assert isinstance(response_doc["totalPages"], int)
+    assert isinstance(response_doc["statistics"], list)
+    assert response.status_code == 200
+
+
+def test_get_items_invalid_limit(client):
+    """Test requesting 100 items with an invalid limit parameter."""
+
+    response = client.simulate_get("/items", query_string="limit=101")
+
+    assert response.status_code == 400
+
+
+def test_get_items_invalid_page(client):
+    """Test requesting 100 items with an invalid page parameter."""
+
+    response = client.simulate_get("/items", query_string="page=-1")
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_items_valid_dateFrom(client):
+    """Test POSTing a request to /items with a valid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00Z",
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_items_valid_dateFrom_mocked(client):
+    """Mock test POSTing a request to /items with a valid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00Z",
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    get_views_return_value = {
+        "fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21,
+        "e53a2eab-1e31-448d-907b-3656ca4e86c1": 0,
+    }
+    get_downloads_return_value = {
+        "fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575,
+        "e53a2eab-1e31-448d-907b-3656ca4e86c1": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_items_invalid_dateFrom(client):
+    """Test POSTing a request to /items with an invalid dateFrom parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00",
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_items_valid_dateTo(client):
+    """Test POSTing a request to /items with a valid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateTo": "2020-01-01T00:00:00Z",
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_items_valid_dateTo_mocked(client):
+    """Mock test POSTing a request to /items with a valid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateTo": "2020-01-01T00:00:00Z",
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    get_views_return_value = {
+        "fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21,
+        "e53a2eab-1e31-448d-907b-3656ca4e86c1": 0,
+    }
+    get_downloads_return_value = {
+        "fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575,
+        "e53a2eab-1e31-448d-907b-3656ca4e86c1": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_items_invalid_dateTo(client):
+    """Test POSTing a request to /items with an invalid dateTo parameter in the request body."""
+
+    request_body = {
+        "dateFrom": "2020-01-01T00:00:00",
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_items_valid_limit(client):
+    """Test POSTing a request to /items with a valid limit parameter in the request body."""
+
+    request_body = {
+        "limit": 1,
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 1
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 1
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+
+
+def test_post_items_valid_limit_mocked(client):
+    """Mock test POSTing a request to /items with a valid limit parameter in the request body."""
+
+    request_body = {
+        "limit": 1,
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    get_views_return_value = {"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21}
+    get_downloads_return_value = {"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575}
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 1
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 1
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+
+
+def test_post_items_invalid_limit(client):
+    """Test POSTing a request to /items with an invalid limit parameter in the request body."""
+
+    request_body = {
+        "limit": -1,
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 400
+
+
+@pytest.mark.xfail
+def test_post_items_valid_page(client):
+    """Test POSTing a request to /items with a valid page parameter in the request body."""
+
+    request_body = {
+        "page": 0,
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert response.json["totalPages"] == 1
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_items_valid_page_mocked(client):
+    """Mock test POSTing a request to /items with a valid page parameter in the request body."""
+
+    request_body = {
+        "page": 0,
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    get_views_return_value = {
+        "fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21,
+        "e53a2eab-1e31-448d-907b-3656ca4e86c1": 0,
+    }
+    get_downloads_return_value = {
+        "fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575,
+        "e53a2eab-1e31-448d-907b-3656ca4e86c1": 899,
+    }
+
+    with patch(
+        "dspace_statistics_api.app.get_views", return_value=get_views_return_value
+    ):
+        with patch(
+            "dspace_statistics_api.app.get_downloads",
+            return_value=get_downloads_return_value,
+        ):
+            response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 200
+    assert response.json["limit"] == 100
+    assert response.json["currentPage"] == 0
+    assert isinstance(response.json["totalPages"], int)
+    assert len(response.json["statistics"]) == 2
+    assert isinstance(response.json["statistics"][0]["views"], int)
+    assert isinstance(response.json["statistics"][0]["downloads"], int)
+    assert isinstance(response.json["statistics"][1]["views"], int)
+    assert isinstance(response.json["statistics"][1]["downloads"], int)
+
+
+def test_post_items_invalid_page(client):
+    """Test POSTing a request to /items with an invalid page parameter in the request body."""
+
+    request_body = {
+        "page": -1,
+        "items": [
+            "fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
+            "e53a2eab-1e31-448d-907b-3656ca4e86c1",
+        ],
+    }
+
+    response = client.simulate_post("/items", json=request_body)
+
+    assert response.status_code == 400
+
+
+# vim: set sw=4 ts=4 expandtab: