prune_captcha 1.9.0__py3-none-any.whl → 1.11.0__py3-none-any.whl

captcha_prune/urls.py

@@ -5,6 +5,6 @@ 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"),
+    path("create/", create_captcha_view, name="create-captcha"),
+    path("verify/", verify_captcha_view, name="verify-captcha"),
 ]

captcha_prune/views.py

@@ -1,4 +1,9 @@
-from django.http import HttpRequest, HttpResponse, JsonResponse
+import os
+import random
+
+from django.conf import settings
+from django.contrib import messages
+from django.http import HttpRequest
 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
@@ -10,36 +15,49 @@ from commons.decorators import use_payload
 
 @require_POST
 @csrf_exempt
-def create_captcha_view(request: HttpRequest) -> HttpResponse:
+def create_captcha_view(request: HttpRequest) -> dict:
     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,
-        },
-    )
+    request.session["puzzle_uuid"] = captcha.uuid
+
+    _, _, puzzle_images_path = settings.PUZZLE_IMAGE_STATIC_PATH.rpartition("static/")
+    puzzle_images = [
+        f
+        for f in os.listdir(settings.PUZZLE_IMAGE_STATIC_PATH)
+        if f.lower().endswith((".jpg", ".jpeg", ".png", ".gif", ".webp"))
+    ]
+    selected_image = random.choice(puzzle_images)
+
+    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,
+        "image": f"{puzzle_images_path}{selected_image}",
+    }
 
 
 @require_GET
 @use_payload(PuzzleAnswerPayload)
-def verify_captcha_view(
-    request: HttpRequest, uuid: str, payload: PuzzleAnswerPayload
-) -> HttpResponse:
-    captcha = get_object_or_404(Captcha, uuid=uuid)
+def verify_captcha_view(request: HttpRequest, payload: PuzzleAnswerPayload) -> bool:
     pos_x_answer = payload.pos_x_answer
     pos_y_answer = payload.pos_y_answer
+
+    puzzle_uuid = request.session.get("puzzle_uuid")
+    if not puzzle_uuid:
+        messages.error(request, "La session a expiré.")
+        return False
+    captcha = get_object_or_404(Captcha, uuid=puzzle_uuid)
+
     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)
+        return True
     else:
-        return HttpResponse(status=401)
+        messages.error(request, "Captcha incorrect. Veuillez réessayer.")
+        return False

{prune_captcha-1.9.0.dist-info → prune_captcha-1.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prune_captcha
-Version: 1.9.0
+Version: 1.11.0
 Summary: A tool to protect formulaire from spam.
 Author-email: Arnout <bastien@prune.sh>
 Project-URL: Made_by, https://prune.sh/
@@ -61,81 +61,90 @@ Don't hesitate to regularly run `poetry update`, as the captcha evolves with tim
 In `settings.py`, set the path to the images used for the puzzle:
 
 ```python
-PUZZLE_IMAGE_STATIC_PATH = "website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_and_get_puzzle to generate the captcha data.
+    -   Use create_captcha_view to generate the captcha data:
 
-    -   Passes the data into the context under the puzzle variable.
+        ```python
+        from captcha_prune.views import create_captcha_view
+        ```
 
-    -   Include the component in your template:
+        ```python
+        puzzle = create_captcha_view(request)
+        ```
+
+    -   Passes the data into the context under the puzzle variable:
 
         ```python
-        from captcha_prune.utils import create_and_get_puzzle
+        return render(
+            request,
+            "website/pages/contact/page.html",
+            {"form": form, "puzzle": puzzle},
+        )
         ```
 
+    -   Include the component in your template:
+
         ```
         {% include "captcha_prune/captcha.html" %}
         ```
 
 -   POST request (form submission)
 
-        -   Use verify_captcha to validate the captcha.
+        -   Use verify_captcha_view to validate the captcha:
 
             ```python
-            from captcha_prune.utils import verify_captcha
+            from captcha_prune.views import verify_captcha_view
             ```
 
             ```python
-            verify_captcha(request, redirect("/"), redirect("website:contact-page"), form)
+            response = verify_captcha_view(request)
             ```
 
-        -   No feedback if the captcha is correct.
+        -   True if the captcha is correct, else False.
 
-        -   Redirects in case of expired session or incorrect captcha.
+        -   Redirects in case of expired session or incorrect captcha:
+
+            ```python
+            if response is False:
+                return redirect("website:contact-page")
+            ```
 
 ### Example
 
     ```python
-    from django.shortcuts import render, redirect
-
-    from django.contrib import messages
-    from captcha_prune.utils import create_and_get_puzzle, verify_captcha
-    from .forms import ContactForm
-
     def contact_view(request):
         if request.method == "POST":
             form = ContactForm(request.POST)
             if form.is_valid():
-                verify_captcha(
-                    request,
-                    redirect("/"),
-                    redirect("website:contact-page"),
-                    form
-                )
-                messages.success(request, "Formulaire soumis avec succès.")
-                return redirect("/")
-            else:
-                puzzle = create_and_get_puzzle(request)
+                response = verify_captcha_view(request)
+            if response is False:
+                return redirect("website:contact-page")
+            messages.success(request, "Formulaire soumis avec succès.")
+            return redirect("/")
         else:
-            form = ContactForm()
-            puzzle = create_and_get_puzzle(request)
+            puzzle = create_captcha_view(request)
+    else:
+        form = ContactForm()
+        puzzle = create_captcha_view(request)
     return render(
         request,
         "website/pages/contact/page.html",
         {"form": form, "puzzle": puzzle},
     )
-
-```
+    ```
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 1.11.0  | 2025-05-21 | removed utils                      |
+| 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
 | 1.9.0   | 2025-05-20 | puzzle images path fixed           |
 | 1.8.0   | 2025-05-20 | added migrations                   |
 | 1.7.0   | 2025-05-20 | PUZZLE_IMAGE_STATIC_PATH ...       |
@@ -146,4 +155,3 @@ PUZZLE_IMAGE_STATIC_PATH = "website/images/"
 | 1.2.0   | 2025-04-30 | fixed prune_captcha command, ...   |
 | 1.1.0   | 2025-04-30 | start_server was not a module, ... |
 | 1.0.0   | 2025-04-29 | First version of the `captcha` ... |
-```

{prune_captcha-1.9.0.dist-info → prune_captcha-1.11.0.dist-info}/RECORD

@@ -1,13 +1,11 @@
 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/context_processors.py,sha256=RTHgIxoje5n2wr1YvefbgUlvwNfiCe7Eyz9VKVoN4ZA,383
 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/urls.py,sha256=DeCJTjJA0krW27KoHafvh3GBRr7fJ80E2lVHEWYSsW4,271
-captcha_prune/utils.py,sha256=3AYKlLxLUdGf9SBGg5Mgzym7LlxBpDhYv4ITFFZ0nAc,2415
-captcha_prune/views.py,sha256=BzjQfXLwYx2YSWODrnGpokqU8XeC-9QORivzWKxYofY,1539
+captcha_prune/urls.py,sha256=0G1O0CO53iBW_QT5vlvyN1UzsWxxZiiooqApx6f3MeU,274
+captcha_prune/views.py,sha256=Y4F3zhq5uYpPuHs-0eI8dpn_-02Vbqw-JURK3fTE7tg,2095
 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
@@ -18,7 +16,7 @@ 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.9.0.dist-info/METADATA,sha256=DwghxRFP3rjicLaneox0e0MhSs62IIdOXomKud1WNw0,4044
-prune_captcha-1.9.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-prune_captcha-1.9.0.dist-info/top_level.txt,sha256=EB4h0WF_YGF7kAWB0XtqmuloOhkL5pC71CzgEVYam7w,28
-prune_captcha-1.9.0.dist-info/RECORD,,
+prune_captcha-1.11.0.dist-info/METADATA,sha256=moZ4qiAgMV2a0wkTqUj8EPkISZgck95t6n_hvE6cVFQ,4259
+prune_captcha-1.11.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+prune_captcha-1.11.0.dist-info/top_level.txt,sha256=EB4h0WF_YGF7kAWB0XtqmuloOhkL5pC71CzgEVYam7w,28
+prune_captcha-1.11.0.dist-info/RECORD,,

{prune_captcha-1.9.0.dist-info → prune_captcha-1.11.0.dist-info}/WHEEL

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

captcha_prune/context_processors.py

@@ -1,12 +0,0 @@
-from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
-
-
-def puzzle_static_path(request):
-    try:
-        path = settings.PUZZLE_IMAGE_STATIC_PATH
-    except AttributeError:
-        raise ImproperlyConfigured(
-            "Vous devez définir PUZZLE_IMAGE_STATIC_PATH dans votre settings.py"
-        )
-    return {"PUZZLE_IMAGE_STATIC_PATH": path}

captcha_prune/utils.py

@@ -1,68 +0,0 @@
-import os
-import random
-from urllib.parse import urlencode
-
-import requests
-from django.conf import settings
-from django.contrib import messages
-from django.http import HttpRequest, HttpResponse
-from django.urls import reverse
-
-
-def create_and_get_puzzle(request: HttpRequest) -> HttpResponse | dict:
-    _, _, puzzle_images_path = settings.PUZZLE_IMAGE_STATIC_PATH.rpartition("static/")
-    try:
-        response = requests.post(
-            request.build_absolute_uri(reverse("captcha:create-captcha"))
-        ).json()
-    except requests.RequestException:
-        return HttpResponse(status=502)
-    request.session["puzzle_uuid"] = response["uuid"]
-    puzzle_images = [
-        f
-        for f in os.listdir(settings.PUZZLE_IMAGE_STATIC_PATH)
-        if f.lower().endswith((".jpg", ".jpeg", ".png", ".gif"))
-    ]
-    selected_image = random.choice(puzzle_images)
-    return {
-        "uuid": response["uuid"],
-        "width": response["width"],
-        "height": response["height"],
-        "piece_width": response["piece_width"],
-        "piece_height": response["piece_height"],
-        "pos_x_solution": response["pos_x_solution"],
-        "pos_y_solution": response["pos_y_solution"],
-        "piece_pos_x": response["piece_pos_x"],
-        "piece_pos_y": response["piece_pos_y"],
-        "image": f"{puzzle_images_path}{selected_image}",
-    }
-
-
-def verify_captcha(
-    request: HttpRequest,
-    session_expired: HttpResponse,
-    incorrect_captcha: HttpResponse,
-    form,
-) -> HttpResponse | None:
-    puzzle_uuid = request.session.get("puzzle_uuid")
-    if not puzzle_uuid:
-        messages.error(request, "La session a expiré.")
-        return session_expired
-    try:
-        base_url = request.build_absolute_uri(
-            reverse("captcha:verify-captcha", kwargs={"uuid": puzzle_uuid}),
-        )
-        data = {
-            "pos_x_answer": request.POST.get("pos_x_answer"),
-            "pos_y_answer": request.POST.get("pos_y_answer"),
-        }
-        query_string = urlencode(data)
-        full_url = f"{base_url}?{query_string}"
-        response = requests.get(full_url)
-        if response.status_code == 401:
-            messages.error(request, "Captcha incorrect. Veuillez réessayer.")
-            return incorrect_captcha
-        del form.fields["pos_x_answer"]
-        del form.fields["pos_y_answer"]
-    except requests.RequestException:
-        return HttpResponse(status=502)