Add domain entities

Author: Waterball12

server/src/Services/Quizer/Quiz.Domain/Entities/Answer.cs

@@ -1,8 +1,28 @@
 namespace Quizzer.Domain.Entities
 {
+    /// <summary>
+    /// Entity for the question answer
+    /// </summary>
     public record Answer
     {
+        /// <summary>
+        /// The id of the answer
+        /// </summary>
+        public ulong Id { get; init; }
+
+        /// <summary>
+        /// The description illustrated to the user
+        /// </summary>
         public string Description { get; init; }
+
+        /// <summary>
+        /// Whether is correct or not
+        /// </summary>
         public bool IsCorrect { get; init; }
+
+        /// <summary>
+        /// How many points does the answer give once the user has got it right
+        /// </summary>
+        public uint Points { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Entities/Player.cs

@@ -0,0 +1,9 @@
+namespace Quizzer.Domain.Entities
+{
+    public record Player
+    {
+        public string Id { get; set; }
+
+        public int Score { get; set; }
+    }
+}

server/src/Services/Quizer/Quiz.Domain/Entities/Question.cs

@@ -1,11 +1,33 @@
 using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
 
 namespace Quizzer.Domain.Entities
 {
+    /// <summary>
+    /// Entity for the quiz question
+    /// </summary>
     public record Question
     {
+        /// <summary>
+        /// The id of the question
+        /// </summary>
+        public ulong Id { get;set; }
+
+        /// <summary>
+        /// The question title or the question itself
+        /// </summary>
         public string Title { get; init; }
+
+        /// <summary>
+        /// The time given to the user to answer the question, this not handled by the server and client
+        /// TODO decide which measurement unit use and integrate with the frontend
+        /// </summary>
         public int Timeout { get; init; }
+
+        /// <summary>
+        /// List of possible answer, MIN 0 and MAX 4
+        /// </summary>
+        [Range(0, 4)]
         public IList<Answer> Answer { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Entities/Quiz.cs

@@ -2,12 +2,35 @@
 
 namespace Quizzer.Domain.Entities
 {
+    /// <summary>
+    /// Immutable quiz entity that contains necessary information to start a game
+    /// This in future will be saved in a database
+    /// </summary>
     public record Quiz
     {
+        /// <summary>
+        /// The id of the quiz
+        /// </summary>
+        public ulong Id { get; init; }
+
+        /// <summary>
+        /// Title of the quiz
+        /// </summary>
         public string Title { get; init; }
+
+        /// <summary>
+        /// Description of the quiz
+        /// </summary>
         public string Description { get; init; }
+
+        /// <summary>
+        /// Image Url in future can be used as a banner
+        /// </summary>
         public string ImageUrl { get; init; }
+
+        /// <summary>
+        /// List of available questions in the quiz
+        /// </summary>
         public IList<Question> Questions { get; init; }
-        public IList<string> Users { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Entities/QuizGame.cs

@@ -1,16 +1,51 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using Quizzer.Domain.Enums;
 
 namespace Quizzer.Domain.Entities
 {
+    /// <summary>
+    /// Entity used for the game
+    /// </summary>
     public record QuizGame
     {
+        /// <summary>
+        /// Unique identifier for the game
+        /// </summary>
         public ulong Id { get; init; }
+
+        /// <summary>
+        /// The Quiz entity, this should probably just use a quiz id
+        /// </summary>
         public Quiz Quiz { get; init; }
-        public DateTime? Started { get; init; }
+
+        /// <summary>
+        /// When the game started, null when it hasn't started yet
+        /// </summary>
+        public DateTime? Started { get; set; }
+
+        /// <summary>
+        /// Indicate the current active question
+        /// </summary>
+        /// <remarks>Cannot be less than 0</remarks>
         public int CurrentQuestion { get; set; }
+
+        /// <summary>
+        /// List of users who are participating to the quiz
+        /// </summary>
+        public IList<Player> Users { get; set; }
+
+        /// <summary>
+        /// Indicate the current state of the game
+        /// </summary>
+        public GameStatus Status { get; set; }
+
+        /// <summary>
+        /// Id of the user who started the game
+        /// </summary>
+        public string OwnerId { get; set; }
+
+        // TODO
+        // Store user answer so that score can be calculated at the end
     }
 }

server/src/Services/Quizer/Quiz.Domain/Enums/GameStatus.cs

@@ -0,0 +1,26 @@
+namespace Quizzer.Domain.Enums
+{
+    public enum GameStatus
+    {
+        /// <summary>
+        /// Indicates that the game hasn't started yet
+        /// </summary>
+        Idle = 0,
+
+        /// <summary>
+        /// Indicates that the game is currently running
+        /// </summary>
+        Running = 1,
+
+        /// <summary>
+        /// Indicate that the game has been stopped
+        /// This is not integrated yet
+        /// </summary>
+        Stopped = 2,
+
+        /// <summary>
+        /// Indicate that the game has ended
+        /// </summary>
+        Ended = 3
+    }
+}

server/src/Services/Quizer/Quiz.Domain/Events/GameEndedEvent.cs

@@ -1,13 +1,12 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using Quizzer.Domain.Entities;
 
 namespace Quizzer.Domain.Events
 {
+    /// <summary>
+    /// Event fired once the game ended
+    /// </summary>
     public class GameEndedEvent
     {
-        public ulong GameId { get; init; }
+        public QuizGame Game { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Events/GameStartedEvent.cs

@@ -1,14 +1,31 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using System.Collections.Generic;
+using Quizzer.Domain.Enums;
 
 namespace Quizzer.Domain.Events
 {
+    /// <summary>
+    /// Event fired once the game owner press start
+    /// </summary>
     public record GameStartedEvent
     {
+        /// <summary>
+        /// The game id or room id
+        /// </summary>
         public ulong GameId { get; init; }
+
+        /// <summary>
+        /// The participants users
+        /// </summary>
         public IList<string> Users { get; init; }
+
+        /// <summary>
+        /// Status of the game, should be running
+        /// </summary>
+        public GameStatus Status { get; init; }
+
+        /// <summary>
+        /// Starting question
+        /// </summary>
+        public int CurrentQuestion { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Events/QuestionEndedEvent.cs

@@ -1,13 +1,18 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using System.Collections.Generic;
+using Quizzer.Domain.Entities;
 
 namespace Quizzer.Domain.Events
 {
+    /// <summary>
+    /// Event fired when the timeout of the question has been reached
+    /// </summary>
     public class QuestionEndedEvent
     {
-        public IList<string> CorrectAnswer { get; init; }
+        public ulong GameId { get; init; }
+
+        /// <summary>
+        /// The list of correct answer
+        /// </summary>
+        public IList<Answer> Answers { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Events/QuestionStartedEvent.cs

@@ -1,14 +1,30 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Quizzer.Domain.Events
 {
+    /// <summary>
+    /// Event fired when the user click on game start or when he clicks on next question
+    /// </summary>
     public record QuestionStartedEvent
     {
+        public ulong GameId { get; init; }
+
+        /// <summary>
+        /// The given question based on the game CurrentQuestion
+        /// </summary>
         public string Question { get; init; }
+
+        /// <summary>
+        /// Current question position
+        /// </summary>
+        public int CurrentQuestion { get; init; }
+
+        public DateTimeOffset EndAt { get; init; }
+
+        /// <summary>
+        /// List of possible answer for he given question
+        /// </summary>
         public IList<string> Answers { get; init; }
     }
 }

server/src/Services/Quizer/Quiz.Domain/Events/UserJoinedGameEvent.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Quizzer.Domain.Events
+{
+    /// <summary>
+    /// Event fired when a user joins a game
+    /// </summary>
+    public record UserJoinedGameEvent
+    {
+        public string UserId { get; set; }
+        public ulong GameId { get; set; }
+    }
+}

server/src/Services/Quizer/Quiz.Domain/Exceptions/GameNotFoundException.cs

@@ -1,11 +1,10 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Quizzer.Domain.Exceptions
 {
+    /// <summary>
+    /// Exception thrown when the game was not found
+    /// </summary>
     public class GameNotFoundException : Exception
     {
         public GameNotFoundException(ulong id) : base($"Game {id} not found")