From 2717c801d5d3b6e523fd8b65aa5eac72822cbe21 Mon Sep 17 00:00:00 2001
From: Hamid Reza Mohammadi <mohammadi.hr@gmail.com>
Date: Sun, 23 Apr 2023 18:28:19 +0330
Subject: [PATCH] docs: #379 api for retrieving list of books

---
 RMuseum/Controllers/GanjoorController.cs      | 20 ++++++++++++++
 .../Ganjoor/ViewModels/GanjoorCatViewModel.cs |  1 -
 RMuseum/RMuseum.xml                           | 18 +++++++++++++
 RMuseum/Services/IGanjoorService.cs           |  6 +++++
 .../Services/Implementation/GanjoorService.cs | 27 +++++++++++++++++++
 5 files changed, 71 insertions(+), 1 deletion(-)

diff --git a/RMuseum/Controllers/GanjoorController.cs b/RMuseum/Controllers/GanjoorController.cs
index b08a52f2..81854b50 100644
--- a/RMuseum/Controllers/GanjoorController.cs
+++ b/RMuseum/Controllers/GanjoorController.cs
@@ -513,6 +513,26 @@ namespace RMuseum.Controllers
             }
         }
 
+        /// <summary>
+        /// list of books
+        /// </summary>
+        /// <returns></returns>
+        [HttpGet]
+        [Route("books")]
+        [AllowAnonymous]
+        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(GanjoorCatViewModel[]))]
+        [ProducesResponseType((int)HttpStatusCode.BadRequest, Type = typeof(string))]
+        [ProducesResponseType((int)HttpStatusCode.NotFound)]
+        public async Task<IActionResult> GetBooksAsync()
+        {
+            var books = await _ganjoorService.GetBooksAsync();
+            if(!string.IsNullOrEmpty(books.ExceptionString))
+            {
+                return BadRequest(books.ExceptionString);
+            }
+            return Ok(books);
+        }
+
         /// <summary>
         /// batch rename cat poems
         /// </summary>
diff --git a/RMuseum/Models/Ganjoor/ViewModels/GanjoorCatViewModel.cs b/RMuseum/Models/Ganjoor/ViewModels/GanjoorCatViewModel.cs
index bd7f9043..ae5cea1f 100644
--- a/RMuseum/Models/Ganjoor/ViewModels/GanjoorCatViewModel.cs
+++ b/RMuseum/Models/Ganjoor/ViewModels/GanjoorCatViewModel.cs
@@ -1,5 +1,4 @@
 using Microsoft.AspNetCore.Http;
-using RSecurityBackend.Models.Image;
 using System;
 using System.Collections.Generic;
 
diff --git a/RMuseum/RMuseum.xml b/RMuseum/RMuseum.xml
index fef1eecf..f9d7c8f8 100644
--- a/RMuseum/RMuseum.xml
+++ b/RMuseum/RMuseum.xml
@@ -996,6 +996,12 @@
             <param name="id"></param>
             <returns>only RImageId field is valid</returns>
         </member>
+        <member name="M:RMuseum.Controllers.GanjoorController.GetBooksAsync">
+            <summary>
+            list of books
+            </summary>
+            <returns></returns>
+        </member>
         <member name="M:RMuseum.Controllers.GanjoorController.BatchRenameCatPoemTitles(System.Int32,RMuseum.Models.Ganjoor.ViewModels.GanjoorBatchNamingModel)">
             <summary>
             batch rename cat poems
@@ -12520,6 +12526,12 @@
             <param name="mapName"></param>
             <returns></returns>
         </member>
+        <member name="M:RMuseum.Services.IGanjoorService.GetBooksAsync">
+            <summary>
+            get list of books
+            </summary>
+            <returns></returns>
+        </member>
         <member name="M:RMuseum.Services.IGanjoorService.GetPageByUrl(System.String,System.Boolean)">
             <summary>
             get page by url
@@ -15706,6 +15718,12 @@
             <param name="mapName"></param>
             <returns></returns>
         </member>
+        <member name="M:RMuseum.Services.Implementation.GanjoorService.GetBooksAsync">
+            <summary>
+            get list of books
+            </summary>
+            <returns></returns>
+        </member>
         <member name="M:RMuseum.Services.Implementation.GanjoorService.GetCatById(System.Int32,System.Boolean,System.Boolean)">
             <summary>
             get cat by id
diff --git a/RMuseum/Services/IGanjoorService.cs b/RMuseum/Services/IGanjoorService.cs
index 4bc74a35..f7be0ee5 100644
--- a/RMuseum/Services/IGanjoorService.cs
+++ b/RMuseum/Services/IGanjoorService.cs
@@ -73,6 +73,12 @@ namespace RMuseum.Services
         /// <returns></returns>
         Task<RServiceResult<GanjoorCatViewModel>> SetCategoryExtraInfo(int catId, string bookName, Guid? imageId, bool sumUpSubsGeoLocations, string mapName);
 
+        /// <summary>
+        /// get list of books
+        /// </summary>
+        /// <returns></returns>
+        Task<RServiceResult<GanjoorCatViewModel[]>> GetBooksAsync();
+
         /// <summary>
         /// get page by url
         /// </summary>
diff --git a/RMuseum/Services/Implementation/GanjoorService.cs b/RMuseum/Services/Implementation/GanjoorService.cs
index 24098e89..1b46dc6f 100644
--- a/RMuseum/Services/Implementation/GanjoorService.cs
+++ b/RMuseum/Services/Implementation/GanjoorService.cs
@@ -245,6 +245,33 @@ namespace RMuseum.Services.Implementation
                 return new RServiceResult<GanjoorCatViewModel>(null, exp.ToString());
             }
         }
+        
+        /// <summary>
+        /// get list of books
+        /// </summary>
+        /// <returns></returns>
+        public async Task<RServiceResult<GanjoorCatViewModel[]>> GetBooksAsync()
+        {
+            try
+            {
+                return new RServiceResult<GanjoorCatViewModel[]>
+                    (
+                    await _context.GanjoorCategories.AsNoTracking().Where(c => !string.IsNullOrEmpty(c.BookName)).OrderBy(c => c.BookName)
+                    .Select(c => new GanjoorCatViewModel()
+                    {
+                        BookName = c.BookName,
+                        FullUrl = c.FullUrl,
+                        RImageId = c.RImageId
+                    }
+                    )
+                    .ToArrayAsync()
+                    );
+            }
+            catch (Exception exp)
+            {
+                return new RServiceResult<GanjoorCatViewModel[]>(null, exp.ToString());
+            }
+        }
 
         /// <summary>
         /// get cat by id