Convert apikit from submodule

Author: Joey Lorich

EasyReader/Library/apikit

@@ -0,0 +1,69 @@
+//
+//  AKRoute.h
+//  APIKit Router
+//
+//  Created by Joseph Lorich on 3/19/14.
+//  Copyright (c) 2014 Joseph Lorich.
+//
+// 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 <Foundation/Foundation.h>
+
+typedef enum {
+    kAKRequestMethodGET,
+    kAKRequestMethodPOST,
+    kAKRequestMethodPUT,
+    kAKRequestMethodDELETE
+} AKRequestMethod;
+
+
+/**
+ * An API Route
+ */
+@interface AKRoute : NSObject
+
+
+#pragma mark - Properties
+
+/// The string representation for the url for this route
+@property (nonatomic, readonly) NSString *path;
+
+/// The request method for this route
+@property (nonatomic, readonly) AKRequestMethod requestMethod;
+
+
+#pragma mark - Initializers
+
+/**
+ * Initializes a new CSApiRoute
+ *
+ * @param path the path for this URL
+ * @param requestMethod the request method for this route
+ */
+- (id)initWithPath:(NSString *)path requestMethod:(AKRequestMethod)requestMethod;
+
+
+/**
+ * Builds a URL String for a given set of params
+ *
+ * @param params The URL Parameters
+ */
+- (NSString *)pathStringForParams:(NSDictionary *)params;
+
+@end

EasyReader/Library/apikit/AKRoute.h

@@ -0,0 +1,79 @@
+//
+//  AKRoute.m
+//  APIKit Router
+//
+//  Created by Joseph Lorich on 3/19/14.
+//  Copyright (c) 2014 Joseph Lorich.
+//
+// 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 "AKRoute.h"
+
+@implementation AKRoute
+{
+    NSString *_path;
+    AKRequestMethod _requestMethod;
+}
+
+- (id)initWithPath:(NSString *)path requestMethod:(AKRequestMethod)requestMethod
+{
+    self = [super init];
+    
+    if (self)
+    {
+        _path = path;
+        _requestMethod = requestMethod;
+    }
+    
+    return self;
+}
+
+- (NSString *)pathStringForParams:(NSDictionary *)params
+{
+    return [self replaceTokensInPath:_path params:params];
+}
+
+/**
+ * Replaces all slug tokens (e.g. ":first_name") in a path with their appropriate param
+ *
+ * @param urlString the base path to parse
+ * @param params the parameters for the URL
+ */
+- (NSString *)replaceTokensInPath:(NSString*)urlString params:(NSDictionary *)params
+{
+    NSMutableString *parsedString = [urlString mutableCopy];
+    
+    for (NSString *param in [params allKeys])
+    {
+        id value = [params valueForKey:param];
+        
+        NSString *paramType = NSStringFromClass([value class]);
+        
+        if ([paramType isEqualToString:@"NSString"])
+        {
+            NSString *token = [NSString stringWithFormat:@":%@", param];
+            [parsedString stringByReplacingOccurrencesOfString:token withString:value];
+        }
+    }
+    
+    return parsedString;
+}
+
+
+@end

EasyReader/Library/apikit/AKRoute.m

@@ -0,0 +1,80 @@
+//
+//  AKRouter.h
+//  APIKit Router
+//
+//  Created by Joseph Lorich on 3/19/14.
+//  Copyright (c) 2014 Joseph Lorich.
+//
+// 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 <Foundation/Foundation.h>
+#import "AKRoute.h"
+
+/**
+ * An interface to create and process named routes for URLs
+ */
+@interface AKRouter : NSObject
+
+
+/**
+ * Returns a shared singleton router instance
+ */
++ (AKRouter *) shared;
+
+/**
+ * Registers a new route with the router
+ *
+ * @param routeName The route name string
+ * @param path The path for the route
+ * @param requestMethod the Request Method
+ */
+- (void)registerRoute:(NSString *)routeName path:(NSString *)path requestMethod:(AKRequestMethod)requestMethod;
+
+
+/**
+ * Builds an NSURL Based on the route name and parameters
+ *
+ * @param routeName the API Route Name
+ * @param params paramaters to be used in building the API route
+ */
+- (NSURL *)urlFor:(NSString *)routeName params:(NSDictionary *)params;
+
+/**
+ * Builds an NSString path based on the route name and parameters
+ *
+ * @param routeName the API Route Name
+ * @param params paramaters to be used in building the API route
+ */
+- (NSString *)pathFor:(NSString *)routeName params:(NSDictionary *)params;
+
+/**
+ * Returns the request method for the given route
+ *
+ * @param routeName the API Route Name
+ */
+- (AKRequestMethod)methodFor:(NSString *)routeName;
+
+/**
+ * Gets the route object for the given route name
+ *
+ * @param routeName The routes name
+ */
+- (AKRoute *)routeForName:(NSString*)routeName;
+
+@end

EasyReader/Library/apikit/AKRouter.h

@@ -0,0 +1,163 @@
+//
+//  AKRouter.m
+//  APIKit Router
+//
+//  Created by Joseph Lorich on 3/19/14.
+//  Copyright (c) 2014 Joseph Lorich.
+//
+// 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 "AKRouter.h"
+
+static dispatch_once_t pred;
+static AKRouter *shared = nil;
+
+@implementation AKRouter
+{
+    /// Internal route storage dictionary
+    NSMutableDictionary *_routes;
+    
+    /// The base API URL
+    NSURL *_baseURL;
+    
+    /// The base API Path
+    NSString *_basePath;
+}
+
++ (AKRouter *)shared
+{
+    dispatch_once(&pred, ^{
+        // Ensure we don't overwrite a manually set client
+        if (shared != nil) return;
+        
+        // Load API configuration data from the info plist
+        NSBundle *bundle = [NSBundle mainBundle];
+        
+        NSString *apiHost  = [bundle objectForInfoDictionaryKey:@"ApiHost"];
+        NSString *basePath  = [bundle objectForInfoDictionaryKey:@"ApiBasePath"];
+        
+        shared = [[AKRouter alloc] initWithAPIHost:apiHost basePath:basePath];
+    });
+    
+    return shared;
+}
+
+- (id)initWithAPIHost:(NSString *)apiHost basePath:(NSString*)basePath
+{
+    self = [super init];
+    
+    if (self)
+    {
+        _routes = [[NSMutableDictionary alloc] init];
+        _baseURL   = [NSURL URLWithString:apiHost];
+        _basePath = basePath;
+    }
+    
+    return self;
+}
+
+- (void)registerRoute:(NSString *)routeName path:(NSString *)path requestMethod:(AKRequestMethod)requestMethod
+{
+    if ([[_routes allKeys] containsObject:routeName])
+    {
+        [NSException raise:@"Route already exists" format:@"The route named %@ already is registered", routeName];
+        return;
+    }
+    
+    AKRoute *route = [[AKRoute alloc] initWithPath:path requestMethod:requestMethod];
+    
+    [_routes setValue:route forKey:routeName];
+}
+
+- (NSURL *)urlFor:(NSString *)routeName params:(NSDictionary *)params
+{
+    NSString *path = [self pathFor:routeName params:params];
+    
+    if (!path)
+    {
+        return nil;
+    }
+    
+    return [NSURL URLWithString:path relativeToURL:_baseURL];
+}
+
+- (NSString *)pathFor:(NSString *)routeName params:(NSDictionary *)params
+{
+    AKRoute *route = [self routeForName:routeName];
+    NSString *pathString = [route pathStringForParams:params];
+
+   return [NSString stringWithFormat:@"%@/%@",
+          [self stripTrainingSlashes:_basePath],
+           [self stripLeadingSlashes:pathString]];
+}
+
+- (AKRequestMethod)methodFor:(NSString *)routeName
+{
+    AKRoute *route = [self routeForName:routeName];
+    
+    return [route requestMethod];
+}
+
+- (AKRoute *)routeForName:(NSString *)routeName
+{
+    return [_routes valueForKey:routeName];
+}
+
+
+#pragma mark - Private Methods
+
+/**
+ * Strips any trailing '/' from the end of a string
+ *
+ * This is used to help parse out paths
+ */
+- (NSString *)stripTrainingSlashes:(NSString *)string
+{
+    NSInteger stringLength = [string length];
+    
+    if ([string characterAtIndex:stringLength - 1] == '/')
+    {
+        return [self stripTrainingSlashes:[string substringWithRange:NSMakeRange(0, stringLength - 1)]];
+    }
+    else
+    {
+        return string;
+    }
+}
+
+/**
+ * Strips any leading '/' from the beginning of a string
+ *
+ * This is used to help parse out paths
+ */
+- (NSString *)stripLeadingSlashes:(NSString *)string
+{
+    if ([string characterAtIndex:0] == '/')
+    {
+        NSInteger stringLength = [string length];
+        return [self stripLeadingSlashes:[string substringWithRange:NSMakeRange(1, stringLength-2)]];
+    }
+    else
+    {
+        return string;
+    }
+}
+
+
+@end