Merge branch 'development'

* development: (24 commits)
  Add enum for client events. Resolves #675
  Add client event for status changes. Closes #668
  Remove from manager can be discarded
  Use xctool
  Go back to straight xcodebuild
  Try and fix travis
  Disable logging in tests, use xctool again
  Implement #672
  Document SocketIOClientSwift
  Document SocketAnyEvent
  Move operators inside type
  Document ack types
  Fix #667 Make no ack an enum case
  remove refactor build
  Open client
  Make client single queued
  Make engine single queued
  add ignore for appcode
  Fix #657
  Parsable doesn't have to be a client
  ...

Author: nuclearace

.gitignore

@@ -46,3 +46,7 @@ DerivedData
 *.xcuserstate
 
 Socket.IO-Test-Server/node_modules/*
+
+.idea/
+docs/docsets/
+docs/undocumented.json

.travis.yml

@@ -9,5 +9,7 @@ branches:
 before_install:
   - brew update
   - brew outdated xctool || brew upgrade xctool
-# script: xctool -project Socket.IO-Client-Swift.xcodeproj -scheme SocketIO-Mac build test -parallelize
-script: xcodebuild -project Socket.IO-Client-Swift.xcodeproj -scheme SocketIO-Mac build test
+script:
+  - xcodebuild -project Socket.IO-Client-Swift.xcodeproj -scheme SocketIO-Mac build-for-testing -quiet
+  - xctool -project Socket.IO-Client-Swift.xcodeproj -scheme SocketIO-Mac run-tests --parallelize
+#script: xcodebuild -project Socket.IO-Client-Swift.xcodeproj -scheme SocketIO-Mac build test

README.md

@@ -9,7 +9,7 @@ import SocketIO
 
 let socket = SocketIOClient(socketURL: URL(string: "http://localhost:8080")!, config: [.log(true), .forcePolling(true)])
 
-socket.on("connect") {data, ack in
+socket.on(clientEvent: .connect) {data, ack in
     print("socket connected")
 }
 
@@ -70,13 +70,11 @@ If you need Swift 1.2 use v2.4.5 (Pre-Swift 2 support is no longer maintained)
 
 If you need Swift 1.1 use v1.5.2. (Pre-Swift 1.2 support is no longer maintained)
 
-Manually (iOS 7+)
------------------
+### Manually (iOS 7+)
 1. Copy the Source folder into your Xcode project. (Make sure you add the files to your target(s))
 2. If you plan on using this from Objective-C, read [this](https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html) on exposing Swift code to Objective-C.
 
-Swift Package Manager
----------------------
+### Swift Package Manager
 Add the project as a dependency to your Package.swift:
 ```swift
 import PackageDescription
@@ -91,17 +89,15 @@ let package = Package(
 
 Then import `import SocketIO`.
 
-Carthage
------------------
+### Carthage
 Add this line to your `Cartfile`:
 ```
 github "socketio/socket.io-client-swift" ~> 8.3.3 # Or latest version
 ```
 
 Run `carthage update --platform ios,macosx`.
 
-CocoaPods 1.0.0 or later
-------------------
+### CocoaPods 1.0.0 or later
 Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
 
 ```ruby
@@ -131,8 +127,7 @@ Objective-C:
 @import SocketIO;
 ```
 
-CocoaSeeds
------------------
+### CocoaSeeds
 
 Add this line to your `Seedfile`:
 
@@ -150,8 +145,7 @@ Constructors
 
 `convenience init(socketURL: NSURL, options: NSDictionary?)` - Same as above, but meant for Objective-C. See Options on how convert between SocketIOClientOptions and dictionary keys.
 
-Options
--------
+### Options
 All options are a case of SocketIOClientOption. To get the Objective-C Option, convert the name to lowerCamelCase.
 
 ```swift
@@ -176,8 +170,7 @@ case security(SSLSecurity) // Allows you to set which certs are valid. Useful fo
 case selfSigned(Bool) // Sets WebSocket.selfSignedSSL. Use this if you're using self-signed certs.
 case voipEnabled(Bool) // Only use this option if you're using the client with VoIP services. Changes the way the WebSocket is created. Default is false
 ```
-Methods
--------
+### Methods
 1. `on(_ event: String, callback: NormalCallback) -> NSUUID` - Adds a handler for an event. Items are passed by an array. `ack` can be used to send an ack when one is requested. See example. Returns a unique id for the handler.
 2. `once(_ event: String, callback: NormalCallback) -> NSUUID` - Adds a handler that will only be executed once. Returns a unique id for the handler.
 3. `onAny(callback:((event: String, items: AnyObject?)) -> Void)` - Adds a handler for all events. It will be called on any received event.
@@ -195,8 +188,7 @@ Methods
 15. `off(id id: NSUUID)` - Removes the event that corresponds to id.
 16. `removeAllHandlers()` - Removes all handlers.
 
-Client Events
-------
+### Client Events
 1. `connect` - Emitted when on a successful connection.
 2. `disconnect` - Emitted when the connection is closed.
 3. `error` - Emitted on an error.

SocketIO-MacTests/SocketAckManagerTest.swift

@@ -9,18 +9,43 @@
 import XCTest
 @testable import SocketIO
 
-class SocketAckManagerTest: XCTestCase {
+class SocketAckManagerTest : XCTestCase {
     var ackManager = SocketAckManager()
 
     func testAddAcks() {
-        let callbackExpection = self.expectation(description: "callbackExpection")
+        let callbackExpection = expectation(description: "callbackExpection")
         let itemsArray = ["Hi", "ho"]
+
         func callback(_ items: [Any]) {
             callbackExpection.fulfill()
         }
+
         ackManager.addAck(1, callback: callback)
         ackManager.executeAck(1, with: itemsArray, onQueue: DispatchQueue.main)
-        
+
         waitForExpectations(timeout: 3.0, handler: nil)
     }
+
+    func testManagerTimeoutAck() {
+        let callbackExpection = expectation(description: "Manager should timeout ack with noAck status")
+        let itemsArray = ["Hi", "ho"]
+
+        func callback(_ items: [Any]) {
+            XCTAssertEqual(items.count, 1, "Timed out ack should have one value")
+            guard let timeoutReason = items[0] as? String else {
+                XCTFail("Timeout reason should be a string")
+
+                return
+            }
+
+            XCTAssertEqual(timeoutReason, SocketAckStatus.noAck.rawValue)
+
+            callbackExpection.fulfill()
+        }
+
+        ackManager.addAck(1, callback: callback)
+        ackManager.timeoutAck(1, onQueue: DispatchQueue.main)
+
+        waitForExpectations(timeout: 0.2, handler: nil)
+    }
 }

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:@{@"log": @YES, @"forcePolling": @YES}];
+    self.socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{@"log": @NO, @"forcePolling": @YES}];
 }
 
 - (void)testOnSyntax {
@@ -36,7 +36,7 @@ - (void)testEmitSyntax {
 
 - (void)testEmitWithAckSyntax {
     [[self.socket emitWithAck:@"testAckEmit" with:@[@YES]] timingOutAfter:0 callback:^(NSArray* data) {
-        
+
     }];
 }