API for validating conditions needed for passport stamps (#10755)

* Adding API endpoints required for verifying stamp issuance condition

* Adding information about the number of rounds a user contributed to

* Adding  to contributor_statistics api

* Adding API for grantee statistics

* Adding verification that grantee was elligible in ecosystem and cause rounds

* Updating file header comment

Author: nutrina

app/grants/urls.py

@@ -33,6 +33,7 @@
     leaderboard, manage_ethereum_cart_data, matching_funds, profile, remove_grant_from_collection, save_collection,
     toggle_grant_favorite, upload_sybil_csv, verify_grant,
 )
+from grants.views_api_vc import contributor_statistics, grantee_statistics
 
 app_name = 'grants/'
 urlpatterns = [
@@ -126,4 +127,7 @@
     path('v1/api/upload_sybil_csv', upload_sybil_csv, name='upload_sybil_csv'),
     path('v1/api/ingest_merkle_claim_to_clr_match', ingest_merkle_claim_to_clr_match, name='ingest_merkle_claim_to_clr_match'),
 
+    # VC verification API (when issuing a VC)
+    path('v1/api/vc/contributor_statistics', contributor_statistics, name='contributor_statistics'),
+    path('v1/api/vc/grantee_statistics', grantee_statistics, name='grantee_statistics'),
 ]

app/grants/views_api_vc.py

@@ -0,0 +1,202 @@
+# -*- coding: utf-8 -*-
+"""Define the Grant views for API used by the passport IAM
+
+Copyright (C) 2021 Gitcoin Core
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+"""
+import logging
+
+from django.conf import settings
+from django.db.models import Sum
+from django.http import JsonResponse
+from django.utils.translation import gettext_lazy as _
+
+from grants.models import Contribution, Grant
+from perftools.models import StaticJsonEnv
+from townsquare.models import SquelchProfile
+
+logger = logging.getLogger(__name__)
+
+
+def ami_api_token_required(func):
+    def decorator(request, *args, **kwargs):
+        try:
+            apiToken = StaticJsonEnv.objects.get(key="AMI_API_TOKEN")
+            expectedToken = apiToken.data["token"]
+            receivedToken = request.headers.get("Authorization")
+
+            if receivedToken:
+                # Token shall look like "token <bearer token>", and we need only the <bearer token> part
+                receivedToken = receivedToken.split(" ")[1]
+
+            if expectedToken == receivedToken:
+                return func(request, *args, **kwargs)
+            else:
+                return JsonResponse(
+                    {
+                        "error": "Access denied",
+                    },
+                    status=403,
+                )
+        except Exception as e:
+            logger.error("Error in ami_api_token_required %s", e)
+            return JsonResponse(
+                {
+                    "error": "An unexpected error occured",
+                },
+                status=500,
+            )
+
+    return decorator
+
+
+@ami_api_token_required
+def contributor_statistics(request):
+    handle = request.GET.get("handle")
+
+    if not handle:
+        return JsonResponse(
+            {"error": "Bad request, 'handle' parameter is missing or invalid"},
+            status=400,
+        )
+
+    # Get number of grants the user contributed to
+    num_grants_contribute_to = (
+        Contribution.objects.filter(profile_for_clr__handle=handle, success=True)
+        .order_by("grant_id")
+        .distinct("grant_id")
+        .count()
+    )
+
+    # Get the number of grants the user contributed to
+    num_rounds_contribute_to = (
+        Contribution.objects.filter(
+            success=True,
+            subscription__contributor_profile__handle=handle,
+            subscription__network="mainnet",
+            subscription__grant__clr_calculations__latest=True,
+        )
+        .order_by("subscription__grant__clr_calculations__grantclr__round_num")
+        .distinct("subscription__grant__clr_calculations__grantclr__round_num")
+        .count()
+    )
+
+    total_contribution_amount = Contribution.objects.filter(
+        profile_for_clr__handle=handle, success=True
+    ).aggregate(Sum("amount_per_period_usdt"))["amount_per_period_usdt__sum"]
+    total_contribution_amount = (
+        total_contribution_amount if total_contribution_amount is not None else 0
+    )
+
+    # GR14 contributor (and not squelched by FDD)
+    profile_squelch = SquelchProfile.objects.filter(
+        profile__handle=handle, active=True
+    ).values_list("profile_id", flat=True)
+
+    num_gr14_contributions = (
+        Contribution.objects.filter(
+            success=True,
+            subscription__contributor_profile__handle=handle,
+            subscription__network="mainnet",
+            subscription__grant__clr_calculations__latest=True,
+            subscription__grant__clr_calculations__grantclr__round_num=14,
+        )
+        .exclude(subscription__contributor_profile_id__in=profile_squelch)
+        .count()
+    )
+
+    return JsonResponse(
+        {
+            "num_grants_contribute_to": num_grants_contribute_to,
+            "num_rounds_contribute_to": num_rounds_contribute_to,
+            "total_contribution_amount": total_contribution_amount,
+            "is_gr14_contributor": num_gr14_contributions > 0,
+        }
+    )
+
+
+@ami_api_token_required
+def grantee_statistics(request):
+    handle = request.GET.get("handle")
+
+    if not handle:
+        return JsonResponse(
+            {"error": "Bad request, 'handle' parameter is missing or invalid"},
+            status=400,
+        )
+
+    # Get number of owned grants
+    num_owned_grants = Grant.objects.filter(
+        admin_profile__handle=handle,
+        hidden=False,
+        active=True,
+        is_clr_eligible=True,
+    ).count()
+
+    # Get the total amount of contrinutors for ane users grants that where not squelched and are not the owner himself
+    all_squelched = SquelchProfile.objects.filter(active=True).values_list(
+        "profile_id", flat=True
+    )
+    num_grant_contributors = (
+        Contribution.objects.filter(
+            success=True,
+            subscription__network="mainnet",
+            subscription__grant__hidden=False,
+            subscription__grant__active=True,
+            subscription__grant__is_clr_eligible=True,
+            subscription__grant__admin_profile__handle=handle,
+        )
+        .exclude(subscription__contributor_profile_id__in=all_squelched)
+        .exclude(subscription__contributor_profile__handle=handle)
+        .order_by("subscription__contributor_profile_id")
+        .distinct("subscription__contributor_profile_id")
+        .count()
+    )
+
+    # Get the total amount of contributions received by the owned grants (excluding the contributions made by the owner)
+    total_contribution_amount = (
+        Contribution.objects.filter(
+            success=True,
+            subscription__network="mainnet",
+            subscription__grant__hidden=False,
+            subscription__grant__active=True,
+            subscription__grant__is_clr_eligible=True,
+            subscription__grant__admin_profile__handle=handle,
+        )
+        .exclude(subscription__contributor_profile__handle=handle)
+        .aggregate(Sum("amount_per_period_usdt"))["amount_per_period_usdt__sum"]
+    )
+    total_contribution_amount = (
+        total_contribution_amount if total_contribution_amount is not None else 0
+    )
+
+    # [IAM] As an IAM server, I want to issue stamps for grant owners whose project have tagged matching-eligibel in an eco-system and/or cause round
+    num_grants_in_eco_and_cause_rounds = Grant.objects.filter(
+        admin_profile__handle=handle,
+        hidden=False,
+        active=True,
+        is_clr_eligible=True,
+        clr_calculations__grantclr__type__in=["ecosystem", "cause"],
+    ).count()
+
+    return JsonResponse(
+        {
+            "num_owned_grants": num_owned_grants,
+            "num_grant_contributors": num_grant_contributors,
+            "num_grants_in_eco_and_cause_rounds": num_grants_in_eco_and_cause_rounds,
+            "total_contribution_amount": total_contribution_amount,
+        }
+    )