feat(controller): PATCH and DELETE

Author: jaredcnance

src/JsonApiDotNetCore/Controllers/JsonApiController.cs

@@ -9,7 +9,17 @@
 
 namespace JsonApiDotNetCore.Controllers
 {
-    public class JsonApiController<T> : Controller where T : class, IIdentifiable<int>
+    public class JsonApiController<T> : JsonApiController<T, int> where T : class, IIdentifiable<int>
+    {
+        public JsonApiController(
+            ILoggerFactory loggerFactory,
+            DbContext context, 
+            IJsonApiContext jsonApiContext)
+            : base(loggerFactory, context, jsonApiContext)
+            { }
+    }
+
+    public class JsonApiController<T, TId> : Controller where T : class, IIdentifiable<TId>
     {
         private readonly DbContext _context;
         private readonly DbSet<T> _dbSet;
@@ -25,8 +35,8 @@ public JsonApiController(
             _dbSet = context.GetDbSet<T>();
             _jsonApiContext = jsonApiContext;
 
-            _logger = loggerFactory.CreateLogger<JsonApiController<T>>();
-            _logger.LogInformation($@"JsonApiController activated with ContextGraph: 
+            _logger = loggerFactory.CreateLogger<JsonApiController<T, TId>>();
+            _logger.LogTrace($@"JsonApiController activated with ContextGraph: 
                 {JsonConvert.SerializeObject(jsonApiContext.ContextGraph)}");
         }
 
@@ -42,15 +52,14 @@ public JsonApiController(
         [HttpGet]
         public virtual IActionResult Get() 
         {
-            _logger.LogInformation("");
             var entities = _dbSet.ToList();
             return Ok(entities);
         }
 
         [HttpGet("{id}")]
-        public virtual IActionResult Get(int id) 
+        public virtual IActionResult Get(TId id) 
         {
-            var entity = _dbSet.FirstOrDefault(e => e.Id == id);
+            var entity = _dbSet.FirstOrDefault(e => e.Id.Equals(id));
 
             if(entity == null)
                 return NotFound();
@@ -59,7 +68,7 @@ public virtual IActionResult Get(int id)
         }
 
         [HttpGet("{id}/{relationshipName}")]
-        public virtual IActionResult GetRelationship(int id, string relationshipName) 
+        public virtual IActionResult GetRelationship(TId id, string relationshipName) 
         {
             relationshipName = _jsonApiContext.ContextGraph.GetRelationshipName<T>(relationshipName);
 
@@ -68,7 +77,7 @@ public virtual IActionResult GetRelationship(int id, string relationshipName)
 
             var entity = _dbSet
                 .Include(relationshipName)
-                .FirstOrDefault(e => e.Id == id);
+                .FirstOrDefault(e => e.Id.Equals(id));
 
             if(entity == null)
                 return NotFound();
@@ -99,26 +108,47 @@ public virtual IActionResult Post([FromBody] T entity)
         [HttpPatch("{id}")]
         public virtual IActionResult Patch(int id, [FromBody] T entity) 
         {
+            if(entity == null)
+                return BadRequest();
 
-            return Ok("Patch Id");
-        }
+            var oldEntity = _dbSet.FirstOrDefault(e => e.Id.Equals(id));
+            if(oldEntity == null)
+                return NotFound();
 
-        [HttpPatch("{id}/{relationship}")]
-        public virtual IActionResult PatchRelationship(int id, string relation) 
-        {
-            return Ok("Patch Id/relationship");
+            var requestEntity = _jsonApiContext.RequestEntity;
+
+            requestEntity.Attributes.ForEach(attr => {
+                attr.SetValue(oldEntity, attr.GetValue(entity));
+            });
+
+            _context.SaveChanges();
+
+            return Ok(oldEntity);
         }
 
+        // [HttpPatch("{id}/{relationship}")]
+        // public virtual IActionResult PatchRelationship(int id, string relation) 
+        // {
+        //     return Ok("Patch Id/relationship");
+        // }
+
         [HttpDelete("{id}")]
-        public virtual IActionResult Delete(int id) 
+        public virtual IActionResult Delete(TId id) 
         {
-            return Ok("Delete Id");
+            var entity = _dbSet.FirstOrDefault(e => e.Id.Equals(id));
+            if(entity == null)
+                return NotFound();
+            
+            _dbSet.Remove(entity);
+            _context.SaveChanges();
+            
+            return Ok();
         }
 
-        [HttpDelete("{id}/{relationship}")]
-        public virtual IActionResult Delete(int id, string relation) 
-        {
-            return Ok("Delete Id/relationship");
-        }
+        // [HttpDelete("{id}/{relationship}")]
+        // public virtual IActionResult Delete(int id, string relation) 
+        // {
+        //     return Ok("Delete Id/relationship");
+        // }
     }
 }

src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs

@@ -36,8 +36,8 @@ public Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
             try
             {
                 var body = GetRequestBody(context.HttpContext.Request.Body);
-                var contextGraph = context.HttpContext.RequestServices.GetService<IJsonApiContext>().ContextGraph;
-                var model = JsonApiDeSerializer.Deserialize(body, contextGraph);
+                var jsonApiContext = context.HttpContext.RequestServices.GetService<IJsonApiContext>();
+                var model = JsonApiDeSerializer.Deserialize(body, jsonApiContext);
 
                 return InputFormatterResult.SuccessAsync(model);
             }

src/JsonApiDotNetCore/Formatters/JsonApiOutputFormatter.cs

@@ -27,7 +27,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)
                 throw new ArgumentNullException(nameof(context));
 
             var response = context.HttpContext.Response;
-
+            
             using (var writer = context.WriterFactory(response.Body, Encoding.UTF8))
             {
                 var contextGraph = context.HttpContext.RequestServices.GetService<IJsonApiContext>().ContextGraph;

src/JsonApiDotNetCore/Internal/AttrAttribute.cs

@@ -20,5 +20,16 @@ public object GetValue(object entity)
                 .GetProperty(InternalAttributeName)
                 .GetValue(entity);
         }
+
+        public void SetValue(object entity, object newValue)
+        {
+            var propertyInfo = entity
+                .GetType()
+                .GetProperty(InternalAttributeName);
+                
+            var convertedValue = Convert.ChangeType(newValue, propertyInfo.PropertyType);
+            
+            propertyInfo.SetValue(entity, convertedValue);
+        }
     }
 }

src/JsonApiDotNetCore/Serialization/JsonApiDeSerializer.cs

@@ -5,19 +5,21 @@
 using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Models;
+using JsonApiDotNetCore.Services;
 using Newtonsoft.Json;
 
 namespace JsonApiDotNetCore.Serialization
 {
     public static class JsonApiDeSerializer
     {
-        public static object Deserialize(string requestBody, IContextGraph contextGraph)
+        public static object Deserialize(string requestBody, IJsonApiContext context)
         {
             var document = JsonConvert.DeserializeObject<Document>(requestBody);
 
             var entityTypeName = document.Data.Type.ToProperCase();
 
-            var contextEntity = contextGraph.GetContextEntity(entityTypeName);
+            var contextEntity = context.ContextGraph.GetContextEntity(entityTypeName);
+            context.RequestEntity = contextEntity;
 
             var entity = Activator.CreateInstance(contextEntity.EntityType);
 

src/JsonApiDotNetCore/Services/IJsonApiContext.cs

@@ -5,5 +5,6 @@ namespace JsonApiDotNetCore.Services
     public interface IJsonApiContext
     {
         IContextGraph ContextGraph { get; set; }
+        ContextEntity RequestEntity { get; set; }
     }
 }

src/JsonApiDotNetCore/Services/JsonApiContext.cs

@@ -4,6 +4,7 @@ namespace JsonApiDotNetCore.Services
 {
     public class JsonApiContext : IJsonApiContext
     {
+        public ContextEntity RequestEntity { get; set; }
         public IContextGraph ContextGraph { get; set; }
     }
 }

src/JsonApiDotNetCoreExample/README.md

@@ -1,39 +1,41 @@
-# Welcome to ASP.NET Core
-
-We've made some big updates in this release, so it’s **important** that you spend a few minutes to learn what’s new.
-
-You've created a new ASP.NET Core project. [Learn what's new](https://go.microsoft.com/fwlink/?LinkId=518016)
-
-## This application consists of:
-
-*   Sample pages using ASP.NET Core MVC
-*   [Bower](https://go.microsoft.com/fwlink/?LinkId=518004) for managing client-side libraries
-*   Theming using [Bootstrap](https://go.microsoft.com/fwlink/?LinkID=398939)
-
-## How to
-
-*   [Add a Controller and View](https://go.microsoft.com/fwlink/?LinkID=398600)
-*   [Add an appsetting in config and access it in app.](https://go.microsoft.com/fwlink/?LinkID=699562)
-*   [Manage User Secrets using Secret Manager.](https://go.microsoft.com/fwlink/?LinkId=699315)
-*   [Use logging to log a message.](https://go.microsoft.com/fwlink/?LinkId=699316)
-*   [Add packages using NuGet.](https://go.microsoft.com/fwlink/?LinkId=699317)
-*   [Add client packages using Bower.](https://go.microsoft.com/fwlink/?LinkId=699318)
-*   [Target development, staging or production environment.](https://go.microsoft.com/fwlink/?LinkId=699319)
-
-## Overview
-
-*   [Conceptual overview of what is ASP.NET Core](https://go.microsoft.com/fwlink/?LinkId=518008)
-*   [Fundamentals of ASP.NET Core such as Startup and middleware.](https://go.microsoft.com/fwlink/?LinkId=699320)
-*   [Working with Data](https://go.microsoft.com/fwlink/?LinkId=398602)
-*   [Security](https://go.microsoft.com/fwlink/?LinkId=398603)
-*   [Client side development](https://go.microsoft.com/fwlink/?LinkID=699321)
-*   [Develop on different platforms](https://go.microsoft.com/fwlink/?LinkID=699322)
-*   [Read more on the documentation site](https://go.microsoft.com/fwlink/?LinkID=699323)
-
-## Run & Deploy
-
-*   [Run your app](https://go.microsoft.com/fwlink/?LinkID=517851)
-*   [Run tools such as EF migrations and more](https://go.microsoft.com/fwlink/?LinkID=517853)
-*   [Publish to Microsoft Azure Web Apps](https://go.microsoft.com/fwlink/?LinkID=398609)
-
-We would love to hear your [feedback](https://go.microsoft.com/fwlink/?LinkId=518015)
+# Task List 
+
+- [x] Add inbound serialization formatting
+- [x] Add POST
+- [x] Add PATCH
+- [ ] Add DELETE
+- [ ] Add Relationships
+- [ ] Add support for authorization/context-scoping middleware
+- [ ] BadRequest should be 422 in POST
+- [ ] Add integration tests to example project
+
+## Usage
+
+- Add Middleware
+- Define Models
+- Define Controllers
+
+## Defining Models
+
+## Defining Controllers
+
+```
+```
+
+#### Non-Integer Type Keys
+
+If your model is using a type other than `int` for the primary key,
+you should explicitly declare it in the controller generic:
+
+```
+[Route("api/[controller]")]
+public class ThingsController : JsonApiController<Person, Guid>
+{
+    public ThingsController(
+        ILoggerFactory loggerFactory,
+        AppDbContext context, 
+        IJsonApiContext jsonApiContext) 
+        : base(loggerFactory, context, jsonApiContext)
+    { }
+}
+```

src/JsonApiDotNetCoreExample/appsettings.json

@@ -5,9 +5,9 @@
   "Logging": {
     "IncludeScopes": false,
     "LogLevel": {
-      "Default": "Debug",
-      "System": "Information",
-      "Microsoft": "Information"
+      "Default": "Trace",
+      "System": "Trace",
+      "Microsoft": "Trace"
     }
   }
 }