Archived
Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Marko (Hermes Implementer)
|
74fdae61db | ||
|
Marko (Hermes Implementer)
|
b29ea8211c | ||
|
Marko (Hermes Implementer)
|
3b5b301e42 |
@@ -1,72 +0,0 @@
|
|||||||
name: Backend CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main, develop]
|
|
||||||
paths:
|
|
||||||
- "backend/**"
|
|
||||||
- ".github/workflows/backend-ci.yml"
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "backend/**"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
services:
|
|
||||||
postgres:
|
|
||||||
image: postgres:16
|
|
||||||
env:
|
|
||||||
POSTGRES_DB: cloud_reader
|
|
||||||
POSTGRES_USER: cloud_reader
|
|
||||||
POSTGRES_PASSWORD: cloud_reader
|
|
||||||
ports:
|
|
||||||
- 5432:5432
|
|
||||||
options: >-
|
|
||||||
--health-cmd pg_isready
|
|
||||||
--health-interval 10s
|
|
||||||
--health-timeout 5s
|
|
||||||
--health-retries 5
|
|
||||||
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
working-directory: backend
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Python 3.12
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: "3.12"
|
|
||||||
cache: "pip"
|
|
||||||
cache-dependency-path: backend/requirements/dev.txt
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
python -m pip install --upgrade pip
|
|
||||||
pip install -r requirements/dev.txt
|
|
||||||
|
|
||||||
- name: Lint
|
|
||||||
run: ruff check .
|
|
||||||
|
|
||||||
- name: Run migrations
|
|
||||||
run: python manage.py migrate
|
|
||||||
env:
|
|
||||||
DB_HOST: localhost
|
|
||||||
DB_NAME: cloud_reader
|
|
||||||
DB_USER: cloud_reader
|
|
||||||
DB_PASSWORD: cloud_reader
|
|
||||||
DB_PORT: 5432
|
|
||||||
SECRET_KEY: ci-test-secret-key-do-not-use-in-production
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
run: pytest
|
|
||||||
env:
|
|
||||||
DB_HOST: localhost
|
|
||||||
DB_NAME: cloud_reader
|
|
||||||
DB_USER: cloud_reader
|
|
||||||
DB_PASSWORD: cloud_reader
|
|
||||||
DB_PORT: 5432
|
|
||||||
SECRET_KEY: ci-test-secret-key-do-not-use-in-production
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
name: Frontend CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main, develop]
|
|
||||||
paths:
|
|
||||||
- "frontend/**"
|
|
||||||
- "shared/**"
|
|
||||||
- ".github/workflows/frontend-ci.yml"
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "frontend/**"
|
|
||||||
- "shared/**"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Node.js 20
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: "20"
|
|
||||||
cache: "yarn"
|
|
||||||
cache-dependency-path: yarn.lock
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: yarn install --frozen-lockfile
|
|
||||||
|
|
||||||
- name: Type check shared
|
|
||||||
run: yarn workspace @cloud-reader/shared typecheck
|
|
||||||
|
|
||||||
- name: Build shared
|
|
||||||
run: yarn workspace @cloud-reader/shared build
|
|
||||||
|
|
||||||
- name: Type check frontend
|
|
||||||
run: yarn workspace @cloud-reader/frontend typecheck
|
|
||||||
|
|
||||||
- name: Build frontend
|
|
||||||
run: yarn workspace @cloud-reader/frontend build
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
name: Mobile CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main, develop]
|
|
||||||
paths:
|
|
||||||
- "mobile/**"
|
|
||||||
- "shared/**"
|
|
||||||
- ".github/workflows/mobile-ci.yml"
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "mobile/**"
|
|
||||||
- "shared/**"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Node.js 20
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: "20"
|
|
||||||
cache: "yarn"
|
|
||||||
cache-dependency-path: yarn.lock
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: yarn install --frozen-lockfile
|
|
||||||
|
|
||||||
- name: Type check shared
|
|
||||||
run: yarn workspace @cloud-reader/shared typecheck
|
|
||||||
|
|
||||||
- name: Build shared
|
|
||||||
run: yarn workspace @cloud-reader/shared build
|
|
||||||
|
|
||||||
- name: Type check mobile
|
|
||||||
run: yarn workspace @cloud-reader/mobile typecheck
|
|
||||||
-48
@@ -1,48 +0,0 @@
|
|||||||
# Python
|
|
||||||
__pycache__/
|
|
||||||
*.py[cod]
|
|
||||||
*.egg-info/
|
|
||||||
dist/
|
|
||||||
build/
|
|
||||||
.eggs/
|
|
||||||
*.egg
|
|
||||||
.env
|
|
||||||
venv/
|
|
||||||
.venv/
|
|
||||||
*.sqlite3
|
|
||||||
|
|
||||||
# Node
|
|
||||||
node_modules/
|
|
||||||
.pnp
|
|
||||||
.pnp.js
|
|
||||||
yarn-error.log*
|
|
||||||
|
|
||||||
# Build artifacts
|
|
||||||
dist/
|
|
||||||
build/
|
|
||||||
*.tsbuildinfo
|
|
||||||
|
|
||||||
# IDE
|
|
||||||
.vscode/
|
|
||||||
.idea/
|
|
||||||
*.swp
|
|
||||||
*.swo
|
|
||||||
.DS_Store
|
|
||||||
|
|
||||||
# Django
|
|
||||||
backend/media/
|
|
||||||
backend/staticfiles/
|
|
||||||
backend/**/migrations/
|
|
||||||
|
|
||||||
# Expo / React Native
|
|
||||||
mobile/.expo/
|
|
||||||
mobile/ios/Pods/
|
|
||||||
mobile/android/.gradle/
|
|
||||||
mobile/android/app/build/
|
|
||||||
mobile/android/build/
|
|
||||||
mobile/*.hprof
|
|
||||||
|
|
||||||
# Environment
|
|
||||||
.env.local
|
|
||||||
.env.production
|
|
||||||
.env.development
|
|
||||||
@@ -1,195 +1,38 @@
|
|||||||
# Cloud Reader
|
# Cloud Reader
|
||||||
|
|
||||||
A modern eBook reader with web and mobile clients, powered by Django REST Framework.
|
A full-stack cloud-based e-book reader application with cross-device synchronization.
|
||||||
|
|
||||||
## Monorepo Structure
|
## Architecture
|
||||||
|
|
||||||
```
|
- **Backend**: Django 5.x + Django REST Framework
|
||||||
cloud-reader/
|
- **Frontend**: React with TypeScript
|
||||||
├── backend/ # Django API server (Python 3.12 + DRF)
|
- **Database**: PostgreSQL
|
||||||
│ ├── config/ # Django project settings
|
- **Monorepo**: Yarn workspaces
|
||||||
│ ├── apps/ # Django applications
|
|
||||||
│ │ ├── accounts/ # User authentication & profiles
|
|
||||||
│ │ ├── documents/ # Document management & uploads
|
|
||||||
│ │ ├── collections/# Document collections
|
|
||||||
│ │ └── reading/ # Bookmarks, highlights, reading progress
|
|
||||||
│ ├── requirements/ # pip dependency files
|
|
||||||
│ ├── Dockerfile
|
|
||||||
│ └── manage.py
|
|
||||||
├── frontend/ # React web app (TypeScript + Vite)
|
|
||||||
│ ├── src/
|
|
||||||
│ │ ├── pages/ # Route pages (lazy-loaded)
|
|
||||||
│ │ ├── hooks/ # Custom React hooks
|
|
||||||
│ │ ├── services/ # API client & auth service
|
|
||||||
│ │ ├── types/ # Frontend-specific types
|
|
||||||
│ │ └── styles/ # Global CSS
|
|
||||||
│ ├── Dockerfile
|
|
||||||
│ └── vite.config.ts
|
|
||||||
├── mobile/ # Expo/React Native mobile app
|
|
||||||
│ ├── app/ # Expo Router pages
|
|
||||||
│ ├── src/ # Mobile source code
|
|
||||||
│ ├── app.json
|
|
||||||
│ └── Dockerfile
|
|
||||||
├── shared/ # Shared TypeScript types & utilities
|
|
||||||
│ └── src/
|
|
||||||
│ └── index.ts # API response types, constants
|
|
||||||
├── .github/workflows/ # CI/CD pipelines
|
|
||||||
└── package.json # Yarn workspace root
|
|
||||||
```
|
|
||||||
|
|
||||||
## Prerequisites
|
## Getting Started
|
||||||
|
|
||||||
- **Python** 3.12+
|
### Prerequisites
|
||||||
- **Node.js** 20 LTS
|
- Python 3.12+
|
||||||
- **Yarn** 4.x
|
- Node.js 20+
|
||||||
- **PostgreSQL** 16
|
- PostgreSQL 15+
|
||||||
- **Expo CLI** (for mobile development)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Backend Setup
|
|
||||||
|
|
||||||
|
### Backend Setup
|
||||||
```bash
|
```bash
|
||||||
cd backend
|
cd backend
|
||||||
|
|
||||||
# Create virtual environment
|
|
||||||
python -m venv .venv
|
python -m venv .venv
|
||||||
source .venv/bin/activate # Linux/macOS
|
source .venv/bin/activate
|
||||||
# .venv\Scripts\activate # Windows
|
pip install -r requirements.txt
|
||||||
|
|
||||||
# Install dependencies
|
|
||||||
pip install -r requirements/dev.txt
|
|
||||||
|
|
||||||
# Configure environment
|
|
||||||
cp .env.example .env
|
|
||||||
# Edit .env with your PostgreSQL credentials
|
|
||||||
|
|
||||||
# Run migrations
|
|
||||||
python manage.py migrate
|
python manage.py migrate
|
||||||
|
|
||||||
# Create admin user
|
|
||||||
python manage.py createsuperuser
|
|
||||||
|
|
||||||
# Start development server
|
|
||||||
python manage.py runserver
|
python manage.py runserver
|
||||||
```
|
```
|
||||||
|
|
||||||
The API will be available at `http://localhost:8000/`. Browse the API at `http://localhost:8000/api/schema/swagger-ui/`.
|
### Frontend Setup
|
||||||
|
|
||||||
### Backend Tests
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd backend
|
cd frontend
|
||||||
pytest
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Frontend Setup
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# From monorepo root
|
|
||||||
yarn install
|
yarn install
|
||||||
|
yarn dev
|
||||||
# Start dev server (with API proxy)
|
|
||||||
yarn frontend:dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The frontend will be available at `http://localhost:5173/`. API requests under `/api/` are proxied to `http://localhost:8000/`.
|
## Projects
|
||||||
|
|
||||||
### Frontend Build
|
See [Gitea Issues](https://gitea-dev.codescripters.org/crisleo-hermes/cloud-reader/issues) for the full roadmap.
|
||||||
|
|
||||||
```bash
|
|
||||||
yarn frontend:build
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Mobile Setup
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# From monorepo root
|
|
||||||
yarn install
|
|
||||||
|
|
||||||
# Start Expo dev server
|
|
||||||
yarn mobile:start
|
|
||||||
|
|
||||||
# Run on Android
|
|
||||||
yarn mobile:android
|
|
||||||
|
|
||||||
# Run on iOS (macOS only)
|
|
||||||
yarn mobile:ios
|
|
||||||
```
|
|
||||||
|
|
||||||
> The mobile API client defaults to `http://localhost:8000/`. For physical devices, update the `API_BASE` in `mobile/src/services/api.ts` to your machine's local IP.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Shared Package
|
|
||||||
|
|
||||||
The `shared/` package contains TypeScript types and constants used by both the frontend and mobile apps.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build shared package
|
|
||||||
yarn shared:build
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## CI/CD
|
|
||||||
|
|
||||||
Three independent CI pipelines run on pushes and PRs:
|
|
||||||
|
|
||||||
| Pipeline | Trigger Path | What It Does |
|
|
||||||
|----------|-------------|--------------|
|
|
||||||
| **Backend CI** | `backend/**` | Installs Python deps, runs Ruff linter, applies migrations, runs pytest |
|
|
||||||
| **Frontend CI** | `frontend/**`, `shared/**` | Installs Node deps, type-check & build shared, type-check & build frontend |
|
|
||||||
| **Mobile CI** | `mobile/**`, `shared/**` | Installs Node deps, type-check shared & mobile |
|
|
||||||
|
|
||||||
Pipeline configs are in `.github/workflows/`.
|
|
||||||
|
|
||||||
### Docker Deployments
|
|
||||||
|
|
||||||
Each app has its own Dockerfile for independent deployment:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build backend image
|
|
||||||
docker build -t cloud-reader-backend backend/
|
|
||||||
|
|
||||||
# Build frontend image
|
|
||||||
docker build -t cloud-reader-frontend frontend/
|
|
||||||
|
|
||||||
# Build mobile image (web export)
|
|
||||||
docker build -t cloud-reader-mobile mobile/
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## API Endpoints
|
|
||||||
|
|
||||||
| Endpoint | Description |
|
|
||||||
|----------|-------------|
|
|
||||||
| `POST /api/v1/auth/register/` | Create a new account |
|
|
||||||
| `POST /api/v1/auth/token/` | Obtain JWT tokens |
|
|
||||||
| `POST /api/v1/auth/token/refresh/` | Refresh JWT token |
|
|
||||||
| `GET /api/v1/auth/me/` | Get current user profile |
|
|
||||||
| `GET/POST /api/v1/documents/` | List / upload documents |
|
|
||||||
| `GET/PUT/DELETE /api/v1/documents/:id/` | Document detail |
|
|
||||||
| `GET/POST /api/v1/collections/` | List / create collections |
|
|
||||||
| `GET/PUT/DELETE /api/v1/collections/:id/` | Collection detail |
|
|
||||||
| `POST /api/v1/collections/:id/add_documents/` | Add docs to collection |
|
|
||||||
| `POST /api/v1/collections/:id/remove_documents/` | Remove docs from collection |
|
|
||||||
| `GET/POST /api/v1/reading/bookmarks/` | List / create bookmarks |
|
|
||||||
| `GET/POST /api/v1/reading/highlights/` | List / create highlights |
|
|
||||||
| `GET/POST /api/v1/reading/progress/` | Track reading progress |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tech Stack
|
|
||||||
|
|
||||||
- **Backend:** Django 5, Django REST Framework, SimpleJWT, PostgreSQL, drf-spectacular
|
|
||||||
- **Frontend:** React 18, TypeScript, Vite, React Router, Axios
|
|
||||||
- **Mobile:** Expo SDK 51, React Native 0.74, Expo Router
|
|
||||||
- **Shared:** TypeScript types, Zod schemas
|
|
||||||
- **CI/CD:** GitHub Actions
|
|
||||||
- **Container:** Docker (separate images per app)
|
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
FROM python:3.12-slim
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||||
|
libpq-dev gcc && \
|
||||||
|
rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
COPY pyproject.toml ./
|
||||||
|
RUN pip install uv && uv sync --frozen
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
RUN mkdir -p media
|
||||||
|
|
||||||
|
EXPOSE 8000
|
||||||
|
|
||||||
|
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
from django.contrib import admin
|
||||||
|
|
||||||
|
from books.models import Book, ReadingProgress, ReadingSettings
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(Book)
|
||||||
|
class BookAdmin(admin.ModelAdmin):
|
||||||
|
list_display = ["title", "author", "user", "created_at"]
|
||||||
|
list_filter = ["created_at", "user"]
|
||||||
|
search_fields = ["title", "author"]
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(ReadingProgress)
|
||||||
|
class ReadingProgressAdmin(admin.ModelAdmin):
|
||||||
|
list_display = ["book", "user", "current_position", "updated_at"]
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(ReadingSettings)
|
||||||
|
class ReadingSettingsAdmin(admin.ModelAdmin):
|
||||||
|
list_display = ["user", "font_size", "font_style", "background_color"]
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
from django.apps import AppConfig
|
||||||
|
|
||||||
|
|
||||||
|
class BooksConfig(AppConfig):
|
||||||
|
default_auto_field = "django.db.models.BigAutoField"
|
||||||
|
name = "books"
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# management/__init__.py
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# management/commands/__init__.py
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
"""
|
||||||
|
Management command to seed sample book data for development and testing.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from django.core.management.base import BaseCommand
|
||||||
|
|
||||||
|
from books.models import Book, ReadingStatus
|
||||||
|
|
||||||
|
SAMPLE_BOOKS: list[dict[str, Any]] = [
|
||||||
|
{
|
||||||
|
"title": "The Great Gatsby",
|
||||||
|
"author": "F. Scott Fitzgerald",
|
||||||
|
"genre": "Classic Literature",
|
||||||
|
"description": "A story of the mysteriously wealthy Jay Gatsby and his love for the beautiful Daisy Buchanan.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "To Kill a Mockingbird",
|
||||||
|
"author": "Harper Lee",
|
||||||
|
"genre": "Classic Literature",
|
||||||
|
"description": "The unforgettable novel of a childhood in a sleepy Southern town and the crisis of conscience that rocked it.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "1984",
|
||||||
|
"author": "George Orwell",
|
||||||
|
"genre": "Science Fiction",
|
||||||
|
"description": "A dystopian social science fiction novel and cautionary tale about the future of totalitarianism.",
|
||||||
|
"reading_status": ReadingStatus.READING,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Dune",
|
||||||
|
"author": "Frank Herbert",
|
||||||
|
"genre": "Science Fiction",
|
||||||
|
"description": "Set on the desert planet Arrakis, it is one of the world's best-selling science fiction novels.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Hobbit",
|
||||||
|
"author": "J.R.R. Tolkien",
|
||||||
|
"genre": "Fantasy",
|
||||||
|
"description": "Bilbo Baggins is swept into a quest to reclaim the lost Dwarf Kingdom of Erebor from the fearsome dragon Smaug.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Pride and Prejudice",
|
||||||
|
"author": "Jane Austen",
|
||||||
|
"genre": "Romance",
|
||||||
|
"description": "A romantic novel of manners that follows the character development of Elizabeth Bennet.",
|
||||||
|
"reading_status": ReadingStatus.WANT_TO_READ,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Martian",
|
||||||
|
"author": "Andy Weir",
|
||||||
|
"genre": "Science Fiction",
|
||||||
|
"description": "An astronaut becomes stranded alone on Mars and must find a way to signal that he is alive.",
|
||||||
|
"reading_status": ReadingStatus.READING,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Catcher in the Rye",
|
||||||
|
"author": "J.D. Salinger",
|
||||||
|
"genre": "Classic Literature",
|
||||||
|
"description": "The story of Holden Caulfield's experiences in New York City after being expelled from prep school.",
|
||||||
|
"reading_status": ReadingStatus.DNF,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Alchemist",
|
||||||
|
"author": "Paulo Coelho",
|
||||||
|
"genre": "Philosophy",
|
||||||
|
"description": "A young Andalusian shepherd follows his dream to find treasure at the Egyptian pyramids.",
|
||||||
|
"reading_status": ReadingStatus.WANT_TO_READ,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Neuromancer",
|
||||||
|
"author": "William Gibson",
|
||||||
|
"genre": "Science Fiction",
|
||||||
|
"description": "The novel that launched the cyberpunk genre, following washed-up computer hacker Henry Case.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Name of the Wind",
|
||||||
|
"author": "Patrick Rothfuss",
|
||||||
|
"genre": "Fantasy",
|
||||||
|
"description": "The tale of the magically gifted young man who grows to be the most notorious wizard his world has ever seen.",
|
||||||
|
"reading_status": ReadingStatus.READING,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Gone Girl",
|
||||||
|
"author": "Gillian Flynn",
|
||||||
|
"genre": "Thriller",
|
||||||
|
"description": "A mystery thriller about a wife's disappearance on the day of her fifth wedding anniversary.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Sapiens",
|
||||||
|
"author": "Yuval Noah Harari",
|
||||||
|
"genre": "Non-Fiction",
|
||||||
|
"description": "A brief history of humankind, exploring how biology and history have defined us.",
|
||||||
|
"reading_status": ReadingStatus.FINISHED,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Road",
|
||||||
|
"author": "Cormac McCarthy",
|
||||||
|
"genre": "Post-Apocalyptic",
|
||||||
|
"description": "A father and his young son walk alone through burned America heading toward the coast.",
|
||||||
|
"reading_status": ReadingStatus.WANT_TO_READ,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "The Three-Body Problem",
|
||||||
|
"author": "Cixin Liu",
|
||||||
|
"genre": "Science Fiction",
|
||||||
|
"description": "The first novel in the Remembrance of Earth's Past trilogy, a blend of physics and alien contact.",
|
||||||
|
"reading_status": ReadingStatus.READING,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
class Command(BaseCommand):
|
||||||
|
"""Seed the database with sample books."""
|
||||||
|
|
||||||
|
help = "Seeds the database with sample books for development and testing."
|
||||||
|
|
||||||
|
def handle(self, *args: Any, **options: Any) -> str | None:
|
||||||
|
for i, book_data in enumerate(SAMPLE_BOOKS):
|
||||||
|
Book.objects.get_or_create(
|
||||||
|
title=book_data["title"],
|
||||||
|
author=book_data["author"],
|
||||||
|
defaults=book_data,
|
||||||
|
)
|
||||||
|
count = Book.objects.count()
|
||||||
|
self.stdout.write(self.style.SUCCESS(f"Seeded {count} books into the database."))
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
import django.db.models.deletion
|
||||||
|
from django.db import migrations, models
|
||||||
|
|
||||||
|
|
||||||
|
class Migration(migrations.Migration):
|
||||||
|
|
||||||
|
initial = True
|
||||||
|
|
||||||
|
dependencies: list = []
|
||||||
|
|
||||||
|
operations = [
|
||||||
|
migrations.CreateModel(
|
||||||
|
name="Book",
|
||||||
|
fields=[
|
||||||
|
(
|
||||||
|
"id",
|
||||||
|
models.BigAutoField(
|
||||||
|
auto_created=True,
|
||||||
|
primary_key=True,
|
||||||
|
serialize=False,
|
||||||
|
verbose_name="ID",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
("title", models.CharField(db_index=True, max_length=500)),
|
||||||
|
("author", models.CharField(db_index=True, max_length=300)),
|
||||||
|
("genre", models.CharField(db_index=True, max_length=100)),
|
||||||
|
("description", models.TextField(blank=True, default="")),
|
||||||
|
(
|
||||||
|
"reading_status",
|
||||||
|
models.CharField(
|
||||||
|
choices=[
|
||||||
|
("want_to_read", "Want to Read"),
|
||||||
|
("reading", "Reading"),
|
||||||
|
("finished", "Finished"),
|
||||||
|
("dnf", "Did Not Finish"),
|
||||||
|
],
|
||||||
|
db_index=True,
|
||||||
|
default="want_to_read",
|
||||||
|
max_length=20,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
("cover_url", models.URLField(blank=True, default="")),
|
||||||
|
("created_at", models.DateTimeField(auto_now_add=True)),
|
||||||
|
("updated_at", models.DateTimeField(auto_now=True)),
|
||||||
|
],
|
||||||
|
options={
|
||||||
|
"ordering": ["title"],
|
||||||
|
"indexes": [
|
||||||
|
models.Index(
|
||||||
|
fields=["title", "author", "genre"],
|
||||||
|
name="books_book_title_2cc25e_idx",
|
||||||
|
)
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
]
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# migrations/__init__.py
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
from enum import StrEnum
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from django.conf import settings
|
||||||
|
from django.core.validators import FileExtensionValidator
|
||||||
|
from django.db import models
|
||||||
|
from django.db.models.signals import post_delete
|
||||||
|
from django.dispatch import receiver
|
||||||
|
|
||||||
|
|
||||||
|
class FontStyle(StrEnum):
|
||||||
|
SANS_SERIF = "sans-serif"
|
||||||
|
SERIF = "serif"
|
||||||
|
MONOSPACE = "monospace"
|
||||||
|
|
||||||
|
|
||||||
|
class BackgroundColor(StrEnum):
|
||||||
|
WHITE = "#ffffff"
|
||||||
|
SEPIA = "#f4e4c1"
|
||||||
|
DARK = "#1a1a2e"
|
||||||
|
GREEN = "#c7edcc"
|
||||||
|
|
||||||
|
|
||||||
|
class Book(models.Model):
|
||||||
|
user = models.ForeignKey(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="books",
|
||||||
|
)
|
||||||
|
title = models.CharField(max_length=512)
|
||||||
|
author = models.CharField(max_length=256, blank=True, default="")
|
||||||
|
file = models.FileField(
|
||||||
|
upload_to="books/%Y/%m/%d/",
|
||||||
|
validators=[FileExtensionValidator(allowed_extensions=["epub", "pdf"])],
|
||||||
|
)
|
||||||
|
cover_image = models.ImageField(upload_to="covers/%Y/%m/%d/", blank=True, null=True)
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
ordering = ["-created_at"]
|
||||||
|
indexes = [
|
||||||
|
models.Index(fields=["user", "-created_at"]),
|
||||||
|
]
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return self.title
|
||||||
|
|
||||||
|
def filename(self) -> str:
|
||||||
|
return Path(self.file.name).name
|
||||||
|
|
||||||
|
|
||||||
|
@receiver(post_delete, sender=Book)
|
||||||
|
def _auto_delete_file_on_delete(sender: type[Book], instance: Book, **kwargs: object) -> None:
|
||||||
|
"""Delete the uploaded file when the Book record is deleted."""
|
||||||
|
if instance.file:
|
||||||
|
instance.file.delete(save=False)
|
||||||
|
if instance.cover_image:
|
||||||
|
instance.cover_image.delete(save=False)
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingProgress(models.Model):
|
||||||
|
user = models.ForeignKey(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="reading_progress",
|
||||||
|
)
|
||||||
|
book = models.OneToOneField(
|
||||||
|
Book,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="reading_progress",
|
||||||
|
)
|
||||||
|
current_position = models.FloatField(default=0.0)
|
||||||
|
"""Position in the book as a percentage (0.0 to 100.0)"""
|
||||||
|
last_page = models.IntegerField(default=0)
|
||||||
|
"""Last page/paragraph index for granular tracking"""
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
verbose_name_plural = "reading progress"
|
||||||
|
unique_together = [("user", "book")]
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return f"{self.book.title} — {self.current_position:.1f}%"
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettings(models.Model):
|
||||||
|
user = models.OneToOneField(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="reading_settings",
|
||||||
|
)
|
||||||
|
font_size = models.IntegerField(default=18)
|
||||||
|
"""Font size in pixels (min 12, max 36)"""
|
||||||
|
font_style = models.CharField(
|
||||||
|
max_length=20,
|
||||||
|
choices=[(s.value, s.name.replace("_", " ").title()) for s in FontStyle],
|
||||||
|
default=FontStyle.SANS_SERIF.value,
|
||||||
|
)
|
||||||
|
background_color = models.CharField(
|
||||||
|
max_length=7,
|
||||||
|
choices=[(c.value, c.name.title()) for c in BackgroundColor],
|
||||||
|
default=BackgroundColor.WHITE.value,
|
||||||
|
)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
verbose_name_plural = "reading settings"
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return f"Settings for {self.user}"
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
from rest_framework import serializers
|
||||||
|
|
||||||
|
from books.models import Book, FontStyle, BackgroundColor, ReadingProgress, ReadingSettings
|
||||||
|
|
||||||
|
|
||||||
|
class BookListSerializer(serializers.ModelSerializer):
|
||||||
|
"""Lightweight serializer for the library listing — no file or progress data."""
|
||||||
|
|
||||||
|
filename = serializers.CharField(read_only=True)
|
||||||
|
progress = serializers.SerializerMethodField()
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Book
|
||||||
|
fields = [
|
||||||
|
"id",
|
||||||
|
"title",
|
||||||
|
"author",
|
||||||
|
"filename",
|
||||||
|
"cover_image",
|
||||||
|
"created_at",
|
||||||
|
"progress",
|
||||||
|
]
|
||||||
|
|
||||||
|
def get_progress(self, obj: Book) -> float | None:
|
||||||
|
try:
|
||||||
|
return obj.reading_progress.current_position
|
||||||
|
except ReadingProgress.DoesNotExist:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class BookDetailSerializer(serializers.ModelSerializer):
|
||||||
|
"""Full serializer for the reader view — includes file URL and progress."""
|
||||||
|
|
||||||
|
filename = serializers.CharField(read_only=True)
|
||||||
|
file_url = serializers.SerializerMethodField()
|
||||||
|
progress = serializers.SerializerMethodField()
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Book
|
||||||
|
fields = [
|
||||||
|
"id",
|
||||||
|
"title",
|
||||||
|
"author",
|
||||||
|
"filename",
|
||||||
|
"file_url",
|
||||||
|
"cover_image",
|
||||||
|
"created_at",
|
||||||
|
"updated_at",
|
||||||
|
"progress",
|
||||||
|
]
|
||||||
|
|
||||||
|
def get_file_url(self, obj: Book) -> str:
|
||||||
|
request = self.context.get("request")
|
||||||
|
if request and obj.file:
|
||||||
|
return request.build_absolute_uri(obj.file.url)
|
||||||
|
return ""
|
||||||
|
|
||||||
|
def get_progress(self, obj: Book) -> dict | None:
|
||||||
|
try:
|
||||||
|
rp = obj.reading_progress
|
||||||
|
return {
|
||||||
|
"current_position": rp.current_position,
|
||||||
|
"last_page": rp.last_page,
|
||||||
|
}
|
||||||
|
except ReadingProgress.DoesNotExist:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class BookUploadSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serializer for uploading a new book."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Book
|
||||||
|
fields = ["title", "author", "file", "cover_image"]
|
||||||
|
extra_kwargs = {
|
||||||
|
"title": {"required": True},
|
||||||
|
"file": {"required": True},
|
||||||
|
}
|
||||||
|
|
||||||
|
def validate_file(self, value: object) -> object:
|
||||||
|
import os
|
||||||
|
if isinstance(value, type(None)):
|
||||||
|
return value
|
||||||
|
ext = os.path.splitext(str(getattr(value, 'name', '')))[1].lower()
|
||||||
|
if ext not in (".epub", ".pdf"):
|
||||||
|
raise serializers.ValidationError(
|
||||||
|
"Only EPUB and PDF files are supported."
|
||||||
|
)
|
||||||
|
return value
|
||||||
|
|
||||||
|
def create(self, validated_data: dict) -> Book:
|
||||||
|
validated_data["user"] = self.context["request"].user
|
||||||
|
return super().create(validated_data)
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingProgressSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = ReadingProgress
|
||||||
|
fields = ["current_position", "last_page"]
|
||||||
|
extra_kwargs = {
|
||||||
|
"current_position": {"required": True, "min_value": 0.0, "max_value": 100.0},
|
||||||
|
}
|
||||||
|
|
||||||
|
def validate_current_position(self, value: float) -> float:
|
||||||
|
if value < 0.0 or value > 100.0:
|
||||||
|
raise serializers.ValidationError(
|
||||||
|
"Position must be between 0.0 and 100.0."
|
||||||
|
)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettingsSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = ReadingSettings
|
||||||
|
fields = ["font_size", "font_style", "background_color"]
|
||||||
|
|
||||||
|
def validate_font_size(self, value: int) -> int:
|
||||||
|
if value < 12 or value > 36:
|
||||||
|
raise serializers.ValidationError("Font size must be between 12 and 36.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_font_style(self, value: str) -> str:
|
||||||
|
valid = [s.value for s in FontStyle]
|
||||||
|
if value not in valid:
|
||||||
|
raise serializers.ValidationError(
|
||||||
|
f"Font style must be one of: {', '.join(valid)}"
|
||||||
|
)
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_background_color(self, value: str) -> str:
|
||||||
|
valid = [c.value for c in BackgroundColor]
|
||||||
|
if value not in valid:
|
||||||
|
raise serializers.ValidationError(
|
||||||
|
f"Background color must be one of: {', '.join(valid)}"
|
||||||
|
)
|
||||||
|
return value
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
from django.urls import include, path
|
||||||
|
from rest_framework.routers import DefaultRouter
|
||||||
|
|
||||||
|
from books.views import BookViewSet, ReadingSettingsViewSet
|
||||||
|
|
||||||
|
router = DefaultRouter()
|
||||||
|
router.register(r"books", BookViewSet, basename="book")
|
||||||
|
|
||||||
|
urlpatterns = [
|
||||||
|
path("", include(router.urls)),
|
||||||
|
path("settings/", ReadingSettingsViewSet.as_view({
|
||||||
|
"get": "list",
|
||||||
|
"patch": "partial_update",
|
||||||
|
}), name="reading-settings"),
|
||||||
|
]
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
from django.shortcuts import get_object_or_404
|
||||||
|
from rest_framework import parsers, permissions, status, viewsets
|
||||||
|
from rest_framework.decorators import action
|
||||||
|
from rest_framework.request import Request
|
||||||
|
from rest_framework.response import Response
|
||||||
|
|
||||||
|
from books.models import Book, ReadingProgress, ReadingSettings
|
||||||
|
from books.serializers import (
|
||||||
|
BookDetailSerializer,
|
||||||
|
BookListSerializer,
|
||||||
|
BookUploadSerializer,
|
||||||
|
ReadingProgressSerializer,
|
||||||
|
ReadingSettingsSerializer,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class IsBookOwner(permissions.BasePermission):
|
||||||
|
"""Only the owner of a book can access it."""
|
||||||
|
|
||||||
|
def has_object_permission(
|
||||||
|
self, request: Request, view: object, obj: Book
|
||||||
|
) -> bool:
|
||||||
|
return obj.user == request.user
|
||||||
|
|
||||||
|
|
||||||
|
class BookViewSet(viewsets.ModelViewSet):
|
||||||
|
"""API endpoint for managing user books."""
|
||||||
|
|
||||||
|
parser_classes = [parsers.MultiPartParser, parsers.FormParser, parsers.JSONParser]
|
||||||
|
permission_classes = [permissions.IsAuthenticated, IsBookOwner]
|
||||||
|
|
||||||
|
def get_serializer_class(self) -> type:
|
||||||
|
if self.action == "create":
|
||||||
|
return BookUploadSerializer
|
||||||
|
if self.action == "list":
|
||||||
|
return BookListSerializer
|
||||||
|
return BookDetailSerializer
|
||||||
|
|
||||||
|
def get_queryset(self):
|
||||||
|
return (
|
||||||
|
Book.objects.filter(user=self.request.user)
|
||||||
|
.select_related("reading_progress", "user")
|
||||||
|
.prefetch_related()
|
||||||
|
)
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get", "patch"])
|
||||||
|
def progress(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""Get or update reading progress for a specific book."""
|
||||||
|
book = self.get_object()
|
||||||
|
progress, _created = ReadingProgress.objects.get_or_create(
|
||||||
|
user=request.user,
|
||||||
|
book=book,
|
||||||
|
)
|
||||||
|
|
||||||
|
if request.method == "GET":
|
||||||
|
serializer = ReadingProgressSerializer(progress)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
serializer = ReadingProgressSerializer(progress, data=request.data, partial=True)
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
serializer.save()
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettingsViewSet(viewsets.GenericViewSet):
|
||||||
|
"""API endpoint for user reading settings."""
|
||||||
|
|
||||||
|
permission_classes = [permissions.IsAuthenticated]
|
||||||
|
serializer_class = ReadingSettingsSerializer
|
||||||
|
|
||||||
|
def get_queryset(self):
|
||||||
|
return ReadingSettings.objects.filter(user=self.request.user)
|
||||||
|
|
||||||
|
def list(self, request: Request) -> Response:
|
||||||
|
settings, _created = ReadingSettings.objects.get_or_create(
|
||||||
|
user=request.user,
|
||||||
|
)
|
||||||
|
serializer = self.get_serializer(settings)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
def partial_update(self, request: Request) -> Response:
|
||||||
|
settings, _created = ReadingSettings.objects.get_or_create(
|
||||||
|
user=request.user,
|
||||||
|
)
|
||||||
|
serializer = self.get_serializer(settings, data=request.data, partial=True)
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
serializer.save()
|
||||||
|
return Response(serializer.data)
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
"""Django's command-line utility for administrative tasks."""
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> None:
|
||||||
|
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
|
||||||
|
try:
|
||||||
|
from django.core.management import execute_from_command_line
|
||||||
|
except ImportError as exc:
|
||||||
|
raise ImportError(
|
||||||
|
"Couldn't import Django. Are you sure it's installed and "
|
||||||
|
"available on your PYTHONPATH environment variable? Did you "
|
||||||
|
"forget to activate a virtual environment?"
|
||||||
|
) from exc
|
||||||
|
execute_from_command_line(sys.argv)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
BASE_DIR = Path(__file__).resolve().parent.parent
|
||||||
|
|
||||||
|
SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY", "django-insecure-dev-change-me")
|
||||||
|
DEBUG = os.environ.get("DJANGO_DEBUG", "True").lower() in ("true", "1", "yes")
|
||||||
|
ALLOWED_HOSTS: list[str] = ["*"]
|
||||||
|
|
||||||
|
INSTALLED_APPS = [
|
||||||
|
"django.contrib.admin",
|
||||||
|
"django.contrib.auth",
|
||||||
|
"django.contrib.contenttypes",
|
||||||
|
"django.contrib.sessions",
|
||||||
|
"django.contrib.messages",
|
||||||
|
"django.contrib.staticfiles",
|
||||||
|
# Third-party
|
||||||
|
"rest_framework",
|
||||||
|
"rest_framework.authtoken",
|
||||||
|
"corsheaders",
|
||||||
|
# Local
|
||||||
|
"books",
|
||||||
|
]
|
||||||
|
|
||||||
|
MIDDLEWARE = [
|
||||||
|
"corsheaders.middleware.CorsMiddleware",
|
||||||
|
"django.middleware.security.SecurityMiddleware",
|
||||||
|
"django.contrib.sessions.middleware.SessionMiddleware",
|
||||||
|
"django.middleware.common.CommonMiddleware",
|
||||||
|
"django.middleware.csrf.CsrfViewMiddleware",
|
||||||
|
"django.contrib.auth.middleware.AuthenticationMiddleware",
|
||||||
|
"django.contrib.messages.middleware.MessageMiddleware",
|
||||||
|
"django.middleware.clickjacking.XFrameOptionsMiddleware",
|
||||||
|
]
|
||||||
|
|
||||||
|
ROOT_URLCONF = "project.urls"
|
||||||
|
|
||||||
|
TEMPLATES = [
|
||||||
|
{
|
||||||
|
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
||||||
|
"DIRS": [],
|
||||||
|
"APP_DIRS": True,
|
||||||
|
"OPTIONS": {
|
||||||
|
"context_processors": [
|
||||||
|
"django.template.context_processors.debug",
|
||||||
|
"django.template.context_processors.request",
|
||||||
|
"django.contrib.auth.context_processors.auth",
|
||||||
|
"django.contrib.messages.context_processors.messages",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
WSGI_APPLICATION = "project.wsgi.application"
|
||||||
|
|
||||||
|
# ── Database ──────────────────────────────────────────────
|
||||||
|
_database_url = os.environ.get(
|
||||||
|
"DATABASE_URL",
|
||||||
|
"postgres://cloudreader:cloudreader@localhost:5432/cloudreader",
|
||||||
|
)
|
||||||
|
_db_parts = _database_url.replace("postgres://", "").split("@")
|
||||||
|
_credentials, _host_db = _db_parts[0], _db_parts[1]
|
||||||
|
_db_user, _db_pass = _credentials.split(":")
|
||||||
|
_host_port, _db_name = _host_db.split("/")
|
||||||
|
_db_host = _host_port.split(":")[0]
|
||||||
|
_db_port = _host_port.split(":")[1] if ":" in _host_port else "5432"
|
||||||
|
|
||||||
|
DATABASES = {
|
||||||
|
"default": {
|
||||||
|
"ENGINE": "django.db.backends.postgresql",
|
||||||
|
"NAME": _db_name,
|
||||||
|
"USER": _db_user,
|
||||||
|
"PASSWORD": _db_pass,
|
||||||
|
"HOST": _db_host,
|
||||||
|
"PORT": _db_port,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
|
||||||
|
|
||||||
|
# ── Auth / Password Validation ────────────────────────────
|
||||||
|
AUTH_PASSWORD_VALIDATORS = [
|
||||||
|
{"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
|
||||||
|
]
|
||||||
|
|
||||||
|
# ── DRF ───────────────────────────────────────────────────
|
||||||
|
REST_FRAMEWORK = {
|
||||||
|
"DEFAULT_AUTHENTICATION_CLASSES": [
|
||||||
|
"rest_framework.authentication.TokenAuthentication",
|
||||||
|
"rest_framework.authentication.SessionAuthentication",
|
||||||
|
],
|
||||||
|
"DEFAULT_PERMISSION_CLASSES": [
|
||||||
|
"rest_framework.permissions.IsAuthenticated",
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
# ── CORS ──────────────────────────────────────────────────
|
||||||
|
CORS_ALLOW_ALL_ORIGINS = True # dev only
|
||||||
|
|
||||||
|
# ── Media / Uploads ───────────────────────────────────────
|
||||||
|
MEDIA_URL = "/media/"
|
||||||
|
MEDIA_ROOT = BASE_DIR / "media"
|
||||||
|
|
||||||
|
# ── i18n / Static ─────────────────────────────────────────
|
||||||
|
LANGUAGE_CODE = "en-us"
|
||||||
|
TIME_ZONE = "UTC"
|
||||||
|
USE_I18N = True
|
||||||
|
USE_TZ = True
|
||||||
|
STATIC_URL = "static/"
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
from django.contrib import admin
|
||||||
|
from django.urls import include, path
|
||||||
|
|
||||||
|
urlpatterns = [
|
||||||
|
path("admin/", admin.site.urls),
|
||||||
|
path("api/", include("books.urls")),
|
||||||
|
]
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
|
from django.core.wsgi import get_wsgi_application
|
||||||
|
|
||||||
|
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
|
||||||
|
application = get_wsgi_application()
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
[project]
|
||||||
|
name = "api"
|
||||||
|
version = "1.0.0"
|
||||||
|
description = "Cloud Reader API — Book Search and Discovery"
|
||||||
|
requires-python = ">=3.12"
|
||||||
|
dependencies = [
|
||||||
|
"django>=5.1,<6.0",
|
||||||
|
"djangorestframework>=3.15,<4.0",
|
||||||
|
"django-cors-headers>=4.4,<5.0",
|
||||||
|
"django-filter>=24.3,<25.0",
|
||||||
|
"psycopg2-binary>=2.9,<3.0",
|
||||||
|
"pydantic>=2.0,<3.0",
|
||||||
|
"pydantic-settings>=2.0,<3.0",
|
||||||
|
]
|
||||||
|
|
||||||
|
[build-system]
|
||||||
|
requires = ["setuptools"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[tool.setuptools.packages.find]
|
||||||
|
include = ["books*", "project*"]
|
||||||
Generated
+290
@@ -0,0 +1,290 @@
|
|||||||
|
version = 1
|
||||||
|
revision = 3
|
||||||
|
requires-python = ">=3.12"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "annotated-types"
|
||||||
|
version = "0.7.0"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/ee/67/531ea369ba64dcff5ec9c3402f9f51bf748cec26dde048a2f973a4eea7f5/annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89", size = 16081, upload-time = "2024-05-20T21:33:25.928Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/78/b6/6307fbef88d9b5ee7421e68d78a9f162e0da4900bc5f5793f6d3d0e34fb8/annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53", size = 13643, upload-time = "2024-05-20T21:33:24.1Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "api"
|
||||||
|
version = "1.0.0"
|
||||||
|
source = { editable = "." }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "django" },
|
||||||
|
{ name = "django-cors-headers" },
|
||||||
|
{ name = "django-filter" },
|
||||||
|
{ name = "djangorestframework" },
|
||||||
|
{ name = "psycopg2-binary" },
|
||||||
|
{ name = "pydantic" },
|
||||||
|
{ name = "pydantic-settings" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[package.metadata]
|
||||||
|
requires-dist = [
|
||||||
|
{ name = "django", specifier = ">=5.1,<6.0" },
|
||||||
|
{ name = "django-cors-headers", specifier = ">=4.4,<5.0" },
|
||||||
|
{ name = "django-filter", specifier = ">=24.3,<25.0" },
|
||||||
|
{ name = "djangorestframework", specifier = ">=3.15,<4.0" },
|
||||||
|
{ name = "psycopg2-binary", specifier = ">=2.9,<3.0" },
|
||||||
|
{ name = "pydantic", specifier = ">=2.0,<3.0" },
|
||||||
|
{ name = "pydantic-settings", specifier = ">=2.0,<3.0" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "asgiref"
|
||||||
|
version = "3.11.1"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/63/40/f03da1264ae8f7cfdbf9146542e5e7e8100a4c66ab48e791df9a03d3f6c0/asgiref-3.11.1.tar.gz", hash = "sha256:5f184dc43b7e763efe848065441eac62229c9f7b0475f41f80e207a114eda4ce", size = 38550, upload-time = "2026-02-03T13:30:14.33Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5c/0a/a72d10ed65068e115044937873362e6e32fab1b7dce0046aeb224682c989/asgiref-3.11.1-py3-none-any.whl", hash = "sha256:e8667a091e69529631969fd45dc268fa79b99c92c5fcdda727757e52146ec133", size = 24345, upload-time = "2026-02-03T13:30:13.039Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "django"
|
||||||
|
version = "5.2.14"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "asgiref" },
|
||||||
|
{ name = "sqlparse" },
|
||||||
|
{ name = "tzdata", marker = "sys_platform == 'win32'" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/65/95/95f7faa0950867afaa0bef2460c6263afd6a2c78cc9434046ed28160b015/django-5.2.14.tar.gz", hash = "sha256:58a63ba841662e5c686b57ba1fec52ddd68c0b93bd96ac3029d55728f00bf8a2", size = 10895118, upload-time = "2026-05-05T13:57:31.104Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/14/44/f172870cf87aa25afef48fb72adba89ee8b77fcab6f3b23d240b923f1528/django-5.2.14-py3-none-any.whl", hash = "sha256:6f712143bd3064310d1f50fac859c3e9a274bdcfc9595339853be7779297fc76", size = 8311320, upload-time = "2026-05-05T13:57:25.795Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "django-cors-headers"
|
||||||
|
version = "4.9.0"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "asgiref" },
|
||||||
|
{ name = "django" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/21/39/55822b15b7ec87410f34cd16ce04065ff390e50f9e29f31d6d116fc80456/django_cors_headers-4.9.0.tar.gz", hash = "sha256:fe5d7cb59fdc2c8c646ce84b727ac2bca8912a247e6e68e1fb507372178e59e8", size = 21458, upload-time = "2025-09-18T10:40:52.326Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/30/d8/19ed1e47badf477d17fb177c1c19b5a21da0fd2d9f093f23be3fb86c5fab/django_cors_headers-4.9.0-py3-none-any.whl", hash = "sha256:15c7f20727f90044dcee2216a9fd7303741a864865f0c3657e28b7056f61b449", size = 12809, upload-time = "2025-09-18T10:40:50.843Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "django-filter"
|
||||||
|
version = "24.3"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "django" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/50/bc/dc19ae39c235332926dd0efe0951f663fa1a9fc6be8430737ff7fd566b20/django_filter-24.3.tar.gz", hash = "sha256:d8ccaf6732afd21ca0542f6733b11591030fa98669f8d15599b358e24a2cd9c3", size = 144444, upload-time = "2024-08-02T13:27:58.132Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/09/b1/92f1c30b47c1ebf510c35a2ccad9448f73437e5891bbd2b4febe357cc3de/django_filter-24.3-py3-none-any.whl", hash = "sha256:c4852822928ce17fb699bcfccd644b3574f1a2d80aeb2b4ff4f16b02dd49dc64", size = 95011, upload-time = "2024-08-02T13:27:55.616Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "djangorestframework"
|
||||||
|
version = "3.17.1"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "django" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/ca/d7/c016e69fac19ff8afdc89db9d31d9ae43ae031e4d1993b20aca179b8301a/djangorestframework-3.17.1.tar.gz", hash = "sha256:a6def5f447fe78ff853bff1d47a3c59bf38f5434b031780b351b0c73a62db1a5", size = 905742, upload-time = "2026-03-24T16:58:33.705Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5a/e1/2c516bdc83652b1a60c6119366ac2c0607b479ed05cd6093f916ca8928f8/djangorestframework-3.17.1-py3-none-any.whl", hash = "sha256:c3c74dd3e83a5a3efc37b3c18d92bd6f86a6791c7b7d4dff62bb068500e76457", size = 898844, upload-time = "2026-03-24T16:58:31.845Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "psycopg2-binary"
|
||||||
|
version = "2.9.12"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/2a/60/a3624f79acea344c16fbef3a94d28b89a8042ddfb8f3e4ca83f538671409/psycopg2_binary-2.9.12.tar.gz", hash = "sha256:5ac9444edc768c02a6b6a591f070b8aae28ff3a99be57560ac996001580f294c", size = 379686, upload-time = "2026-04-21T09:40:34.304Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/e2/9f/ef4ef3c8e15083df90ca35265cfd1a081a2f0cc07bb229c6314c6af817f4/psycopg2_binary-2.9.12-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:5cdc05117180c5fa9c40eea8ea559ce64d73824c39d928b7da9fb5f6a9392433", size = 3712459, upload-time = "2026-04-20T23:34:30.549Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/b5/01/3dd14e46ba48c1e1a6ec58ee599fa1b5efa00c246d5046cd903d0eeb1af1/psycopg2_binary-2.9.12-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d3227a3bc228c10d21011a99245edca923e4e8bf461857e869a507d9a41fe9f6", size = 3822936, upload-time = "2026-04-20T23:34:32.77Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/a6/f7/0640e4901119d8a9f7a1784b927f494e2198e213ceb593753d1f2c8b1b30/psycopg2_binary-2.9.12-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:995ce929eede89db6254b50827e2b7fd61e50d11f0b116b29fffe4a2e53c4580", size = 4578676, upload-time = "2026-04-20T23:34:35.18Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/b0/55/44df3965b5f297c50cc0b1b594a31c67d6127a9d133045b8a66611b14dfb/psycopg2_binary-2.9.12-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:9fe06d93e72f1c048e731a2e3e7854a5bfaa58fc736068df90b352cefe66f03f", size = 4274917, upload-time = "2026-04-20T23:34:37.982Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/b0/4b/74535248b1eac0c9336862e8617c765ac94dac76f9e25d7c4a79588c8907/psycopg2_binary-2.9.12-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:40e7b28b63aaf737cb3a1edc3a9bbc9a9f4ad3dcb7152e8c1130e4050eddcb7d", size = 5894843, upload-time = "2026-04-20T23:34:40.856Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/f2/ba/f1bf8d2ae71868ad800b661099086ee52bc0f8d9f05be1acd8ebb06757cc/psycopg2_binary-2.9.12-cp312-cp312-manylinux_2_38_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:89d19a9f7899e8eb0656a2b3a08e0da04c720a06db6e0033eab5928aabe60fa9", size = 4110556, upload-time = "2026-04-20T23:34:44.016Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/45/46/c15706c338403b7c420bcc0c2905aad116cc064545686d8bf85f1999ea00/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:612b965daee295ae2da8f8218ce1d274645dc76ef3f1abf6a0a94fd57eff876d", size = 3655714, upload-time = "2026-04-20T23:34:46.233Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/b3/7c/a2d5dc09b64a4564db242a0fe418fde7d33f6f8259dd2c5b9d7def00fb5a/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:b9a339b79d37c1b45f3235265f07cdeb0cb5ad7acd2ac7720a5920989c17c24e", size = 3301154, upload-time = "2026-04-20T23:34:49.528Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c0/e8/cc8c9a4ce71461f9ec548d38cadc41dc184b34c73e6455450775a9334ccd/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:3471336e1acfd9c7fe507b8bad5af9317b6a89294f9eb37bd9a030bb7bebcdc6", size = 3048882, upload-time = "2026-04-20T23:34:51.86Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/19/6a/31e2296bc0787c5ab75d3d118e40b239db8151b5192b90b77c72bc9256e9/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7af18183109e23502c8b2ae7f6926c0882766f35b5175a4cd737ad825e4d7a1b", size = 3351298, upload-time = "2026-04-20T23:34:54.124Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5f/a8/75f4e3e11203b590150abed2cf7794b9c9c9f7eceddae955191138b44dde/psycopg2_binary-2.9.12-cp312-cp312-win_amd64.whl", hash = "sha256:398fcd4db988c7d7d3713e2b8e18939776fd3fb447052daae4f24fa39daede4c", size = 2757230, upload-time = "2026-04-20T23:34:56.242Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/91/bb/4608c96f970f6e0c56572e87027ef4404f709382a3503e9934526d7ba051/psycopg2_binary-2.9.12-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:7c729a73c7b1b84de3582f73cdd27d905121dc2c531f3d9a3c32a3011033b965", size = 3712419, upload-time = "2026-04-20T23:34:58.754Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5e/af/48f76af9d50d61cf390f8cd657b503168b089e2e9298e48465d029fcc713/psycopg2_binary-2.9.12-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:4413d0caef93c5cf50b96863df4c2efe8c269bf2267df353225595e7e15e8df7", size = 3822990, upload-time = "2026-04-20T23:35:00.821Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/7a/df/aba0f99397cd811d32e06fc0cc781f1f3ce98bc0e729cb423925085d781a/psycopg2_binary-2.9.12-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:4dfcf8e45ebb0c663be34a3442f65e17311f3367089cd4e5e3a3e8e62c978777", size = 4578696, upload-time = "2026-04-20T23:35:03.409Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/95/9c/eaa74021ac4e4d5c2f83d82fc6615a63f4fe6c94dc4e94c3990427053f67/psycopg2_binary-2.9.12-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:c41321a14dd74aceb6a9a643b9253a334521babfa763fa873e33d89cfa122fb5", size = 4274982, upload-time = "2026-04-20T23:35:05.583Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/35/ed/c25deff98bd26187ba48b3b250a3ffc3037c46c5b89362534a15d200e0db/psycopg2_binary-2.9.12-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:83946ba43979ebfdc99a3cd0ee775c89f221df026984ba19d46133d8d75d3cd9", size = 5894867, upload-time = "2026-04-20T23:35:07.902Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/9a/81/8d0e21ca77373c6c9589e5c4528f6e8f0c08c62cafc76fb0bddb7a2cee22/psycopg2_binary-2.9.12-cp313-cp313-manylinux_2_38_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:411e85815652d13560fbe731878daa5d92378c4995a22302071890ec3397d019", size = 4110578, upload-time = "2026-04-20T23:35:10.149Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/00/fc/f481e2435bd8f742d0123309174aae4165160ad3ef17c1b99c3622c241d2/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:1c8ad4c08e00f7679559eaed7aff1edfffc60c086b976f93972f686384a95e2c", size = 3655816, upload-time = "2026-04-20T23:35:12.56Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/53/79/b9f46466bdbe9f239c96cde8be33c1aace4842f06013b47b730dc9759187/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:00814e40fa23c2b37ef0a1e3c749d89982c73a9cb5046137f0752a22d432e82f", size = 3301307, upload-time = "2026-04-20T23:35:15.029Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/3f/19/7dc003b32fe35024df89b658104f7c8538a8b2dcbde7a4e746ce929742e7/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:98062447aebc20ed20add1f547a364fd0ef8933640d5372ff1873f8deb9b61be", size = 3048968, upload-time = "2026-04-20T23:35:16.757Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/91/58/2dbd7db5c604d45f4950d988506aae672a14126ec22998ced5021cbb76bb/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:66a7685d7e548f10fb4ce32fb01a7b7f4aa702134de92a292c7bd9e0d3dbd290", size = 3351369, upload-time = "2026-04-20T23:35:18.933Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/42/ee/dee8dcaad07f735824de3d6563bc67119fa6c28257b17977a8d624f02fab/psycopg2_binary-2.9.12-cp313-cp313-win_amd64.whl", hash = "sha256:b6937f5fe4e180aeee87de907a2fa982ded6f7f15d7218f78a083e4e1d68f2a0", size = 2757347, upload-time = "2026-04-20T23:35:21.283Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/13/1b/708c0dca874acfad6d65314271859899a79007686f3a1f74e82a2ed4b645/psycopg2_binary-2.9.12-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:6f3b3de8a74ef8db215f22edffb19e32dc6fa41340456de7ec99efdc8a7b3ec2", size = 3712428, upload-time = "2026-04-20T23:35:23.453Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/d6/39/ddbea9d4b4de6aca9431b6ed253f530f8a02d3b8f9bcfd0dbfe2b3de6fe4/psycopg2_binary-2.9.12-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:1006fb62f0f0bc5ce256a832356c6262e91be43f5e4eb15b5eaf38079464caf2", size = 3823184, upload-time = "2026-04-20T23:35:25.92Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/bf/a0/bc2fef74b106fa345567122a0659e6d94512ed7dc0131ec44c9e5aba3725/psycopg2_binary-2.9.12-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:840066105706cd2eb29b9a1c2329620056582a4bf3e8169dec5c447042d0869f", size = 4579157, upload-time = "2026-04-20T23:35:28.542Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/57/d7/d4e3b2005d3de607ca4fbb0e8742e248056e52184a6b94ebda3c1c2c329b/psycopg2_binary-2.9.12-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:863f5d12241ebe1c76a72a04c2113b6dc905f90b9cef0e9be0efd994affd9354", size = 4274970, upload-time = "2026-04-20T23:35:30.418Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/2e/42/c9853f8db3967fe08bcde11f53d53b85d351750cae726ce001cb68afa9c1/psycopg2_binary-2.9.12-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a99eaab34a9010f1a086b126de467466620a750634d114d20455f3a824aae033", size = 5895175, upload-time = "2026-04-20T23:35:33.584Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/eb/fd/b82b5601a97630308bef079f545ffec481bbbc795c2ba5ec416a01d03f60/psycopg2_binary-2.9.12-cp314-cp314-manylinux_2_38_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:ffdd7dc5463ccd61845ac37b7012d0f35a1548df9febe14f8dd549be4a0bc81e", size = 4110658, upload-time = "2026-04-20T23:35:35.638Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/62/8c/32ca69b0389ef25dd22937bf9e8fbe2ce27aea20b05ded48c4ce4cb42475/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:54a0dfecab1b48731f934e06139dfe11e24219fb6d0ceb32177cf0375f14c7b5", size = 3656251, upload-time = "2026-04-20T23:35:37.854Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c4/29/96992a2b59e3b9d730fcf9612d0a387305025dc867a9fc490a9e496e074e/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:96937c9c5d891f772430f418a7a8b4691a90c3e6b93cf72b5bd7cad8cbca32a5", size = 3301810, upload-time = "2026-04-20T23:35:39.927Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/56/ad/44b06659949b243ae10112cd3b20a197f9bf3e81d5651379b9eb889bfaad/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:77b348775efd4cdab410ec6609d81ccecd1139c90265fa583a7255c8064bc03d", size = 3048977, upload-time = "2026-04-20T23:35:41.806Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/1d/f2/10a1bcebadb6aa55e280e1f58975c36a7b560ea525184c7aa4064c466633/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:527e6342b3e44c2f0544f6b8e927d60de7f163f5723b8f1dfa7d2a84298738cd", size = 3351466, upload-time = "2026-04-20T23:35:43.993Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/20/be/b732c8418ffa5bcfda002890f5dc4c869fc17db66ff11f53b17cfe44afc0/psycopg2_binary-2.9.12-cp314-cp314-win_amd64.whl", hash = "sha256:f12ae41fcafadb39b2785e64a40f9db05d6de2ac114077457e0e7c597f3af980", size = 2848762, upload-time = "2026-04-20T23:35:46.421Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "pydantic"
|
||||||
|
version = "2.13.4"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "annotated-types" },
|
||||||
|
{ name = "pydantic-core" },
|
||||||
|
{ name = "typing-extensions" },
|
||||||
|
{ name = "typing-inspection" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/18/a5/b60d21ac674192f8ab0ba4e9fd860690f9b4a6e51ca5df118733b487d8d6/pydantic-2.13.4.tar.gz", hash = "sha256:c40756b57adaa8b1efeeced5c196f3f3b7c435f90e84ea7f443901bec8099ef6", size = 844775, upload-time = "2026-05-06T13:43:05.343Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/fd/7b/122376b1fd3c62c1ed9dc80c931ace4844b3c55407b6fb2d199377c9736f/pydantic-2.13.4-py3-none-any.whl", hash = "sha256:45a282cde31d808236fd7ea9d919b128653c8b38b393d1c4ab335c62924d9aba", size = 472262, upload-time = "2026-05-06T13:43:02.641Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "pydantic-core"
|
||||||
|
version = "2.46.4"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "typing-extensions" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/9d/56/921726b776ace8d8f5db44c4ef961006580d91dc52b803c489fafd1aa249/pydantic_core-2.46.4.tar.gz", hash = "sha256:62f875393d7f270851f20523dd2e29f082bcc82292d66db2b64ea71f64b6e1c1", size = 471464, upload-time = "2026-05-06T13:37:06.98Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/ce/8c/af022f0af448d7747c5154288d46b5f2bc5f17366eaa0e23e9aa04d59f3b/pydantic_core-2.46.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3245406455a5d98187ec35530fd772b1d799b26667980872c8d4614991e2c4a2", size = 2106158, upload-time = "2026-05-06T13:38:57.215Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/19/95/6195171e385007300f0f5574592e467c568becce2d937a0b6804f218bc49/pydantic_core-2.46.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:962ccbab7b642487b1d8b7df90ef677e03134cf1fd8880bf698649b22a69371f", size = 1951724, upload-time = "2026-05-06T13:37:02.697Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/8e/bc/f47d1ff9cbb1620e1b5b697eef06010035735f07820180e74178226b27b3/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8233f2947cf85404441fd7e0085f53b10c93e0ee78611099b5c7237e36aacbf7", size = 1975742, upload-time = "2026-05-06T13:37:09.448Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5b/11/9b9a5b0306345664a2da6410877af6e8082481b5884b3ddd78d47c6013ce/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:3a233125ac121aa3ffba9a2b59edfc4a985a76092dc8279586ab4b71390875e7", size = 2052418, upload-time = "2026-05-06T13:37:38.234Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/f1/b7/a65fec226f5d78fc39f4a13c4cc0c768c22b113438f60c14adc9d2865038/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5b712b53160b79a5850310b912a5ef8e57e56947c8ad690c227f5c9d7e561712", size = 2232274, upload-time = "2026-05-06T13:38:27.753Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/68/f0/92039db98b907ef49269a8271f67db9cb78ae2fc68062ef7e4e77adb5f61/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9401557acd873c3a7f3eb9383edef8ac4968f9510e340f4808d427e75667e7b4", size = 2309940, upload-time = "2026-05-06T13:38:05.353Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5f/97/2aab507d3d00ca626e8e57c1eac6a79e4e5fbcc63eb99733ff55d1717f65/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:926c9541b14b12b1681dca8a0b75feb510b06c6341b70a8e500c2fdcff837cce", size = 2094516, upload-time = "2026-05-06T13:39:10.577Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/22/37/a8aca44d40d737dde2bc05b3c6c07dff0de07ce6f82e9f3167aeaf4d5dea/pydantic_core-2.46.4-cp312-cp312-manylinux_2_31_riscv64.whl", hash = "sha256:56cb4851bcaf3d117eddcef4fe66afd750a50274b0da8e22be256d10e5611987", size = 2136854, upload-time = "2026-05-06T13:40:22.59Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/24/99/fcef1b79238c06a8cbec70819ac722ba76e02bc8ada9b0fd66eba40da01b/pydantic_core-2.46.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:c68fcd102d71ea85c5b2dfac3f4f8476eff42a9e078fd5faefff6d145063536b", size = 2180306, upload-time = "2026-05-06T13:40:10.666Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/ae/6c/fc44000918855b42779d007ae63b0532794739027b2f417321cddbc44f6a/pydantic_core-2.46.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:b2f69dec1725e79a012d920df1707de5caf7ed5e08f3be4435e25803efc47458", size = 2190044, upload-time = "2026-05-06T13:40:43.231Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/6b/65/d9cadc9f1920d7a127ad2edba16c1db7916e59719285cd6c94600b0080ba/pydantic_core-2.46.4-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:8d0820e8192167f80d88d64038e609c31452eeca865b4e1d9950a27a4609b00b", size = 2329133, upload-time = "2026-05-06T13:39:57.365Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/d0/cf/c873d91679f3a30bcf5e7ac280ce5573483e72295307685120d0d5ad3416/pydantic_core-2.46.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:fbdb89b3e1c94a30cc5edfce477c6e6a5dc4d8f84665b455c27582f211a1c72c", size = 2374464, upload-time = "2026-05-06T13:38:06.976Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/47/bd/6f2fc8188f31bf10590f1e98e7b306336161fac930a8c514cd7bd828c7dc/pydantic_core-2.46.4-cp312-cp312-win32.whl", hash = "sha256:9aa768456404a8bf48a4406685ac2bec8e72b62c69313734fa3b73cf33b3a894", size = 1974823, upload-time = "2026-05-06T13:40:47.985Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/40/8c/985c1d41ea1107c2534abd9870e4ed5c8e7669b5c308297835c001e7a1c4/pydantic_core-2.46.4-cp312-cp312-win_amd64.whl", hash = "sha256:e9c26f834c65f5752f3f06cb08cb86a913ceb7274d0db6e267808a708b46bc89", size = 2072919, upload-time = "2026-05-06T13:39:21.153Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c4/ba/f463d006e0c47373ca7ec5e1a261c59dc01ef4d62b2657af925fb0deee3a/pydantic_core-2.46.4-cp312-cp312-win_arm64.whl", hash = "sha256:4fc73cb559bdb54b1134a706a2802a4cddd27a0633f5abb7e53056268751ac6a", size = 2027604, upload-time = "2026-05-06T13:39:03.753Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/51/a2/5d30b469c5267a17b39dec53208222f76a8d351dfac4af661888c5aee77d/pydantic_core-2.46.4-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:5d5902252db0d3cedf8d4a1bc68f70eeb430f7e4c7104c8c476753519b423008", size = 2106306, upload-time = "2026-05-06T13:37:48.029Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c1/81/4fa520eaffa8bd7d1525e644cd6d39e7d60b1592bc5b516693c7340b50f1/pydantic_core-2.46.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:c94f0688e7b8d0a67abf40e57a7eaaecd17cc9586706a31b76c031f63df052b4", size = 1951906, upload-time = "2026-05-06T13:37:17.012Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/03/d5/fd02da45b659668b05923b17ba3a0100a0a3d5541e3bd8fcc4ecb711309e/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f027324c56cd5406ca49c124b0db10e56c69064fec039acc571c29020cc87c76", size = 1976802, upload-time = "2026-05-06T13:37:35.113Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/21/f2/95727e1368be3d3ed485eaab7adbd7dda408f33f7a36e8b48e0144002b91/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e739fee756ba1010f8bcccb534252e85a35fe45ae92c295a06059ce58b74ccd3", size = 2052446, upload-time = "2026-05-06T13:37:12.313Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/9c/86/5d99feea3f77c7234b8718075b23db11532773c1a0dbd9b9490215dc2eeb/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9d56801be94b86a9da183e5f3766e6310752b99ff647e38b09a9500d88e46e76", size = 2232757, upload-time = "2026-05-06T13:39:01.149Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/d2/3a/508ac615935ef7588cf6d9e9b91309fdc2da751af865e02a9098de88258c/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2412e734dcb48da14d4e4006b82b46b74f2518b8a26ee7e58c6844a6cd6d03c4", size = 2309275, upload-time = "2026-05-06T13:37:41.406Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/07/f8/41db9de19d7987d6b04715a02b3b40aea467000275d9d758ffaa31af7d50/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9551187363ffc0de2a00b2e47c25aeaeb1020b69b668762966df15fc5659dd5a", size = 2094467, upload-time = "2026-05-06T13:39:18.847Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/2c/e2/f35033184cb11d0052daf4416e8e10a502ea2ac006fc4f459aee872727d1/pydantic_core-2.46.4-cp313-cp313-manylinux_2_31_riscv64.whl", hash = "sha256:0186750b482eefa11d7f435892b09c5c606193ef3375bcf94aa00ae6bfb66262", size = 2134417, upload-time = "2026-05-06T13:40:17.944Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/7e/7b/6ceeb1cc90e193862f444ebe373d8fdf613f0a82572dde03fb10734c6c71/pydantic_core-2.46.4-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5855698a4856556d86e8e6cd8434bc3ac0314ee8e12089ae0e143f64c6256e4e", size = 2179782, upload-time = "2026-05-06T13:40:32.618Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5a/f2/c8d7773ede6af08036423a00ae0ceffce266c3c52a096c435d68c896083f/pydantic_core-2.46.4-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:cbaf13819775b7f769bf4a1f066cb6df7a28d4480081a589828ef190226881cd", size = 2188782, upload-time = "2026-05-06T13:36:51.018Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/59/31/0c864784e31f09f05cdd87606f08923b9c9e7f6e51dd27f20f62f975ce9f/pydantic_core-2.46.4-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:633147d34cf4550417f12e2b1a0383973bdf5cdfde212cb09e9a581cf10820be", size = 2328334, upload-time = "2026-05-06T13:40:37.764Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c2/eb/4f6c8a41efa30baa755590f4141abf3a8c370fab610915733e74134a7270/pydantic_core-2.46.4-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:82cf5301172168103724d49a1444d3378cb20cdee30b116a1bd6031236298a5d", size = 2372986, upload-time = "2026-05-06T13:39:34.152Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/5b/24/b375a480d53113860c299764bfe9f349a3dc9108b3adc0d7f0d786492ebf/pydantic_core-2.46.4-cp313-cp313-win32.whl", hash = "sha256:9fa8ae11da9e2b3126c6426f147e0fba88d96d65921799bb30c6abd1cb2c97fb", size = 1973693, upload-time = "2026-05-06T13:37:55.072Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/7e/e8/cff247591966f2d22ec8c003cd7587e27b7ba7b81ab2fb888e3ab75dc285/pydantic_core-2.46.4-cp313-cp313-win_amd64.whl", hash = "sha256:6b3ace8194b0e5204818c92802dcdca7fc6d88aabbb799d7c795540d9cd6d292", size = 2071819, upload-time = "2026-05-06T13:38:49.139Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c6/1a/f4aee670d5670e9e148e0c82c7db98d780be566c6e6a97ee8035528ca0b3/pydantic_core-2.46.4-cp313-cp313-win_arm64.whl", hash = "sha256:184c081504d17f1c1066e430e117142b2c77d9448a97f7b65c6ac9fd9aee238d", size = 2027411, upload-time = "2026-05-06T13:40:45.796Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/8d/74/228a26ddad29c6672b805d9fd78e8d251cd04004fa7eed0e622096cd0250/pydantic_core-2.46.4-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:428e04521a40150c85216fc8b85e8d39fece235a9cf5e383761238c7fa9b96fb", size = 2102079, upload-time = "2026-05-06T13:38:41.019Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/ad/1f/8970b150a4b4365623ae00fc88603491f763c627311ae8031e3111356d6e/pydantic_core-2.46.4-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:23ace664830ee0bfe014a0c7bc248b1f7f25ed7ad103852c317624a1083af462", size = 1952179, upload-time = "2026-05-06T13:36:59.812Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/95/30/5211a831ae054928054b2f79731661087a2bc5c01e825c672b3a4a8f1b3e/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ce5c1d2a8b27468f433ca974829c44060b8097eedc39933e3c206a90ee49c4a9", size = 1978926, upload-time = "2026-05-06T13:37:39.933Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/57/e9/689668733b1eb67adeef047db3c2e8788fcf65a7fd9c9e2b46b7744fe245/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7283d57845ecf5a163403eb0702dfc220cc4fbdd18919cb5ccea4f95ee1cdab4", size = 2046785, upload-time = "2026-05-06T13:38:01.995Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/60/d9/6715260422ff50a2109878fd24d948a6c3446bb2664f34ee78cd972b3acd/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8daafc69c93ee8a0204506a3b6b30f586ef54028f52aeeeb5c4cfc5184fd5914", size = 2228733, upload-time = "2026-05-06T13:40:50.371Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/18/ae/fdb2f64316afca925640f8e70bb1a564b0ec2721c1389e25b8eb4bf9a299/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd2213145bcc2ba85884d0ac63d222fece9209678f77b9b4d76f054c561adb28", size = 2307534, upload-time = "2026-05-06T13:37:21.531Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/89/1d/8eff589b45bb8190a9d12c49cfad0f176a5cbd1534908a6b5125e2886239/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7a5f930472650a82629163023e630d160863fce524c616f4e5186e5de9d9a49b", size = 2099732, upload-time = "2026-05-06T13:39:31.942Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/06/d5/ee5a3366637fee41dee51a1fc91562dcf12ddbc68fda34e6b253da2324bb/pydantic_core-2.46.4-cp314-cp314-manylinux_2_31_riscv64.whl", hash = "sha256:c1b3f518abeca3aa13c712fd202306e145abf59a18b094a6bafb2d2bbf59192c", size = 2129627, upload-time = "2026-05-06T13:37:25.033Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/94/33/2414be571d2c6a6c4d08be21f9292b6d3fdb08949a97b6dfe985017821db/pydantic_core-2.46.4-cp314-cp314-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:1a7dd0b3ee80d90150e3495a3a13ac34dbcbfd4f012996a6a1d8900e91b5c0fb", size = 2179141, upload-time = "2026-05-06T13:37:14.046Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/7b/79/7daa95be995be0eecc4cf75064cb33f9bbbfe3fe0158caf2f0d4a996a5c7/pydantic_core-2.46.4-cp314-cp314-musllinux_1_1_aarch64.whl", hash = "sha256:3fb702cd90b0446a3a1c5e470bfa0dd23c0233b676a9099ddcc964fa6ca13898", size = 2184325, upload-time = "2026-05-06T13:36:53.615Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/9f/cb/d0a382f5c0de8a222dc61c65348e0ce831b1f68e0a018450d31c2cace3a5/pydantic_core-2.46.4-cp314-cp314-musllinux_1_1_armv7l.whl", hash = "sha256:b8458003118a712e66286df6a707db01c52c0f52f7db8e4a38f0da1d3b94fc4e", size = 2323990, upload-time = "2026-05-06T13:40:29.971Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/05/db/d9ba624cc4a5aced1598e88c04fdbd8310c8a69b9d38b9a3d39ce3a61ed7/pydantic_core-2.46.4-cp314-cp314-musllinux_1_1_x86_64.whl", hash = "sha256:372429a130e469c9cd698925ce5fc50940b7a1336b0d82038e63d5bbc4edc519", size = 2369978, upload-time = "2026-05-06T13:37:23.027Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/f2/20/d15df15ba918c423461905802bfd2981c3af0bfa0e40d05e13edbfa48bc3/pydantic_core-2.46.4-cp314-cp314-win32.whl", hash = "sha256:85bb3611ff1802f3ee7fdd7dbff26b56f343fb432d57a4728fdd49b6ef35e2f4", size = 1966354, upload-time = "2026-05-06T13:38:03.499Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/fc/b6/6b8de4c0a7d7ab3004c439c80c5c1e0a3e8d78bbae19379b01960383d9e5/pydantic_core-2.46.4-cp314-cp314-win_amd64.whl", hash = "sha256:811ff8e9c313ab425368bcbb36e5c4ebd7108c2bbf4e4089cfbb0b01eff63fac", size = 2072238, upload-time = "2026-05-06T13:39:40.807Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/32/36/51eb763beec1f4cf59b1db243a7dcc39cbb41230f050a09b9d69faaf0a48/pydantic_core-2.46.4-cp314-cp314-win_arm64.whl", hash = "sha256:bfec22eab3c8cc2ceec0248aec886624116dc079afa027ecc8ad4a7e62010f8a", size = 2018251, upload-time = "2026-05-06T13:37:26.72Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/e8/91/855af51d625b23aa987116a19e231d2aaef9c4a415273ddc189b79a45fee/pydantic_core-2.46.4-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:af8244b2bef6aaad6d92cda81372de7f8c8d36c9f0c3ea36e827c60e7d9467a0", size = 2099593, upload-time = "2026-05-06T13:39:47.682Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/fb/1b/8784a54c65edb5f49f0a14d6977cf1b209bba85a4c77445b255c2de58ab3/pydantic_core-2.46.4-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:5a4330cdbc57162e4b3aa303f588ba752257694c9c9be3e7ebb11b4aca659b5d", size = 1935226, upload-time = "2026-05-06T13:40:40.428Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/e8/e7/1955d28d1afc56dd4b3ad7cc0cf39df1b9852964cf16e5d13912756d6d6b/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:29c61fc04a3d840155ff08e475a04809278972fe6aef51e2720554e96367e34b", size = 1974605, upload-time = "2026-05-06T13:37:32.029Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/93/e2/3fedbf0ba7a22850e6e9fd78117f1c0f10f950182344d8a6c535d468fdd8/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c50f2528cf200c5eed56faf3f4e22fcd5f38c157a8b78576e6ba3168ec35f000", size = 2030777, upload-time = "2026-05-06T13:38:55.239Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/f8/61/46be275fcaaba0b4f5b9669dd852267ce1ff616592dccf7a7845588df091/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0cbe8b01f948de4286c74cdd6c667aceb38f5c1e26f0693b3983d9d74887c65e", size = 2236641, upload-time = "2026-05-06T13:37:08.096Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/60/db/12e93e46a8bac9988be3c016860f83293daea8c716c029c9ace279036f2f/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:617d7e2ca7dcb8c5cf6bcb8c59b8832c94b36196bbf1cbd1bfb56ed341905edd", size = 2286404, upload-time = "2026-05-06T13:40:20.221Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/e2/4a/4d8b19008f38d31c53b8219cfedc2e3d5de5fe99d90076b7e767de29274f/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7027560ee92211647d0d34e3f7cd6f50da56399d26a9c8ad0da286d3869a53f3", size = 2109219, upload-time = "2026-05-06T13:38:12.153Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/88/70/3cbc40978fefb7bb09c6708d40d4ad1a5d70fd7213c3d17f971de868ec1f/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_31_riscv64.whl", hash = "sha256:f99626688942fb746e545232e7726926f3be91b5975f8b55327665fafda991c7", size = 2110594, upload-time = "2026-05-06T13:40:02.971Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/9d/20/b8d36736216e29491125531685b2f9e61aa5b4b2599893f8268551da3338/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:fc3e9034a63de20e15e8ade85358bc6efc614008cab72898b4b4952bea0509ff", size = 2159542, upload-time = "2026-05-06T13:39:27.506Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/1d/a2/367df868eb584dacf6bf82a389272406d7178e301c4ac82545ab98bc2dd9/pydantic_core-2.46.4-cp314-cp314t-musllinux_1_1_aarch64.whl", hash = "sha256:97e7cf2be5c77b7d1a9713a05605d49460d02c6078d38d8bef3cbe323c548424", size = 2168146, upload-time = "2026-05-06T13:38:31.93Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c1/b8/4460f77f7e201893f649a29ab355dddd3beee8a97bcb1a320db414f9a06e/pydantic_core-2.46.4-cp314-cp314t-musllinux_1_1_armv7l.whl", hash = "sha256:3bf92c5d0e00fefaab325a4d27828fe6b6e2a21848686b5b60d2d9eeb09d76c6", size = 2306309, upload-time = "2026-05-06T13:37:44.717Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/64/c4/be2639293acd87dc8ddbcec41a73cee9b2ebf996fe6d892a1a74e88ad3f7/pydantic_core-2.46.4-cp314-cp314t-musllinux_1_1_x86_64.whl", hash = "sha256:3ecbc122d18468d06ca279dc26a8c2e2d5acb10943bb35e36ae92096dc3b5565", size = 2369736, upload-time = "2026-05-06T13:37:05.645Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/30/a6/9f9f380dbb301f67023bf8f707aaa75daadf84f7152d95c410fd7e81d994/pydantic_core-2.46.4-cp314-cp314t-win32.whl", hash = "sha256:e846ae7835bf0703ae43f534ab79a867146dadd59dc9ca5c8b53d5c8f7c9ef02", size = 1955575, upload-time = "2026-05-06T13:38:51.116Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/40/1f/f1eb9eb350e795d1af8586289746f5c5677d16043040d63710e22abc43c9/pydantic_core-2.46.4-cp314-cp314t-win_amd64.whl", hash = "sha256:2108ba5c1c1eca18030634489dc544844144ee36357f2f9f780b93e7ddbb44b5", size = 2051624, upload-time = "2026-05-06T13:38:21.672Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/f6/d2/42dd53d0a85c27606f316d3aa5d2869c4e8470a5ed6dec30e4a1abe19192/pydantic_core-2.46.4-cp314-cp314t-win_arm64.whl", hash = "sha256:4fcbe087dbc2068af7eda3aa87634eba216dbda64d1ae73c8684b621d33f6596", size = 2017325, upload-time = "2026-05-06T13:40:52.723Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/9d/1d/8987ad40f65ae1432753072f214fb5c74fe47ffbd0698bb9cbbb585664f8/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-macosx_10_12_x86_64.whl", hash = "sha256:1d8ba486450b14f3b1d63bc521d410ec7565e52f887b9fb671791886436a42f7", size = 2095527, upload-time = "2026-05-06T13:39:52.283Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/64/d3/84c282a7eee1d3ac4c0377546ef5a1ea436ce26840d9ac3b7ed54a377507/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-macosx_11_0_arm64.whl", hash = "sha256:3009f12e4e90b7f88b4f9adb1b0c4a3d58fe7820f3238c190047209d148026df", size = 1936024, upload-time = "2026-05-06T13:40:15.671Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/d7/ca/eac61596cdeb4d7e174d3dc0bd8a6238f14f75f97a24e7b7db4c7e7340a0/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ad785e92e6dc634c21555edc8bd6b64957ab844541bcb96a1366c202951ae526", size = 1990696, upload-time = "2026-05-06T13:38:34.717Z" },
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/fa/c3/7c8b240552251faf6b3a957db200fcfbbcec36763c050428b601e0c9b83b/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:00c603d540afdd6b80eb39f078f33ebd46211f02f33e34a32d9f053bba711de0", size = 2147590, upload-time = "2026-05-06T13:39:29.883Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "pydantic-settings"
|
||||||
|
version = "2.14.1"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "pydantic" },
|
||||||
|
{ name = "python-dotenv" },
|
||||||
|
{ name = "typing-inspection" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/07/60/1d1e59c9c90d54591469ada7d268251f71c24bdb765f1a8a832cee8c6653/pydantic_settings-2.14.1.tar.gz", hash = "sha256:e874d3bec7e787b0c9958277956ed9b4dd5de6a80e162188fdaff7c5e26fd5fa", size = 235551, upload-time = "2026-05-08T13:40:06.542Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/ae/8d/f1af3832f5e6eb13ba94ee809e72b8ecb5eef226d27ee0bef7d963d943c7/pydantic_settings-2.14.1-py3-none-any.whl", hash = "sha256:6e3c7edfd8277687cdc598f56e5cff0e9bfff0910a3749deaa8d4401c3a2b9de", size = 60964, upload-time = "2026-05-08T13:40:04.958Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "python-dotenv"
|
||||||
|
version = "1.2.2"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/82/ed/0301aeeac3e5353ef3d94b6ec08bbcabd04a72018415dcb29e588514bba8/python_dotenv-1.2.2.tar.gz", hash = "sha256:2c371a91fbd7ba082c2c1dc1f8bf89ca22564a087c2c287cd9b662adde799cf3", size = 50135, upload-time = "2026-03-01T16:00:26.196Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/0b/d7/1959b9648791274998a9c3526f6d0ec8fd2233e4d4acce81bbae76b44b2a/python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a", size = 22101, upload-time = "2026-03-01T16:00:25.09Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "sqlparse"
|
||||||
|
version = "0.5.5"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/90/76/437d71068094df0726366574cf3432a4ed754217b436eb7429415cf2d480/sqlparse-0.5.5.tar.gz", hash = "sha256:e20d4a9b0b8585fdf63b10d30066c7c94c5d7a7ec47c889a2d83a3caa93ff28e", size = 120815, upload-time = "2025-12-19T07:17:45.073Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/49/4b/359f28a903c13438ef59ebeee215fb25da53066db67b305c125f1c6d2a25/sqlparse-0.5.5-py3-none-any.whl", hash = "sha256:12a08b3bf3eec877c519589833aed092e2444e68240a3577e8e26148acc7b1ba", size = 46138, upload-time = "2025-12-19T07:17:46.573Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "typing-extensions"
|
||||||
|
version = "4.15.0"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/72/94/1a15dd82efb362ac84269196e94cf00f187f7ed21c242792a923cdb1c61f/typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466", size = 109391, upload-time = "2025-08-25T13:49:26.313Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/18/67/36e9267722cc04a6b9f15c7f3441c2363321a3ea07da7ae0c0707beb2a9c/typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548", size = 44614, upload-time = "2025-08-25T13:49:24.86Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "typing-inspection"
|
||||||
|
version = "0.4.2"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "typing-extensions" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/55/e3/70399cb7dd41c10ac53367ae42139cf4b1ca5f36bb3dc6c9d33acdb43655/typing_inspection-0.4.2.tar.gz", hash = "sha256:ba561c48a67c5958007083d386c3295464928b01faa735ab8547c5692e87f464", size = 75949, upload-time = "2025-10-01T02:14:41.687Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/dc/9b/47798a6c91d8bdb567fe2698fe81e0c6b7cb7ef4d13da4114b41d239f65d/typing_inspection-0.4.2-py3-none-any.whl", hash = "sha256:4ed1cacbdc298c220f1bd249ed5287caa16f34d44ef4e9c3d0cbad5b521545e7", size = 14611, upload-time = "2025-10-01T02:14:40.154Z" },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "tzdata"
|
||||||
|
version = "2026.2"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/ba/19/1b9b0e29f30c6d35cb345486df41110984ea67ae69dddbc0e8a100999493/tzdata-2026.2.tar.gz", hash = "sha256:9173fde7d80d9018e02a662e168e5a2d04f87c41ea174b139fbef642eda62d10", size = 198254, upload-time = "2026-04-24T15:22:08.651Z" }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/ce/e4/dccd7f47c4b64213ac01ef921a1337ee6e30e8c6466046018326977efd95/tzdata-2026.2-py2.py3-none-any.whl", hash = "sha256:bbe9af844f658da81a5f95019480da3a89415801f6cc966806612cc7169bffe7", size = 349321, upload-time = "2026-04-24T15:22:05.876Z" },
|
||||||
|
]
|
||||||
+5
-12
@@ -1,15 +1,8 @@
|
|||||||
# Cloud Reader Backend — Environment Variables
|
# Backend environment (example – never commit real secrets)
|
||||||
# Copy to .env and fill in your values.
|
DJANGO_SECRET_KEY=django-insecure-change-me-in-production
|
||||||
|
DJANGO_DEBUG=True
|
||||||
SECRET_KEY=django-insecure-change-me-in-production
|
|
||||||
DEBUG=True
|
|
||||||
|
|
||||||
DB_ENGINE=django.db.backends.postgresql
|
|
||||||
DB_NAME=cloud_reader
|
DB_NAME=cloud_reader
|
||||||
DB_USER=cloud_reader
|
DB_USER=postgres
|
||||||
DB_PASSWORD=cloud_reader
|
DB_PASSWORD=postgres
|
||||||
DB_HOST=localhost
|
DB_HOST=localhost
|
||||||
DB_PORT=5432
|
DB_PORT=5432
|
||||||
|
|
||||||
CORS_ALLOWED_ORIGINS=http://localhost:5173,http://localhost:3000
|
|
||||||
ALLOWED_HOSTS=localhost,127.0.0.1
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
FROM python:3.12-slim
|
|
||||||
|
|
||||||
ENV PYTHONDONTWRITEBYTECODE=1 \
|
|
||||||
PYTHONUNBUFFERED=1 \
|
|
||||||
DJANGO_SETTINGS_MODULE=config.settings
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
COPY requirements/production.txt /app/requirements/
|
|
||||||
RUN pip install --no-cache-dir -r requirements/production.txt
|
|
||||||
|
|
||||||
COPY . /app
|
|
||||||
|
|
||||||
RUN python manage.py collectstatic --noinput
|
|
||||||
|
|
||||||
EXPOSE 8000
|
|
||||||
|
|
||||||
CMD ["gunicorn", "config.wsgi:application", "--bind", "0.0.0.0:8000", "--workers", "4"]
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
from django.contrib import admin
|
|
||||||
|
|
||||||
from .models import User
|
|
||||||
|
|
||||||
|
|
||||||
@admin.register(User)
|
|
||||||
class UserAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ["email", "display_name", "is_verified", "is_active", "date_joined"]
|
|
||||||
search_fields = ["email", "display_name"]
|
|
||||||
list_filter = ["is_verified", "is_active"]
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
from django.contrib.auth.models import AbstractUser
|
|
||||||
from django.db import models
|
|
||||||
|
|
||||||
|
|
||||||
class User(AbstractUser):
|
|
||||||
"""Custom user model for Cloud Reader."""
|
|
||||||
|
|
||||||
email = models.EmailField(unique=True)
|
|
||||||
display_name = models.CharField(max_length=150, blank=True)
|
|
||||||
avatar = models.ImageField(upload_to="avatars/", blank=True, null=True)
|
|
||||||
is_verified = models.BooleanField(default=False)
|
|
||||||
reading_preferences = models.JSONField(default=dict, blank=True)
|
|
||||||
|
|
||||||
USERNAME_FIELD = "email"
|
|
||||||
REQUIRED_FIELDS = ["username"]
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
db_table = "accounts_user"
|
|
||||||
verbose_name = "User"
|
|
||||||
verbose_name_plural = "Users"
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return self.email
|
|
||||||
|
|
||||||
@property
|
|
||||||
def avatar_url(self) -> str | None:
|
|
||||||
if self.avatar:
|
|
||||||
return self.avatar.url
|
|
||||||
return None
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
from django.contrib.auth import get_user_model
|
|
||||||
from rest_framework import serializers
|
|
||||||
|
|
||||||
from .models import User
|
|
||||||
|
|
||||||
UserModel = get_user_model()
|
|
||||||
|
|
||||||
|
|
||||||
class RegisterSerializer(serializers.ModelSerializer[User]):
|
|
||||||
password = serializers.CharField(write_only=True, min_length=8)
|
|
||||||
password_confirm = serializers.CharField(write_only=True, min_length=8)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = User
|
|
||||||
fields = ["email", "username", "display_name", "password", "password_confirm"]
|
|
||||||
|
|
||||||
def validate(self, attrs):
|
|
||||||
if attrs["password"] != attrs.pop("password_confirm"):
|
|
||||||
raise serializers.ValidationError({"password_confirm": "Passwords do not match."})
|
|
||||||
return attrs
|
|
||||||
|
|
||||||
def create(self, validated_data):
|
|
||||||
password = validated_data.pop("password")
|
|
||||||
user = UserModel(**validated_data)
|
|
||||||
user.set_password(password)
|
|
||||||
user.save()
|
|
||||||
return user
|
|
||||||
|
|
||||||
|
|
||||||
class UserSerializer(serializers.ModelSerializer[User]):
|
|
||||||
avatar_url = serializers.SerializerMethodField()
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = User
|
|
||||||
fields = [
|
|
||||||
"id", "email", "username", "display_name", "avatar_url",
|
|
||||||
"date_joined", "is_verified", "reading_preferences",
|
|
||||||
]
|
|
||||||
read_only_fields = ["id", "email", "date_joined", "is_verified"]
|
|
||||||
|
|
||||||
def get_avatar_url(self, obj: User) -> str | None:
|
|
||||||
return obj.avatar_url
|
|
||||||
|
|
||||||
|
|
||||||
class ChangePasswordSerializer(serializers.Serializer):
|
|
||||||
old_password = serializers.CharField(required=True)
|
|
||||||
new_password = serializers.CharField(required=True, min_length=8)
|
|
||||||
|
|
||||||
def validate_old_password(self, value: str) -> str:
|
|
||||||
user = self.context["request"].user
|
|
||||||
if not user.check_password(value):
|
|
||||||
raise serializers.ValidationError("Current password is incorrect.")
|
|
||||||
return value
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
from django.urls import path
|
|
||||||
from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView
|
|
||||||
|
|
||||||
from . import views
|
|
||||||
|
|
||||||
app_name = "accounts"
|
|
||||||
|
|
||||||
urlpatterns = [
|
|
||||||
path("register/", views.RegisterView.as_view(), name="register"),
|
|
||||||
path("me/", views.UserDetailView.as_view(), name="user-detail"),
|
|
||||||
path("change-password/", views.ChangePasswordView.as_view(), name="change-password"),
|
|
||||||
path("token/", TokenObtainPairView.as_view(), name="token-obtain"),
|
|
||||||
path("token/refresh/", TokenRefreshView.as_view(), name="token-refresh"),
|
|
||||||
]
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
from django.contrib.auth import get_user_model
|
|
||||||
from rest_framework import generics, permissions, status
|
|
||||||
from rest_framework.response import Response
|
|
||||||
from rest_framework.views import APIView
|
|
||||||
|
|
||||||
from .serializers import ChangePasswordSerializer, RegisterSerializer, UserSerializer
|
|
||||||
|
|
||||||
UserModel = get_user_model()
|
|
||||||
|
|
||||||
|
|
||||||
class RegisterView(generics.CreateAPIView):
|
|
||||||
"""Create a new user account."""
|
|
||||||
queryset = UserModel.objects.all()
|
|
||||||
serializer_class = RegisterSerializer
|
|
||||||
permission_classes = [permissions.AllowAny]
|
|
||||||
|
|
||||||
|
|
||||||
class UserDetailView(generics.RetrieveUpdateAPIView):
|
|
||||||
"""Get or update the authenticated user's profile."""
|
|
||||||
serializer_class = UserSerializer
|
|
||||||
permission_classes = [permissions.IsAuthenticated]
|
|
||||||
|
|
||||||
def get_object(self):
|
|
||||||
return self.request.user
|
|
||||||
|
|
||||||
|
|
||||||
class ChangePasswordView(APIView):
|
|
||||||
"""Change the authenticated user's password."""
|
|
||||||
permission_classes = [permissions.IsAuthenticated]
|
|
||||||
|
|
||||||
def post(self, request):
|
|
||||||
serializer = ChangePasswordSerializer(data=request.data, context={"request": request})
|
|
||||||
serializer.is_valid(raise_exception=True)
|
|
||||||
request.user.set_password(serializer.validated_data["new_password"])
|
|
||||||
request.user.save()
|
|
||||||
return Response({"detail": "Password changed successfully."}, status=status.HTTP_200_OK)
|
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
from django.contrib import admin
|
||||||
|
|
||||||
|
from apps.annotations.models import Bookmark, Note
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(Bookmark)
|
||||||
|
class BookmarkAdmin(admin.ModelAdmin):
|
||||||
|
list_display = ("user", "book", "page", "created_at")
|
||||||
|
list_select_related = ("user", "book")
|
||||||
|
search_fields = ("user__email", "book__title", "location_text")
|
||||||
|
list_filter = ("created_at",)
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(Note)
|
||||||
|
class NoteAdmin(admin.ModelAdmin):
|
||||||
|
list_display = ("user", "book", "page", "created_at", "updated_at")
|
||||||
|
list_select_related = ("user", "book")
|
||||||
|
search_fields = ("user__email", "book__title", "content", "location_text")
|
||||||
|
list_filter = ("created_at",)
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
from django.apps import AppConfig
|
||||||
|
|
||||||
|
|
||||||
|
class AnnotationsConfig(AppConfig):
|
||||||
|
default_auto_field = "django.db.models.BigAutoField"
|
||||||
|
name = "apps.annotations"
|
||||||
|
label = "annotations"
|
||||||
@@ -0,0 +1,84 @@
|
|||||||
|
import uuid
|
||||||
|
|
||||||
|
from django.conf import settings
|
||||||
|
from django.db import models
|
||||||
|
|
||||||
|
|
||||||
|
class Bookmark(models.Model):
|
||||||
|
"""A saved location in a book that the user can return to."""
|
||||||
|
|
||||||
|
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
|
||||||
|
user = models.ForeignKey(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="bookmarks",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
book = models.ForeignKey(
|
||||||
|
"books.Book",
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="bookmarks",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
page = models.PositiveIntegerField()
|
||||||
|
location_text = models.TextField(
|
||||||
|
blank=True,
|
||||||
|
default="",
|
||||||
|
help_text="The selected passage text at this location",
|
||||||
|
)
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "annotations_bookmark"
|
||||||
|
verbose_name = "Bookmark"
|
||||||
|
verbose_name_plural = "Bookmarks"
|
||||||
|
ordering = ["-created_at"]
|
||||||
|
constraints = [
|
||||||
|
models.UniqueConstraint(
|
||||||
|
fields=["user", "book", "page"],
|
||||||
|
name="uq_bookmark_user_book_page",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return f"{self.user} @ {self.book} p.{self.page}"
|
||||||
|
|
||||||
|
|
||||||
|
class Note(models.Model):
|
||||||
|
"""A user-written note attached to a specific location in a book."""
|
||||||
|
|
||||||
|
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
|
||||||
|
user = models.ForeignKey(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="notes",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
book = models.ForeignKey(
|
||||||
|
"books.Book",
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="notes",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
page = models.PositiveIntegerField()
|
||||||
|
location_text = models.TextField(
|
||||||
|
blank=True,
|
||||||
|
default="",
|
||||||
|
help_text="The selected passage text this note refers to",
|
||||||
|
)
|
||||||
|
content = models.TextField(
|
||||||
|
help_text="The note body content"
|
||||||
|
)
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "annotations_note"
|
||||||
|
verbose_name = "Note"
|
||||||
|
verbose_name_plural = "Notes"
|
||||||
|
ordering = ["-created_at"]
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
preview = self.content[:50]
|
||||||
|
return f"{self.user} @ {self.book} p.{self.page}: {preview}"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
from rest_framework import permissions
|
||||||
|
|
||||||
|
|
||||||
|
class IsOwner(permissions.BasePermission):
|
||||||
|
"""Grant access only if the requesting user owns the object."""
|
||||||
|
|
||||||
|
def has_object_permission(self, request, view, obj) -> bool:
|
||||||
|
return obj.user == request.user
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
from rest_framework import serializers
|
||||||
|
|
||||||
|
from apps.annotations.models import Bookmark, Note
|
||||||
|
|
||||||
|
|
||||||
|
class BookmarkSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serialize Bookmark data with full details."""
|
||||||
|
|
||||||
|
book_title = serializers.CharField(source="book.title", read_only=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Bookmark
|
||||||
|
fields = [
|
||||||
|
"id",
|
||||||
|
"book",
|
||||||
|
"book_title",
|
||||||
|
"page",
|
||||||
|
"location_text",
|
||||||
|
"created_at",
|
||||||
|
"updated_at",
|
||||||
|
]
|
||||||
|
read_only_fields = ["id", "created_at", "updated_at", "book_title"]
|
||||||
|
|
||||||
|
def validate_page(self, value: int) -> int:
|
||||||
|
if value < 1:
|
||||||
|
raise serializers.ValidationError("Page must be a positive integer.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
class BookmarkCreateSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serializer used for creating bookmarks. Sets user from request context."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Bookmark
|
||||||
|
fields = ["book", "page", "location_text"]
|
||||||
|
|
||||||
|
def validate_page(self, value: int) -> int:
|
||||||
|
if value < 1:
|
||||||
|
raise serializers.ValidationError("Page must be a positive integer.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate(self, attrs):
|
||||||
|
user = self.context["request"].user
|
||||||
|
if Bookmark.objects.filter(
|
||||||
|
user=user, book=attrs["book"], page=attrs["page"]
|
||||||
|
).exists():
|
||||||
|
raise serializers.ValidationError(
|
||||||
|
{"page": "A bookmark already exists at this page for this book."}
|
||||||
|
)
|
||||||
|
return attrs
|
||||||
|
|
||||||
|
def create(self, validated_data):
|
||||||
|
validated_data["user"] = self.context["request"].user
|
||||||
|
return super().create(validated_data)
|
||||||
|
|
||||||
|
|
||||||
|
class NoteSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serialize Note data with full details."""
|
||||||
|
|
||||||
|
book_title = serializers.CharField(source="book.title", read_only=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Note
|
||||||
|
fields = [
|
||||||
|
"id",
|
||||||
|
"book",
|
||||||
|
"book_title",
|
||||||
|
"page",
|
||||||
|
"location_text",
|
||||||
|
"content",
|
||||||
|
"created_at",
|
||||||
|
"updated_at",
|
||||||
|
]
|
||||||
|
read_only_fields = ["id", "created_at", "updated_at", "book_title"]
|
||||||
|
|
||||||
|
def validate_page(self, value: int) -> int:
|
||||||
|
if value < 1:
|
||||||
|
raise serializers.ValidationError("Page must be a positive integer.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_content(self, value: str) -> str:
|
||||||
|
stripped = value.strip()
|
||||||
|
if not stripped:
|
||||||
|
raise serializers.ValidationError("Note content cannot be empty.")
|
||||||
|
return stripped
|
||||||
|
|
||||||
|
|
||||||
|
class NoteCreateSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serializer used for creating notes. Sets user from request context."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Note
|
||||||
|
fields = ["book", "page", "location_text", "content"]
|
||||||
|
|
||||||
|
def validate_page(self, value: int) -> int:
|
||||||
|
if value < 1:
|
||||||
|
raise serializers.ValidationError("Page must be a positive integer.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_content(self, value: str) -> str:
|
||||||
|
stripped = value.strip()
|
||||||
|
if not stripped:
|
||||||
|
raise serializers.ValidationError("Note content cannot be empty.")
|
||||||
|
return stripped
|
||||||
|
|
||||||
|
def create(self, validated_data):
|
||||||
|
validated_data["user"] = self.context["request"].user
|
||||||
|
return super().create(validated_data)
|
||||||
@@ -0,0 +1,331 @@
|
|||||||
|
"""Tests for the annotations app – Bookmarks & Notes API."""
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from django.urls import reverse
|
||||||
|
from rest_framework import status
|
||||||
|
from rest_framework.test import APIClient
|
||||||
|
|
||||||
|
from apps.annotations.models import Bookmark, Note
|
||||||
|
from apps.books.models import Book
|
||||||
|
from apps.users.models import User
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Fixtures
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def api_client() -> APIClient:
|
||||||
|
return APIClient()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def user() -> User:
|
||||||
|
return User.objects.create_user(
|
||||||
|
username="testuser",
|
||||||
|
email="test@example.com",
|
||||||
|
password="testpass123",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def other_user() -> User:
|
||||||
|
return User.objects.create_user(
|
||||||
|
username="other",
|
||||||
|
email="other@example.com",
|
||||||
|
password="testpass123",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def auth_client(api_client: APIClient, user: User) -> APIClient:
|
||||||
|
api_client.force_authenticate(user=user)
|
||||||
|
return api_client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def book() -> Book:
|
||||||
|
return Book.objects.create(
|
||||||
|
title="Test Book",
|
||||||
|
author="Test Author",
|
||||||
|
total_pages=300,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def bookmark(auth_client, user: User, book: Book) -> Bookmark:
|
||||||
|
return Bookmark.objects.create(
|
||||||
|
user=user,
|
||||||
|
book=book,
|
||||||
|
page=42,
|
||||||
|
location_text="important passage",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def note(auth_client, user: User, book: Book) -> Note:
|
||||||
|
return Note.objects.create(
|
||||||
|
user=user,
|
||||||
|
book=book,
|
||||||
|
page=15,
|
||||||
|
location_text="highlighted section",
|
||||||
|
content="This is my note about this section.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Bookmark tests
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestBookmarkList:
|
||||||
|
url = reverse("bookmark-list")
|
||||||
|
|
||||||
|
def test_unauthenticated_user_cannot_list(self, api_client: APIClient):
|
||||||
|
response = api_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_401_UNAUTHORIZED
|
||||||
|
|
||||||
|
def test_list_returns_user_bookmarks_only(
|
||||||
|
self, auth_client: APIClient, user: User, other_user: User, book: Book
|
||||||
|
):
|
||||||
|
Bookmark.objects.create(user=user, book=book, page=1)
|
||||||
|
Bookmark.objects.create(user=other_user, book=book, page=2)
|
||||||
|
|
||||||
|
response = auth_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
results = response.data["results"]
|
||||||
|
assert len(results) == 1
|
||||||
|
assert results[0]["page"] == 1
|
||||||
|
|
||||||
|
def test_list_returns_empty_when_no_bookmarks(
|
||||||
|
self, auth_client: APIClient
|
||||||
|
):
|
||||||
|
response = auth_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["count"] == 0
|
||||||
|
|
||||||
|
def test_list_orders_by_newest_first(
|
||||||
|
self, auth_client: APIClient, user: User, book: Book
|
||||||
|
):
|
||||||
|
b1 = Bookmark.objects.create(user=user, book=book, page=1)
|
||||||
|
b2 = Bookmark.objects.create(user=user, book=book, page=2)
|
||||||
|
response = auth_client.get(self.url)
|
||||||
|
results = response.data["results"]
|
||||||
|
assert results[0]["page"] == 2
|
||||||
|
assert results[1]["page"] == 1
|
||||||
|
|
||||||
|
def test_list_includes_book_title(
|
||||||
|
self, auth_client: APIClient, bookmark: Bookmark
|
||||||
|
):
|
||||||
|
response = auth_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["results"][0]["book_title"] == "Test Book"
|
||||||
|
|
||||||
|
|
||||||
|
class TestBookmarkCreate:
|
||||||
|
url = reverse("bookmark-list")
|
||||||
|
|
||||||
|
def test_create_bookmark(self, auth_client: APIClient, book: Book):
|
||||||
|
data = {"book": str(book.id), "page": 10, "location_text": "key insight"}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_201_CREATED
|
||||||
|
assert response.data["page"] == 10
|
||||||
|
|
||||||
|
def test_create_bookmark_without_location_text(
|
||||||
|
self, auth_client: APIClient, book: Book
|
||||||
|
):
|
||||||
|
data = {"book": str(book.id), "page": 5}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_201_CREATED
|
||||||
|
assert response.data["page"] == 5
|
||||||
|
|
||||||
|
def test_duplicate_bookmark_page_is_rejected(
|
||||||
|
self, auth_client: APIClient, bookmark: Bookmark
|
||||||
|
):
|
||||||
|
data = {"book": str(bookmark.book.id), "page": bookmark.page}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
||||||
|
|
||||||
|
def test_unauthenticated_user_cannot_create(
|
||||||
|
self, api_client: APIClient, book: Book
|
||||||
|
):
|
||||||
|
data = {"book": str(book.id), "page": 10}
|
||||||
|
response = api_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_401_UNAUTHORIZED
|
||||||
|
|
||||||
|
def test_invalid_page_rejected(
|
||||||
|
self, auth_client: APIClient, book: Book
|
||||||
|
):
|
||||||
|
data = {"book": str(book.id), "page": 0}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
||||||
|
|
||||||
|
|
||||||
|
class TestBookmarkDetail:
|
||||||
|
def test_get_bookmark(
|
||||||
|
self, auth_client: APIClient, bookmark: Bookmark
|
||||||
|
):
|
||||||
|
url = reverse("bookmark-detail", args=[str(bookmark.id)])
|
||||||
|
response = auth_client.get(url)
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["page"] == bookmark.page
|
||||||
|
|
||||||
|
def test_cannot_access_other_users_bookmark(
|
||||||
|
self, api_client: APIClient, other_user: User, bookmark: Bookmark
|
||||||
|
):
|
||||||
|
api_client.force_authenticate(user=other_user)
|
||||||
|
url = reverse("bookmark-detail", args=[str(bookmark.id)])
|
||||||
|
response = api_client.get(url)
|
||||||
|
assert response.status_code == status.HTTP_404_NOT_FOUND
|
||||||
|
|
||||||
|
|
||||||
|
class TestBookmarkDelete:
|
||||||
|
def test_delete_bookmark(
|
||||||
|
self, auth_client: APIClient, bookmark: Bookmark
|
||||||
|
):
|
||||||
|
url = reverse("bookmark-detail", args=[str(bookmark.id)])
|
||||||
|
response = auth_client.delete(url)
|
||||||
|
assert response.status_code == status.HTTP_204_NO_CONTENT
|
||||||
|
assert Bookmark.objects.count() == 0
|
||||||
|
|
||||||
|
def test_cannot_delete_other_users_bookmark(
|
||||||
|
self, api_client: APIClient, other_user: User, bookmark: Bookmark
|
||||||
|
):
|
||||||
|
api_client.force_authenticate(user=other_user)
|
||||||
|
url = reverse("bookmark-detail", args=[str(bookmark.id)])
|
||||||
|
response = api_client.delete(url)
|
||||||
|
assert response.status_code == status.HTTP_404_NOT_FOUND
|
||||||
|
|
||||||
|
|
||||||
|
class TestBookmarkFilterByBook:
|
||||||
|
def test_filter_by_book(
|
||||||
|
self, auth_client: APIClient, user: User, book: Book
|
||||||
|
):
|
||||||
|
other_book = Book.objects.create(title="Other", author="Other")
|
||||||
|
Bookmark.objects.create(user=user, book=book, page=1)
|
||||||
|
Bookmark.objects.create(user=user, book=other_book, page=2)
|
||||||
|
|
||||||
|
url = reverse("bookmark-list")
|
||||||
|
response = auth_client.get(url, {"book": str(book.id)})
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["count"] == 1
|
||||||
|
assert response.data["results"][0]["page"] == 1
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Note tests
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestNoteList:
|
||||||
|
url = reverse("note-list")
|
||||||
|
|
||||||
|
def test_unauthenticated_user_cannot_list(self, api_client: APIClient):
|
||||||
|
response = api_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_401_UNAUTHORIZED
|
||||||
|
|
||||||
|
def test_list_returns_user_notes_only(
|
||||||
|
self, auth_client: APIClient, user: User, other_user: User, book: Book
|
||||||
|
):
|
||||||
|
Note.objects.create(user=user, book=book, page=1, content="My note")
|
||||||
|
Note.objects.create(user=other_user, book=book, page=2, content="Other's note")
|
||||||
|
|
||||||
|
response = auth_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
results = response.data["results"]
|
||||||
|
assert len(results) == 1
|
||||||
|
assert results[0]["content"] == "My note"
|
||||||
|
|
||||||
|
def test_list_includes_book_title(
|
||||||
|
self, auth_client: APIClient, note: Note
|
||||||
|
):
|
||||||
|
response = auth_client.get(self.url)
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["results"][0]["book_title"] == "Test Book"
|
||||||
|
|
||||||
|
|
||||||
|
class TestNoteCreate:
|
||||||
|
url = reverse("note-list")
|
||||||
|
|
||||||
|
def test_create_note(self, auth_client: APIClient, book: Book):
|
||||||
|
data = {
|
||||||
|
"book": str(book.id),
|
||||||
|
"page": 20,
|
||||||
|
"location_text": "interesting part",
|
||||||
|
"content": "This is a thoughtful note.",
|
||||||
|
}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_201_CREATED
|
||||||
|
assert response.data["content"] == "This is a thoughtful note."
|
||||||
|
|
||||||
|
def test_create_note_without_location_text(
|
||||||
|
self, auth_client: APIClient, book: Book
|
||||||
|
):
|
||||||
|
data = {"book": str(book.id), "page": 20, "content": "A note."}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_201_CREATED
|
||||||
|
|
||||||
|
def test_empty_content_rejected(
|
||||||
|
self, auth_client: APIClient, book: Book
|
||||||
|
):
|
||||||
|
data = {"book": str(book.id), "page": 20, "content": " "}
|
||||||
|
response = auth_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
||||||
|
|
||||||
|
def test_unauthenticated_user_cannot_create(
|
||||||
|
self, api_client: APIClient, book: Book
|
||||||
|
):
|
||||||
|
data = {"book": str(book.id), "page": 20, "content": "Note"}
|
||||||
|
response = api_client.post(self.url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_401_UNAUTHORIZED
|
||||||
|
|
||||||
|
|
||||||
|
class TestNoteUpdate:
|
||||||
|
def test_update_note_content(
|
||||||
|
self, auth_client: APIClient, note: Note
|
||||||
|
):
|
||||||
|
url = reverse("note-detail", args=[str(note.id)])
|
||||||
|
data = {"content": "Updated note content."}
|
||||||
|
response = auth_client.patch(url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["content"] == "Updated note content."
|
||||||
|
|
||||||
|
def test_cannot_update_other_users_note(
|
||||||
|
self, api_client: APIClient, other_user: User, note: Note
|
||||||
|
):
|
||||||
|
api_client.force_authenticate(user=other_user)
|
||||||
|
url = reverse("note-detail", args=[str(note.id)])
|
||||||
|
data = {"content": "Hacked!"}
|
||||||
|
response = api_client.patch(url, data, format="json")
|
||||||
|
assert response.status_code == status.HTTP_404_NOT_FOUND
|
||||||
|
|
||||||
|
|
||||||
|
class TestNoteDelete:
|
||||||
|
def test_delete_note(self, auth_client: APIClient, note: Note):
|
||||||
|
url = reverse("note-detail", args=[str(note.id)])
|
||||||
|
response = auth_client.delete(url)
|
||||||
|
assert response.status_code == status.HTTP_204_NO_CONTENT
|
||||||
|
assert Note.objects.count() == 0
|
||||||
|
|
||||||
|
def test_batch_delete_notes(
|
||||||
|
self, auth_client: APIClient, user: User, book: Book
|
||||||
|
):
|
||||||
|
n1 = Note.objects.create(user=user, book=book, page=1, content="A")
|
||||||
|
n2 = Note.objects.create(user=user, book=book, page=2, content="B")
|
||||||
|
url = reverse("note-batch-delete")
|
||||||
|
response = auth_client.delete(url, {"ids": [str(n1.id), str(n2.id)]}, format="json")
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["deleted"] == 2
|
||||||
|
|
||||||
|
|
||||||
|
class TestNoteFilterByBook:
|
||||||
|
def test_filter_by_book(
|
||||||
|
self, auth_client: APIClient, user: User, book: Book
|
||||||
|
):
|
||||||
|
other_book = Book.objects.create(title="Other", author="Other")
|
||||||
|
Note.objects.create(user=user, book=book, page=1, content="In book")
|
||||||
|
Note.objects.create(user=user, book=other_book, page=2, content="In other")
|
||||||
|
|
||||||
|
url = reverse("note-list")
|
||||||
|
response = auth_client.get(url, {"book": str(book.id)})
|
||||||
|
assert response.status_code == status.HTTP_200_OK
|
||||||
|
assert response.data["count"] == 1
|
||||||
|
assert response.data["results"][0]["content"] == "In book"
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
from django.urls import include, path
|
||||||
|
from rest_framework.routers import DefaultRouter
|
||||||
|
|
||||||
|
from apps.annotations.views import BookmarkViewSet, NoteViewSet
|
||||||
|
|
||||||
|
router = DefaultRouter()
|
||||||
|
router.register(r"bookmarks", BookmarkViewSet, basename="bookmark")
|
||||||
|
router.register(r"notes", NoteViewSet, basename="note")
|
||||||
|
|
||||||
|
urlpatterns = [
|
||||||
|
path("", include(router.urls)),
|
||||||
|
]
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
from django_filters.rest_framework import DjangoFilterBackend
|
||||||
|
from rest_framework import status, viewsets
|
||||||
|
from rest_framework.decorators import action
|
||||||
|
from rest_framework.filters import OrderingFilter, SearchFilter
|
||||||
|
from rest_framework.permissions import IsAuthenticated
|
||||||
|
from rest_framework.response import Response
|
||||||
|
|
||||||
|
from apps.annotations.models import Bookmark, Note
|
||||||
|
from apps.annotations.permissions import IsOwner
|
||||||
|
from apps.annotations.serializers import (
|
||||||
|
BookmarkCreateSerializer,
|
||||||
|
BookmarkSerializer,
|
||||||
|
NoteCreateSerializer,
|
||||||
|
NoteSerializer,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class BookmarkViewSet(viewsets.ModelViewSet):
|
||||||
|
"""CRUD for user bookmarks. Users can only manage their own bookmarks."""
|
||||||
|
|
||||||
|
permission_classes = [IsAuthenticated, IsOwner]
|
||||||
|
filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter]
|
||||||
|
filterset_fields = ["book"]
|
||||||
|
search_fields = ["location_text"]
|
||||||
|
ordering_fields = ["created_at", "page"]
|
||||||
|
ordering = ["-created_at"]
|
||||||
|
|
||||||
|
def get_serializer_class(self):
|
||||||
|
if self.action == "create":
|
||||||
|
return BookmarkCreateSerializer
|
||||||
|
return BookmarkSerializer
|
||||||
|
|
||||||
|
def get_queryset(self):
|
||||||
|
return Bookmark.objects.filter(user=self.request.user).select_related(
|
||||||
|
"book"
|
||||||
|
)
|
||||||
|
|
||||||
|
def perform_create(self, serializer):
|
||||||
|
serializer.save(user=self.request.user)
|
||||||
|
|
||||||
|
@action(detail=False, methods=["delete"], url_path="batch-delete")
|
||||||
|
def batch_delete(self, request):
|
||||||
|
"""Delete multiple bookmarks by id list."""
|
||||||
|
ids = request.data.get("ids", [])
|
||||||
|
if not ids:
|
||||||
|
return Response(
|
||||||
|
{"detail": "No ids provided."}, status=status.HTTP_400_BAD_REQUEST
|
||||||
|
)
|
||||||
|
deleted, _ = Bookmark.objects.filter(
|
||||||
|
id__in=ids, user=request.user
|
||||||
|
).delete()
|
||||||
|
return Response(
|
||||||
|
{"deleted": deleted}, status=status.HTTP_200_OK
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class NoteViewSet(viewsets.ModelViewSet):
|
||||||
|
"""CRUD for user notes. Users can only manage their own notes."""
|
||||||
|
|
||||||
|
permission_classes = [IsAuthenticated, IsOwner]
|
||||||
|
filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter]
|
||||||
|
filterset_fields = ["book"]
|
||||||
|
search_fields = ["content", "location_text"]
|
||||||
|
ordering_fields = ["created_at", "page"]
|
||||||
|
ordering = ["-created_at"]
|
||||||
|
|
||||||
|
def get_serializer_class(self):
|
||||||
|
if self.action == "create":
|
||||||
|
return NoteCreateSerializer
|
||||||
|
return NoteSerializer
|
||||||
|
|
||||||
|
def get_queryset(self):
|
||||||
|
return Note.objects.filter(user=self.request.user).select_related(
|
||||||
|
"book"
|
||||||
|
)
|
||||||
|
|
||||||
|
def perform_create(self, serializer):
|
||||||
|
serializer.save(user=self.request.user)
|
||||||
|
|
||||||
|
@action(detail=False, methods=["delete"], url_path="batch-delete")
|
||||||
|
def batch_delete(self, request):
|
||||||
|
"""Delete multiple notes by id list."""
|
||||||
|
ids = request.data.get("ids", [])
|
||||||
|
if not ids:
|
||||||
|
return Response(
|
||||||
|
{"detail": "No ids provided."}, status=status.HTTP_400_BAD_REQUEST
|
||||||
|
)
|
||||||
|
deleted, _ = Note.objects.filter(
|
||||||
|
id__in=ids, user=request.user
|
||||||
|
).delete()
|
||||||
|
return Response(
|
||||||
|
{"deleted": deleted}, status=status.HTTP_200_OK
|
||||||
|
)
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
from django.contrib import admin
|
||||||
|
|
||||||
|
from apps.books.models import Book
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(Book)
|
||||||
|
class BookAdmin(admin.ModelAdmin):
|
||||||
|
list_display = ("title", "author", "total_pages", "created_at")
|
||||||
|
search_fields = ("title", "author")
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
from django.apps import AppConfig
|
||||||
|
|
||||||
|
|
||||||
|
class BooksConfig(AppConfig):
|
||||||
|
default_auto_field = "django.db.models.BigAutoField"
|
||||||
|
name = "apps.books"
|
||||||
|
label = "books"
|
||||||
@@ -0,0 +1,258 @@
|
|||||||
|
from django.conf import settings
|
||||||
|
from django.db import models
|
||||||
|
from django.db.models.signals import post_delete
|
||||||
|
from django.dispatch import receiver
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingStatus(models.TextChoices):
|
||||||
|
WANT_TO_READ = "want_to_read", "Want to Read"
|
||||||
|
READING = "reading", "Reading"
|
||||||
|
FINISHED = "finished", "Finished"
|
||||||
|
DNF = "dnf", "Did Not Finish"
|
||||||
|
|
||||||
|
|
||||||
|
class FontStyle(models.TextChoices):
|
||||||
|
SANS_SERIF = "sans-serif", "Sans Serif"
|
||||||
|
SERIF = "serif", "Serif"
|
||||||
|
MONOSPACE = "monospace", "Monospace"
|
||||||
|
|
||||||
|
|
||||||
|
class BackgroundColor(models.TextChoices):
|
||||||
|
WHITE = "#ffffff", "White"
|
||||||
|
SEPIA = "#f4e4c1", "Sepia"
|
||||||
|
DARK = "#1a1a2e", "Dark"
|
||||||
|
GREEN = "#c7edcc", "Green"
|
||||||
|
|
||||||
|
|
||||||
|
class Book(models.Model):
|
||||||
|
title = models.CharField(max_length=512, db_index=True)
|
||||||
|
author = models.CharField(max_length=256, blank=True, default="", db_index=True)
|
||||||
|
genre = models.CharField(max_length=128, blank=True, default="", db_index=True)
|
||||||
|
description = models.TextField(blank=True, default="")
|
||||||
|
reading_status = models.CharField(max_length=20, choices=ReadingStatus.choices, default=ReadingStatus.WANT_TO_READ, db_index=True)
|
||||||
|
total_pages = models.PositiveIntegerField(default=0)
|
||||||
|
cover_image = models.URLField(blank=True, default="")
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_book"
|
||||||
|
verbose_name = "Book"
|
||||||
|
verbose_name_plural = "Books"
|
||||||
|
ordering = ["title"]
|
||||||
|
indexes = [models.Index(fields=["title", "author", "genre"])]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return self.title
|
||||||
|
|
||||||
|
|
||||||
|
class EBook(models.Model):
|
||||||
|
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="ebooks")
|
||||||
|
title = models.CharField(max_length=512, db_index=True)
|
||||||
|
author = models.CharField(max_length=256, blank=True, default="", db_index=True)
|
||||||
|
format = models.CharField(max_length=20, blank=True, default="", editable=False)
|
||||||
|
page_count = models.PositiveIntegerField(default=0)
|
||||||
|
file_size = models.BigIntegerField(default=0)
|
||||||
|
metadata_json = models.JSONField(blank=True, default=dict)
|
||||||
|
file = models.FileField(upload_to="ebooks/%Y/%m/%d/")
|
||||||
|
cover_image = models.ImageField(upload_to="ebook_covers/%Y/%m/%d/", blank=True, null=True)
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_ebook"
|
||||||
|
verbose_name = "E-Book"
|
||||||
|
verbose_name_plural = "E-Books"
|
||||||
|
ordering = ["-created_at"]
|
||||||
|
indexes = [models.Index(fields=["user", "-created_at"])]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return self.title
|
||||||
|
|
||||||
|
def filename(self):
|
||||||
|
return Path(self.file.name).name if self.file else ""
|
||||||
|
|
||||||
|
|
||||||
|
class BookChapter(models.Model):
|
||||||
|
ebook = models.ForeignKey(EBook, on_delete=models.CASCADE, related_name="chapters")
|
||||||
|
title = models.CharField(max_length=512)
|
||||||
|
index = models.IntegerField(default=0)
|
||||||
|
href = models.CharField(max_length=1024, blank=True, default="")
|
||||||
|
children = models.JSONField(blank=True, default=list)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_book_chapter"
|
||||||
|
verbose_name = "Book Chapter"
|
||||||
|
verbose_name_plural = "Book Chapters"
|
||||||
|
ordering = ["index"]
|
||||||
|
indexes = [models.Index(fields=["ebook", "index"])]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"{self.ebook.title} - {self.title}"
|
||||||
|
|
||||||
|
|
||||||
|
@receiver(post_delete, sender=EBook)
|
||||||
|
def _auto_delete_ebook_file(sender, instance, **kwargs):
|
||||||
|
if instance.file:
|
||||||
|
instance.file.delete(save=False)
|
||||||
|
if instance.cover_image:
|
||||||
|
instance.cover_image.delete(save=False)
|
||||||
|
|
||||||
|
|
||||||
|
class DownloadRecord(models.Model):
|
||||||
|
"""Tracks book downloads for offline access management."""
|
||||||
|
|
||||||
|
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="download_records")
|
||||||
|
ebook = models.ForeignKey(EBook, on_delete=models.CASCADE, related_name="download_records")
|
||||||
|
file_size = models.BigIntegerField(default=0)
|
||||||
|
downloaded_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_download_record"
|
||||||
|
verbose_name = "Download Record"
|
||||||
|
verbose_name_plural = "Download Records"
|
||||||
|
ordering = ["-downloaded_at"]
|
||||||
|
unique_together = [("user", "ebook")]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"{self.user} - {self.ebook.title}"
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingProgress(models.Model):
|
||||||
|
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="reading_progress")
|
||||||
|
ebook = models.OneToOneField(EBook, on_delete=models.CASCADE, related_name="reading_progress")
|
||||||
|
current_position = models.FloatField(default=0.0)
|
||||||
|
last_page = models.IntegerField(default=0)
|
||||||
|
device_id = models.CharField(max_length=128, blank=True, default="")
|
||||||
|
device_name = models.CharField(max_length=128, blank=True, default="")
|
||||||
|
version = models.PositiveIntegerField(default=1)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_reading_progress"
|
||||||
|
verbose_name_plural = "reading progress"
|
||||||
|
unique_together = [("user", "ebook")]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"{self.ebook.title} - {self.current_position:.1f}%"
|
||||||
|
|
||||||
|
def update_with_sync(self, position: float, last_page: int,
|
||||||
|
device_id: str, device_name: str,
|
||||||
|
client_updated_at: str | None = None) -> tuple["ReadingProgress", bool]:
|
||||||
|
"""Update progress with conflict resolution (last-write-wins by timestamp).
|
||||||
|
|
||||||
|
Returns (instance, applied) where applied is True if the update was applied.
|
||||||
|
"""
|
||||||
|
if client_updated_at and self.updated_at:
|
||||||
|
try:
|
||||||
|
from django.utils.timezone import is_naive, make_aware
|
||||||
|
from datetime import datetime
|
||||||
|
client_dt = datetime.fromisoformat(client_updated_at.replace("Z", "+00:00"))
|
||||||
|
if is_naive(client_dt):
|
||||||
|
client_dt = make_aware(client_dt)
|
||||||
|
if client_dt <= self.updated_at:
|
||||||
|
return self, False
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
self.current_position = position
|
||||||
|
self.last_page = last_page
|
||||||
|
self.device_id = device_id
|
||||||
|
self.device_name = device_name
|
||||||
|
self.version += 1
|
||||||
|
self.save(update_fields=[
|
||||||
|
"current_position", "last_page",
|
||||||
|
"device_id", "device_name", "version", "updated_at",
|
||||||
|
])
|
||||||
|
return self, True
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettings(models.Model):
|
||||||
|
user = models.OneToOneField(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="reading_settings")
|
||||||
|
font_size = models.IntegerField(default=18)
|
||||||
|
font_style = models.CharField(max_length=20, choices=FontStyle.choices, default=FontStyle.SANS_SERIF.value)
|
||||||
|
background_color = models.CharField(max_length=7, choices=BackgroundColor.choices, default=BackgroundColor.WHITE.value)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_reading_settings"
|
||||||
|
verbose_name_plural = "reading settings"
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"Settings for {self.user}"
|
||||||
|
|
||||||
|
|
||||||
|
class Chapter(models.Model):
|
||||||
|
"""A chapter within a book, containing the text/markdown content.
|
||||||
|
|
||||||
|
This is distinct from BookChapter (which tracks EPUB TOC entries).
|
||||||
|
Chapter represents user-authored chapter content for a Book.
|
||||||
|
"""
|
||||||
|
|
||||||
|
book = models.ForeignKey(
|
||||||
|
Book,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="chapters",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
title = models.CharField(max_length=512)
|
||||||
|
number = models.PositiveIntegerField()
|
||||||
|
content = models.TextField(blank=True, default="")
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_chapter"
|
||||||
|
verbose_name = "Chapter"
|
||||||
|
verbose_name_plural = "Chapters"
|
||||||
|
ordering = ["book", "number"]
|
||||||
|
constraints = [
|
||||||
|
models.UniqueConstraint(
|
||||||
|
fields=["book", "number"],
|
||||||
|
name="uq_book_chapter_number",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"{self.book.title} — Ch. {self.number}: {self.title}"
|
||||||
|
|
||||||
|
|
||||||
|
class BookReadingProgress(models.Model):
|
||||||
|
"""Tracks a user's reading progress within a book's chapters.
|
||||||
|
|
||||||
|
This is distinct from ReadingProgress (which tracks ebook progress).
|
||||||
|
BookReadingProgress tracks chapter-based reading for Books.
|
||||||
|
"""
|
||||||
|
|
||||||
|
user = models.ForeignKey(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="book_reading_progress",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
book = models.ForeignKey(
|
||||||
|
Book,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="book_reading_progress",
|
||||||
|
db_index=True,
|
||||||
|
)
|
||||||
|
current_chapter = models.PositiveIntegerField(default=1)
|
||||||
|
current_position = models.PositiveIntegerField(default=0)
|
||||||
|
percentage = models.FloatField(default=0.0)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "books_book_reading_progress"
|
||||||
|
verbose_name = "Book Reading Progress"
|
||||||
|
verbose_name_plural = "Book Reading Progress"
|
||||||
|
ordering = ["-updated_at"]
|
||||||
|
constraints = [
|
||||||
|
models.UniqueConstraint(
|
||||||
|
fields=["user", "book"],
|
||||||
|
name="uq_book_reading_progress_user_book",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"{self.user} — {self.book.title} ({self.percentage:.0f}%)"
|
||||||
@@ -0,0 +1,228 @@
|
|||||||
|
from rest_framework import serializers
|
||||||
|
|
||||||
|
from apps.books.models import Book, BookChapter, BookReadingProgress, Chapter, EBook, FontStyle, BackgroundColor, ReadingProgress, ReadingSettings, ReadingStatus, DownloadRecord
|
||||||
|
|
||||||
|
|
||||||
|
class BookChapterSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = BookChapter
|
||||||
|
fields = ["id", "title", "index", "href", "children"]
|
||||||
|
|
||||||
|
|
||||||
|
class EBookContentSerializer(serializers.Serializer):
|
||||||
|
page = serializers.IntegerField()
|
||||||
|
total_pages = serializers.IntegerField()
|
||||||
|
content = serializers.CharField()
|
||||||
|
chapter_title = serializers.CharField()
|
||||||
|
format = serializers.CharField()
|
||||||
|
|
||||||
|
|
||||||
|
class EBookTocSerializer(serializers.Serializer):
|
||||||
|
chapters = serializers.ListField(child=BookChapterSerializer())
|
||||||
|
format = serializers.CharField()
|
||||||
|
page_count = serializers.IntegerField()
|
||||||
|
|
||||||
|
|
||||||
|
class BookListSerializer(serializers.ModelSerializer):
|
||||||
|
reading_status_display = serializers.CharField(source="get_reading_status_display", read_only=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Book
|
||||||
|
fields = ["id", "title", "author", "genre", "reading_status", "reading_status_display", "cover_image"]
|
||||||
|
|
||||||
|
|
||||||
|
class BookDetailSerializer(serializers.ModelSerializer):
|
||||||
|
reading_status_display = serializers.CharField(source="get_reading_status_display", read_only=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Book
|
||||||
|
fields = ["id", "title", "author", "genre", "description", "reading_status", "reading_status_display", "cover_image", "total_pages", "created_at", "updated_at"]
|
||||||
|
read_only_fields = ["id", "created_at", "updated_at"]
|
||||||
|
|
||||||
|
|
||||||
|
class BookSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = Book
|
||||||
|
fields = ["id", "title", "author", "genre", "description", "reading_status", "cover_image", "total_pages", "created_at", "updated_at"]
|
||||||
|
read_only_fields = ["id", "created_at", "updated_at"]
|
||||||
|
|
||||||
|
|
||||||
|
class EBookListSerializer(serializers.ModelSerializer):
|
||||||
|
filename = serializers.CharField(read_only=True)
|
||||||
|
format = serializers.CharField(read_only=True)
|
||||||
|
progress = serializers.SerializerMethodField()
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = EBook
|
||||||
|
fields = ["id", "title", "author", "filename", "format", "page_count", "file_size", "cover_image", "created_at", "progress"]
|
||||||
|
|
||||||
|
def get_progress(self, obj):
|
||||||
|
try:
|
||||||
|
return obj.reading_progress.current_position
|
||||||
|
except ReadingProgress.DoesNotExist:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class EBookDetailSerializer(serializers.ModelSerializer):
|
||||||
|
filename = serializers.CharField(read_only=True)
|
||||||
|
format = serializers.CharField(read_only=True)
|
||||||
|
file_url = serializers.SerializerMethodField()
|
||||||
|
progress = serializers.SerializerMethodField()
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = EBook
|
||||||
|
fields = ["id", "title", "author", "filename", "format", "page_count", "file_size", "file_url", "cover_image", "created_at", "updated_at", "progress"]
|
||||||
|
|
||||||
|
def get_file_url(self, obj):
|
||||||
|
request = self.context.get("request")
|
||||||
|
if request and obj.file:
|
||||||
|
return request.build_absolute_uri(obj.file.url)
|
||||||
|
return ""
|
||||||
|
|
||||||
|
def get_progress(self, obj):
|
||||||
|
try:
|
||||||
|
rp = obj.reading_progress
|
||||||
|
return {"current_position": rp.current_position, "last_page": rp.last_page}
|
||||||
|
except ReadingProgress.DoesNotExist:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class EBookUploadSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = EBook
|
||||||
|
fields = ["title", "author", "file", "cover_image"]
|
||||||
|
extra_kwargs = {"title": {"required": True}, "file": {"required": True}}
|
||||||
|
|
||||||
|
def validate_file(self, value):
|
||||||
|
import os
|
||||||
|
if value is None:
|
||||||
|
return value
|
||||||
|
ext = os.path.splitext(str(getattr(value, "name", "")))[1].lower()
|
||||||
|
if ext not in (".epub", ".pdf"):
|
||||||
|
raise serializers.ValidationError("Only EPUB and PDF files are supported.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def create(self, validated_data):
|
||||||
|
validated_data["user"] = self.context["request"].user
|
||||||
|
# Auto-detect format from file extension
|
||||||
|
import os
|
||||||
|
name = str(getattr(validated_data.get("file"), "name", ""))
|
||||||
|
ext = os.path.splitext(name)[1].lower().lstrip(".")
|
||||||
|
if ext:
|
||||||
|
validated_data["format"] = ext
|
||||||
|
return super().create(validated_data)
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingProgressSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = ReadingProgress
|
||||||
|
fields = ["current_position", "last_page", "device_id", "device_name", "version", "updated_at"]
|
||||||
|
read_only_fields = ["version", "updated_at"]
|
||||||
|
extra_kwargs = {"current_position": {"required": True, "min_value": 0.0, "max_value": 100.0}}
|
||||||
|
|
||||||
|
def validate_current_position(self, value):
|
||||||
|
if value < 0.0 or value > 100.0:
|
||||||
|
raise serializers.ValidationError("Position must be between 0.0 and 100.0.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettingsSerializer(serializers.ModelSerializer):
|
||||||
|
class Meta:
|
||||||
|
model = ReadingSettings
|
||||||
|
fields = ["font_size", "font_style", "background_color"]
|
||||||
|
|
||||||
|
def validate_font_size(self, value):
|
||||||
|
if value < 12 or value > 36:
|
||||||
|
raise serializers.ValidationError("Font size must be between 12 and 36.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_font_style(self, value):
|
||||||
|
valid = [s.value for s in FontStyle]
|
||||||
|
if value not in valid:
|
||||||
|
raise serializers.ValidationError(f"Font style must be one of: {', '.join(valid)}")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_background_color(self, value):
|
||||||
|
valid = [c.value for c in BackgroundColor]
|
||||||
|
if value not in valid:
|
||||||
|
raise serializers.ValidationError(f"Background color must be one of: {', '.join(valid)}")
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
class DownloadRecordSerializer(serializers.ModelSerializer):
|
||||||
|
ebook_id = serializers.IntegerField(source="ebook.id", read_only=True)
|
||||||
|
ebook_title = serializers.CharField(source="ebook.title", read_only=True)
|
||||||
|
author = serializers.CharField(source="ebook.author", read_only=True)
|
||||||
|
filename = serializers.SerializerMethodField()
|
||||||
|
cover_image = serializers.ImageField(source="ebook.cover_image", read_only=True)
|
||||||
|
format = serializers.CharField(source="ebook.format", read_only=True)
|
||||||
|
progress = serializers.SerializerMethodField()
|
||||||
|
file_url = serializers.SerializerMethodField()
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = DownloadRecord
|
||||||
|
fields = [
|
||||||
|
"id", "ebook_id", "ebook_title", "author", "filename", "file_url",
|
||||||
|
"file_size", "cover_image", "format", "downloaded_at", "progress",
|
||||||
|
]
|
||||||
|
|
||||||
|
def get_filename(self, obj):
|
||||||
|
return obj.ebook.filename()
|
||||||
|
|
||||||
|
def get_file_url(self, obj):
|
||||||
|
request = self.context.get("request")
|
||||||
|
if request and obj.ebook.file:
|
||||||
|
return request.build_absolute_uri(obj.ebook.file.url)
|
||||||
|
return ""
|
||||||
|
|
||||||
|
def get_progress(self, obj):
|
||||||
|
try:
|
||||||
|
rp = obj.ebook.reading_progress
|
||||||
|
return {"current_position": rp.current_position, "last_page": rp.last_page}
|
||||||
|
except ReadingProgress.DoesNotExist:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class StorageSummarySerializer(serializers.Serializer):
|
||||||
|
total_downloads = serializers.IntegerField()
|
||||||
|
total_size_bytes = serializers.IntegerField()
|
||||||
|
ebooks = serializers.ListField(child=serializers.DictField())
|
||||||
|
|
||||||
|
|
||||||
|
class ChapterSummarySerializer(serializers.ModelSerializer):
|
||||||
|
"""Compact serializer for TOC listing — no content body."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Chapter
|
||||||
|
fields = ["id", "book", "title", "number"]
|
||||||
|
|
||||||
|
|
||||||
|
class ChapterDetailSerializer(serializers.ModelSerializer):
|
||||||
|
"""Full serializer with chapter content for reading view."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Chapter
|
||||||
|
fields = ["id", "book", "title", "number", "content", "created_at", "updated_at"]
|
||||||
|
read_only_fields = ["id", "created_at", "updated_at"]
|
||||||
|
|
||||||
|
|
||||||
|
class BookReadingProgressSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serialize chapter-based reading progress for a book."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = BookReadingProgress
|
||||||
|
fields = [
|
||||||
|
"id", "book", "current_chapter", "current_position",
|
||||||
|
"percentage", "updated_at",
|
||||||
|
]
|
||||||
|
read_only_fields = ["id", "updated_at"]
|
||||||
|
|
||||||
|
def validate_percentage(self, value):
|
||||||
|
if value < 0.0 or value > 100.0:
|
||||||
|
raise serializers.ValidationError("Percentage must be between 0 and 100.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_current_chapter(self, value):
|
||||||
|
if value < 1:
|
||||||
|
raise serializers.ValidationError("Chapter number must be positive.")
|
||||||
|
return value
|
||||||
@@ -1,12 +1,10 @@
|
|||||||
from django.urls import include, path
|
from django.urls import include, path
|
||||||
from rest_framework.routers import DefaultRouter
|
from rest_framework.routers import DefaultRouter
|
||||||
|
|
||||||
from . import views
|
from apps.books.views import BookViewSet
|
||||||
|
|
||||||
router = DefaultRouter()
|
router = DefaultRouter()
|
||||||
router.register("", views.DocumentViewSet, basename="document")
|
router.register(r"", BookViewSet, basename="book")
|
||||||
|
|
||||||
app_name = "documents"
|
|
||||||
|
|
||||||
urlpatterns = [
|
urlpatterns = [
|
||||||
path("", include(router.urls)),
|
path("", include(router.urls)),
|
||||||
@@ -0,0 +1,341 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from django.db.models import QuerySet, Q
|
||||||
|
from django_filters.rest_framework import DjangoFilterBackend
|
||||||
|
from rest_framework import parsers, permissions, status, viewsets
|
||||||
|
from rest_framework.decorators import action
|
||||||
|
from rest_framework.filters import OrderingFilter, SearchFilter
|
||||||
|
from rest_framework.permissions import AllowAny, IsAuthenticated
|
||||||
|
from rest_framework.request import Request
|
||||||
|
from rest_framework.response import Response
|
||||||
|
|
||||||
|
from apps.books.models import Book, BookChapter, BookReadingProgress, DownloadRecord, EBook, Chapter, ReadingProgress, ReadingSettings
|
||||||
|
from apps.books.serializers import (
|
||||||
|
BookChapterSerializer, BookDetailSerializer, BookListSerializer, BookSerializer,
|
||||||
|
BookReadingProgressSerializer, ChapterDetailSerializer, ChapterSummarySerializer,
|
||||||
|
DownloadRecordSerializer, EBookContentSerializer, EBookDetailSerializer,
|
||||||
|
EBookListSerializer, EBookTocSerializer, EBookUploadSerializer,
|
||||||
|
ReadingProgressSerializer, ReadingSettingsSerializer, StorageSummarySerializer,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class BookViewSet(viewsets.ModelViewSet):
|
||||||
|
queryset = Book.objects.all()
|
||||||
|
permission_classes = [IsAuthenticated]
|
||||||
|
filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter]
|
||||||
|
filterset_fields = ["author", "genre", "reading_status"]
|
||||||
|
search_fields = ["title", "author", "genre"]
|
||||||
|
ordering_fields = ["title", "author", "genre", "created_at"]
|
||||||
|
ordering = ["title"]
|
||||||
|
|
||||||
|
def get_serializer_class(self):
|
||||||
|
if self.action == "retrieve":
|
||||||
|
return BookDetailSerializer
|
||||||
|
if self.action == "list":
|
||||||
|
return BookListSerializer
|
||||||
|
return BookSerializer
|
||||||
|
|
||||||
|
def get_queryset(self) -> QuerySet[Book]:
|
||||||
|
qs = super().get_queryset()
|
||||||
|
query = self.request.query_params.get("q", "").strip()
|
||||||
|
if query:
|
||||||
|
qs = qs.filter(Q(title__icontains=query) | Q(author__icontains=query) | Q(genre__icontains=query))
|
||||||
|
return qs
|
||||||
|
|
||||||
|
@action(detail=False, methods=["get"], permission_classes=[AllowAny])
|
||||||
|
def genres(self, request: Request) -> Response:
|
||||||
|
genre_list = Book.objects.values_list("genre", flat=True).distinct().order_by("genre")
|
||||||
|
return Response([g for g in genre_list if g])
|
||||||
|
|
||||||
|
@action(detail=False, methods=["get"], permission_classes=[AllowAny])
|
||||||
|
def authors(self, request: Request) -> Response:
|
||||||
|
author_list = Book.objects.values_list("author", flat=True).distinct().order_by("author")
|
||||||
|
return Response([a for a in author_list if a])
|
||||||
|
|
||||||
|
@action(detail=False, methods=["get"])
|
||||||
|
def storage(self, request: Request) -> Response:
|
||||||
|
"""Return storage usage summary for the current user."""
|
||||||
|
download_records = DownloadRecord.objects.filter(user=request.user).select_related("ebook")
|
||||||
|
total_size = sum(r.file_size for r in download_records)
|
||||||
|
ebook_list = [
|
||||||
|
{"id": r.ebook.id, "title": r.ebook.title, "file_size": r.file_size}
|
||||||
|
for r in download_records
|
||||||
|
]
|
||||||
|
serializer = StorageSummarySerializer(data={
|
||||||
|
"total_downloads": download_records.count(),
|
||||||
|
"total_size_bytes": total_size,
|
||||||
|
"ebooks": ebook_list,
|
||||||
|
})
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get"])
|
||||||
|
def chapters(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""List all chapters for this book (TOC)."""
|
||||||
|
book = self.get_object()
|
||||||
|
chapter_qs = Chapter.objects.filter(book=book).order_by("number")
|
||||||
|
serializer = ChapterSummarySerializer(chapter_qs, many=True)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get"], url_path=r"chapters/(?P<chapter_number>[0-9]+)")
|
||||||
|
def chapter_detail(self, request: Request, pk: int | None = None, chapter_number: str | None = None) -> Response:
|
||||||
|
"""Get a specific chapter with full content."""
|
||||||
|
book = self.get_object()
|
||||||
|
try:
|
||||||
|
chapter = Chapter.objects.get(book=book, number=int(chapter_number or "0"))
|
||||||
|
except Chapter.DoesNotExist:
|
||||||
|
return Response(
|
||||||
|
{"detail": "Chapter not found."}, status=status.HTTP_404_NOT_FOUND
|
||||||
|
)
|
||||||
|
serializer = ChapterDetailSerializer(chapter)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get", "put"])
|
||||||
|
def progress(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""Get or update chapter-based reading progress for this book."""
|
||||||
|
book = self.get_object()
|
||||||
|
progress_obj, _created = BookReadingProgress.objects.get_or_create(
|
||||||
|
user=request.user, book=book
|
||||||
|
)
|
||||||
|
|
||||||
|
if request.method == "GET":
|
||||||
|
serializer = BookReadingProgressSerializer(progress_obj)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
serializer = BookReadingProgressSerializer(
|
||||||
|
progress_obj, data=request.data, partial=True
|
||||||
|
)
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
serializer.save()
|
||||||
|
return Response(serializer.data, status=status.HTTP_200_OK)
|
||||||
|
|
||||||
|
|
||||||
|
class IsEBookOwner(permissions.BasePermission):
|
||||||
|
def has_object_permission(self, request: Request, view: object, obj: EBook) -> bool:
|
||||||
|
return obj.user == request.user
|
||||||
|
|
||||||
|
|
||||||
|
class EBookViewSet(viewsets.ModelViewSet):
|
||||||
|
parser_classes = [parsers.MultiPartParser, parsers.FormParser, parsers.JSONParser]
|
||||||
|
permission_classes = [IsAuthenticated, IsEBookOwner]
|
||||||
|
|
||||||
|
def get_serializer_class(self):
|
||||||
|
if self.action == "create":
|
||||||
|
return EBookUploadSerializer
|
||||||
|
if self.action in ("list",):
|
||||||
|
return EBookListSerializer
|
||||||
|
if self.action in ("toc",):
|
||||||
|
return BookChapterSerializer
|
||||||
|
return EBookDetailSerializer
|
||||||
|
|
||||||
|
def get_queryset(self):
|
||||||
|
return EBook.objects.filter(user=self.request.user).select_related("reading_progress", "user")
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get", "patch"])
|
||||||
|
def progress(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
ebook = self.get_object()
|
||||||
|
progress_obj, _created = ReadingProgress.objects.get_or_create(user=request.user, ebook=ebook)
|
||||||
|
if request.method == "GET":
|
||||||
|
serializer = ReadingProgressSerializer(progress_obj)
|
||||||
|
return Response(serializer.data)
|
||||||
|
serializer = ReadingProgressSerializer(progress_obj, data=request.data, partial=True)
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
serializer.save()
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
@action(detail=True, methods=["post"])
|
||||||
|
def process(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""Trigger e-book processing: metadata extraction, TOC building, page counting."""
|
||||||
|
ebook = self.get_object()
|
||||||
|
if not ebook.file:
|
||||||
|
return Response({"error": "No file found for this e-book."}, status=status.HTTP_400_BAD_REQUEST)
|
||||||
|
|
||||||
|
try:
|
||||||
|
from apps.books.services import process_ebook
|
||||||
|
|
||||||
|
file_path = ebook.file.path
|
||||||
|
result = process_ebook(file_path, original_filename=ebook.filename())
|
||||||
|
|
||||||
|
# Update ebook with extracted data
|
||||||
|
ebook.format = result.get("format", ebook.format)
|
||||||
|
ebook.page_count = result.get("page_count", 0)
|
||||||
|
ebook.metadata_json = result.get("metadata", {})
|
||||||
|
ebook.save(update_fields=["format", "page_count", "metadata_json", "updated_at"])
|
||||||
|
|
||||||
|
# Store chapters in DB
|
||||||
|
raw_toc: list[dict[str, Any]] = result.get("toc", [])
|
||||||
|
BookChapter.objects.filter(ebook=ebook).delete()
|
||||||
|
_store_chapters(ebook, raw_toc)
|
||||||
|
|
||||||
|
return Response({
|
||||||
|
"format": ebook.format,
|
||||||
|
"page_count": ebook.page_count,
|
||||||
|
"metadata": ebook.metadata_json,
|
||||||
|
"toc_count": len(raw_toc),
|
||||||
|
"status": "processed",
|
||||||
|
})
|
||||||
|
except Exception as exc:
|
||||||
|
logger.exception("Failed to process ebook %s", ebook.id)
|
||||||
|
return Response({"error": f"Processing failed: {exc}"}, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get"])
|
||||||
|
def toc(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""Return hierarchical table of contents."""
|
||||||
|
ebook = self.get_object()
|
||||||
|
chapters = BookChapter.objects.filter(ebook=ebook).order_by("index").select_related("ebook")
|
||||||
|
serializer = BookChapterSerializer(chapters, many=True)
|
||||||
|
return Response({
|
||||||
|
"chapters": serializer.data,
|
||||||
|
"format": ebook.format,
|
||||||
|
"page_count": ebook.page_count,
|
||||||
|
})
|
||||||
|
|
||||||
|
@action(detail=True, methods=["get"])
|
||||||
|
def content(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""Return paginated content for a given page number.
|
||||||
|
|
||||||
|
Query params:
|
||||||
|
page (int): page/chapter index to fetch (1-indexed, default: 1)
|
||||||
|
"""
|
||||||
|
ebook = self.get_object()
|
||||||
|
page = max(1, int(request.query_params.get("page", 1)))
|
||||||
|
|
||||||
|
chapters = list(BookChapter.objects.filter(ebook=ebook).order_by("index").select_related("ebook"))
|
||||||
|
total_pages = len(chapters) or ebook.page_count or 1
|
||||||
|
|
||||||
|
chapter: BookChapter | None = None
|
||||||
|
chapter_title = ""
|
||||||
|
content_html = ""
|
||||||
|
|
||||||
|
if chapters and 0 <= page - 1 < len(chapters):
|
||||||
|
ch = chapters[page - 1]
|
||||||
|
chapter_title = ch.title
|
||||||
|
content_html = _fetch_chapter_content(ebook, ch)
|
||||||
|
|
||||||
|
serializer = EBookContentSerializer(data={
|
||||||
|
"page": page,
|
||||||
|
"total_pages": total_pages,
|
||||||
|
"content": content_html,
|
||||||
|
"chapter_title": chapter_title,
|
||||||
|
"format": ebook.format,
|
||||||
|
})
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
@action(detail=True, methods=["post"])
|
||||||
|
def download(self, request: Request, pk: int | None = None) -> Response:
|
||||||
|
"""Track download of an e-book. Creates a DownloadRecord and returns file info."""
|
||||||
|
ebook = self.get_object()
|
||||||
|
if not ebook.file:
|
||||||
|
return Response({"error": "No file found for this e-book."}, status=status.HTTP_400_BAD_REQUEST)
|
||||||
|
|
||||||
|
download, created = DownloadRecord.objects.get_or_create(
|
||||||
|
user=request.user,
|
||||||
|
ebook=ebook,
|
||||||
|
defaults={"file_size": ebook.file.size if ebook.file else 0},
|
||||||
|
)
|
||||||
|
if not created:
|
||||||
|
download.file_size = ebook.file.size if ebook.file else 0
|
||||||
|
download.save(update_fields=["file_size"])
|
||||||
|
|
||||||
|
serializer = DownloadRecordSerializer(download, context={"request": request})
|
||||||
|
return Response(serializer.data, status=status.HTTP_200_OK)
|
||||||
|
|
||||||
|
@action(detail=False, methods=["get"])
|
||||||
|
def downloads(self, request: Request) -> Response:
|
||||||
|
"""List all e-books the current user has downloaded."""
|
||||||
|
records = DownloadRecord.objects.filter(user=request.user).select_related(
|
||||||
|
"ebook", "ebook__reading_progress"
|
||||||
|
).prefetch_related("ebook__chapters")
|
||||||
|
page = self.paginate_queryset(records)
|
||||||
|
if page is not None:
|
||||||
|
serializer = DownloadRecordSerializer(page, many=True, context={"request": request})
|
||||||
|
return self.get_paginated_response(serializer.data)
|
||||||
|
serializer = DownloadRecordSerializer(records, many=True, context={"request": request})
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
@action(detail=False, methods=["delete"], url_path="downloads/(?P<download_pk>[^/.]+)")
|
||||||
|
def delete_download(self, request: Request, download_pk: str | None = None) -> Response:
|
||||||
|
"""Delete a download record."""
|
||||||
|
try:
|
||||||
|
download = DownloadRecord.objects.get(pk=download_pk, user=request.user)
|
||||||
|
except DownloadRecord.DoesNotExist:
|
||||||
|
return Response({"error": "Download record not found."}, status=status.HTTP_404_NOT_FOUND)
|
||||||
|
download.delete()
|
||||||
|
return Response(status=status.HTTP_204_NO_CONTENT)
|
||||||
|
|
||||||
|
|
||||||
|
def _store_chapters(ebook: EBook, toc: list[dict[str, Any]], parent_index: int = 0) -> None:
|
||||||
|
"""Recursively store TOC entries as BookChapter records."""
|
||||||
|
for idx, entry in enumerate(toc):
|
||||||
|
BookChapter.objects.create(
|
||||||
|
ebook=ebook,
|
||||||
|
title=entry.get("title", "Untitled"),
|
||||||
|
index=parent_index + idx,
|
||||||
|
href=entry.get("href", ""),
|
||||||
|
children=entry.get("children", []),
|
||||||
|
)
|
||||||
|
children = entry.get("children", [])
|
||||||
|
if children:
|
||||||
|
_store_chapters(ebook, children, parent_index + idx + 1)
|
||||||
|
|
||||||
|
|
||||||
|
def _fetch_chapter_content(ebook: EBook, chapter: BookChapter) -> str:
|
||||||
|
"""Fetch HTML content for a chapter from the e-book file."""
|
||||||
|
if ebook.format == "epub":
|
||||||
|
return _fetch_epub_chapter_content(ebook.file.path, chapter)
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def _fetch_epub_chapter_content(file_path: str, chapter: BookChapter) -> str:
|
||||||
|
"""Extract HTML content of a specific EPUB chapter by href."""
|
||||||
|
try:
|
||||||
|
from ebooklib import epub
|
||||||
|
from bs4 import BeautifulSoup
|
||||||
|
except ImportError:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
try:
|
||||||
|
book = epub.read_epub(file_path)
|
||||||
|
href = chapter.href or ""
|
||||||
|
# Find the item by href
|
||||||
|
for item in book.get_items():
|
||||||
|
item_name = item.get_name() or ""
|
||||||
|
if href and (item_name.endswith(href) or href.endswith(item_name)):
|
||||||
|
content = item.get_content()
|
||||||
|
soup = BeautifulSoup(content, "html.parser")
|
||||||
|
# Clean up — remove body/html/head wrappers, keep inner content
|
||||||
|
body = soup.find("body")
|
||||||
|
if body:
|
||||||
|
return str(body)
|
||||||
|
return str(soup)
|
||||||
|
return ""
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Failed to fetch EPUB chapter content for %s", chapter.href)
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettingsViewSet(viewsets.GenericViewSet):
|
||||||
|
permission_classes = [IsAuthenticated]
|
||||||
|
serializer_class = ReadingSettingsSerializer
|
||||||
|
|
||||||
|
def get_queryset(self):
|
||||||
|
return ReadingSettings.objects.filter(user=self.request.user)
|
||||||
|
|
||||||
|
def list(self, request: Request) -> Response:
|
||||||
|
settings_obj, _created = ReadingSettings.objects.get_or_create(user=request.user)
|
||||||
|
serializer = self.get_serializer(settings_obj)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
def partial_update(self, request: Request) -> Response:
|
||||||
|
settings_obj, _created = ReadingSettings.objects.get_or_create(user=request.user)
|
||||||
|
serializer = self.get_serializer(settings_obj, data=request.data, partial=True)
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
serializer.save()
|
||||||
|
return Response(serializer.data)
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
from django.contrib import admin
|
|
||||||
|
|
||||||
from .models import Collection
|
|
||||||
|
|
||||||
|
|
||||||
@admin.register(Collection)
|
|
||||||
class CollectionAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ["name", "owner", "document_count", "is_public", "created_at"]
|
|
||||||
list_filter = ["is_public"]
|
|
||||||
search_fields = ["name", "description"]
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
from django.conf import settings
|
|
||||||
from django.db import models
|
|
||||||
|
|
||||||
|
|
||||||
class Collection(models.Model):
|
|
||||||
"""A user-created collection of documents."""
|
|
||||||
name = models.CharField(max_length=300)
|
|
||||||
description = models.TextField(blank=True, default="")
|
|
||||||
cover = models.ImageField(upload_to="collection_covers/", blank=True, null=True)
|
|
||||||
documents = models.ManyToManyField(
|
|
||||||
"documents.Document",
|
|
||||||
related_name="collections",
|
|
||||||
blank=True,
|
|
||||||
)
|
|
||||||
is_public = models.BooleanField(default=False)
|
|
||||||
owner = models.ForeignKey(
|
|
||||||
settings.AUTH_USER_MODEL,
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="collections",
|
|
||||||
)
|
|
||||||
created_at = models.DateTimeField(auto_now_add=True)
|
|
||||||
updated_at = models.DateTimeField(auto_now=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
db_table = "collections_collection"
|
|
||||||
ordering = ["-updated_at"]
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return self.name
|
|
||||||
|
|
||||||
@property
|
|
||||||
def document_count(self) -> int:
|
|
||||||
return self.documents.count()
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cover_url(self) -> str | None:
|
|
||||||
if self.cover:
|
|
||||||
return self.cover.url
|
|
||||||
return None
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
from rest_framework import serializers
|
|
||||||
|
|
||||||
from .models import Collection
|
|
||||||
|
|
||||||
|
|
||||||
class CollectionSerializer(serializers.ModelSerializer[Collection]):
|
|
||||||
cover_url = serializers.SerializerMethodField()
|
|
||||||
document_count = serializers.IntegerField(read_only=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = Collection
|
|
||||||
fields = [
|
|
||||||
"id", "name", "description", "cover_url", "document_count",
|
|
||||||
"is_public", "created_at", "updated_at",
|
|
||||||
]
|
|
||||||
read_only_fields = ["id", "document_count", "created_at", "updated_at"]
|
|
||||||
|
|
||||||
def get_cover_url(self, obj: Collection) -> str | None:
|
|
||||||
return obj.cover_url
|
|
||||||
|
|
||||||
|
|
||||||
class CollectionDetailSerializer(CollectionSerializer):
|
|
||||||
documents = serializers.PrimaryKeyRelatedField(many=True, read_only=True)
|
|
||||||
|
|
||||||
class Meta(CollectionSerializer.Meta):
|
|
||||||
fields = CollectionSerializer.Meta.fields + ["documents", "owner"]
|
|
||||||
|
|
||||||
|
|
||||||
class CollectionDocumentActionSerializer(serializers.Serializer):
|
|
||||||
document_ids = serializers.ListField(
|
|
||||||
child=serializers.IntegerField(),
|
|
||||||
allow_empty=False,
|
|
||||||
)
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
from django.urls import include, path
|
|
||||||
from rest_framework.routers import DefaultRouter
|
|
||||||
|
|
||||||
from . import views
|
|
||||||
|
|
||||||
router = DefaultRouter()
|
|
||||||
router.register("", views.CollectionViewSet, basename="collection")
|
|
||||||
|
|
||||||
app_name = "collections"
|
|
||||||
|
|
||||||
urlpatterns = [
|
|
||||||
path("", include(router.urls)),
|
|
||||||
]
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
from rest_framework import permissions, status, viewsets
|
|
||||||
from rest_framework.decorators import action
|
|
||||||
from rest_framework.response import Response
|
|
||||||
|
|
||||||
from apps.documents.models import Document
|
|
||||||
|
|
||||||
from .models import Collection
|
|
||||||
from .serializers import (
|
|
||||||
CollectionDetailSerializer,
|
|
||||||
CollectionDocumentActionSerializer,
|
|
||||||
CollectionSerializer,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class CollectionViewSet(viewsets.ModelViewSet):
|
|
||||||
"""CRUD for user collections."""
|
|
||||||
permission_classes = [permissions.IsAuthenticated]
|
|
||||||
|
|
||||||
def get_serializer_class(self):
|
|
||||||
if self.action in ("retrieve", "update", "partial_update"):
|
|
||||||
return CollectionDetailSerializer
|
|
||||||
return CollectionSerializer
|
|
||||||
|
|
||||||
def get_queryset(self):
|
|
||||||
return Collection.objects.filter(owner=self.request.user).prefetch_related("documents")
|
|
||||||
|
|
||||||
def perform_create(self, serializer):
|
|
||||||
serializer.save(owner=self.request.user)
|
|
||||||
|
|
||||||
@action(detail=True, methods=["post"])
|
|
||||||
def add_documents(self, request, pk=None):
|
|
||||||
"""Add documents to a collection."""
|
|
||||||
collection = self.get_object()
|
|
||||||
serializer = CollectionDocumentActionSerializer(data=request.data)
|
|
||||||
serializer.is_valid(raise_exception=True)
|
|
||||||
docs = Document.objects.filter(
|
|
||||||
id__in=serializer.validated_data["document_ids"],
|
|
||||||
owner=request.user,
|
|
||||||
)
|
|
||||||
collection.documents.add(*docs)
|
|
||||||
return Response({"detail": f"Added {docs.count()} document(s)."}, status=status.HTTP_200_OK)
|
|
||||||
|
|
||||||
@action(detail=True, methods=["post"])
|
|
||||||
def remove_documents(self, request, pk=None):
|
|
||||||
"""Remove documents from a collection."""
|
|
||||||
collection = self.get_object()
|
|
||||||
serializer = CollectionDocumentActionSerializer(data=request.data)
|
|
||||||
serializer.is_valid(raise_exception=True)
|
|
||||||
collection.documents.remove(*serializer.validated_data["document_ids"])
|
|
||||||
return Response({"detail": "Documents removed."}, status=status.HTTP_200_OK)
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
from django.contrib import admin
|
|
||||||
|
|
||||||
from .models import Document
|
|
||||||
|
|
||||||
|
|
||||||
@admin.register(Document)
|
|
||||||
class DocumentAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ["title", "author", "file_type", "file_size", "is_public", "owner", "uploaded_at"]
|
|
||||||
list_filter = ["file_type", "is_public"]
|
|
||||||
search_fields = ["title", "author", "description"]
|
|
||||||
date_hierarchy = "uploaded_at"
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
from django.conf import settings
|
|
||||||
from django.db import models
|
|
||||||
|
|
||||||
|
|
||||||
class Document(models.Model):
|
|
||||||
"""A digital document (ebook, PDF, etc.) uploaded by a user."""
|
|
||||||
|
|
||||||
class FileType(models.TextChoices):
|
|
||||||
PDF = "pdf", "PDF"
|
|
||||||
EPUB = "epub", "EPUB"
|
|
||||||
MOBI = "mobi", "MOBI"
|
|
||||||
TXT = "txt", "Plain Text"
|
|
||||||
DOCX = "docx", "Word Document"
|
|
||||||
|
|
||||||
title = models.CharField(max_length=500)
|
|
||||||
author = models.CharField(max_length=300, blank=True, null=True)
|
|
||||||
description = models.TextField(blank=True, default="")
|
|
||||||
cover = models.ImageField(upload_to="covers/", blank=True, null=True)
|
|
||||||
file = models.FileField(upload_to="documents/")
|
|
||||||
file_type = models.CharField(max_length=10, choices=FileType.choices)
|
|
||||||
file_size = models.PositiveIntegerField(help_text="File size in bytes")
|
|
||||||
page_count = models.PositiveIntegerField(blank=True, null=True)
|
|
||||||
tags = models.JSONField(default=list, blank=True)
|
|
||||||
is_public = models.BooleanField(default=False)
|
|
||||||
owner = models.ForeignKey(
|
|
||||||
settings.AUTH_USER_MODEL,
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="documents",
|
|
||||||
)
|
|
||||||
uploaded_at = models.DateTimeField(auto_now_add=True)
|
|
||||||
updated_at = models.DateTimeField(auto_now=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
db_table = "documents_document"
|
|
||||||
ordering = ["-uploaded_at"]
|
|
||||||
indexes = [
|
|
||||||
models.Index(fields=["owner", "-uploaded_at"]),
|
|
||||||
models.Index(fields=["file_type"]),
|
|
||||||
]
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return self.title
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cover_url(self) -> str | None:
|
|
||||||
if self.cover:
|
|
||||||
return self.cover.url
|
|
||||||
return None
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
from rest_framework import serializers
|
|
||||||
|
|
||||||
from .models import Document
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentListSerializer(serializers.ModelSerializer[Document]):
|
|
||||||
cover_url = serializers.SerializerMethodField()
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = Document
|
|
||||||
fields = [
|
|
||||||
"id", "title", "author", "cover_url", "description",
|
|
||||||
"file_type", "file_size", "page_count", "tags",
|
|
||||||
"is_public", "uploaded_at", "updated_at",
|
|
||||||
]
|
|
||||||
read_only_fields = ["id", "uploaded_at", "updated_at"]
|
|
||||||
|
|
||||||
def get_cover_url(self, obj: Document) -> str | None:
|
|
||||||
return obj.cover_url
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentDetailSerializer(DocumentListSerializer):
|
|
||||||
owner = serializers.PrimaryKeyRelatedField(read_only=True)
|
|
||||||
|
|
||||||
class Meta(DocumentListSerializer.Meta):
|
|
||||||
fields = DocumentListSerializer.Meta.fields + ["owner", "file"]
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentUploadSerializer(serializers.ModelSerializer[Document]):
|
|
||||||
class Meta:
|
|
||||||
model = Document
|
|
||||||
fields = [
|
|
||||||
"title", "author", "description", "cover", "file",
|
|
||||||
"file_type", "file_size", "page_count", "tags", "is_public",
|
|
||||||
]
|
|
||||||
|
|
||||||
def validate_file_size(self, value: int) -> int:
|
|
||||||
max_size = 100 * 1024 * 1024 # 100 MB
|
|
||||||
if value > max_size:
|
|
||||||
raise serializers.ValidationError("File size must not exceed 100 MB.")
|
|
||||||
return value
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
from rest_framework import permissions, viewsets
|
|
||||||
|
|
||||||
from .models import Document
|
|
||||||
from .serializers import DocumentDetailSerializer, DocumentListSerializer, DocumentUploadSerializer
|
|
||||||
|
|
||||||
|
|
||||||
class IsOwnerOrPublic(permissions.BasePermission):
|
|
||||||
"""Allow access if user is owner or the document is public."""
|
|
||||||
|
|
||||||
def has_object_permission(self, request, view, obj: Document) -> bool:
|
|
||||||
if request.method in permissions.SAFE_METHODS:
|
|
||||||
return obj.is_public or obj.owner == request.user
|
|
||||||
return obj.owner == request.user
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentViewSet(viewsets.ModelViewSet):
|
|
||||||
"""CRUD for documents with owner-scoping."""
|
|
||||||
permission_classes = [permissions.IsAuthenticated, IsOwnerOrPublic]
|
|
||||||
|
|
||||||
def get_serializer_class(self):
|
|
||||||
if self.action == "create":
|
|
||||||
return DocumentUploadSerializer
|
|
||||||
if self.action in ("retrieve", "update", "partial_update"):
|
|
||||||
return DocumentDetailSerializer
|
|
||||||
return DocumentListSerializer
|
|
||||||
|
|
||||||
def get_queryset(self):
|
|
||||||
user = self.request.user
|
|
||||||
qs = Document.objects.select_related("owner")
|
|
||||||
if self.action == "list":
|
|
||||||
return qs.filter(owner=user) | qs.filter(is_public=True)
|
|
||||||
return qs
|
|
||||||
|
|
||||||
def perform_create(self, serializer):
|
|
||||||
serializer.save(owner=self.request.user)
|
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
from django.apps import AppConfig
|
||||||
|
|
||||||
|
|
||||||
|
class ReaderConfig(AppConfig):
|
||||||
|
default_auto_field = "django.db.models.BigAutoField"
|
||||||
|
name = "apps.reader"
|
||||||
|
verbose_name = "Reader Settings"
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
from django.conf import settings
|
||||||
|
from django.db import models
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettings(models.Model):
|
||||||
|
"""Per-user reading preferences for the e-book reader view."""
|
||||||
|
|
||||||
|
THEME_CHOICES = [
|
||||||
|
("sepia", "Sepia"),
|
||||||
|
("dark", "Dark"),
|
||||||
|
("light", "Light"),
|
||||||
|
("paper", "Paper"),
|
||||||
|
]
|
||||||
|
|
||||||
|
FONT_CHOICES = [
|
||||||
|
("sans-serif", "Sans-serif"),
|
||||||
|
("serif", "Serif"),
|
||||||
|
("monospace", "Monospace"),
|
||||||
|
]
|
||||||
|
|
||||||
|
ORIENTATION_CHOICES = [
|
||||||
|
("auto", "Auto"),
|
||||||
|
("portrait", "Portrait"),
|
||||||
|
("landscape", "Landscape"),
|
||||||
|
]
|
||||||
|
|
||||||
|
user = models.OneToOneField(
|
||||||
|
settings.AUTH_USER_MODEL,
|
||||||
|
on_delete=models.CASCADE,
|
||||||
|
related_name="reading_settings",
|
||||||
|
primary_key=True,
|
||||||
|
)
|
||||||
|
font_family = models.CharField(max_length=32, choices=FONT_CHOICES, default="serif")
|
||||||
|
font_size = models.PositiveSmallIntegerField(default=18)
|
||||||
|
line_height = models.FloatField(default=1.6)
|
||||||
|
margin_width = models.PositiveSmallIntegerField(default=16)
|
||||||
|
background_color = models.CharField(max_length=7, default="#f5f0eb")
|
||||||
|
text_color = models.CharField(max_length=7, default="#1a1a1a")
|
||||||
|
brightness = models.PositiveSmallIntegerField(default=100)
|
||||||
|
orientation_lock = models.CharField(
|
||||||
|
max_length=16, choices=ORIENTATION_CHOICES, default="auto"
|
||||||
|
)
|
||||||
|
theme = models.CharField(max_length=32, choices=THEME_CHOICES, default="sepia")
|
||||||
|
created_at = models.DateTimeField(auto_now_add=True)
|
||||||
|
updated_at = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "reader_reading_settings"
|
||||||
|
verbose_name = "Reading Settings"
|
||||||
|
verbose_name_plural = "Reading Settings"
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return f"{self.user} — {self.theme} ({self.font_size}px)"
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
from rest_framework import serializers
|
||||||
|
|
||||||
|
from apps.reader.models import ReadingSettings
|
||||||
|
|
||||||
|
# Theme presets mapped to colors
|
||||||
|
THEME_COLORS = {
|
||||||
|
"sepia": {"background_color": "#f5f0eb", "text_color": "#1a1a1a"},
|
||||||
|
"dark": {"background_color": "#1a1a2e", "text_color": "#e0e0e0"},
|
||||||
|
"light": {"background_color": "#ffffff", "text_color": "#1a1a1a"},
|
||||||
|
"paper": {"background_color": "#e8e0d4", "text_color": "#2c2c2c"},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class ReadingSettingsSerializer(serializers.ModelSerializer):
|
||||||
|
"""Serialize ReadingSettings for the current user."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = ReadingSettings
|
||||||
|
fields = [
|
||||||
|
"font_family",
|
||||||
|
"font_size",
|
||||||
|
"line_height",
|
||||||
|
"margin_width",
|
||||||
|
"background_color",
|
||||||
|
"text_color",
|
||||||
|
"brightness",
|
||||||
|
"orientation_lock",
|
||||||
|
"theme",
|
||||||
|
"created_at",
|
||||||
|
"updated_at",
|
||||||
|
]
|
||||||
|
read_only_fields = ["created_at", "updated_at"]
|
||||||
|
|
||||||
|
def validate_font_size(self, value: int) -> int:
|
||||||
|
if value < 12 or value > 32:
|
||||||
|
raise serializers.ValidationError("Font size must be between 12 and 32.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_line_height(self, value: float) -> float:
|
||||||
|
if value < 1.2 or value > 2.0:
|
||||||
|
raise serializers.ValidationError("Line height must be between 1.2 and 2.0.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_margin_width(self, value: int) -> int:
|
||||||
|
if value < 8 or value > 48:
|
||||||
|
raise serializers.ValidationError("Margin width must be between 8 and 48.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate_brightness(self, value: int) -> int:
|
||||||
|
if value < 0 or value > 100:
|
||||||
|
raise serializers.ValidationError("Brightness must be between 0 and 100.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
def validate(self, attrs):
|
||||||
|
"""Sync theme colors when theme changes, unless explicit colors provided."""
|
||||||
|
theme = attrs.get("theme")
|
||||||
|
if theme and theme in THEME_COLORS:
|
||||||
|
# Only auto-set colors if not explicitly provided
|
||||||
|
if "background_color" not in attrs:
|
||||||
|
attrs["background_color"] = THEME_COLORS[theme]["background_color"]
|
||||||
|
if "text_color" not in attrs:
|
||||||
|
attrs["text_color"] = THEME_COLORS[theme]["text_color"]
|
||||||
|
return attrs
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
from django.urls import path
|
||||||
|
|
||||||
|
from apps.reader.views import reading_settings_view
|
||||||
|
|
||||||
|
urlpatterns = [
|
||||||
|
path("settings/", reading_settings_view, name="reading-settings"),
|
||||||
|
]
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
from rest_framework import permissions, status
|
||||||
|
from rest_framework.decorators import api_view, permission_classes
|
||||||
|
from rest_framework.request import Request
|
||||||
|
from rest_framework.response import Response
|
||||||
|
|
||||||
|
from apps.reader.models import ReadingSettings
|
||||||
|
from apps.reader.serializers import ReadingSettingsSerializer
|
||||||
|
|
||||||
|
|
||||||
|
@api_view(["GET", "PUT", "PATCH"])
|
||||||
|
@permission_classes([permissions.IsAuthenticated])
|
||||||
|
def reading_settings_view(request: Request) -> Response:
|
||||||
|
"""Get or update the current user's reading settings.
|
||||||
|
|
||||||
|
GET → return existing settings (auto-create defaults if missing)
|
||||||
|
PUT → create or fully replace settings
|
||||||
|
PATCH → partial update
|
||||||
|
"""
|
||||||
|
user = request.user
|
||||||
|
settings, created = ReadingSettings.objects.get_or_create(user=user)
|
||||||
|
|
||||||
|
if request.method == "GET":
|
||||||
|
serializer = ReadingSettingsSerializer(settings)
|
||||||
|
return Response(serializer.data)
|
||||||
|
|
||||||
|
if request.method == "PUT":
|
||||||
|
serializer = ReadingSettingsSerializer(settings, data=request.data)
|
||||||
|
elif request.method == "PATCH":
|
||||||
|
serializer = ReadingSettingsSerializer(settings, data=request.data, partial=True)
|
||||||
|
|
||||||
|
serializer.is_valid(raise_exception=True)
|
||||||
|
serializer.save()
|
||||||
|
return Response(serializer.data, status=status.HTTP_200_OK)
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
from django.contrib import admin
|
|
||||||
|
|
||||||
from .models import Bookmark, Highlight, ReadingProgress
|
|
||||||
|
|
||||||
|
|
||||||
@admin.register(Bookmark)
|
|
||||||
class BookmarkAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ["document", "user", "page", "label", "created_at"]
|
|
||||||
list_filter = ["created_at"]
|
|
||||||
|
|
||||||
|
|
||||||
@admin.register(Highlight)
|
|
||||||
class HighlightAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ["document", "user", "page", "color", "created_at"]
|
|
||||||
list_filter = ["color", "created_at"]
|
|
||||||
|
|
||||||
|
|
||||||
@admin.register(ReadingProgress)
|
|
||||||
class ReadingProgressAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ["document", "user", "percentage", "last_read_at"]
|
|
||||||
date_hierarchy = "last_read_at"
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
from django.conf import settings
|
|
||||||
from django.db import models
|
|
||||||
|
|
||||||
|
|
||||||
class Bookmark(models.Model):
|
|
||||||
"""A user bookmark at a specific page in a document."""
|
|
||||||
document = models.ForeignKey(
|
|
||||||
"documents.Document",
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="bookmarks",
|
|
||||||
)
|
|
||||||
user = models.ForeignKey(
|
|
||||||
settings.AUTH_USER_MODEL,
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="bookmarks",
|
|
||||||
)
|
|
||||||
page = models.PositiveIntegerField()
|
|
||||||
label = models.CharField(max_length=300, blank=True, default="")
|
|
||||||
created_at = models.DateTimeField(auto_now_add=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
db_table = "reading_bookmark"
|
|
||||||
ordering = ["page"]
|
|
||||||
unique_together = [["document", "user", "page"]]
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return f"{self.document.title} p.{self.page}"
|
|
||||||
|
|
||||||
|
|
||||||
class Highlight(models.Model):
|
|
||||||
"""A highlighted passage in a document."""
|
|
||||||
document = models.ForeignKey(
|
|
||||||
"documents.Document",
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="highlights",
|
|
||||||
)
|
|
||||||
user = models.ForeignKey(
|
|
||||||
settings.AUTH_USER_MODEL,
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="highlights",
|
|
||||||
)
|
|
||||||
page = models.PositiveIntegerField()
|
|
||||||
color = models.CharField(max_length=20, default="yellow")
|
|
||||||
text = models.TextField()
|
|
||||||
note = models.TextField(blank=True, null=True)
|
|
||||||
created_at = models.DateTimeField(auto_now_add=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
db_table = "reading_highlight"
|
|
||||||
ordering = ["-created_at"]
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return f"Highlight on {self.document.title} p.{self.page}"
|
|
||||||
|
|
||||||
|
|
||||||
class ReadingProgress(models.Model):
|
|
||||||
"""Tracks the user's reading progress through a document."""
|
|
||||||
document = models.ForeignKey(
|
|
||||||
"documents.Document",
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="reading_progress",
|
|
||||||
)
|
|
||||||
user = models.ForeignKey(
|
|
||||||
settings.AUTH_USER_MODEL,
|
|
||||||
on_delete=models.CASCADE,
|
|
||||||
related_name="reading_progress",
|
|
||||||
)
|
|
||||||
current_page = models.PositiveIntegerField(default=1)
|
|
||||||
total_pages = models.PositiveIntegerField(default=0)
|
|
||||||
percentage = models.FloatField(default=0.0)
|
|
||||||
last_read_at = models.DateTimeField(auto_now=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
db_table = "reading_progress"
|
|
||||||
unique_together = [["document", "user"]]
|
|
||||||
verbose_name_plural = "Reading progress"
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return f"{self.document.title} — {self.percentage:.0f}%"
|
|
||||||
|
|
||||||
def save(self, *args, **kwargs):
|
|
||||||
if self.total_pages > 0:
|
|
||||||
self.percentage = round((self.current_page / self.total_pages) * 100, 1)
|
|
||||||
super().save(*args, **kwargs)
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
from rest_framework import serializers
|
|
||||||
|
|
||||||
from .models import Bookmark, Highlight, ReadingProgress
|
|
||||||
|
|
||||||
|
|
||||||
class BookmarkSerializer(serializers.ModelSerializer[Bookmark]):
|
|
||||||
class Meta:
|
|
||||||
model = Bookmark
|
|
||||||
fields = ["id", "document", "page", "label", "created_at"]
|
|
||||||
read_only_fields = ["id", "created_at"]
|
|
||||||
|
|
||||||
|
|
||||||
class HighlightSerializer(serializers.ModelSerializer[Highlight]):
|
|
||||||
class Meta:
|
|
||||||
model = Highlight
|
|
||||||
fields = ["id", "document", "page", "color", "text", "note", "created_at"]
|
|
||||||
read_only_fields = ["id", "created_at"]
|
|
||||||
|
|
||||||
|
|
||||||
class ReadingProgressSerializer(serializers.ModelSerializer[ReadingProgress]):
|
|
||||||
class Meta:
|
|
||||||
model = ReadingProgress
|
|
||||||
fields = ["id", "document", "current_page", "total_pages", "percentage", "last_read_at"]
|
|
||||||
read_only_fields = ["id", "percentage", "last_read_at"]
|
|
||||||
|
|
||||||
|
|
||||||
class ReadingProgressUpdateSerializer(serializers.ModelSerializer[ReadingProgress]):
|
|
||||||
class Meta:
|
|
||||||
model = ReadingProgress
|
|
||||||
fields = ["current_page", "total_pages"]
|
|
||||||
|
|
||||||
def validate_current_page(self, value: int) -> int:
|
|
||||||
if value < 1:
|
|
||||||
raise serializers.ValidationError("Page must be at least 1.")
|
|
||||||
return value
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
from django.urls import include, path
|
|
||||||
from rest_framework.routers import DefaultRouter
|
|
||||||
|
|
||||||
from . import views
|
|
||||||
|
|
||||||
router = DefaultRouter()
|
|
||||||
router.register("bookmarks", views.BookmarkViewSet, basename="bookmark")
|
|
||||||
router.register("highlights", views.HighlightViewSet, basename="highlight")
|
|
||||||
router.register("progress", views.ReadingProgressViewSet, basename="reading-progress")
|
|
||||||
|
|
||||||
app_name = "reading"
|
|
||||||
|
|
||||||
urlpatterns = [
|
|
||||||
path("", include(router.urls)),
|
|
||||||
]
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
from rest_framework import permissions, viewsets
|
|
||||||
|
|
||||||
from .models import Bookmark, Highlight, ReadingProgress
|
|
||||||
from .serializers import (
|
|
||||||
BookmarkSerializer,
|
|
||||||
HighlightSerializer,
|
|
||||||
ReadingProgressSerializer,
|
|
||||||
ReadingProgressUpdateSerializer,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class BookmarkViewSet(viewsets.ModelViewSet):
|
|
||||||
"""User bookmarks for documents."""
|
|
||||||
serializer_class = BookmarkSerializer
|
|
||||||
permission_classes = [permissions.IsAuthenticated]
|
|
||||||
|
|
||||||
def get_queryset(self):
|
|
||||||
return Bookmark.objects.filter(user=self.request.user).select_related("document")
|
|
||||||
|
|
||||||
def perform_create(self, serializer):
|
|
||||||
serializer.save(user=self.request.user)
|
|
||||||
|
|
||||||
|
|
||||||
class HighlightViewSet(viewsets.ModelViewSet):
|
|
||||||
"""User highlights for documents."""
|
|
||||||
serializer_class = HighlightSerializer
|
|
||||||
permission_classes = [permissions.IsAuthenticated]
|
|
||||||
|
|
||||||
def get_queryset(self):
|
|
||||||
return Highlight.objects.filter(user=self.request.user).select_related("document")
|
|
||||||
|
|
||||||
def perform_create(self, serializer):
|
|
||||||
serializer.save(user=self.request.user)
|
|
||||||
|
|
||||||
|
|
||||||
class ReadingProgressViewSet(viewsets.ModelViewSet):
|
|
||||||
"""Reading progress tracker."""
|
|
||||||
permission_classes = [permissions.IsAuthenticated]
|
|
||||||
|
|
||||||
def get_serializer_class(self):
|
|
||||||
if self.action in ("create", "update", "partial_update"):
|
|
||||||
return ReadingProgressUpdateSerializer
|
|
||||||
return ReadingProgressSerializer
|
|
||||||
|
|
||||||
def get_queryset(self):
|
|
||||||
return ReadingProgress.objects.filter(user=self.request.user).select_related("document")
|
|
||||||
|
|
||||||
def perform_create(self, serializer):
|
|
||||||
serializer.save(user=self.request.user)
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
from django.contrib import admin
|
||||||
|
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
|
||||||
|
|
||||||
|
from apps.users.models import User
|
||||||
|
|
||||||
|
|
||||||
|
@admin.register(User)
|
||||||
|
class UserAdmin(BaseUserAdmin):
|
||||||
|
"""Admin config for the custom User model."""
|
||||||
|
list_display = ("email", "username", "is_staff", "is_active", "date_joined")
|
||||||
|
search_fields = ("email", "username")
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
from django.apps import AppConfig
|
||||||
|
|
||||||
|
|
||||||
|
class UsersConfig(AppConfig):
|
||||||
|
default_auto_field = "django.db.models.BigAutoField"
|
||||||
|
name = "apps.users"
|
||||||
|
label = "users"
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
from django.contrib.auth.models import AbstractUser
|
||||||
|
|
||||||
|
|
||||||
|
class User(AbstractUser):
|
||||||
|
"""Custom user model. Uses email as the unique identifier field."""
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
db_table = "users_user"
|
||||||
|
verbose_name = "User"
|
||||||
|
verbose_name_plural = "Users"
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return self.email or self.username
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
from django.urls import include, path
|
||||||
|
from rest_framework.routers import DefaultRouter
|
||||||
|
from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView
|
||||||
|
|
||||||
|
urlpatterns = [
|
||||||
|
path("token/", TokenObtainPairView.as_view(), name="token_obtain_pair"),
|
||||||
|
path("token/refresh/", TokenRefreshView.as_view(), name="token_refresh"),
|
||||||
|
]
|
||||||
@@ -0,0 +1,154 @@
|
|||||||
|
"""
|
||||||
|
Django settings for cloud-reader backend.
|
||||||
|
|
||||||
|
Generated using Django 5.1. Customised with pydantic-settings integration.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from config.settings import settings
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Build paths
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
BASE_DIR = Path(__file__).resolve().parent.parent
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Security
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
SECRET_KEY = settings.DJANGO_SECRET_KEY
|
||||||
|
DEBUG = settings.DJANGO_DEBUG
|
||||||
|
ALLOWED_HOSTS = settings.DJANGO_ALLOWED_HOSTS
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Application definition
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
INSTALLED_APPS = [
|
||||||
|
# Django built-in
|
||||||
|
"django.contrib.admin",
|
||||||
|
"django.contrib.auth",
|
||||||
|
"django.contrib.contenttypes",
|
||||||
|
"django.contrib.sessions",
|
||||||
|
"django.contrib.messages",
|
||||||
|
"django.contrib.staticfiles",
|
||||||
|
# Third-party
|
||||||
|
"rest_framework",
|
||||||
|
"rest_framework_simplejwt",
|
||||||
|
"corsheaders",
|
||||||
|
"django_filters",
|
||||||
|
# Local apps
|
||||||
|
"apps.users",
|
||||||
|
"apps.books",
|
||||||
|
"apps.annotations",
|
||||||
|
"apps.reader",
|
||||||
|
]
|
||||||
|
|
||||||
|
MIDDLEWARE = [
|
||||||
|
"corsheaders.middleware.CorsMiddleware",
|
||||||
|
"django.middleware.security.SecurityMiddleware",
|
||||||
|
"django.contrib.sessions.middleware.SessionMiddleware",
|
||||||
|
"django.middleware.common.CommonMiddleware",
|
||||||
|
"django.middleware.csrf.CsrfViewMiddleware",
|
||||||
|
"django.contrib.auth.middleware.AuthenticationMiddleware",
|
||||||
|
"django.contrib.messages.middleware.MessageMiddleware",
|
||||||
|
"django.middleware.clickjacking.XFrameOptionsMiddleware",
|
||||||
|
]
|
||||||
|
|
||||||
|
ROOT_URLCONF = "config.urls"
|
||||||
|
|
||||||
|
TEMPLATES = [
|
||||||
|
{
|
||||||
|
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
||||||
|
"DIRS": [],
|
||||||
|
"APP_DIRS": True,
|
||||||
|
"OPTIONS": {
|
||||||
|
"context_processors": [
|
||||||
|
"django.template.context_processors.debug",
|
||||||
|
"django.template.context_processors.request",
|
||||||
|
"django.contrib.auth.context_processors.auth",
|
||||||
|
"django.contrib.messages.context_processors.messages",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
WSGI_APPLICATION = "config.wsgi.application"
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Database
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
DATABASES = {
|
||||||
|
"default": {
|
||||||
|
"ENGINE": "django.db.backends.postgresql",
|
||||||
|
"NAME": settings.DB_NAME,
|
||||||
|
"USER": settings.DB_USER,
|
||||||
|
"PASSWORD": settings.DB_PASSWORD,
|
||||||
|
"HOST": settings.DB_HOST,
|
||||||
|
"PORT": settings.DB_PORT,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Auth
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
AUTH_USER_MODEL = "users.User"
|
||||||
|
|
||||||
|
AUTH_PASSWORD_VALIDATORS = [
|
||||||
|
{"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
|
||||||
|
{"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
|
||||||
|
]
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# DRF
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
REST_FRAMEWORK = {
|
||||||
|
"DEFAULT_AUTHENTICATION_CLASSES": (
|
||||||
|
"rest_framework_simplejwt.authentication.JWTAuthentication",
|
||||||
|
),
|
||||||
|
"DEFAULT_PERMISSION_CLASSES": (
|
||||||
|
"rest_framework.permissions.IsAuthenticated",
|
||||||
|
),
|
||||||
|
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
|
||||||
|
"PAGE_SIZE": 50,
|
||||||
|
"DEFAULT_FILTER_BACKENDS": [
|
||||||
|
"django_filters.rest_framework.DjangoFilterBackend",
|
||||||
|
"rest_framework.filters.OrderingFilter",
|
||||||
|
"rest_framework.filters.SearchFilter",
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# SimpleJWT
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
from datetime import timedelta
|
||||||
|
|
||||||
|
SIMPLE_JWT = {
|
||||||
|
"ACCESS_TOKEN_LIFETIME": timedelta(minutes=settings.JWT_ACCESS_TOKEN_LIFETIME_MINUTES),
|
||||||
|
"REFRESH_TOKEN_LIFETIME": timedelta(days=settings.JWT_REFRESH_TOKEN_LIFETIME_DAYS),
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# CORS
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
CORS_ALLOWED_ORIGINS = settings.CORS_ALLOWED_ORIGINS
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# i18n
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
LANGUAGE_CODE = "en-us"
|
||||||
|
TIME_ZONE = "UTC"
|
||||||
|
USE_I18N = True
|
||||||
|
USE_TZ = True
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Static / Media
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
STATIC_URL = "static/"
|
||||||
|
STATIC_ROOT = BASE_DIR / "staticfiles"
|
||||||
|
MEDIA_URL = "media/"
|
||||||
|
MEDIA_ROOT = BASE_DIR / "media"
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Default primary key
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
"""Custom exception handler that returns consistent JSON error responses."""
|
|
||||||
from rest_framework.views import exception_handler
|
|
||||||
|
|
||||||
|
|
||||||
def custom_exception_handler(exc, context):
|
|
||||||
"""Wrap DRF's default handler to always return {'detail': ..., 'code': ...}."""
|
|
||||||
response = exception_handler(exc, context)
|
|
||||||
if response is not None:
|
|
||||||
data = response.data
|
|
||||||
# Flatten validation errors into a consistent shape
|
|
||||||
if isinstance(data, dict) and "detail" not in data:
|
|
||||||
response.data = {"detail": "Validation error", "fields": data, "code": "validation_error"}
|
|
||||||
return response
|
|
||||||
+29
-157
@@ -1,170 +1,42 @@
|
|||||||
import os
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import decouple
|
from pydantic_settings import BaseSettings
|
||||||
|
|
||||||
BASE_DIR = Path(__file__).resolve().parent.parent
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
class Settings(BaseSettings):
|
||||||
# Environment
|
"""Application settings via pydantic-settings. Reads from env vars and .env."""
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
config = decouple.AutoConfig(search_path=BASE_DIR / ".env")
|
|
||||||
|
|
||||||
SECRET_KEY = config("SECRET_KEY", default="django-insecure-change-me-in-production")
|
# Django
|
||||||
DEBUG = config("DEBUG", default=False, cast=bool)
|
DJANGO_SECRET_KEY: str = "django-insecure-change-me-in-production"
|
||||||
ALLOWED_HOSTS = config("ALLOWED_HOSTS", default="localhost,127.0.0.1", cast=decouple.Csv())
|
DJANGO_DEBUG: bool = False
|
||||||
|
DJANGO_ALLOWED_HOSTS: list[str] = ["*"]
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# PostgreSQL
|
||||||
# Application definition
|
DB_NAME: str = "cloud_reader"
|
||||||
# ---------------------------------------------------------------------------
|
DB_USER: str = "postgres"
|
||||||
INSTALLED_APPS = [
|
DB_PASSWORD: str = "postgres"
|
||||||
"django.contrib.admin",
|
DB_HOST: str = "localhost"
|
||||||
"django.contrib.auth",
|
DB_PORT: int = 5432
|
||||||
"django.contrib.contenttypes",
|
|
||||||
"django.contrib.sessions",
|
|
||||||
"django.contrib.messages",
|
|
||||||
"django.contrib.staticfiles",
|
|
||||||
# Third-party
|
|
||||||
"rest_framework",
|
|
||||||
"rest_framework_simplejwt",
|
|
||||||
"corsheaders",
|
|
||||||
"django_filters",
|
|
||||||
"drf_spectacular",
|
|
||||||
# Local
|
|
||||||
"apps.accounts",
|
|
||||||
"apps.documents",
|
|
||||||
"apps.collections",
|
|
||||||
"apps.reading",
|
|
||||||
]
|
|
||||||
|
|
||||||
MIDDLEWARE = [
|
# JWT
|
||||||
"django.middleware.security.SecurityMiddleware",
|
JWT_ACCESS_TOKEN_LIFETIME_MINUTES: int = 60
|
||||||
"whitenoise.middleware.WhiteNoiseMiddleware",
|
JWT_REFRESH_TOKEN_LIFETIME_DAYS: int = 7
|
||||||
"corsheaders.middleware.CorsMiddleware",
|
|
||||||
"django.contrib.sessions.middleware.SessionMiddleware",
|
|
||||||
"django.middleware.common.CommonMiddleware",
|
|
||||||
"django.middleware.csrf.CsrfViewMiddleware",
|
|
||||||
"django.contrib.auth.middleware.AuthenticationMiddleware",
|
|
||||||
"django.contrib.messages.middleware.MessageMiddleware",
|
|
||||||
"django.middleware.clickjacking.XFrameOptionsMiddleware",
|
|
||||||
]
|
|
||||||
|
|
||||||
ROOT_URLCONF = "config.urls"
|
# CORS
|
||||||
|
CORS_ALLOWED_ORIGINS: list[str] = [
|
||||||
|
"http://localhost:5173",
|
||||||
|
"http://localhost:3000",
|
||||||
|
]
|
||||||
|
|
||||||
TEMPLATES = [
|
@property
|
||||||
{
|
def DATABASE_URL(self) -> str:
|
||||||
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
return (
|
||||||
"DIRS": [BASE_DIR / "templates"],
|
f"postgresql://{self.DB_USER}:{self.DB_PASSWORD}"
|
||||||
"APP_DIRS": True,
|
f"@{self.DB_HOST}:{self.DB_PORT}/{self.DB_NAME}"
|
||||||
"OPTIONS": {
|
)
|
||||||
"context_processors": [
|
|
||||||
"django.template.context_processors.debug",
|
|
||||||
"django.template.context_processors.request",
|
|
||||||
"django.contrib.auth.context_processors.auth",
|
|
||||||
"django.contrib.messages.context_processors.messages",
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
WSGI_APPLICATION = "config.wsgi.application"
|
model_config = {"env_file": ".env", "env_file_encoding": "utf-8"}
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Database
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
DATABASES = {
|
|
||||||
"default": {
|
|
||||||
"ENGINE": config("DB_ENGINE", default="django.db.backends.postgresql"),
|
|
||||||
"NAME": config("DB_NAME", default="cloud_reader"),
|
|
||||||
"USER": config("DB_USER", default="cloud_reader"),
|
|
||||||
"PASSWORD": config("DB_PASSWORD", default="cloud_reader"),
|
|
||||||
"HOST": config("DB_HOST", default="localhost"),
|
|
||||||
"PORT": config("DB_PORT", default="5432", cast=int),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
|
settings = Settings()
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Auth
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
AUTH_USER_MODEL = "accounts.User"
|
|
||||||
AUTH_PASSWORD_VALIDATORS = [
|
|
||||||
{"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
|
|
||||||
{"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
|
|
||||||
{"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
|
|
||||||
]
|
|
||||||
|
|
||||||
LOGIN_URL = "rest_framework:login"
|
|
||||||
LOGOUT_URL = "rest_framework:logout"
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Internationalization
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
LANGUAGE_CODE = "en-us"
|
|
||||||
TIME_ZONE = "UTC"
|
|
||||||
USE_I18N = True
|
|
||||||
USE_TZ = True
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Static & Media files
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
STATIC_URL = "static/"
|
|
||||||
STATIC_ROOT = BASE_DIR / "staticfiles"
|
|
||||||
STATICFILES_DIRS = [BASE_DIR / "static"]
|
|
||||||
STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
|
|
||||||
|
|
||||||
MEDIA_URL = "media/"
|
|
||||||
MEDIA_ROOT = BASE_DIR / "media"
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# CORS
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
CORS_ALLOWED_ORIGINS = config(
|
|
||||||
"CORS_ALLOWED_ORIGINS",
|
|
||||||
default="http://localhost:5173,http://localhost:3000",
|
|
||||||
cast=decouple.Csv(),
|
|
||||||
)
|
|
||||||
CORS_ALLOW_CREDENTIALS = True
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# REST Framework
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
REST_FRAMEWORK = {
|
|
||||||
"DEFAULT_AUTHENTICATION_CLASSES": (
|
|
||||||
"rest_framework_simplejwt.authentication.JWTAuthentication",
|
|
||||||
),
|
|
||||||
"DEFAULT_PERMISSION_CLASSES": (
|
|
||||||
"rest_framework.permissions.IsAuthenticated",
|
|
||||||
),
|
|
||||||
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
|
|
||||||
"PAGE_SIZE": 20,
|
|
||||||
"DEFAULT_FILTER_BACKENDS": [
|
|
||||||
"django_filters.rest_framework.DjangoFilterBackend",
|
|
||||||
"rest_framework.filters.SearchFilter",
|
|
||||||
"rest_framework.filters.OrderingFilter",
|
|
||||||
],
|
|
||||||
"DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
|
|
||||||
"EXCEPTION_HANDLER": "config.exceptions.custom_exception_handler",
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# SimpleJWT
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
from datetime import timedelta # noqa: E402
|
|
||||||
|
|
||||||
SIMPLE_JWT = {
|
|
||||||
"ACCESS_TOKEN_LIFETIME": timedelta(minutes=30),
|
|
||||||
"REFRESH_TOKEN_LIFETIME": timedelta(days=7),
|
|
||||||
"ROTATE_REFRESH_TOKENS": True,
|
|
||||||
"AUTH_HEADER_TYPES": ("Bearer",),
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# drf-spectacular (OpenAPI)
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
SPECTACULAR_SETTINGS = {
|
|
||||||
"TITLE": "Cloud Reader API",
|
|
||||||
"VERSION": "0.1.0",
|
|
||||||
"SERVE_INCLUDE_SCHEMA": False,
|
|
||||||
}
|
|
||||||
@@ -3,11 +3,8 @@ from django.urls import include, path
|
|||||||
|
|
||||||
urlpatterns = [
|
urlpatterns = [
|
||||||
path("admin/", admin.site.urls),
|
path("admin/", admin.site.urls),
|
||||||
# API
|
path("api/auth/", include("apps.users.urls")),
|
||||||
path("api/v1/auth/", include("apps.accounts.urls")),
|
path("api/books/", include("apps.books.urls")),
|
||||||
path("api/v1/documents/", include("apps.documents.urls")),
|
path("api/annotations/", include("apps.annotations.urls")),
|
||||||
path("api/v1/collections/", include("apps.collections.urls")),
|
path("api/reader/", include("apps.reader.urls")),
|
||||||
path("api/v1/reading/", include("apps.reading.urls")),
|
|
||||||
# OpenAPI schema
|
|
||||||
path("api/schema/", include("drf_spectacular.urls")),
|
|
||||||
]
|
]
|
||||||
@@ -2,6 +2,6 @@ import os
|
|||||||
|
|
||||||
from django.core.wsgi import get_wsgi_application
|
from django.core.wsgi import get_wsgi_application
|
||||||
|
|
||||||
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
|
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.django")
|
||||||
|
|
||||||
application = get_wsgi_application()
|
application = get_wsgi_application()
|
||||||
+3
-2
@@ -1,12 +1,13 @@
|
|||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
"""Django's command-line utility for administrative tasks."""
|
"""Django's command-line utility for administrative tasks."""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def main():
|
||||||
"""Run administrative tasks."""
|
"""Run administrative tasks."""
|
||||||
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
|
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.django")
|
||||||
try:
|
try:
|
||||||
from django.core.management import execute_from_command_line
|
from django.core.management import execute_from_command_line
|
||||||
except ImportError as exc:
|
except ImportError as exc:
|
||||||
|
|||||||
@@ -1,33 +0,0 @@
|
|||||||
[project]
|
|
||||||
name = "cloud-reader-backend"
|
|
||||||
version = "0.1.0"
|
|
||||||
description = "Cloud Reader API — Django REST Framework backend"
|
|
||||||
readme = "README.md"
|
|
||||||
requires-python = ">=3.12"
|
|
||||||
dependencies = [
|
|
||||||
"django>=5.1,<6.0",
|
|
||||||
"djangorestframework>=3.15,<4.0",
|
|
||||||
"django-cors-headers>=4.3",
|
|
||||||
"django-filter>=24.3",
|
|
||||||
"psycopg2-binary>=2.9",
|
|
||||||
"python-decouple>=3.8",
|
|
||||||
"djangorestframework-simplejwt>=5.3",
|
|
||||||
"drf-spectacular>=0.27",
|
|
||||||
"gunicorn>=22.0",
|
|
||||||
"whitenoise>=6.6",
|
|
||||||
"Pillow>=10.3",
|
|
||||||
]
|
|
||||||
|
|
||||||
[project.optional-dependencies]
|
|
||||||
dev = [
|
|
||||||
"pytest>=8.0",
|
|
||||||
"pytest-django>=4.8",
|
|
||||||
"pytest-cov>=5.0",
|
|
||||||
"model-bakery>=1.17",
|
|
||||||
"ruff>=0.5",
|
|
||||||
"ipdb>=0.13",
|
|
||||||
]
|
|
||||||
|
|
||||||
[build-system]
|
|
||||||
requires = ["setuptools>=72"]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
+7
-4
@@ -1,5 +1,8 @@
|
|||||||
# pytest
|
[tool:pytest]
|
||||||
DJANGO_SETTINGS_MODULE = config.settings
|
DJANGO_SETTINGS_MODULE = config.django
|
||||||
python_files = tests.py test_*.py *_tests.py
|
python_files = tests.py test_*.py *_tests.py
|
||||||
django_find_project = false
|
testpaths = apps
|
||||||
testpaths = apps/
|
|
||||||
|
[coverage:run]
|
||||||
|
source = apps
|
||||||
|
omit = */tests/*,*/migrations/*,*/admin.py,*/apps.py
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
Django==5.1.7
|
||||||
|
djangorestframework==3.15.2
|
||||||
|
djangorestframework-simplejwt==5.4.0
|
||||||
|
django-filter==25.1
|
||||||
|
django-cors-headers==4.6.0
|
||||||
|
psycopg2-binary==2.9.10
|
||||||
|
pydantic==2.10.5
|
||||||
|
pydantic-settings==2.7.1
|
||||||
|
python-dotenv==1.0.1
|
||||||
|
gunicorn==23.0.0
|
||||||
|
pytest==8.3.4
|
||||||
|
pytest-django==4.9.0
|
||||||
|
pytest-cov==6.0.0
|
||||||
|
coverage==7.6.10
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
-r production.txt
|
|
||||||
pytest>=8.0
|
|
||||||
pytest-django>=4.8
|
|
||||||
pytest-cov>=5.0
|
|
||||||
model-bakery>=1.17
|
|
||||||
ruff>=0.5
|
|
||||||
ipdb>=0.13
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# Django
|
|
||||||
django>=5.1,<6.0
|
|
||||||
djangorestframework>=3.15,<4.0
|
|
||||||
django-cors-headers>=4.3
|
|
||||||
django-filter>=24.3
|
|
||||||
psycopg2-binary>=2.9
|
|
||||||
python-decouple>=3.8
|
|
||||||
djangorestframework-simplejwt>=5.3
|
|
||||||
drf-spectacular>=0.27
|
|
||||||
gunicorn>=22.0
|
|
||||||
whitenoise>=6.6
|
|
||||||
Pillow>=10.3
|
|
||||||
+37
-24
@@ -1,39 +1,52 @@
|
|||||||
version: "3.9"
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
db:
|
db:
|
||||||
image: postgres:16
|
image: postgres:15
|
||||||
|
restart: unless-stopped
|
||||||
|
volumes:
|
||||||
|
- postgres_data:/var/lib/postgresql/data
|
||||||
environment:
|
environment:
|
||||||
POSTGRES_DB: cloud_reader
|
POSTGRES_DB: cloudreader
|
||||||
POSTGRES_USER: cloud_reader
|
POSTGRES_USER: cloudreader
|
||||||
POSTGRES_PASSWORD: cloud_reader
|
POSTGRES_PASSWORD: cloudreader
|
||||||
ports:
|
ports:
|
||||||
- "5432:5432"
|
- "5432:5432"
|
||||||
volumes:
|
healthcheck:
|
||||||
- pgdata:/var/lib/postgresql/data
|
test: ["CMD-SHELL", "pg_isready -U cloudreader -d cloudreader"]
|
||||||
|
interval: 5s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 10
|
||||||
|
|
||||||
backend:
|
api:
|
||||||
build: backend
|
build:
|
||||||
|
context: ./api
|
||||||
ports:
|
ports:
|
||||||
- "8000:8000"
|
- "8000:8000"
|
||||||
environment:
|
environment:
|
||||||
SECRET_KEY: development-secret-key
|
DATABASE_URL: "postgres://cloudreader:cloudreader@db:5432/cloudreader"
|
||||||
DEBUG: "True"
|
DJANGO_SECRET_KEY: "dev-secret-key-change-in-production"
|
||||||
DB_HOST: db
|
DJANGO_DEBUG: "True"
|
||||||
DB_NAME: cloud_reader
|
volumes:
|
||||||
DB_USER: cloud_reader
|
- ./api:/app
|
||||||
DB_PASSWORD: cloud_reader
|
- book_uploads:/app/media
|
||||||
CORS_ALLOWED_ORIGINS: http://localhost:5173,http://localhost:3000
|
command: >
|
||||||
ALLOWED_HOSTS: localhost,127.0.0.1
|
sh -c "python manage.py migrate && python manage.py runserver 0.0.0.0:8000"
|
||||||
depends_on:
|
depends_on:
|
||||||
- db
|
db:
|
||||||
|
condition: service_healthy
|
||||||
|
|
||||||
frontend:
|
web:
|
||||||
build: frontend
|
build:
|
||||||
|
context: ./web
|
||||||
ports:
|
ports:
|
||||||
- "5173:80"
|
- "3000:3000"
|
||||||
|
environment:
|
||||||
|
VITE_API_URL: "http://localhost:8000"
|
||||||
|
volumes:
|
||||||
|
- ./web:/app
|
||||||
|
- /app/node_modules
|
||||||
depends_on:
|
depends_on:
|
||||||
- backend
|
- api
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
pgdata:
|
postgres_data:
|
||||||
|
book_uploads:
|
||||||
@@ -0,0 +1,246 @@
|
|||||||
|
# US: Customizable Mobile Reading Experience
|
||||||
|
|
||||||
|
**Issue:** https://gitea-dev.codescripters.org/HermesFactory/cloud-reader/issues (TBD)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Add a full-screen reading view for ebooks with customizable typography, themes,
|
||||||
|
table of contents navigation, and orientation support. Mobile-first, responsive
|
||||||
|
design that adapts to any screen size.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Backend Specification
|
||||||
|
|
||||||
|
### New Models
|
||||||
|
|
||||||
|
#### `apps.books.models.Chapter`
|
||||||
|
|
||||||
|
| Field | Type | Notes |
|
||||||
|
|-------------|--------------------|--------------------------------|
|
||||||
|
| id | AutoField (PK) | |
|
||||||
|
| book | FK -> Book | related_name="chapters" |
|
||||||
|
| title | CharField(512) | Chapter title |
|
||||||
|
| number | PositiveIntegerField | Chapter ordering / TOC index |
|
||||||
|
| content | TextField | Chapter text/markdown content |
|
||||||
|
| created_at | DateTimeField | auto_now_add |
|
||||||
|
| updated_at | DateTimeField | auto_now |
|
||||||
|
|
||||||
|
**Constraints:** UniqueConstraint(book, chapter_number)
|
||||||
|
**Ordering:** [book, number]
|
||||||
|
**Index:** FK to book with db_index
|
||||||
|
|
||||||
|
#### `apps.books.models.ReadingProgress`
|
||||||
|
|
||||||
|
| Field | Type | Notes |
|
||||||
|
|------------------|--------------------|--------------------------------|
|
||||||
|
| id | AutoField (PK) | |
|
||||||
|
| user | FK -> User | related_name="reading_progress"|
|
||||||
|
| book | FK -> Book | related_name="reading_progress"|
|
||||||
|
| current_chapter | PositiveIntegerField | Last chapter number |
|
||||||
|
| current_position | PositiveIntegerField | Position within chapter (paragraph) |
|
||||||
|
| percentage | FloatField | 0.0 - 100.0 overall progress |
|
||||||
|
| updated_at | DateTimeField | auto_now |
|
||||||
|
|
||||||
|
**Constraints:** UniqueConstraint(user, book)
|
||||||
|
**Indexes:** (user, book) composite, (user) filter for list queries
|
||||||
|
|
||||||
|
#### `apps.reader.models.ReadingSettings`
|
||||||
|
|
||||||
|
New app `apps/reader/` for reading preferences, isolated from book data model.
|
||||||
|
|
||||||
|
| Field | Type | Notes |
|
||||||
|
|-------------------|--------------------|-------------------------------|
|
||||||
|
| id | AutoField (PK) | |
|
||||||
|
| user | OneToOneField -> User | related_name="reading_settings" |
|
||||||
|
| font_family | CharField(32) | "sans-serif", "serif", "monospace" |
|
||||||
|
| font_size | PositiveSmallIntegerField | 12-32, default 18 |
|
||||||
|
| line_height | FloatField | 1.2 - 2.0, default 1.6 |
|
||||||
|
| margin_width | PositiveSmallIntegerField | 8-48, default 16 (px) |
|
||||||
|
| background_color | CharField(7) | Hex color, default "#f5f0eb" |
|
||||||
|
| text_color | CharField(7) | Hex color, default "#1a1a1a" |
|
||||||
|
| brightness | PositiveSmallIntegerField | 0-100, default 100 |
|
||||||
|
| orientation_lock | CharField(16) | "auto", "portrait", "landscape" |
|
||||||
|
| theme | CharField(32) | "sepia", "dark", "light", "paper" |
|
||||||
|
| created_at | DateTimeField | auto_now_add |
|
||||||
|
| updated_at | DateTimeField | auto_now |
|
||||||
|
|
||||||
|
### New API Endpoints
|
||||||
|
|
||||||
|
All under `/api/` prefix, authenticated with JWT.
|
||||||
|
|
||||||
|
#### Reader Settings (`/api/reader/settings/`)
|
||||||
|
|
||||||
|
| Method | URL | Action |
|
||||||
|
|--------|------------------------------|---------------------------|
|
||||||
|
| GET | /api/reader/settings/ | Get current user settings |
|
||||||
|
| PUT | /api/reader/settings/ | Create/update settings |
|
||||||
|
| PATCH | /api/reader/settings/ | Partial update settings |
|
||||||
|
|
||||||
|
- Single-object endpoint (one settings record per user, auto-created on first GET)
|
||||||
|
- Validation: font_size 12-32, line_height 1.2-2.0, margin_width 8-48
|
||||||
|
|
||||||
|
#### Reading Progress (`/api/books/{id}/progress/`)
|
||||||
|
|
||||||
|
| Method | URL | Action |
|
||||||
|
|--------|----------------------------------------|------------------------------|
|
||||||
|
| GET | /api/books/{id}/progress/ | Get reading progress for book|
|
||||||
|
| PUT | /api/books/{id}/progress/ | Create/update reading progress|
|
||||||
|
|
||||||
|
- Nested under book detail
|
||||||
|
- Auto-creates progress record on first PUT
|
||||||
|
|
||||||
|
#### Chapters (`/api/books/{id}/chapters/`)
|
||||||
|
|
||||||
|
| Method | URL | Action |
|
||||||
|
|--------|----------------------------------------|------------------------------|
|
||||||
|
| GET | /api/books/{id}/chapters/ | List chapters for book (TOC) |
|
||||||
|
| GET | /api/books/{id}/chapters/{number}/ | Get specific chapter content |
|
||||||
|
|
||||||
|
- Ordering by `number`
|
||||||
|
- Used by frontend TOC sidebar and content loading
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Frontend Specification
|
||||||
|
|
||||||
|
### New Pages
|
||||||
|
|
||||||
|
#### `/reader/:bookId` — ReadingPage
|
||||||
|
|
||||||
|
Full-screen reading view with:
|
||||||
|
- Chapter content display (left/right swiping or scroll)
|
||||||
|
- Bottom toolbar: TOC toggle, Settings toggle, Progress indicator
|
||||||
|
- Top bar: Back button, Book title, Chapter title
|
||||||
|
- Swipe/tap/page navigation between chapters
|
||||||
|
|
||||||
|
### New Components
|
||||||
|
|
||||||
|
#### `ReaderToolbar`
|
||||||
|
- Fixed bottom toolbar
|
||||||
|
- TOC button (opens TOC drawer)
|
||||||
|
- Settings/theme button (opens settings panel)
|
||||||
|
- Progress bar showing overall reading progress
|
||||||
|
|
||||||
|
#### `TableOfContents`
|
||||||
|
- Slide-in drawer from left
|
||||||
|
- Lists all chapters with current chapter highlighted
|
||||||
|
- Tap on chapter to navigate
|
||||||
|
- Shows reading progress per chapter
|
||||||
|
|
||||||
|
#### `ReadingSettingsPanel`
|
||||||
|
- Slide-in drawer from right (or bottom sheet on mobile)
|
||||||
|
- Controls:
|
||||||
|
- Theme presets: Sepia, Dark, Light, Paper
|
||||||
|
- Font family: Sans-serif, Serif, Monospace
|
||||||
|
- Font size slider (12-32)
|
||||||
|
- Line height slider (1.2-2.0)
|
||||||
|
- Margin/padding control
|
||||||
|
- Orientation lock toggle (Auto / Portrait / Landscape)
|
||||||
|
- All changes persist immediately via API
|
||||||
|
- LocalStorage fallback when offline
|
||||||
|
|
||||||
|
### New Hooks
|
||||||
|
|
||||||
|
#### `useReadingSettings(bookId)`
|
||||||
|
- Fetches user reading settings from API
|
||||||
|
- Returns current settings + update function
|
||||||
|
- Applies CSS custom properties to document root
|
||||||
|
- Falls back to defaults if API unavailable
|
||||||
|
|
||||||
|
#### `useChapters(bookId)`
|
||||||
|
- Fetches chapter list for TOC
|
||||||
|
- Returns chapters array, current chapter, navigate function
|
||||||
|
- Prefetches next/prev chapter content
|
||||||
|
|
||||||
|
#### `useReadingProgress(bookId)`
|
||||||
|
- Fetches/updates reading progress
|
||||||
|
- Auto-saves position on chapter change and periodic interval
|
||||||
|
|
||||||
|
### New Types
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface Chapter {
|
||||||
|
id: number;
|
||||||
|
book: number;
|
||||||
|
title: string;
|
||||||
|
number: number;
|
||||||
|
content?: string; // Only present when fetching individual chapter
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ChapterSummary {
|
||||||
|
id: number;
|
||||||
|
book: number;
|
||||||
|
title: string;
|
||||||
|
number: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ReadingSettings {
|
||||||
|
font_family: "sans-serif" | "serif" | "monospace";
|
||||||
|
font_size: number;
|
||||||
|
line_height: number;
|
||||||
|
margin_width: number;
|
||||||
|
background_color: string;
|
||||||
|
text_color: string;
|
||||||
|
brightness: number;
|
||||||
|
orientation_lock: "auto" | "portrait" | "landscape";
|
||||||
|
theme: "sepia" | "dark" | "light" | "paper";
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ReadingProgress {
|
||||||
|
current_chapter: number;
|
||||||
|
current_position: number;
|
||||||
|
percentage: number;
|
||||||
|
updated_at: string;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### CSS / Theming
|
||||||
|
|
||||||
|
Reading view uses CSS custom properties driven by reading settings:
|
||||||
|
|
||||||
|
```css
|
||||||
|
:root {
|
||||||
|
--reader-bg: var(--bg-color, #f5f0eb);
|
||||||
|
--reader-text: var(--text-color, #1a1a1a);
|
||||||
|
--reader-font-family: var(--font-family, "Georgia", serif);
|
||||||
|
--reader-font-size: var(--font-size, 18px);
|
||||||
|
--reader-line-height: var(--line-height, 1.6);
|
||||||
|
--reader-margin: var(--margin-width, 16px);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Three theme presets:
|
||||||
|
- **Sepia**: `bg:#f5f0eb`, `text:#1a1a1a` — warm, easy on eyes
|
||||||
|
- **Dark**: `bg:#1a1a2e`, `text:#e0e0e0` — for low-light reading
|
||||||
|
- **Light**: `bg:#ffffff`, `text:#1a1a1a` — crisp and clean
|
||||||
|
- **Paper**: `bg:#e8e0d4`, `text:#2c2c2c` — book-like feel
|
||||||
|
|
||||||
|
### Orientation Support
|
||||||
|
|
||||||
|
- CSS `@media (orientation: portrait)` and `@media (orientation: landscape)` breakpoints
|
||||||
|
- Reading settings panel includes orientation lock toggle
|
||||||
|
- On mobile, landscape mode expands content horizontally with wider margins
|
||||||
|
- Portrait mode stacks controls vertically for thumb-reachable UI
|
||||||
|
|
||||||
|
### Routing
|
||||||
|
|
||||||
|
Add to App.tsx:
|
||||||
|
```
|
||||||
|
/ → LibraryPage
|
||||||
|
/books/:bookId → BookDetailPage
|
||||||
|
/reader/:bookId → ReadingPage
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Order
|
||||||
|
|
||||||
|
1. Backend models + migrations (Chapter, ReadingProgress, ReadingSettings)
|
||||||
|
2. Backend serializers + views + URLs
|
||||||
|
3. Frontend types + API client
|
||||||
|
4. Frontend hooks (useReadingSettings, useChapters, useReadingProgress)
|
||||||
|
5. Frontend components (ReadingSettingsPanel, TableOfContents, ReaderToolbar)
|
||||||
|
6. Frontend page (ReadingPage)
|
||||||
|
7. Routing updates
|
||||||
|
8. CSS / theming
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
FROM node:20-alpine AS build
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
COPY package.json yarn.lock ./
|
|
||||||
COPY shared/package.json shared/
|
|
||||||
COPY frontend/package.json frontend/
|
|
||||||
|
|
||||||
RUN yarn install --frozen-lockfile
|
|
||||||
|
|
||||||
COPY shared/ shared/
|
|
||||||
COPY frontend/ frontend/
|
|
||||||
|
|
||||||
RUN yarn workspace @cloud-reader/shared build && \
|
|
||||||
yarn workspace @cloud-reader/frontend build
|
|
||||||
|
|
||||||
FROM nginx:alpine
|
|
||||||
COPY --from=build /app/frontend/dist /usr/share/nginx/html
|
|
||||||
COPY frontend/nginx.conf /etc/nginx/conf.d/default.conf
|
|
||||||
EXPOSE 80
|
|
||||||
@@ -4,7 +4,6 @@
|
|||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Cloud Reader</title>
|
<title>Cloud Reader</title>
|
||||||
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="root"></div>
|
<div id="root"></div>
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
server {
|
|
||||||
listen 80;
|
|
||||||
root /usr/share/nginx/html;
|
|
||||||
index index.html;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
try_files $uri $uri/ /index.html;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /api/ {
|
|
||||||
proxy_pass http://backend:8000;
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+16
-14
@@ -1,28 +1,30 @@
|
|||||||
{
|
{
|
||||||
"name": "@cloud-reader/frontend",
|
"name": "@cloud-reader/frontend",
|
||||||
"version": "0.1.0",
|
"version": "1.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
"build": "tsc -b && vite build",
|
"build": "tsc -b && vite build",
|
||||||
"preview": "vite preview",
|
"preview": "vite preview",
|
||||||
"typecheck": "tsc --noEmit",
|
"test": "vitest run",
|
||||||
"lint": "echo 'lint ok'"
|
"lint": "eslint ."
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@cloud-reader/shared": "*",
|
"react": "^19.0.0",
|
||||||
"react": "^18.3.0",
|
"react-dom": "^19.0.0",
|
||||||
"react-dom": "^18.3.0",
|
"react-router-dom": "^7.1.0",
|
||||||
"react-router-dom": "^6.26.0",
|
"axios": "^1.7.9"
|
||||||
"axios": "^1.7.0",
|
|
||||||
"zod": "^3.23.0"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/react": "^18.3.0",
|
"@types/react": "^19.0.0",
|
||||||
"@types/react-dom": "^18.3.0",
|
"@types/react-dom": "^19.0.0",
|
||||||
"@vitejs/plugin-react": "^4.3.0",
|
"@vitejs/plugin-react": "^4.3.4",
|
||||||
"typescript": "^5.5.0",
|
"typescript": "~5.7.0",
|
||||||
"vite": "^5.4.0"
|
"vite": "^6.0.0",
|
||||||
|
"vitest": "^2.1.0",
|
||||||
|
"@testing-library/react": "^16.2.0",
|
||||||
|
"@testing-library/jest-dom": "^6.6.3",
|
||||||
|
"jsdom": "^25.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+50
-31
@@ -1,43 +1,62 @@
|
|||||||
import React, { Suspense, lazy } from "react";
|
import React, { lazy, Suspense, useState } from "react";
|
||||||
import { Navigate, Route, Routes } from "react-router-dom";
|
import { BrowserRouter, Navigate, Route, Routes } from "react-router-dom";
|
||||||
import { useAuth } from "./hooks/useAuth";
|
import { AuthProvider, useAuth } from "./context/AuthContext";
|
||||||
|
|
||||||
const LoginPage = lazy(() => import("./pages/LoginPage"));
|
const LibraryPage = lazy(() => import("./pages/Library").then((m) => ({ default: m.LibraryPage })));
|
||||||
const RegisterPage = lazy(() => import("./pages/RegisterPage"));
|
const BookDetailPage = lazy(() => import("./pages/BookDetailPage").then((m) => ({ default: m.BookDetailPage })));
|
||||||
const LibraryPage = lazy(() => import("./pages/LibraryPage"));
|
const ReaderPage = lazy(() => import("./pages/Reader").then((m) => ({ default: m.ReaderPage })));
|
||||||
const DocumentPage = lazy(() => import("./pages/DocumentPage"));
|
const AddBookPage = lazy(() => import("./pages/AddBook").then((m) => ({ default: m.AddBookPage })));
|
||||||
const ReaderPage = lazy(() => import("./pages/ReaderPage"));
|
const EditEBookPage = lazy(() => import("./pages/EditEBook").then((m) => ({ default: m.EditEBookPage })));
|
||||||
const CollectionsPage = lazy(() => import("./pages/CollectionsPage"));
|
const SettingsPage = lazy(() => import("./pages/Settings").then((m) => ({ default: m.SettingsPage })));
|
||||||
const SettingsPage = lazy(() => import("./pages/SettingsPage"));
|
const BookmarksNotesPage = lazy(() => import("./components/annotations/BookmarksNotesPage").then((m) => ({ default: m.BookmarksNotesPage })));
|
||||||
|
const ReadingPage = lazy(() => import("./pages/ReadingPage").then((m) => ({ default: m.default })));
|
||||||
|
|
||||||
function ProtectedRoute({ children }: { children: React.ReactNode }): React.ReactElement {
|
const AuthPage = lazy(() =>
|
||||||
const { user, isLoading } = useAuth();
|
import("./pages/AuthPage").then((m) => ({
|
||||||
if (isLoading) return <div className="loading-screen">Loading...</div>;
|
default: () => {
|
||||||
if (!user) return <Navigate to="/login" replace />;
|
const [isLogin, setIsLogin] = useState(true);
|
||||||
|
return isLogin ? <m.LoginPage onToggle={() => setIsLogin(false)} /> : <m.RegisterPage onToggle={() => setIsLogin(true)} />;
|
||||||
|
},
|
||||||
|
})),
|
||||||
|
);
|
||||||
|
|
||||||
|
function LoadingFallback() {
|
||||||
|
return <div style={{ display: "flex", justifyContent: "center", alignItems: "center", minHeight: "100vh", color: "#888", fontSize: 16 }}><p>Loading...</p></div>;
|
||||||
|
}
|
||||||
|
|
||||||
|
function ProtectedRoute({ children }: { children: React.ReactNode }) {
|
||||||
|
const { isAuthenticated, loading } = useAuth();
|
||||||
|
if (loading) return <LoadingFallback />;
|
||||||
|
if (!isAuthenticated) return <Navigate to="/auth" replace />;
|
||||||
return <>{children}</>;
|
return <>{children}</>;
|
||||||
}
|
}
|
||||||
|
|
||||||
function PublicRoute({ children }: { children: React.ReactNode }): React.ReactElement {
|
function AppRoutes() {
|
||||||
const { user, isLoading } = useAuth();
|
const { isAuthenticated } = useAuth();
|
||||||
if (isLoading) return <div className="loading-screen">Loading...</div>;
|
|
||||||
if (user) return <Navigate to="/library" replace />;
|
|
||||||
return <>{children}</>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function App(): React.ReactElement {
|
|
||||||
return (
|
return (
|
||||||
<Suspense fallback={<div className="loading-screen">Loading...</div>}>
|
<Suspense fallback={<LoadingFallback />}>
|
||||||
<Routes>
|
<Routes>
|
||||||
<Route path="/login" element={<PublicRoute><LoginPage /></PublicRoute>} />
|
<Route path="/auth" element={isAuthenticated ? <Navigate to="/" replace /> : <AuthPage />} />
|
||||||
<Route path="/register" element={<PublicRoute><RegisterPage /></PublicRoute>} />
|
<Route path="/" element={<ProtectedRoute><LibraryPage /></ProtectedRoute>} />
|
||||||
<Route path="/library" element={<ProtectedRoute><LibraryPage /></ProtectedRoute>} />
|
<Route path="/books/:id" element={<ProtectedRoute><BookDetailPage /></ProtectedRoute>} />
|
||||||
<Route path="/documents/:id" element={<ProtectedRoute><DocumentPage /></ProtectedRoute>} />
|
<Route path="/reader/:id" element={<ProtectedRoute><ReaderPage /></ProtectedRoute>} />
|
||||||
<Route path="/read/:id" element={<ProtectedRoute><ReaderPage /></ProtectedRoute>} />
|
<Route path="/read/:id" element={<ProtectedRoute><ReadingPage /></ProtectedRoute>} />
|
||||||
<Route path="/collections" element={<ProtectedRoute><CollectionsPage /></ProtectedRoute>} />
|
<Route path="/add" element={<ProtectedRoute><AddBookPage /></ProtectedRoute>} />
|
||||||
|
<Route path="/edit/:id" element={<ProtectedRoute><EditEBookPage /></ProtectedRoute>} />
|
||||||
<Route path="/settings" element={<ProtectedRoute><SettingsPage /></ProtectedRoute>} />
|
<Route path="/settings" element={<ProtectedRoute><SettingsPage /></ProtectedRoute>} />
|
||||||
<Route path="/" element={<Navigate to="/library" replace />} />
|
<Route path="/bookmarks-notes/:bookId?" element={<ProtectedRoute><BookmarksNotesPage /></ProtectedRoute>} />
|
||||||
<Route path="*" element={<div className="not-found">Page not found</div>} />
|
<Route path="*" element={<Navigate to="/" replace />} />
|
||||||
</Routes>
|
</Routes>
|
||||||
</Suspense>
|
</Suspense>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export default function App() {
|
||||||
|
return (
|
||||||
|
<BrowserRouter>
|
||||||
|
<AuthProvider>
|
||||||
|
<AppRoutes />
|
||||||
|
</AuthProvider>
|
||||||
|
</BrowserRouter>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
import api from "@/api/client";
|
||||||
|
import type {
|
||||||
|
Bookmark,
|
||||||
|
CreateBookmarkPayload,
|
||||||
|
Note,
|
||||||
|
CreateNotePayload,
|
||||||
|
UpdateNotePayload,
|
||||||
|
PaginatedResponse,
|
||||||
|
} from "@/types";
|
||||||
|
|
||||||
|
/** Fetch bookmarks for the current user, optionally filtered by book */
|
||||||
|
export async function fetchBookmarks(
|
||||||
|
bookId?: string
|
||||||
|
): Promise<PaginatedResponse<Bookmark>> {
|
||||||
|
const params: Record<string, string> = {};
|
||||||
|
if (bookId) params.book = bookId;
|
||||||
|
const { data } = await api.get<PaginatedResponse<Bookmark>>(
|
||||||
|
"/annotations/bookmarks/",
|
||||||
|
{ params }
|
||||||
|
);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Create a new bookmark */
|
||||||
|
export async function createBookmark(
|
||||||
|
payload: CreateBookmarkPayload
|
||||||
|
): Promise<Bookmark> {
|
||||||
|
const { data } = await api.post<Bookmark>(
|
||||||
|
"/annotations/bookmarks/",
|
||||||
|
payload
|
||||||
|
);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Delete a bookmark by id */
|
||||||
|
export async function deleteBookmark(id: string): Promise<void> {
|
||||||
|
await api.delete(`/annotations/bookmarks/${id}/`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Batch delete bookmarks */
|
||||||
|
export async function batchDeleteBookmarks(
|
||||||
|
ids: string[]
|
||||||
|
): Promise<{ deleted: number }> {
|
||||||
|
const { data } = await api.delete<{ deleted: number }>(
|
||||||
|
"/annotations/bookmarks/batch-delete/",
|
||||||
|
{ data: { ids } }
|
||||||
|
);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Fetch notes for the current user, optionally filtered by book */
|
||||||
|
export async function fetchNotes(
|
||||||
|
bookId?: string
|
||||||
|
): Promise<PaginatedResponse<Note>> {
|
||||||
|
const params: Record<string, string> = {};
|
||||||
|
if (bookId) params.book = bookId;
|
||||||
|
const { data } = await api.get<PaginatedResponse<Note>>(
|
||||||
|
"/annotations/notes/",
|
||||||
|
{ params }
|
||||||
|
);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Create a new note */
|
||||||
|
export async function createNote(payload: CreateNotePayload): Promise<Note> {
|
||||||
|
const { data } = await api.post<Note>("/annotations/notes/", payload);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Update a note's content */
|
||||||
|
export async function updateNote(
|
||||||
|
id: string,
|
||||||
|
payload: UpdateNotePayload
|
||||||
|
): Promise<Note> {
|
||||||
|
const { data } = await api.patch<Note>(
|
||||||
|
`/annotations/notes/${id}/`,
|
||||||
|
payload
|
||||||
|
);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Delete a note by id */
|
||||||
|
export async function deleteNote(id: string): Promise<void> {
|
||||||
|
await api.delete(`/annotations/notes/${id}/`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Batch delete notes */
|
||||||
|
export async function batchDeleteNotes(
|
||||||
|
ids: string[]
|
||||||
|
): Promise<{ deleted: number }> {
|
||||||
|
const { data } = await api.delete<{ deleted: number }>(
|
||||||
|
"/annotations/notes/batch-delete/",
|
||||||
|
{ data: { ids } }
|
||||||
|
);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
import axios from "axios";
|
||||||
|
|
||||||
|
const api = axios.create({
|
||||||
|
baseURL: "/api",
|
||||||
|
headers: {
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Attach JWT token to every request
|
||||||
|
api.interceptors.request.use((config) => {
|
||||||
|
const token = localStorage.getItem("access_token");
|
||||||
|
if (token) {
|
||||||
|
config.headers.Authorization = `Bearer ${token}`;
|
||||||
|
}
|
||||||
|
return config;
|
||||||
|
});
|
||||||
|
|
||||||
|
// Attempt token refresh on 401
|
||||||
|
let isRefreshing = false;
|
||||||
|
let pendingRequests: Array<(token: string) => void> = [];
|
||||||
|
|
||||||
|
api.interceptors.response.use(
|
||||||
|
(response) => response,
|
||||||
|
async (error) => {
|
||||||
|
const originalRequest = error.config;
|
||||||
|
if (error.response?.status !== 401 || originalRequest._retry) {
|
||||||
|
return Promise.reject(error);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isRefreshing) {
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
pendingRequests.push((token: string) => {
|
||||||
|
originalRequest.headers.Authorization = `Bearer ${token}`;
|
||||||
|
resolve(api(originalRequest));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
originalRequest._retry = true;
|
||||||
|
isRefreshing = true;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const refreshToken = localStorage.getItem("refresh_token");
|
||||||
|
if (!refreshToken) {
|
||||||
|
throw new Error("No refresh token");
|
||||||
|
}
|
||||||
|
const { data } = await axios.post("/api/auth/token/refresh/", {
|
||||||
|
refresh: refreshToken,
|
||||||
|
});
|
||||||
|
localStorage.setItem("access_token", data.access);
|
||||||
|
pendingRequests.forEach((cb) => cb(data.access));
|
||||||
|
pendingRequests = [];
|
||||||
|
originalRequest.headers.Authorization = `Bearer ${data.access}`;
|
||||||
|
return api(originalRequest);
|
||||||
|
} catch {
|
||||||
|
localStorage.removeItem("access_token");
|
||||||
|
localStorage.removeItem("refresh_token");
|
||||||
|
window.location.href = "/login";
|
||||||
|
return Promise.reject(error);
|
||||||
|
} finally {
|
||||||
|
isRefreshing = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
export default api;
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
/**
|
||||||
|
* API client for the reader module — reading settings, chapters, and progress.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type {
|
||||||
|
ChapterDetail,
|
||||||
|
ChapterSummary,
|
||||||
|
ReadingProgress,
|
||||||
|
ReadingSettings,
|
||||||
|
} from "../types/reader";
|
||||||
|
|
||||||
|
const API_BASE = "/api";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch the current user's reading settings.
|
||||||
|
* Auto-creates defaults on the server if none exist.
|
||||||
|
*/
|
||||||
|
export async function getReadingSettings(): Promise<ReadingSettings> {
|
||||||
|
const response = await fetch(`${API_BASE}/reader/settings/`);
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to fetch reading settings: ${response.status} ${response.statusText}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return response.json() as Promise<ReadingSettings>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update (full or partial) the user's reading settings.
|
||||||
|
*/
|
||||||
|
export async function updateReadingSettings(
|
||||||
|
settings: Partial<ReadingSettings>
|
||||||
|
): Promise<ReadingSettings> {
|
||||||
|
const method = settings.theme !== undefined ? "PUT" : "PATCH";
|
||||||
|
const response = await fetch(`${API_BASE}/reader/settings/`, {
|
||||||
|
method,
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
body: JSON.stringify(settings),
|
||||||
|
});
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to update reading settings: ${response.status} ${response.statusText}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return response.json() as Promise<ReadingSettings>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch the table of contents (chapter list) for a book.
|
||||||
|
*/
|
||||||
|
export async function getChapters(bookId: number): Promise<ChapterSummary[]> {
|
||||||
|
const response = await fetch(`${API_BASE}/books/${bookId}/chapters/`);
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to fetch chapters: ${response.status} ${response.statusText}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return response.json() as Promise<ChapterSummary[]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch a specific chapter with full content for reading.
|
||||||
|
*/
|
||||||
|
export async function getChapterContent(
|
||||||
|
bookId: number,
|
||||||
|
chapterNumber: number
|
||||||
|
): Promise<ChapterDetail> {
|
||||||
|
const response = await fetch(
|
||||||
|
`${API_BASE}/books/${bookId}/chapters/${chapterNumber}/`
|
||||||
|
);
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to fetch chapter ${chapterNumber}: ${response.status} ${response.statusText}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return response.json() as Promise<ChapterDetail>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch reading progress for a book.
|
||||||
|
*/
|
||||||
|
export async function getReadingProgress(
|
||||||
|
bookId: number
|
||||||
|
): Promise<ReadingProgress> {
|
||||||
|
const response = await fetch(`${API_BASE}/books/${bookId}/progress/`);
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to fetch reading progress: ${response.status} ${response.statusText}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return response.json() as Promise<ReadingProgress>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update reading progress for a book.
|
||||||
|
*/
|
||||||
|
export async function updateReadingProgress(
|
||||||
|
bookId: number,
|
||||||
|
progress: Partial<ReadingProgress>
|
||||||
|
): Promise<ReadingProgress> {
|
||||||
|
const response = await fetch(`${API_BASE}/books/${bookId}/progress/`, {
|
||||||
|
method: "PUT",
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
body: JSON.stringify(progress),
|
||||||
|
});
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to update reading progress: ${response.status} ${response.statusText}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return response.json() as Promise<ReadingProgress>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
import React, { useState } from "react";
|
||||||
|
import { useAnnotations } from "@/context/AnnotationsContext";
|
||||||
|
|
||||||
|
interface AddAnnotationFormProps {
|
||||||
|
bookId: string;
|
||||||
|
page: number;
|
||||||
|
locationText?: string;
|
||||||
|
onClose?: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function AddAnnotationForm({
|
||||||
|
bookId,
|
||||||
|
page,
|
||||||
|
locationText,
|
||||||
|
onClose,
|
||||||
|
}: AddAnnotationFormProps): React.ReactElement {
|
||||||
|
const { addBookmark, addNote } = useAnnotations();
|
||||||
|
const [mode, setMode] = useState<"bookmark" | "note" | null>(null);
|
||||||
|
const [noteContent, setNoteContent] = useState("");
|
||||||
|
const [submitting, setSubmitting] = useState(false);
|
||||||
|
const [error, setError] = useState<string | null>(null);
|
||||||
|
|
||||||
|
const handleSubmit = async (): Promise<void> => {
|
||||||
|
setSubmitting(true);
|
||||||
|
setError(null);
|
||||||
|
try {
|
||||||
|
if (mode === "bookmark") {
|
||||||
|
await addBookmark({ book: bookId, page, location_text: locationText });
|
||||||
|
} else if (mode === "note") {
|
||||||
|
if (!noteContent.trim()) {
|
||||||
|
setError("Note content cannot be empty.");
|
||||||
|
setSubmitting(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await addNote({
|
||||||
|
book: bookId,
|
||||||
|
page,
|
||||||
|
location_text: locationText,
|
||||||
|
content: noteContent.trim(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
onClose?.();
|
||||||
|
} catch (err) {
|
||||||
|
setError(
|
||||||
|
err instanceof Error ? err.message : "Failed to save annotation."
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
setSubmitting(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="add-annotation-overlay">
|
||||||
|
<div className="add-annotation-modal">
|
||||||
|
<button className="modal-close" onClick={onClose} aria-label="Close">
|
||||||
|
×
|
||||||
|
</button>
|
||||||
|
<h3>Add to Page {page}</h3>
|
||||||
|
{locationText && (
|
||||||
|
<blockquote className="annotation-quote">
|
||||||
|
“{locationText}”
|
||||||
|
</blockquote>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{!mode ? (
|
||||||
|
<div className="mode-selector">
|
||||||
|
<button
|
||||||
|
className="btn btn-block"
|
||||||
|
onClick={() => setMode("bookmark")}
|
||||||
|
>
|
||||||
|
Add Bookmark
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
className="btn btn-block btn-secondary"
|
||||||
|
onClick={() => setMode("note")}
|
||||||
|
>
|
||||||
|
Add Note
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
) : (
|
||||||
|
<div className="annotation-form">
|
||||||
|
{mode === "note" && (
|
||||||
|
<div className="form-group">
|
||||||
|
<label htmlFor="note-content">Note:</label>
|
||||||
|
<textarea
|
||||||
|
id="note-content"
|
||||||
|
className="form-textarea"
|
||||||
|
value={noteContent}
|
||||||
|
onChange={(e: React.ChangeEvent<HTMLTextAreaElement>) =>
|
||||||
|
setNoteContent(e.target.value)
|
||||||
|
}
|
||||||
|
rows={5}
|
||||||
|
placeholder="Write your note here..."
|
||||||
|
autoFocus
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{error && <div className="form-error">{error}</div>}
|
||||||
|
<div className="form-actions">
|
||||||
|
<button
|
||||||
|
className="btn"
|
||||||
|
onClick={handleSubmit}
|
||||||
|
disabled={submitting}
|
||||||
|
>
|
||||||
|
{submitting ? "Saving..." : "Save"}
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
className="btn btn-secondary"
|
||||||
|
onClick={() => setMode(null)}
|
||||||
|
disabled={submitting}
|
||||||
|
>
|
||||||
|
Back
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
import React from "react";
|
||||||
|
import { useAnnotations } from "@/context/AnnotationsContext";
|
||||||
|
import type { AnnotationEntry } from "@/types";
|
||||||
|
|
||||||
|
interface AnnotationsDashboardProps {
|
||||||
|
bookId?: string;
|
||||||
|
onNavigateToPage?: (bookId: string, page: number) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function AnnotationsDashboard({
|
||||||
|
bookId,
|
||||||
|
onNavigateToPage,
|
||||||
|
}: AnnotationsDashboardProps): React.ReactElement {
|
||||||
|
const {
|
||||||
|
mergedAnnotations,
|
||||||
|
loadBookmarks,
|
||||||
|
loadNotes,
|
||||||
|
removeBookmark,
|
||||||
|
removeNote,
|
||||||
|
state,
|
||||||
|
} = useAnnotations();
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
loadBookmarks(bookId);
|
||||||
|
loadNotes(bookId);
|
||||||
|
}, [loadBookmarks, loadNotes, bookId]);
|
||||||
|
|
||||||
|
const handleDelete = async (entry: AnnotationEntry): Promise<void> => {
|
||||||
|
if (entry.kind === "bookmark") {
|
||||||
|
await removeBookmark(entry.id);
|
||||||
|
} else {
|
||||||
|
await removeNote(entry.id);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
if (state.bookmarksLoading || state.notesLoading) {
|
||||||
|
return <div className="annotations-loading">Loading annotations...</div>;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (mergedAnnotations.length === 0) {
|
||||||
|
return (
|
||||||
|
<div className="annotations-empty">
|
||||||
|
No bookmarks or notes yet.
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="annotations-dashboard">
|
||||||
|
<div className="annotations-summary">
|
||||||
|
<span className="summary-count">
|
||||||
|
{state.bookmarks.length} bookmarks
|
||||||
|
</span>
|
||||||
|
<span className="summary-separator">·</span>
|
||||||
|
<span className="summary-count">
|
||||||
|
{state.notes.length} notes
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div className="annotations-list">
|
||||||
|
{mergedAnnotations.map((entry: AnnotationEntry) => (
|
||||||
|
<div key={`${entry.kind}-${entry.id}`} className="annotation-card">
|
||||||
|
<div className="annotation-card-header">
|
||||||
|
<span
|
||||||
|
className={`annotation-kind-badge ${
|
||||||
|
entry.kind === "bookmark" ? "bookmark-badge" : "note-badge"
|
||||||
|
}`}
|
||||||
|
>
|
||||||
|
{entry.kind === "bookmark" ? "Bookmark" : "Note"}
|
||||||
|
</span>
|
||||||
|
<span className="annotation-book-title">
|
||||||
|
{entry.book_title}
|
||||||
|
</span>
|
||||||
|
<span className="annotation-page">p.{entry.page}</span>
|
||||||
|
<span className="annotation-date">
|
||||||
|
{new Date(entry.created_at).toLocaleDateString()}
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
{entry.location_text && (
|
||||||
|
<blockquote className="annotation-quote">
|
||||||
|
“{entry.location_text}”
|
||||||
|
</blockquote>
|
||||||
|
)}
|
||||||
|
{entry.kind === "note" && entry.content && (
|
||||||
|
<p className="note-content-text">{entry.content}</p>
|
||||||
|
)}
|
||||||
|
<div className="annotation-actions">
|
||||||
|
{onNavigateToPage && (
|
||||||
|
<button
|
||||||
|
className="btn btn-sm"
|
||||||
|
onClick={() =>
|
||||||
|
onNavigateToPage(entry.book_id, entry.page)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Go to page
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
<button
|
||||||
|
className="btn btn-sm btn-danger"
|
||||||
|
onClick={() => handleDelete(entry)}
|
||||||
|
>
|
||||||
|
Delete
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
import React, { useState } from "react";
|
||||||
|
import { useAnnotations } from "@/context/AnnotationsContext";
|
||||||
|
import type { Bookmark } from "@/types";
|
||||||
|
|
||||||
|
interface BookmarkListProps {
|
||||||
|
bookId?: string;
|
||||||
|
onNavigateToPage?: (bookId: string, page: number) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function BookmarkList({
|
||||||
|
bookId,
|
||||||
|
onNavigateToPage,
|
||||||
|
}: BookmarkListProps): React.ReactElement {
|
||||||
|
const { state, loadBookmarks, removeBookmark } = useAnnotations();
|
||||||
|
const [deletingId, setDeletingId] = useState<string | null>(null);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
loadBookmarks(bookId);
|
||||||
|
}, [loadBookmarks, bookId]);
|
||||||
|
|
||||||
|
const handleDelete = async (id: string): Promise<void> => {
|
||||||
|
setDeletingId(id);
|
||||||
|
try {
|
||||||
|
await removeBookmark(id);
|
||||||
|
} catch {
|
||||||
|
// error handled by context
|
||||||
|
} finally {
|
||||||
|
setDeletingId(null);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
if (state.bookmarksLoading) {
|
||||||
|
return <div className="annotations-loading">Loading bookmarks...</div>;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (state.bookmarks.length === 0) {
|
||||||
|
return (
|
||||||
|
<div className="annotations-empty">
|
||||||
|
No bookmarks yet. Select a passage and add a bookmark while reading.
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="annotations-list">
|
||||||
|
{state.bookmarks.map((bookmark: Bookmark) => (
|
||||||
|
<div key={bookmark.id} className="annotation-card">
|
||||||
|
<div className="annotation-card-header">
|
||||||
|
<span className="annotation-kind-badge bookmark-badge">
|
||||||
|
Bookmark
|
||||||
|
</span>
|
||||||
|
<span className="annotation-page">
|
||||||
|
Page {bookmark.page}
|
||||||
|
</span>
|
||||||
|
<span className="annotation-date">
|
||||||
|
{new Date(bookmark.created_at).toLocaleDateString()}
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
{bookmark.location_text && (
|
||||||
|
<blockquote className="annotation-quote">
|
||||||
|
“{bookmark.location_text}”
|
||||||
|
</blockquote>
|
||||||
|
)}
|
||||||
|
<div className="annotation-actions">
|
||||||
|
{onNavigateToPage && (
|
||||||
|
<button
|
||||||
|
className="btn btn-sm"
|
||||||
|
onClick={() =>
|
||||||
|
onNavigateToPage(bookmark.book, bookmark.page)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Go to page
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
<button
|
||||||
|
className="btn btn-sm btn-danger"
|
||||||
|
onClick={() => handleDelete(bookmark.id)}
|
||||||
|
disabled={deletingId === bookmark.id}
|
||||||
|
>
|
||||||
|
{deletingId === bookmark.id ? "Deleting..." : "Delete"}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import React from "react";
|
||||||
|
import { AnnotationsDashboard } from "@/components/annotations";
|
||||||
|
|
||||||
|
interface BookmarksNotesPageProps {
|
||||||
|
bookId?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function BookmarksNotesPage({
|
||||||
|
bookId,
|
||||||
|
}: BookmarksNotesPageProps): React.ReactElement {
|
||||||
|
return (
|
||||||
|
<div className="page">
|
||||||
|
<h2>Bookmarks & Notes</h2>
|
||||||
|
<AnnotationsDashboard
|
||||||
|
bookId={bookId}
|
||||||
|
onNavigateToPage={(bookId, page) => {
|
||||||
|
// Navigate to the book reader page at the specific page
|
||||||
|
window.location.href = `/books/${bookId}?page=${page}`;
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user