flaskbb-plugin-inviteonly 1.0.0__tar.gz → 1.0.2__tar.gz

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: flaskbb-plugin-inviteonly
-Version: 1.0.0
+Version: 1.0.2
 Summary: Invite-only registration for FlaskBB - let admins and quota-holding members invite new users even while registration is closed
 Project-URL: Homepage, https://github.com/flaskbb/flaskbb-plugin-inviteonly
 Project-URL: Repository, https://github.com/flaskbb/flaskbb-plugin-inviteonly
@@ -23,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.12
-Requires-Dist: flaskbb>=3.0.0
+Requires-Dist: flaskbb>=3.0.0rc4
 Description-Content-Type: text/markdown
 
 Invite-only

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/inviteonly/__init__.py

@@ -31,8 +31,6 @@ from .utils import (
 )
 from .views import inviteonly_bp
 
-__version__ = "1.0.0"
-
 hookimpl = HookimplMarker("flaskbb")
 
 

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/inviteonly/forms.py

@@ -13,7 +13,7 @@ from flask_babelplus import gettext as _
 from flask_wtf import FlaskForm
 from flaskbb.utils.forms import FlaskBBForm
 from wtforms import BooleanField, IntegerField, StringField, SubmitField
-from wtforms.validators import DataRequired, Length, NumberRange, Optional
+from wtforms.validators import DataRequired, Email, Length, NumberRange, Optional
 
 
 class InviteCodeForm(FlaskBBForm):
@@ -27,7 +27,7 @@ class InviteCodeForm(FlaskBBForm):
 class CreateInviteForm(FlaskBBForm):
     email = StringField(
         _("Email address (optional)"),
-        validators=[Optional(), Length(max=255)],
+        validators=[Optional(), Length(max=255), Email(message=_("Invalid email address."))],
     )
     submit = SubmitField(_("Create invitation"))
 

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/inviteonly/utils.py

@@ -9,16 +9,20 @@ emailing invites.
 :license: BSD License, see LICENSE for more details.
 """
 
+import logging
 import secrets
 
 from flask_allows2 import Permission
-from flaskbb.email import send_email
+from flaskbb.email import send_async_email, send_email
 from flaskbb.settings import flaskbb_config
 from flaskbb.user.models import User
 from flaskbb.utils.requirements import IsAdmin
+from kombu.exceptions import OperationalError
 
 from .models import Invitation, InviteQuota
 
+logger = logging.getLogger(__name__)
+
 CODE_LENGTH = 10
 
 # Setting defaults - also used as the SettingGroup's defaults in __init__.py,
@@ -103,15 +107,24 @@ def grant_quota(user: User, remaining: int | None) -> None:
 
 
 def send_invite_email(email: str, link: str, invited_by: User) -> None:
-    send_email(
-        subject="You've been invited to join the forum",
-        recipients=[email],
-        text_body=(
+    message = {
+        "subject": "You've been invited to join the forum",
+        "recipients": [email],
+        "text_body": (
             f"{invited_by.username} has invited you to join the forum.\n\n"
             f"Follow this link to register: {link}\n"
         ),
-        html_body=(
+        "html_body": (
             f"<p>{invited_by.username} has invited you to join the forum.</p>"
             f'<p><a href="{link}">{link}</a></p>'
         ),
-    )
+    }
+    # TODO: replace with flaskbb.email.delay_or_run once FlaskBB 3.0 is out
+    try:
+        send_async_email.delay(**message)
+    except OperationalError:
+        logger.warning("Could not queue the invitation mail, sending it in-process")
+        try:
+            send_email(**message)
+        except Exception:
+            logger.exception("Could not send the invitation mail to %s", email)

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/inviteonly/views.py

@@ -77,7 +77,9 @@ class EnterInviteCode(MethodView):
     def post(self):
         form = InviteCodeForm()
         if form.validate_on_submit():
-            return redirect(url_for("inviteonly.register_with_invite", code=form.code.data.strip()))
+            return redirect(
+                url_for("inviteonly.register_with_invite", code=(form.code.data or "").strip())
+            )
         return render_template("inviteonly/enter_code.html", form=form)
 
 
@@ -124,10 +126,10 @@ class RegisterWithInvite(MethodView):
         form = self.form(invite)
         if form.validate_on_submit():
             registration_info = UserRegistrationInfo(
-                username=form.username.data,
-                password=form.password.data,
+                username=form.username.data or "",
+                password=form.password.data or "",
                 group=4,
-                email=form.email.data,
+                email=form.email.data or "",
                 language=form.language.data,
             )
 
@@ -309,7 +311,7 @@ class AdminGrantQuota(MethodView):
         form = AdminGrantQuotaForm()
 
         if form.validate_on_submit():
-            target = User.get(func.lower(User.username) == form.username.data.lower())
+            target = User.get(func.lower(User.username) == (form.username.data or "").lower())
             if target is None:
                 flash(
                     _("No user named %(username)s.", username=form.username.data),

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/pyproject.toml

@@ -1,8 +1,8 @@
 [project]
 name = "flaskbb-plugin-inviteonly"
-version = "1.0.0"
+version = "1.0.2"
 dependencies = [
-    "FlaskBB>=3.0.0",
+    "FlaskBB>=3.0.0rc4",
 ]
 requires-python = ">=3.12"
 authors = [

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/tests/conftest.py

@@ -7,6 +7,11 @@ from inviteonly.models import Invitation
 from inviteonly.utils import generate_code
 
 
+@pytest.fixture(scope="package")
+def tested_plugins():
+    return ["inviteonly"]
+
+
 @pytest.fixture
 def invite(user):
     invitation = Invitation(code=generate_code(), created_by_id=user.id)

{flaskbb_plugin_inviteonly-1.0.0 → flaskbb_plugin_inviteonly-1.0.2}/tests/test_inviteonly_views.py

@@ -2,9 +2,12 @@ from contextlib import contextmanager
 
 import pytest
 from flask_login import login_user, logout_user
+from flaskbb.email import send_async_email
+from flaskbb.extensions import mail
 from flaskbb.settings import flaskbb_config
 from flaskbb.user.models import User
 from flaskbb.utils.helpers import time_utcnow
+from kombu.exceptions import OperationalError
 from werkzeug.exceptions import NotFound
 
 from inviteonly.models import Invitation
@@ -112,6 +115,23 @@ def test_create_invite_blocked_when_quota_exhausted(application, database, user)
     assert Invitation.get_all(Invitation.created_by_id == user.id) == []
 
 
+def test_create_invite_rejects_an_invalid_email(application, database, default_settings, user):
+    grant_quota(user, 1)
+
+    view = MyInvitations.as_view("mine")
+    with (
+        _csrf_disabled(application),
+        application.test_request_context(
+            method="POST", data={"email": "not-an-email"}, path="/invite/mine"
+        ),
+        _logged_in(user),
+    ):
+        resp = view()
+
+    assert "Invalid email address." in resp
+    assert Invitation.get_all(Invitation.created_by_id == user.id) == []
+
+
 def test_revoke_invite_by_non_owner_non_admin_is_rejected(
     application, database, invite, other_moderator_user
 ):
@@ -160,3 +180,47 @@ def test_admin_invitations_allows_admin(application, database, default_settings,
         resp = view()
 
     assert isinstance(resp, str)
+
+
+def _create_invite(application, user, email):
+    view = MyInvitations.as_view("mine")
+    with (
+        _csrf_disabled(application),
+        application.test_request_context(method="POST", data={"email": email}, path="/invite/mine"),
+        _logged_in(user),
+    ):
+        return view()
+
+
+def test_invite_mail_is_queued(application, database, default_settings, admin_user, mocker):
+    delay = mocker.patch.object(send_async_email, "delay")
+
+    resp = _create_invite(application, admin_user, "friend@example.org")
+
+    assert resp.status_code == 302
+    delay.assert_called_once()
+    assert delay.call_args.kwargs["recipients"] == ["friend@example.org"]
+
+
+def test_invite_mail_is_sent_in_process_without_broker(
+    application, database, default_settings, admin_user, mocker
+):
+    mocker.patch.object(send_async_email, "delay", side_effect=OperationalError)
+
+    with mail.record_messages() as outbox:
+        resp = _create_invite(application, admin_user, "friend@example.org")
+
+    assert resp.status_code == 302
+    assert [message.recipients for message in outbox] == [["friend@example.org"]]
+
+
+def test_failing_invite_mail_keeps_the_invitation(
+    application, database, default_settings, admin_user, mocker
+):
+    mocker.patch.object(send_async_email, "delay", side_effect=OperationalError)
+    mocker.patch.object(mail, "send", side_effect=ConnectionRefusedError)
+
+    resp = _create_invite(application, admin_user, "friend@example.org")
+
+    assert resp.status_code == 302
+    assert Invitation.get(Invitation.invited_email == "friend@example.org") is not None