appjam 0.1.8.8 → 0.1.8.9

data/lib/appjam/generators/templates/blank/EiffelApplication/libs/frameworks/AFIncrementalStore/AFRESTClient.h

@@ -0,0 +1,135 @@
+// AFRESTClient.h
+//
+// Copyright (c) 2012 Mattt Thompson (http://mattt.me)
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// 
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+#import "AFHTTPClient.h"
+#import "AFHTTPRequestOperation.h"
+#import "AFIncrementalStore.h"
+#import "TTTStringInflector.h"
+
+@protocol AFPaginator;
+
+/**
+ `AFRESTClient` is a subclass of `AFHTTPClient` that implements the `AFIncrementalStoreHTTPClient` protocol in a way that follows the conventions of a RESTful web service.
+ */
+@interface AFRESTClient : AFHTTPClient <AFIncrementalStoreHTTPClient>
+
+/**
+ 
+ */
+@property (nonatomic, strong) id <AFPaginator> paginator;
+
+/**
+ 
+ */
+@property (readonly, nonatomic, strong) TTTStringInflector *inflector;
+
+///------------------------
+/// @name Determining Paths
+///------------------------
+
+/**
+ Returns the request path for a collection of resources of the specified entity. By default, this returns an imprecise pluralization of the entity name.
+ 
+ @discussion The return value of this method is used as the `path` parameter in other `AFHTTPClient` methods.
+ 
+ @param entity The entity used to determine the resources path.
+ 
+ @return An `NSString` representing the request path.
+ */
+- (NSString *)pathForEntity:(NSEntityDescription *)entity;
+
+/**
+ Returns the request path for the resource of a particular managed object. By default, this returns an imprecise pluralization of the entity name, with the additional path component of the resource identifier corresponding to the managed object.
+ 
+ @discussion The return value of this method is used as the `path` parameter in other `AFHTTPClient` methods.
+ 
+ @param object The managed object used to determine the resource path.
+ 
+ @return An `NSString` representing the request path.
+ */
+- (NSString *)pathForObject:(NSManagedObject *)object;
+
+/**
+ Returns the request path for the resource of a particular managed object. By default, this returns an imprecise pluralization of the entity name, with the additional path component of either an imprecise pluralization of the relationship destination entity name if the relationship is to-many, or the relationship destination entity name if to-one.
+ 
+ @discussion The return value of this method is used as the `path` parameter in other `AFHTTPClient` methods.
+ 
+ @param relationship The relationship used to determine the resource path
+ @param object The managed object used to determine the resource path.
+ 
+ @return An `NSString` representing the request path.
+ */
+- (NSString *)pathForRelationship:(NSRelationshipDescription *)relationship
+                        forObject:(NSManagedObject *)object;
+
+@end
+
+///----------------
+/// @name Functions
+///----------------
+
+/**
+ 
+ */
+extern NSDate * AFDateFromISO8601String(NSString *ISO8601String);
+
+///-----------------
+/// @name Pagination
+///-----------------
+
+/**
+ 
+ */
+@protocol AFPaginator <NSObject>
+- (NSDictionary *)parametersForFetchRequest:(NSFetchRequest *)fetchRequest;
+@end
+
+/**
+ 
+ */
+@interface AFLimitAndOffsetPaginator : NSObject <AFPaginator>
+
+@property (readonly, nonatomic, copy) NSString *limitParameter;
+@property (readonly, nonatomic, copy) NSString *offsetParameter;
+
++ (instancetype)paginatorWithLimitParameter:(NSString *)limitParameterName
+                            offsetParameter:(NSString *)offsetParameterName;
+@end
+
+/**
+ 
+ */
+@interface AFPageAndPerPagePaginator : NSObject <AFPaginator>
+
+@property (readonly, nonatomic, copy) NSString *pageParameter;
+@property (readonly, nonatomic, copy) NSString *perPageParameter;
+
++ (instancetype)paginatorWithPageParameter:(NSString *)pageParameterName
+                          perPageParameter:(NSString *)perPageParameterName;
+@end
+
+/**
+ 
+ */
+@interface AFBlockPaginator : NSObject <AFPaginator>
++ (instancetype)paginatorWithBlock:(NSDictionary * (^)(NSFetchRequest *fetchRequest))block;
+@end

data/lib/appjam/generators/templates/blank/EiffelApplication/libs/frameworks/AFIncrementalStore/AFRESTClient.m

@@ -0,0 +1,441 @@
+// AFRESTClient.m
+//
+// Copyright (c) 2012 Mattt Thompson (http://mattt.me)
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// 
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+#import "AFRESTClient.h"
+#include <time.h>
+#include <xlocale.h>
+
+#define AF_ISO8601_MAX_LENGTH 25
+
+// Adopted from SSToolkit NSDate+SSToolkitAdditions
+// Created by Sam Soffes
+// Copyright (c) 2008-2012 Sam Soffes
+// https://github.com/soffes/sstoolkit/
+NSDate * AFDateFromISO8601String(NSString *ISO8601String) {
+    if (!ISO8601String) {
+        return nil;
+    }
+    
+    const char *str = [ISO8601String cStringUsingEncoding:NSUTF8StringEncoding];
+    char newStr[AF_ISO8601_MAX_LENGTH];
+    bzero(newStr, AF_ISO8601_MAX_LENGTH);
+    
+    size_t len = strlen(str);
+    if (len == 0) {
+        return nil;
+    }
+    
+    // UTC dates ending with Z
+    if (len == 20 && str[len - 1] == 'Z') {
+        memcpy(newStr, str, len - 1);
+        strncpy(newStr + len - 1, "+0000\0", 6);
+    }
+    
+    // Timezone includes a semicolon (not supported by strptime)
+    else if (len == 25 && str[22] == ':') {
+        memcpy(newStr, str, 22);
+        memcpy(newStr + 22, str + 23, 2);
+    }
+    
+    // Fallback: date was already well-formatted OR any other case (bad-formatted)
+    else {
+        memcpy(newStr, str, len > AF_ISO8601_MAX_LENGTH - 1 ? AF_ISO8601_MAX_LENGTH - 1 : len);
+    }
+    
+    // Add null terminator
+    newStr[sizeof(newStr) - 1] = 0;
+    
+    struct tm tm = {
+        .tm_sec = 0,
+        .tm_min = 0,
+        .tm_hour = 0,
+        .tm_mday = 0,
+        .tm_mon = 0,
+        .tm_year = 0,
+        .tm_wday = 0,
+        .tm_yday = 0,
+        .tm_isdst = -1,
+    };
+    
+    strptime_l(newStr, "%FT%T%z", &tm, NULL);
+    
+    return [NSDate dateWithTimeIntervalSince1970:mktime(&tm)];
+}
+
+static NSString * AFQueryByAppendingParameters(NSString *query, NSDictionary *parameters) {
+    static NSCharacterSet *_componentSeparatorCharacterSet = nil;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        _componentSeparatorCharacterSet = [NSCharacterSet characterSetWithCharactersInString:@"&"];
+    });
+    
+    if (!parameters || [parameters count] == 0) {
+        return query;
+    }
+    
+    query = query ? [[query stringByTrimmingCharactersInSet:_componentSeparatorCharacterSet] stringByAppendingString:@"&"] : @"";
+    
+    NSMutableArray *mutablePairs = [NSMutableArray arrayWithCapacity:[parameters count]];
+    [parameters enumerateKeysAndObjectsUsingBlock:^(id field, id value, BOOL *stop) {
+        [mutablePairs addObject:[NSString stringWithFormat:@"%@=%@", field, value]];
+    }];
+    
+    return [query stringByAppendingString:[mutablePairs componentsJoinedByString:@"&"]];
+}
+
+@interface AFRESTClient ()
+@property (readwrite, nonatomic, strong) TTTStringInflector *inflector;
+@end
+
+@implementation AFRESTClient
+@synthesize paginator = _paginator;
+@synthesize inflector = _inflector;
+
+- (id)initWithBaseURL:(NSURL *)url {
+    self = [super initWithBaseURL:url];
+    if (!self) {
+        return nil;
+    }
+
+    self.inflector = [TTTStringInflector defaultInflector];
+
+    return self;
+}
+
+#pragma mark -
+
+- (NSString *)pathForEntity:(NSEntityDescription *)entity {
+    return [self.inflector pluralize:[entity.name lowercaseString]];
+}
+
+- (NSString *)pathForObject:(NSManagedObject *)object {
+    NSString *resourceIdentifier = AFResourceIdentifierFromReferenceObject([(NSIncrementalStore *)object.objectID.persistentStore referenceObjectForObjectID:object.objectID]);
+    return [[self pathForEntity:object.entity] stringByAppendingPathComponent:[resourceIdentifier lastPathComponent]];
+}
+
+- (NSString *)pathForRelationship:(NSRelationshipDescription *)relationship 
+                        forObject:(NSManagedObject *)object
+{
+    return [[self pathForObject:object] stringByAppendingPathComponent:relationship.name];
+}
+
+#pragma mark - AFIncrementalStoreHTTPClient
+
+#pragma mark Read Methods
+
+- (id)representationOrArrayOfRepresentationsOfEntity:(NSEntityDescription *)entity
+                                  fromResponseObject:(id)responseObject
+{
+    if ([responseObject isKindOfClass:[NSArray class]]) {
+        return responseObject;
+    } else if ([responseObject isKindOfClass:[NSDictionary class]]) {
+        id value = nil;
+
+        value = [responseObject valueForKey:[entity.name lowercaseString]];
+        if (value && [value isKindOfClass:[NSDictionary class]]) {
+            return value;
+        }
+
+        value = [responseObject valueForKey:[self.inflector pluralize:[entity.name lowercaseString]]];
+        if (value && [value isKindOfClass:[NSArray class]]) {
+            return value;
+        }
+        
+        return responseObject;
+    }
+    
+    return responseObject;
+}
+
+- (NSDictionary *)representationsForRelationshipsFromRepresentation:(NSDictionary *)representation
+                                                           ofEntity:(NSEntityDescription *)entity
+                                                       fromResponse:(NSHTTPURLResponse *)response
+{
+    NSMutableDictionary *mutableRelationshipRepresentations = [NSMutableDictionary dictionaryWithCapacity:[entity.relationshipsByName count]];
+    [entity.relationshipsByName enumerateKeysAndObjectsUsingBlock:^(id name, id relationship, BOOL *stop) {
+        id value = [representation valueForKey:name];
+        if (value) {
+            if ([relationship isToMany]) {
+                NSArray *arrayOfRelationshipRepresentations = nil;
+                if ([value isKindOfClass:[NSArray class]]) {
+                    arrayOfRelationshipRepresentations = value;
+                } else {
+                    arrayOfRelationshipRepresentations = [NSArray arrayWithObject:value];
+                }
+                                
+                [mutableRelationshipRepresentations setValue:arrayOfRelationshipRepresentations forKey:name];
+            } else {
+                [mutableRelationshipRepresentations setValue:value forKey:name];
+            }
+        }
+    }];
+    
+    return mutableRelationshipRepresentations;
+}
+
+- (NSString *)resourceIdentifierForRepresentation:(NSDictionary *)representation
+                                         ofEntity:(NSEntityDescription *)entity
+                                     fromResponse:(NSHTTPURLResponse *)response
+{
+    static NSArray *_candidateKeys = nil;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        _candidateKeys = [[NSArray alloc] initWithObjects:@"id", @"_id", @"identifier", @"url", @"URL", nil];
+    });
+    
+    NSString *key = [[representation allKeys] firstObjectCommonWithArray:_candidateKeys];
+    if (key) {
+        id value = [representation valueForKey:key];
+        if (value) {
+            return [value description];
+        }
+    }
+    
+    return nil;
+}
+
+- (NSDictionary *)attributesForRepresentation:(NSDictionary *)representation
+                                     ofEntity:(NSEntityDescription *)entity
+                                 fromResponse:(NSHTTPURLResponse *)response
+{
+    if ([representation isEqual:[NSNull null]]) {
+        return nil;
+    }
+    
+    NSMutableDictionary *mutableAttributes = [representation mutableCopy];
+    @autoreleasepool {
+        NSMutableSet *mutableKeys = [NSMutableSet setWithArray:[representation allKeys]];
+        [mutableKeys minusSet:[NSSet setWithArray:[[entity attributesByName] allKeys]]];
+        [mutableAttributes removeObjectsForKeys:[mutableKeys allObjects]];
+    
+        NSSet *keysWithNestedValues = [mutableAttributes keysOfEntriesPassingTest:^BOOL(id key, id obj, BOOL *stop) {
+            return [obj isKindOfClass:[NSArray class]] || [obj isKindOfClass:[NSDictionary class]];
+        }];
+        [mutableAttributes removeObjectsForKeys:[keysWithNestedValues allObjects]];
+    }
+    
+    [[entity attributesByName] enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL *stop) {
+        if ([(NSAttributeDescription *)obj attributeType] == NSDateAttributeType) {
+            id value = [mutableAttributes valueForKey:key];
+            if (value && ![value isEqual:[NSNull null]]) {
+                [mutableAttributes setValue:AFDateFromISO8601String(value) forKey:key];
+            }
+        }
+    }];
+    
+    return mutableAttributes;
+}
+
+- (NSMutableURLRequest *)requestForFetchRequest:(NSFetchRequest *)fetchRequest
+                                    withContext:(NSManagedObjectContext *)context
+{
+    NSMutableDictionary *mutableParameters = [NSMutableDictionary dictionary];
+    if (self.paginator) {
+        [mutableParameters addEntriesFromDictionary:[self.paginator parametersForFetchRequest:fetchRequest]];
+    }
+    
+    NSMutableURLRequest *mutableRequest =  [self requestWithMethod:@"GET" path:[self pathForEntity:fetchRequest.entity] parameters:[mutableParameters count] == 0 ? nil : mutableParameters];
+    
+    return mutableRequest;
+}
+
+- (NSMutableURLRequest *)requestWithMethod:(NSString *)method
+                       pathForObjectWithID:(NSManagedObjectID *)objectID
+                               withContext:(NSManagedObjectContext *)context
+{
+    NSManagedObject *object = [context objectWithID:objectID];
+    return [self requestWithMethod:method path:[self pathForObject:object] parameters:nil];
+}
+
+- (NSMutableURLRequest *)requestWithMethod:(NSString *)method
+                       pathForRelationship:(NSRelationshipDescription *)relationship
+                           forObjectWithID:(NSManagedObjectID *)objectID
+                               withContext:(NSManagedObjectContext *)context
+{
+    NSManagedObject *object = [context objectWithID:objectID];
+    return [self requestWithMethod:method path:[self pathForRelationship:relationship forObject:object] parameters:nil];
+}
+
+- (BOOL)shouldFetchRemoteValuesForRelationship:(NSRelationshipDescription *)relationship
+                               forObjectWithID:(NSManagedObjectID *)objectID
+                        inManagedObjectContext:(NSManagedObjectContext *)context
+{
+    return [relationship isToMany] || ![relationship inverseRelationship];
+}
+
+#pragma mark Write Methods
+
+- (NSDictionary *)representationOfAttributes:(NSDictionary *)attributes
+                             ofManagedObject:(NSManagedObject *)managedObject
+{
+    NSMutableDictionary *mutableAttributes = [attributes mutableCopy];
+    [attributes enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL *stop) {
+        // Use NSString representation of NSDate to avoid NSInvalidArgumentException when serializing JSON
+        if ([obj isKindOfClass:[NSDate class]]) {
+            [mutableAttributes setObject:[obj description] forKey:key];
+        }
+    }];
+
+    return mutableAttributes;
+}
+
+- (NSMutableURLRequest *)requestForInsertedObject:(NSManagedObject *)insertedObject {
+    return [self requestWithMethod:@"POST" path:[self pathForEntity:insertedObject.entity] parameters:[self representationOfAttributes:[insertedObject dictionaryWithValuesForKeys:[insertedObject.entity.attributesByName allKeys]] ofManagedObject:insertedObject]];
+}
+
+- (NSMutableURLRequest *)requestForUpdatedObject:(NSManagedObject *)updatedObject {
+    NSMutableSet *mutableChangedAttributeKeys = [NSMutableSet setWithArray:[[updatedObject changedValues] allKeys]];
+    [mutableChangedAttributeKeys intersectSet:[NSSet setWithArray:[updatedObject.entity.attributesByName allKeys]]];
+    
+    return [self requestWithMethod:@"PUT" path:[self pathForObject:updatedObject] parameters:[self representationOfAttributes:[[updatedObject changedValues] dictionaryWithValuesForKeys:[mutableChangedAttributeKeys allObjects]] ofManagedObject:updatedObject]];
+}
+
+- (NSMutableURLRequest *)requestForDeletedObject:(NSManagedObject *)deletedObject {
+    return [self requestWithMethod:@"DELETE" path:[self pathForObject:deletedObject] parameters:nil];
+}
+
+#pragma mark - AFHTTPClient
+
+- (void)enqueueBatchOfHTTPRequestOperations:(NSArray *)operations
+                              progressBlock:(void (^)(NSUInteger, NSUInteger))progressBlock
+                            completionBlock:(void (^)(NSArray *))completionBlock
+{
+    for (AFHTTPRequestOperation *operation in operations) {
+        if ([operation isKindOfClass:[AFHTTPRequestOperation class]]) {
+            if (!operation.successCallbackQueue) {
+                operation.successCallbackQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0);
+            }
+            
+            if (!operation.failureCallbackQueue) {
+                operation.failureCallbackQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0);
+            }
+        }
+    }
+    
+    [super enqueueBatchOfHTTPRequestOperations:operations progressBlock:progressBlock completionBlock:completionBlock];
+}
+
+@end
+
+#pragma mark -
+
+@interface AFLimitAndOffsetPaginator ()
+@property (readwrite, nonatomic, copy) NSString *limitParameter;
+@property (readwrite, nonatomic, copy) NSString *offsetParameter;
+@end
+
+@implementation AFLimitAndOffsetPaginator
+
++ (instancetype)paginatorWithLimitParameter:(NSString *)limitParameterName
+                            offsetParameter:(NSString *)offsetParameterName
+{
+    NSParameterAssert(offsetParameterName);
+    NSParameterAssert(limitParameterName);
+    
+    AFLimitAndOffsetPaginator *paginator = [[AFLimitAndOffsetPaginator alloc] init];
+    paginator.limitParameter = limitParameterName;
+    paginator.offsetParameter = offsetParameterName;
+    
+    return paginator;
+}
+
+- (NSDictionary *)parametersForFetchRequest:(NSFetchRequest *)fetchRequest {
+    NSMutableDictionary *mutableParameters = [NSMutableDictionary dictionary];
+    if (fetchRequest.fetchOffset > 0) {
+        [mutableParameters setValue:[NSString stringWithFormat:@"%u", fetchRequest.fetchOffset] forKey:self.offsetParameter];
+    }
+    
+    if (fetchRequest.fetchLimit > 0) {
+        [mutableParameters setValue:[NSString stringWithFormat:@"%u", fetchRequest.fetchLimit] forKey:self.limitParameter];
+    }
+    
+    return mutableParameters;
+}
+
+@end
+
+#pragma mark -
+
+static NSUInteger const kAFPaginationDefaultPage = 1;
+static NSUInteger const kAFPaginationDefaultPerPage = 20;
+
+@interface AFPageAndPerPagePaginator ()
+@property (readwrite, nonatomic, copy) NSString *pageParameter;
+@property (readwrite, nonatomic, copy) NSString *perPageParameter;
+@end
+
+@implementation AFPageAndPerPagePaginator
+
++ (instancetype)paginatorWithPageParameter:(NSString *)pageParameterName
+                          perPageParameter:(NSString *)perPageParameterName
+{
+    NSParameterAssert(pageParameterName);
+    NSParameterAssert(perPageParameterName);
+    
+    AFPageAndPerPagePaginator *paginator = [[AFPageAndPerPagePaginator alloc] init];
+    paginator.pageParameter = pageParameterName;
+    paginator.perPageParameter = perPageParameterName;
+    
+    return paginator;
+}
+
+- (NSDictionary *)parametersForFetchRequest:(NSFetchRequest *)fetchRequest {
+    NSUInteger perPage = fetchRequest.fetchLimit == 0 ? kAFPaginationDefaultPerPage : fetchRequest.fetchLimit;
+    NSUInteger page = fetchRequest.fetchOffset == 0 ? kAFPaginationDefaultPage : (NSUInteger)floorf((float)fetchRequest.fetchOffset / (float)perPage) + 1;
+    
+    NSMutableDictionary *mutableParameters = [NSMutableDictionary dictionary];
+    [mutableParameters setValue:[NSString stringWithFormat:@"%u", page] forKey:self.pageParameter];
+    [mutableParameters setValue:[NSString stringWithFormat:@"%u", perPage] forKey:self.perPageParameter];
+    
+    return mutableParameters;
+}
+
+@end
+
+#pragma mark -
+
+typedef NSDictionary * (^AFPaginationParametersBlock)(NSFetchRequest *fetchRequest);
+
+@interface AFBlockPaginator ()
+@property (readwrite, nonatomic, copy) AFPaginationParametersBlock paginationParameters;
+@end
+
+@implementation AFBlockPaginator
+
++ (instancetype)paginatorWithBlock:(NSDictionary * (^)(NSFetchRequest *fetchRequest))block {
+    NSParameterAssert(block);
+    
+    AFBlockPaginator *paginator = [[AFBlockPaginator alloc] init];
+    paginator.paginationParameters = block;
+    
+    return paginator;
+}
+
+- (NSDictionary *)parametersForFetchRequest:(NSFetchRequest *)fetchRequest {
+    if (self.paginationParameters) {
+        return self.paginationParameters(fetchRequest);
+    }
+    
+    return nil;
+}
+
+@end