Merge pull request #320 from pusher/feature/correct-typos

Correct source code and documentation typos

Author: danielrbrowne

CHANGELOG.md

@@ -73,7 +73,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- Added new `bind` functions which accept a callback that receives a `PusherEvent`. A `PusherEvent` represents an event received from the websocket and has properties containing the event name, channel name and data. In addition, `PusherEvent` has a new property, `userId`, which allows you to verify the ID of the user who triggered a client event on a presence channel. You can read more about this feature in [the docs](https://pusher.com/docs/channels/using_channels/events#user-id-in-client-events). All the old `bind` functions are still available for backwards compatibility. The `data` property of `PusherEvent` is not automatically parsed from JSON and you can decide to parse that as required. The parsing behaviour is unchanged for data passed to callbacks bound by the old `bind` functions.
+- Added new `bind` functions which accept a callback that receives a `PusherEvent`. A `PusherEvent` represents an event received from the websocket and has properties containing the event name, channel name and data. In addition, `PusherEvent` has a new property, `userId`, which allows you to verify the ID of the user who triggered a client event on a presence channel. You can read more about this feature in [the docs](https://pusher.com/docs/channels/using_channels/events#user-id-in-client-events). All the old `bind` functions are still available for backwards compatibility. The `data` property of `PusherEvent` is not automatically parsed from JSON and you can decide to parse that as required. The parsing behavior is unchanged for data passed to callbacks bound by the old `bind` functions.
 
 ### Changed
 

README.md

@@ -578,7 +578,7 @@ All of this is the case if you have the client option of `autoReconnect` set as
 
 N.B: If the Pusher servers close the websocket with a [Channels Protocol closure code](https://pusher.com/docs/channels/library_auth_reference/pusher-websockets-protocol#connection-closure), then the `autoReconnect` option is ignored, and the reconnection strategy is determined by the specific closure code that was received.
 
-There are a couple of properties on the connection (`PusherConnection`) that you can set that affect how the reconnection behaviour works. These are:
+There are a couple of properties on the connection (`PusherConnection`) that you can set that affect how the reconnection behavior works. These are:
 
 - `public var reconnectAttemptsMax: Int? = 6` - if you set this to `nil` then there is no maximum number of reconnect attempts and so attempts will continue to be made with an exponential backoff (based on number of attempts), otherwise only as many attempts as this property's value will be made before the connection's state moves to `.disconnected`
 - `public var maxReconnectGapInSeconds: Double? = nil` - if you want to set a maximum length of time (in seconds) between reconnect attempts then set this property appropriately
@@ -804,7 +804,7 @@ let pusherAuth = PusherAuth(auth: yourAuthString, channelData: yourOptionalChann
 let chan = self.pusher.subscribe(channelName, auth: pusherAuth)
 ```
 
-This PusherAuth object can be initialised with just an auth (String) value if the subscription is to a private channel, or both an `auth (String)` and `channelData (String)` pair of values if the subscription is to a presence channel.
+This PusherAuth object can be initialized with just an auth (String) value if the subscription is to a private channel, or both an `auth (String)` and `channelData (String)` pair of values if the subscription is to a presence channel.
 
 These `auth` and `channelData` values are the values that you received if the json object created by a call to pusher.authenticate(...) in one of our various server libraries.
 
@@ -877,7 +877,7 @@ PusherChannel *chan = [pusher subscribeWithChannelName:@"my-channel"];
 
 ### Global events
 
-You can attach behaviour to these events regardless of the channel the event is broadcast to. 
+You can attach behavior to these events regardless of the channel the event is broadcast to. 
 
 #### Swift
 

Sources/Extensions/PusherWebsocketDelegate.swift

@@ -49,7 +49,7 @@ extension PusherConnection: WebSocketConnectionDelegate {
     public func webSocketDidDisconnect(connection: WebSocketConnection,
                                        closeCode: NWProtocolWebSocket.CloseCode,
                                        reason: Data?) {
-        // Handles setting channel subscriptions to unsubscribed wheter disconnection
+        // Handles setting channel subscriptions to unsubscribed whether disconnection
         // is intentional or not
         if connectionState == .disconnecting || connectionState == .connected {
             for (_, channel) in self.channels.channels {

Sources/Helpers/PusherLogger.swift

@@ -25,7 +25,7 @@ internal class PusherLogger {
         case networkConnectionViable = "Network connection became viable"
         case networkConnectionUnviable = "Network connection became unviable"
 
-        // Websockets
+        // WebSocket
 
         case attemptReconnectionAfterWaiting = "Attempting to reconnect after waiting"
         case attemptReconnectionImmediately = "Attempting to reconnect immediately"

Sources/Models/PusherChannel.swift

@@ -52,7 +52,7 @@ open class PusherChannel: NSObject {
     }
 
     /**
-        Initializes a new PusherChannel with a given name and conenction
+        Initializes a new PusherChannel with a given name and connection
 
         - parameter name:       The name of the channel
         - parameter connection: The connection that this channel is relevant to
@@ -81,7 +81,7 @@ open class PusherChannel: NSObject {
     @discardableResult open func bind(eventName: String, callback: @escaping (Any?) -> Void) -> String {
         return bind(eventName: eventName, eventCallback: { [weak self] (event: PusherEvent) -> Void in
             guard let self = self else { return }
-            // Mimic the old parsing behaviour for backwards compatibility
+            // Mimic the old parsing behavior for backwards compatibility
             let callbackData: Any?
             if self.shouldParseJSONForLegacyCallbacks {
                 if let data = event.dataToJSONObject() {

Sources/Models/PusherChannels.swift

@@ -47,7 +47,7 @@ import Foundation
     }
 
     /**
-        Create a new PresencPusherChannel, which is returned, and add it to the PusherChannels
+        Create a new PresencePusherChannel, which is returned, and add it to the PusherChannels
         list of channels
 
         - parameter channelName:     The name of the channel to create

Sources/Models/PusherPresenceChannel.swift

@@ -10,7 +10,7 @@ public typealias PusherUserInfoObject = [String: AnyObject]
     open var myId: String?
 
     /**
-        Initializes a new PusherPresenceChannel with a given name, conenction, and optional
+        Initializes a new PusherPresenceChannel with a given name, connection, and optional
         member added and member removed handler functions
 
         - parameter name:            The name of the channel

Sources/Services/PusherConnection.swift

@@ -46,7 +46,7 @@ import NWWebSocket
         - parameter key:        The Pusher app key
         - parameter socket:     The websocket object
         - parameter url:        The URL the connection is made to
-        - parameter options:    A PusherClientOptions instance containing all of the user-speficied
+        - parameter options:    A PusherClientOptions instance containing all of the user-specified
                                 client options
         - parameter URLSession: An NSURLSession instance for the connection to use for making
                                 authentication requests
@@ -271,7 +271,7 @@ import NWWebSocket
     }
 
     /**
-        Instantiate a new GloblalChannel instance for the connection
+        Instantiate a new GlobalChannel instance for the connection
     */
     internal func createGlobalChannel() {
         self.globalChannel = GlobalChannel(connection: self)
@@ -404,7 +404,7 @@ import NWWebSocket
 
     /**
         Schedule a timer that will fire if no pong response is received within the
-        pongResponseTImeoutInterval
+        pongResponseTimeoutInterval
     */
     fileprivate func setupPongResponseTimeoutTimer() {
         pongResponseTimeoutTimer = Timer.scheduledTimer(
@@ -664,11 +664,11 @@ import NWWebSocket
             return false
         case .endpoint(authEndpoint: let authEndpoint):
             let request = requestForAuthValue(from: authEndpoint, socketId: socketId, channelName: channel.name)
-            sendAuthorisationRequest(request: request, channel: channel, completionHandler: completionHandler)
+            sendAuthorizationRequest(request: request, channel: channel, completionHandler: completionHandler)
             return true
         case .authRequestBuilder(authRequestBuilder: let builder):
             if let request = builder.requestFor?(socketID: socketId, channelName: channel.name) {
-                sendAuthorisationRequest(request: request, channel: channel, completionHandler: completionHandler)
+                sendAuthorizationRequest(request: request, channel: channel, completionHandler: completionHandler)
                 return true
             } else {
                 let errorMessage = "Authentication request could not be built"
@@ -758,7 +758,7 @@ import NWWebSocket
 
         - parameter endpoint: The authEndpoint to which the request will be made
         - parameter socketId: The socketId of the connection's websocket
-        - parameter channel:  The PusherChannel to authenticate subsciption for
+        - parameter channel:  The PusherChannel to authenticate subscription for
 
         - returns: URLRequest object to be used by the function making the auth request
     */
@@ -777,9 +777,9 @@ import NWWebSocket
         Send authentication request to the authEndpoint specified
 
         - parameter request: The request to send
-        - parameter channel: The PusherChannel to authenticate subsciption for
+        - parameter channel: The PusherChannel to authenticate subscription for
     */
-    fileprivate func sendAuthorisationRequest(request: URLRequest,
+    fileprivate func sendAuthorizationRequest(request: URLRequest,
                                               channel: PusherChannel,
                                               completionHandler: @escaping (PusherAuth?, PusherAuthError?) -> Void) {
         let task = URLSession.dataTask(with: request, completionHandler: { data, response, sessionError in
@@ -846,7 +846,7 @@ import NWWebSocket
 
         - parameter authString:  The auth response as a dictionary
         - parameter channelData: The channelData to send along with the auth request
-        - parameter channel:     The PusherChannel to authorize the subsciption for
+        - parameter channel:     The PusherChannel to authorize the subscription for
     */
     fileprivate func handleAuthInfo(pusherAuth: PusherAuth, channel: PusherChannel) {
         if let decryptionKey = pusherAuth.sharedSecret {
@@ -864,7 +864,7 @@ import NWWebSocket
         Handle presence channel auth response and send subscribe message to Pusher API
 
         - parameter auth:        The auth string
-        - parameter channel:     The PusherChannel to authorize subsciption for
+        - parameter channel:     The PusherChannel to authorize subscription for
         - parameter channelData: The channelData to send along with the auth request
     */
     fileprivate func handlePresenceChannelAuth(
@@ -888,7 +888,7 @@ import NWWebSocket
         Handle private channel auth response and send subscribe message to Pusher API
 
         - parameter auth:    The auth string
-        - parameter channel: The PusherChannel to authenticate subsciption for
+        - parameter channel: The PusherChannel to authenticate subscription for
     */
     fileprivate func handlePrivateChannelAuth(authValue auth: String, channel: PusherChannel) {
         self.sendEvent(

Tests/Integration/PusherClientInitializationTests.swift

@@ -43,7 +43,7 @@ class ClientInitializationTests: XCTestCase {
         XCTAssertEqual(pusher.connection.activityTimeoutInterval, 60, "the activity timeout interval should be 60")
     }
 
-    func testProvidingEcryptedOptionAsFalse() {
+    func testProvidingEncryptedOptionAsFalse() {
         let options = PusherClientOptions(
             useTLS: false
         )

Tests/Unit/Models/PrivateEncryptedChannelTests.swift

@@ -193,7 +193,7 @@ class PrivateEncryptedChannelTests: XCTestCase {
         waitForExpectations(timeout: 1)
 
         // set a new expectation for the error delegate for the second event
-        errorDelegate.expectation = expectation(description: "second event should fail to decrpyt too.")
+        errorDelegate.expectation = expectation(description: "second event should fail to decrypt too.")
 
         // send a second message
         socket.delegate?.webSocketDidReceiveMessage(
@@ -202,7 +202,7 @@ class PrivateEncryptedChannelTests: XCTestCase {
         waitForExpectations(timeout: 1)
     }
 
-    func authorizerReponseSequence(_ authSequence: [PusherAuth]) {
+    func authorizerResponseSequence(_ authSequence: [PusherAuth]) {
         let (pusher, socket) = configurePusherWithAuthMethod(authMethod: AuthMethod.authorizer(authorizer: TestAuthorizer(authSequence)))
         pusher.connect()
 
@@ -238,11 +238,11 @@ class PrivateEncryptedChannelTests: XCTestCase {
     }
 
     func testInitialLoadKeyAuthorizerAuthMethod() {
-        authorizerReponseSequence([validAuth])
+        authorizerResponseSequence([validAuth])
     }
 
     func testReloadKeyAuthorizerAuthMethod() {
-        authorizerReponseSequence([incorrectSharedSecretAuth, validAuth])
+        authorizerResponseSequence([incorrectSharedSecretAuth, validAuth])
     }
 
     func testInitialLoadKeyRequestBuilder() {
@@ -346,12 +346,12 @@ class PrivateEncryptedChannelTests: XCTestCase {
     }
 
     class TestAuthorizer: Authorizer {
-        var authReponseSequence: [PusherAuth]
-        public init(_ authReponseSequence: [PusherAuth]) {
-            self.authReponseSequence = authReponseSequence
+        var authResponseSequence: [PusherAuth]
+        public init(_ authResponseSequence: [PusherAuth]) {
+            self.authResponseSequence = authResponseSequence
         }
         func fetchAuthValue(socketID: String, channelName: String, completionHandler: @escaping (PusherAuth?) -> Void) {
-            completionHandler(authReponseSequence.removeFirst())
+            completionHandler(authResponseSequence.removeFirst())
         }
     }
 
@@ -375,7 +375,7 @@ class PrivateEncryptedChannelTests: XCTestCase {
         }
     }
 
-    // utility method to mock an authorizor response with the jsonData provided
+    // utility method to mock an authorizer response with the jsonData provided
     func mockAuthResponse(jsonData: String, pusher: Pusher) {
         let urlResponse = HTTPURLResponse(
             url: URL(string: "\(authEndpointURL)?channel_name=\(channelName)&socket_id=45481.3166671")!,