[ADMINAPI-1100] - Finalize adminconsole/instances endpoints (#201)

* Add Update and Delete Instance feature * Add Update and Delete Instance feature * Fix GetInstanceById Fix EditInstance * Fix EditInstanceCommand * Change response code in PATCH verb --------- Co-authored-by: Juan Agudelo <jagudelo@wearegap.com>
Ed-Fi-Alliance-OSS · Dec 17, 2024 · 28d024e · 28d024e
1 parent 81c022f
commit 28d024e
Show file tree

Hide file tree

Showing 24 changed files with 1,022 additions and 60 deletions.
diff --git a/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/AddInstance.cs b/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/AddInstance.cs
@@ -4,6 +4,8 @@
 // See the LICENSE and NOTICES files in the project root for more information.
 
 using System.ComponentModel.DataAnnotations;
+using System.Dynamic;
+using System.Text.Json;
 using EdFi.Ods.AdminApi.AdminConsole.Infrastructure.Services.Instances.Commands;
 using EdFi.Ods.AdminApi.Common.Features;
 using EdFi.Ods.AdminApi.Common.Infrastructure;
@@ -33,19 +35,19 @@ public async Task<IResult> Execute(Validator validator, IAddInstanceCommand addI
     public class AddInstanceRequest : IAddInstanceModel
     {
         [Required]
-        public int InstanceId { get; set; }
+        public int OdsInstanceId { get; set; }
         public int? EdOrgId { get; set; }
         [Required]
         public int TenantId { get; set; }
         [Required]
-        public string Document { get; set; }
+        public ExpandoObject Document { get; set; }
     }
 
     public class Validator : AbstractValidator<AddInstanceRequest>
     {
         public Validator()
         {
-            RuleFor(m => m.InstanceId)
+            RuleFor(m => m.OdsInstanceId)
              .NotNull();
 
             RuleFor(m => m.EdOrgId)
@@ -57,14 +59,15 @@ public Validator()
              .Must(BeValidDocument).WithMessage("Document must be a valid JSON.");
         }
 
-        private bool BeValidDocument(string document)
+        private bool BeValidDocument(ExpandoObject document)
         {
             try
             {
-                Newtonsoft.Json.Linq.JToken.Parse(document);
+                var jDocument = JsonSerializer.Serialize(document);
+                Newtonsoft.Json.Linq.JToken.Parse(jDocument);
                 return true;
             }
-            catch (Newtonsoft.Json.JsonReaderException)
+            catch
             {
                 return false;
             }

diff --git a/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/DeleteInstance.cs b/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/DeleteInstance.cs
@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: Apache-2.0
+// Licensed to the Ed-Fi Alliance under one or more agreements.
+// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+// See the LICENSE and NOTICES files in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using EdFi.Ods.AdminApi.AdminConsole.Infrastructure.Services.Instances.Commands;
+using EdFi.Ods.AdminApi.Common.Features;
+using EdFi.Ods.AdminApi.Common.Infrastructure;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
+using static EdFi.Ods.AdminApi.AdminConsole.Features.Instances.EditInstance;
+
+namespace EdFi.Ods.AdminApi.AdminConsole.Features.Instances;
+public class DeleteInstance : IFeature
+{
+    public void MapEndpoints(IEndpointRouteBuilder endpoints)
+    {
+        AdminApiEndpointBuilder.MapDelete(endpoints, "/instances/{odsinstanceid}", Execute)
+            .WithRouteOptions(b => b.WithResponseCode(200, FeatureCommonConstants.DeletedSuccessResponseDescription))
+            .BuildForVersions(AdminApiVersions.AdminConsole);
+    }
+
+    public async Task<IResult> Execute(IDeleteInstanceCommand deleteInstanceCommand, int odsInstanceId)
+    {
+        await deleteInstanceCommand.Execute(odsInstanceId);
+        return Results.Ok();
+    }
+}
diff --git a/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/EditInstance.cs b/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/EditInstance.cs
@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: Apache-2.0
+// Licensed to the Ed-Fi Alliance under one or more agreements.
+// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+// See the LICENSE and NOTICES files in the project root for more information.
+
+using EdFi.Ods.AdminApi.AdminConsole.Infrastructure.Services.Instances.Commands;
+using System.ComponentModel.DataAnnotations;
+using EdFi.Ods.AdminApi.Common.Features;
+using EdFi.Ods.AdminApi.Common.Infrastructure;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
+using FluentValidation;
+using static EdFi.Ods.AdminApi.AdminConsole.Features.Instances.AddInstance;
+using System.Dynamic;
+using System.Text.Json;
+
+namespace EdFi.Ods.AdminApi.AdminConsole.Features.Instances;
+
+public class EditInstance : IFeature
+{
+    public void MapEndpoints(IEndpointRouteBuilder endpoints)
+    {
+        AdminApiEndpointBuilder.MapPatch(endpoints, "/instances/{odsinstanceid}", Execute)
+            .WithRouteOptions(b => b.WithResponseCode(204))
+            .BuildForVersions(AdminApiVersions.AdminConsole);
+    }
+
+    public async Task<IResult> Execute(Validator validator, IEditInstanceCommand editInstanceCommand, EditInstanceRequest request, int odsInstanceId)
+    {
+        await validator.GuardAsync(request);
+        var instance = await editInstanceCommand.Execute(odsInstanceId, request);
+        return Results.NoContent();
+    }
+
+    public class EditInstanceRequest : IEditInstanceModel
+    {
+        [Required]
+        public ExpandoObject Document { get; set; }
+    }
+
+    public class Validator : AbstractValidator<EditInstanceRequest>
+    {
+        public Validator()
+        {
+            RuleFor(m => m.Document)
+             .NotNull()
+             .NotEmpty()
+             .Must(BeValidDocument).WithMessage("Document must be a valid JSON.");
+        }
+
+        private bool BeValidDocument(ExpandoObject document)
+        {
+            try
+            {
+                var jDocument = JsonSerializer.Serialize(document);
+                Newtonsoft.Json.Linq.JToken.Parse(jDocument);
+                return true;
+            }
+            catch
+            {
+                return false;
+            }
+        }
+    }
+}
diff --git a/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/ReadInstances.cs b/Application/EdFi.Ods.AdminApi.AdminConsole/Features/Instances/ReadInstances.cs
@@ -23,11 +23,7 @@ public void MapEndpoints(IEndpointRouteBuilder endpoints)
         AdminApiEndpointBuilder.MapGet(endpoints, "/instances", GetInstances)
             .BuildForVersions(AdminApiVersions.AdminConsole);
 
-        AdminApiEndpointBuilder.MapGet(endpoints, "/instances/{tenantId}/{id}", GetInstanceById)
-            .WithRouteOptions(b => b.WithResponse<InstanceModel>(200))
-            .BuildForVersions(AdminApiVersions.AdminConsole);
-
-        AdminApiEndpointBuilder.MapGet(endpoints, "/instances/{tenantId}", GetInstancesByTenantId)
+        AdminApiEndpointBuilder.MapGet(endpoints, "/instances/{odsinstanceid}", GetInstanceById)
             .WithRouteOptions(b => b.WithResponse<InstanceModel>(200))
             .BuildForVersions(AdminApiVersions.AdminConsole);
     }
@@ -38,23 +34,13 @@ internal async Task<IResult> GetInstances([FromServices] IGetInstancesQuery getI
         return Results.Ok(instances);
     }
 
-    internal async Task<IResult> GetInstanceById([FromServices] IGetInstanceByIdQuery getInstanceQuery, int tenantId, int id)
+    internal async Task<IResult> GetInstanceById([FromServices] IGetInstanceByIdQuery getInstanceQuery, int odsInstanceId)
     {
-        var instance = await getInstanceQuery.Execute(tenantId, id);
+        var instance = await getInstanceQuery.Execute(odsInstanceId);
 
         if (instance != null)
             return Results.Ok(instance);
 
         return Results.NotFound();
     }
-
-    internal async Task<IResult> GetInstancesByTenantId([FromServices] IGetInstancesByTenantIdQuery getInstancesQuery, int tenantId)
-    {
-        var instances = await getInstancesQuery.Execute(tenantId);
-        if (instances.Any())
-        {
-            return Results.Ok(instances);
-        }
-        return Results.NotFound();
-    }
 }
diff --git a/Application/EdFi.Ods.AdminApi.AdminConsole/Helpers/ExpandoObjectConverter.cs b/Application/EdFi.Ods.AdminApi.AdminConsole/Helpers/ExpandoObjectConverter.cs
@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: Apache-2.0
+// Licensed to the Ed-Fi Alliance under one or more agreements.
+// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+// See the LICENSE and NOTICES files in the project root for more information.
+
+using System.Dynamic;
+using Newtonsoft.Json;
+
+namespace EdFi.Ods.AdminApi.AdminConsole.Helpers;
+
+public class ExpandoObjectConverter : JsonConverter
+{
+    public override bool CanConvert(Type objectType)
+    {
+        return typeof(ExpandoObject).IsAssignableFrom(objectType);
+    }
+
+    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+    {
+        var dictionary = (IDictionary<string, object>)value;
+        writer.WriteStartObject();
+
+        foreach (var kvp in dictionary)
+        {
+            writer.WritePropertyName(kvp.Key);
+            serializer.Serialize(writer, kvp.Value);
+        }
+
+        writer.WriteEndObject();
+    }
+
+    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+    {
+        return serializer.Deserialize<ExpandoObject>(reader);
+    }
+}
diff --git a/Application/EdFi.Ods.AdminApi.AdminConsole/Helpers/ExpandoObjectHelper.cs b/Application/EdFi.Ods.AdminApi.AdminConsole/Helpers/ExpandoObjectHelper.cs
@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+// Licensed to the Ed-Fi Alliance under one or more agreements.
+// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+// See the LICENSE and NOTICES files in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Dynamic;
+using System.Linq;
+using System.Text;
+using System.Text.Json;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+
+namespace EdFi.Ods.AdminApi.AdminConsole.Helpers
+{
+    public static class ExpandoObjectHelper
+    {
+        public static ExpandoObject NormalizeExpandoObject(ExpandoObject expando)
+        {
+            var dictionary = (IDictionary<string, object>)expando;
+            var normalized = new ExpandoObject() as IDictionary<string, object>;
+
+            foreach (var kvp in dictionary)
+            {
+                if (kvp.Value is JsonElement jsonElement)
+                {
+                    normalized[kvp.Key] = jsonElement.ValueKind switch
+                    {
+                        JsonValueKind.String => jsonElement.GetString(),
+                        JsonValueKind.Number => jsonElement.GetDecimal(), // Cambia según el tipo esperado
+                        JsonValueKind.True => true,
+                        JsonValueKind.False => false,
+                        JsonValueKind.Null => null,
+                        JsonValueKind.Object => JsonConvert.DeserializeObject<ExpandoObject>(jsonElement.GetRawText()),
+                        _ => jsonElement.ToString()
+                    };
+                }
+                else if (kvp.Value is ExpandoObject nestedExpando)
+                {
+                    normalized[kvp.Key] = NormalizeExpandoObject(nestedExpando);
+                }
+                else
+                {
+                    normalized[kvp.Key] = kvp.Value;
+                }
+            }
+
+            return (ExpandoObject)normalized;
+        }
+
+    }
+}