Moved torrent diffing logic to ChangeMap

.dockerignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# temporary
+.tmp/

.env.sample

@@ -1,9 +1,9 @@
 # qBittorrent
-QBIT_HOST="localhost"
+QBIT_HOST=localhost
-QBIT_PORT="8080"
+QBIT_PORT=8080
-QBIT_USERNAME="admin"
+QBIT_USERNAME=admin
-QBIT_PASSWORD="adminadmin"
+QBIT_PASSWORD=adminadmin
 
 # Mounts
 # Prefix of the location where we mount our downloads folder
-MNT_PREFIX=".tmp"
+MNT_PREFIX=.tmp

Dockerfile

@@ -0,0 +1,8 @@
+FROM python:3.10.7-alpine
+ADD . /app
+WORKDIR /app
+
+RUN pip install -r requirements.txt
+RUN pip install -e .
+
+CMD [ "python", "qbit_ci" ]

README.md

@@ -19,7 +19,12 @@ steps:
 ```
 
 ## Usage
+Python:
 ```py
+# Copy and update settings
+cp .env.sample .env
+nano .env
+
 # Install requirements
 pip install -r requirements.txt
 pip install -e .
@@ -30,3 +35,19 @@ nano .qbit-ci.yaml
 # Start the app
 python qbit_ci
 ```
+
+Docker:
+```sh
+# Copy and update settings
+cp .env.sample .env
+nano .env
+
+# Create a qbit-ci config file
+nano .qbit-ci.yaml
+
+# Run qbit-ci
+docker run \
+  --env-file .env \
+  --mount type=bind,source=$(pwd)/.qbit-ci.yaml,target=/app/.qbit-ci.yaml \
+  git.cesium.pw/niku/qbit-ci:latest
+```

examples/webhook.qbit-ci.yaml

@@ -8,7 +8,7 @@ steps:
         curl
           -H "Content-Type: application/json"
           -d '{"username": "cute anime girl", "content": "{{ torrent.name }} complete"}'
-          https://discord.com/api/webhooks/1026143262668488895/IxsxPMIu-02sFMMUzakPeQwEqKRIJOzct27oOnXB2DrpDBwBAmbjSo9jklN-UsOUn-GH
+          <webhook_url>
     when:
-      - '{{ changes.completion_on not in [None, -1] }}'
+      - '{{ changes.state == "uploading" }}'
-      - '{{ torrent.state == "uploading" }}'
+      - '{{ torrent.category == "" }}'

qbit_ci/change_map.py

@@ -1,5 +1,9 @@
 import typing
 
+import qbittorrentapi
+
+Torrent = qbittorrentapi.TorrentDictionary
+
 class ChangeMap:
     def __init__(self, changes: typing.Dict[typing.Any, typing.Any]) -> None:
         self._changes: typing.Dict[typing.Any, typing.Any] = changes
@@ -7,4 +11,18 @@ class ChangeMap:
     def __getattr__(self, __name: str) -> typing.Any:
         return self._changes.get(__name)
 
+    @staticmethod
+    def diff_torrents(torrent: typing.Optional[Torrent] = None, other_torrent: typing.Optional[Torrent] = None) -> "ChangeMap":
+        changes: typing.Any = []
+
+        if not torrent and other_torrent:
+            changes = other_torrent.items()
+        elif torrent and not other_torrent:
+            changes = torrent.items()
+        elif torrent and other_torrent:
+            changes = torrent.items() ^ other_torrent.items()
+
+        return ChangeMap({k: v for k, v in changes})
+
+
 __all__ = ("ChangeMap",)

qbit_ci/torrent_dict.py

@@ -10,13 +10,7 @@ class TorrentStateStore:
     def update(self, torrent: TorrentDictionary) -> ChangeMap:
         torrent_name: str = torrent.hash
         old_torrent: typing.Optional[TorrentDictionary] = self._torrents.get(torrent_name)
-        changes: typing.Any
+        change_map = ChangeMap.diff_torrents(torrent, old_torrent)
-        if old_torrent:
-            changes = old_torrent.items() ^ torrent.items()
-        else:
-            changes = torrent.items()
-
-        change_map = ChangeMap({k: v for k, v in changes})
         self._torrents[torrent_name] = torrent
         return change_map