Merge branch 'development'

* development:
  bump websocket version
  bump websocket version
  Fix #521
  add options to objective-c test
  add link to spm example
  remove redundant cast
  remove redundant cast
  Redo emitWithAck API since in Swift 3 parameter names aren't apart of the type

Author: nuclearace

README.md

@@ -6,6 +6,7 @@ Socket.IO-client for iOS/OS X.
 ##Example
 ```swift
 import SocketIO
+
 let socket = SocketIOClient(socketURL: URL(string: "http://localhost:8080")!, config: [.log(true), .forcePolling(true)])
 
 socket.on("connect") {data, ack in
@@ -14,7 +15,7 @@ socket.on("connect") {data, ack in
 
 socket.on("currentAmount") {data, ack in
     if let cur = data[0] as? Double {
-        socket.emitWithAck("canUpdate", cur)(0) {data in
+        socket.emitWithAck("canUpdate", cur).timingOut(after: 0) {data in
             socket.emit("update", ["amount": cur + 2.50])
         }
 
@@ -40,7 +41,7 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{
 
     [socket emitWithAck:@"canUpdate" with:@[@(cur)]](0, ^(NSArray* data) {
         [socket emit:@"update" withItems:@[@{@"amount": @(cur + 2.50)}]];
-    });
+    }];
 
     [ack with:@[@"Got your currentAmount, ", @"dude"]];
 }];
@@ -94,7 +95,7 @@ Carthage
 -----------------
 Add this line to your `Cartfile`:
 ```
-github "socketio/socket.io-client-swift" ~> 8.0.2 # Or latest version
+github "socketio/socket.io-client-swift" ~> 8.0.3 # Or latest version
 ```
 
 Run `carthage update --platform ios,macosx`.
@@ -107,7 +108,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
 use_frameworks!
 
 target 'YourApp' do
-    pod 'Socket.IO-Client-Swift', '~> 8.0.2' # Or latest version
+    pod 'Socket.IO-Client-Swift', '~> 8.0.3' # Or latest version
 end
 ```
 
@@ -136,7 +137,7 @@ CocoaSeeds
 Add this line to your `Seedfile`:
 
 ```
-github "socketio/socket.io-client-swift", "v8.0.2", :files => "Source/*.swift" # Or latest version
+github "socketio/socket.io-client-swift", "v8.0.3", :files => "Source/*.swift" # Or latest version
 ```
 
 Run `seed install`.
@@ -182,8 +183,8 @@ Methods
 3. `onAny(callback:((event: String, items: AnyObject?)) -> Void)` - Adds a handler for all events. It will be called on any received event.
 4. `emit(_ event: String, _ items: AnyObject...)` - Sends a message. Can send multiple items.
 5. `emit(_ event: String, withItems items: [AnyObject])` - `emit` for Objective-C
-6. `emitWithAck(_ event: String, _ items: AnyObject...) -> (timeoutAfter: UInt64, callback: (NSArray?) -> Void) -> Void` - Sends a message that requests an acknowledgement from the server. Returns a function which you can use to add a handler. See example. Note: The message is not sent until you call the returned function.
-7. `emitWithAck(_ event: String, withItems items: [AnyObject]) -> (UInt64, (NSArray?) -> Void) -> Void` - `emitWithAck` for Objective-C. Note: The message is not sent until you call the returned function.
+6. `emitWithAck(_ event: String, _ items: AnyObject...) -> OnAckCallback` - Sends a message that requests an acknowledgement from the server. Returns an object which you can use to add a handler. See example. Note: The message is not sent until you call timingOut(after:) on the returned object.
+7. `emitWithAck(_ event: String, withItems items: [AnyObject]) -> OnAckCallback` - `emitWithAck` for Objective-C. Note: The message is not sent until you call timingOutAfter on the returned object.
 8. `connect()` - Establishes a connection to the server. A "connect" event is fired upon successful connection.
 9. `connect(timeoutAfter timeoutAfter: Int, withTimeoutHandler handler: (() -> Void)?)` - Connect to the server. If it isn't connected after timeoutAfter seconds, the handler is called.
 10. `disconnect()` - Closes the socket. Reopening a disconnected socket is not fully tested.
@@ -205,5 +206,7 @@ Client Events
 ##Detailed Example
 A more detailed example can be found [here](https://github.com/nuclearace/socket.io-client-swift-example)
 
+An example using the Swift Package Manager can be found [here](https://github.com/nuclearace/socket.io-client-swift-spm-example)
+
 ##License
 MIT

Socket.IO-Client-Swift.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Socket.IO-Client-Swift"
   s.module_name  = "SocketIO"
-  s.version      = "8.0.2"
+  s.version      = "8.0.3"
   s.summary      = "Socket.IO-client for iOS and OS X"
   s.description  = <<-DESC
                    Socket.IO-client for iOS and OS X.
@@ -14,7 +14,7 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '8.0'
   s.osx.deployment_target = '10.10'
   s.tvos.deployment_target = '9.0'
-  s.source       = { :git => "https://github.com/socketio/socket.io-client-swift.git", :tag => 'v8.0.2' }
+  s.source       = { :git => "https://github.com/socketio/socket.io-client-swift.git", :tag => 'v8.0.3' }
   s.source_files  = "Source/**/*.swift"
   s.requires_arc = true
   # s.dependency 'Starscream', '~> 0.9' # currently this repo includes Starscream swift files

SocketIO-MacTests/SocketObjectiveCTest.m

@@ -21,7 +21,7 @@ @implementation SocketObjectiveCTest
 - (void)setUp {
     [super setUp];
     NSURL* url = [[NSURL alloc] initWithString:@"http://localhost"];
-    self.socket = [[SocketIOClient alloc] initWithSocketURL:url config:nil];
+    self.socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{@"log": @YES, @"forcePolling": @YES}];
 }
 
 - (void)testOnSyntax {
@@ -35,9 +35,9 @@ - (void)testEmitSyntax {
 }
 
 - (void)testEmitWithAckSyntax {
-    [self.socket emitWithAck:@"testAckEmit" with:@[@YES]](0, ^(NSArray* data) {
+    [[self.socket emitWithAck:@"testAckEmit" with:@[@YES]] timingOutAfter:0 callback:^(NSArray* data) {
 
-    });
+    }];
 }
 
 - (void)testOffSyntax {

SocketIO-MacTests/SocketSideEffectTest.swift

@@ -25,20 +25,20 @@ class SocketSideEffectTest: XCTestCase {
     }
 
     func testFirstAck() {
-        socket.emitWithAck("test")(0) {data in}
+        socket.emitWithAck("test").timingOut(after: 0) {data in}
         XCTAssertEqual(socket.currentAck, 0)
     }
 
     func testSecondAck() {
-        socket.emitWithAck("test")(0) {data in}
-        socket.emitWithAck("test")(0) {data in}
+        socket.emitWithAck("test").timingOut(after: 0) {data in}
+        socket.emitWithAck("test").timingOut(after: 0) {data in}
 
         XCTAssertEqual(socket.currentAck, 1)
     }
 
     func testHandleAck() {
         let expect = expectation(description: "handled ack")
-        socket.emitWithAck("test")(0) {data in
+        socket.emitWithAck("test").timingOut(after: 0) {data in
             XCTAssertEqual(data[0] as? String, "hello world")
             expect.fulfill()
         }
@@ -49,7 +49,7 @@ class SocketSideEffectTest: XCTestCase {
 
     func testHandleAck2() {
         let expect = expectation(description: "handled ack2")
-        socket.emitWithAck("test")(0) {data in
+        socket.emitWithAck("test").timingOut(after: 0) {data in
             XCTAssertTrue(data.count == 2, "Wrong number of ack items")
             expect.fulfill()
         }

Source/SSLSecurity.swift

@@ -4,7 +4,7 @@
 //  Starscream
 //
 //  Created by Dalton Cherry on 5/16/15.
-//  Copyright (c) 2014-2015 Dalton Cherry.
+//  Copyright (c) 2014-2016 Dalton Cherry.
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
@@ -19,11 +19,14 @@
 //  limitations under the License.
 //
 //////////////////////////////////////////////////////////////////////////////////////////////////
-
 import Foundation
 import Security
 
-public class SSLCert : NSObject {
+public protocol SSLTrustValidator {
+    func isValid(_ trust: SecTrust, domain: String?) -> Bool
+}
+
+open class SSLCert {
     var certData: Data?
     var key: SecKey?
 
@@ -50,7 +53,7 @@ public class SSLCert : NSObject {
     }
 }
 
-public class SSLSecurity : NSObject {
+open class SSLSecurity : SSLTrustValidator {
     public var validatedDN = true //should the domain name be validated?
 
     var isReady = false //is the key processing done?
@@ -82,16 +85,14 @@ public class SSLSecurity : NSObject {
     /**
      Designated init
 
-     - parameter keys: is the certificates or public keys to use
+     - parameter certs: is the certificates or public keys to use
      - parameter usePublicKeys: is to specific if the publicKeys or certificates should be used for SSL pinning validation
 
      - returns: a representation security object to be used with
      */
     public init(certs: [SSLCert], usePublicKeys: Bool) {
         self.usePublicKeys = usePublicKeys
 
-        super.init()
-        
         if self.usePublicKeys {
             DispatchQueue.global(qos: .default).async {
                 let pubKeys = certs.reduce([SecKey]()) { (pubKeys: [SecKey], cert: SSLCert) -> [SecKey] in

Source/SocketAckEmitter.swift

@@ -45,3 +45,38 @@ public final class SocketAckEmitter : NSObject {
         socket.emitAck(ackNum, with: items)
     }
 }
+
+public final class OnAckCallback : NSObject {
+    private let ackNumber: Int
+    private let items: [Any]
+    private weak var socket: SocketIOClient?
+    
+    init(ackNumber: Int, items: [Any], socket: SocketIOClient) {
+        self.ackNumber = ackNumber
+        self.items = items
+        self.socket = socket
+    }
+    
+    deinit {
+        DefaultSocketLogger.Logger.log("OnAckCallback for \(ackNumber) being released", type: "OnAckCallback")
+    }
+    
+    public func timingOut(after seconds: Int, callback: @escaping AckCallback) {
+        guard let socket = self.socket else { return }
+        
+        socket.ackQueue.sync() {
+            socket.ackHandlers.addAck(ackNumber, callback: callback)
+        }
+        
+        socket._emit(items, ack: ackNumber)
+        
+        guard seconds != 0 else { return }
+        
+        let time = DispatchTime.now() + Double(UInt64(seconds) * NSEC_PER_SEC) / Double(NSEC_PER_SEC)
+        
+        socket.handleQueue.asyncAfter(deadline: time) {
+            socket.ackHandlers.timeoutAck(self.ackNumber, onQueue: socket.handleQueue)
+        }
+    }
+    
+}

Source/SocketIOClient.swift

@@ -46,21 +46,22 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable
     public var reconnects = true
     public var reconnectWait = 10
 
-    private let ackQueue = DispatchQueue(label: "com.socketio.ackQueue", attributes: [])
-    private let emitQueue = DispatchQueue(label: "com.socketio.emitQueue", attributes: [])
     private let logType = "SocketIOClient"
-    private let parseQueue = DispatchQueue(label: "com.socketio.parseQueue", attributes: [])
+    private let parseQueue = DispatchQueue(label: "com.socketio.parseQueue")
 
     private var anyHandler: ((SocketAnyEvent) -> Void)?
     private var currentReconnectAttempt = 0
     private var handlers = [SocketEventHandler]()
-    private var ackHandlers = SocketAckManager()
     private var reconnecting = false
 
     private(set) var currentAck = -1
     private(set) var handleQueue = DispatchQueue.main
     private(set) var reconnectAttempts = -1
+    
+    let ackQueue = DispatchQueue(label: "com.socketio.ackQueue")
+    let emitQueue = DispatchQueue(label: "com.socketio.emitQueue")
 
+    var ackHandlers = SocketAckManager()
     var waitingPackets = [SocketPacket]()
 
     public var sid: String? {
@@ -148,7 +149,7 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable
 
         guard timeoutAfter != 0 else { return }
 
-        let time = DispatchTime.now() + Double(Int64(timeoutAfter) * Int64(NSEC_PER_SEC)) / Double(NSEC_PER_SEC)
+        let time = DispatchTime.now() + Double(UInt64(timeoutAfter) * NSEC_PER_SEC) / Double(NSEC_PER_SEC)
 
         handleQueue.asyncAfter(deadline: time) {[weak self] in
             guard let this = self, this.status != .connected && this.status != .disconnected else { return }
@@ -163,24 +164,7 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable
     private func createOnAck(_ items: [Any]) -> OnAckCallback {
         currentAck += 1
 
-        return {[weak self, ack = currentAck] timeout, callback in
-            guard let this = self else { return }
-
-            this.ackQueue.sync() {
-                this.ackHandlers.addAck(ack, callback: callback)
-            }
-            
-            
-            this._emit(items, ack: ack)
-            
-            if timeout != 0 {
-                let time = DispatchTime.now() + Double(Int64(timeout * NSEC_PER_SEC)) / Double(NSEC_PER_SEC)
-                
-                this.handleQueue.asyncAfter(deadline: time) {
-                    this.ackHandlers.timeoutAck(ack, onQueue: this.handleQueue)
-                }
-            }
-        }
+        return OnAckCallback(ackNumber: currentAck, items: items, socket: self)
     }
 
     func didConnect() {
@@ -238,7 +222,7 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable
         return createOnAck([event] + items)
     }
 
-    private func _emit(_ data: [Any], ack: Int? = nil) {
+    func _emit(_ data: [Any], ack: Int? = nil) {
         emitQueue.async {
             guard self.status == .connected else {
                 self.handleEvent("error", data: ["Tried emitting when not connected"], isInternalMessage: true)
@@ -269,7 +253,9 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable
     }
 
     public func engineDidClose(reason: String) {
-        waitingPackets.removeAll()
+        parseQueue.sync {
+            self.waitingPackets.removeAll()
+        }
 
         if status != .disconnected {
             status = .notConnected

Source/SocketPacket.swift

@@ -87,25 +87,18 @@ struct SocketPacket {
     }
 
     private func completeMessage(_ message: String) -> String {
-        let restOfMessage: String
-        
         if data.count == 0 {
             return message + "[]"
         }
 
-        do {
-            let jsonSend = try data.toJSON()
-            guard let jsonString = String(data: jsonSend, encoding: .utf8) else { return message + "[]" }
-            
-            restOfMessage = jsonString
-        } catch {
+        guard let jsonSend = try? data.toJSON(), let jsonString = String(data: jsonSend, encoding: .utf8) else {
             DefaultSocketLogger.Logger.error("Error creating JSON object in SocketPacket.completeMessage",
-                type: SocketPacket.logType)
+                                             type: SocketPacket.logType)
 
-            restOfMessage = "[]"
+            return message + "[]"
         }
 
-        return message + restOfMessage
+        return message + jsonString
     }
 
     private func createPacketString() -> String {
@@ -133,11 +126,11 @@ struct SocketPacket {
     // binary data
     private func _fillInPlaceholders(_ object: Any) -> Any {
         switch object {
-        case let dict as [String: Any]:
+        case let dict as JSON:
             if dict["_placeholder"] as? Bool ?? false {
                 return binary[dict["num"] as! Int]
             } else {
-                return dict.reduce([String: Any](), {cur, keyValue in
+                return dict.reduce(JSON(), {cur, keyValue in
                     var cur = cur
 
                     cur[keyValue.0] = _fillInPlaceholders(keyValue.1)
@@ -181,7 +174,7 @@ extension SocketPacket {
 private extension SocketPacket {
     // Recursive function that looks for NSData in collections
     static func shred(_ data: Any, binary: inout [Data]) -> Any {
-        let placeholder = ["_placeholder": true, "num": binary.count] as [String : Any]
+        let placeholder = ["_placeholder": true, "num": binary.count] as JSON
 
         switch data {
         case let bin as Data:
@@ -190,8 +183,8 @@ private extension SocketPacket {
             return placeholder
         case let arr as [Any]:
             return arr.map({shred($0, binary: &binary)})
-        case let dict as [String: Any]:
-            return dict.reduce([String: Any](), {cur, keyValue in
+        case let dict as JSON:
+            return dict.reduce(JSON(), {cur, keyValue in
                 var mutCur = cur
 
                 mutCur[keyValue.0] = shred(keyValue.1, binary: &binary)

Source/SocketTypes.swift

@@ -41,8 +41,8 @@ extension String : SocketData {}
 
 public typealias AckCallback = ([Any]) -> Void
 public typealias NormalCallback = ([Any], SocketAckEmitter) -> Void
-public typealias OnAckCallback = (_ timeoutAfter: UInt64, _ callback: @escaping AckCallback) -> Void
 
+typealias JSON = [String: Any]
 typealias Probe = (msg: String, type: SocketEnginePacketType, data: [Data])
 typealias ProbeWaitQueue = [Probe]