Skip to content

Speakr is a personal, self-hosted web application designed for transcribing audio recordings

Python

Add upload recording related tests

Lumen Yang39ba09329f8f
diff --git a/docs/user-guide/api-reference.md b/docs/user-guide/api-reference.md
index 71818f66..682a9169 100644
--- a/docs/user-guide/api-reference.md
+++ b/docs/user-guide/api-reference.md
@@ -130,6 +130,55 @@ GET /api/v1/stats
## Recordings
+### Upload Recording
+
+```http
+POST /api/v1/recordings/upload
+```
+
+Upload a recording as multipart form-data and immediately queue transcription.
+
+**Form Fields:**
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `file` | file | yes | Audio file to upload |
+| `notes` | string | no | Optional notes |
+| `file_last_modified` | string | no | Client file lastModified (ms epoch) |
+| `language` | string | no | Language hint (ISO 639-1) |
+| `min_speakers` | integer | no | Min speaker count |
+| `max_speakers` | integer | no | Max speaker count |
+| `tag_ids[0]`, `tag_ids[1]`, ... | integer | no | Tag IDs (multi) |
+| `tag_id` | integer | no | Single tag ID (legacy) |
+
+**Response:**
+
+```json
+// 202 Accepted
+{
+ "id": 123,
+ "title": "Recording - meeting.mp3",
+ "status": "PENDING",
+ "created_at": "2024-01-15T10:00:00Z",
+ "meeting_date": "2024-01-15T09:00:00Z",
+ "file_size": 15728640,
+ "original_filename": "meeting.mp3",
+ "mime_type": "audio/mpeg",
+ "notes": "Quick test upload"
+}
+```
+
+**Example:**
+
+```bash
+curl -X POST \
+ -H "X-API-Token: YOUR_TOKEN" \
+ -F "file=@/path/to/audio.mp3" \
+ -F "notes=Quick test upload" \
+ -F "language=en" \
+ https://speakr.example.com/api/v1/recordings/upload
+```
+
### List Recordings
```http
diff --git a/tests/test_api_v1_upload.py b/tests/test_api_v1_upload.py
new file mode 100644
index 00000000..d0037808
--- /dev/null
+++ b/tests/test_api_v1_upload.py
@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+"""
+Integration test for API v1 recording upload endpoint.
+
+Validates API token authentication and expected 400 response when no file is provided.
+"""
+
+import secrets
+import sys
+import os
+
+# Add the parent directory to the path to import app
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+from src.app import app, db
+from src.models import User, APIToken
+from src.utils.token_auth import hash_token
+
+
+def _get_or_create_test_user():
+ user = User.query.filter_by(username="api_test_user").first()
+ created = False
+ if not user:
+ user = User(username="api_test_user", email="[email protected]")
+ db.session.add(user)
+ db.session.commit()
+ created = True
+ return user, created
+
+
+def _create_api_token(user):
+ plaintext = f"test-token-{secrets.token_urlsafe(16)}"
+ token = APIToken(
+ user_id=user.id,
+ token_hash=hash_token(plaintext),
+ name="test-api-token"
+ )
+ db.session.add(token)
+ db.session.commit()
+ return token, plaintext
+
+
+def test_upload_requires_file():
+ with app.app_context():
+ user, created_user = _get_or_create_test_user()
+ token_record, token = _create_api_token(user)
+ client = app.test_client()
+
+ try:
+ response = client.post(
+ "/api/v1/recordings/upload",
+ headers={"X-API-Token": token}
+ )
+
+ if response.status_code != 400:
+ print(f"❌ Expected 400, got {response.status_code}")
+ return False
+
+ payload = response.get_json(silent=True) or {}
+ if payload.get("error") != "No file provided":
+ print(f"❌ Unexpected error payload: {payload}")
+ return False
+
+ print("✅ Token auth works and missing file returns 400 as expected")
+ return True
+ finally:
+ db.session.delete(token_record)
+ db.session.commit()
+ if created_user:
+ db.session.delete(user)
+ db.session.commit()
+
+
+def main():
+ print("🚀 Running API v1 upload test...\n")
+ ok = test_upload_requires_file()
+ print("\n" + ("✅ PASS" if ok else "❌ FAIL"))
+ sys.exit(0 if ok else 1)
+
+
+if __name__ == "__main__":
+ main()