[Feature] Prize support for Challenges

apps/challenges/challenge_config_utils.py

@@ -2,6 +2,7 @@
 import requests
 import zipfile
 import yaml
+import re
 
 from django.core.files.base import ContentFile
 
@@ -400,6 +401,23 @@ def validate_challenge_config_util(
         current_phase_config_ids = []
         current_phase_split_ids = []
 
+    # Check for Prizes
+    prizes = yaml_file_data.get("prizes")
+    if prizes:
+        for prize in prizes:
+            rank = prize.get("rank")
+            amount = prize.get("amount")
+            if not rank or not amount:
+                message = "ERROR: Invalid prize entry, rank or amount is missing."
+                error_messages.append(message)
+            elif not isinstance(rank, int) or rank < 1:
+                message = "ERROR: Invalid rank value {}. Rank should be a positive integer.".format(prize["rank"])
+                error_messages.append(message)
+            else:
+                if not re.match(r'^\d+(\.\d{1,2})?[A-Z]{3}$', amount):
+                    message = "ERROR: Invalid amount value {}. Amount should be in decimal format with three-letter currency code (e.g. 100.00USD, 500EUR, 1000INR).".format(prize["amount"])
+                    error_messages.append(message)
+
     # Check for leaderboards
     leaderboard = yaml_file_data.get("leaderboard")
     leaderboard_ids = []

apps/challenges/migrations/0089_challenge_prizes.py

@@ -0,0 +1,33 @@
+# Generated by Django 2.2.20 on 2023-03-25 08:23
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('challenges', '0088_increase_cpu_workers_and_memory'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='challenge',
+            name='has_prizes',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.CreateModel(
+            name='ChallengePrize',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('modified_at', models.DateTimeField(auto_now=True)),
+                ('amount', models.CharField(max_length=10)),
+                ('rank', models.PositiveIntegerField()),
+                ('challenge', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='challenges.Challenge')),
+            ],
+            options={
+                'db_table': 'challenge_prize',
+            },
+        ),
+    ]

apps/challenges/models.py

@@ -42,6 +42,7 @@ def __init__(self, *args, **kwargs):
     terms_and_conditions = models.TextField(null=True, blank=True)
     submission_guidelines = models.TextField(null=True, blank=True)
     evaluation_details = models.TextField(null=True, blank=True)
+    has_prizes = models.BooleanField(default=False)
     image = models.ImageField(
         upload_to=RandomFileName("logos"),
         null=True,
@@ -627,3 +628,25 @@ class PWCChallengeLeaderboard(TimeStampedModel):
     class Meta:
         app_label = "challenges"
         db_table = "pwc_challenge_leaderboard"
+
+
+class ChallengePrize(TimeStampedModel):
+    """
+    Model to store challenge prizes
+
+    Arguments:
+        TimeStampedModel {[model class]} -- An abstract base class model that provides self-managed `created_at` and
+                                            `modified_at` fields.
+    """
+
+    challenge = models.ForeignKey("Challenge", on_delete=models.CASCADE)
+    amount = models.CharField(max_length=10)
+    rank = models.PositiveIntegerField()
+
+    class Meta:
+        app_label = "challenges"
+        db_table = "challenge_prize"
+
+    def __str__(self):
+        """Returns a string representation of the Prize object"""
+        return f"Prize for {self.challenge}: Rank {self.rank}, Amount {self.amount}"

apps/challenges/serializers.py

@@ -15,6 +15,7 @@
     PWCChallengeLeaderboard,
     StarChallenge,
     UserInvitation,
+    ChallengePrize,
 )
 
 
@@ -41,6 +42,7 @@ class Meta:
             "terms_and_conditions",
             "submission_guidelines",
             "evaluation_details",
+            "has_prizes",
             "image",
             "start_date",
             "end_date",
@@ -508,3 +510,25 @@ def get_leaderboard(self, obj):
         # PWC requires the default sorted by metric at the index "0" of the array
         labels.insert(0, labels.pop(default_order_by_index))
         return labels
+
+
+class ChallengePrizeSerializer(serializers.ModelSerializer):
+    """
+    Serialize the ChallengePrize Model.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(ChallengePrizeSerializer, self).__init__(*args, **kwargs)
+        context = kwargs.get("context")
+        if context:
+            challenge = context.get("challenge")
+            if challenge:
+                kwargs["data"]["challenge"] = challenge.pk
+
+    class Meta:
+        model = ChallengePrize
+        fields = (
+            "challenge",
+            "amount",
+            "rank"
+        )

apps/challenges/urls.py

@@ -115,6 +115,11 @@
         views.get_or_update_challenge_phase_split,
         name="get_or_update_challenge_phase_split",
     ),
+    url(
+        r"^(?P<challenge_pk>[0-9]+)/prizes/$",
+        views.get_prizes_by_challenge,
+        name="get_prizes_by_challenge",
+    ),
     url(
         r"^(?P<challenge_pk>[0-9]+)/$",
         views.star_challenge,

apps/challenges/views.py

@@ -11,6 +11,7 @@
 import uuid
 import yaml
 import zipfile
+import re
 
 from os.path import basename, isfile, join
 from datetime import datetime
@@ -106,6 +107,7 @@
     PWCChallengeLeaderboard,
     StarChallenge,
     UserInvitation,
+    ChallengePrize,
 )
 from .permissions import IsChallengeCreator
 from .serializers import (
@@ -123,6 +125,7 @@
     UserInvitationSerializer,
     ZipChallengeSerializer,
     ZipChallengePhaseSplitSerializer,
+    ChallengePrizeSerializer,
 )
 
 from .aws_utils import (
@@ -1417,6 +1420,62 @@ def create_challenge_using_zip_file(request, challenge_host_team_pk):
                     response_data = serializer.errors
                     raise RuntimeError()
 
+            # Create Prizes
+            if "prizes" in yaml_file_data:
+                prizes_data = yaml_file_data['prizes']
+                rank_set = set()
+                prizes = []
+                for index, prize in enumerate(prizes_data):
+                    rank = prize.get("rank")
+                    amount = prize.get("amount")
+                    if not rank or not amount:
+                        message = "Invalid prize entry, rank or amount is missing."
+                        response_data = {"error": message}
+                        return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                    elif not isinstance(rank, int) or rank < 1:
+                        message = "Invalid prize rank value {}. Rank should be a positive integer.".format(prize["rank"])
+                        response_data = {"error": message}
+                        return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                    elif not re.match(r'^\d+(\.\d{1,2})?[A-Z]{3}$', amount):
+                        message = "Invalid prize amount value {}. Amount should be in decimal format with three-letter currency code (e.g. 100.00USD, 500EUR, 1000INR).".format(prize["amount"])
+                        response_data = {"error": message}
+                        return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                    else:
+                        # Check for duplicate rank.
+                        rank = prize['rank']
+                        if rank in rank_set:
+                            message = f"Duplicate rank {rank} found in prizes."
+                            response_data = {"error": message}
+                            return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                        rank_set.add(rank)
+
+                        data = {
+                            "challenge": challenge,
+                            "amount": amount,
+                            "rank": rank,
+                        }
+
+                        prizes.append(data)
+
+                        # Update all prizes data after successful validation
+                        if index == len(prizes_data) - 1:
+                            for prize_data in prizes:
+                                serializer = ChallengePrizeSerializer(
+                                    data=prize_data,
+                                    context={
+                                        "challenge": challenge,
+                                    }
+                                )
+                                if serializer.is_valid():
+                                    serializer.save()
+                                    challenge.has_prizes = True
+                                    challenge.save()
+                                else:
+                                    challenge.has_prizes = False
+                                    challenge.save()
+                                    response_data = serializer.errors
+                                    raise RuntimeError()
+
             # Create Challenge Phase
             challenge_phase_ids = {}
             for data in challenge_phases_data:
@@ -2411,6 +2470,22 @@ def get_or_update_challenge_phase_split(request, challenge_phase_split_pk):
         return Response(response_data, status=status.HTTP_200_OK)
 
 
+@api_view(["GET"])
+@throttle_classes([UserRateThrottle])
+def get_prizes_by_challenge(request, challenge_pk):
+    """
+    Returns a list of prizes for a given challenge.
+    """
+    challenge = get_challenge_model(
+        challenge_pk
+    )
+
+    prizes = ChallengePrize.objects.filter(challenge=challenge)
+    serializer = ChallengePrizeSerializer(prizes, many=True)
+    response_data = serializer.data
+    return Response(response_data, status=status.HTTP_200_OK)
+
+
 @api_view(["GET", "POST"])
 @throttle_classes([UserRateThrottle])
 @permission_classes((permissions.IsAuthenticatedOrReadOnly, HasVerifiedEmail))
@@ -3410,6 +3485,50 @@ def create_or_update_github_challenge(request, challenge_host_team_pk):
                             str(data["id"])
                         ] = serializer.instance.pk
 
+                    # Create Prizes
+                    if "prizes" in yaml_file_data:
+                        prizes_data = yaml_file_data['prizes']
+                        rank_set = set()
+                        for prize in prizes_data:
+                            if 'rank' not in prize:
+                                message = "Prize rank not found in YAML data."
+                                response_data = {"error": message}
+                                return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                            if 'amount' not in prize:
+                                message = "Prize amount not found in YAML data."
+                                response_data = {"error": message}
+                                return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+
+                            # Check for duplicate rank.
+                            rank = prize['rank']
+                            if rank in rank_set:
+                                message = f"Duplicate rank {rank} found in YAML data."
+                                response_data = {"error": message}
+                                return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                            rank_set.add(rank)
+
+                            amount = prize["amount"]
+
+                            data = {
+                                "challenge": challenge,
+                                "amount": amount,
+                                "rank": rank,
+                            }
+
+                            serializer = ChallengePrizeSerializer(
+                                data=data,
+                                context={
+                                    "challenge": challenge,
+                                }
+                            )
+                            if serializer.is_valid():
+                                serializer.save()
+                                challenge.has_prizes = True
+                                challenge.save()
+                            else:
+                                error_messages = serializer.errors
+                                raise RuntimeError()
+
                     # Create Challenge Phase
                     challenge_phase_ids = {}
                     challenge_phases_data = yaml_file_data["challenge_phases"]
@@ -3662,6 +3781,67 @@ def create_or_update_github_challenge(request, challenge_host_team_pk):
                         error_messages = serializer.errors
                         raise RuntimeError()
 
+                # Updating ChallengePrize objects
+                if "prizes" in yaml_file_data:
+                    prizes_data = yaml_file_data['prizes']
+                    rank_set = set()
+                    for prize in prizes_data:
+                        if 'rank' not in prize:
+                            message = "Prize rank not found in YAML data."
+                            response_data = {"error": message}
+                            return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                        if 'amount' not in prize:
+                            message = "Prize amount not found in YAML data."
+                            response_data = {"error": message}
+                            return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+
+                        # Check for duplicate rank.
+                        rank = prize['rank']
+                        if rank in rank_set:
+                            message = f"Duplicate rank {rank} found in YAML data."
+                            response_data = {"error": message}
+                            return Response(response_data, status.HTTP_406_NOT_ACCEPTABLE)
+                        rank_set.add(rank)
+
+                        rank = prize['rank']
+                        amount = prize["amount"]
+
+                        prize_obj = ChallengePrize.objects.filter(rank=rank, challenge=challenge).first()
+
+                        if prize_obj:
+                            data = {
+                                "amount": amount,
+                            }
+                            serializer = ChallengePrizeSerializer(
+                                prize_obj, data=data,
+                                context={
+                                    "challenge": challenge,
+                                },
+                                partial=True
+                            )
+                        else:
+                            data = {
+                                "challenge": challenge,
+                                "amount": amount,
+                                "rank": rank,
+                            }
+                            serializer = ChallengePrizeSerializer(
+                                data=data,
+                                context={
+                                    "challenge": challenge,
+                                }
+                            )
+                        if serializer.is_valid():
+                            serializer.save()
+                            challenge.has_prizes = True
+                            challenge.save()
+                        else:
+                            error_messages = serializer.errors
+                            raise RuntimeError()
+                    else:
+                        challenge.has_prizes = False
+                        challenge.save()
+
                 # Updating ChallengePhase objects
                 challenge_phase_ids = {}
                 challenge_phases_data = yaml_file_data["challenge_phases"]