Merge branch 'development'

* development:
  update readme
  Renamed modules to make then consistent.
  rename engine init
  tweaks
  Add SocketIOClientConfiguration
  Rename variable
  refactor some reconnect code
  bump websocket version
  move extensions
  refactor out checking for base64

Author: nuclearace

README.md

@@ -5,7 +5,9 @@ Socket.IO-client for iOS/OS X.
 
 ##Example
 ```swift
-let socket = SocketIOClient(socketURL: NSURL(string: "http://localhost:8080")!, options: [.Log(true), .ForcePolling(true)])
+import SocketIO
+
+let socket = SocketIOClient(socketURL: NSURL(string: "http://localhost:8080")!, config: [.Log(true), .ForcePolling(true)])
 
 socket.on("connect") {data, ack in
     print("socket connected")
@@ -26,8 +28,9 @@ socket.connect()
 
 ##Objective-C Example
 ```objective-c
+@import SocketIO;
 NSURL* url = [[NSURL alloc] initWithString:@"http://localhost:8080"];
-SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url options:@{@"log": @YES, @"forcePolling": @YES}];
+SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{@"log": @YES, @"forcePolling": @YES}];
 
 [socket on:@"connect" callback:^(NSArray* data, SocketAckEmitter* ack) {
     NSLog(@"socket connected");
@@ -115,13 +118,13 @@ Import the module:
 
 Swift:
 ```swift
-import SocketIOClientSwift
+import SocketIO
 ```
 
 Objective-C:
 
 ```Objective-C
-@import SocketIOClientSwift;
+@import SocketIO;
 ```
 
 CocoaSeeds
@@ -139,7 +142,7 @@ Run `seed install`.
 ##API
 Constructors
 -----------
-`init(var socketURL: NSURL, options: Set<SocketIOClientOption> = [])` - Creates a new SocketIOClient. options is a Set of SocketIOClientOption. If your socket.io server is secure, you need to specify `https` in your socketURL.
+`init(var socketURL: NSURL, config: SocketIOClientConfiguration = [])` - Creates a new SocketIOClient. options is a Set of SocketIOClientOption. If your socket.io server is secure, you need to specify `https` in your socketURL.
 
 `convenience init(socketURL: NSURL, options: NSDictionary?)` - Same as above, but meant for Objective-C. See Options on how convert between SocketIOClientOptions and dictionary keys.
 

Socket.IO-Client-Swift.xcodeproj/project.pbxproj

@@ -7,7 +7,7 @@
 //
 
 import XCTest
-@testable import SocketIOClientSwift
+@testable import SocketIO
 
 class SocketAckManagerTest: XCTestCase {
     var ackManager = SocketAckManager()

SocketIO-MacTests/SocketAckManagerTest.swift

@@ -7,7 +7,7 @@
 //
 
 import XCTest
-@testable import SocketIOClientSwift
+@testable import SocketIO
 
 class SocketBasicPacketTest: XCTestCase {
     let data = "test".dataUsingEncoding(NSUTF8StringEncoding)!

SocketIO-MacTests/SocketBasicPacketTest.swift

@@ -7,7 +7,7 @@
 //
 
 import XCTest
-@testable import SocketIOClientSwift
+@testable import SocketIO
 
 class SocketEngineTest: XCTestCase {
     var client: SocketIOClient!

SocketIO-MacTests/SocketEngineTest.swift

@@ -0,0 +1,46 @@
+//
+//  TestSocketIOClientConfiguration.swift
+//  Socket.IO-Client-Swift
+//
+//  Created by Erik Little on 8/13/16.
+//
+//
+
+import XCTest
+import SocketIO
+
+class TestSocketIOClientConfiguration: XCTestCase {
+    var config = [] as SocketIOClientConfiguration
+
+    override func setUp() {
+        super.setUp()
+        
+        config = [.Log(false), .ForceNew(true)]
+    }
+
+    func testReplaceSameOption() {
+        config.insert(.Log(true))
+        
+        XCTAssertEqual(config.count, 2)
+        
+        switch config[0] {
+        case let .Log(log):
+            XCTAssertTrue(log)
+        default:
+            XCTFail()
+        }
+    }
+    
+    func testIgnoreIfExisting() {
+        config.insert(.ForceNew(false), replacing: false)
+        
+        XCTAssertEqual(config.count, 2)
+        
+        switch config[1] {
+        case let .ForceNew(new):
+            XCTAssertTrue(new)
+        default:
+            XCTFail()
+        }
+    }
+}

SocketIO-MacTests/SocketIOClientConfigurationTest.swift

@@ -7,7 +7,7 @@
 //
 
 import XCTest
-@testable import SocketIOClientSwift
+@testable import SocketIO
 
 class SocketNamespacePacketTest: XCTestCase {
     let data = "test".dataUsingEncoding(NSUTF8StringEncoding)!

SocketIO-MacTests/SocketNamespacePacketTest.swift

@@ -8,7 +8,7 @@
 //
 
 #import <XCTest/XCTest.h>
-@import SocketIOClientSwift;
+@import SocketIO;
 
 @interface SocketObjectiveCTest : XCTestCase
 
@@ -21,7 +21,7 @@ @implementation SocketObjectiveCTest
 - (void)setUp {
     [super setUp];
     NSURL* url = [[NSURL alloc] initWithString:@"http://localhost"];
-    self.socket = [[SocketIOClient alloc] initWithSocketURL:url options:nil];
+    self.socket = [[SocketIOClient alloc] initWithSocketURL:url config:nil];
 }
 
 - (void)testOnSyntax {

SocketIO-MacTests/SocketObjectiveCTest.m

@@ -7,7 +7,7 @@
 //
 
 import XCTest
-@testable import SocketIOClientSwift
+@testable import SocketIO
 
 class SocketParserTest: XCTestCase {
     let testSocket = SocketIOClient(socketURL: NSURL())

SocketIO-MacTests/SocketParserTest.swift

@@ -7,7 +7,7 @@
 //
 
 import XCTest
-@testable import SocketIOClientSwift
+@testable import SocketIO
 
 class SocketSideEffectTest: XCTestCase {
     let data = "test".dataUsingEncoding(NSUTF8StringEncoding)!

SocketIO-MacTests/SocketSideEffectTest.swift

@@ -88,10 +88,10 @@ public class SSLSecurity : NSObject {
      - returns: a representation security object to be used with
      */
     public init(certs: [SSLCert], usePublicKeys: Bool) {
-        super.init()
-        
         self.usePublicKeys = usePublicKeys
 
+        super.init()
+        
         if self.usePublicKeys {
             dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT,0)) {
                 let pubKeys = certs.reduce([SecKeyRef]()) { (pubKeys: [SecKeyRef], cert: SSLCert) -> [SecKeyRef] in

SocketIO-iOS/SocketIO-iOS.h renamed to SocketIO-iOS/SocketIO.h

@@ -80,11 +80,11 @@ public final class SocketEngine : NSObject, NSURLSessionDelegate, SocketEnginePo
     private var selfSigned = false
     private var voipEnabled = false
 
-    public init(client: SocketEngineClient, url: NSURL, options: Set<SocketIOClientOption>) {
+    public init(client: SocketEngineClient, url: NSURL, config: SocketIOClientConfiguration) {
         self.client = client
         self.url = url
 
-        for option in options {
+        for option in config {
             switch option {
             case let .ConnectParams(params):
                 connectParams = params
@@ -127,7 +127,7 @@ public final class SocketEngine : NSObject, NSURLSessionDelegate, SocketEnginePo
     }
 
     public convenience init(client: SocketEngineClient, url: NSURL, options: NSDictionary?) {
-        self.init(client: client, url: url, options: options?.toSocketOptionsSet() ?? [])
+        self.init(client: client, url: url, config: options?.toSocketConfiguration() ?? [])
     }
 
     deinit {
@@ -153,18 +153,12 @@ public final class SocketEngine : NSObject, NSURLSessionDelegate, SocketEnginePo
         }
     }
 
-    private func checkIfMessageIsBase64Binary(message: String) -> Bool {
-        if message.hasPrefix("b4") {
-            // binary in base64 string
-            let noPrefix = message[message.startIndex.advancedBy(2)..<message.endIndex]
-
-            if let data = NSData(base64EncodedString: noPrefix, options: .IgnoreUnknownCharacters) {
-                client?.parseEngineBinaryData(data)
-            }
-            
-            return true
-        } else {
-            return false
+    private func handleBase64(message: String) {
+        // binary in base64 string
+        let noPrefix = message[message.startIndex.advancedBy(2)..<message.endIndex]
+        
+        if let data = NSData(base64EncodedString: noPrefix, options: .IgnoreUnknownCharacters) {
+            client?.parseEngineBinaryData(data)
         }
     }
 
@@ -265,7 +259,7 @@ public final class SocketEngine : NSObject, NSURLSessionDelegate, SocketEnginePo
             }
         }
 
-        ws?.queue = handleQueue
+        ws?.callbackQueue = handleQueue
         ws?.voipEnabled = voipEnabled
         ws?.delegate = self
         ws?.selfSignedSSL = selfSigned
@@ -419,11 +413,13 @@ public final class SocketEngine : NSObject, NSURLSessionDelegate, SocketEnginePo
 
         let reader = SocketStringReader(message: message)
         let fixedString: String
+        
+        if message.hasPrefix("b4") {
+            return handleBase64(message)
+        }
 
         guard let type = SocketEnginePacketType(rawValue: Int(reader.currentCharacter) ?? -1) else {
-            if !checkIfMessageIsBase64Binary(message) {
-                checkAndHandleEngineError(message)
-            }
+            checkAndHandleEngineError(message)
 
             return
         }

Source/SSLSecurity.swift

@@ -36,11 +36,72 @@ extension Array where Element: AnyObject {
 }
 
 extension NSCharacterSet {
-    class var allowedURLCharacterSet: NSCharacterSet {
+    static var allowedURLCharacterSet: NSCharacterSet {
         return NSCharacterSet(charactersInString: "!*'();:@&=+$,/?%#[]\" {}").invertedSet
     }
 }
 
+extension NSDictionary {
+    private static func keyValueToSocketIOClientOption(key: String, value: AnyObject) -> SocketIOClientOption? {
+        switch (key, value) {
+        case let ("connectParams", params as [String: AnyObject]):
+            return .ConnectParams(params)
+        case let ("cookies", cookies as [NSHTTPCookie]):
+            return .Cookies(cookies)
+        case let ("doubleEncodeUTF8", encode as Bool):
+            return .DoubleEncodeUTF8(encode)
+        case let ("extraHeaders", headers as [String: String]):
+            return .ExtraHeaders(headers)
+        case let ("forceNew", force as Bool):
+            return .ForceNew(force)
+        case let ("forcePolling", force as Bool):
+            return .ForcePolling(force)
+        case let ("forceWebsockets", force as Bool):
+            return .ForceWebsockets(force)
+        case let ("handleQueue", queue as dispatch_queue_t):
+            return .HandleQueue(queue)
+        case let ("log", log as Bool):
+            return .Log(log)
+        case let ("logger", logger as SocketLogger):
+            return .Logger(logger)
+        case let ("nsp", nsp as String):
+            return .Nsp(nsp)
+        case let ("path", path as String):
+            return .Path(path)
+        case let ("reconnects", reconnects as Bool):
+            return .Reconnects(reconnects)
+        case let ("reconnectAttempts", attempts as Int):
+            return .ReconnectAttempts(attempts)
+        case let ("reconnectWait", wait as Int):
+            return .ReconnectWait(wait)
+        case let ("secure", secure as Bool):
+            return .Secure(secure)
+        case let ("security", security as SSLSecurity):
+            return .Security(security)
+        case let ("selfSigned", selfSigned as Bool):
+            return .SelfSigned(selfSigned)
+        case let ("sessionDelegate", delegate as NSURLSessionDelegate):
+            return .SessionDelegate(delegate)
+        case let ("voipEnabled", enable as Bool):
+            return .VoipEnabled(enable)
+        default:
+            return nil
+        }
+    }
+    
+    func toSocketConfiguration() -> SocketIOClientConfiguration {
+        var options = [] as SocketIOClientConfiguration
+        
+        for (rawKey, value) in self {
+            if let key = rawKey as? String, opt = NSDictionary.keyValueToSocketIOClientOption(key, value: value) {
+                options.insert(opt)
+            }
+        }
+        
+        return options
+    }
+}
+
 extension String {
     func toArray() throws -> [AnyObject] {
         guard let stringData = dataUsingEncoding(NSUTF8StringEncoding, allowLossyConversion: false) else { return [] }