Merge pull request #289 from socketio/nsurl-based

nuclearace · nuclearace · commit d36ef10404ae · 2016-01-26T11:24:19.000-05:00
Nsurl based
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ Socket.IO-client for iOS/OS X.
 
 ##Example
 ```swift
-let socket = SocketIOClient(socketURL: "localhost:8080", options: [.Log(true), .ForcePolling(true)])
+let socket = SocketIOClient(socketURL: NSURL(string: "http://localhost:8080")!, options: [.Log(true), .ForcePolling(true)])
 
 socket.on("connect") {data, ack in
     print("socket connected")
@@ -26,7 +26,8 @@ socket.connect()
 
 ##Objective-C Example
 ```objective-c
-SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:@"localhost:8080" options:@{@"log": @YES, @"forcePolling": @YES}];
+NSURL* url = [[NSURL alloc] initWithString:@"http://localhost:8080"];
+SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url options:@{@"log": @YES, @"forcePolling": @YES}];
 
 [socket on:@"connect" callback:^(NSArray* data, SocketAckEmitter* ack) {
     NSLog(@"socket connected");
@@ -136,9 +137,9 @@ Run `seed install`.
 ##API
 Constructors
 -----------
-`init(var socketURL: String, options: Set<SocketIOClientOption> = [])` - Creates a new SocketIOClient. opts is a Set of SocketIOClientOption. If your socket.io server is secure, you need to specify `https` in your socketURL.
+`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.
 
-`convenience init(socketURL: String, options: NSDictionary?)` - Same as above, but meant for Objective-C. See Options on how convert between SocketIOClientOptions and dictionary keys.
+`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
 -------
diff --git a/SocketIO-MacTests/SocketEngineTest.swift b/SocketIO-MacTests/SocketEngineTest.swift
@@ -15,8 +15,8 @@ class SocketEngineTest: XCTestCase {
 
     override func setUp() {
         super.setUp()
-        client = SocketIOClient(socketURL: "")
-        engine = SocketEngine(client: client, url: "", options: nil)
+        client = SocketIOClient(socketURL: NSURL(string: "http://localhost")!)
+        engine = SocketEngine(client: client, url: NSURL(string: "http://localhost")!, options: nil)
         
         client.setTestable()
     }
diff --git a/SocketIO-MacTests/SocketParserTest.swift b/SocketIO-MacTests/SocketParserTest.swift
@@ -10,7 +10,7 @@ import XCTest
 @testable import SocketIOClientSwift
 
 class SocketParserTest: XCTestCase {
-    let testSocket = SocketIOClient(socketURL: "")
+    let testSocket = SocketIOClient(socketURL: NSURL())
     
     //Format key: message; namespace-data-binary-id
     static let packetTypes: Dictionary<String, (String, [AnyObject], [NSData], Int)> = [
diff --git a/SocketIO-MacTests/SocketSideEffectTest.swift b/SocketIO-MacTests/SocketSideEffectTest.swift
@@ -16,7 +16,7 @@ class SocketSideEffectTest: XCTestCase {
     
     override func setUp() {
         super.setUp()
-        socket = SocketIOClient(socketURL: "")
+        socket = SocketIOClient(socketURL: NSURL())
         socket.setTestable()
     }
     
diff --git a/Source/SocketEngine.swift b/Source/SocketEngine.swift
@@ -29,6 +29,11 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
     public let handleQueue = dispatch_queue_create("com.socketio.engineHandleQueue", DISPATCH_QUEUE_SERIAL)
     public let parseQueue = dispatch_queue_create("com.socketio.engineParseQueue", DISPATCH_QUEUE_SERIAL)
 
+    public var connectParams: [String: AnyObject]? {
+        didSet {
+            (urlPolling, urlWebSocket) = createURLs()
+        }
+    }
     public var postWait = [String]()
     public var waitingForPoll = false
     public var waitingForPost = false
@@ -46,9 +51,9 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
     public private(set) var probing = false
     public private(set) var session: NSURLSession?
     public private(set) var sid = ""
-    public private(set) var socketPath = "/engine.io"
-    public private(set) var urlPolling = ""
-    public private(set) var urlWebSocket = ""
+    public private(set) var socketPath = "/engine.io/"
+    public private(set) var urlPolling = NSURL()
+    public private(set) var urlWebSocket = NSURL()
     public private(set) var websocket = false
     public private(set) var ws: WebSocket?
 
@@ -59,11 +64,9 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
     private typealias Probe = (msg: String, type: SocketEnginePacketType, data: [NSData])
     private typealias ProbeWaitQueue = [Probe]
 
-    private let allowedCharacterSet = NSCharacterSet(charactersInString: "!*'();:@&=+$,/?%#[]\" {}").invertedSet
     private let logType = "SocketEngine"
-    private let url: String
+    private let url: NSURL
     
-    private var connectParams: [String: AnyObject]?
     private var pingInterval: Double?
     private var pingTimeout = 0.0 {
         didSet {
@@ -76,13 +79,15 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
     private var secure = false
     private var selfSigned = false
     private var voipEnabled = false
-    
-    public init(client: SocketEngineClient, url: String, options: Set<SocketIOClientOption>) {
+
+    public init(client: SocketEngineClient, url: NSURL, options: Set<SocketIOClientOption>) {
         self.client = client
         self.url = url
-
+        
         for option in options {
             switch option {
+            case let .ConnectParams(params):
+                connectParams = params
             case let .SessionDelegate(delegate):
                 sessionDelegate = delegate
             case let .ForcePolling(force):
@@ -105,11 +110,26 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
                 continue
             }
         }
+        
+        super.init()
+        
+        (urlPolling, urlWebSocket) = createURLs()
+    }
+    
+    public convenience init(client: SocketEngineClient, url: NSURL, options: NSDictionary?) {
+        self.init(client: client, url: url, options: options?.toSocketOptionsSet() ?? [])
     }
     
-    public convenience init(client: SocketEngineClient, url: String, options: NSDictionary?) {
-        self.init(client: client, url: url,
-            options: options?.toSocketOptionsSet() ?? [])
+    @available(*, deprecated=5.3)
+    public convenience init(client: SocketEngineClient, urlString: String, options: Set<SocketIOClientOption>) {
+        guard let url = NSURL(string: urlString) else { fatalError("Incorrect url") }
+        self.init(client: client, url: url, options: options)
+    }
+    
+    @available(*, deprecated=5.3)
+    public convenience init(client: SocketEngineClient, urlString: String, options: NSDictionary?) {
+        guard let url = NSURL(string: urlString) else { fatalError("Incorrect url") }
+        self.init(client: client, url: url, options: options?.toSocketOptionsSet() ?? [])
     }
 
     deinit {
@@ -131,7 +151,7 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
                     switch code {
                     case 0: // Unknown transport
                         didError(error)
-                    case 1: // Unknown sid. clear and retry connect
+                    case 1: // Unknown sid.
                         didError(error)
                     case 2: // Bad handshake request
                         didError(error)
@@ -188,49 +208,45 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
         }
     }
 
-    private func createURLs(params: [String: AnyObject]?) -> (String, String) {
+    private func createURLs() -> (NSURL, NSURL) {
         if client == nil {
-            return ("", "")
+            return (NSURL(), NSURL())
         }
 
-        let socketURL = "\(url)\(socketPath)/?transport="
-        var urlPolling: String
-        var urlWebSocket: String
+        let urlPolling = NSURLComponents(string: url.absoluteString)!
+        let urlWebSocket = NSURLComponents(string: url.absoluteString)!
+        var queryString = ""
+        
+        urlWebSocket.path = socketPath
+        urlPolling.path = socketPath
+        urlWebSocket.query = "transport=websocket"
+        urlPolling.query = "transport=polling&b64=1"
 
         if secure {
-            urlPolling = "https://" + socketURL + "polling"
-            urlWebSocket = "wss://" + socketURL + "websocket"
+            urlPolling.scheme = "https"
+            urlWebSocket.scheme = "wss"
         } else {
-            urlPolling = "http://" + socketURL + "polling"
-            urlWebSocket = "ws://" + socketURL + "websocket"
+            urlPolling.scheme = "http"
+            urlWebSocket.scheme = "ws"
         }
 
-        if params != nil {
-            for (key, value) in params! {
-                let keyEsc = key.stringByAddingPercentEncodingWithAllowedCharacters(
-                    allowedCharacterSet)!
-                urlPolling += "&\(keyEsc)="
-                urlWebSocket += "&\(keyEsc)="
-
-                if value is String {
-                    let valueEsc = (value as! String).stringByAddingPercentEncodingWithAllowedCharacters(
-                        allowedCharacterSet)!
-                    urlPolling += "\(valueEsc)"
-                    urlWebSocket += "\(valueEsc)"
-                } else {
-                    urlPolling += "\(value)"
-                    urlWebSocket += "\(value)"
-                }
+        if connectParams != nil {
+            for (key, value) in connectParams! {
+                queryString += "&\(key)=\(value)"
             }
         }
 
-        return (urlPolling, urlWebSocket)
+        urlWebSocket.query = urlWebSocket.query! + queryString
+        urlPolling.query = urlPolling.query! + queryString
+        
+        return (urlPolling.URL!, urlWebSocket.URL!)
     }
 
     private func createWebsocketAndConnect() {
-        let wsUrl = urlWebSocket + (sid == "" ? "" : "&sid=\(sid)")
-
-        ws = WebSocket(url: NSURL(string: wsUrl)!)
+        let component = NSURLComponents(URL: urlWebSocket, resolvingAgainstBaseURL: false)!
+        component.query = component.query! + (sid == "" ? "" : "&sid=\(sid)")
+        
+        ws = WebSocket(url: component.URL!)
         
         if cookies != nil {
             let headers = NSHTTPCookie.requestHeaderFieldsWithCookies(cookies!)
@@ -363,30 +379,26 @@ public final class SocketEngine: NSObject, SocketEnginePollable, SocketEngineWeb
         }
     }
 
-    public func open(opts: [String: AnyObject]?) {
+    public func open() {
         if connected {
             DefaultSocketLogger.Logger.error("Engine tried opening while connected. This is probably a programming error. "
                 + "Abandoning open attempt", type: logType)
             return
         }
         
-        connectParams = opts
-
         DefaultSocketLogger.Logger.log("Starting engine", type: logType)
         DefaultSocketLogger.Logger.log("Handshaking", type: logType)
 
         resetEngine()
 
-        (urlPolling, urlWebSocket) = createURLs(opts)
-
         if forceWebsockets {
             polling = false
             websocket = true
             createWebsocketAndConnect()
             return
         }
 
-        let reqPolling = NSMutableURLRequest(URL: NSURL(string: urlPolling + "&b64=1")!)
+        let reqPolling = NSMutableURLRequest(URL: urlPolling)
 
         if cookies != nil {
             let headers = NSHTTPCookie.requestHeaderFieldsWithCookies(cookies!)
diff --git a/Source/SocketEnginePollable.swift b/Source/SocketEnginePollable.swift
@@ -71,7 +71,7 @@ extension SocketEnginePollable {
         
         postWait.removeAll(keepCapacity: false)
         
-        let req = NSMutableURLRequest(URL: NSURL(string: urlPolling + "&sid=\(sid)")!)
+        let req = NSMutableURLRequest(URL: urlPollingWithSid)
         
         addHeaders(req)
         
@@ -93,7 +93,7 @@ extension SocketEnginePollable {
         }
         
         waitingForPoll = true
-        let req = NSMutableURLRequest(URL: NSURL(string: urlPolling + "&sid=\(sid)&b64=1")!)
+        let req = NSMutableURLRequest(URL: urlPollingWithSid)
         
         addHeaders(req)
         doLongPoll(req)
@@ -112,7 +112,7 @@ extension SocketEnginePollable {
     
     func doLongPoll(req: NSURLRequest) {
         doRequest(req) {[weak self] data, res, err in
-            guard let this = self else {return}
+            guard let this = self else { return }
             
             if err != nil || data == nil {
                 DefaultSocketLogger.Logger.error(err?.localizedDescription ?? "Error", type: "SocketEnginePolling")
diff --git a/Source/SocketEngineSpec.swift b/Source/SocketEngineSpec.swift
@@ -29,6 +29,7 @@ import Foundation
     weak var client: SocketEngineClient? { get set }
     var closed: Bool { get }
     var connected: Bool { get }
+    var connectParams: [String: AnyObject]? { get set }
     var cookies: [NSHTTPCookie]? { get }
     var extraHeaders: [String: String]? { get }
     var fastUpgrade: Bool { get }
@@ -42,23 +43,30 @@ import Foundation
     var handleQueue: dispatch_queue_t! { get }
     var sid: String { get }
     var socketPath: String { get }
-    var urlPolling: String { get }
-    var urlWebSocket: String { get }
+    var urlPolling: NSURL { get }
+    var urlWebSocket: NSURL { get }
     var websocket: Bool { get }
     
-    init(client: SocketEngineClient, url: String, options: NSDictionary?)
+    init(client: SocketEngineClient, url: NSURL, options: NSDictionary?)
     
     func close(reason: String)
     func didError(error: String)
     func doFastUpgrade()
     func flushWaitingForPostToWebSocket()
-    func open(opts: [String: AnyObject]?)
+    func open()
     func parseEngineData(data: NSData)
     func parseEngineMessage(message: String, fromPolling: Bool)
     func write(msg: String, withType type: SocketEnginePacketType, withData data: [NSData])
 }
 
 extension SocketEngineSpec {
+    var urlPollingWithSid: NSURL {
+        let com = NSURLComponents(URL: urlPolling, resolvingAgainstBaseURL: false)!
+        com.query = com.query! + "&sid=\(sid)"
+        
+        return com.URL!
+    }
+    
     func createBinaryDataForSend(data: NSData) -> Either<NSData, String> {
         if websocket {
             var byteArray = [UInt8](count: 1, repeatedValue: 0x4)
diff --git a/Source/SocketIOClient.swift b/Source/SocketIOClient.swift
diff --git a/Source/SwiftRegex.swift b/Source/SwiftRegex.swift

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ class SocketEngineTest: XCTestCase {`
`15`	`15`
`16`	`16`	`override func setUp() {`
`17`	`17`	`super.setUp()`
`18`		`- client = SocketIOClient(socketURL: "")`
`19`		`- engine = SocketEngine(client: client, url: "", options: nil)`
	`18`	`+ client = SocketIOClient(socketURL: NSURL(string: "http://localhost")!)`
	`19`	`+ engine = SocketEngine(client: client, url: NSURL(string: "http://localhost")!, options: nil)`
`20`	`20`
`21`	`21`	`client.setTestable()`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class SocketSideEffectTest: XCTestCase {`
`16`	`16`
`17`	`17`	`override func setUp() {`
`18`	`18`	`super.setUp()`
`19`		`- socket = SocketIOClient(socketURL: "")`
	`19`	`+ socket = SocketIOClient(socketURL: NSURL())`
`20`	`20`	`socket.setTestable()`
`21`	`21`	`}`
`22`	`22`