add relationships object to datum; rename routeBuilder to documentBuilder

Author: jaredcnance

JsonApiDotNetCore/Configuration/JsonApiModelConfiguration.cs

@@ -1,12 +1,8 @@
 using System;
 using System.Collections.Generic;
-using System.ComponentModel;
 using System.Linq;
 using System.Reflection;
 using AutoMapper;
-using JsonApiDotNetCore.Abstractions;
-using JsonApiDotNetCore.Attributes;
-using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Routing;
 using Microsoft.AspNetCore.Http;
 using Microsoft.EntityFrameworkCore;
@@ -16,12 +12,11 @@ namespace JsonApiDotNetCore.Configuration
   public class JsonApiModelConfiguration : IJsonApiModelConfiguration
   {
     public string Namespace;
-    private readonly List<RouteDefinition> _routes = new List<RouteDefinition>();
-
     public IMapper ResourceMaps;
-
     public Type ContextType { get; set; }
 
+    private readonly List<RouteDefinition> _routes = new List<RouteDefinition>();
+
     public void SetDefaultNamespace(string ns)
     {
       Namespace = ns;

JsonApiDotNetCore/JsonApi/DocumentBuilder.cs

@@ -0,0 +1,35 @@
+using System.Collections.Generic;
+
+namespace JsonApiDotNetCore.JsonApi
+{
+  public static class DocumentBuilder
+  {
+    public static Dictionary<string, string> BuildSelfLink(string protocol, string host, string nameSpace, string modelRouteName, string resourceId)
+    {
+      var id = resourceId != null ? $"/{resourceId}" : string.Empty;
+      return new Dictionary<string, string>
+      {
+        {
+          "self", $"{protocol}://{host}/{nameSpace}/{modelRouteName}{id}"
+        }
+      };
+    }
+    public static Dictionary<string, string> BuildSelfLink(string nameSpace, string modelRouteName)
+    {
+      return new Dictionary<string, string>
+      {
+        {
+          "self", $"/{nameSpace}/{modelRouteName}"
+        }
+      };
+    }
+    public static Dictionary<string, string> BuildRelationshipLinks(string protocol, string host, string nameSpace, string modelRouteName, string resourceId, string relationshipName)
+    {
+      return new Dictionary<string, string>
+      {
+        {"self", $"{protocol}://{host}/{nameSpace}/{modelRouteName}/{resourceId}/relationships/{relationshipName}"},
+        {"related", $"{protocol}://{host}/{nameSpace}/{modelRouteName}/{resourceId}/{relationshipName}"}
+      };
+    }
+  }
+}

JsonApiDotNetCore/Routing/RouteBuilder.cs

@@ -15,6 +15,7 @@
 using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.JsonApi;
 using JsonApiDotNetCore.Routing;
+using Microsoft.EntityFrameworkCore;
 
 namespace JsonApiDotNetCore.Services
 {
@@ -121,7 +122,8 @@ private JsonApiDatum ResourceToJsonApiDatum(JsonApiContext context, IJsonApiReso
         Type = context.Route.RouteDefinition.ContextPropertyName.ToCamelCase(),
         Id = resource.Id,
         Attributes = GetAttributesFromResource(resource),
-        Links = GetJsonApiDatumLinks(context, resource)
+        Links = GetJsonApiDatumLinks(context, resource),
+        Relationships = BuildRelationshipsObject(context, resource)
       };
     }
 
@@ -147,28 +149,33 @@ private Dictionary<string, string> GetJsonApiDocumentLinks(JsonApiContext jsonAp
       var request = jsonApiContext.HttpContext.Request;
       var route = jsonApiContext.Route;
 
-      var links = new Dictionary<string, string>
-      {
-        {
-          "self",
-          RouteBuilder.BuildRoute(request.Scheme, request.Host.ToString(), _jsonApiModelConfiguration.Namespace,
-            route.RouteDefinition.ContextPropertyName.ToCamelCase(), route.ResourceId)
-        }
-      };
-      return links;
+      return DocumentBuilder.BuildSelfLink(request.Scheme, request.Host.ToString(), _jsonApiModelConfiguration.Namespace,
+        route.RouteDefinition.ContextPropertyName.ToCamelCase(), route.ResourceId);
     }
 
     private Dictionary<string, string> GetJsonApiDatumLinks(JsonApiContext jsonApiContext, IJsonApiResource resource)
     {
-      var links = new Dictionary<string, string>
-      {
+      return DocumentBuilder.BuildSelfLink(jsonApiContext.HttpContext.Request.Scheme,
+        jsonApiContext.HttpContext.Request.Host.ToString(), _jsonApiModelConfiguration.Namespace,
+        jsonApiContext.Route.RouteDefinition.ContextPropertyName.ToCamelCase(), resource.Id);
+    }
+
+    private Dictionary<string, object> BuildRelationshipsObject(JsonApiContext jsonApiContext, IJsonApiResource resource)
+    {
+      var relationships = new Dictionary<string, object>();
+      jsonApiContext.Route.Model.GetProperties().Where(propertyInfo => propertyInfo.GetMethod.IsVirtual).ToList().ForEach(
+        virtualProperty =>
         {
-          "self",
-          RouteBuilder.BuildRoute(jsonApiContext.HttpContext.Request.Scheme, jsonApiContext.HttpContext.Request.Host.ToString(), _jsonApiModelConfiguration.Namespace,
-            jsonApiContext.Route.RouteDefinition.ContextPropertyName.ToCamelCase(), resource.Id)
-        }
-      };
-      return links;
+          relationships.Add(virtualProperty.Name, GetRelationshipLinks(jsonApiContext, resource, virtualProperty.Name));
+        });
+      return relationships;
+    }
+
+    private Dictionary<string, string> GetRelationshipLinks(JsonApiContext jsonApiContext, IJsonApiResource resource, string relationshipName)
+    {
+      return DocumentBuilder.BuildRelationshipLinks(jsonApiContext.HttpContext.Request.Scheme,
+        jsonApiContext.HttpContext.Request.Host.ToString(), _jsonApiModelConfiguration.Namespace,
+        jsonApiContext.Route.RouteDefinition.ContextPropertyName.ToCamelCase(), resource.Id, relationshipName);
     }
   }
 }