Add PusherDelegate.

Add NativePusherTests.

Restructure how the MockSession works in Mocks.swift so that it can
better handle multiple “stubbed” requests in a single test.

Author: hamchapman

PusherSwift/PusherSwift.xcodeproj/project.pbxproj

@@ -21,6 +21,8 @@
 		3389F57A1CAEDEC800563F49 /* PusherClientOptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3389F5791CAEDEC800563F49 /* PusherClientOptions.swift */; };
 		33A962741D88A9C900DA421E /* PusherConnectionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33A962731D88A9C800DA421E /* PusherConnectionDelegate.swift */; };
 		33A962771D89483600DA421E /* PusherConnectionDelegateTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33A962751D8943CA00DA421E /* PusherConnectionDelegateTests.swift */; };
+		33BA541E1D90351B00CD853B /* NativePusherTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33BA541D1D90351B00CD853B /* NativePusherTests.swift */; };
+		33BA54201D9035BD00CD853B /* PusherDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33BA541F1D9035BD00CD853B /* PusherDelegate.swift */; };
 		33BB99731D21230100B25C2A /* AuthenticationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33BB995D1D21226C00B25C2A /* AuthenticationTests.swift */; };
 		33BB99751D21230100B25C2A /* Helpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33BB995F1D21226C00B25C2A /* Helpers.swift */; };
 		33BB99761D21230100B25C2A /* Mocks.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33BB99601D21226C00B25C2A /* Mocks.swift */; };
@@ -66,6 +68,8 @@
 		3389F5791CAEDEC800563F49 /* PusherClientOptions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PusherClientOptions.swift; sourceTree = "<group>"; };
 		33A962731D88A9C800DA421E /* PusherConnectionDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PusherConnectionDelegate.swift; sourceTree = "<group>"; };
 		33A962751D8943CA00DA421E /* PusherConnectionDelegateTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = PusherConnectionDelegateTests.swift; path = ../Tests/PusherConnectionDelegateTests.swift; sourceTree = "<group>"; };
+		33BA541D1D90351B00CD853B /* NativePusherTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = NativePusherTests.swift; path = ../Tests/NativePusherTests.swift; sourceTree = "<group>"; };
+		33BA541F1D9035BD00CD853B /* PusherDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PusherDelegate.swift; sourceTree = "<group>"; };
 		33BB995D1D21226C00B25C2A /* AuthenticationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = AuthenticationTests.swift; path = ../Tests/AuthenticationTests.swift; sourceTree = "<group>"; };
 		33BB995F1D21226C00B25C2A /* Helpers.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = Helpers.swift; path = ../Tests/Helpers.swift; sourceTree = "<group>"; };
 		33BB99601D21226C00B25C2A /* Mocks.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = Mocks.swift; path = ../Tests/Mocks.swift; sourceTree = "<group>"; };
@@ -124,6 +128,7 @@
 			children = (
 				33831CD31A9CFFD900B124F1 /* PusherSwift.swift */,
 				3389F5791CAEDEC800563F49 /* PusherClientOptions.swift */,
+				33BA541F1D9035BD00CD853B /* PusherDelegate.swift */,
 				3389F5651CAEDD5F00563F49 /* PusherConnection.swift */,
 				33A962731D88A9C800DA421E /* PusherConnectionDelegate.swift */,
 				3389F5691CAEDD9100563F49 /* PusherWebsocketDelegate.swift */,
@@ -163,6 +168,7 @@
 				33A962751D8943CA00DA421E /* PusherConnectionDelegateTests.swift */,
 				33BB99651D21226C00B25C2A /* PusherIncomingEventHandlingTests.swift */,
 				33BB99661D21226C00B25C2A /* PusherTopLevelAPITests.swift */,
+				33BA541D1D90351B00CD853B /* NativePusherTests.swift */,
 				33BB99671D21226C00B25C2A /* Info.plist */,
 			);
 			name = Tests;
@@ -323,6 +329,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				3389F5661CAEDD5F00563F49 /* PusherConnection.swift in Sources */,
+				33BA54201D9035BD00CD853B /* PusherDelegate.swift in Sources */,
 				3389F56A1CAEDD9100563F49 /* PusherWebsocketDelegate.swift in Sources */,
 				330D7A6D1CAEDA750032FF2C /* PusherChannel.swift in Sources */,
 				33A962741D88A9C900DA421E /* PusherConnectionDelegate.swift in Sources */,
@@ -351,6 +358,7 @@
 				33BB997B1D21230100B25C2A /* PusherIncomingEventHandlingTests.swift in Sources */,
 				3342F3BD1D808AC900C0296E /* ClientEventTests.swift in Sources */,
 				33BB99751D21230100B25C2A /* Helpers.swift in Sources */,
+				33BA541E1D90351B00CD853B /* NativePusherTests.swift in Sources */,
 				33BB99731D21230100B25C2A /* AuthenticationTests.swift in Sources */,
 				33BB99781D21230100B25C2A /* PusherChannelTests.swift in Sources */,
 				33BB99761D21230100B25C2A /* Mocks.swift in Sources */,

Source/NativePusher.swift

@@ -24,11 +24,12 @@
     private let CLIENT_API_V1_ENDPOINT = "https://nativepushclient-cluster1.pusher.com/client_api/v1"
     private let LIBRARY_NAME_AND_VERSION = "pusher-websocket-swift " + VERSION
 
-    private let URLSession = Foundation.URLSession.shared
+    public var URLSession = Foundation.URLSession.shared
     private var failedRequestAttempts: Int = 0
     private let maxFailedRequestAttempts: Int = 6
 
     internal var socketConnection: PusherConnection? = nil
+    internal var pusher: Pusher? = nil
 
     private var requestQueue = TaskQueue()
 
@@ -61,12 +62,11 @@
         requestQueue.run()
     }
 
-
     /**
         Makes device token presentable to server
 
         - parameter deviceToken: the deviceToken received when registering
-                                 to receive push notifications, as NSData
+                                 to receive push notifications, as Data
 
         - returns: the deviceToken formatted as a String
     */
@@ -79,12 +79,11 @@
     }
 
     /**
-        Registers this app instance with Pusher for push notifications.
+        Registers (asynchronously) this app instance with Pusher for push notifications.
         This must be done before we can subscribe to interests.
-        Registration happens asynchronously; any errors are reported by print statements.
 
         - parameter deviceToken: the deviceToken received when registering
-                                 to receive push notifications, as NSData
+                                 to receive push notifications, as Data
     */
     open func register(deviceToken: Data) {
         var request = URLRequest(url: URL(string: CLIENT_API_V1_ENDPOINT + "/clients")!)
@@ -122,6 +121,7 @@
                             if let clientIdJson = json["id"] {
                                 if let clientId = clientIdJson as? String {
                                     self.clientId = clientId
+                                    self.pusher?.delegate?.didRegisterForPushNotifications?(clientId: clientId)
                                     self.socketConnection?.delegate?.debugLog?(message: "Successfully registered for push notifications and got clientId: \(clientId)")
                                     self.requestQueue.run()
                                 } else {
@@ -241,6 +241,13 @@
                     return
                 }
 
+                switch change {
+                case .subscribe:
+                    self.pusher?.delegate?.didSubscribeToInterest?(named: interest)
+                case .unsubscribe:
+                    self.pusher?.delegate?.didUnsubscribeFromInterest?(named: interest)
+                }
+
                 self.socketConnection?.delegate?.debugLog?(message: "Success making \(change.stringValue) to \(interest)")
 
                 self.failedRequestAttempts = 0

Source/PusherDelegate.swift

@@ -0,0 +1,13 @@
+//
+//  PusherDelegate.swift
+//  PusherSwift
+//
+//  Created by Hamilton Chapman on 19/09/2016.
+//
+//
+
+@objc public protocol PusherDelegate: class {
+    @objc optional func didRegisterForPushNotifications(clientId: String)
+    @objc optional func didSubscribeToInterest(named name: String)
+    @objc optional func didUnsubscribeFromInterest(named name: String)
+}

Source/PusherSwift.swift

@@ -13,6 +13,7 @@ let CLIENT_NAME = "pusher-websocket-swift"
 
 @objc open class Pusher: NSObject {
     open let connection: PusherConnection
+    open weak var delegate: PusherDelegate? = nil
     private let key: String
 
 #if os(iOS)
@@ -33,6 +34,8 @@ let CLIENT_NAME = "pusher-websocket-swift"
         connection.createGlobalChannel()
         nativePusher.setPusherAppKey(pusherAppKey: key)
         nativePusher.socketConnection = connection
+        super.init()
+        nativePusher.pusher = self
     }
 
 #endif

Tests/Mocks.swift

@@ -206,32 +206,46 @@ open class FunctionCall {
     }
 }
 
-class MockSession: URLSession {
-    var completionHandler: ((Data?, URLResponse?, NSError?) -> Void)?
+public typealias Response = (data: Data?, urlResponse: URLResponse?, error: NSError?)
 
-    static var mockResponse: (data: Data?, urlResponse: URLResponse?, error: NSError?) = (data: nil, urlResponse: nil, error: nil)
-    override class var shared: URLSession {
+public class MockSession: URLSession {
+    static public var mockResponses: [String: Response] = [:]
+    static public var mockResponse: (data: Data?, urlResponse: URLResponse?, error: NSError?) = (data: nil, urlResponse: nil, error: nil)
+
+    override public class var shared: URLSession {
         get {
             return MockSession()
         }
     }
 
-    override func dataTask(with: URLRequest, completionHandler: @escaping(Data?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
-        self.completionHandler = completionHandler
-        return MockTask(response: MockSession.mockResponse, completionHandler: completionHandler)
+    override public func dataTask(with: URLRequest, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
+        var response: Response
+        let mockedMethodAndUrlString = "\(with.httpMethod!)||\((with.url?.absoluteString)!)"
+
+        if let mockedResponse = MockSession.mockResponses[mockedMethodAndUrlString] {
+            response = mockedResponse
+        } else {
+            response = MockSession.mockResponse
+        }
+        return MockTask(response: response, completionHandler: completionHandler)
+    }
+
+    public class func addMockResponse(for url: URL, httpMethod: String, data: Data?, urlResponse: URLResponse?, error: NSError?) {
+        let response = (data: data, urlResponse: urlResponse, error: error)
+        let mockedResponseString = "\(httpMethod)||\(url.absoluteString)"
+        mockResponses[mockedResponseString] = response
     }
 
-    class MockTask: URLSessionDataTask {
-        typealias Response = (data: Data?, urlResponse: URLResponse?, error: NSError?)
-        var mockResponse: Response
-        let completionHandler: ((Data?, URLResponse?, NSError?) -> Void)?
+    public class MockTask: URLSessionDataTask {
+        public var mockResponse: Response
+        public let completionHandler: ((Data?, URLResponse?, NSError?) -> Void)?
 
-        init(response: Response, completionHandler: ((Data?, URLResponse?, NSError?) -> Void)?) {
+        public init(response: Response, completionHandler: ((Data?, URLResponse?, NSError?) -> Void)?) {
             self.mockResponse = response
             self.completionHandler = completionHandler
         }
 
-        override func resume() {
+        override public func resume() {
             DispatchQueue.global(qos: .default).async {
                 self.completionHandler!(self.mockResponse.data, self.mockResponse.urlResponse, self.mockResponse.error)
             }

Tests/NativePusherTests.swift

@@ -0,0 +1,121 @@
+//
+//  NativePusherTests.swift
+//  PusherSwift
+//
+//  Created by Hamilton Chapman on 19/09/2016.
+//
+//
+
+#if os(iOS)
+
+import PusherSwift
+import XCTest
+
+class NativePusherTests: XCTestCase {
+    public class DummyDelegate: PusherDelegate {
+        public var testClientId: String? = nil
+        public var registerEx: XCTestExpectation? = nil
+        public var subscribeEx: XCTestExpectation? = nil
+        public var unsubscribeEx: XCTestExpectation? = nil
+        public var interestName: String? = nil
+
+        public func didSubscribeToInterest(named name: String) {
+            if interestName == name {
+                subscribeEx!.fulfill()
+            }
+        }
+
+        public func didUnsubscribeFromInterest(named name: String) {
+            if interestName == name {
+                unsubscribeEx!.fulfill()
+            }
+        }
+
+        public func didRegisterForPushNotifications(clientId: String) {
+            XCTAssertEqual(clientId, testClientId)
+            registerEx!.fulfill()
+        }
+    }
+
+    var key: String!
+    var pusher: Pusher!
+    var socket: MockWebSocket!
+    var dummyDelegate: DummyDelegate!
+    var testClientId: String!
+
+    override func setUp() {
+        super.setUp()
+
+        key = "testKey123"
+        testClientId = "your_client_id"
+        let options = PusherClientOptions(
+            authMethod: AuthMethod.inline(secret: "secret"),
+            autoReconnect: false
+        )
+
+        pusher = Pusher(key: key, options: options)
+        socket = MockWebSocket()
+        socket.delegate = pusher.connection
+        pusher.connection.socket = socket
+        dummyDelegate = DummyDelegate()
+        pusher.delegate = dummyDelegate
+
+        let jsonData = "{\"id\":\"\(testClientId!)\"}".data(using: String.Encoding.utf8, allowLossyConversion: false)!
+        let url = URL(string: "https://nativepushclient-cluster1.pusher.com/client_api/v1/clients")!
+        let urlResponse = HTTPURLResponse(url: url, statusCode: 201, httpVersion: nil, headerFields: nil)
+        MockSession.addMockResponse(for: url, httpMethod: "POST", data: jsonData, urlResponse: urlResponse, error: nil)
+
+        let emptyJsonData = "".data(using: String.Encoding.utf8)!
+        let subscriptionModificationUrl = URL(string: "https://nativepushclient-cluster1.pusher.com/client_api/v1/clients/\(testClientId!)/interests/donuts")!
+        let susbcriptionModificationResponse = HTTPURLResponse(url: subscriptionModificationUrl, statusCode: 204, httpVersion: nil, headerFields: nil)
+        let httpMethodForSubscribe = "POST"
+        MockSession.addMockResponse(for: subscriptionModificationUrl, httpMethod: httpMethodForSubscribe, data: emptyJsonData, urlResponse: susbcriptionModificationResponse, error: nil)
+        let httpMethodForUnsubscribe = "DELETE"
+        MockSession.addMockResponse(for: subscriptionModificationUrl, httpMethod: httpMethodForUnsubscribe, data: emptyJsonData, urlResponse: susbcriptionModificationResponse, error: nil)
+
+        pusher.nativePusher().URLSession = MockSession.shared
+    }
+
+    func testReceivingAClientIdAfterRegisterIsCalled() {
+        let ex = expectation(description: "the clientId should be received when registration succeeds")
+        dummyDelegate.testClientId = testClientId
+        dummyDelegate.registerEx = ex
+
+        pusher.nativePusher().register(deviceToken: "SOME_DEVICE_TOKEN".data(using: String.Encoding.utf8)!)
+        waitForExpectations(timeout: 0.5)
+    }
+
+    func testSubscribingToAnInterest() {
+        let registerEx = expectation(description: "the clientId should be received when registration succeeds")
+        let subscribeEx = expectation(description: "the client should successfully subscribe to an interest")
+
+        dummyDelegate.testClientId = testClientId
+        dummyDelegate.interestName = "donuts"
+        dummyDelegate.registerEx = registerEx
+        dummyDelegate.subscribeEx = subscribeEx
+
+        pusher.nativePusher().subscribe(interestName: "donuts")
+        pusher.nativePusher().register(deviceToken: "SOME_DEVICE_TOKEN".data(using: String.Encoding.utf8)!)
+
+        waitForExpectations(timeout: 0.5)
+    }
+
+    func testUnsubscribingFromAnInterest() {
+        let registerEx = expectation(description: "the clientId should be received when registration succeeds")
+        let subscribeEx = expectation(description: "the client should successfully subscribe to an interest")
+        let unsubscribeEx = expectation(description: "the client should successfully unsubscribe from an interest")
+        dummyDelegate.testClientId = testClientId
+        dummyDelegate.interestName = "donuts"
+        dummyDelegate.registerEx = registerEx
+        dummyDelegate.subscribeEx = subscribeEx
+        dummyDelegate.unsubscribeEx = unsubscribeEx
+
+        pusher.nativePusher().subscribe(interestName: "donuts")
+        pusher.nativePusher().register(deviceToken: "SOME_DEVICE_TOKEN".data(using: String.Encoding.utf8)!)
+        pusher.nativePusher().unsubscribe(interestName: "donuts")
+
+        waitForExpectations(timeout: 0.5)
+    }
+}
+
+#endif