Option to enable and validate Payment Phone Numbers

commcare_connect/connect_id_client/main.py

@@ -70,6 +70,18 @@ def filter_users(country_code: str, credential: list[str]):
     return [ConnectIdUser(**user_dict) for user_dict in data["found_users"]]
 
 
+def fetch_payment_phone_numbers(usernames, status):
+    response = _make_request(
+        GET, "/users/fetch_payment_phone_numbers", params={"usernames": usernames, "status": status}
+    )
+    return response.json()["found_payment_numbers"]
+
+
+def update_payment_statuses(update_data):
+    response = _make_request(POST, "/users/validate_payment_phone_numbers", json={"updates": update_data})
+    return response
+
+
 def _make_request(method, path, params=None, json=None, timeout=5) -> Response:
     if json and not method == "POST":
         raise ValueError("json can only be used with POST requests")

commcare_connect/opportunity/api/serializers.py

@@ -126,6 +126,7 @@ class Meta:
             "organization",
             "learn_app",
             "deliver_app",
+            "payment_info_required",
             "start_date",
             "end_date",
             "max_visits_per_user",

commcare_connect/opportunity/forms.py

@@ -88,6 +88,7 @@ class Meta:
             "short_description",
             "is_test",
             "delivery_type",
+            "payment_info_required",
         ]
 
     def __init__(self, *args, **kwargs):
@@ -102,6 +103,7 @@ def __init__(self, *args, **kwargs):
             Row(Field("description")),
             Row(Field("short_description")),
             Row(Field("currency")),
+            Row(Field("payment_info_required")),
             Row(
                 Field("additional_users", wrapper_class="form-group col-md-6 mb-0"),
                 Field("end_date", wrapper_class="form-group col-md-6 mb-0"),
@@ -118,6 +120,9 @@ def __init__(self, *args, **kwargs):
             Submit("submit", "Submit"),
         )
 
+        self.fields["payment_info_required"] = forms.BooleanField(
+            label="Require Phone Numbers from users for payments", required=False
+        )
         self.fields["additional_users"] = forms.IntegerField(
             required=False, help_text="Adds budget for additional users."
         )
@@ -147,12 +152,7 @@ class OpportunityInitForm(forms.ModelForm):
 
     class Meta:
         model = Opportunity
-        fields = [
-            "name",
-            "description",
-            "short_description",
-            "currency",
-        ]
+        fields = ["name", "description", "short_description", "currency", "payment_info_required"]
 
     def __init__(self, *args, **kwargs):
         self.domains = kwargs.pop("domains", [])
@@ -180,6 +180,7 @@ def __init__(self, *args, **kwargs):
                 data_loading_states=True,
             ),
             Row(Field("currency")),
+            Row(Field("payment_info_required")),
             Row(Field("api_key")),
             Submit("submit", "Submit"),
         )
@@ -218,6 +219,10 @@ def __init__(self, *args, **kwargs):
         self.fields["deliver_app"] = forms.Field(
             widget=forms.Select(choices=[(None, "Loading...")], attrs={"data-loading-disable": True})
         )
+        self.fields["payment_info_required"] = forms.BooleanField(
+            label="Require Phone Numbers from users for payments", required=False
+        )
+
         self.fields["api_key"] = forms.CharField(max_length=50)
 
     def clean(self):

commcare_connect/opportunity/migrations/0063_opportunity_payment_info_required.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.5 on 2024-11-10 11:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("opportunity", "0062_opportunityaccess_invited_date"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="opportunity",
+            name="payment_info_required",
+            field=models.BooleanField(default=False),
+        ),
+    ]

commcare_connect/opportunity/models.py

@@ -82,6 +82,8 @@ class Opportunity(BaseModel):
     # to be removed
     budget_per_visit = models.IntegerField(null=True)
     total_budget = models.IntegerField(null=True)
+    # Whether users payment phone numbers are required or not
+    payment_info_required = models.BooleanField(default=False)
     api_key = models.ForeignKey(HQApiKey, on_delete=models.DO_NOTHING, null=True)
     currency = models.CharField(max_length=3, null=True)
     auto_approve_visits = models.BooleanField(default=True)

commcare_connect/opportunity/payment_number_report.py

@@ -0,0 +1,241 @@
+import dataclasses
+from collections import defaultdict
+
+import django_filters
+import django_tables2 as tables
+from django.db import transaction
+from django.http import HttpResponse
+from django.urls import reverse
+from django.utils.html import format_html
+
+from commcare_connect.connect_id_client.main import (
+    fetch_payment_phone_numbers,
+    send_message_bulk,
+    update_payment_statuses,
+)
+from commcare_connect.connect_id_client.models import Message
+from commcare_connect.opportunity.models import Opportunity, OpportunityAccess
+from commcare_connect.opportunity.views import OrganizationUserMemberRoleMixin
+from commcare_connect.organization.models import OrgUserPaymentNumberStatus
+from commcare_connect.reports.views import NonModelTableBaseView
+from commcare_connect.users.models import User
+
+
+class PaymentNumberReportTable(tables.Table):
+    username = tables.Column(verbose_name="Username")
+    phone_number = tables.Column(verbose_name="Payment Phone Number")
+    status = tables.Column(verbose_name="Status")
+
+    class Meta:
+        template_name = "opportunity/payment_numbers_table.html"
+        attrs = {"class": "table table-striped table-hover"}
+        empty_text = "No data available."
+        orderable = False
+
+    def render_status(self, value, record):
+        username = record["username"]
+        phone_number = record["phone_number"]
+
+        radio_buttons = [
+            f'<input type="radio" name="status_{username}" value="{filter_value}" {"checked" if value == filter_value else ""}> {label}'
+            for (filter_value, label) in PaymentFilters.STATUS_CHOICES
+        ]
+        radio_buttons.append(f'<input type="hidden" name="phone_{username}" value="{phone_number}">')
+        return format_html("<br>".join(radio_buttons))
+
+
+class PaymentFilters(django_filters.FilterSet):
+    STATUS_CHOICES = [
+        ("pending", "Pending Review"),
+        ("approved", "Working"),
+        ("rejected", "Not working"),
+    ]
+
+    opportunity = django_filters.ChoiceFilter(method="filter_by_ignore")
+    status = django_filters.ChoiceFilter(choices=STATUS_CHOICES, label="Payment Status")
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        opportunities = Opportunity.objects.filter(
+            organization=self.request.org, payment_info_required=True
+        ).values_list("id", "name")
+        self.filters["opportunity"] = django_filters.ChoiceFilter(
+            choices=opportunities, label="Opportunity", empty_label=None
+        )
+
+    class Meta:
+        model = None
+        fields = ["status"]
+
+    def filter_by_ignore(self, queryset, name, value):
+        return queryset
+
+
+class PaymentNumberReport(tables.SingleTableMixin, OrganizationUserMemberRoleMixin, NonModelTableBaseView):
+    table_class = PaymentNumberReportTable
+    filterset_class = PaymentFilters
+    htmx_table_template = "opportunity/payment_numbers_table.html"
+    report_title = "Review Payment Phone Numbers"
+
+    @property
+    def report_url(self):
+        return reverse("opportunity:payment_number_report", args=(self.request.org.slug,))
+
+    @property
+    def object_list(self):
+        if not self.filter_values:
+            return []
+
+        status = self.filter_values["status"]
+        opportunity = self.filter_values["opportunity"]
+        if not opportunity:
+            return []
+        usernames = OpportunityAccess.objects.filter(opportunity_id=opportunity).values_list(
+            "user__username", flat=True
+        )
+        connectid_statuses = fetch_payment_phone_numbers(usernames, status)
+        # display local status when its overridden
+        local_statuses = OrgUserPaymentNumberStatus.objects.filter(
+            user__username__in=usernames, organization=self.request.org
+        )
+        local_statuses_by_username = {status.user.username: status for status in local_statuses}
+        for status in connectid_statuses:
+            local_status = local_statuses_by_username.get(status["username"])
+            if local_status and local_status.phone_number == status["phone_number"]:
+                status["status"] = local_status.status
+        return connectid_statuses
+
+    def post(self, request, *args, **kwargs):
+        user_statuses = defaultdict(dict)
+
+        for key, value in request.POST.items():
+            if key.startswith("status_"):
+                username = key.split("status_")[1]
+                user_statuses[username].update({"status": value})
+            if key.startswith("phone_"):
+                username = key.split("phone_")[1]
+                user_statuses[username].update({"phone_number": value})
+
+        # validate that usernames do belong to this opportunity
+        opportunity_id = request.GET.get("opportunity")
+        if not opportunity_id:
+            return HttpResponse("Opportunity must be specified", status=400)
+        opportunity = Opportunity.objects.get(pk=opportunity_id)
+        if opportunity.organization != request.org:
+            return HttpResponse("You can't specify this opportunity", status=400)
+        is_valid = OpportunityAccess.objects.filter(
+            opportunity_id=opportunity_id, user__username__in=user_statuses.keys()
+        ).count() == len(user_statuses)
+        if not is_valid:
+            return HttpResponse("Unknown usernames", status=400)
+
+        updates = [{"username": username, **values} for username, values in user_statuses.items()]
+        result = update_payment_number_statuses(updates, opportunity)
+        return HttpResponse(
+            format_html(
+                """<span id="result" class="alert alert-info p-1">{}</span>""".format(
+                    f"Approved: {result['approved']}, Rejected: {result['rejected']}, Pending: {result['pending']}"
+                )
+            )
+        )
+
+
+@dataclasses.dataclass
+class PaymentStatus:
+    user: str
+    phone_number: str
+    new_status: str
+    current_status: str = None
+    other_org_statuses: set = dataclasses.field(default_factory=set)
+
+
+def update_payment_number_statuses(update_data, opportunity):
+    """
+    Updates payment number status in bulk
+    """
+
+    user_obj_by_username = {
+        user.username: user for user in User.objects.filter(username__in=[u["username"] for u in update_data]).all()
+    }
+    update_by_username = {
+        u["username"]: PaymentStatus(
+            user=user_obj_by_username[u["username"]],
+            phone_number=u["phone_number"],
+            new_status=u["status"],
+        )
+        for u in update_data
+    }
+
+    existing_statuses = OrgUserPaymentNumberStatus.objects.filter(user__username__in=update_by_username.keys()).all()
+
+    # remove unchanged updates and gather current-status
+    #   and status set by other orgs
+    for status in existing_statuses:
+        update = update_by_username[status.user.username]
+        if status.organization == opportunity.organization:
+            if update.phone_number == status.phone_number:
+                if update.new_status == status.status:
+                    # No change in status, so remove it
+                    update_by_username.pop(status.user.username)
+                else:
+                    update.current_status = status.status
+            else:
+                # the status is for an updated number, so default to PENDING
+                update.current_status = OrgUserPaymentNumberStatus.PENDING
+        else:
+            if update.phone_number == status.phone_number:
+                update.other_org_statuses.add(status.status)
+
+    with transaction.atomic():
+        objs = [
+            OrgUserPaymentNumberStatus(
+                organization=opportunity.organization,
+                user=u.user,
+                phone_number=u.phone_number,
+                status=u.new_status,
+            )
+            for u in update_by_username.values()
+        ]
+        # Bulk update/create
+        OrgUserPaymentNumberStatus.objects.bulk_create(
+            objs,
+            update_conflicts=True,
+            unique_fields=["user", "organization"],
+            update_fields=["phone_number", "status"],
+        )
+
+        # Process connect-id updates and push-notifications
+        connectid_updates = []
+        rejected_usernames = []
+        approved_usernames = []
+        result = {
+            OrgUserPaymentNumberStatus.APPROVED: 0,
+            OrgUserPaymentNumberStatus.REJECTED: 0,
+            OrgUserPaymentNumberStatus.PENDING: 0,
+        }
+        for update in update_by_username.values():
+            result[update.new_status] += result[update.new_status] + 1
+            if (not update.other_org_statuses) or {update.new_status} == update.other_org_statuses:
+                # only send update on connectid if there is no disaggrement bw orgs
+                # connectid stores status and triggers relevant notifications
+                connectid_updates.append({"username": update.user.username, "status": update.new_status})
+            else:
+                if update.new_status == OrgUserPaymentNumberStatus.REJECTED:
+                    rejected_usernames.append("username")
+                else:
+                    approved_usernames.append("username")
+
+        if connectid_updates:
+            response = update_payment_statuses(connectid_updates)
+            if response.status_code not in [200, 201]:
+                raise Exception("Error sending payment number status updates to ConnectID")
+
+        if rejected_usernames:
+            rejected_msg = f"{opportunity.name} is unable to send payments to you"
+            send_message_bulk(Message(usernames=rejected_usernames, body=rejected_msg))
+
+        if approved_usernames:
+            approved_msg = f"{opportunity.name} is now able to send payments to you"
+            send_message_bulk(Message(usernames=approved_usernames, body=approved_msg))
+
+    return result