Add support for 2.10.5 (#23)

- Add new elements to API response elements, per 2.10.5 Tautulli update: https://github.com/Tautulli/Tautulli/releases/tag/v2.10.5
- Update server version support calculation
- Test multiple server versions, multiple Python versions in CI

.github/workflows/tests.yml

@@ -6,74 +6,53 @@ on:
   pull_request: ~
 
 jobs:
-  unit-tests:
+  versions:
     runs-on: ubuntu-latest
-    services:
-      tautulli-docker:
-        image: tautulli/tautulli
-        ports:
-           - 8001:8181
-
+    outputs:
+      server_versions: ${{ steps.set-server-versions.outputs.server_versions }}
+      python_versions: ${{ steps.set-python-versions.outputs.python_versions }}
     steps:
-    - name: Sleep for 30 seconds
-      uses: jakejarvis/wait-action@master
-      with:
-        time: '30s'
-
-    - name: Checkout code
-      uses: actions/checkout@v2
-
-    - name: Make envfile
-      uses: SpicyPizza/create-envfile@v1
-      with:
-        envkey_T_URL: http://localhost:8001
-        file_name: .env
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.10"
-
-    - name: Install Python dependencies
-      run: |
-        python3 -m pip install --upgrade pip
-        make install
+      - uses: actions/checkout@v2
+      - id: set-server-versions
+        run: echo "::set-output name=server_versions::$(cat tautulli/API_VERSIONS | jq -R -s -c 'split("\n")')"
+      - id: set-python-versions
+        run: echo "::set-output name=python_versions::$(cat tautulli/PYTHON_VERSIONS | jq -R -s -c 'split("\n")')"
 
-    - name: Test with pytest
-      run: make test
-
-  compatibility:
+  unit-tests:
+    needs: versions
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        image_version: ${{ fromJson(needs.versions.outputs.server_versions) }}
+        python_version: ${{ fromJson(needs.versions.outputs.python_versions) }}
     services:
       tautulli-docker:
-        image: tautulli/tautulli
+        image: tautulli/tautulli:v${{ matrix.image_version }}
         ports:
           - 8001:8181
-
     steps:
+      - name: Matrix => (${{ matrix.image_version }} ${{ matrix.python_version}})
+        run: |
+          echo ${{ matrix.image_version }}
+          echo ${{ matrix.python_version }}
       - name: Sleep for 30 seconds
         uses: jakejarvis/wait-action@master
         with:
           time: '30s'
-
       - name: Checkout code
         uses: actions/checkout@v2
-
       - name: Make envfile
         uses: SpicyPizza/create-envfile@v1
         with:
           envkey_T_URL: http://localhost:8001
           file_name: .env
-
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: "3.10"
-
+          python-version: ${{ matrix.python_version }}
       - name: Install Python dependencies
         run: |
           python3 -m pip install --upgrade pip
           make install
-
-      - name: Test compatibility with tox
-        run: make test-compatibility
+      - name: Test with pytest
+        run: make test

Makefile

@@ -46,6 +46,17 @@ install:
 install-pypy:
 	$(PYTHON_BINARY) -m venv $(VIRTUAL_ENV)
 	$(VIRTUAL_BIN)/pip install -e ."[pypy_dev]"
+
+## install-pyenv - Install pyenv
+install-pyenv:
+	curl https://pyenv.run | bash
+
+## change-python - Change the python version used by pyenv
+# params:
+# py-= The python version to use
+change-python:
+	pyenv local $(py)
+
 ## isort - Sorts imports throughout the project
 isort:
 	$(VIRTUAL_BIN)/isort $(PROJECT_NAME)/ $(TEST_DIR)/
@@ -66,10 +77,4 @@ mypy:
 test:
 	$(VIRTUAL_BIN)/pytest --exitfirst --verbose --failed-first
 
-## test-compatibility - Test the project against multiple Python versions
-test-compatibility:
-	pyenv local 3.7.15 3.8.15 3.9.15 3.10.8 3.11.0 # install Python versions
-	$(VIRTUAL_BIN)/pip install tox
-	$(VIRTUAL_BIN)/tox
-
-.PHONY: help build coverage clean black black-check format format-check install isort isort-check lint mypy test test-compatibility
+.PHONY: help build coverage clean black black-check format format-check install install-pypy install-pyenv change-python isort isort-check lint mypy test

setup.py

@@ -15,6 +15,24 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
+
+def python_versions():
+    """Return a list of supported Python versions."""
+    with open("tautulli/PYTHON_VERSIONS") as f:
+        versions = f.read().splitlines()
+    version_strings = ['Programming Language :: Python :: 3']
+    for version in versions:
+        version_strings.append(f"Programming Language :: Python :: {version}")
+    return version_strings
+
+
+def python3_range():
+    """Return a string of the supported Python version range."""
+    with open("tautulli/PYTHON_VERSIONS") as f:
+        versions = f.read().splitlines()
+    return f">={versions[0]}, <4"
+
+
 REQUIREMENTS = [
     "objectrest==2.0.*",
     "pydantic==1.10.*",
@@ -36,6 +54,19 @@
     "vcrpy==4.*",
 ]
 
+classifiers = [
+    'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+    'Development Status :: 4 - Beta',
+    # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
+    'Intended Audience :: Developers',  # Define that your audience are developers
+    'Topic :: Software Development :: Build Tools',
+    'Topic :: Multimedia :: Video',
+    'Topic :: Multimedia',
+    'Topic :: Internet :: WWW/HTTP',
+    'Operating System :: OS Independent'
+]
+classifiers.extend(python_versions())
+
 setuptools.setup(
     name=__title__,
     packages=setuptools.find_packages(exclude=["tests"]),
@@ -54,22 +85,6 @@
         "dev": DEV_REQUIREMENTS,
     },
     test_suite="test",
-    classifiers=[
-        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
-        'Development Status :: 4 - Beta',
-        # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
-        'Intended Audience :: Developers',  # Define that your audience are developers
-        'Topic :: Software Development :: Build Tools',
-        'Programming Language :: Python :: 3',  # Specify which python versions that you want to support
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10',
-        'Programming Language :: Python :: 3.11',
-        'Topic :: Multimedia :: Video',
-        'Topic :: Multimedia',
-        'Topic :: Internet :: WWW/HTTP',
-        'Operating System :: OS Independent'
-    ],
-    python_requires='>=3.7, <4'
+    classifiers=classifiers,
+    python_requires=python3_range(),
 )

tautulli/API_VERSIONS

@@ -0,0 +1,3 @@
+2.10.3
+2.10.4
+2.10.5

tautulli/PYTHON_VERSIONS

@@ -0,0 +1,5 @@
+3.7
+3.8
+3.9
+3.10
+3.11

tautulli/_info.py

@@ -1 +1,11 @@
-__min_api_version__ = "2.10.3"
+import os
+from typing import List
+
+
+def __supported_api_versions__() -> List[str]:
+    with open(os.path.join(os.path.dirname(__file__), "API_VERSIONS")) as f:
+        return f.read().splitlines()
+
+
+def __min_api_version__() -> str:
+    return __supported_api_versions__()[0]

tautulli/api/json_api.py

@@ -26,8 +26,9 @@ def __init__(self, base_url: str, api_key: str, verbose: bool = False, verify: b
         self._session = objectrest.Session()
         logging.basicConfig(format='%(levelname)s:%(message)s', level=(logging.DEBUG if verbose else logging.ERROR))
         self._logger = logging.getLogger("tautulli")
-        if verify and not self._verify_compatibility(min_version=__min_api_version__):
-            warnings.warn(f"Tautulli API is older than {__min_api_version__}, things may not work as expected.")
+        min_api_version = __min_api_version__()
+        if verify and not self._verify_compatibility(min_version=min_api_version):
+            warnings.warn(f"Tautulli API is older than {min_api_version}, things may not work as expected.")
 
     def __str__(self):
         return f"RawAPI(url={self._redacted_url})"

tautulli/models/children_metadata.py

@@ -20,6 +20,7 @@ class ChildrenListItem(BaseModel):
     directors: Optional[List]
     duration: Optional[str]
     full_title: Optional[str]
+    collections: Optional[List]
     genres: Optional[List]
     grandparent_rating_key: Optional[str]
     grandparent_thumb: Optional[str]

tautulli/models/history.py

@@ -21,6 +21,7 @@ class Datum(BaseModel):
     user_id: Optional[int]
     user: Optional[str]
     friendly_name: Optional[str]
+    user_thumb: Optional[str]
     platform: Optional[str]
     product: Optional[str]
     player: Optional[str]

tautulli/models/metadata.py

@@ -86,6 +86,7 @@ class Data(BaseModel):
     grandparent_title: Optional[str]
     original_title: Optional[str]
     sort_title: Optional[str]
+    edition_title: Optional[str]
     media_index: Optional[str]
     parent_media_index: Optional[str]
     studio: Optional[str]