feat: add data shaping to cuntries controller

Server/Controllers/CountryManagementController.cs

@@ -46,14 +46,14 @@ public class CountryManagementController : ControllerBase
     }
     
     [HttpGet("{id}")]
-    public async Task<IActionResult> GetCountry(int id)
+    public async Task<IActionResult> GetCountry(int id, [FromQuery] string? fields)
     {
         if (!await _countryManagementService.IsCountryExists(id))
         {
             return NotFound();
         }
 
-        var result = await _countryManagementService.GetCountry(id);
+        var result = await _countryManagementService.GetCountry(id, fields);
 
         if (!result.isSucceed)
         {
@@ -78,7 +78,7 @@ public class CountryManagementController : ControllerBase
             return BadRequest(result.message);
         }
     
-        return Ok(result);
+        return Ok(result.country);
     }
     
     [HttpDelete("{id}")]

Server/Helpers/DataShaper.cs

@@ -0,0 +1,69 @@
+using System.Dynamic;
+using System.Reflection;
+
+namespace Server.Helpers;
+
+public class DataShaper<T> : IDataShaper<T>
+{
+    public PropertyInfo[] Properties { get; set; }
+    
+    public DataShaper()
+    {
+        Properties = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance);
+    }
+    
+    public IEnumerable<ExpandoObject> ShapeData(IEnumerable<T> entities, string? fieldsString)
+    {
+        var requiredProperties = GetRequiredProperties(fieldsString);
+        return FetchData(entities, requiredProperties);
+    }
+    
+    public ExpandoObject ShapeData(T entity, string? fieldsString)
+    {
+        var requiredProperties = GetRequiredProperties(fieldsString);
+        return FetchDataForEntity(entity, requiredProperties);
+    }
+    
+    private IEnumerable<PropertyInfo> GetRequiredProperties(string? fieldsString)
+    {
+        var requiredProperties = new List<PropertyInfo>();
+        if (!string.IsNullOrWhiteSpace(fieldsString))
+        {
+            var fields = fieldsString.Split(',', StringSplitOptions.RemoveEmptyEntries);
+            foreach (var field in fields)
+            {
+                var property = Properties.FirstOrDefault(pi => pi.Name.Equals(field.Trim(), StringComparison.InvariantCultureIgnoreCase));
+                if (property == null)
+                    continue;
+                requiredProperties.Add(property);
+            }
+        }
+        else
+        {
+            requiredProperties = Properties.ToList();
+        }
+        return requiredProperties;
+    }
+    
+    private IEnumerable<ExpandoObject> FetchData(IEnumerable<T> entities, IEnumerable<PropertyInfo> requiredProperties)
+    {
+        var shapedData = new List<ExpandoObject>();
+        foreach (var entity in entities)
+        {
+            var shapedObject = FetchDataForEntity(entity, requiredProperties);
+            shapedData.Add(shapedObject);
+        }
+        return shapedData;
+    }
+    
+    private ExpandoObject FetchDataForEntity(T entity, IEnumerable<PropertyInfo> requiredProperties)
+    {
+        var shapedObject = new ExpandoObject();
+        foreach (var property in requiredProperties)
+        {
+            var objectPropertyValue = property.GetValue(entity);
+            shapedObject.TryAdd(property.Name, objectPropertyValue);
+        }
+        return shapedObject;
+    }
+}

Server/Helpers/IDataShaper.cs

@@ -0,0 +1,9 @@
+using System.Dynamic;
+
+namespace Server.Helpers;
+
+public interface IDataShaper<T>
+{
+    IEnumerable<ExpandoObject> ShapeData(IEnumerable<T> entities, string? fieldsString);
+    ExpandoObject ShapeData(T entity, string? fieldsString);
+}

Server/Program.cs

@@ -5,6 +5,7 @@ using Microsoft.EntityFrameworkCore;
 using Microsoft.IdentityModel.Tokens;
 using Microsoft.OpenApi.Models;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Serialization;
 using Server.Configurations;
 using Server.Data;
 using Server.Helpers;
@@ -15,8 +16,11 @@ var builder = WebApplication.CreateBuilder(args);
 
 // Add services to the container.
 
-builder.Services.AddControllers().AddNewtonsoftJson(options =>
-    options.SerializerSettings.Formatting = Formatting.Indented);
+builder.Services.AddControllers().AddNewtonsoftJson(options => {
+    options.SerializerSettings.Formatting = Formatting.Indented;
+    options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
+    
+});
 
 // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
 builder.Services.AddEndpointsApiExplorer();
@@ -88,6 +92,8 @@ builder.Services.AddScoped<IDateTimeService, DateTimeService>();
 
 builder.Services.AddScoped<ISortHelper<Country>, SortHelper<Country>>();
 
+builder.Services.AddScoped<IDataShaper<Country>, DataShaper<Country>>();
+
 // Adding DB Context with PostgreSQL
 var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
 builder.Services.AddDbContext<ApplicationDbContext>(options =>

Server/Services/CountryManagementService.cs

@@ -1,3 +1,4 @@
+using System.Dynamic;
 using System.Linq.Dynamic.Core;
 using AutoMapper;
 using AutoMapper.QueryableExtensions;
@@ -15,13 +16,16 @@ public class CountryManagementService : ICountryManagementService
     private readonly ApplicationDbContext _dbContext;
     private readonly IMapper _mapper;
     private readonly ISortHelper<Country> _countrySortHelper;
+    private readonly IDataShaper<Country> _countryDataShaper;
 
     public CountryManagementService(ApplicationDbContext dbContext,
-        IMapper mapper, ISortHelper<Country> countrySortHelper)
+        IMapper mapper, ISortHelper<Country> countrySortHelper, 
+        IDataShaper<Country> countryDataShaper)
     {
         _dbContext = dbContext;
         _mapper = mapper;
         _countrySortHelper = countrySortHelper;
+        _countryDataShaper = countryDataShaper;
     }
 
     public async Task<(bool isSucceed, string message, CountryDto country)> AddCountry(CreateCountryDto createCountryDto)
@@ -34,7 +38,7 @@ public class CountryManagementService : ICountryManagementService
         return (true, String.Empty, _mapper.Map<CountryDto>(country));
     }
 
-    public async Task<(bool isSucceed, string message, IEnumerable<CountryDto> countries,
+    public async Task<(bool isSucceed, string message, IEnumerable<ExpandoObject> countries,
             PagingMetadata<Country> pagingMetadata)> GetCountries(CountryParameters parameters)
     {
         var dbCountries = _dbContext.Countries.AsQueryable();
@@ -59,10 +63,9 @@ public class CountryManagementService : ICountryManagementService
         var pagingMetadata = ApplyPaging(ref dbCountries, parameters.PageNumber,
             parameters.PageSize);
 
-        var countryDtos =
-            dbCountries.ProjectTo<CountryDto>(_mapper.ConfigurationProvider);
+        var shapedCountiesData = _countryDataShaper.ShapeData(dbCountries, parameters.Fields);
         
-        return (true, "", countryDtos, pagingMetadata);
+        return (true, "", shapedCountiesData, pagingMetadata);
 
         void SearchByAllCountryFields(ref IQueryable<Country> countries,
             string? search)
@@ -117,21 +120,22 @@ public class CountryManagementService : ICountryManagementService
         }
     }
     
-    public async Task<(bool isSucceed, string message, CountryDto country)> GetCountry(int id)
+    public async Task<(bool isSucceed, string message, ExpandoObject country)> GetCountry(int id, string? fields)
     {
         var dbCountry = await _dbContext.Countries.Where(c => c.Id == id)
-            .ProjectTo<CountryDto>(_mapper.ConfigurationProvider)
             .FirstOrDefaultAsync();
 
         if (dbCountry == null)
         {
             return (false, $"Country doesn't exist", null)!;
         }
+        
+        var shapedCountryData = _countryDataShaper.ShapeData(dbCountry, fields);
 
-        return (true, "", dbCountry);
+        return (true, "", shapedCountryData);
     }
 
-    public async Task<(bool isSucceed, string message, CountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto)
+    public async Task<(bool isSucceed, string message, UpdateCountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto)
     {
         var country = _mapper.Map<Country>(updateCountryDto);
         _dbContext.Entry(country).State = EntityState.Modified;
@@ -152,7 +156,7 @@ public class CountryManagementService : ICountryManagementService
 
         var dbCountry = await _dbContext.Countries.FirstOrDefaultAsync(c => c.Id == country.Id);
         
-        return (true, String.Empty, _mapper.Map<CountryDto>(dbCountry));
+        return (true, String.Empty, _mapper.Map<UpdateCountryDto>(dbCountry));
     }
 
     public async Task<(bool isSucceed, string message)> DeleteCountry(int id)

Server/Services/ICountryManagementService.cs

@@ -1,3 +1,4 @@
+using System.Dynamic;
 using Server.Models;
 using SharedModels.DataTransferObjects;
 using SharedModels.QueryStringParameters;
@@ -8,10 +9,10 @@ public interface ICountryManagementService
 {
     Task<(bool isSucceed, string message, CountryDto country)> AddCountry(CreateCountryDto createCountryDto);
 
-    Task<(bool isSucceed, string message, IEnumerable<CountryDto> countries,
+    Task<(bool isSucceed, string message, IEnumerable<ExpandoObject> countries,
         PagingMetadata<Country> pagingMetadata)> GetCountries(CountryParameters parameters);
-    Task<(bool isSucceed, string message, CountryDto country)> GetCountry(int id);
-    Task<(bool isSucceed, string message, CountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto);
+    Task<(bool isSucceed, string message, ExpandoObject country)> GetCountry(int id, string? fields);
+    Task<(bool isSucceed, string message, UpdateCountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto);
     Task<(bool isSucceed, string message)> DeleteCountry(int id);
     Task<bool> IsCountryExists(int id);
 }

SharedModels/QueryStringParameters/CountryParameters.cs

@@ -5,6 +5,7 @@ public class CountryParameters : QueryStringParameters
     public CountryParameters()
     {
         Sort = "id";
+        Fields = "id,code,name,states";
     }
     
     public string? Code { get; set; }

SharedModels/QueryStringParameters/QueryStringParameters.cs

@@ -14,4 +14,5 @@ public class QueryStringParameters
     
     public string? Search { get; set; }
     public string? Sort { get; set; }
+    public string? Fields { get; set; }
 }