Merge branch 'jkarmstr-master'

Author: Josh Holtz

Classes/JSONAPI.h

@@ -9,14 +9,20 @@
 #import <Foundation/Foundation.h>
 
 #import "JSONAPIResource.h"
-#import "JSONAPIResourceFormatter.h"
-#import "JSONAPIResourceModeler.h"
-#import "JSONAPIErrorResource.h"
 
+/**
+ *  Represents a complete JSON-API formatted message body.
+ */
 @interface JSONAPI : NSObject
 
-@property (nonatomic, strong, readonly) NSDictionary *meta;
-@property (nonatomic, strong, readonly) id data;
+/**
+ *  Returns Content-Type string for JSON-API
+ *
+ *  @return Content-Type string for JSON-API
+ */
++ (NSString*)MEDIA_TYPE;
+
+@property (readonly) NSDictionary *meta;
 @property (nonatomic, strong, readonly) NSArray *errors;
 
 @property (readonly) id resource;
@@ -28,9 +34,13 @@
 // Initializers
 + (instancetype)jsonAPIWithDictionary:(NSDictionary *)dictionary;
 + (instancetype)jsonAPIWithString:(NSString *)string;
++ (instancetype)jsonAPIWithResource:(NSObject <JSONAPIResource> *)resource;
+
 - (instancetype)initWithDictionary:(NSDictionary*)dictionary;
 - (instancetype)initWithString:(NSString*)string;
 
+- (NSDictionary*)dictionary;
+
 - (id)includedResource:(id)ID withType:(NSString*)type;
 - (BOOL)hasErrors;
 

Classes/JSONAPI.m

@@ -9,6 +9,11 @@
 #import "JSONAPI.h"
 
 #import "JSONAPIErrorResource.h"
+#import "JSONAPIResourceParser.h"
+#import "JSONAPIResourceDescriptor.h"
+
+
+static NSString *gMEDIA_TYPE = @"application/vnd.api+json";
 
 @interface JSONAPI()
 
@@ -20,6 +25,10 @@ @implementation JSONAPI
 
 #pragma mark - Class
 
++ (NSString*)MEDIA_TYPE {
+    return gMEDIA_TYPE;
+}
+
 + (instancetype)jsonAPIWithDictionary:(NSDictionary *)dictionary {
     return [[JSONAPI alloc] initWithDictionary:dictionary];
 }
@@ -28,8 +37,16 @@ + (instancetype)jsonAPIWithString:(NSString *)string {
     return [[JSONAPI alloc] initWithString:string];
 }
 
++ (instancetype)jsonAPIWithResource:(NSObject <JSONAPIResource> *)resource {
+    return [[JSONAPI alloc] initWithResource:resource];
+}
+
 #pragma mark - Instance
 
+- (NSDictionary*)meta {
+    return self.dictionary[@"meta"];
+}
+
 - (instancetype)initWithDictionary:(NSDictionary*)dictionary {
     self = [super init];
     if (self) {
@@ -46,6 +63,14 @@ - (instancetype)initWithString:(NSString*)string {
     return self;
 }
 
+-(instancetype)initWithResource:(NSObject <JSONAPIResource> *)resource {
+    self = [super init];
+    if (self) {
+        [self inflateWithResource:resource];
+    }
+    return self;
+}
+
 - (void)inflateWithString:(NSString*)string {
     id json = [NSJSONSerialization JSONObjectWithData:[string dataUsingEncoding:NSUTF8StringEncoding] options:0 error:nil];
 
@@ -79,72 +104,99 @@ - (void)inflateWithDictionary:(NSDictionary*)dictionary {
     // Sets internal dictionary
     _dictionary = dictionary;
 
-    // Sets meta
-    _meta = dictionary[@"meta"];
-    if ([_meta isKindOfClass:[NSDictionary class]] == NO) {
-        _meta = nil;
-    }
-    
     // Parse resources
-    _data = _dictionary[@"data"];
-    
-    NSMutableArray *resources = @[].mutableCopy;
-    if ([_data isKindOfClass:[NSArray class]] == YES) {
+    id data = dictionary[@"data"];
+    if ([data isKindOfClass:[NSArray class]] == YES) {
+        _resources = [JSONAPIResourceParser parseResources:data];
 
-        NSArray *dataArray = (NSArray*) _data;
-        for (NSDictionary *data in dataArray) {
-            id resource = [self inflateResourceData:data];
-            if (resource) [resources addObject:resource];
-        }
-        
-    } else if ([_data isKindOfClass:[NSDictionary class]] == YES) {
-        id resource = [self inflateResourceData:_data];
-        if (resource) [resources addObject:resource];
+    } else if ([data isKindOfClass:[NSDictionary class]] == YES) {
+        id resource = [JSONAPIResourceParser parseResource:data];
+        _resources = [[NSArray alloc] initWithObjects:resource, nil];
     }
-    _resources = resources;
 
     // Parses included resources
-    NSArray *included = _dictionary[@"included"];
-    NSMutableDictionary *includedResources = @{}.mutableCopy;
-    for (NSDictionary *data in included) {
-        
-        JSONAPIResource *resource = [self inflateResourceData:data];
+    id included = dictionary[@"included"];
+    NSMutableDictionary *includedResources = [[NSMutableDictionary alloc] init];
+    if ([included isKindOfClass:[NSArray class]] == YES) {
+        for (NSDictionary *data in included) {
+            
+            NSObject <JSONAPIResource> *resource = [JSONAPIResourceParser parseResource:data];
+            if (resource) {
+                JSONAPIResourceDescriptor *desc = [JSONAPIResourceDescriptor forLinkedType:data[@"type"]];
+                
+                NSMutableDictionary *typeDict = includedResources[desc.type] ?: @{}.mutableCopy;
+                typeDict[resource.ID] = resource;
+                
+                includedResources[desc.type] = typeDict;
+            }
+        }
+    } else if ([included isKindOfClass:[NSDictionary class]] == YES) {
+        NSObject <JSONAPIResource> *resource = [JSONAPIResourceParser parseResource:included];
         if (resource) {
-
-            NSMutableDictionary *typeDict = includedResources[resource.type] ?: @{}.mutableCopy;
+            JSONAPIResourceDescriptor *desc = [JSONAPIResourceDescriptor forLinkedType:data[@"type"]];
+            
+            NSMutableDictionary *typeDict = includedResources[desc.type] ?: @{}.mutableCopy;
             typeDict[resource.ID] = resource;
 
-            includedResources[resource.type] = typeDict;
+            includedResources[desc.type] = typeDict;
         }
     }
     _includedResources = includedResources;
 
     // Link included with included
     for (NSDictionary *typeIncluded in _includedResources.allValues) {
-        for (JSONAPIResource *resource in typeIncluded.allValues) {
-            [resource linkWithIncluded:self];
+        for (NSObject <JSONAPIResource> *resource in typeIncluded.allValues) {
+            [JSONAPIResourceParser link:resource withIncluded:self];
         }
     }
 
     // Link data with included
-    for (JSONAPIResource *resource in _resources) {
-        [resource linkWithIncluded:self];
+    for (NSObject <JSONAPIResource> *resource in _resources) {
+        [JSONAPIResourceParser link:resource withIncluded:self];
     }
-
+    
     // Parse errors
-    NSMutableArray *errors = @[].mutableCopy;
-    NSLog(@"ERROS - %@", _dictionary[@"errors"]);
-    for (NSDictionary *data in _dictionary[@"errors"]) {
-        
-        JSONAPIErrorResource *resource = [[JSONAPIErrorResource alloc] initWithDictionary:data];
-        NSLog(@"Error resource - %@", resource);
-        if (resource) [errors addObject:resource];
+    if (dictionary[@"errors"]) {
+        NSMutableArray *errors = [[NSMutableArray alloc] init];
+        NSLog(@"ERRORS - %@", dictionary[@"errors"]);
+        for (NSDictionary *data in dictionary[@"errors"]) {
+            
+            JSONAPIErrorResource *resource = [[JSONAPIErrorResource alloc] initWithDictionary: data];
+            NSLog(@"Error resource - %@", resource);
+            if (resource) [errors addObject:resource];
+        }
+        _errors = errors;
     }
-    _errors = errors;
 }
 
-- (id)inflateResourceData:(NSDictionary*)data {
-    return [JSONAPIResource jsonAPIResource:data];
+- (void)inflateWithResource:(NSObject <JSONAPIResource> *)resource
+{
+    NSMutableArray *resourceArray = [[NSMutableArray alloc] init];
+    [resourceArray addObject:resource];
+    _resources = resourceArray;
+    
+    NSMutableDictionary *newDictionary = [[NSMutableDictionary alloc] init];
+    
+    newDictionary[@"data"] = [JSONAPIResourceParser dictionaryFor:resource];
+    
+    NSArray *included = [JSONAPIResourceParser relatedResourcesFor:resource];
+    if (included.count) {
+        newDictionary[@"included"] = included;
+        
+        NSMutableDictionary *includedResources = [[NSMutableDictionary alloc] init];
+        for (NSObject <JSONAPIResource> *linked in included) {
+            
+            JSONAPIResourceDescriptor *desc = [[linked class] descriptor];
+            
+            NSMutableDictionary *typeDict = includedResources[desc.type] ?: @{}.mutableCopy;
+            typeDict[linked.ID] = resource;
+            
+            includedResources[desc.type] = typeDict;
+        }
+        _includedResources = includedResources;
+    }
+    
+    _dictionary = newDictionary;
 }
 
 @end

Classes/JSONAPIErrorResource.h

@@ -6,15 +6,20 @@
 //  Copyright (c) 2015 Josh Holtz. All rights reserved.
 //
 
-#import "JSONAPIResource.h"
-
-@interface JSONAPIErrorResource : JSONAPIResource
+/**
+ *  Class respresentation of a JSON-API error structure.
+ */
+@interface JSONAPIErrorResource : NSObject
 
+@property (nonatomic, strong) NSString *ID;
+@property (nonatomic, strong) NSString *href;
 @property (nonatomic, strong) NSString *status;
 @property (nonatomic, strong) NSString *code;
 @property (nonatomic, strong) NSString *title;
 @property (nonatomic, strong) NSString *detail;
 @property (nonatomic, strong) NSArray *links;
 @property (nonatomic, strong) NSArray *paths;
 
+- (instancetype) initWithDictionary:(NSDictionary*)dictionary;
+
 @end

Classes/JSONAPIErrorResource.m

@@ -8,16 +8,25 @@
 
 #import "JSONAPIErrorResource.h"
 
+#import "JSONAPIResourceDescriptor.h"
+
 @implementation JSONAPIErrorResource
 
-- (NSDictionary *)mapKeysToProperties {
-    return @{
-             @"status" : @"status",
-             @"code" : @"code",
-             @"title" : @"title",
-             @"detail" : @"detail",
-             @"paths" : @"paths",
-             };
+- (instancetype) initWithDictionary:(NSDictionary*)dictionary {
+    self =  [self init];
+    
+    if (self) {
+        _ID = dictionary[@"id"];
+        _href = dictionary[@"href"];
+        _status = dictionary[@"status"];
+        _code = dictionary[@"code"];
+        _title = dictionary[@"title"];
+        _detail = dictionary[@"detail"];
+        _links = dictionary[@"links"];
+        _paths = dictionary[@"paths"];
+    }
+    
+    return self;
 }
 
 @end

Classes/JSONAPIPropertyDescriptor.h

@@ -0,0 +1,90 @@
+//
+//  JSONAPIProperty.h
+//  JSONAPI
+//
+//  Created by Jonathan Karl Armstrong, 2015.
+//
+
+#import <Foundation/Foundation.h>
+
+@class JSONAPIResourceDescriptor;
+
+/**
+ * JSON API metadata for a <JSONAPIResource> property. This is intended to be used in 
+ * dictionary contained in <JSONAPIResourceDescriptor>. The dictionary key is the model 
+ * class property name, and the <JSONAPIResourceDescriptor> contains the rest of the 
+ * model class metadata.
+ *
+ * This class is used primarily to transform an individual model property to and from JSON.
+ *
+ * There are two basic resouce model property types; simple values and related resource 
+ * references. This class handles both, although some internal properties may only apply 
+ * to one or the other.
+ * 
+ * A simple value property includes anything that can be expressed or transformed into 
+ * a single key-value pair in JSON. This includes types like NSNumber and NSString that 
+ * have native JSON serialization support, as well as types like NSDate that can be 
+ * transformed into an NSString representation using an NSFormatter.
+ *
+ * Related resources are objects that must also conform to the <JSONAPIResource> protocol. 
+ * Classes that do not conform to the protocol, or do not have a <JSONAPIResourceDescriptor>
+ * registered at runtime, are not supported, even if they theoretically have a valid JSON 
+ * serialization. Since it is easy to implement the protocol on existing classes, this 
+ * should not be a great limitation.
+ */
+@interface JSONAPIPropertyDescriptor : NSObject
+
+/** 
+ * Name used for property in JSON serialization 
+ */
+@property (nonatomic, readonly) NSString *jsonName;
+
+/** 
+ * Optional formatter instance used to serialize/deserialize property. For example,
+ * NSDate instances must be serialized to a string representation. Any type that can be
+ * reversibly serialized to a String can be used as a property by setting an appropriate 
+ * serializer.
+ *
+ * For array properties, this is applied to each element of an array if set.
+ *
+ * Formatters are only for simple property types. A _linked_ <JSONAPIResource> may not have 
+ * a formatter.
+ */
+@property (nonatomic) NSFormatter *formatter;
+
+/**
+ * For a linked <JSONAPIResource> type, this is a reference to the resource class.
+ *
+ * For array properties (has many relationship), this applies to each element of the array.
+ *
+ * Should be nil for simple types.
+ */
+@property (nonatomic, readonly) Class resourceType;
+
+/** 
+ * Initialize new instance. For supported simple types (NSSTring, NSNumber, etc.) this is usually 
+ * sufficient.
+ *
+ * @param name property label used in JSON
+ */
+- (instancetype)initWithJsonName:(NSString*)name;
+
+/** 
+ * Initialize new instance with NSFormatter. For simple properties that are not directly
+ * supported by NSJSONSerialization, use this. For example, NSDate requires an NSDateFormatter.
+ *
+ * @param name property label used in JSON
+ * @param fmt an NSFormatter that converts to/fram JSON string
+ */
+- (instancetype)initWithJsonName:(NSString*)name withFormat:(NSFormatter*)fmt;
+
+/** 
+ * Initialize new instance for linked resource property. For related resource properties use this.
+ * This applies to both has-one relationships and has-many relationships.
+ *
+ * @param name property label used in JSON
+ * @param resource Class of property. If property is an array (has_many), this is the element Class.
+ */
+- (instancetype)initWithJsonName:(NSString*)name withResource:(Class)resource;
+
+@end