[ios, osx] Consolidate remaining files in platform/{ios,osx}

2 files changed, 338 insertions, 0 deletions

diff --git a/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h b/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h
new file mode 100644
index 0000000000..77fe65e892
--- /dev/null
+++ b/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h
@@ -0,0 +1,100 @@
+/***********************************************************************************
+ *
+ * Copyright (c) 2015 Jinlian (Sunny) Wang
+ *
+ * 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 <OHHTTPStubs/OHHTTPStubs.h>
+#import <OHHTTPStubs/Compatibility.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Error codes for the OHHTTPStubs Mocktail category
+ */
+typedef NS_ENUM(NSInteger, OHHTTPStubsMocktailError) {
+    /** The specified path does not exist */
+    OHHTTPStubsMocktailErrorPathDoesNotExist = 1,
+    /** The specified path was not readable */
+    OHHTTPStubsMocktailErrorPathFailedToRead,
+    /** The specified path is not a directory */
+    OHHTTPStubsMocktailErrorPathIsNotFolder,
+    /** The specified file is not a valid Mocktail file */
+    OHHTTPStubsMocktailErrorInvalidFileFormat,
+    /** The specified Mocktail file has invalid headers */
+    OHHTTPStubsMocktailErrorInvalidFileHeader,
+    /** An unexpected internal error occured */
+    OHHTTPStubsMocktailErrorInternalError
+};
+
+extern NSString* const MocktailErrorDomain;
+
+@interface OHHTTPStubs (Mocktail)
+
+/**
+ * Add a stub given a file in the format of Mocktail as defined at https://github.com/square/objc-mocktail.
+ *
+ * This method will split the HTTP method Regex, the absolute URL Regex, the headers, the HTTP status code and
+ * response body, and use them to add a stub.
+ *
+ * @param fileName The name of the mocktail file (without extension of '.tail') in the Mocktail format.
+ * @param bundleOrNil The bundle in which the mocktail file is located. If `nil`, the `[NSBundle bundleForClass:self.class]` will be used.
+ * @param error An out value that returns any error encountered during stubbing. Returns an NSError object if any error; otherwise returns nil.
+ *
+ * @return a stub descriptor that uniquely identifies the stub and can be later used to remove it with
+ * `removeStub:`.
+ */
++(id<OHHTTPStubsDescriptor>)stubRequestsUsingMocktailNamed:(NSString *)fileName inBundle:(nullable NSBundle*)bundleOrNil error:(NSError **)error;
+
+/**
+ * Add a stub given a file URL in the format of Mocktail as defined at https://github.com/square/objc-mocktail.
+ *
+ * This method will split the HTTP method Regex, the absolute URL Regex, the headers, the HTTP status code and
+ * response body, and use them to add a stub.
+ *
+ * @param fileURL The URL pointing to the file in the Mocktail format.
+ * @param error An out value that returns any error encountered during stubbing. Returns an NSError object if any error; otherwise returns nil.
+ *
+ * @return a stub descriptor that uniquely identifies the stub and can be later used to remove it with
+ * `removeStub:`.
+ */
++(id<OHHTTPStubsDescriptor>)stubRequestsUsingMocktail:(NSURL *)fileURL error:(NSError **)error;
+
+/**
+ * Add stubs using files under a folder in the format of Mocktail as defined at https://github.com/square/objc-mocktail.
+ *
+ * This method will retrieve all the files under the folder; for each file with surfix of ".tail", it will split the HTTP method Regex, the absolute URL Regex, the headers, the HTTP status code and response body, and use them to add a stub.
+ *
+ * @param path The name of the folder containing files in the Mocktail format.
+ * @param bundleOrNil The bundle in which the path is located. If `nil`, the `[NSBundle bundleForClass:self.class]` will be used.
+ * @param error An out value that returns any error encountered during stubbing. Returns an NSError object if any error; otherwise returns nil.
+ *
+ * @return an array of stub descriptor that uniquely identifies the stub and can be later used to remove it with
+ * `removeStub:`.
+ */
++(NSArray *)stubRequestsUsingMocktailsAtPath:(NSString *)path inBundle:(nullable NSBundle*)bundleOrNil error:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.m b/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.m
new file mode 100644
index 0000000000..4de8996ae0
--- /dev/null
+++ b/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.m
@@ -0,0 +1,238 @@
+/***********************************************************************************
+ *
+ * Copyright (c) 2015 Jinlian (Sunny) Wang
+ *
+ * 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 <OHHTTPStubs/OHHTTPStubs+Mocktail.h>
+
+NSString* const MocktailErrorDomain = @"Mocktail";
+
+@implementation OHHTTPStubs (Mocktail)
+
+
++(NSArray *)stubRequestsUsingMocktailsAtPath:(NSString *)path inBundle:(nullable NSBundle*)bundleOrNil error:(NSError **)error
+{
+    NSURL *dirURL = [bundleOrNil?:[NSBundle bundleForClass:self.class] URLForResource:path withExtension:nil];
+    if (!dirURL)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathDoesNotExist userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Path '%@' does not exist.", path]}];
+        }
+        return nil;
+    }
+    
+    // Make sure path points to a directory
+    NSNumber *isDirectory;
+    BOOL success = [dirURL getResourceValue:&isDirectory forKey:NSURLIsDirectoryKey error:nil];
+    BOOL isDir = (success && [isDirectory boolValue]);
+    
+    if (!isDir)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathIsNotFolder userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Path '%@' is not a folder.", path]}];
+        }
+        return nil;
+    }
+    
+    // Read the content of the directory
+    NSError *bError = nil;
+    NSFileManager *fileManager = [NSFileManager defaultManager];
+    NSArray *fileURLs = [fileManager contentsOfDirectoryAtURL:dirURL includingPropertiesForKeys:nil options:0 error:&bError];
+
+    if (bError)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathFailedToRead userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error reading path '%@'.", dirURL.absoluteString]}];
+        }
+        return nil;
+    }
+    
+    //stub the Mocktail-formatted requests
+    NSMutableArray *descriptorArray = [[NSMutableArray alloc] initWithCapacity:fileURLs.count];
+    for (NSURL *fileURL in fileURLs)
+    {
+        if (![fileURL.absoluteString hasSuffix:@".tail"])
+        {
+            continue;
+        }
+        id<OHHTTPStubsDescriptor> descriptor = [[self class] stubRequestsUsingMocktail:fileURL error: &bError];
+        if (descriptor && !bError)
+        {
+            [descriptorArray addObject:descriptor];
+        }
+    }
+    
+    return descriptorArray;
+}
+
++(id<OHHTTPStubsDescriptor>)stubRequestsUsingMocktailNamed:(NSString *)fileName inBundle:(nullable NSBundle*)bundleOrNil error:(NSError **)error
+{
+    NSURL *responseURL = [bundleOrNil?:[NSBundle bundleForClass:self.class] URLForResource:fileName withExtension:@"tail"];
+    
+    if (!responseURL)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathDoesNotExist userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' does not exist.", fileName]}];
+        }
+        return nil;
+    }
+    else
+    {
+        return [[self class] stubRequestsUsingMocktail:responseURL error:error];
+    }
+}
+
++(id<OHHTTPStubsDescriptor>)stubRequestsUsingMocktail:(NSURL *)fileURL error:(NSError **)error
+{
+    NSError *bError = nil;
+    NSStringEncoding originalEncoding;
+    NSString *contentsOfFile = [NSString stringWithContentsOfURL:fileURL usedEncoding:&originalEncoding error:&bError];
+    
+    if (!contentsOfFile || bError)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathFailedToRead userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' does not read.", fileURL.absoluteString]}];
+        }
+        return nil;
+    }
+    
+    NSScanner *scanner = [NSScanner scannerWithString:contentsOfFile];
+    NSString *headerMatter = nil;
+    [scanner scanUpToString:@"\n\n" intoString:&headerMatter];
+    NSArray *lines = [headerMatter componentsSeparatedByString:@"\n"];
+    if (lines.count < 4)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileFormat userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid amount of lines:%u.", fileURL.absoluteString, (unsigned)lines.count]}];
+        }
+        return nil;
+    }
+    
+    /* Handle Mocktail format, adapted from Mocktail implementation
+       For more details on the file format, check out: https://github.com/square/objc-Mocktail */
+    NSRegularExpression *methodRegex = [NSRegularExpression regularExpressionWithPattern:lines[0] options:NSRegularExpressionCaseInsensitive error:&bError];
+    
+    if (bError)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileFormat userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid method regular expression pattern: %@.", fileURL.absoluteString,  lines[0]]}];
+        }
+        return nil;
+    }
+    
+    NSRegularExpression *absoluteURLRegex = [NSRegularExpression regularExpressionWithPattern:lines[1] options:NSRegularExpressionCaseInsensitive error:&bError];
+    
+    if (bError)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileFormat userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid URL regular expression pattern: %@.", fileURL.absoluteString,  lines[1]]}];
+        }
+        return nil;
+    }
+    
+    NSInteger statusCode = [lines[2] integerValue];
+    
+    NSMutableDictionary *headers = @{@"Content-Type":lines[3]}.mutableCopy;
+    
+    // From line 5 to '\n\n', expect HTTP response headers.
+    NSRegularExpression *headerPattern = [NSRegularExpression regularExpressionWithPattern:@"^([^:]+):\\s+(.*)" options:0 error:&bError];
+    if (bError)
+    {
+        if (error)
+        {
+            *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInternalError userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Internal error while stubbing file '%@'.", fileURL.absoluteString]}];
+        }
+        return nil;
+    }
+    
+    for (NSUInteger line = 4; line < lines.count; line ++) {
+        NSString *headerLine = lines[line];
+        NSTextCheckingResult *match = [headerPattern firstMatchInString:headerLine options:0 range:NSMakeRange(0, headerLine.length)];
+        
+        if (match)
+        {
+            NSString *key = [headerLine substringWithRange:[match rangeAtIndex:1]];
+            NSString *value = [headerLine substringWithRange:[match rangeAtIndex:2]];
+            headers[key] = value;
+        }
+        else
+        {
+            if (error)
+            {
+                *error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileHeader userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid header: %@.", fileURL.absoluteString, headerLine]}];
+            }
+            return nil;
+        }
+    }
+    
+    // Handle binary which is base64 encoded
+    NSUInteger bodyOffset = [headerMatter dataUsingEncoding:NSUTF8StringEncoding].length + 2;
+    
+    return [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
+        NSString *absoluteURL = (request.URL).absoluteString;
+        NSString *method = request.HTTPMethod;
+        
+        if ([absoluteURLRegex numberOfMatchesInString:absoluteURL options:0 range:NSMakeRange(0, absoluteURL.length)] > 0)
+        {
+            if ([methodRegex numberOfMatchesInString:method options:0 range:NSMakeRange(0, method.length)] > 0)
+            {
+                return YES;
+            }
+        }
+        
+        return NO;
+    } withStubResponse:^OHHTTPStubsResponse*(NSURLRequest *request) {
+        if([headers[@"Content-Type"] hasSuffix:@";base64"])
+        {
+            NSString *type = headers[@"Content-Type"];
+            NSString *newType = [type substringWithRange:NSMakeRange(0, type.length - 7)];
+            headers[@"Content-Type"] = newType;
+            
+            NSData *body = [NSData dataWithContentsOfURL:fileURL];
+            body = [body subdataWithRange:NSMakeRange(bodyOffset, body.length - bodyOffset)];
+            body = [[NSData alloc] initWithBase64EncodedData:body options:NSDataBase64DecodingIgnoreUnknownCharacters];
+            
+            OHHTTPStubsResponse *response = [OHHTTPStubsResponse responseWithData:body statusCode:(int)statusCode headers:headers];
+            return response;
+        }
+        else
+        {
+            OHHTTPStubsResponse *response = [OHHTTPStubsResponse responseWithFileAtPath:fileURL.path
+                                                                             statusCode:(int)statusCode headers:headers];
+            [response.inputStream setProperty:@(bodyOffset) forKey:NSStreamFileCurrentOffsetKey];
+            return response;
+        }
+    }];
+}
+
+@end