Merge pull request #9 from joshdholtz/1.0.0-rc1

1.0.0 rc1 - Updates to 1.0.0-rc3 of JSON API spec

Author: Josh Holtz

Classes/JSONAPI.h

@@ -10,23 +10,28 @@
 
 #import "JSONAPIResource.h"
 #import "JSONAPIResourceFormatter.h"
-#import "JSONAPIResourceLinker.h"
 #import "JSONAPIResourceModeler.h"
+#import "JSONAPIErrorResource.h"
 
 @interface JSONAPI : NSObject
 
-@property (nonatomic, strong) NSDictionary *meta;
-@property (nonatomic, strong) NSDictionary *linked;
-@property (nonatomic, strong) NSError *error;
+@property (nonatomic, strong, readonly) NSDictionary *meta;
+@property (nonatomic, strong, readonly) id data;
+@property (nonatomic, strong, readonly) NSArray *errors;
 
-+ (id)JSONAPIWithString:(NSString*)string;
-+ (id)JSONAPIWithDictionary:(NSDictionary*)dictionary;
+@property (readonly) id resource;
+@property (nonatomic, strong, readonly) NSArray *resources;
+@property (nonatomic, strong, readonly) NSDictionary *includedResources;
 
-- (id)initWithString:(NSString*)string;
-- (id)initWithDictionary:(NSDictionary*)dictionary;
+@property (nonatomic, strong, readonly) NSError *internalError;
 
-- (id)objectForKey:(NSString*)key;
-- (id)resourceForKey:(NSString*)key;
-- (NSArray*)resourcesForKey:(NSString*)key;
+// Initializers
++ (instancetype)jsonAPIWithDictionary:(NSDictionary *)dictionary;
++ (instancetype)jsonAPIWithString:(NSString *)string;
+- (instancetype)initWithDictionary:(NSDictionary*)dictionary;
+- (instancetype)initWithString:(NSString*)string;
+
+- (id)includedResource:(id)ID withType:(NSString*)type;
+- (BOOL)hasErrors;
 
 @end

Classes/JSONAPI.m

@@ -8,6 +8,8 @@
 
 #import "JSONAPI.h"
 
+#import "JSONAPIErrorResource.h"
+
 @interface JSONAPI()
 
 @property (nonatomic, strong) NSDictionary *dictionary;
@@ -16,28 +18,30 @@ @interface JSONAPI()
 
 @implementation JSONAPI
 
-#pragma mark - Init
+#pragma mark - Class
 
-+ (id)JSONAPIWithString:(NSString*)string {
-    return [[JSONAPI alloc] initWithString:string];
++ (instancetype)jsonAPIWithDictionary:(NSDictionary *)dictionary {
+    return [[JSONAPI alloc] initWithDictionary:dictionary];
 }
 
-+ (id)JSONAPIWithDictionary:(NSDictionary*)dictionary {
-    return [[JSONAPI alloc] initWithDictionary:dictionary];
++ (instancetype)jsonAPIWithString:(NSString *)string {
+    return [[JSONAPI alloc] initWithString:string];
 }
 
-- (id)initWithString:(NSString*)string {
+#pragma mark - Instance
+
+- (instancetype)initWithDictionary:(NSDictionary*)dictionary {
     self = [super init];
     if (self) {
-        [self inflateWithString:string];
+        [self inflateWithDictionary:dictionary];
     }
     return self;
 }
 
-- (id)initWithDictionary:(NSDictionary*)dictionary {
+- (instancetype)initWithString:(NSString*)string {
     self = [super init];
     if (self) {
-        [self inflateWithDictionary:dictionary];
+        [self inflateWithString:string];
     }
     return self;
 }
@@ -48,102 +52,100 @@ - (void)inflateWithString:(NSString*)string {
     if ([json isKindOfClass:[NSDictionary class]] == YES) {
         [self inflateWithDictionary:json];
     } else {
-        _error = [NSError errorWithDomain:@"Could not parse JSON" code:0 userInfo:nil];
+        _internalError = [NSError errorWithDomain:@"Could not parse JSON" code:0 userInfo:nil];
     }
 }
 
 #pragma mark - Resources
 
-- (id)objectForKey:(NSString*)key {
-    return [_dictionary objectForKey:key];
+- (id)resource {
+    return _resources.firstObject;
 }
 
-- (id)resourceForKey:(NSString*)key {
-    if ([key isEqualToString:@"meta"] == YES || [key isEqualToString:@"linked"] == YES) {
-        return nil;
-    }
-    
-    NSDictionary *rawResource = [_dictionary objectForKey:key];
-    JSONAPIResource *resource = nil;
-    if ([rawResource isKindOfClass:[NSDictionary class]] == YES) {
-        Class c = [JSONAPIResourceModeler resourceForLinkedType:[JSONAPIResourceLinker linkedType:key]];
-        resource = [JSONAPIResource jsonAPIResource:rawResource withLinked:self.linked withClass:c];
-    }
-    
-    // Fall back to first element in array
-    if (resource == nil) {
-        id resources = [self resourcesForKey:key];
-        if ([resources isKindOfClass:[NSArray class]] == YES) {
-            return [resources firstObject];
-        }
-    }
-    
-    return resource;
-
+- (id)includedResource:(id)ID withType:(NSString *)type {
+    if (ID == nil) return nil;
+    if (type == nil) return nil;
+    return _includedResources[type][ID];
 }
 
-- (NSArray*)resourcesForKey:(NSString*)key {
-    if ([key isEqualToString:@"meta"] == YES || [key isEqualToString:@"linked"] == YES) {
-        return nil;
-    }
-    
-    NSArray *rawResources = [_dictionary objectForKey:key];
-    NSArray *resources = nil;
-    if ([rawResources isKindOfClass:[NSArray class]] == YES) {
-        Class c = [JSONAPIResourceModeler resourceForLinkedType:[JSONAPIResourceLinker linkedType:key]];
-        resources = [JSONAPIResource jsonAPIResources:rawResources withLinked:self.linked withClass:c];
-    }
-    
-    return resources;
+- (BOOL)hasErrors {
+    return _errors.count > 0;
 }
 
 #pragma mark - Private
 
 - (void)inflateWithDictionary:(NSDictionary*)dictionary {
-    // Sets dictionary
+    
+    // Sets internal dictionary
     _dictionary = dictionary;
 
     // Sets meta
-    _meta = [dictionary objectForKey:@"meta"];
+    _meta = dictionary[@"meta"];
     if ([_meta isKindOfClass:[NSDictionary class]] == NO) {
         _meta = nil;
     }
 
-    // Sets linked
-    NSMutableDictionary *creatingLinked = [NSMutableDictionary dictionary];
-    NSDictionary *rawLinked = [dictionary objectForKey:@"linked"];
-    if ([rawLinked isKindOfClass:[NSDictionary class]] == YES) {
+    // Parse resources
+    _data = _dictionary[@"data"];
+    
+    NSMutableArray *resources = @[].mutableCopy;
+    if ([_data isKindOfClass:[NSArray class]] == YES) {
+        
+        NSArray *dataArray = (NSArray*) _data;
+        for (NSDictionary *data in dataArray) {
+            id resource = [self inflateResourceData:data];
+            if (resource) [resources addObject:resource];
+        }
 
-        NSMutableArray *linkedToLinkWithLinked = [NSMutableArray array];
+    } else if ([_data isKindOfClass:[NSDictionary class]] == YES) {
+        id resource = [self inflateResourceData:_data];
+        if (resource) [resources addObject:resource];
+    }
+    _resources = resources;
+    
+    // Parses included resources
+    NSArray *included = _dictionary[@"included"];
+    NSMutableDictionary *includedResources = @{}.mutableCopy;
+    for (NSDictionary *data in included) {
 
-        // Loops through linked arrays
-        for (NSString *key in rawLinked.allKeys) {
-            NSArray *value = [rawLinked objectForKey:key];
-            
-            if ([value isKindOfClass:[NSArray class]] == YES) {
-                NSMutableDictionary *resources = [NSMutableDictionary dictionary];
-                for (NSDictionary *resourceDictionary in value) {
-                    Class c = [JSONAPIResourceModeler resourceForLinkedType:[JSONAPIResourceLinker linkedType:key]];
-                    JSONAPIResource *resource = [JSONAPIResource jsonAPIResource:resourceDictionary withLinked:nil withClass:c];
-                    if (resource.ID != nil) {
-                        [resources setObject:resource forKey:resource.ID];
-                        [linkedToLinkWithLinked addObject:resource];
-                    }
-                }
-                [creatingLinked setObject:resources forKey:key];
-                
-            }
+        JSONAPIResource *resource = [self inflateResourceData:data];
+        if (resource) {
+
+            NSMutableDictionary *typeDict = includedResources[resource.type] ?: @{}.mutableCopy;
+            typeDict[resource.ID] = resource;
 
+            includedResources[resource.type] = typeDict;
         }
-        
-        // Linked the linked
-        for (JSONAPIResource *resource in linkedToLinkWithLinked) {
-            [resource linkLinks:creatingLinked];
+    }
+    _includedResources = includedResources;
+    
+    // Link included with included
+    // TODO: Need to look into / stop circular references
+    for (NSDictionary *typeIncluded in _includedResources.allValues) {
+        for (JSONAPIResource *resource in typeIncluded.allValues) {
+            [resource linkWithIncluded:self];
         }
-        
     }
 
-    _linked = creatingLinked;
+    // Link data with included
+    for (JSONAPIResource *resource in _resources) {
+        [resource linkWithIncluded: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];
+    }
+    _errors = errors;
+}
+
+- (id)inflateResourceData:(NSDictionary*)data {
+    return [JSONAPIResource jsonAPIResource:data];
 }
 
 @end

Classes/JSONAPIErrorResource.h

@@ -0,0 +1,20 @@
+//
+//  JSONAPIErrorResource.h
+//  JSONAPI
+//
+//  Created by Josh Holtz on 3/17/15.
+//  Copyright (c) 2015 Josh Holtz. All rights reserved.
+//
+
+#import "JSONAPIResource.h"
+
+@interface JSONAPIErrorResource : JSONAPIResource
+
+@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;
+
+@end

Classes/JSONAPIErrorResource.m

@@ -0,0 +1,23 @@
+//
+//  JSONAPIErrorResource.m
+//  JSONAPI
+//
+//  Created by Josh Holtz on 3/17/15.
+//  Copyright (c) 2015 Josh Holtz. All rights reserved.
+//
+
+#import "JSONAPIErrorResource.h"
+
+@implementation JSONAPIErrorResource
+
+- (NSDictionary *)mapKeysToProperties {
+    return @{
+             @"status" : @"status",
+             @"code" : @"code",
+             @"title" : @"title",
+             @"detail" : @"detail",
+             @"paths" : @"paths",
+             };
+}
+
+@end

Classes/JSONAPIResource.h

@@ -8,26 +8,20 @@
 
 #import <Foundation/Foundation.h>
 
+@class JSONAPI;
+
 @interface JSONAPIResource : NSObject<NSCopying, NSCoding>
 
 @property (nonatomic, strong) id ID;
-@property (nonatomic, strong) NSString *href;
-@property (nonatomic, strong) NSDictionary *links;
-
-+ (NSArray*)jsonAPIResources:(NSArray*)array withLinked:(NSDictionary*)linked;
-+ (NSArray*)jsonAPIResources:(NSArray*)array withLinked:(NSDictionary*)linked withClass:(Class)resourceObjectClass;
-
-+ (id)jsonAPIResource:(NSDictionary*)dictionary withLinked:(NSDictionary*)linked;
-+ (id)jsonAPIResource:(NSDictionary*)dictionary withLinked:(NSDictionary*)linked withClass:(Class)resourceObjectClass;
-
-- (id)initWithDictionary:(NSDictionary*)dict withLinked:(NSDictionary*)linked;
-- (void)setWithDictionary:(NSDictionary*)dict;
+@property (nonatomic, strong) NSString *type;
+@property (nonatomic, strong) id links;
 
-- (id)objectForKey:(NSString*)key;
-- (id)linkedResourceForKey:(NSString*)key;
++ (id)jsonAPIResource:(NSDictionary*)dictionary;
++ (NSArray*)jsonAPIResources:(NSArray*)array;
 
-- (void)linkLinks:(NSDictionary*)linked;
+- (id)initWithDictionary:(NSDictionary*)dict;
 
 - (NSDictionary *)mapKeysToProperties;
+- (void)linkWithIncluded:(JSONAPI*)jsonAPI;
 
 @end