From 8ab93a7235af0897c9ea5a20d7ab85109a7c8237 Mon Sep 17 00:00:00 2001
From: Hamid Reza Mohammadi <mohammadi.hr@gmail.com>
Date: Thu, 30 Sep 2021 10:10:51 +0330
Subject: [PATCH] #208 api improvement

---
 RMuseum/Controllers/GanjoorController.cs      |  6 +++---
 RMuseum/RMuseum.xml                           |  6 +++---
 RMuseum/Services/IGanjoorService.cs           |  4 ++--
 .../GanjoorService-Bookmarking.cs             | 21 ++++++++++++++-----
 4 files changed, 24 insertions(+), 13 deletions(-)

diff --git a/RMuseum/Controllers/GanjoorController.cs b/RMuseum/Controllers/GanjoorController.cs
index 7fa02249..cd6d9634 100644
--- a/RMuseum/Controllers/GanjoorController.cs
+++ b/RMuseum/Controllers/GanjoorController.cs
@@ -1929,19 +1929,19 @@ namespace RMuseum.Controllers
 
 
         /// <summary>
-        /// get poem user bookmarks
+        /// get poem user bookmarks (only Id, CoupletIndex and DateTime are valid in the output view model)
         /// </summary>
         /// <param name="poemId"></param>
         /// <returns></returns>
         [HttpGet]
         [Route("bookmark/{poemId}")]
         [Authorize]
-        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(GanjoorUserBookmark[]))]
+        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(GanjoorUserBookmarkViewModel[]))]
         [ProducesResponseType((int)HttpStatusCode.BadRequest, Type = typeof(string))]
         public async Task<IActionResult> GetPoemUserBookmarks(int poemId)
         {
             Guid loggedOnUserId = new Guid(User.Claims.FirstOrDefault(c => c.Type == "UserId").Value);
-            RServiceResult<GanjoorUserBookmark[]> res = await _ganjoorService.GetPoemUserBookmarks(loggedOnUserId, poemId);
+            RServiceResult<GanjoorUserBookmarkViewModel[]> res = await _ganjoorService.GetPoemUserBookmarks(loggedOnUserId, poemId);
             if (!string.IsNullOrEmpty(res.ExceptionString))
                 return BadRequest(res.ExceptionString);
             return Ok(res.Result);
diff --git a/RMuseum/RMuseum.xml b/RMuseum/RMuseum.xml
index da64922e..db4d7bb7 100644
--- a/RMuseum/RMuseum.xml
+++ b/RMuseum/RMuseum.xml
@@ -1227,7 +1227,7 @@
         </member>
         <member name="M:RMuseum.Controllers.GanjoorController.GetPoemUserBookmarks(System.Int32)">
             <summary>
-            get poem user bookmarks
+            get poem user bookmarks (only Id, CoupletIndex and DateTime are valid in the output view model)
             </summary>
             <param name="poemId"></param>
             <returns></returns>
@@ -8703,7 +8703,7 @@
         </member>
         <member name="M:RMuseum.Services.IGanjoorService.GetPoemUserBookmarks(System.Guid,System.Int32)">
             <summary>
-            get user ganjoor bookmarks
+            get user ganjoor bookmarks (only  Id, CoupletIndex and DateTime are valid)
             </summary>
             <param name="userId"></param>
             <param name="poemId"></param>
@@ -9790,7 +9790,7 @@
         </member>
         <member name="M:RMuseum.Services.Implementation.GanjoorService.GetPoemUserBookmarks(System.Guid,System.Int32)">
             <summary>
-            get user ganjoor bookmarks
+            get user ganjoor bookmarks (only Id, CoupletIndex and DateTime are valid)
             </summary>
             <param name="userId"></param>
             <param name="poemId"></param>
diff --git a/RMuseum/Services/IGanjoorService.cs b/RMuseum/Services/IGanjoorService.cs
index 7c2d5e02..61a7b558 100644
--- a/RMuseum/Services/IGanjoorService.cs
+++ b/RMuseum/Services/IGanjoorService.cs
@@ -585,12 +585,12 @@ namespace RMuseum.Services
         Task<RServiceResult<bool>> DeleteGanjoorBookmark(Guid bookmarkId, Guid userId);
 
         /// <summary>
-        /// get user ganjoor bookmarks
+        /// get user ganjoor bookmarks (only  Id, CoupletIndex and DateTime are valid)
         /// </summary>
         /// <param name="userId"></param>
         /// <param name="poemId"></param>
         /// <returns></returns>
-        Task<RServiceResult<GanjoorUserBookmark[]>> GetPoemUserBookmarks(Guid userId, int poemId);
+        Task<RServiceResult<GanjoorUserBookmarkViewModel[]>> GetPoemUserBookmarks(Guid userId, int poemId);
 
         /// <summary>
         /// get verse bookmarks
diff --git a/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-Bookmarking.cs b/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-Bookmarking.cs
index d65992f1..e7fd472e 100644
--- a/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-Bookmarking.cs
+++ b/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-Bookmarking.cs
@@ -82,15 +82,26 @@ namespace RMuseum.Services.Implementation
         }
 
         /// <summary>
-        /// get user ganjoor bookmarks
+        /// get user ganjoor bookmarks (only Id, CoupletIndex and DateTime are valid)
         /// </summary>
         /// <param name="userId"></param>
         /// <param name="poemId"></param>
         /// <returns></returns>
-        public async Task<RServiceResult<GanjoorUserBookmark[]>> GetPoemUserBookmarks(Guid userId, int poemId)
-        { 
-            GanjoorUserBookmark[] bookmarks = await _context.GanjoorUserBookmarks.Where(b => b.PoemId == poemId && b.UserId == userId).ToArrayAsync();
-            return new RServiceResult<GanjoorUserBookmark[]>(bookmarks);
+        public async Task<RServiceResult<GanjoorUserBookmarkViewModel[]>> GetPoemUserBookmarks(Guid userId, int poemId)
+        {
+            GanjoorUserBookmarkViewModel[] bookmarks = 
+                await _context.GanjoorUserBookmarks
+                .Where(b => b.PoemId == poemId && b.UserId == userId)
+                .Select(b => 
+                    new GanjoorUserBookmarkViewModel()
+                    {
+                        Id = b.Id,
+                        CoupletIndex = b.CoupletIndex,
+                        DateTime = b.DateTime,
+                    }
+                )
+                .ToArrayAsync();
+            return new RServiceResult<GanjoorUserBookmarkViewModel[]>(bookmarks);
         }
 
         /// <summary>