prune_captcha 1.12.1__py3-none-any.whl → 1.13.0__py3-none-any.whl

captcha_prune/utils.py

@@ -2,14 +2,16 @@ import os
 import random
 
 from django.conf import settings
-from django.shortcuts import get_object_or_404
+from django.http import HttpRequest
 
-from captcha_prune.models import Captcha
-
-
-def create_and_get_captcha() -> dict:
-    captcha = Captcha.objects.create()
 
+def create_and_get_captcha(
+    request, *, width=350, height=200, piece_width=80, piece_height=50, precision=2
+) -> dict:
+    pos_x_solution = random.randint(0, width - piece_width)
+    pos_y_solution = random.randint(0, height - piece_height)
+    piece_pos_x = random.randint(0, width - piece_width)
+    piece_pos_y = random.randint(0, height - piece_height)
     _, _, puzzle_images_path = settings.PUZZLE_IMAGE_STATIC_PATH.rpartition("static/")
     puzzle_images = [
         f
@@ -17,27 +19,33 @@ def create_and_get_captcha() -> dict:
         if f.lower().endswith((".jpg", ".jpeg", ".png", ".gif", ".webp"))
     ]
     selected_image = random.choice(puzzle_images)
-
+    request.session["pos_x_solution"] = pos_x_solution
+    request.session["pos_y_solution"] = pos_y_solution
+    request.session["precision"] = precision
     return {
-        "uuid": 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,
+        "width": width,
+        "height": height,
+        "piece_width": piece_width,
+        "piece_height": piece_height,
+        "pos_x_solution": pos_x_solution,
+        "pos_y_solution": pos_y_solution,
+        "piece_pos_x": piece_pos_x,
+        "piece_pos_y": piece_pos_y,
         "image": f"{puzzle_images_path}{selected_image}",
     }
 
 
-def verify_captcha(puzzle_uuid: str, pos_x_answer: int, pos_y_answer: int) -> bool:
-    captcha = get_object_or_404(Captcha, uuid=puzzle_uuid)
-
+def verify_captcha(request: HttpRequest) -> bool:
+    pos_x_answer = request.POST.get("pos_x_answer")
+    pos_y_answer = request.POST.get("pos_Y_answer")
+    if pos_x_answer is None or pos_y_answer is None:
+        return False
+    pos_x_solution = request.session.get("pos_x_solution")
+    pos_y_solution = request.session.get("pos_y_solution")
+    precision = request.session.get("precision")
     if (
-        abs(captcha.pos_x_solution - pos_x_answer) <= captcha.precision
-        and abs(captcha.pos_y_solution - pos_y_answer) <= captcha.precision
+        abs(pos_x_solution - pos_x_answer) <= precision
+        and abs(pos_y_solution - pos_y_answer) <= precision
     ):
         return True
     else:

{prune_captcha-1.12.1.dist-info → prune_captcha-1.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prune_captcha
-Version: 1.12.1
+Version: 1.13.0
 Summary: A tool to protect formulaire from spam.
 Author-email: Arnout <bastien@prune.sh>
 Project-URL: Made_by, https://prune.sh/
@@ -64,6 +64,8 @@ In `settings.py`, set the path to the images used for the puzzle:
 PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/puzzles/"
 ```
 
+Important: You must import the static files (css, js) present in "captcha_prune/static/".
+
 ### Utilisation
 
 -   GET request (form display)
@@ -96,24 +98,26 @@ PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/puzzles/"
 
 -   POST request (form submission)
 
-        -   Use verify_captcha to validate the captcha:
+    -   Use verify_captcha to validate the captcha:
 
-            ```python
-            from captcha_prune.utils import verify_captcha
-            ```
+        ```python
+        from captcha_prune.utils import verify_captcha
+        ```
 
-            ```python
-            response = verify_captcha(request)
-            ```
+        ```python
+        response = verify_captcha(request)
+        ```
 
-        -   True if the captcha is correct, else False.
+    -   True if the captcha is correct, else False.
 
-        -   Redirects in case of  incorrect captcha.
+    -   Redirects in case of incorrect captcha.
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 1.13.0  | 2025-05-21 | use session, add static            |
+| 1.12.2  | 2025-05-21 | doc fixed                          |
 | 1.12.1  | 2025-05-21 | doc fixed                          |
 | 1.12.0  | 2025-05-21 | removed views, added utils, ...    |
 | 1.11.0  | 2025-05-21 | removed utils                      |

prune_captcha-1.13.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+captcha_prune/__init__.py,sha256=JerrqDuZCUa8pj_9pEv68rnlPsiXovRP4biKpCqyThs,61
+captcha_prune/apps.py,sha256=WVAz3WWaPAgM7-Ojd_Cl2KVdcub1n-03qpnRyu2ToTo,422
+captcha_prune/utils.py,sha256=0wgRNCfmAAugFh5sw3qk-YqvNMiMZgJRtd6QlpRa-D8,1861
+prune_captcha-1.13.0.dist-info/METADATA,sha256=4z0bIAlKrXm8__Isw5WjZArvgJKZ_1KpQOtSxwmSI40,3707
+prune_captcha-1.13.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+prune_captcha-1.13.0.dist-info/top_level.txt,sha256=01HnLL5Bu66yMBCvNpNBzN0L6AxTdG1_1YFSJr3dI2w,14
+prune_captcha-1.13.0.dist-info/RECORD,,

{prune_captcha-1.12.1.dist-info → prune_captcha-1.13.0.dist-info}/top_level.txt

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

captcha_prune/asgi.py

@@ -1,16 +0,0 @@
-"""
-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

@@ -1,29 +0,0 @@
-# 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

@@ -1,73 +0,0 @@
-# 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/migrations/0003_captcha_created_at_captcha_updated_at.py

@@ -1,25 +0,0 @@
-# Generated by Django 5.2 on 2025-05-20 09:12
-
-import django.utils.timezone
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('captcha_prune', '0002_remove_captcha_created_at_remove_captcha_pos_x_and_more'),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name='captcha',
-            name='created_at',
-            field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now),
-            preserve_default=False,
-        ),
-        migrations.AddField(
-            model_name='captcha',
-            name='updated_at',
-            field=models.DateTimeField(auto_now=True),
-        ),
-    ]

captcha_prune/models.py

@@ -1,34 +0,0 @@
-import random
-import uuid
-
-from django.db import models
-
-from commons.base_model import BaseModel
-
-
-class Captcha(BaseModel):
-    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

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

captcha_prune/settings.py

@@ -1,130 +0,0 @@
-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/wsgi.py

@@ -1,16 +0,0 @@
-"""
-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

@@ -1,9 +0,0 @@
-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

prune_captcha-1.12.1.dist-info/RECORD

@@ -1,20 +0,0 @@
-captcha_prune/__init__.py,sha256=JerrqDuZCUa8pj_9pEv68rnlPsiXovRP4biKpCqyThs,61
-captcha_prune/apps.py,sha256=WVAz3WWaPAgM7-Ojd_Cl2KVdcub1n-03qpnRyu2ToTo,422
-captcha_prune/asgi.py,sha256=wi2rRLFltXOZyve8mAB_E8udaFyONOf5N42WrWIQX8M,403
-captcha_prune/models.py,sha256=O8nxhVfPat3oaDGZzd88kQHkGayQIWZ_dOO9uu1R6P4,1240
-captcha_prune/payloads.py,sha256=PwR48xKg9YEgGgoJmGe7ywwFPCqM4gumomyFunn-Ems,115
-captcha_prune/settings.py,sha256=YEZHEjYYYK-cH3gSLIR3a7g4Bypnuf_5eMTTcm719CE,3395
-captcha_prune/utils.py,sha256=bEOMAA4jatS9eAgHEHpq0qNHjkCrywDGHAn81JPwbuo,1352
-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/0003_captcha_created_at_captcha_updated_at.py,sha256=qT9cTDe3coiWXYbYfBlK4iEYg71E9B2FGuo74Wy_gbA,698
-captcha_prune/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-commons/base_model.py,sha256=q1Q7lgtvN_t6ujhEiSsNNXb_ay0qY6FbfK0Zm2Hdgp0,213
-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.12.1.dist-info/METADATA,sha256=oZ7iPR5MtlgIcFcwYhH_WvLJVJyTlm4Yqdwpfq9DaYM,3529
-prune_captcha-1.12.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-prune_captcha-1.12.1.dist-info/top_level.txt,sha256=EB4h0WF_YGF7kAWB0XtqmuloOhkL5pC71CzgEVYam7w,28
-prune_captcha-1.12.1.dist-info/RECORD,,

tests/captcha_prune/test_views.py

@@ -1,67 +0,0 @@
-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)