Add Invite Coapplicant model/feature, list their email ids

Author: sandeepsajan0

hypha/apply/activity/adapters/base.py

@@ -11,6 +11,7 @@
     MESSAGES.TRANSITION: "old_phase",
     MESSAGES.BATCH_TRANSITION: "transitions",
     MESSAGES.APPLICANT_EDIT: "revision",
+    MESSAGES.INVITE_COAPPLICANT: "co_applicant_invite",
     MESSAGES.EDIT_SUBMISSION: "revision",
     MESSAGES.COMMENT: "comment",
     MESSAGES.SCREENING: "old_status",

hypha/apply/activity/adapters/emails.py

@@ -6,6 +6,7 @@
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.template.loader import render_to_string
+from django.urls import reverse
 from django.utils.translation import gettext as _
 
 from hypha.apply.activity import tasks
@@ -41,6 +42,7 @@ class EmailAdapter(AdapterBase):
     messages = {
         MESSAGES.NEW_SUBMISSION: "messages/email/submission_confirmation.html",
         MESSAGES.DRAFT_SUBMISSION: "messages/email/submission_confirmation.html",
+        MESSAGES.INVITE_COAPPLICANT: "handle_co_applicant_invite",
         MESSAGES.COMMENT: "notify_comment",
         MESSAGES.EDIT_SUBMISSION: "messages/email/submission_edit.html",
         MESSAGES.TRANSITION: "handle_transition",
@@ -87,6 +89,8 @@ def get_subject(self, message_type, source):
                 subject = _(
                     "Reminder: Application ready to review: {source.title_text_display}"
                 ).format(source=source)
+            elif message_type == MESSAGES.INVITE_COAPPLICANT:
+                subject = _("You are invited as a co-applicant")
             elif message_type in [
                 MESSAGES.SENT_TO_COMPLIANCE,
                 MESSAGES.APPROVE_PAF,
@@ -164,6 +168,27 @@ def handle_transition(self, old_phase, source, **kwargs):
                 **kwargs,
             )
 
+    def handle_co_applicant_invite(self, source, related, **kwargs):
+        invited_user = User.objects.filter(email=related.invited_user_email).first()
+        can_accept = True
+        if invited_user and (
+            invited_user.is_apply_staff or invited_user.is_apply_staff_admin
+        ):
+            can_accept = False
+
+        accept_link = reverse(
+            "apply:submissions:accept_coapplicant_invite",
+            kwargs={"pk": source.id, "token": related.token},
+        )
+        return self.render_message(
+            "messages/email/invite_co_applicant.html",
+            source=source,
+            can_accept=can_accept,
+            accept_link=accept_link,
+            related=related,
+            **kwargs,
+        )
+
     def handle_batch_transition(self, transitions, sources, **kwargs):
         submissions = sources
         kwargs.pop("source")
@@ -274,6 +299,10 @@ def recipients(self, message_type, source, user, **kwargs):
             if not source.phase.permissions.can_view(source.user):
                 return []
 
+        if message_type == MESSAGES.INVITE_COAPPLICANT:
+            related = kwargs.get("related", None)
+            return [related.invited_user_email]
+
         if message_type == MESSAGES.PARTNERS_UPDATED_PARTNER:
             partners = kwargs["added"]
             return [partner.email for partner in partners]

hypha/apply/activity/options.py

@@ -79,3 +79,4 @@ class MESSAGES(TextChoices):
     ARCHIVE_SUBMISSION = "ARCHIVE_SUBMISSION", _("archived submission")
     UNARCHIVE_SUBMISSION = "UNARCHIVE_SUBMISSION", _("unarchived submission")
     REMOVE_TASK = "REMOVE_TASK", _("remove task")
+    INVITE_COAPPLICANT = "INVITE_COAPPLICANT", _("invite co-applicant")

hypha/apply/activity/templates/messages/email/invite_co_applicant.html

@@ -0,0 +1,11 @@
+{% extends "messages/email/applicant_base.html" %}
+
+{% load i18n %}
+{% block content %}{# fmt:off #}
+{% blocktrans %}You have been invited as a co-applicant to an application on {{ ORG_SHORT_NAME }} by {{ user }}.{% endblocktrans %}
+{% if not can_accept %}
+{% trans "But You can't accept this invite because you already hold a responsible position in" %} {{ ORG_SHORT_NAME }}
+{% endif %}
+{% blocktrans %} Click on link if you want to accept it, otherwise leave it.{% endblocktrans %}
+{% trans "Link" %}: {{ accept_link }}
+{% endblock %}{# fmt:on #}

hypha/apply/funds/forms.py

@@ -1,3 +1,4 @@
+import uuid
 from collections import OrderedDict
 from functools import partial
 from itertools import groupby
@@ -16,6 +17,7 @@
 from .models import (
     ApplicationSubmission,
     AssignedReviewers,
+    CoApplicantInvite,
     Reminder,
     ReviewerRole,
 )
@@ -456,3 +458,29 @@ def save(self, *args, **kwargs):
     class Meta:
         model = Reminder
         fields = ["title", "description", "time", "action"]
+
+
+class InviteCoApplicantForm(forms.ModelForm):
+    invited_user_email = forms.EmailField(required=True, label="Email")
+
+    submission = forms.ModelChoiceField(
+        queryset=ApplicationSubmission.objects.filter(),
+        widget=forms.HiddenInput(),
+    )
+
+    def __init__(self, *args, submission, user=None, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.invited_by = user
+
+        if submission:
+            self.fields["submission"].initial = submission.id
+
+    class Meta:
+        model = CoApplicantInvite
+        fields = ["invited_user_email", "submission"]
+
+    def save(self, *args, **kwargs):
+        self.instance.submission = self.cleaned_data["submission"]
+        self.instance.token = str(uuid.uuid4())
+        self.instance.invited_user_email = self.cleaned_data["invited_user_email"]
+        return super().save(*args, **kwargs)

…ply/funds/migrations/0124_coapplicant.py …ns/0124_coapplicantinvite_coapplicant.pyhypha/apply/funds/migrations/0124_coapplicant.py renamed to hypha/apply/funds/migrations/0124_coapplicantinvite_coapplicant.py hypha/apply/funds/migrations/0124_coapplicant.py renamed to hypha/apply/funds/migrations/0124_coapplicantinvite_coapplicant.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.20 on 2025-04-21 10:12
+# Generated by Django 4.2.20 on 2025-04-23 12:47
 
 from django.conf import settings
 from django.db import migrations, models
@@ -12,6 +12,45 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
+        migrations.CreateModel(
+            name="CoApplicantInvite",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("invited_user_email", models.EmailField(max_length=254)),
+                ("token", models.CharField(max_length=256, unique=True)),
+                ("is_used", models.BooleanField(default=False)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                (
+                    "invited_by",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="co_applicant_invites",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "submission",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="co_applicant_invites",
+                        to="funds.applicationsubmission",
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("submission", "invited_user_email")},
+            },
+        ),
         migrations.CreateModel(
             name="CoApplicant",
             fields=[
@@ -29,25 +68,21 @@ class Migration(migrations.Migration):
                     "status",
                     models.CharField(
                         choices=[
-                            ("pending", "Pending"),
                             ("accepted", "Accepted"),
                             ("rejected", "Rejected"),
                             ("expired", "Expired"),
                         ],
-                        default="pending",
+                        default="accepted",
                         max_length=20,
                     ),
                 ),
-                ("invited_on", models.DateTimeField(auto_now_add=True)),
-                ("responded_on", models.DateTimeField(blank=True, null=True)),
+                ("accepted_on", models.DateTimeField(blank=True, null=True)),
                 (
-                    "invited_by",
-                    models.ForeignKey(
-                        blank=True,
-                        null=True,
-                        on_delete=django.db.models.deletion.SET_NULL,
-                        related_name="co_applicant_invites",
-                        to=settings.AUTH_USER_MODEL,
+                    "invite",
+                    models.OneToOneField(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="co_applicant",
+                        to="funds.coapplicantinvite",
                     ),
                 ),
                 (

hypha/apply/funds/models/__init__.py

@@ -9,7 +9,7 @@
     RoundsAndLabs,
 )
 from .assigned_reviewers import AssignedReviewers
-from .co_applicants import CoApplicant
+from .co_applicants import CoApplicant, CoApplicantInvite
 from .forms import ApplicationForm
 from .reminders import Reminder
 from .reviewer_role import ReviewerRole, ReviewerSettings
@@ -28,6 +28,7 @@
     "RoundsAndLabs",
     "ScreeningStatus",
     "CoApplicant",
+    "CoApplicantInvite",
 ]
 
 

hypha/apply/funds/models/co_applicants.py

@@ -12,12 +12,36 @@
 
 
 class CoApplicantInviteStatus(models.TextChoices):
-    PENDING = "pending", "Pending"
     ACCEPTED = "accepted", "Accepted"
     REJECTED = "rejected", "Rejected"
     EXPIRED = "expired", "Expired"
 
 
+class CoApplicantInvite(models.Model):
+    submission = models.ForeignKey(
+        "funds.ApplicationSubmission",
+        on_delete=models.CASCADE,
+        related_name="co_applicant_invites",
+    )
+    invited_user_email = models.EmailField()
+    token = models.CharField(max_length=256, unique=True)
+    is_used = models.BooleanField(default=False)
+    invited_by = models.ForeignKey(
+        User,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="co_applicant_invites",
+    )
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        unique_together = ("submission", "invited_user_email")
+
+    def __str__(self):
+        return f"{self.invited_user_email} invited to {self.submission})"
+
+
 class CoApplicant(models.Model):
     submission = models.ForeignKey(
         "funds.ApplicationSubmission",
@@ -27,27 +51,19 @@ class CoApplicant(models.Model):
     user = models.ForeignKey(
         User, on_delete=models.CASCADE, related_name="co_applicants"
     )
+    invite = models.OneToOneField(
+        CoApplicantInvite, on_delete=models.CASCADE, related_name="co_applicant"
+    )
     role = models.JSONField(default=list)
-
     status = models.CharField(
         max_length=20,
         choices=CoApplicantInviteStatus.choices,
-        default=CoApplicantInviteStatus.PENDING,
-    )
-    invited_by = models.ForeignKey(
-        User,
-        on_delete=models.SET_NULL,
-        null=True,
-        blank=True,
-        related_name="co_applicant_invites",
+        default=CoApplicantInviteStatus.ACCEPTED,
     )
-    invited_on = models.DateTimeField(auto_now_add=True)
-    responded_on = models.DateTimeField(null=True, blank=True)
+    accepted_on = models.DateTimeField(null=True, blank=True)
 
     class Meta:
         unique_together = ("submission", "user")
 
     def __str__(self):
-        return (
-            f"{self.user} invited to {self.submission} as {self.role} ({self.status})"
-        )
+        return self.user

hypha/apply/funds/permissions.py

@@ -209,9 +209,16 @@ def can_view_submission_screening(user, submission):
     return True, ""
 
 
+def can_invite_co_applicants(user, submission):
+    if user.is_applicant and user == submission.user:
+        return True, "Applicants can invite co-applicants to their application"
+    return False, "Forbidden Error"
+
+
 permissions_map = {
     "submission_view": is_user_has_access_to_view_submission,
     "submission_edit": can_edit_submission,
     "can_view_submission_screening": can_view_submission_screening,
     "archive_alter": can_alter_archived_submissions,
+    "co_applicant_invite": can_invite_co_applicants,
 }

hypha/apply/funds/templates/funds/includes/generic_primary_actions.html

@@ -21,3 +21,21 @@ <h5>{% trans "Actions to take" %}</h5>
         {% endif %}
     </div>
 {% endif %}
+
+{% display_coapplicant_section user object as coapplicant_section %}
+{% if coapplicant_section %}
+    <div class="sidebar__inner sidebar__inner--light-blue sidebar__inner--actions" data-testid="sidebar-primary-actions">
+        <h5>{% trans "Manage Co-applicants" %}</h5>
+        {% for invite in object.co_applicant_invites.all %}
+            <p> {{ invite.invited_user_email }}</p>
+        {% endfor %}
+        <button
+            class="button button--primary button--full-width button--bottom-space"
+            hx-get="{% url 'apply:submissions:invite_co_applicant' pk=object.id %}"
+            hx-target="#htmx-modal"
+            {% if object.co_applicant_invites.count >= 5 %}disabled{% endif %}
+            role="button"
+            aria-label="{% trans "Invite CoApplicant" %}"
+        >{% trans "Invite Co-applicant" %}</button>
+    </div>
+{% endif %}