Merge pull request #42 from ilri/renovate/pytest-7.x-lockfile

Update dependency pytest to v7.4.4

.build.yml

@@ -1,21 +0,0 @@
-image: archlinux
-packages:
-  - python-poetry
-  - postgresql
-sources:
-  - https://git.sr.ht/~alanorth/dspace-statistics-api
-tasks:
-  - setup: |
-      id
-      psql --version
-      sudo su - postgres -c "initdb --locale en_US.UTF-8 -E UTF8 -D '/var/lib/postgres/data'"
-      sudo systemctl start postgresql
-      createuser -U postgres dspacestatistics
-      psql -U postgres -c "ALTER USER dspacestatistics WITH PASSWORD 'dspacestatistics'"
-      createdb -U postgres -O dspacestatistics --encoding=UNICODE dspacestatistics
-      cd dspace-statistics-api
-      psql -U postgres -d dspacestatistics < tests/dspacestatistics.sql
-      poetry install --no-root
-  - test: |
-      cd dspace-statistics-api
-      poetry run pytest

.drone.yml

@@ -1,10 +1,49 @@
 kind: pipeline
 type: docker
+name: python310
+
+steps:
+- name: setup
+  image: postgres:15-alpine
+  environment:
+    PGPASSWORD: postgres
+  commands:
+  - id
+  - psql --version
+  - sleep 5
+  - pg_isready -h database -U postgres -d dspacestatistics
+  - createuser -h database -U postgres dspacestatistics
+  - psql -h database -U postgres -c "ALTER USER dspacestatistics WITH PASSWORD 'dspacestatistics'"
+  - psql -h database -U postgres -d dspacestatistics < tests/dspacestatistics.sql
+
+- name: test
+  image: python:3.10-slim
+  environment:
+    PGPASSWORD: dspacestatistics
+    DATABASE_HOST: database
+  commands:
+  - id
+  - python -V
+  - apt update && apt install -y gcc git libpq-dev
+  - pip install -r requirements-dev.txt
+  - pytest
+
+services:
+- name: database
+  image: postgres:15-alpine
+  environment:
+    POSTGRES_USER: postgres
+    POSTGRES_PASSWORD: postgres
+    POSTGRES_DB: dspacestatistics
+
+---
+kind: pipeline
+type: docker
 name: python39
 
 steps:
 - name: setup
-  image: postgres:10-alpine
+  image: postgres:15-alpine
   environment:
     PGPASSWORD: postgres
   commands:
@@ -24,13 +63,13 @@ steps:
   commands:
   - id
   - python -V
-  - apt update && apt install -y gcc
+  - apt update && apt install -y gcc git libpq-dev
   - pip install -r requirements-dev.txt
   - pytest
 
 services:
 - name: database
-  image: postgres:10-alpine
+  image: postgres:15-alpine
   environment:
     POSTGRES_USER: postgres
     POSTGRES_PASSWORD: postgres
@@ -43,7 +82,7 @@ name: python38
 
 steps:
 - name: database
-  image: postgres:10-alpine
+  image: postgres:15-alpine
   detach: true
   environment:
     POSTGRES_USER: postgres
@@ -51,7 +90,7 @@ steps:
     POSTGRES_DB: dspacestatistics
 
 - name: setup
-  image: postgres:10-alpine
+  image: postgres:15-alpine
   environment:
     PGPASSWORD: postgres
   commands:
@@ -71,82 +110,7 @@ steps:
   commands:
   - id
   - python -V
-  - pip install -r requirements-dev.txt
-  - pytest
-
----
-kind: pipeline
-type: docker
-name: python37
-
-steps:
-- name: database
-  image: postgres:10-alpine
-  detach: true
-  environment:
-    POSTGRES_USER: postgres
-    POSTGRES_PASSWORD: postgres
-    POSTGRES_DB: dspacestatistics
-
-- name: setup
-  image: postgres:10-alpine
-  environment:
-    PGPASSWORD: postgres
-  commands:
-  - id
-  - psql --version
-  - sleep 5
-  - pg_isready -h database -U postgres -d dspacestatistics
-  - createuser -h database -U postgres dspacestatistics
-  - psql -h database -U postgres -c "ALTER USER dspacestatistics WITH PASSWORD 'dspacestatistics'"
-  - psql -h database -U postgres -d dspacestatistics < tests/dspacestatistics.sql
-
-- name: test
-  image: python:3.7-slim
-  environment:
-    PGPASSWORD: dspacestatistics
-    DATABASE_HOST: database
-  commands:
-  - id
-  - python -V
-  - pip install -r requirements-dev.txt
-  - pytest
-
----
-kind: pipeline
-type: docker
-name: python36
-
-steps:
-- name: database
-  image: postgres:10-alpine
-  detach: true
-  environment:
-    POSTGRES_USER: postgres
-    POSTGRES_PASSWORD: postgres
-    POSTGRES_DB: dspacestatistics
-
-- name: setup
-  image: postgres:10-alpine
-  environment:
-    PGPASSWORD: postgres
-  commands:
-  - id
-  - psql --version
-  - sleep 5
-  - pg_isready -h database -U postgres -d dspacestatistics
-  - createuser -h database -U postgres dspacestatistics
-  - psql -h database -U postgres -c "ALTER USER dspacestatistics WITH PASSWORD 'dspacestatistics'"
-  - psql -h database -U postgres -d dspacestatistics < tests/dspacestatistics.sql
-
-- name: test
-  image: python:3.6-slim
-  environment:
-    PGPASSWORD: dspacestatistics
-    DATABASE_HOST: database
-  commands:
-  - id
-  - python -V
+  - apt update && apt install -y gcc git libpq-dev
   - pip install -r requirements-dev.txt
   - pytest
 

.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.11'
+        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

.hound.yml

@@ -1,4 +0,0 @@
-flake8:
-    enabled: true
-    config_file: .flake8
-    fail_on_violations: true

CHANGELOG.md

@@ -4,6 +4,39 @@ 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
+### Changed
+- Update recommended Python version to 3.7+
+- Use PostgreSQL 12 in CI
+
+### Updated
+- Falcon 3.1.1
+
+## 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
@@ -72,7 +105,7 @@ and gunicorn 20.0.4
 - Minor syntax issues highlighted by flake8
 
 ## [1.1.0] - 2019-05-05
-## Updated
+### Updated
 - Falcon 2.0.0 (@alanorth)
 
 ## [1.0.0] - 2019-04-15
@@ -90,7 +123,7 @@ and gunicorn 20.0.4
 ## [0.9.0] - 2019-01-22
 ### Updated
 - pytest version 4.0.0
-- Fix indexing of sharded statistics cores ([#10))
+- Fix indexing of sharded statistics cores (#10)
 - Handle case of missing views/downloads gracefully
 
 ## [0.8.1] - 2018-11-14

README.md

@@ -1,8 +1,16 @@
-# DSpace Statistics API [![Build Status](https://ci.mjanja.ch/api/badges/alanorth/dspace-statistics-api/status.svg?ref=refs/heads/v6_x)](https://ci.mjanja.ch/alanorth/dspace-statistics-api) [![builds.sr.ht status](https://builds.sr.ht/~alanorth/dspace-statistics-api.svg)](https://builds.sr.ht/~alanorth/dspace-statistics-api?)
+<h1 align="center">DSpace Statistics API</h1>
+
+<p align="center">
+<a href="https://ci.mjanja.ch/alanorth/dspace-statistics-api"><img alt="Build Status" src="https://ci.mjanja.ch/api/badges/alanorth/dspace-statistics-api/status.svg?ref=refs/heads/v6_x"></a>
+<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).
 
@@ -12,7 +20,7 @@ If you use the DSpace Statistics API please cite:
 
 ## Requirements
 
-- Python 3.6+
+- 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)
 
@@ -119,7 +127,6 @@ The id is the *internal* UUID for an item, community, or collection. You can get
 - Use JSON in PostgreSQL
 - Add top items endpoint, perhaps `/top/items` or `/items/top`?
   - Actually we could add `/items?limit=10&sort=views`
-- Add Swagger with OpenAPI 3.0.x with [falcon-swagger-ui](https://github.com/rdidyk/falcon-swagger-ui)
 
 ## License
 This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).

dspace_statistics_api/app.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
 import json
 import math
 
@@ -29,7 +31,7 @@ class RootResource:
             "</html"
         )
 
-        resp.body = docs_html
+        resp.text = docs_html
 
 
 class StatusResource:
@@ -61,7 +63,7 @@ class OpenAPIJSONResource:
             # Set the version in the schema so Swagger UI can display it
             data["info"]["version"] = VERSION
 
-            resp.body = json.dumps(data)
+            resp.text = json.dumps(data)
 
 
 class AllStatisticsResource:
@@ -88,7 +90,7 @@ class AllStatisticsResource:
                 )
 
                 # create a list to hold dicts of stats
-                statistics = list()
+                statistics = []
 
                 # iterate over results and build statistics object
                 for result in cursor:
@@ -160,7 +162,7 @@ class AllStatisticsResource:
         )
 
         # create a list to hold dicts of stats
-        statistics = list()
+        statistics = []
 
         # iterate over views dict to extract views and use the element id as an
         # index to the downloads dict to extract downloads.
@@ -213,24 +215,24 @@ class SingleStatisticsResource:
                     resp.media = statistics
 
 
-api = application = falcon.API()
-api.add_route("/", RootResource())
-api.add_route("/status", StatusResource())
+app = application = falcon.App()
+app.add_route("/", RootResource())
+app.add_route("/status", StatusResource())
 
 # Item routes
-api.add_route("/items", AllStatisticsResource())
-api.add_route("/item/{id_:uuid}", SingleStatisticsResource())
+app.add_route("/items", AllStatisticsResource())
+app.add_route("/item/{id_:uuid}", SingleStatisticsResource())
 
 # Community routes
-api.add_route("/communities", AllStatisticsResource())
-api.add_route("/community/{id_:uuid}", SingleStatisticsResource())
+app.add_route("/communities", AllStatisticsResource())
+app.add_route("/community/{id_:uuid}", SingleStatisticsResource())
 
 # Collection routes
-api.add_route("/collections", AllStatisticsResource())
-api.add_route("/collection/{id_:uuid}", SingleStatisticsResource())
+app.add_route("/collections", AllStatisticsResource())
+app.add_route("/collection/{id_:uuid}", SingleStatisticsResource())
 
-# Route to the Swagger UI OpenAPI schema
-api.add_route("/docs/openapi.json", OpenAPIJSONResource())
+# 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
@@ -240,12 +242,12 @@ 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 api_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(
-    api,
+    app,
     SWAGGERUI_PATH,
     SWAGGERUI_API_URL,
     config={

dspace_statistics_api/config.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
 import os
 
 # Check if Solr connection information was provided in the environment
@@ -16,6 +18,6 @@ DATABASE_PORT = os.environ.get("DATABASE_PORT", "5432")
 # the vanilla DSpace REST API.
 DSPACE_STATISTICS_API_URL = os.environ.get("DSPACE_STATISTICS_API_URL", "")
 
-VERSION = "1.4.0"
+VERSION = "1.4.4-dev"
 
 # vim: set sw=4 ts=4 expandtab:

dspace_statistics_api/database.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
 import falcon
 import psycopg2
 import psycopg2.extras

dspace_statistics_api/docs/openapi.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "1.4.0",
+    "version": "1.4.4-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": {
@@ -613,4 +613,4 @@
       }
     }
   }
-}
+}

dspace_statistics_api/indexer.py

@@ -1,23 +1,7 @@
+# SPDX-License-Identifier: GPL-3.0-only
 #
 # indexer.py
 #
-# Copyright 2018 Alan Orth.
-#
-# 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 <http://www.gnu.org/licenses/>.
-#
-# ---
-#
 # Connects to a DSpace Solr statistics core and ingests views and downloads for
 # communities, collections, and items into a PostgreSQL database.
 #
@@ -47,7 +31,7 @@ def index_views(indexType: str, facetField: str):
     #
     # see: https://lucene.apache.org/solr/guide/6_6/the-stats-component.html
     solr_query_params = {
-        "q": "type:2",
+        "q": f"type:2 AND {facetField}:/.{{36}}/",
         "fq": "-isBot:true AND statistics_type:view",
         "fl": facetField,
         "facet": "true",
@@ -94,7 +78,7 @@ def index_views(indexType: str, facetField: str):
                 )
 
                 solr_query_params = {
-                    "q": "type:2",
+                    "q": f"type:2 AND {facetField}:/.{{36}}/",
                     "fq": "-isBot:true AND statistics_type:view",
                     "fl": facetField,
                     "facet": "true",
@@ -130,7 +114,7 @@ def index_views(indexType: str, facetField: str):
 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": "type:0",
+        "q": f"type:0 AND {facetField}:/.{{36}}/",
         "fq": "-isBot:true AND statistics_type:view AND bundleName:ORIGINAL",
         "fl": facetField,
         "facet": "true",
@@ -176,7 +160,7 @@ def index_downloads(indexType: str, facetField: str):
                 )
 
                 solr_query_params = {
-                    "q": "type:0",
+                    "q": f"type:0 AND {facetField}:/.{{36}}/",
                     "fq": "-isBot:true AND statistics_type:view AND bundleName:ORIGINAL",
                     "fl": facetField,
                     "facet": "true",

dspace_statistics_api/stats.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
 import requests
 
 from .config import SOLR_SERVER

dspace_statistics_api/util.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-only
+
 import datetime
 import json
 import re
@@ -60,7 +62,6 @@ def get_statistics_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
@@ -139,7 +140,7 @@ def validate_post_parameters(req, resp, resource, params):
                 description=f'The "{req.context.statistics_scope}" parameter is invalid. The value must be a comma-separated list of UUIDs.',
             )
     else:
-        req.context.elements = list()
+        req.context.elements = []
 
 
 def set_statistics_scope(req, resp, resource, params):

pyproject.toml

@@ -1,25 +1,29 @@
 [tool.poetry]
 name = "dspace-statistics-api"
-version = "1.4.0"
+version = "1.4.4-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.6"
-gunicorn = "^20.0.4"
-falcon = "^2.0.0"
-psycopg2-binary = "^2.8.6"
+python = "^3.8.1"
+gunicorn = "^21.0.0"
+falcon = "3.1.3"
+psycopg2 = "^2.9.1"
 requests = "^2.24.0"
-falcon-swagger-ui = {git = "https://github.com/alanorth/falcon-swagger-ui.git"}
+falcon-swagger-ui = {git = "https://github.com/alanorth/falcon-swagger-ui.git", rev="falcon3-update-swagger-ui"}
 
-[tool.poetry.dev-dependencies]
-ipython = { version = "^7.18.1", python = "^3.7" }
-flake8 = "^3.8.4"
-pytest = "^6.1.1"
-isort = "^5.5.4"
-black = "^20.8b1"
+[tool.poetry.group.dev.dependencies]
+black = "^23.0.0"
+fixit = "^2.1.0"
+flake8 = "^7.0.0"
+isort = "^5.9.1"
+pytest = "^7.0.0"
 
 [build-system]
 requires = ["poetry>=0.12"]
 build-backend = "poetry.masonry.api"
+
+[tool.isort]
+profile = "black"
+line_length=88

renovate.json

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

requirements-dev.txt

@@ -1,51 +1,33 @@
-appdirs==1.4.4
-appnope==0.1.2; python_version >= "3.7" and python_version < "4.0" and sys_platform == "darwin"
-atomicwrites==1.4.0; sys_platform == "win32"
-attrs==20.3.0
-backcall==0.2.0; python_version >= "3.7" and python_version < "4.0"
-black==20.8b1
-certifi==2020.12.5
-chardet==4.0.0
-click==7.1.2
-colorama==0.4.4; python_version >= "3.7" and python_version < "4.0" and sys_platform == "win32" or sys_platform == "win32"
-dataclasses==0.6; python_version < "3.7"
-decorator==4.4.2; python_version >= "3.7" and python_version < "4.0"
-falcon==2.0.0
--e git+https://github.com/alanorth/falcon-swagger-ui.git@a44244c85dceccfcd249b62fea4ee82a8221e3d2#egg=falcon-swagger-ui
-flake8==3.8.4
-gunicorn==20.0.4
-idna==2.10
-importlib-metadata==3.3.0; python_version < "3.8"
-iniconfig==1.1.1
-ipython==7.19.0; python_version >= "3.7" and python_version < "4.0"
-ipython-genutils==0.2.0; python_version >= "3.7" and python_version < "4.0"
-isort==5.6.4
-jedi==0.17.2; python_version >= "3.7" and python_version < "4.0"
-jinja2==2.11.2
-markupsafe==1.1.1
-mccabe==0.6.1
-mypy-extensions==0.4.3
-packaging==20.8
-parso==0.7.1; python_version >= "3.7" and python_version < "4.0"
-pathspec==0.8.1
-pexpect==4.8.0; python_version >= "3.7" and python_version < "4.0" and sys_platform != "win32"
-pickleshare==0.7.5; python_version >= "3.7" and python_version < "4.0"
-pluggy==0.13.1
-prompt-toolkit==3.0.8; python_version >= "3.7" and python_version < "4.0"
-psycopg2-binary==2.8.6
-ptyprocess==0.6.0; python_version >= "3.7" and python_version < "4.0" and sys_platform != "win32"
-py==1.10.0
-pycodestyle==2.6.0
-pyflakes==2.2.0
-pygments==2.7.3; python_version >= "3.7" and python_version < "4.0"
-pyparsing==2.4.7
-pytest==6.2.1
-regex==2020.11.13
-requests==2.25.1
-toml==0.10.2
-traitlets==5.0.5; python_version >= "3.7" and python_version < "4.0"
-typed-ast==1.4.1
-typing-extensions==3.7.4.3
-urllib3==1.26.2
-wcwidth==0.2.5; python_version >= "3.7" and python_version < "4.0"
-zipp==3.4.0; python_version < "3.8"
+atomicwrites==1.4.1 ; python_version >= "3.8" and python_version < "4.0" and sys_platform == "win32"
+attrs==23.1.0 ; python_version >= "3.8" and python_version < "4.0"
+black==22.12.0 ; python_version >= "3.8" and python_version < "4.0"
+certifi==2023.5.7 ; python_version >= "3.8" and python_version < "4.0"
+charset-normalizer==3.1.0 ; python_version >= "3.8" and python_version < "4.0"
+click==8.1.3 ; python_version >= "3.8" and python_version < "4.0"
+colorama==0.4.6 ; python_version >= "3.8" and python_version < "4.0" and (sys_platform == "win32" or platform_system == "Windows")
+falcon-swagger-ui @ git+https://github.com/alanorth/falcon-swagger-ui.git@falcon3-update-swagger-ui ; python_version >= "3.8" and python_version < "4.0"
+falcon==3.1.1 ; python_version >= "3.8" and python_version < "4.0"
+flake8==4.0.1 ; python_version >= "3.8" and python_version < "4.0"
+gunicorn==20.1.0 ; python_version >= "3.8" and python_version < "4.0"
+idna==3.4 ; python_version >= "3.8" and python_version < "4.0"
+iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "4.0"
+isort==5.12.0 ; python_version >= "3.8" and python_version < "4.0"
+jinja2==3.1.2 ; python_version >= "3.8" and python_version < "4.0"
+markupsafe==2.1.2 ; python_version >= "3.8" and python_version < "4.0"
+mccabe==0.6.1 ; python_version >= "3.8" and python_version < "4.0"
+mypy-extensions==1.0.0 ; python_version >= "3.8" and python_version < "4.0"
+packaging==23.1 ; python_version >= "3.8" and python_version < "4.0"
+pathspec==0.11.1 ; python_version >= "3.8" and python_version < "4.0"
+platformdirs==3.5.1 ; python_version >= "3.8" and python_version < "4.0"
+pluggy==1.0.0 ; python_version >= "3.8" and python_version < "4.0"
+psycopg2==2.9.6 ; python_version >= "3.8" and python_version < "4.0"
+py==1.11.0 ; python_version >= "3.8" and python_version < "4.0"
+pycodestyle==2.8.0 ; python_version >= "3.8" and python_version < "4.0"
+pyflakes==2.4.0 ; python_version >= "3.8" and python_version < "4.0"
+pytest==6.2.5 ; python_version >= "3.8" and python_version < "4.0"
+requests==2.31.0 ; python_version >= "3.8" and python_version < "4.0"
+setuptools==67.8.0 ; python_version >= "3.8" and python_version < "4.0"
+toml==0.10.2 ; python_version >= "3.8" and python_version < "4.0"
+tomli==2.0.1 ; python_version >= "3.8" and python_full_version < "3.11.0a7"
+typing-extensions==4.6.2 ; python_version >= "3.8" and python_version < "3.10"
+urllib3==2.0.2 ; python_version >= "3.8" and python_version < "4.0"

requirements.txt

@@ -1,11 +1,12 @@
-certifi==2020.12.5
-chardet==4.0.0
-falcon==2.0.0
--e git+https://github.com/alanorth/falcon-swagger-ui.git@a44244c85dceccfcd249b62fea4ee82a8221e3d2#egg=falcon-swagger-ui
-gunicorn==20.0.4
-idna==2.10
-jinja2==2.11.2
-markupsafe==1.1.1
-psycopg2-binary==2.8.6
-requests==2.25.1
-urllib3==1.26.2
+certifi==2023.5.7 ; python_version >= "3.8" and python_version < "4.0"
+charset-normalizer==3.1.0 ; python_version >= "3.8" and python_version < "4.0"
+falcon-swagger-ui @ git+https://github.com/alanorth/falcon-swagger-ui.git@falcon3-update-swagger-ui ; python_version >= "3.8" and python_version < "4.0"
+falcon==3.1.1 ; python_version >= "3.8" and python_version < "4.0"
+gunicorn==20.1.0 ; python_version >= "3.8" and python_version < "4.0"
+idna==3.4 ; python_version >= "3.8" and python_version < "4.0"
+jinja2==3.1.2 ; python_version >= "3.8" and python_version < "4.0"
+markupsafe==2.1.2 ; python_version >= "3.8" and python_version < "4.0"
+psycopg2==2.9.6 ; python_version >= "3.8" and python_version < "4.0"
+requests==2.31.0 ; python_version >= "3.8" and python_version < "4.0"
+setuptools==67.8.0 ; python_version >= "3.8" and python_version < "4.0"
+urllib3==2.0.2 ; python_version >= "3.8" and python_version < "4.0"

setup.cfg

@@ -1,6 +0,0 @@
-[isort]
-multi_line_output=3
-include_trailing_comma=True
-force_grid_wrap=0
-use_parentheses=True
-line_length=88

tests/test_api_collections.py

@@ -1,14 +1,17 @@
-from falcon import testing
+# SPDX-License-Identifier: GPL-3.0-only
+
 import json
-import pytest
 from unittest.mock import patch
 
-from dspace_statistics_api.app import api
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
 
 
 @pytest.fixture
 def client():
-    return testing.TestClient(api)
+    return testing.TestClient(app)
 
 
 def test_get_collection(client):
@@ -309,7 +312,7 @@ def test_post_collections_valid_page(client):
     assert response.status_code == 200
     assert response.json["limit"] == 100
     assert response.json["currentPage"] == 0
-    assert response.json["totalPages"] == 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)

tests/test_api_communities.py

@@ -1,14 +1,17 @@
-from falcon import testing
+# SPDX-License-Identifier: GPL-3.0-only
+
 import json
-import pytest
 from unittest.mock import patch
 
-from dspace_statistics_api.app import api
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
 
 
 @pytest.fixture
 def client():
-    return testing.TestClient(api)
+    return testing.TestClient(app)
 
 
 def test_get_community(client):
@@ -309,7 +312,7 @@ def test_post_communities_valid_page(client):
     assert response.status_code == 200
     assert response.json["limit"] == 100
     assert response.json["currentPage"] == 0
-    assert response.json["totalPages"] == 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)

tests/test_api_docs.py

@@ -1,12 +1,14 @@
-from falcon import testing
-import pytest
+# SPDX-License-Identifier: GPL-3.0-only
 
-from dspace_statistics_api.app import api
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
 
 
 @pytest.fixture
 def client():
-    return testing.TestClient(api)
+    return testing.TestClient(app)
 
 
 def test_get_docs(client):

tests/test_api_items.py

@@ -1,14 +1,17 @@
-from falcon import testing
+# SPDX-License-Identifier: GPL-3.0-only
+
 import json
-import pytest
 from unittest.mock import patch
 
-from dspace_statistics_api.app import api
+import pytest
+from falcon import testing
+
+from dspace_statistics_api.app import app
 
 
 @pytest.fixture
 def client():
-    return testing.TestClient(api)
+    return testing.TestClient(app)
 
 
 def test_get_item(client):
@@ -309,7 +312,7 @@ def test_post_items_valid_page(client):
     assert response.status_code == 200
     assert response.json["limit"] == 100
     assert response.json["currentPage"] == 0
-    assert response.json["totalPages"] == 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)