Merge branch 'release/1.5.0'

Author: EvilLord666

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Controllers/BasicPagedDataController.cs

@@ -1,21 +1,18 @@
 using Microsoft.AspNetCore.Mvc;
+using Wissance.WebApiToolkit.Utils;
 
 namespace Wissance.WebApiToolkit.Controllers
 {
     public abstract class BasicPagedDataController : ControllerBase
     {
         protected int GetPage(int? page)
         {
-            int selectedPage = page ?? DefaultPage;
-            return selectedPage < 1 ? 1 : selectedPage;
+            return PagingUtils.GetPage(page);
         }
 
         protected int GetPageSize(int? size)
         {
-            return size ?? DefaultSize;
+            return PagingUtils.GetPageSize(size);
         }
-
-        private const int DefaultPage = 1;
-        private const int DefaultSize = 25;
     }
 }

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Controllers/BasicReadController.cs

@@ -8,6 +8,7 @@
 using Wissance.WebApiToolkit.Data;
 using Wissance.WebApiToolkit.Dto;
 using Wissance.WebApiToolkit.Managers;
+using Wissance.WebApiToolkit.Utils;
 
 namespace Wissance.WebApiToolkit.Controllers
 {
@@ -29,7 +30,7 @@ public virtual async Task<PagedDataDto<TRes>> ReadAsync([FromQuery] int? page, [
                 .ToDictionary(k => k.Key, v => v.Value.ToString());
             OperationResultDto<Tuple<IList<TRes>, long>> result = await Manager.GetAsync(pageNumber, pageSize, sorting, parameters);
             HttpContext.Response.StatusCode = result.Status;
-            return new PagedDataDto<TRes>(pageNumber, result.Data.Item2, GetTotalPages(result.Data.Item2, pageSize), result.Data.Item1);
+            return new PagedDataDto<TRes>(pageNumber, result.Data.Item2, PagingUtils.GetTotalPages(result.Data.Item2, pageSize), result.Data.Item1);
         }
 
         [HttpGet]
@@ -41,17 +42,6 @@ public async Task<TRes> ReadByIdAsync([FromRoute] TId id)
             return result.Data;
         }
 
-        private long GetTotalPages(long totalItems, int pageSize)
-        {
-            if (pageSize <= 0)
-            {
-                // todo(UMV): this is hardly ever possible but add logging here for jokers
-                return -1;
-            }
-
-            return (long)Math.Ceiling((double)totalItems / pageSize);
-        }
-
         private const string PageQueryParam = "page";
         private const string SizeQueryParam = "size";
         private const string SortQueryParam = "sort";

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Services/IResourceBasedCrudService.cs

@@ -0,0 +1,22 @@
+using System.Threading.Tasks;
+using Wissance.WebApiToolkit.Dto;
+
+namespace Wissance.WebApiToolkit.Services
+{
+    /// <summary>
+    ///    This is a Resource based CRUD Service interface to interact in a Resource-oriented way
+    ///    via GRPC, could be used also for others Frameworks &amp;&amp; Protocols like SignalR &amp;&amp; WCF. This interface should be
+    ///    implemented in some real service classes. Examples will be here: https://github.com/Wissance/WeatherControl . Contains methods
+    ///    for Create, Update and Delete TData item respectively.
+    /// </summary>
+    /// <typeparam name="TRes">TRes (Resource) means Representation of Persistent data in external system i.e. DTO</typeparam>
+    /// <typeparam name="TData">Persistent item type, in terms of Web App it is a Table or some ORM Entity Class</typeparam>
+    /// <typeparam name="TId">Unique Identifier type (could be different for different apps i.e int/string/Guid)</typeparam>
+    public interface IResourceBasedCrudService<TRes, TData, TId> : IResourceBasedReadOnlyService<TRes, TData, TId>
+        where TRes: class
+    {
+        Task<OperationResultDto<TRes>> CreateAsync(TRes data);
+        Task<OperationResultDto<TRes>> UpdateAsync(TId id, TRes data);
+        Task<OperationResultDto<bool>> DeleteAsync(TId id);
+    }
+}

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Services/IResourceBasedReadOnlyService.cs

@@ -0,0 +1,21 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Wissance.WebApiToolkit.Dto;
+
+namespace Wissance.WebApiToolkit.Services
+{
+    /// <summary>
+    ///    This is a general RO-interface for object Reading. Mainly this interface is using for interact in a Resource-oriented way
+    ///    via GRPC, could be used also for others Frameworks && Protocols like SignalR && WCF. This interface should be
+    ///    implemented in some real service classes. Examples will be here: https://github.com/Wissance/WeatherControl
+    /// </summary>
+    /// <typeparam name="TRes">TRes (Resource) means Representation of Persistent data in external system i.e. DTO</typeparam>
+    /// <typeparam name="TData">Persistent item type, in terms of Web App it is a Table or some ORM Entity Class</typeparam>
+    /// <typeparam name="TId">Unique Identifier type (could be different for different apps i.e int/string/Guid)</typeparam>
+    public interface IResourceBasedReadOnlyService<TRes, TData, TId>
+        where TRes: class
+    {
+        Task<PagedDataDto<TRes>> ReadAsync(int? page, int? size, string sort, string order, IDictionary<string, string> filterParams);
+        Task<TRes> ReadByIdAsync(TId id);
+    }
+}

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Services/ResourceBasedDataManageableCrudService.cs

@@ -0,0 +1,36 @@
+using System.Threading.Tasks;
+using Wissance.WebApiToolkit.Dto;
+
+namespace Wissance.WebApiToolkit.Services
+{
+    /// <summary>
+    ///     This is a full CRUD service implementation based on usage IModelManager as a service class for accessing
+    ///     persistent storage. This class has both Read operations (from ResourceBasedDataManageableReadOnlyService)
+    ///     and Create, Update and Delete operations
+    /// </summary>
+    /// <typeparam name="TRes">TRes (Resource) means Representation of Persistent data in external system i.e. DTO</typeparam>
+    /// <typeparam name="TData">Persistent item type, in terms of Web App it is a Table or some ORM Entity Class</typeparam>
+    /// <typeparam name="TId">Unique Identifier type (could be different for different apps i.e int/string/Guid)</typeparam>
+    public class ResourceBasedDataManageableCrudService<TRes, TData, TId> : ResourceBasedDataManageableReadOnlyService<TRes, TData, TId>,
+        IResourceBasedCrudService<TRes, TData, TId>
+       where TRes: class
+    {
+        public async Task<OperationResultDto<TRes>> CreateAsync(TRes data)
+        {
+            OperationResultDto<TRes> result = await Manager.CreateAsync(data);
+            return result;
+        }
+
+        public async Task<OperationResultDto<TRes>> UpdateAsync(TId id, TRes data)
+        {
+            OperationResultDto<TRes> result = await Manager.UpdateAsync(id, data);
+            return result;
+        }
+
+        public async Task<OperationResultDto<bool>> DeleteAsync(TId id)
+        {
+            OperationResultDto<bool> result = await Manager.DeleteAsync(id);
+            return result;
+        }
+    }
+}

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Services/ResourceBasedDataManageableReadOnlyService.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Wissance.WebApiToolkit.Data;
+using Wissance.WebApiToolkit.Dto;
+using Wissance.WebApiToolkit.Managers;
+using Wissance.WebApiToolkit.Utils;
+
+namespace Wissance.WebApiToolkit.Services
+{
+    /// <summary>
+    ///    This is an implementation of IResourceBasedReadOnlyService based on usage IModelManager as a service class for accessing
+    ///    persistent storage. This class has 2 Operations:
+    ///        1. Read portion (page) of TData via Manager and Transform it to TRes inside Manager (see i.e. EfModelManager, EfSoftRemovableModelManager)
+    ///        2. Read single item from Manager and return it TRes representation
+    ///    This service class ia analog of a REST BasicReadController
+    /// </summary>
+    /// <typeparam name="TRes">TRes (Resource) means Representation of Persistent data in external system i.e. DTO</typeparam>
+    /// <typeparam name="TData">Persistent item type, in terms of Web App it is a Table or some ORM Entity Class</typeparam>
+    /// <typeparam name="TId">Unique Identifier type (could be different for different apps i.e int/string/Guid)</typeparam>
+    public abstract class ResourceBasedDataManageableReadOnlyService<TRes, TData, TId> : IResourceBasedReadOnlyService<TRes, TData, TId>
+        where TRes : class
+    {
+        public virtual async Task<PagedDataDto<TRes>> ReadAsync(int? page, int? size, string sort, string order, IDictionary<string, string> filterParams)
+        {
+            int pageNumber = PagingUtils.GetPage(page);
+            int pageSize = PagingUtils.GetPageSize(size);
+            SortOption sorting = !string.IsNullOrEmpty(sort) ? new SortOption(sort, order) : null;
+            OperationResultDto<Tuple<IList<TRes>, long>> result = await Manager.GetAsync(pageNumber, pageSize, sorting, filterParams);
+            return new PagedDataDto<TRes>(pageNumber, result.Data.Item2, PagingUtils.GetTotalPages(result.Data.Item2, pageSize), result.Data.Item1);
+        }
+
+        public virtual async Task<TRes> ReadByIdAsync(TId id)
+        {
+            OperationResultDto<TRes> result = await Manager.GetByIdAsync(id);
+            return result.Data;
+        }
+        
+        public IModelManager<TRes, TData, TId> Manager { get; set; }
+    }
+}

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Utils/PagingUtils.cs

@@ -0,0 +1,32 @@
+using System;
+
+namespace Wissance.WebApiToolkit.Utils
+{
+    public static class PagingUtils
+    {
+        public static long GetTotalPages(long totalItems, int pageSize)
+        {
+            if (pageSize <= 0)
+            {
+                // todo(UMV): this is hardly ever possible but add logging here for jokers
+                return -1;
+            }
+
+            return (long)Math.Ceiling((double)totalItems / pageSize);
+        }
+        
+        public static int GetPage(int? page)
+        {
+            int selectedPage = page ?? DefaultPage;
+            return selectedPage < 1 ? 1 : selectedPage;
+        }
+
+        public static int GetPageSize(int? size)
+        {
+            return size ?? DefaultSize;
+        }
+        
+        private const int DefaultPage = 1;
+        private const int DefaultSize = 25;
+    }
+}

Wissance.WebApiToolkit/Wissance.WebApiToolkit/Wissance.WebApiToolkit.csproj

@@ -10,6 +10,10 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Grpc.Tools" Version="2.60.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.AspNetCore" Version="2.2.0" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="2.2.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.2" />