feat(backend): implement a claim system

This allows to get a token once for each project.
This token can then be used for operations which
require more permissions like overriding stuff
or deleting files/tags.

Author: fliiiix

Diff for: README.md

@@ -17,6 +17,7 @@ docker run \
   --detach \
   --volume /path/to/doc:/var/docat/doc/ \
   --volume /path/to/locations:/etc/nginx/locations.d/ \
+  --volume /path/to/db.json:/app/docat/db.json
   --publish 8000:80 \
   randombenj/docat
 ```

Diff for: docat/.gitignore

@@ -4,3 +4,4 @@ __pycache__
 upload
 .tox
 .coverage
+db.json

Diff for: docat/app.py

@@ -9,17 +9,20 @@
 """
 
 import os
+import secrets
 from http import HTTPStatus
 from pathlib import Path
 
 from flask import Flask, request, send_from_directory
+from tinydb import Query, TinyDB
 from werkzeug.utils import secure_filename
 
 from docat.docat.utils import create_nginx_config, create_symlink, extract_archive
 
 app = Flask(__name__)
 app.config["UPLOAD_FOLDER"] = os.getenv("DOCAT_DOC_PATH", "/var/docat/doc")
 app.config["MAX_CONTENT_LENGTH"] = 100 * 1024 * 1024  # 100M
+app.db = TinyDB('db.json')
 
 
 @app.route("/api/<project>/<version>", methods=["POST"])
@@ -63,6 +66,22 @@ def tag(project, version, new_tag):
             HTTPStatus.CONFLICT,
         )
 
+@app.route("/api/<project>/claim", methods=["GET"])
+def claim(project):
+    Project = Query()
+    table = app.db.table('claims')
+    result = table.search(Project.name == project)
+    if result:
+        return (
+            {"message": f"Project {project} is already claimed!"},
+            HTTPStatus.CONFLICT,
+        )
+
+    token = secrets.token_hex(16)  
+    table.insert({"name": project, "token": token})
+    return {"message": f"Project {project} successfully claimed", "token": token}, HTTPStatus.CREATED
+
+
 
 # serve_local_docs for local testing without a nginx
 if os.environ.get("DOCAT_SERVE_FILES"):

Diff for: docat/poetry.lock

@@ -8,6 +8,7 @@ license = "MIT"
 [tool.poetry.dependencies]
 python = ">=3.6"
 flask = "*"
+tinydb = "*"
 
 [tool.poetry.dev-dependencies]
 flake8 = "*"

Diff for: docat/pyproject.toml

@@ -0,0 +1,14 @@
+import pytest
+from tinydb import TinyDB
+from tinydb.storages import MemoryStorage
+
+from app import app
+
+
+@pytest.fixture
+def client():
+    app.config["TESTING"] = True
+    app.db = TinyDB(storage=MemoryStorage)
+    yield app.test_client()
+    app.db = None
+

Diff for: docat/tests/__init__.py

@@ -0,0 +1,12 @@
+def test_successfully_claim_token(client):
+
+    rv = client.get("/api/some-project/claim")
+    assert b"Project some-project successfully claimed" in rv.data
+    assert b"token" in rv.data
+
+
+def test_already_claimed(client):
+
+    rv = client.get("/api/some-project/claim")
+    rv = client.get("/api/some-project/claim")
+    assert b"Project some-project is already claimed!" in rv.data

Diff for: docat/tests/conftest.py

@@ -2,7 +2,7 @@
 
 from mock import MagicMock, mock_open, patch
 
-from docat.utils import create_nginx_config, create_symlink, extract_archive
+from docat.docat.utils import create_nginx_config, create_symlink, extract_archive
 
 
 def test_symlink_creation():
@@ -90,7 +90,7 @@ def test_not_overwrite_nginx_config():
 def test_archive_artifact():
     target_file = Path("/some/zipfile.zip")
     destination = "/tmp/null"
-    with patch.object(Path, "unlink") as mock_unlink, patch("docat.utils.ZipFile") as mock_zip:
+    with patch.object(Path, "unlink") as mock_unlink, patch("docat.docat.utils.ZipFile") as mock_zip:
         mock_zip_open = MagicMock()
         mock_zip.return_value.__enter__.return_value.extractall = mock_zip_open