Add example projects and tests

JsonApiDotNetCore.MongoDb.sln

@@ -3,9 +3,17 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.26124.0
 MinimumVisualStudioVersion = 15.0.26124.0
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{DDAB9F03-9137-4BA5-9932-96C006C88583}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{7E29AA10-F938-4CF8-9CAB-7ACD2D6DC784}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JsonApiDotNetCore.MongoDb", "src\JsonApiDotNetCore.MongoDb\JsonApiDotNetCore.MongoDb.csproj", "{E8C38068-3E3E-477D-A09A-D536D662FC1C}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JsonApiDotNetCore.MongoDb.GettingStarted", "src\JsonApiDotNetCore.MongoDb.GettingStarted\JsonApiDotNetCore.MongoDb.GettingStarted.csproj", "{600A3E66-E63F-427D-A991-4CD2067041F9}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JsonApiDotNetCore.MongoDb", "src\JsonApiDotNetCore.MongoDb\JsonApiDotNetCore.MongoDb.csproj", "{FD312677-2A62-4B8F-A965-879B059F1755}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{19A533AA-E006-496D-A476-364DF2B637A1}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JsonApiDotNetCore.MongoDb.Example.Tests", "test\JsonApiDotNetCore.MongoDb.Example.Tests\JsonApiDotNetCore.MongoDb.Example.Tests.csproj", "{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JsonApiDotNetCore.MongoDb.Example", "src\JsonApiDotNetCore.MongoDb.Example\JsonApiDotNetCore.MongoDb.Example.csproj", "{743C32A5-2584-4FA0-987B-B4E97CDAADE8}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -20,20 +28,59 @@ Global
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Debug|x64.Build.0 = Debug|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Debug|x86.Build.0 = Debug|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Release|Any CPU.Build.0 = Release|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Release|x64.ActiveCfg = Release|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Release|x64.Build.0 = Release|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Release|x86.ActiveCfg = Release|Any CPU
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C}.Release|x86.Build.0 = Release|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Debug|x64.Build.0 = Debug|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Debug|x86.Build.0 = Debug|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Release|x64.ActiveCfg = Release|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Release|x64.Build.0 = Release|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Release|x86.ActiveCfg = Release|Any CPU
+		{600A3E66-E63F-427D-A991-4CD2067041F9}.Release|x86.Build.0 = Release|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Debug|x64.Build.0 = Debug|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Debug|x86.Build.0 = Debug|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Release|x64.ActiveCfg = Release|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Release|x64.Build.0 = Release|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Release|x86.ActiveCfg = Release|Any CPU
+		{FD312677-2A62-4B8F-A965-879B059F1755}.Release|x86.Build.0 = Release|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Debug|x64.Build.0 = Debug|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Debug|x86.Build.0 = Debug|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Release|x64.ActiveCfg = Release|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Release|x64.Build.0 = Release|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Release|x86.ActiveCfg = Release|Any CPU
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1}.Release|x86.Build.0 = Release|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Debug|x64.Build.0 = Debug|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Debug|x86.Build.0 = Debug|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Release|x64.ActiveCfg = Release|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Release|x64.Build.0 = Release|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Release|x86.ActiveCfg = Release|Any CPU
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
-		{E8C38068-3E3E-477D-A09A-D536D662FC1C} = {DDAB9F03-9137-4BA5-9932-96C006C88583}
+		{600A3E66-E63F-427D-A991-4CD2067041F9} = {7E29AA10-F938-4CF8-9CAB-7ACD2D6DC784}
+		{FD312677-2A62-4B8F-A965-879B059F1755} = {7E29AA10-F938-4CF8-9CAB-7ACD2D6DC784}
+		{24CE53FA-9C49-4E20-A060-4A43DFB8C8F1} = {19A533AA-E006-496D-A476-364DF2B637A1}
+		{743C32A5-2584-4FA0-987B-B4E97CDAADE8} = {7E29AA10-F938-4CF8-9CAB-7ACD2D6DC784}
 	EndGlobalSection
 EndGlobal

README.md

@@ -71,6 +71,35 @@ public class Startup
 }
 ```
 
+
+## Development
+
+Restore all NuGet packages with:
+
+```bash
+dotnet restore
+```
+
+### Testing
+
+You don't need to have a running instance of MongoDB on your machine. To run the tests just type the following command in your terminal:
+
+```bash
+dotnet test
+```
+
+If you want to run the examples and explore them on your own **you are** going to need that running instance of MongoDB. If you have docker installed you can launch it like this:
+
+```bash
+docker run -p 27017:27017 -d mongo:latest
+```
+
+And then to run the API:
+
+```bash
+dotnet run
+```
+
 ## Limitations
 
 - Relationships are not supported

src/JsonApiDotNetCore.MongoDb.Example/Controllers/ArticlesController.cs

@@ -0,0 +1,18 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Controllers
+{
+    public sealed class ArticlesController : JsonApiController<Article, string>
+    {
+        public ArticlesController(
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceService<Article, string> resourceService)
+            : base(options, loggerFactory, resourceService)
+        { }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Controllers/AuthorsController.cs

@@ -0,0 +1,18 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Controllers
+{
+    public sealed class AuthorsController : JsonApiController<Author, string>
+    {
+        public AuthorsController(
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceService<Author, string> resourceService)
+            : base(options, loggerFactory, resourceService)
+        { }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Controllers/BlogsController.cs

@@ -0,0 +1,18 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Controllers
+{
+    public sealed class BlogsController : JsonApiController<Blog, string>
+    {
+        public BlogsController(
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceService<Blog, string> resourceService)
+            : base(options, loggerFactory, resourceService)
+        { }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Controllers/PeopleController.cs

@@ -0,0 +1,18 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Controllers
+{
+    public sealed class PeopleController : JsonApiController<Person, string>
+    {
+        public PeopleController(
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceService<Person, string> resourceService)
+            : base(options, loggerFactory, resourceService)
+        { }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Controllers/TodoItemsController.cs

@@ -0,0 +1,18 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Controllers
+{
+    public sealed class TodoItemsController : JsonApiController<TodoItem, string>
+    {
+        public TodoItemsController(
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceService<TodoItem, string> resourceService)
+            : base(options, loggerFactory, resourceService)
+        { }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Controllers/UsersController.cs

@@ -0,0 +1,18 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Controllers
+{
+    public sealed class UsersController : JsonApiController<User, string>
+    {
+        public UsersController(
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceService<User, string> resourceService)
+            : base(options, loggerFactory, resourceService)
+        { }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Definitions/ArticleHooksDefinition.cs

@@ -0,0 +1,31 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Errors;
+using JsonApiDotNetCore.Hooks.Internal.Execution;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Serialization.Objects;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Definitions
+{
+    public class ArticleHooksDefinition : ResourceHooksDefinition<Article>
+    {
+        public ArticleHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph) { }
+
+        public override IEnumerable<Article> OnReturn(HashSet<Article> resources, ResourcePipeline pipeline)
+        {
+            if (pipeline == ResourcePipeline.GetSingle && resources.Any(r => r.Caption == "Classified"))
+            {
+                throw new JsonApiException(new Error(HttpStatusCode.Forbidden)
+                {
+                    Title = "You are not allowed to see this article."
+                });
+            }
+
+            return resources.Where(t => t.Caption != "This should not be included");
+        }
+    }
+}
+

src/JsonApiDotNetCore.MongoDb.Example/Definitions/LockableHooksDefinition.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Errors;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Serialization.Objects;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Definitions
+{
+    public abstract class LockableHooksDefinition<T> : ResourceHooksDefinition<T> where T : class, IIsLockable, IIdentifiable
+    {
+        protected LockableHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph) { }
+
+        protected void DisallowLocked(IEnumerable<T> resources)
+        {
+            foreach (var e in resources ?? Enumerable.Empty<T>())
+            {
+                if (e.IsLocked)
+                {
+                    throw new JsonApiException(new Error(HttpStatusCode.Forbidden)
+                    {
+                        Title = "You are not allowed to update fields or relationships of locked todo items."
+                    });
+                }
+            }
+        }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Definitions/TodoHooksDefinition.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Errors;
+using JsonApiDotNetCore.Hooks.Internal.Execution;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Serialization.Objects;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Definitions
+{
+    public class TodoHooksDefinition : LockableHooksDefinition<TodoItem>
+    {
+        public TodoHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph) { }
+
+        public override void BeforeRead(ResourcePipeline pipeline, bool isIncluded = false, string stringId = null)
+        {
+            if (stringId == "1337")
+            {
+                throw new JsonApiException(new Error(HttpStatusCode.Forbidden)
+                {
+                    Title = "You are not allowed to update the author of todo items."
+                });
+            }
+        }
+
+        public override void BeforeImplicitUpdateRelationship(IRelationshipsDictionary<TodoItem> resourcesByRelationship, ResourcePipeline pipeline)
+        {
+            List<TodoItem> todos = resourcesByRelationship.GetByRelationship<Person>().SelectMany(kvp => kvp.Value).ToList();
+            DisallowLocked(todos);
+        }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Definitions/TodoItemDefinition.cs

@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.MongoDb.Example.Models;
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.MongoDb.Example.Definitions
+{
+    public sealed class TodoItemDefinition : JsonApiResourceDefinition<TodoItem, string>
+    {
+        public TodoItemDefinition(IResourceGraph resourceGraph) : base(resourceGraph)
+        {
+        }
+
+        public override IDictionary<string, object> GetMeta(TodoItem resource)
+        {
+            if (resource.Description != null && resource.Description.StartsWith("Important:"))
+            {
+                return new Dictionary<string, object>
+                {
+                    ["hasHighPriority"] = true
+                };
+            }
+
+            return base.GetMeta(resource);
+        }
+    }
+}

src/JsonApiDotNetCore.MongoDb.Example/Dockerfile

@@ -0,0 +1,13 @@
+FROM microsoft/dotnet:latest
+
+COPY . /app
+
+WORKDIR /app
+
+RUN ["dotnet", "restore"]
+
+RUN ["dotnet", "build"]
+
+EXPOSE 14140/tcp
+
+CMD ["dotnet", "run", "--server.urls", "http://*:14140"]

src/JsonApiDotNetCore.MongoDb.Example/JsonApiDotNetCore.MongoDb.Example.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+  <PropertyGroup>
+    <TargetFramework>$(NetCoreAppVersion)</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="JsonApiDotNetCore" Version="$(JsonApiDotNetCoreVersion)" />
+    <PackageReference Include="MongoDB.Driver" Version="$(MongoDBDriverVersion)" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\JsonApiDotNetCore.MongoDb\JsonApiDotNetCore.MongoDb.csproj" />
+  </ItemGroup>
+</Project>