refactor to streamline API surface

Author: Chris Santero

JSONAPI.EntityFramework.Tests.TestWebApp/Startup.cs

@@ -1,17 +1,11 @@
 using System;
-using System.Collections.Generic;
 using System.Reflection;
 using System.Web;
 using System.Web.Http;
-using System.Web.Http.Dispatcher;
 using Autofac;
 using Autofac.Integration.WebApi;
-using JSONAPI.ActionFilters;
 using JSONAPI.Core;
-using JSONAPI.EntityFramework.ActionFilters;
 using JSONAPI.EntityFramework.Tests.TestWebApp.Models;
-using JSONAPI.Http;
-using JSONAPI.Json;
 using Microsoft.Owin;
 using Owin;
 
@@ -62,27 +56,21 @@ public void Configuration(IAppBuilder app)
 
         private static HttpConfiguration GetWebApiConfiguration()
         {
-            var config = new HttpConfiguration();
-
             var pluralizationService = new PluralizationService();
-            var modelManager = new ModelManager(pluralizationService);
 
-            var formatter = new JsonApiFormatter(modelManager);
-            config.Formatters.Clear();
-            config.Formatters.Add(formatter);
+            var httpConfig = new HttpConfiguration();
 
-            // Global filters
-            config.Filters.Add(new EnumerateQueryableAsyncAttribute());
-            config.Filters.Add(new EnableSortingAttribute(modelManager));
-            config.Filters.Add(new EnableFilteringAttribute(modelManager));
+            // Configure JSON API
+            new JsonApiConfiguration()
+                .PluralizeResourceTypesWith(pluralizationService)
+                .UseEntityFramework()
+                .Apply(httpConfig);
 
-            // Override controller selector
-            config.Services.Replace(typeof(IHttpControllerSelector), new PascalizedControllerSelector(config));
 
             // Web API routes
-            config.Routes.MapHttpRoute("DefaultApi", "{controller}/{id}", new { id = RouteParameter.Optional });
+            httpConfig.Routes.MapHttpRoute("DefaultApi", "{controller}/{id}", new { id = RouteParameter.Optional });
 
-            return config;
+            return httpConfig;
         }
     }
 }

JSONAPI.EntityFramework/ActionFilters/EnumerateQueryableAsyncAttribute.cs

@@ -9,7 +9,7 @@
 
 namespace JSONAPI.EntityFramework.ActionFilters
 {
-    public class EnumerateQueryableAsyncAttribute : ActionFilterAttribute
+    internal class EnumerateQueryableAsyncAttribute : ActionFilterAttribute
     {
         private readonly Lazy<MethodInfo> _toArrayAsyncMethod = new Lazy<MethodInfo>(() =>
                typeof(QueryableExtensions).GetMethods().FirstOrDefault(x => x.Name == "ToArrayAsync" && x.GetParameters().Count() == 2));

JSONAPI.EntityFramework/JSONAPI.EntityFramework.csproj

@@ -38,6 +38,10 @@
     <DocumentationFile>bin\Release\JSONAPI.EntityFramework.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Autofac, Version=3.5.0.0, Culture=neutral, PublicKeyToken=17863af14b0044da, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\packages\Autofac.3.5.2\lib\net40\Autofac.dll</HintPath>
+    </Reference>
     <Reference Include="EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\packages\EntityFramework.6.1.2\lib\net45\EntityFramework.dll</HintPath>
@@ -74,6 +78,7 @@
     <Compile Include="EntityFrameworkMaterializer.cs" />
     <Compile Include="EntityFrameworkMaterializer_Util.cs" />
     <Compile Include="Http\ApiController.cs" />
+    <Compile Include="JsonApiConfigurationExtensions.cs" />
     <Compile Include="PluralizationService.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>

JSONAPI.EntityFramework/JsonApiConfigurationExtensions.cs

@@ -0,0 +1,25 @@
+using System.Web.Http.Filters;
+using Autofac;
+using JSONAPI.Core;
+using JSONAPI.EntityFramework.ActionFilters;
+
+namespace JSONAPI.EntityFramework
+{
+    /// <summary>
+    /// Extension Methods for JSONAPI.JsonApiConfiguration
+    /// </summary>
+    public static class JsonApiConfigurationExtensions
+    {
+        /// <summary>
+        /// Add Entity Framework specific handling to the configuration
+        /// </summary>
+        /// <param name="jsonApiConfig">The configuration object to modify</param>
+        /// <returns>The same configuration object that was passed in</returns>
+        public static JsonApiConfiguration UseEntityFramework(this JsonApiConfiguration jsonApiConfig)
+        {
+            jsonApiConfig.Builder.RegisterType<EnumerateQueryableAsyncAttribute>().As<IActionFilter>();
+
+            return jsonApiConfig;
+        }
+    }
+}

JSONAPI.EntityFramework/packages.config

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
+  <package id="Autofac" version="3.5.2" targetFramework="net45" />
   <package id="EntityFramework" version="6.1.2" targetFramework="net45" />
   <package id="Microsoft.AspNet.WebApi.Client" version="5.2.2" targetFramework="net45" />
   <package id="Microsoft.AspNet.WebApi.Core" version="5.2.2" targetFramework="net45" />