prune_captcha 1.0.0__py3-none-any.whl

captcha_prune/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for captcha_prune project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'captcha_prune.settings')
+
+application = get_asgi_application()

captcha_prune/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.2 on 2025-04-28 10:19
+
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Captcha',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('uuid', models.UUIDField(default=uuid.uuid4, unique=True)),
+                ('pos_x', models.IntegerField()),
+                ('pos_y', models.IntegerField()),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

captcha_prune/migrations/0002_remove_captcha_created_at_remove_captcha_pos_x_and_more.py

@@ -0,0 +1,73 @@
+# Generated by Django 5.2 on 2025-04-29 07:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("captcha_prune", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="captcha",
+            name="created_at",
+        ),
+        migrations.RemoveField(
+            model_name="captcha",
+            name="pos_x",
+        ),
+        migrations.RemoveField(
+            model_name="captcha",
+            name="pos_y",
+        ),
+        migrations.RemoveField(
+            model_name="captcha",
+            name="updated_at",
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="height",
+            field=models.IntegerField(default=200),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="piece_height",
+            field=models.IntegerField(default=50),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="piece_pos_x",
+            field=models.IntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="piece_pos_y",
+            field=models.IntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="piece_width",
+            field=models.IntegerField(default=80),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="pos_x_solution",
+            field=models.IntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="pos_y_solution",
+            field=models.IntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="precision",
+            field=models.IntegerField(default=2),
+        ),
+        migrations.AddField(
+            model_name="captcha",
+            name="width",
+            field=models.IntegerField(default=350),
+        ),
+    ]

captcha_prune/models.py

@@ -0,0 +1,32 @@
+import random
+import uuid
+
+from django.db import models
+
+
+class Captcha(models.Model):
+    uuid = models.UUIDField(default=uuid.uuid4, unique=True)
+    width = models.IntegerField(default=350)
+    height = models.IntegerField(default=200)
+    pos_x_solution = models.IntegerField(null=True, blank=True)
+    pos_y_solution = models.IntegerField(null=True, blank=True)
+    piece_pos_x = models.IntegerField(null=True, blank=True)
+    piece_pos_y = models.IntegerField(null=True, blank=True)
+    piece_width = models.IntegerField(default=80)
+    piece_height = models.IntegerField(default=50)
+    precision = models.IntegerField(default=2)
+
+    def save(self, *args, **kwargs):
+        if self.pos_x_solution is None:
+            self.pos_x_solution = random.randint(0, self.width - self.piece_width)
+
+        if self.pos_y_solution is None:
+            self.pos_y_solution = random.randint(0, self.height - self.piece_height)
+
+        if self.piece_pos_x is None:
+            self.piece_pos_x = random.randint(0, self.width - self.piece_width)
+
+        if self.piece_pos_y is None:
+            self.piece_pos_y = random.randint(0, self.height - self.piece_height)
+
+        super().save(*args, **kwargs)

captcha_prune/payloads.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class PuzzleAnswerPayload(BaseModel):
+    pos_x_answer: int
+    pos_y_answer: int

captcha_prune/settings.py

@@ -0,0 +1,130 @@
+from pathlib import Path
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class EnvSettings(BaseSettings):
+    model_config = SettingsConfigDict(env_file=".env", extra="allow")
+
+    postgres_db: str
+    postgres_user: str
+    postgres_password: str
+    postgres_host: str
+    postgres_port: str
+
+
+env_settings = EnvSettings()
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-dj-w%-kno*r5w=e_&l1sl3)9kl%m25(3ikoc=z_%p5-0d5472%"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "captcha_prune",
+]
+
+MIDDLEWARE = [
+    "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 = "captcha_prune.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "captcha_prune.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": env_settings.postgres_db,
+        "USER": env_settings.postgres_user,
+        "PASSWORD": env_settings.postgres_password,
+        "HOST": env_settings.postgres_host,
+        "PORT": env_settings.postgres_port,
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.2/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

captcha_prune/urls.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from captcha_prune.views import create_captcha_view, verify_captcha_view
+
+app_name = "captcha"
+
+urlpatterns = [
+    path("", create_captcha_view, name="create-captcha"),
+    path("<str:uuid>/", verify_captcha_view, name="verify-captcha"),
+]

captcha_prune/views.py

@@ -0,0 +1,45 @@
+from django.http import HttpRequest, HttpResponse, JsonResponse
+from django.shortcuts import get_object_or_404
+from django.views.decorators.csrf import csrf_exempt
+from django.views.decorators.http import require_GET, require_POST
+
+from captcha_prune.models import Captcha
+from captcha_prune.payloads import PuzzleAnswerPayload
+from commons.decorators import use_payload
+
+
+@require_POST
+@csrf_exempt
+def create_captcha_view(request: HttpRequest) -> HttpResponse:
+    captcha = Captcha.objects.create()
+    return JsonResponse(
+        status=201,
+        data={
+            "uuid": str(captcha.uuid),
+            "width": captcha.width,
+            "height": captcha.height,
+            "piece_width": captcha.piece_width,
+            "piece_height": captcha.piece_height,
+            "pos_x_solution": captcha.pos_x_solution,
+            "pos_y_solution": captcha.pos_y_solution,
+            "piece_pos_x": captcha.piece_pos_x,
+            "piece_pos_y": captcha.piece_pos_y,
+        },
+    )
+
+
+@require_GET
+@use_payload(PuzzleAnswerPayload)
+def verify_captcha_view(
+    request: HttpRequest, uuid: str, payload: PuzzleAnswerPayload
+) -> HttpResponse:
+    captcha = get_object_or_404(Captcha, uuid=uuid)
+    pos_x_answer = payload.pos_x_answer
+    pos_y_answer = payload.pos_y_answer
+    if (
+        abs(captcha.pos_x_solution - pos_x_answer) <= captcha.precision
+        and abs(captcha.pos_y_solution - pos_y_answer) <= captcha.precision
+    ):
+        return HttpResponse(status=304)
+    else:
+        return HttpResponse(status=401)

captcha_prune/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for captcha_prune project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'captcha_prune.settings')
+
+application = get_wsgi_application()

commons/base_model.py

@@ -0,0 +1,9 @@
+from django.db import models
+
+
+class BaseModel(models.Model):
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        abstract = True

commons/decorators.py

@@ -0,0 +1,41 @@
+import functools
+from typing import get_origin
+
+from django.http import HttpResponse
+from pydantic import ValidationError
+
+
+def use_payload(payload_class):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(request, *args, **kwargs):
+            data = {}
+
+            if request.method == "POST":
+                body = request.POST
+            elif request.method == "GET":
+                body = request.GET
+            else:
+                raise NotImplementedError
+
+            for field_name, field in payload_class.model_fields.items():
+                url_name = field.alias if field.alias else field_name
+                is_list_field = get_origin(field.annotation) is list
+                url_value = (
+                    body.getlist(url_name) if is_list_field else body.get(url_name)
+                )
+                if url_value is not None:
+                    data[url_name] = url_value
+
+            try:
+                payload = payload_class.model_validate(data)
+            except ValidationError as e:
+                return HttpResponse(
+                    e.json(), headers={"content_type": "application/json"}, status=400
+                )
+
+            return func(request, *args, payload=payload, **kwargs)
+
+        return wrapper
+
+    return decorator

prune_captcha-1.0.0.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: prune_captcha
+Version: 1.0.0
+Summary: A tool to protect formulaire from spam.
+Author-email: Arnout <bastien@prune.sh>
+Project-URL: Made_by, https://prune.sh/
+Keywords: captcha,django,code-quality
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: <4.0,>=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: django>=5.2
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: pydantic>=2.11.4
+Requires-Dist: pydantic-settings>=2.9.1
+
+# Prune's Captcha
+
+## What is it for?
+
+Captcha helps prevent robots from spamming using your forms.
+
+## Prerequisites
+
+-   To be installed on a Prune Django project that uses poetry or UV
+
+## UV project
+
+### Installation
+
+Run the following command in the console:
+
+```bash
+uv add captcha_prune
+```
+
+### Running the captcha
+
+To run the package, simply enter in the console:
+
+```bash
+captcha_prune
+```
+
+### Updating the captcha
+
+Don't hesitate to regularly run `uv sync --upgrade`, as the captcha evolves with time and our practices!
+
+## Poetry project
+
+### Installation
+
+Run the following command:
+
+```bash
+poetry add prune_captcha
+```
+
+### Running the captcha
+
+```bash
+poetry run prune_captcha
+```
+
+### Updating the captcha
+
+Don't hesitate to regularly run `poetry update`, as the captcha evolves with time and our practices!
+
+## Captcha Integration
+
+Once the project is launched, the application's URLs need to be linked to the form.
+
+-   When making a **GET** request to the form page, the API must be called via the **creation endpoint**. The response will contain the necessary information to display the captcha.
+-   When submitting the form via **POST**, the API must be called via the **verification endpoint**. The response will indicate whether the captcha is valid or not.
+
+## Captcha Display
+
+To display the captcha correctly, use the data received in the response from the creation request. This data includes:
+
+-   the captcha's width and height,
+-   the piece's width and height,
+-   the current position of the piece,
+-   the target position (where the piece should be placed),
+-   the expected precision (captcha difficulty level).
+
+# Available Versions
+
+| Version | Date       | Notes                                  |
+| ------- | ---------- | -------------------------------------- |
+| 1.0.0   | 2025-03-14 | First version of the `captcha` package |

prune_captcha-1.0.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+captcha_prune/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+captcha_prune/asgi.py,sha256=wi2rRLFltXOZyve8mAB_E8udaFyONOf5N42WrWIQX8M,403
+captcha_prune/models.py,sha256=3IwEWBl5ykZEivE5FGU0jUZKZGVkhvCuMh1HFehjYFU,1201
+captcha_prune/payloads.py,sha256=PwR48xKg9YEgGgoJmGe7ywwFPCqM4gumomyFunn-Ems,115
+captcha_prune/settings.py,sha256=YEZHEjYYYK-cH3gSLIR3a7g4Bypnuf_5eMTTcm719CE,3395
+captcha_prune/urls.py,sha256=DeCJTjJA0krW27KoHafvh3GBRr7fJ80E2lVHEWYSsW4,271
+captcha_prune/views.py,sha256=BzjQfXLwYx2YSWODrnGpokqU8XeC-9QORivzWKxYofY,1539
+captcha_prune/wsgi.py,sha256=fukA_iiCT4FFzcJ0QX2Zr_HNddqdq-ln3ien2UWcCTA,403
+captcha_prune/migrations/0001_initial.py,sha256=QMTaeSIxPociSrV4r89zfsbxMwMu4qpL16LT3yPgcaw,831
+captcha_prune/migrations/0002_remove_captcha_created_at_remove_captcha_pos_x_and_more.py,sha256=xyyE_G3t8kJqFvKuNWFRTyTyyD1kzvfeSgbkTQ9DO8A,2099
+captcha_prune/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+commons/base_model.py,sha256=q1Q7lgtvN_t6ujhEiSsNNXb_ay0qY6FbfK0Zm2Hdgp0,213
+commons/decorators.py,sha256=nU_3SyxENcWDdxo03VyNYEvoevplC6ig7BFogY8apNs,1306
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/captcha_prune/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/captcha_prune/test_views.py,sha256=h-Mrdiprh71s7kIJPYAt6xv4G_S7vp51WCpAzy4CZ6U,2364
+prune_captcha-1.0.0.dist-info/METADATA,sha256=bUB-rBL654MCCPo0kmTGlwmCHtfkA-DDr56hPjpkALI,2447
+prune_captcha-1.0.0.dist-info/WHEEL,sha256=ooBFpIzZCPdw3uqIQsOo4qqbA4ZRPxHnOH7peeONza0,91
+prune_captcha-1.0.0.dist-info/entry_points.txt,sha256=_7zxh1tub_wWQu9oo5vcYIJAEQMPmTj0ekh0oXJ_8FM,52
+prune_captcha-1.0.0.dist-info/top_level.txt,sha256=EB4h0WF_YGF7kAWB0XtqmuloOhkL5pC71CzgEVYam7w,28
+prune_captcha-1.0.0.dist-info/RECORD,,

prune_captcha-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

prune_captcha-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+prune_captcha = start_server:main

prune_captcha-1.0.0.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+captcha_prune
+commons
+tests

tests/captcha_prune/test_views.py

@@ -0,0 +1,67 @@
+import uuid
+
+from django.test import TestCase
+from django.urls import reverse
+
+from captcha_prune.models import Captcha
+
+
+class CreateCaptchaViewTestCase(TestCase):
+    def test_create_captcha_with_GET_method(self):
+        response = self.client.get(reverse("create-captcha"))
+        self.assertEqual(response.status_code, 405)
+
+    def test_create_captcha_with_POST_method(self):
+        response = self.client.post(reverse("create-captcha"))
+        self.assertEqual(response.status_code, 201)
+
+        data = response.json()
+        captcha = Captcha.objects.get(uuid=data["uuid"])
+        self.assertIsNotNone(captcha)
+
+
+class VerifyCaptchaViewTestCase(TestCase):
+    def setUp(self):
+        self.captcha = Captcha.objects.create()
+        self.pos_x_solution = self.captcha.pos_x_solution
+        self.pos_y_solution = self.captcha.pos_y_solution
+
+    def test_verify_captcha_with_POST_method(self):
+        response = self.client.post(
+            reverse("verify-captcha", kwargs={"uuid": str(uuid.uuid4())}),
+            data={
+                "pos_x_answer": self.pos_x_solution,
+                "pos_y_answer": self.pos_y_solution,
+            },
+        )
+        self.assertEqual(response.status_code, 405)
+
+    def test_verify_captcha_with_bad_uuid(self):
+        response = self.client.get(
+            reverse("verify-captcha", kwargs={"uuid": str(uuid.uuid4())}),
+            data={
+                "pos_x_answer": self.pos_x_solution,
+                "pos_y_answer": self.pos_y_solution,
+            },
+        )
+        self.assertEqual(response.status_code, 404)
+
+    def test_verify_captcha_with_good_uuid_but_bad_answer(self):
+        response = self.client.get(
+            reverse("verify-captcha", kwargs={"uuid": str(self.captcha.uuid)}),
+            data={
+                "pos_x_answer": self.pos_x_solution - 20,
+                "pos_y_answer": self.pos_y_solution - 20,
+            },
+        )
+        self.assertEqual(response.status_code, 401)
+
+    def test_verify_captcha_with_good_uuid_and_good_answer(self):
+        response = self.client.get(
+            reverse("verify-captcha", kwargs={"uuid": str(self.captcha.uuid)}),
+            data={
+                "pos_x_answer": self.pos_x_solution,
+                "pos_y_answer": self.pos_y_solution,
+            },
+        )
+        self.assertEqual(response.status_code, 304)