Define ValidationErrorResult in SpaServices; use it in MusicStore

Microsoft.AspNet.SpaServices/ValidationErrorResult.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.AspNet.Mvc;
+using Microsoft.AspNet.Mvc.ModelBinding;
+
+namespace Microsoft.AspNet.SpaServices
+{
+    public class ValidationErrorResult : ObjectResult {
+        public const int DefaultStatusCode = 400;
+
+        public ValidationErrorResult(ModelStateDictionary modelState, int errorStatusCode = DefaultStatusCode)
+            : base(CreateResultObject(modelState))
+        {
+            if (!modelState.IsValid) {
+                this.StatusCode = errorStatusCode;
+            }
+        }
+
+        private static IDictionary<string, IEnumerable<string>> CreateResultObject(ModelStateDictionary modelState)
+        {
+            if (modelState.IsValid) {
+                return null;
+            } else {
+                return modelState
+                    .Where(m => m.Value.Errors.Any())
+                    .ToDictionary(m => m.Key, m => m.Value.Errors.Select(me => me.ErrorMessage));
+            }
+        }
+    }
+}

Microsoft.AspNet.SpaServices/project.json

@@ -10,6 +10,7 @@
   "projectUrl": "",
   "licenseUrl": "",
   "dependencies": {
+      "Microsoft.AspNet.Mvc": "6.0.0-rc1-*",
       "Microsoft.AspNet.Routing": "1.0.0-rc1-*"
   },
   "frameworks": {

samples/angular/MusicStore/Apis/AlbumsApiController.cs

@@ -6,6 +6,7 @@ using Microsoft.Data.Entity;
 using AutoMapper;
 using MusicStore.Models;
 using MusicStore.Infrastructure;
+using Microsoft.AspNet.SpaServices;
 
 namespace MusicStore.Apis
 {
@@ -95,7 +96,7 @@ namespace MusicStore.Apis
             if (!ModelState.IsValid)
             {
                 // Return the model errors
-                return new ApiResult(ModelState);
+                return new ValidationErrorResult(ModelState);
             }
 
             // Save the changes to the DB
@@ -105,11 +106,10 @@ namespace MusicStore.Apis
 
             // TODO: Handle missing record, key violations, concurrency issues, etc.
 
-            return new ApiResult
+            return new ObjectResult(new {
-            {
                 Data = dbAlbum.AlbumId,
                 Message = "Album created successfully."
-            };
+            });
         }
 
         [HttpPut("{albumId:int}/update")]
@@ -118,18 +118,16 @@ namespace MusicStore.Apis
             if (!ModelState.IsValid)
             {
                 // Return the model errors
-                return new ApiResult(ModelState);
+                return new ValidationErrorResult(ModelState);
             }
 
             var dbAlbum = await _storeContext.Albums.SingleOrDefaultAsync(a => a.AlbumId == albumId);
 
             if (dbAlbum == null)
             {
-                return new ApiResult
+                return new ObjectResult(new {
-                {
-                    StatusCode = 404,
                     Message = string.Format("The album with ID {0} was not found.", albumId)
-                };
+                }) { StatusCode = 404 };
             }
 
             // Save the changes to the DB
@@ -138,10 +136,9 @@ namespace MusicStore.Apis
 
             // TODO: Handle missing record, key violations, concurrency issues, etc.
 
-            return new ApiResult
+            return new ObjectResult (new {
-            {
                 Message = "Album updated successfully."
-            };
+            });
         }
 
         [HttpDelete("{albumId:int}")]
@@ -161,10 +158,9 @@ namespace MusicStore.Apis
                 // TODO: Handle missing record, key violations, concurrency issues, etc.
             }
 
-            return new ApiResult
+            return new ObjectResult (new {
-            {
                 Message = "Album deleted successfully."
-            };
+            });
         }
     }
 

samples/angular/MusicStore/Infrastructure/ApiResult.cs

@@ -1,51 +0,0 @@
-using Microsoft.AspNet.Mvc;
-using Microsoft.AspNet.Mvc.ModelBinding;
-using Newtonsoft.Json;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
-
-namespace MusicStore.Infrastructure
-{
-    public class ApiResult : ActionResult
-    {
-        public ApiResult(ModelStateDictionary modelState)
-            : this()
-        {
-            if (modelState.Any(m => m.Value.Errors.Any()))
-            {
-                StatusCode = 400;
-                Message = "The model submitted was invalid. Please correct the specified errors and try again.";
-                ModelErrors = modelState
-                    .Where(m => m.Value.Errors.Any())
-                    .ToDictionary(m => m.Key, m => m.Value.Errors.Select(me => me.ErrorMessage ));
-            }
-        }
-
-        public ApiResult()
-        {
-
-        }
-
-        [JsonIgnore]
-        public int? StatusCode { get; set; }
-
-        public string Message { get; set; }
-
-        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
-        public object Data { get; set; }
-
-        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
-        public IDictionary<string, IEnumerable<string>> ModelErrors { get; set; }
-
-        public override Task ExecuteResultAsync(ActionContext context)
-        {
-            if (StatusCode.HasValue)
-            {
-                context.HttpContext.Response.StatusCode = StatusCode.Value;
-            }
-
-            return new ObjectResult(this).ExecuteResultAsync(context);
-        }
-    }
-}

samples/angular/MusicStore/wwwroot/ng-app/components/admin/album-edit/album-edit.ts

@@ -71,7 +71,7 @@ export class AlbumEdit {
                 if (response.status === 200) {
                     this.changesSaved = true;
                 } else {
-                    var errors = (<ValidationResponse>(response.json())).ModelErrors;
+                    var errors = <ValidationResponse>(response.json());
                     Object.keys(errors).forEach(key => {
                         errors[key].forEach(errorMessage => {
                             // TODO: There has to be a better API for this
@@ -101,6 +101,5 @@ export class AlbumEdit {
 }
 
 interface ValidationResponse {
-    Message: string;
+    [propertyName: string]: string[];
-    ModelErrors: { [key: string]: string[] };
 }