Merge pull request #46 from Research-Institute/staging

v1.0.0

Author: jaredcnance

.travis.yml

@@ -10,5 +10,6 @@ dotnet: 1.0.0-preview2-1-003177
 branches:
   only:
     - master
+    - staging
 script:
-  - ./build.sh
+  - ./build.sh

README.md

@@ -76,8 +76,24 @@ Your models should inherit `Identifiable<TId>` where `TId` is the type of the pr
 
 ```csharp
 public class Person : Identifiable<Guid>
-{
-    public override Guid Id { get; set; }
+{ }
+```
+
+You can use the non-generic `Identifiable` if your primary key is an integer:
+
+```csharp
+public class Person : Identifiable
+{ }
+```
+
+If you need to hang annotations or attributes on the `Id` property, you can override the virtual member:
+
+```csharp
+public class Person : Identifiable
+{ 
+    [Key]
+    [Column("person_id")]
+    public override int Id { get; set; }
 }
 ```
 
@@ -89,8 +105,6 @@ add the `AttrAttribute` and provide the outbound name.
 ```csharp
 public class Person : Identifiable<int>
 {
-    public override int Id { get; set; }
-    
     [Attr("first-name")]
     public string FirstName { get; set; }
 }
@@ -99,16 +113,15 @@ public class Person : Identifiable<int>
 #### Relationships
 
 In order for navigation properties to be identified in the model, 
-they should be labeled as virtual.
+they should be labeled with the appropriate attribute (either `HasOne` or `HasMany`).
 
 ```csharp
 public class Person : Identifiable<int>
 {
-    public override int Id { get; set; }
-    
     [Attr("first-name")]
     public string FirstName { get; set; }
 
+    [HasMany("todo-items")]
     public virtual List<TodoItem> TodoItems { get; set; }
 }
 ```
@@ -119,12 +132,12 @@ For example, a `TodoItem` may have an `Owner` and so the Id attribute should be
 ```csharp
 public class TodoItem : Identifiable<int>
 {
-    public override int Id { get; set; }
-    
     [Attr("description")]
     public string Description { get; set; }
 
     public int OwnerId { get; set; }
+
+    [HasOne("owner")]
     public virtual Person Owner { get; set; }
 }
 ```
@@ -224,6 +237,9 @@ public class MyAuthorizedEntityRepository : DefaultEntityRepository<MyEntity>
 }
 ```
 
+For more examples, take a look at the customization tests 
+in `./test/JsonApiDotNetCoreExampleTests/Acceptance/Extensibility`.
+
 ### Pagination
 
 Resources can be paginated. 
@@ -272,6 +288,7 @@ identifier):
 ?filter[attribute]=gt:value
 ?filter[attribute]=le:value
 ?filter[attribute]=ge:value
+?filter[attribute]=like:value
 ```
 
 ### Sorting

appveyor.yml

@@ -4,6 +4,7 @@ pull_requests:
 branches:
   only:
   - master
+  - staging
 nuget:
   disable_publish_on_pr: true
 build_script:
@@ -19,7 +20,7 @@ deploy:
     secure: 6CeYcZ4Ze+57gxfeuHzqP6ldbUkPtF6pfpVM1Gw/K2jExFrAz763gNAQ++tiacq3
   skip_symbols: true
   on:
-    branch: master
+    branch: staging
 - provider: NuGet
   name: production
   api_key:

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -26,7 +26,8 @@ public Document Build(IIdentifiable entity)
             var document = new Document
             {
                 Data = _getData(contextEntity, entity),
-                Meta = _getMeta(entity)
+                Meta = _getMeta(entity),
+                Links = _jsonApiContext.PageManager.GetPageLinks(new LinkBuilder(_jsonApiContext))
             };
 
             document.Included = _appendIncludedObject(document.Included, contextEntity, entity);
@@ -45,7 +46,8 @@ public Documents Build(IEnumerable<IIdentifiable> entities)
             var documents = new Documents
             {
                 Data = new List<DocumentData>(),
-                Meta = _getMeta(entities.FirstOrDefault())
+                Meta = _getMeta(entities.FirstOrDefault()),
+                Links = _jsonApiContext.PageManager.GetPageLinks(new LinkBuilder(_jsonApiContext))
             };
 
             foreach (var entity in entities)
@@ -68,7 +70,7 @@ private Dictionary<string, object> _getMeta(IIdentifiable entity)
                 meta = metaEntity.GetMeta(_jsonApiContext);
 
             if(_jsonApiContext.Options.IncludeTotalRecordCount)
-                meta["total-records"] = _jsonApiContext.TotalRecords;
+                meta["total-records"] = _jsonApiContext.PageManager.TotalRecords;
 
             if(meta.Count > 0) return meta;
             return null;
@@ -122,23 +124,25 @@ private void _addRelationships(DocumentData data, ContextEntity contextEntity, I
                 {
                     Links = new Links
                     {
-                        Self = linkBuilder.GetSelfRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.RelationshipName),
-                        Related = linkBuilder.GetRelatedRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.RelationshipName)
+                        Self = linkBuilder.GetSelfRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.InternalRelationshipName),
+                        Related = linkBuilder.GetRelatedRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.InternalRelationshipName)
                     }
                 };
 
-                if (_relationshipIsIncluded(r.RelationshipName))
+                if (_relationshipIsIncluded(r.InternalRelationshipName))
                 {
                     var navigationEntity = _jsonApiContext.ContextGraph
-                        .GetRelationship(entity, r.RelationshipName);
+                        .GetRelationship(entity, r.InternalRelationshipName);
 
-                    if (navigationEntity is IEnumerable)
-                        relationshipData.ManyData = _getRelationships((IEnumerable<object>)navigationEntity, r.RelationshipName);
+                    if(navigationEntity == null)
+                        relationshipData.SingleData = null;
+                    else if (navigationEntity is IEnumerable)
+                        relationshipData.ManyData = _getRelationships((IEnumerable<object>)navigationEntity, r.InternalRelationshipName);
                     else
-                        relationshipData.SingleData = _getRelationship(navigationEntity, r.RelationshipName);
+                        relationshipData.SingleData = _getRelationship(navigationEntity, r.InternalRelationshipName);
                 }
 
-                data.Relationships.Add(r.RelationshipName.Dasherize(), relationshipData);
+                data.Relationships.Add(r.InternalRelationshipName.Dasherize(), relationshipData);
             });
         }
 
@@ -148,9 +152,9 @@ private List<DocumentData> _getIncludedEntities(ContextEntity contextEntity, IId
 
             contextEntity.Relationships.ForEach(r =>
             {
-                if (!_relationshipIsIncluded(r.RelationshipName)) return;
+                if (!_relationshipIsIncluded(r.InternalRelationshipName)) return;
 
-                var navigationEntity = _jsonApiContext.ContextGraph.GetRelationship(entity, r.RelationshipName);
+                var navigationEntity = _jsonApiContext.ContextGraph.GetRelationship(entity, r.InternalRelationshipName);
 
                 if (navigationEntity is IEnumerable)
                     foreach (var includedEntity in (IEnumerable)navigationEntity)
@@ -164,6 +168,8 @@ private List<DocumentData> _getIncludedEntities(ContextEntity contextEntity, IId
 
         private DocumentData _getIncludedEntity(IIdentifiable entity)
         {
+            if(entity == null) return null;
+            
             var contextEntity = _jsonApiContext.ContextGraph.GetContextEntity(entity.GetType());
 
             var data = new DocumentData

src/JsonApiDotNetCore/Builders/LinkBuilder.cs

@@ -1,4 +1,3 @@
-
 using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Http;
@@ -45,5 +44,10 @@ public string GetRelatedRelationLink(string parent, string parentId, string chil
         {
             return $"{_context.BasePath}/{parent.Dasherize()}/{parentId}/{child.Dasherize()}";
         }
+
+        public string GetPageLink(int pageOffset, int pageSize)
+        {
+            return $"{_context.BasePath}/{_context.RequestEntity.EntityName.Dasherize()}?page[size]={pageSize}&page[number]={pageOffset}";
+        }
     }
 }

src/JsonApiDotNetCore/Controllers/JsonApiController.cs

@@ -65,7 +65,7 @@ public virtual async Task<IActionResult> GetAsync()
                 entities = IncludeRelationships(entities, _jsonApiContext.QuerySet.IncludedRelationships);
 
             if (_jsonApiContext.Options.IncludeTotalRecordCount)
-                _jsonApiContext.TotalRecords = await entities.CountAsync();
+                _jsonApiContext.PageManager.TotalRecords = await entities.CountAsync();
 
             // pagination should be done last since it will execute the query
             var pagedEntities = await ApplyPageQueryAsync(entities);
@@ -126,9 +126,6 @@ public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string rel
             var relationship = _jsonApiContext.ContextGraph
                 .GetRelationship<T>(entity, relationshipName);
 
-            if (relationship == null)
-                return NotFound();
-
             return Ok(relationship);
         }
 
@@ -141,9 +138,13 @@ public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
                 return UnprocessableEntity();
             }
 
+            var stringId = entity.Id.ToString();
+            if(stringId.Length > 0 && stringId != "0")
+                return Forbidden();
+
             await _entities.CreateAsync(entity);
 
-            return Created(HttpContext.Request.Path, entity);
+            return Created($"{HttpContext.Request.Path}/{entity.Id}", entity);
         }
 
         [HttpPatch("{id}")]
@@ -157,9 +158,41 @@ public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
 
             var updatedEntity = await _entities.UpdateAsync(id, entity);
 
+            if(updatedEntity == null)  return NotFound();
+
             return Ok(updatedEntity);
         }
 
+        [HttpPatch("{id}/relationships/{relationshipName}")]
+        public virtual async Task<IActionResult> PatchRelationshipsAsync(TId id, string relationshipName, [FromBody] List<DocumentData> relationships)
+        {
+            relationshipName = _jsonApiContext.ContextGraph
+                .GetRelationshipName<T>(relationshipName.ToProperCase());
+
+            if (relationshipName == null)
+            {
+                _logger?.LogInformation($"Relationship name not specified returning 422");
+                return UnprocessableEntity();
+            }
+
+            var entity = await _entities.GetAndIncludeAsync(id, relationshipName);
+
+            if (entity == null)
+                return NotFound();
+
+            var relationship = _jsonApiContext.ContextGraph
+                .GetContextEntity(typeof(T))
+                .Relationships
+                .FirstOrDefault(r => r.InternalRelationshipName == relationshipName);
+
+            var relationshipIds = relationships.Select(r=>r.Id);
+            
+            await _entities.UpdateRelationshipsAsync(entity, relationship, relationshipIds);
+
+            return Ok();
+            
+        }
+
         [HttpDelete("{id}")]
         public virtual async Task<IActionResult> DeleteAsync(TId id)
         {
@@ -190,17 +223,15 @@ private IQueryable<T> ApplySortAndFilterQuery(IQueryable<T> entities)
 
         private async Task<IEnumerable<T>> ApplyPageQueryAsync(IQueryable<T> entities)
         {
-            if(_jsonApiContext.Options.DefaultPageSize == 0 && (_jsonApiContext.QuerySet == null || _jsonApiContext.QuerySet.PageQuery.PageSize == 0))
+            var pageManager = _jsonApiContext.PageManager;
+            if(!pageManager.IsPaginated)
                 return entities;
 
             var query = _jsonApiContext.QuerySet?.PageQuery ?? new PageQuery();
-            
-            var pageNumber = query.PageOffset > 0 ? query.PageOffset : 1;
-            var pageSize = query.PageSize > 0 ? query.PageSize : _jsonApiContext.Options.DefaultPageSize;
 
-            _logger?.LogInformation($"Applying paging query. Fetching page {pageNumber} with {pageSize} entities");
+            _logger?.LogInformation($"Applying paging query. Fetching page {pageManager.CurrentPage} with {pageManager.PageSize} entities");
 
-            return await _entities.PageAsync(entities, pageSize, pageNumber);
+            return await _entities.PageAsync(entities, pageManager.PageSize, pageManager.CurrentPage);
         }
 
         private IQueryable<T> IncludeRelationships(IQueryable<T> entities, List<string> relationships)

src/JsonApiDotNetCore/Controllers/JsonApiControllerMixin.cs

@@ -11,5 +11,10 @@ protected IActionResult UnprocessableEntity()
         {
             return new StatusCodeResult(422);
         }
+
+        protected IActionResult Forbidden()
+        {
+            return new StatusCodeResult(403);
+        }
     }
 }

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -105,7 +105,13 @@ public virtual async Task<TEntity> UpdateAsync(TId id, TEntity entity)
 
             await _context.SaveChangesAsync();
 
-            return oldEntity;
+        return oldEntity;
+        }
+
+        public async Task UpdateRelationshipsAsync(object parent, RelationshipAttribute relationship, IEnumerable<string> relationshipIds)
+        {
+            var genericProcessor = GenericProcessorFactory.GetProcessor(relationship.Type, _context);
+            await genericProcessor.UpdateRelationshipsAsync(parent, relationship, relationshipIds);
         }
 
         public virtual async Task<bool> DeleteAsync(TId id)
@@ -125,7 +131,7 @@ public virtual async Task<bool> DeleteAsync(TId id)
         public virtual IQueryable<TEntity> Include(IQueryable<TEntity> entities, string relationshipName)
         {
             var entity = _jsonApiContext.RequestEntity;
-            if(entity.Relationships.Any(r => r.RelationshipName == relationshipName))
+            if(entity.Relationships.Any(r => r.InternalRelationshipName == relationshipName))
                 return entities.Include(relationshipName);
 
             throw new JsonApiException("400", "Invalid relationship",

src/JsonApiDotNetCore/Data/IEntityRepository.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Query;
 using JsonApiDotNetCore.Models;
 
@@ -33,6 +34,8 @@ public interface IEntityRepository<TEntity, in TId>
 
         Task<TEntity> UpdateAsync(TId id, TEntity entity);
 
+        Task UpdateRelationshipsAsync(object parent, RelationshipAttribute relationship, IEnumerable<string> relationshipIds);
+
         Task<bool> DeleteAsync(TId id);
     }
 }

src/JsonApiDotNetCore/Extensions/IQueryableExtensions.cs

@@ -86,7 +86,7 @@ public static IQueryable<TSource> Filter<TSource>(this IQueryable<TSource> sourc
                 // {1}
                 var right = Expression.Constant(convertedValue, property.PropertyType);
 
-                var body = Expression.Equal(left, right);
+                Expression body;
                 switch (filterQuery.FilterOperation)
                 {
                     case FilterOperations.eq:
@@ -109,6 +109,12 @@ public static IQueryable<TSource> Filter<TSource>(this IQueryable<TSource> sourc
                         // {model.Id <= 1}
                         body = Expression.GreaterThanOrEqual(left, right);
                         break;
+                    case FilterOperations.like:
+                        // {model.Id <= 1}
+                        body = Expression.Call(left, "Contains", null, right);
+                        break;
+                    default:
+                        throw new JsonApiException("500", $"Unknown filter operation {filterQuery.FilterOperation}");
                 }
 
                 var lambda = Expression.Lambda<Func<TSource, bool>>(body, parameter);

src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs

@@ -41,7 +41,9 @@ public Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
             {
                 var body = GetRequestBody(context.HttpContext.Request.Body);
                 var jsonApiContext = GetService<IJsonApiContext>(context);
-                var model = JsonApiDeSerializer.Deserialize(body, jsonApiContext);
+                var model = jsonApiContext.IsRelationshipPath ? 
+                    JsonApiDeSerializer.DeserializeRelationship(body, jsonApiContext) :
+                    JsonApiDeSerializer.Deserialize(body, jsonApiContext);
 
                 if(model == null)
                     logger?.LogError("An error occurred while de-serializing the payload");