Refactor DTOs and update course-related logic

abdullahazmy · abdullahazmy · commit d363a73321e8 · 2025-04-29T21:13:14.000+03:00
Introduced `CourseReadByIdDTO` with additional properties for detailed course information. Updated `CourseReadDTO` to simplify its structure. Replaced `CourseReadDTO` with `CourseReadByIdDTO` across controllers, caching logic, and `GetStudentCoursesDTO`. Adjusted AutoMapper profiles for new mappings. Modified `CreateCourse` and `UpdateCourse` methods to return `CourseReadByIdDTO`. Updated namespaces and performed general refactoring for consistency.
diff --git a/Controllers/CourseController.cs b/Controllers/CourseController.cs
@@ -1,4 +1,5 @@
-﻿using AskAMuslimAPI.Enums;
+﻿using AskAMuslimAPI.DTOs.CourseDTOs;
+using AskAMuslimAPI.Enums;
 using AutoMapper;
 using EdufyAPI.DTOs;
 using EdufyAPI.DTOs.CourseDTOs;
@@ -81,14 +82,14 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourses()
         /// <param name="id">The unique identifier of the course.</param>
         /// <returns>The course details if found; otherwise, NotFound.</returns>
         [HttpGet("{id}")]
-        public async Task<ActionResult<CourseReadDTO>> GetCourseById(string id)
+        public async Task<ActionResult<CourseReadByIdDTO>> GetCourseById(string id)
         {
             const string cacheKeyPrefix = "course_";  // Cache prefix for individual course.
             var cacheKey = $"{cacheKeyPrefix}{id}";
 
             try
             {
-                var courseDto = await _memoryCache.GetDataAsync<CourseReadDTO>(cacheKey);
+                var courseDto = await _memoryCache.GetDataAsync<CourseReadByIdDTO>(cacheKey);
 
                 if (courseDto == null)
                 {
@@ -97,7 +98,7 @@ public async Task<ActionResult<CourseReadDTO>> GetCourseById(string id)
                     if (course == null)
                         return NotFound("Course not found.");
 
-                    courseDto = _mapper.Map<CourseReadDTO>(course);
+                    courseDto = _mapper.Map<CourseReadByIdDTO>(course);
                     courseDto.ThumbnailUrl = ConstructFileUrlHelper.ConstructFileUrl(Request, ThumbnailsFolderName, courseDto.ThumbnailUrl);
 
                     await _memoryCache.SetDataAsync(cacheKey, courseDto, DateTimeOffset.Now.AddMinutes(5));
@@ -115,14 +116,14 @@ public async Task<ActionResult<CourseReadDTO>> GetCourseById(string id)
         }
 
         [HttpGet("ByName/{categoryName}")]
-        public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourseByCategoryName(string categoryName)
+        public async Task<ActionResult<IEnumerable<CourseReadByIdDTO>>> GetCourseByCategoryName(string categoryName)
         {
             const string cacheKeyPrefix = "course_category_name_";
             var cacheKey = $"{cacheKeyPrefix}{categoryName.ToLower()}";
 
             try
             {
-                var courseDtos = await _memoryCache.GetDataAsync<IEnumerable<CourseReadDTO>>(cacheKey);
+                var courseDtos = await _memoryCache.GetDataAsync<IEnumerable<CourseReadByIdDTO>>(cacheKey);
                 if (courseDtos == null)
                 {
                     if (!Enum.TryParse(typeof(CourseCategory), categoryName, true, out var categoryEnum))
@@ -134,9 +135,9 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourseByCategoryN
                         .GetByCondition(c => c.Category == category);
 
                     if (!courses.Any())
-                        return Ok(Enumerable.Empty<CourseReadDTO>());
+                        return Ok(Enumerable.Empty<CourseReadByIdDTO>());
 
-                    courseDtos = _mapper.Map<IEnumerable<CourseReadDTO>>(courses);
+                    courseDtos = _mapper.Map<IEnumerable<CourseReadByIdDTO>>(courses);
 
                     foreach (var courseDto in courseDtos)
                     {
@@ -159,14 +160,14 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourseByCategoryN
 
         // Get Courses by its Level
         [HttpGet("ByLevelName/{levelName}")]
-        public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourseByLevelName(string levelName)
+        public async Task<ActionResult<IEnumerable<CourseReadByIdDTO>>> GetCourseByLevelName(string levelName)
         {
             const string cacheKeyPrefix = "course_level_name_";
             var cacheKey = $"{cacheKeyPrefix}{levelName.ToLower()}";
 
             try
             {
-                var courseDtos = await _memoryCache.GetDataAsync<IEnumerable<CourseReadDTO>>(cacheKey);
+                var courseDtos = await _memoryCache.GetDataAsync<IEnumerable<CourseReadByIdDTO>>(cacheKey);
                 if (courseDtos == null)
                 {
                     if (!Enum.TryParse(typeof(CourseLevel), levelName, true, out var levelEnum))
@@ -178,9 +179,9 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourseByLevelName
                         .GetByCondition(c => c.Level == level);
 
                     if (!courses.Any())
-                        return Ok(Enumerable.Empty<CourseReadDTO>());
+                        return Ok(Enumerable.Empty<CourseReadByIdDTO>());
 
-                    courseDtos = _mapper.Map<IEnumerable<CourseReadDTO>>(courses);
+                    courseDtos = _mapper.Map<IEnumerable<CourseReadByIdDTO>>(courses);
 
                     foreach (var courseDto in courseDtos)
                     {
@@ -207,12 +208,12 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetCourseByLevelName
         /// <param name="instructorId">The unique identifier of the instructor.</param>
         /// <returns>A list of courses assigned to the instructor.</returns>
         [HttpGet("{instructorId}")]
-        public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetInstructorCourses(string instructorId)
+        public async Task<ActionResult<IEnumerable<CourseReadByIdDTO>>> GetInstructorCourses(string instructorId)
         {
             const string cacheKeyPrefix = "instructor_courses_";  // Cache prefix for courses by instructor.
             var cacheKey = $"{cacheKeyPrefix}{instructorId}";
 
-            var courseDtos = await _memoryCache.GetDataAsync<IEnumerable<CourseReadDTO>>(cacheKey);
+            var courseDtos = await _memoryCache.GetDataAsync<IEnumerable<CourseReadByIdDTO>>(cacheKey);
 
             try
             {
@@ -221,9 +222,9 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetInstructorCourses
                     // Cache is empty, so retrieve from database.
                     var courses = await _unitOfWork.CourseRepository.GetByCondition(c => c.InstructorId == instructorId);
                     if (!courses.Any())
-                        return Ok(Enumerable.Empty<CourseReadDTO>());
+                        return Ok(Enumerable.Empty<CourseReadByIdDTO>());
 
-                    courseDtos = _mapper.Map<IEnumerable<CourseReadDTO>>(courses);
+                    courseDtos = _mapper.Map<IEnumerable<CourseReadByIdDTO>>(courses);
                     foreach (var courseDto in courseDtos)
                     {
                         courseDto.ThumbnailUrl = ConstructFileUrlHelper.ConstructFileUrl(Request, ThumbnailsFolderName, courseDto.ThumbnailUrl);
@@ -249,7 +250,7 @@ public async Task<ActionResult<IEnumerable<CourseReadDTO>>> GetInstructorCourses
         /// <param name="courseCreateDto">The course creation request object.</param>
         /// <returns>The created course details.</returns>
         [HttpPost]
-        public async Task<ActionResult<CourseReadDTO>> CreateCourse([FromForm] CourseCreateDTO courseCreateDto)
+        public async Task<ActionResult<CourseReadByIdDTO>> CreateCourse([FromForm] CourseCreateDTO courseCreateDto)
         {
             if (!ModelState.IsValid) return BadRequest(ModelState);
 
@@ -263,7 +264,7 @@ public async Task<ActionResult<CourseReadDTO>> CreateCourse([FromForm] CourseCre
                 course.ThumbnailUrl = imageUrl;
                 await _unitOfWork.CourseRepository.AddAsync(course);
                 await _unitOfWork.SaveChangesAsync();
-                var courseReadDto = _mapper.Map<CourseReadDTO>(course);
+                var courseReadDto = _mapper.Map<CourseReadByIdDTO>(course);
 
                 // Invalidate the cache for all courses after a new course is created.
                 await _memoryCache.RemoveDataAsync("all_courses");
@@ -308,7 +309,7 @@ public async Task<IActionResult> UpdateCourse(string id, [FromForm] CourseUpdate
                 // Invalidate the cache for all courses after an update.
                 await _memoryCache.RemoveDataAsync("all_courses");
 
-                return Ok(_mapper.Map<CourseReadDTO>(course));
+                return Ok(_mapper.Map<CourseReadByIdDTO>(course));
             }
             catch (Exception ex)
             {
diff --git a/Controllers/EnrollmentController.cs b/Controllers/EnrollmentController.cs
@@ -109,15 +109,15 @@ public async Task<IActionResult> GetEnrolledCoursesByStudent(string studentId)
             var cacheKey = $"student-courses-{studentId}";
             try
             {
-                var courseDtos = await _cache.GetDataAsync<IEnumerable<CourseReadDTO>>(cacheKey);
+                var courseDtos = await _cache.GetDataAsync<IEnumerable<CourseReadByIdDTO>>(cacheKey);
 
                 if (courseDtos == null)
                 {
                     var enrollments = await _unitOfWork.EnrollmentRepository.GetByCondition(e => e.StudentId == studentId);
                     if (!enrollments.Any())
                         return NotFound("No enrollments found for this student.");
 
-                    courseDtos = _mapper.Map<IEnumerable<CourseReadDTO>>(enrollments.Select(e => e.Course));
+                    courseDtos = _mapper.Map<IEnumerable<CourseReadByIdDTO>>(enrollments.Select(e => e.Course));
                     await _cache.SetDataAsync(cacheKey, courseDtos, DateTimeOffset.Now.AddMinutes(10));
                 }
 
diff --git a/DTOs/AutoMapperProfiles.cs b/DTOs/AutoMapperProfiles.cs
@@ -1,4 +1,5 @@
-﻿using AutoMapper;
+﻿using AskAMuslimAPI.DTOs.CourseDTOs;
+using AutoMapper;
 using EduConnectAPI.Models;
 using EdufyAPI.DTOs.CertificateDTOs;
 using EdufyAPI.DTOs.CourseDTOs;
@@ -68,11 +69,14 @@ public AutoMapperProfiles()
             #endregion
 
             #region Course AutoMapper
-            CreateMap<Course, CourseReadDTO>();
+            CreateMap<Course, CourseReadByIdDTO>().
+                ForMember(dest => dest.InstructorName, opt => opt.MapFrom(src => src.Instructor.FullName));
             //.ForMember(dest => dest.NumberOfStudentsEnrolled, opt => opt.MapFrom(src => src.NumberOfStudentsEnrolled));
             CreateMap<CourseCreateDTO, Course>();
             CreateMap<CourseUpdateDTO, Course>()
                 .ForAllMembers(opts => opts.Condition((src, dest, srcMember) => srcMember != null)); //This ensures only non-null properties are mapped, preventing overwriting existing values with null.
+            CreateMap<Course, CourseReadDTO>().
+               ForMember(dest => dest.InstructorName, opt => opt.MapFrom(src => src.Instructor.FullName));
 
 
             #endregion
diff --git a/DTOs/CourseDTOs/CourseReadByIdDTO.cs b/DTOs/CourseDTOs/CourseReadByIdDTO.cs
@@ -0,0 +1,28 @@
+﻿using AskAMuslimAPI.Enums;
+using EdufyAPI.DTOs.LessonDTOs;
+
+namespace EdufyAPI.DTOs
+{
+    public class CourseReadByIdDTO
+    {
+        public string Id { get; set; }
+        public string Title { get; set; } = string.Empty;
+        public string Description { get; set; } = string.Empty;
+        public string ThumbnailUrl { get; set; } = string.Empty;
+
+        public CourseCategory Category { get; set; }
+        //public string CategoryName => Category.ToString();
+
+        public CourseLevel Level { get; set; }
+
+        public string InstructorID { get; set; }
+
+        public string InstructorName { get; set; } = string.Empty;
+        public ICollection<LessonReadDTO> Lessons { get; set; }
+
+
+        public int NumberOfLessons { get; set; } = 0;
+
+        public int NumberOfStudentsEnrolled { get; set; } = 0;
+    }
+}
diff --git a/DTOs/CourseDTOs/CourseReadDTO.cs b/DTOs/CourseDTOs/CourseReadDTO.cs
@@ -1,7 +1,6 @@
 ﻿using AskAMuslimAPI.Enums;
-using EdufyAPI.DTOs.LessonDTOs;
 
-namespace EdufyAPI.DTOs
+namespace AskAMuslimAPI.DTOs.CourseDTOs
 {
     public class CourseReadDTO
     {
@@ -16,8 +15,8 @@ public class CourseReadDTO
         public CourseLevel Level { get; set; }
 
         public string InstructorID { get; set; }
-        public ICollection<LessonReadDTO> Lessons { get; set; }
 
+        public string InstructorName { get; set; } = string.Empty;
 
         public int NumberOfLessons { get; set; } = 0;
 
diff --git a/DTOs/StudentDTOs/GetStudentCoursesDTO.cs b/DTOs/StudentDTOs/GetStudentCoursesDTO.cs
@@ -6,7 +6,7 @@ public class GetStudentCoursesDTO
 
         //public Dictionary<string, string> Courses { get; set; }
 
-        public List<CourseReadDTO> courses { get; set; } = new List<CourseReadDTO>();
+        public List<CourseReadByIdDTO> courses { get; set; } = new List<CourseReadByIdDTO>();
 
         //public List<string> CoursesTitle { get; set; } = new List<string>();
 

Original file line number	Diff line number	Diff line change
`@@ -109,15 +109,15 @@ public async Task<IActionResult> GetEnrolledCoursesByStudent(string studentId)`
`109`	`109`	`var cacheKey = $"student-courses-{studentId}";`
`110`	`110`	`try`
`111`	`111`	`{`
`112`		`- var courseDtos = await _cache.GetDataAsync<IEnumerable<CourseReadDTO>>(cacheKey);`
	`112`	`+ var courseDtos = await _cache.GetDataAsync<IEnumerable<CourseReadByIdDTO>>(cacheKey);`
`113`	`113`
`114`	`114`	`if (courseDtos == null)`
`115`	`115`	`{`
`116`	`116`	`var enrollments = await _unitOfWork.EnrollmentRepository.GetByCondition(e => e.StudentId == studentId);`
`117`	`117`	`if (!enrollments.Any())`
`118`	`118`	`return NotFound("No enrollments found for this student.");`
`119`	`119`
`120`		`- courseDtos = _mapper.Map<IEnumerable<CourseReadDTO>>(enrollments.Select(e => e.Course));`
	`120`	`+ courseDtos = _mapper.Map<IEnumerable<CourseReadByIdDTO>>(enrollments.Select(e => e.Course));`
`121`	`121`	`await _cache.SetDataAsync(cacheKey, courseDtos, DateTimeOffset.Now.AddMinutes(10));`
`122`	`122`	`}`
`123`	`123`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`using AskAMuslimAPI.Enums;`
`2`		`-using EdufyAPI.DTOs.LessonDTOs;`
`3`	`2`
`4`		`-namespace EdufyAPI.DTOs`
	`3`	`+namespace AskAMuslimAPI.DTOs.CourseDTOs`
`5`	`4`	`{`
`6`	`5`	`public class CourseReadDTO`
`7`	`6`	`{`
`@@ -16,8 +15,8 @@ public class CourseReadDTO`
`16`	`15`	`public CourseLevel Level { get; set; }`
`17`	`16`
`18`	`17`	`public string InstructorID { get; set; }`
`19`		`- public ICollection<LessonReadDTO> Lessons { get; set; }`
`20`	`18`
	`19`	`+ public string InstructorName { get; set; } = string.Empty;`
`21`	`20`
`22`	`21`	`public int NumberOfLessons { get; set; } = 0;`
`23`	`22`