Merge pull request #37 from intility/generic-exception

feat: ✨ general-purpose exception class

Author: erlendellefsen

JsonApiToolkit.Tests/Filters/JsonApiExceptionFilterTests.cs

@@ -213,4 +213,29 @@ public void OnException_WithUnhandledException_LogsWithStackTrace()
             Times.Once
         );
     }
+
+    [Theory]
+    [InlineData(402, "Payment Required")]
+    [InlineData(410, "Gone")]
+    [InlineData(422, "Unprocessable Entity")]
+    [InlineData(451, "Unavailable For Legal Reasons")]
+    public void OnException_WithJsonApiHttpException_ReturnsCorrectStatusAndTitle(
+        int statusCode,
+        string expectedTitle
+    )
+    {
+        var exception = new JsonApiHttpException(statusCode, "Test message");
+        var context = CreateExceptionContext(exception);
+
+        _filter.OnException(context);
+
+        Assert.True(context.ExceptionHandled);
+        var result = Assert.IsType<ObjectResult>(context.Result);
+        Assert.Equal(statusCode, result.StatusCode);
+        var errorResponse = Assert.IsType<JsonApiErrorResponse>(result.Value);
+
+        Assert.Single(errorResponse.Errors);
+        Assert.Equal(statusCode.ToString(), errorResponse.Errors[0].Status);
+        Assert.Equal(expectedTitle, errorResponse.Errors[0].Title);
+    }
 }

JsonApiToolkit/Filters/JsonApiExceptionFilter.cs

@@ -1,3 +1,5 @@
+using System.Net;
+using System.Text.RegularExpressions;
 using JsonApiToolkit.Models.Errors;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
@@ -68,15 +70,14 @@ public void OnException(ExceptionContext context)
         context.ExceptionHandled = true;
     }
 
-    private static string GetTitleForStatusCode(int statusCode) =>
-        statusCode switch
+    private static string GetTitleForStatusCode(int statusCode)
+    {
+        if (Enum.IsDefined(typeof(HttpStatusCode), statusCode))
         {
-            400 => "Bad Request",
-            401 => "Unauthorized",
-            403 => "Forbidden",
-            404 => "Not Found",
-            409 => "Conflict",
-            429 => "Too Many Requests",
-            _ => "Error",
-        };
+            // Convert PascalCase enum name to Title Case with spaces
+            var name = ((HttpStatusCode)statusCode).ToString();
+            return Regex.Replace(name, "(\\B[A-Z])", " $1");
+        }
+        return "Error";
+    }
 }

JsonApiToolkit/Models/Errors/JsonApiErrorTypes.cs

@@ -188,3 +188,29 @@ public JsonApiTooManyRequestsException(
     )
         : base(429, message, code, errorSource, meta, innerException) { }
 }
+
+/// <summary>
+/// General-purpose exception for any HTTP status code.
+/// Use this when the specific exception types don't cover your use case.
+/// </summary>
+public class JsonApiHttpException : JsonApiException
+{
+    /// <summary>
+    /// Initializes a new JSON:API HTTP exception with any status code.
+    /// </summary>
+    public JsonApiHttpException(int statusCode, string message)
+        : base(statusCode, message) { }
+
+    /// <summary>
+    /// Initializes a new JSON:API HTTP exception with additional details.
+    /// </summary>
+    public JsonApiHttpException(
+        int statusCode,
+        string message,
+        string? code = null,
+        ErrorSource? errorSource = null,
+        Dictionary<string, object>? meta = null,
+        Exception? innerException = null
+    )
+        : base(statusCode, message, code, errorSource, meta, innerException) { }
+}