davidcr01
commented
1 year ago Update Report - DRF
A new model has been added to store the multiplayer games called Games:
class Game(models.Model):
player1 = models.ForeignKey(Player, on_delete=models.CASCADE, related_name='player1_wordle')
player2 = models.ForeignKey(Player, on_delete=models.CASCADE, related_name='player2_wordle')
word = models.CharField(max_length=255)
player1_time = models.PositiveIntegerField(default=0)
player1_attempts = models.PositiveIntegerField(default=0)
player1_xp = models.PositiveIntegerField(default=0)
player2_time = models.PositiveIntegerField(default=0)
player2_attempts = models.PositiveIntegerField(default=0)
player2_xp = models.PositiveIntegerField(default=0)
winner = models.ForeignKey(Player, on_delete=models.SET_NULL, null=True, blank=True, related_name='winner')
timestamp = models.DateTimeField(auto_now_add=True)
def __str__(self):
return f"{self.player1.user.username} - {self.player2.user.username}"The serializer looks like this:
class GameDetailSerializer(serializers.ModelSerializer):
player1 = serializers.SerializerMethodField()
player2 = serializers.SerializerMethodField()
class Meta:
model = Game
fields = ['id', 'player1', 'player2', 'player1_time', 'player2_time', 'player1_xp',
'player2_xp', 'timestamp', 'word', 'player1_attempts', 'player2_attempts',
'winner']
def get_player1(self, obj):
return obj.player1.user.username
def get_player2(self, obj):
return obj.player2.user.username
class GameCreateSerializer(serializers.ModelSerializer):
player2 = serializers.SerializerMethodField()
class Meta:
model = Game
fields = ['id', 'player2', 'player1_time', 'player2_time', 'player1_xp',
'player2_xp', 'timestamp', 'word', 'player1_attempts', 'player2_attempts',
'winner']
def get_player2(self, obj):
return obj.player2.user.usernameNotice that in the GameCreateSerializer player1 is not managed as is the player that creates the game, and it is fetched by the identified player.
The serializer will be selected in the view depending on the executed method:
def get_serializer_class(self):
if self.action in ['list', 'retrieve', 'completed_games', 'pending_games']:
return GameDetailSerializer
elif self.action in ['create', 'partial_update']:
return GameCreateSerializer
return super().get_serializer_class()About the view, the create method (executed by the player that creates the game) only allows the player1 statistics. To correctly create the game and link it to the player2, the ID of the second player must be included in the body.
def create(self, request, *args, **kwargs):
player1 = getattr(request.user, 'player', None)
if not player1:
return Response({'error': 'Player1 not found'}, status=404)
player2_id = request.data.get('player2')
if not player2_id:
return Response({'error': 'player2 parameter is required'}, status=400)
try:
player2 = Player.objects.get(id=player2_id)
except Player.DoesNotExist:
return Response({'error': 'Player2 not found'}, status=status.HTTP_404_NOT_FOUND)
allowed_fields = ['player2', 'player1_xp', 'player1_time', 'player1_attempts', 'word']
data = {key: request.data.get(key) for key in allowed_fields}
if 'winner' in data:
return Response({'error': 'The "winner" field cannot be modified.'}, status=400)
serializer = self.get_serializer(data=data)
serializer.is_valid(raise_exception=True)
# Increment player XP
player1.xp += serializer.validated_data['player1_xp']
player1.save()
serializer.save(player1=player1, player2=player2)
# Create notification to the guest player
Notification.objects.create(
player=player2,
text=f"You have been challenged by {player1.user.username}. Let's play!",
link=''
)
return Response(serializer.data, status=201)About the PATCH method, executed by the second player (when it accepts the challenge), it adds the information that is left and defines the winner.
def partial_update(self, request, *args, **kwargs):
instance = self.get_object()
player = request.user.player
if instance.player2 != player:
return Response({'error': 'You do not have permission to update this game.'}, status=403)
if instance.winner is not None:
return Response({'error': 'This game is already completed and cannot be modified.'}, status=400)
allowed_fields = ['player2_xp', 'player2_time', 'player2_attempts']
data = {key: request.data.get(key) for key in allowed_fields}
if 'winner' in data:
return Response({'error': 'The "winner" field cannot be modified.'}, status=400)
player2_xp = request.data.get('player2_xp')
player1_xp = instance.player1_xp
player2_time = request.data.get('player2_time')
player1_time = instance.player1_time
if player2_xp is not None:
player1_xp = instance.player1_xp
if player2_xp > player1_xp:
instance.winner = instance.player2
instance.winner.wins_pvp += 1
instance.winner.save()
elif player2_xp < player1_xp:
instance.winner = instance.player1
instance.winner.wins_pvp += 1
instance.winner.save()
else:
if player2_time <= player1_time:
instance.winner = instance.player2
instance.winner.wins_pvp += 1
instance.winner.save()
else:
instance.winner = instance.player1
instance.winner.wins_pvp += 1
instance.winner.save()
serializer = self.get_serializer(instance, data=data, partial=True)
serializer.is_valid(raise_exception=True)
serializer.save()
return Response({'winner': instance.winner.user.username})
Notice how the player2 information is passed to the backend and it ignores it. Besides, the notification is created:
When the second player plays the game, the information is passed to the backend and the winner is calculated and returned:
Besides, new GET methods have been added to the views:
- To get the completed games of a player
- To get the pending games of a player
- To get the information of a game.
@action(detail=False, methods=['get'])
def completed_games(self, request):
player = getattr(request.user, 'player', None)
if not player:
return Response({'error': 'Player not found'}, status=404)
queryset = Game.objects.filter(Q(player1=player) | Q(player2=player), ~Q(winner=None)).order_by('timestamp')
serializer = self.get_serializer(queryset, many=True)
return Response(serializer.data)
# Pending games are those in which the winner is null and the player is the receiver (player2)
@action(detail=False, methods=['get'])
def pending_games(self, request):
player = getattr(request.user, 'player', None)
if not player:
return Response({'error': 'Player not found'}, status=404)
queryset = Game.objects.filter(player2=player, winner=None).order_by('timestamp')
serializer = self.get_serializer(queryset, many=True)
return Response(serializer.data)
def retrieve(self, request, *args, **kwargs):
instance = self.get_object()
player = getattr(request.user, 'player', None)
if not player:
return Response({'error': 'Player not found'}, status=404)
if player not in [instance.player1, instance.player2]:
return Response({'error': 'You can not access to this game.'}, status=403)Notice how the decorators are used to parameterize the GET method.
Description
As a player, it is necessary to implement new functionality to play the wordle game with another player.
Tasks
To accept the games, is necessary to implement a list of pending games: