prune_captcha 1.11.0__tar.gz → 1.12.1__tar.gz

{prune_captcha-1.11.0 → prune_captcha-1.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prune_captcha
-Version: 1.11.0
+Version: 1.12.1
 Summary: A tool to protect formulaire from spam.
 Author-email: Arnout <bastien@prune.sh>
 Project-URL: Made_by, https://prune.sh/
@@ -61,21 +61,21 @@ 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/static/website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/puzzles/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_captcha_view to generate the captcha data:
+    -   Use create_and_get_captcha to generate the captcha data:
 
         ```python
-        from captcha_prune.views import create_captcha_view
+        from captcha_prune.utils import create_and_get_captcha
         ```
 
         ```python
-        puzzle = create_captcha_view(request)
+        puzzle = create_and_get_captcha(request)
         ```
 
     -   Passes the data into the context under the puzzle variable:
@@ -96,53 +96,26 @@ PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 
 -   POST request (form submission)
 
-        -   Use verify_captcha_view to validate the captcha:
+        -   Use verify_captcha to validate the captcha:
 
             ```python
-            from captcha_prune.views import verify_captcha_view
+            from captcha_prune.utils import verify_captcha
             ```
 
             ```python
-            response = verify_captcha_view(request)
+            response = verify_captcha(request)
             ```
 
         -   True if the captcha is correct, else False.
 
-        -   Redirects in case of expired session or incorrect captcha:
-
-            ```python
-            if response is False:
-                return redirect("website:contact-page")
-            ```
-
-### Example
-
-    ```python
-    def contact_view(request):
-        if request.method == "POST":
-            form = ContactForm(request.POST)
-            if form.is_valid():
-                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:
-            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},
-    )
-    ```
+        -   Redirects in case of  incorrect captcha.
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 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                      |
 | 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
 | 1.9.0   | 2025-05-20 | puzzle images path fixed           |

{prune_captcha-1.11.0 → prune_captcha-1.12.1}/README.md

@@ -43,21 +43,21 @@ 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/static/website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/puzzles/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_captcha_view to generate the captcha data:
+    -   Use create_and_get_captcha to generate the captcha data:
 
         ```python
-        from captcha_prune.views import create_captcha_view
+        from captcha_prune.utils import create_and_get_captcha
         ```
 
         ```python
-        puzzle = create_captcha_view(request)
+        puzzle = create_and_get_captcha(request)
         ```
 
     -   Passes the data into the context under the puzzle variable:
@@ -78,53 +78,26 @@ PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 
 -   POST request (form submission)
 
-        -   Use verify_captcha_view to validate the captcha:
+        -   Use verify_captcha to validate the captcha:
 
             ```python
-            from captcha_prune.views import verify_captcha_view
+            from captcha_prune.utils import verify_captcha
             ```
 
             ```python
-            response = verify_captcha_view(request)
+            response = verify_captcha(request)
             ```
 
         -   True if the captcha is correct, else False.
 
-        -   Redirects in case of expired session or incorrect captcha:
-
-            ```python
-            if response is False:
-                return redirect("website:contact-page")
-            ```
-
-### Example
-
-    ```python
-    def contact_view(request):
-        if request.method == "POST":
-            form = ContactForm(request.POST)
-            if form.is_valid():
-                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:
-            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},
-    )
-    ```
+        -   Redirects in case of  incorrect captcha.
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 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                      |
 | 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
 | 1.9.0   | 2025-05-20 | puzzle images path fixed           |

prune_captcha-1.11.0/captcha_prune/views.py → prune_captcha-1.12.1/captcha_prune/utils.py

@@ -2,22 +2,13 @@ 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
 
 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) -> dict:
+def create_and_get_captcha() -> dict:
     captcha = Captcha.objects.create()
-    request.session["puzzle_uuid"] = captcha.uuid
 
     _, _, puzzle_images_path = settings.PUZZLE_IMAGE_STATIC_PATH.rpartition("static/")
     puzzle_images = [
@@ -41,16 +32,7 @@ def create_captcha_view(request: HttpRequest) -> dict:
     }
 
 
-@require_GET
-@use_payload(PuzzleAnswerPayload)
-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
+def verify_captcha(puzzle_uuid: str, pos_x_answer: int, pos_y_answer: int) -> bool:
     captcha = get_object_or_404(Captcha, uuid=puzzle_uuid)
 
     if (
@@ -59,5 +41,4 @@ def verify_captcha_view(request: HttpRequest, payload: PuzzleAnswerPayload) -> b
     ):
         return True
     else:
-        messages.error(request, "Captcha incorrect. Veuillez réessayer.")
         return False

{prune_captcha-1.11.0 → prune_captcha-1.12.1}/prune_captcha.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prune_captcha
-Version: 1.11.0
+Version: 1.12.1
 Summary: A tool to protect formulaire from spam.
 Author-email: Arnout <bastien@prune.sh>
 Project-URL: Made_by, https://prune.sh/
@@ -61,21 +61,21 @@ 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/static/website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/puzzles/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_captcha_view to generate the captcha data:
+    -   Use create_and_get_captcha to generate the captcha data:
 
         ```python
-        from captcha_prune.views import create_captcha_view
+        from captcha_prune.utils import create_and_get_captcha
         ```
 
         ```python
-        puzzle = create_captcha_view(request)
+        puzzle = create_and_get_captcha(request)
         ```
 
     -   Passes the data into the context under the puzzle variable:
@@ -96,53 +96,26 @@ PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 
 -   POST request (form submission)
 
-        -   Use verify_captcha_view to validate the captcha:
+        -   Use verify_captcha to validate the captcha:
 
             ```python
-            from captcha_prune.views import verify_captcha_view
+            from captcha_prune.utils import verify_captcha
             ```
 
             ```python
-            response = verify_captcha_view(request)
+            response = verify_captcha(request)
             ```
 
         -   True if the captcha is correct, else False.
 
-        -   Redirects in case of expired session or incorrect captcha:
-
-            ```python
-            if response is False:
-                return redirect("website:contact-page")
-            ```
-
-### Example
-
-    ```python
-    def contact_view(request):
-        if request.method == "POST":
-            form = ContactForm(request.POST)
-            if form.is_valid():
-                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:
-            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},
-    )
-    ```
+        -   Redirects in case of  incorrect captcha.
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 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                      |
 | 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
 | 1.9.0   | 2025-05-20 | puzzle images path fixed           |

{prune_captcha-1.11.0 → prune_captcha-1.12.1}/prune_captcha.egg-info/SOURCES.txt

@@ -6,15 +6,13 @@ captcha_prune/asgi.py
 captcha_prune/models.py
 captcha_prune/payloads.py
 captcha_prune/settings.py
-captcha_prune/urls.py
-captcha_prune/views.py
+captcha_prune/utils.py
 captcha_prune/wsgi.py
 captcha_prune/migrations/0001_initial.py
 captcha_prune/migrations/0002_remove_captcha_created_at_remove_captcha_pos_x_and_more.py
 captcha_prune/migrations/0003_captcha_created_at_captcha_updated_at.py
 captcha_prune/migrations/__init__.py
 commons/base_model.py
-commons/decorators.py
 prune_captcha.egg-info/PKG-INFO
 prune_captcha.egg-info/SOURCES.txt
 prune_captcha.egg-info/dependency_links.txt

{prune_captcha-1.11.0 → prune_captcha-1.12.1}/pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
 keywords = ["captcha", "django", "code-quality"]
 urls = {Made_by = "https://prune.sh/"}
 name = "prune_captcha"
-version = "1.11.0"
+version = "1.12.1"
 description = "A tool to protect formulaire from spam."
 readme = "README.md"
 dependencies = [

prune_captcha-1.11.0/captcha_prune/urls.py

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

prune_captcha-1.11.0/commons/decorators.py

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