splent-feature-recaptcha 0.2.1__tar.gz

splent_feature_recaptcha-0.2.1/MANIFEST.in

@@ -0,0 +1,8 @@
+# Compiled frontend bundles
+recursive-include src/splent_io/splent_feature_recaptcha/assets/dist *.js *.css *.map
+
+# Jinja templates (feature views + hook fragments)
+recursive-include src/splent_io/splent_feature_recaptcha/templates *.html
+
+# Alembic migration config and scripts
+recursive-include src/splent_io/splent_feature_recaptcha/migrations *.py *.ini *.mako

splent_feature_recaptcha-0.2.1/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: splent_feature_recaptcha
+Version: 0.2.1
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown

splent_feature_recaptcha-0.2.1/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=80.3.1", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splent_feature_recaptcha"
+version = "0.2.1"
+readme = "README.md"
+requires-python = ">=3.13"
+
+dependencies = [
+
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["*.tests", "*.tests.*"]
+
+[tool.splent]
+cli_version = "1.11.0"
+
+# ── Feature Contract (auto-generated) ────────────────────────────────────────
+# Do not edit manually — re-run `splent feature:contract --write` to refresh.
+# Preserved across refreshes: description, category, tags, env, and
+# requires.features_manual (dependencies invisible to static analysis).
+[tool.splent.contract]
+description = "Google reCAPTCHA protection for comment and contact forms"
+archetype = "light"
+
+[tool.splent.contract.provides]
+routes     = ["/admin/captcha"]
+blueprints = []
+models     = []
+commands   = ["hello"]
+hooks      = ["layout.authenticated_sidebar"]
+services   = ["CaptchaService"]
+signals    = []
+translations = []
+docker     = []
+
+[tool.splent.contract.requires]
+features = ["settings"]
+env_vars = ["RECAPTCHA_SECRET_KEY", "RECAPTCHA_SITE_KEY"]
+signals  = ["comment-submitting", "contact-submitting"]
+
+[tool.splent.contract.extensible]
+services  = ["CaptchaService"]
+templates = ["recaptcha/admin/settings.html"]
+models    = []
+hooks     = ["layout.authenticated_sidebar"]
+routes    = false

splent_feature_recaptcha-0.2.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

splent_feature_recaptcha-0.2.1/src/splent_feature_recaptcha.egg-info/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: splent_feature_recaptcha
+Version: 0.2.1
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown

splent_feature_recaptcha-0.2.1/src/splent_feature_recaptcha.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+MANIFEST.in
+pyproject.toml
+src/splent_feature_recaptcha.egg-info/PKG-INFO
+src/splent_feature_recaptcha.egg-info/SOURCES.txt
+src/splent_feature_recaptcha.egg-info/dependency_links.txt
+src/splent_feature_recaptcha.egg-info/top_level.txt
+src/splent_io/splent_feature_recaptcha/__init__.py
+src/splent_io/splent_feature_recaptcha/commands.py
+src/splent_io/splent_feature_recaptcha/config.py
+src/splent_io/splent_feature_recaptcha/hooks.py
+src/splent_io/splent_feature_recaptcha/routes.py
+src/splent_io/splent_feature_recaptcha/services.py
+src/splent_io/splent_feature_recaptcha/signals.py
+src/splent_io/splent_feature_recaptcha/templates/recaptcha/admin/settings.html

splent_feature_recaptcha-0.2.1/src/splent_feature_recaptcha.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

splent_feature_recaptcha-0.2.1/src/splent_feature_recaptcha.egg-info/top_level.txt

@@ -0,0 +1 @@
+splent_io

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/__init__.py

@@ -0,0 +1,22 @@
+from splent_framework.blueprints.base_blueprint import create_blueprint
+from splent_framework.services.service_locator import register_service, service_proxy
+
+from splent_io.splent_feature_recaptcha.services import RecaptchaService
+
+recaptcha_bp = create_blueprint(__name__)
+
+
+def init_feature(app):
+    # Generic "CaptchaService" name so consumers stay provider-agnostic; this is
+    # the Google reCAPTCHA implementation of the 'captcha' alternative.
+    register_service(app, "CaptchaService", RecaptchaService)
+
+
+def inject_context_vars(app):
+    def captcha_widget():
+        return service_proxy("CaptchaService").widget()
+
+    def captcha_script():
+        return service_proxy("CaptchaService").script_tag()
+
+    return {"captcha_widget": captcha_widget, "captcha_script": captcha_script}

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/commands.py

@@ -0,0 +1,21 @@
+"""
+CLI commands contributed by splent_feature_recaptcha.
+
+These commands are auto-discovered by the framework and exposed in the
+SPLENT CLI under the ``feature:recaptcha`` group.
+
+Usage::
+
+    splent feature:recaptcha hello
+"""
+
+import click
+
+
+@click.command("hello")
+def hello():
+    """Example command — replace with your own."""
+    click.echo("  Hello from splent_feature_recaptcha!")
+
+
+cli_commands = [hello]

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/config.py

@@ -0,0 +1,21 @@
+"""Google reCAPTCHA v2 configuration (anti-spam CAPTCHA).
+
+Set RECAPTCHA_SITE_KEY / RECAPTCHA_SECRET_KEY in the product's .env (dev/prod),
+or configure them from the admin panel. Defaults are Google's official TEST
+keys (always pass), so development works out of the box.
+"""
+
+import os
+
+# Google's documented reCAPTCHA v2 test keys: always pass, safe for dev.
+_TEST_SITE_KEY = "6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI"
+_TEST_SECRET_KEY = "6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe"
+
+
+def inject_config(app):
+    app.config.update(
+        {
+            "RECAPTCHA_SITE_KEY": os.getenv("RECAPTCHA_SITE_KEY", _TEST_SITE_KEY),
+            "RECAPTCHA_SECRET_KEY": os.getenv("RECAPTCHA_SECRET_KEY", _TEST_SECRET_KEY),
+        }
+    )

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/hooks.py

@@ -0,0 +1,23 @@
+from flask import request, url_for
+
+from splent_framework.hooks.template_hooks import register_template_hook
+
+
+def recaptcha_admin_link():
+    """Sidebar entry for the Captcha settings screen (the WP-plugin pattern)."""
+    active = (
+        "active"
+        if request.endpoint and request.endpoint.startswith("recaptcha.admin")
+        else ""
+    )
+    return (
+        f'<li class="sidebar-item {active}">'
+        f'<a class="sidebar-link" href="{url_for("recaptcha.admin_settings")}">'
+        '<i class="align-middle" data-feather="shield"></i> '
+        '<span class="align-middle">Captcha</span>'
+        "</a>"
+        "</li>"
+    )
+
+
+register_template_hook("layout.authenticated_sidebar", recaptcha_admin_link)

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/routes.py

@@ -0,0 +1,28 @@
+from flask import flash, redirect, render_template, request, url_for
+from flask_login import login_required
+
+from splent_io.splent_feature_recaptcha import recaptcha_bp
+from splent_framework.services.service_locator import service_proxy
+
+# Setting keys edited by the Captcha settings panel.
+CAPTCHA_FIELDS = [
+    "recaptcha_site_key",
+    "recaptcha_secret_key",
+]
+
+
+@recaptcha_bp.route("/admin/captcha", methods=["GET", "POST"])
+@login_required
+def admin_settings():
+    """Captcha settings panel for Google reCAPTCHA.
+
+    Edits the site/secret keys and persists them via SettingsService. The
+    RecaptchaService reads these keys back, so changes apply immediately.
+    """
+    if request.method == "POST":
+        values = {field: request.form.get(field, "") for field in CAPTCHA_FIELDS}
+        service_proxy("SettingsService").set_many(values)
+        flash("Captcha settings updated.", "success")
+        return redirect(url_for("recaptcha.admin_settings"))
+
+    return render_template("recaptcha/admin/settings.html")

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/services.py

@@ -0,0 +1,70 @@
+import requests
+from flask import current_app
+from markupsafe import Markup
+
+from splent_framework.services.service_locator import service_proxy
+
+VERIFY_URL = "https://www.google.com/recaptcha/api/siteverify"
+
+
+class RecaptchaService:
+    """Google reCAPTCHA v2 — a CAPTCHA that protects forms from spam.
+
+    A utility service with no DB model. Registered under the generic
+    ``CaptchaService`` name (the alternative to cloudflare). Templates use the
+    captcha_widget()/captcha_script() helpers; routes call verify() before
+    accepting a submission.
+
+    Keys are read from runtime SettingsService first (admin panel), then fall
+    back to the product config (RECAPTCHA_SITE_KEY / RECAPTCHA_SECRET_KEY).
+    """
+
+    def _setting(self, key):
+        try:
+            return service_proxy("SettingsService").get(key, None)
+        except Exception:
+            return None
+
+    def site_key(self):
+        value = self._setting("recaptcha_site_key")
+        if value:
+            return value
+        return current_app.config.get("RECAPTCHA_SITE_KEY", "")
+
+    def secret_key(self):
+        value = self._setting("recaptcha_secret_key")
+        if value:
+            return value
+        return current_app.config.get("RECAPTCHA_SECRET_KEY", "")
+
+    def enabled(self):
+        return bool(self.site_key())
+
+    def widget(self):
+        key = self.site_key()
+        if not key:
+            return Markup("")
+        return Markup(f'<div class="g-recaptcha" data-sitekey="{key}"></div>')
+
+    def script_tag(self):
+        if not self.enabled():
+            return Markup("")
+        return Markup(
+            '<script src="https://www.google.com/recaptcha/api.js"'
+            " async defer></script>"
+        )
+
+    def verify(self, token, remoteip=None):
+        secret = self.secret_key()
+        if not secret:
+            return True
+        if not token:
+            return False
+        try:
+            data = {"secret": secret, "response": token}
+            if remoteip:
+                data["remoteip"] = remoteip
+            resp = requests.post(VERIFY_URL, data=data, timeout=10)
+            return bool(resp.json().get("success"))
+        except Exception:
+            return False

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/signals.py

@@ -0,0 +1,24 @@
+"""Anti-spam: validate submitted comments with Google reCAPTCHA.
+
+Listens to the comments feature's ``comment-submitting`` signal. No hard
+dependency on comments — if comments isn't installed the signal is never
+defined and this handler is simply skipped.
+"""
+
+from splent_framework.signals.signal_utils import connect_signal
+
+
+@connect_signal("comment-submitting", "splent_feature_recaptcha")
+def validate_recaptcha(sender, form=None, remoteip=None, **kwargs):
+    from splent_io.splent_feature_recaptcha.services import RecaptchaService
+
+    token = form.get("g-recaptcha-response") if form else None
+    return RecaptchaService().verify(token, remoteip)
+
+
+@connect_signal("contact-submitting", "splent_feature_recaptcha")
+def validate_recaptcha_contact(sender, form=None, remoteip=None, **kwargs):
+    from splent_io.splent_feature_recaptcha.services import RecaptchaService
+
+    token = form.get("g-recaptcha-response") if form else None
+    return RecaptchaService().verify(token, remoteip)

splent_feature_recaptcha-0.2.1/src/splent_io/splent_feature_recaptcha/templates/recaptcha/admin/settings.html

@@ -0,0 +1,53 @@
+{% extends "base_template.html" %}
+
+{% block title %}Captcha — Google reCAPTCHA{% endblock %}
+
+{% block content %}
+<div class="d-flex flex-column align-items-start gap-2 mb-4">
+    <h1 class="h3 mb-0">Captcha — Google reCAPTCHA</h1>
+</div>
+
+{% with messages = get_flashed_messages(with_categories=true) %}
+    {% for category, message in messages %}
+        <div class="alert alert-{{ 'danger' if category == 'danger' else 'success' }} py-2">{{ message }}</div>
+    {% endfor %}
+{% endwith %}
+
+<form method="POST">
+    <div class="card mb-4">
+        <div class="card-header">
+            <h2 class="h5 mb-0">reCAPTCHA keys</h2>
+        </div>
+        <div class="card-body">
+            <div class="row g-3">
+                <div class="col-12">
+                    <label class="form-label" for="recaptcha_site_key">Site key</label>
+                    <input type="text" name="recaptcha_site_key" id="recaptcha_site_key"
+                           class="form-control"
+                           value="{{ setting('recaptcha_site_key', '') }}"
+                           autocomplete="off">
+                    <div class="form-text">The public key embedded in the widget on your forms.</div>
+                </div>
+                <div class="col-12">
+                    <label class="form-label" for="recaptcha_secret_key">Secret key</label>
+                    <input type="password" name="recaptcha_secret_key" id="recaptcha_secret_key"
+                           class="form-control"
+                           value="{{ setting('recaptcha_secret_key', '') }}"
+                           autocomplete="off">
+                    <div class="form-text">The private key used server-side to verify submissions. Never share it.</div>
+                </div>
+            </div>
+
+            <div class="alert alert-info mt-3 mb-0">
+                Leave these blank to use Google's official <strong>test keys</strong>, which always pass —
+                handy for development but they do <em>not</em> protect your forms.
+                Get real keys for your domain at
+                <a href="https://www.google.com/recaptcha/admin" target="_blank" rel="noopener">
+                    https://www.google.com/recaptcha/admin</a>.
+            </div>
+        </div>
+    </div>
+
+    <button type="submit" class="btn btn-primary">Save</button>
+</form>
+{% endblock %}