Merge pull request #478 from wisepotato/feat/#477

Resource hooks

Author: maurei

JsonApiDotnetCore.sln

@@ -1,4 +1,3 @@
-
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 16
 VisualStudioVersion = 16.0.28606.126

README.md

@@ -91,12 +91,7 @@ Running tests locally requires access to a postgresql database.
 If you have docker installed, this can be propped up via: 
 
 ```bash
-docker run --rm --name jsonapi-dotnet-core-testing \
-  -e POSTGRES_DB=JsonApiDotNetCoreExample \
-  -e POSTGRES_USER=postgres \
-  -e POSTGRES_PASSWORD=postgres \
-  -p 5432:5432 \
-  postgres
+docker run --rm --name jsonapi-dotnet-core-testing  -e POSTGRES_DB=JsonApiDotNetCoreExample -e POSTGRES_USER=postgres  -e POSTGRES_PASSWORD=postgres   -p 5432:5432   postgres
 ```
 
 And then to run the tests:

docs/usage/extensibility/services.md

@@ -17,15 +17,15 @@ public class TodoItemService : EntityResourceService<TodoItem>
 
     public TodoItemService(
         IJsonApiContext jsonApiContext,
-        IEntityRepository<T, TId> repository,
+        IEntityRepository<TodoItem, int> repository,
         ILoggerFactory loggerFactory,
         INotificationService notificationService) 
     : base(jsonApiContext, repository, loggerFactory)
     {
         _notificationService = notificationService;
     }
 
-    public override async Task<TEntity> CreateAsync(TEntity entity)
+    public override async Task<TodoItem> CreateAsync(TodoItem entity)
     {
         // call the base implementation which uses Entity Framework
         var newEntity = await base.CreateAsync(entity);

docs/usage/resources/hooks.md

@@ -0,0 +1,23 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:56042/",
+      "sslPort": 0
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "GettingStarted": {
+      "commandName": "Project",
+      "launchBrowser": true
+    }
+  }
+}

src/Examples/GettingStarted/Properties/launchSettings.json

@@ -1,10 +1,15 @@
 using System.Collections.Generic;
+using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Models;
 
 namespace GettingStarted.ResourceDefinitionExample
 {
     public class ModelDefinition : ResourceDefinition<Model>
     {
+        public ModelDefinition(IResourceGraph graph) : base(graph)
+        {
+        }
+
         // this allows POST / PATCH requests to set the value of a
         // property, but we don't include this value in the response
         // this might be used if the incoming value gets hashed or

src/Examples/GettingStarted/ResourceDefinitionExample/ModelDefinition.cs

@@ -0,0 +1,15 @@
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+using JsonApiDotNetCoreExample.Models;
+
+namespace JsonApiDotNetCoreExample.Controllers
+{
+    public class PassportsController : JsonApiController<Passport>
+    {
+        public PassportsController(
+            IJsonApiContext jsonApiContext,
+            IResourceService<Passport> resourceService) 
+            : base(jsonApiContext, resourceService)
+        { }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Controllers/PassportsController.cs

@@ -41,33 +41,60 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             modelBuilder.Entity<ArticleTag>()
                 .HasKey(bc => new { bc.ArticleId, bc.TagId });
 
+            modelBuilder.Entity<IdentifiableArticleTag>()
+                .HasKey(bc => new { bc.ArticleId, bc.TagId });
+
+            modelBuilder.Entity<Person>()
+                .HasOne(t => t.StakeHolderTodo)
+                .WithMany(t => t.StakeHolders)
+                .HasForeignKey(t => t.StakeHolderTodoId)
+                .OnDelete(DeleteBehavior.Cascade);
 
             modelBuilder.Entity<TodoItem>()
                 .HasOne(t => t.DependentTodoItem);
-
+                
             modelBuilder.Entity<TodoItem>()
                 .HasMany(t => t.ChildrenTodoItems)
                 .WithOne(t => t.ParentTodoItem)
                 .HasForeignKey(t => t.ParentTodoItemId);
 
+            modelBuilder.Entity<Person>()
+                .HasOne(p => p.Passport)
+                .WithOne(p => p.Person)
+                .HasForeignKey<Person>(p => p.PassportId);
+
+            modelBuilder.Entity<Passport>()
+                .HasOne(p => p.Person)
+                .WithOne(p => p.Passport)
+                .HasForeignKey<Person>(p => p.PassportId);
 
+            modelBuilder.Entity<TodoItem>()
+                .HasOne(p => p.ToOnePerson)
+                .WithOne(p => p.ToOneTodoItem)
+                .HasForeignKey<TodoItem>(p => p.ToOnePersonId);
+
+            modelBuilder.Entity<Person>()
+                .HasOne(p => p.ToOneTodoItem)
+                .WithOne(p => p.ToOnePerson)
+                .HasForeignKey<TodoItem>(p => p.ToOnePersonId);
         }
 
         public DbSet<TodoItem> TodoItems { get; set; }
+        public DbSet<Passport> Passports { get; set; }
         public DbSet<Person> People { get; set; }
         public DbSet<TodoItemCollection> TodoItemCollections { get; set; }
         public DbSet<CamelCasedModel> CamelCasedModels { get; set; }
         public DbSet<Article> Articles { get; set; }
         public DbSet<Author> Authors { get; set; }
         public DbSet<NonJsonApiResource> NonJsonApiResources { get; set; }
         public DbSet<User> Users { get; set; }
-
         public DbSet<CourseEntity> Courses { get; set; }
         public DbSet<DepartmentEntity> Departments { get; set; }
         public DbSet<CourseStudentEntity> Registrations { get; set; }
         public DbSet<StudentEntity> Students { get; set; }
         public DbSet<PersonRole> PersonRoles { get; set; }
         public DbSet<ArticleTag> ArticleTags { get; set; }
+        public DbSet<IdentifiableArticleTag> IdentifiableArticleTags { get; set; }
         public DbSet<Tag> Tags { get; set; }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs

@@ -17,5 +17,11 @@ public class Article : Identifiable
         [HasManyThrough(nameof(ArticleTags))]
         public List<Tag> Tags { get; set; }
         public List<ArticleTag> ArticleTags { get; set; }
+
+
+        [NotMapped]
+        [HasManyThrough(nameof(IdentifiableArticleTags))]
+        public List<Tag> IdentifiableTags { get; set; }
+        public List<IdentifiableArticleTag> IdentifiableArticleTags { get; set; }
     }
 }

src/Examples/JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj

@@ -1,3 +1,5 @@
+using JsonApiDotNetCore.Models;
+
 namespace JsonApiDotNetCoreExample.Models
 {
     public class ArticleTag
@@ -8,4 +10,18 @@ public class ArticleTag
         public int TagId { get; set; }
         public Tag Tag { get; set; }
     }
+
+
+    public class IdentifiableArticleTag : Identifiable
+    {
+        public int ArticleId { get; set; }
+        [HasOne("article")]
+        public Article Article { get; set; }
+
+        public int TagId { get; set; }
+        [HasOne("Tag")]
+        public Tag Tag { get; set; }
+
+        public string SomeMetaData { get; set; }
+    }
 }

src/Examples/JsonApiDotNetCoreExample/Models/Article.cs

@@ -12,3 +12,4 @@ public class Author : Identifiable
         public List<Article> Articles { get; set; }
     }
 }
+

src/Examples/JsonApiDotNetCoreExample/Models/ArticleTag.cs

@@ -0,0 +1,7 @@
+namespace JsonApiDotNetCoreExample.Models
+{
+    public interface IIsLockable
+    {
+        bool IsLocked { get; set; }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Models/Author.cs

@@ -5,6 +5,8 @@ namespace JsonApiDotNetCoreExample.Models
     public class Passport : Identifiable
     {
         public virtual int? SocialSecurityNumber { get; set; }
+        public virtual bool IsLocked { get; set; } 
+
         [HasOne("person")]
         public virtual Person Person { get; set; }
     }

src/Examples/JsonApiDotNetCoreExample/Models/IIsLockable.cs

@@ -11,8 +11,10 @@ public class PersonRole : Identifiable
         public Person Person { get; set; }
     }
 
-    public class Person : Identifiable, IHasMeta
+    public class Person : Identifiable, IHasMeta, IIsLockable
     {
+        public bool IsLocked { get; set; }
+
         [Attr("first-name")]
         public string FirstName { get; set; }
 
@@ -32,22 +34,32 @@ public class Person : Identifiable, IHasMeta
         public virtual List<TodoItemCollection> TodoItemCollections { get; set; }
 
         [HasOne("role")]
-        public virtual PersonRole Role { get; set; }
+        public virtual PersonRole Role { get; set; } 
         public int? PersonRoleId { get; set; }
 
+        [HasOne("one-to-one-todo-item")]
+        public virtual TodoItem ToOneTodoItem { get; set; }
+
+
+        [HasOne("stake-holder-todo-item")]
+        public virtual TodoItem StakeHolderTodo { get; set; }
+        public virtual int? StakeHolderTodoId { get; set; }
+
         [HasOne("unincludeable-item", documentLinks: Link.All, canInclude: false)]
         public virtual TodoItem UnIncludeableItem { get; set; }
 
+        public int? PassportId { get; set; }
+
+        [HasOne("passport")]
+        public virtual Passport Passport { get; set; }
+
         public Dictionary<string, object> GetMeta(IJsonApiContext context)
         {
             return new Dictionary<string, object> {
                 { "copyright", "Copyright 2015 Example Corp." },
                 { "authors", new string[] { "Jared Nance" } }
             };
         }
-        public int? PassportId { get; set; }
-        [HasOne("passport")]
-        public virtual Passport Passport { get; set; }
 
     }
 }

src/Examples/JsonApiDotNetCoreExample/Models/Passport.cs

@@ -4,13 +4,15 @@
 
 namespace JsonApiDotNetCoreExample.Models
 {
-    public class TodoItem : Identifiable
+    public class TodoItem : Identifiable, IIsLockable
     {
         public TodoItem()
         {
             GuidProperty = Guid.NewGuid();
         }
 
+        public bool IsLocked { get; set; }
+
         [Attr("description")]
         public string Description { get; set; }
 
@@ -48,17 +50,25 @@ public string CalculatedValue
         [HasOne("assignee")]
         public virtual Person Assignee { get; set; }
 
+        [HasOne("one-to-one-person")]
+        public virtual Person ToOnePerson { get; set; }
+        public virtual int? ToOnePersonId { get; set; }
+
+
+        [HasMany("stake-holders")]
+        public virtual List<Person> StakeHolders { get; set; }
+
         [HasOne("collection")]
         public virtual TodoItemCollection Collection { get; set; }
 
+
+        // cyclical to-one structure
         public virtual int? DependentTodoItemId { get; set; }
         [HasOne("dependent-on-todo")]
         public virtual TodoItem DependentTodoItem { get; set; }
 
 
-
-
-        // cyclical structure
+        // cyclical to-many structure
         public virtual int? ParentTodoItemId {get; set;}
         [HasOne("parent-todo")]
         public virtual TodoItem ParentTodoItem { get; set; }

src/Examples/JsonApiDotNetCoreExample/Models/Person.cs

@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+using System.Linq;
+using System;
+using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Models;
+using JsonApiDotNetCore.Hooks;
+using JsonApiDotNetCoreExample.Models;
+using Microsoft.Extensions.Logging;
+using System.Security.Principal;
+
+namespace JsonApiDotNetCoreExample.Resources
+{
+    public class ArticleResource : ResourceDefinition<Article>
+    {
+        public ArticleResource(IResourceGraph graph) : base(graph) { }
+
+        public override IEnumerable<Article> OnReturn(HashSet<Article> entities, ResourcePipeline pipeline)
+        {
+            if (pipeline == ResourcePipeline.GetSingle && entities.Single().Name == "Classified")
+            {
+                throw new JsonApiException(403, "You are not allowed to see this article!", new UnauthorizedAccessException());
+            }
+            return entities.Where(t => t.Name != "This should be not be included");
+        }
+    }
+}
+

src/Examples/JsonApiDotNetCoreExample/Models/TodoItem.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Models;
+using JsonApiDotNetCoreExample.Models;
+
+namespace JsonApiDotNetCoreExample.Resources
+{
+    public abstract class LockableResourceBase<T> : ResourceDefinition<T> where T : class, IIsLockable, IIdentifiable
+    {
+        protected LockableResourceBase(IResourceGraph graph) : base(graph) { }
+
+        protected void DisallowLocked(IEnumerable<T> entities)
+        {
+            foreach (var e in entities ?? Enumerable.Empty<T>())
+            {
+                if (e.IsLocked)
+                {
+                    throw new JsonApiException(403, "Not allowed to update fields or relations of locked todo item", new UnauthorizedAccessException());
+                }
+            }
+        }
+    }
+}