prune_captcha 1.3.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

captcha_prune/__init__.py

@@ -0,0 +1 @@
+default_app_config = "django_puzzle.apps.DjangoPuzzleConfig"

captcha_prune/apps.py

@@ -0,0 +1,13 @@
+from django.apps import AppConfig
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+
+
+class DjangoPuzzleConfig(AppConfig):
+    name = "django_puzzle"
+
+    def ready(self):
+        if not hasattr(settings, "PUZZLE_IMAGE_STATIC_PATH"):
+            raise ImproperlyConfigured(
+                "django-puzzle: vous devez définir PUZZLE_IMAGE_STATIC_PATH dans settings.py"
+            )

captcha_prune/context_processors.py

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

@@ -3,8 +3,10 @@ import uuid
 
 from django.db import models
 
+from commons.base_model import BaseModel
 
-class Captcha(models.Model):
+
+class Captcha(BaseModel):
     uuid = models.UUIDField(default=uuid.uuid4, unique=True)
     width = models.IntegerField(default=350)
     height = models.IntegerField(default=200)

captcha_prune/utils.py

@@ -0,0 +1,68 @@
+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_path = getattr(settings, "PUZZLE_IMAGE_STATIC_PATH", None)
+    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(puzzle_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": 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)

prune_captcha-1.4.0.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: prune_captcha
+Version: 1.4.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
+Requires-Dist: requests>=2.32.3
+
+# 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
+```
+
+### 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
+```
+
+### Updating the captcha
+
+Don't hesitate to regularly run `poetry update`, as the captcha evolves with time and our practices!
+
+## Captcha Integration
+
+### Configuration
+
+In `settings.py`, set the path to the images used for the puzzle:
+
+```python
+PUZZLE_IMAGE_STATIC_PATH = "website/images/"
+```
+
+### Utilisation
+
+-   GET request (form display)
+
+    -   Use create_and_get_puzzle to generate the captcha data.
+
+    -   Passes the data into the context under the puzzle variable.
+
+    -   Include the component in your template:
+
+        ```python
+        from captcha_prune.utils import create_and_get_puzzle
+        ```
+
+        ```
+        {% include "captcha_prune/components/captcha.html" %}
+        ```
+
+-   POST request (form submission)
+
+        -   Use verify_captcha to validate the captcha.
+
+            ```python
+            from captcha_prune.utils import verify_captcha
+            ```
+
+            ```python
+            verify_captcha(request, redirect("/"), redirect("website:contact-page"), form)
+            ```
+
+        -   No feedback if the captcha is correct.
+
+        -   Redirects in case of expired session or incorrect captcha.
+
+### 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)
+        else:
+            form = ContactForm()
+            puzzle = create_and_get_puzzle(request)
+    return render(
+        request,
+        "website/pages/contact/page.html",
+        {"form": form, "puzzle": puzzle},
+    )
+
+```
+
+# Available Versions
+
+| Version | Date       | Notes                              |
+| ------- | ---------- | ---------------------------------- |
+| 1.4.0   | 2025-05-20 | added BaseModel in Captcha, ...    |
+| 1.3.0   | 2025-04-30 | deleted start_server, deleted ...  |
+| 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.3.0.dist-info → prune_captcha-1.4.0.dist-info}/RECORD

@@ -1,9 +1,12 @@
-captcha_prune/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+captcha_prune/__init__.py,sha256=chKlxXsXZCpq_Ae-w6o8J0xR-oUimw8ECGuCLu7Ntu0,61
+captcha_prune/apps.py,sha256=aBtviQsU3gIRCPeeJyVMAvjoza6oh34-NEWtB9klnvg,422
 captcha_prune/asgi.py,sha256=wi2rRLFltXOZyve8mAB_E8udaFyONOf5N42WrWIQX8M,403
-captcha_prune/models.py,sha256=3IwEWBl5ykZEivE5FGU0jUZKZGVkhvCuMh1HFehjYFU,1201
+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=fInmwfuDWyR3oRfVYpeHUj2JfjvATZHMUcKQkTXKPD0,2351
 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
@@ -14,7 +17,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.3.0.dist-info/METADATA,sha256=r8T7YZU23h9uZsGiAJoofqGaYbKZpFlH4TnQE7c-18E,2282
-prune_captcha-1.3.0.dist-info/WHEEL,sha256=ooBFpIzZCPdw3uqIQsOo4qqbA4ZRPxHnOH7peeONza0,91
-prune_captcha-1.3.0.dist-info/top_level.txt,sha256=EB4h0WF_YGF7kAWB0XtqmuloOhkL5pC71CzgEVYam7w,28
-prune_captcha-1.3.0.dist-info/RECORD,,
+prune_captcha-1.4.0.dist-info/METADATA,sha256=u2jmNK0J8rDB7fNs3a1LOHH_vT35hd6PnQEk5cyijx4,3745
+prune_captcha-1.4.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+prune_captcha-1.4.0.dist-info/top_level.txt,sha256=EB4h0WF_YGF7kAWB0XtqmuloOhkL5pC71CzgEVYam7w,28
+prune_captcha-1.4.0.dist-info/RECORD,,

{prune_captcha-1.3.0.dist-info → prune_captcha-1.4.0.dist-info}/WHEEL

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

prune_captcha-1.3.0.dist-info/METADATA

@@ -1,77 +0,0 @@
-Metadata-Version: 2.4
-Name: prune_captcha
-Version: 1.3.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
-```
-
-### 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
-```
-
-### 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 |