Merge pull request #161 from pusher/set-subscriptions

Implement setSubscriptions

Author: lukabratos

CHANGELOG.md

@@ -1,4 +1,14 @@
 # Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/pusher/pusher-websocket-swift/compare/5.1.0...HEAD)
+
+## [5.1.0](https://github.com/pusher/pusher-websocket-swift/compare/5.0.1...5.1.0) - 2017-11-23
+## Added
+- [`setSubscriptions`](https://pusher.com/docs/push_notifications/reference/client_api#put-v1clientsclientidinterests) method.
 
 ## 5.0.1
 

PusherSwift.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'PusherSwift'
-  s.version          = '5.0.1'
+  s.version          = '5.1.0'
   s.summary          = 'A Pusher client library in Swift'
   s.homepage         = 'https://github.com/pusher/pusher-websocket-swift'
   s.license          = 'MIT'

Sources/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>5.0.1</string>
+	<string>5.1.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Sources/NativePusher.swift

@@ -156,6 +156,22 @@ import Foundation
         addSubscriptionChangeToTaskQueue(interestName: interestName, change: .subscribe)
     }
 
+    /**
+     Subscribe to interests with Pusher's Push Notification Service
+
+     - parameter interests: the name of the interests you want to subscribe to
+     */
+    open func setSubscriptions(interests: Array<String>) {
+        requestQueue.tasks += { _, next in
+            self.replaceSubscriptionSet(
+                interests: interests,
+                successCallback: next
+            )
+        }
+        
+        requestQueue.run()
+    }
+
     /**
         Unsubscribe from an interest with Pusher's Push Notification Service
 
@@ -176,7 +192,7 @@ import Foundation
     */
     private func addSubscriptionChangeToTaskQueue(interestName: String, change: SubscriptionChange) {
         requestQueue.tasks += { _, next in
-            self.modifySubscription(
+            self.subscribeOrUnsubscribeInterest(
                 interest: interestName,
                 change: change,
                 successCallback: next
@@ -188,98 +204,125 @@ import Foundation
 
     /**
         Makes either a POST or DELETE request for a given interest
-
-        - parameter pusherAppKey: The app key for the Pusher app
-        - parameter clientId:     The clientId returned by Pusher's server
-        - parameter interest:     The name of the interest to be subscribed to /
-                                  unsunscribed from
+        - parameter interest:     The name of the interest to be subscribed to / unsunscribed from
         - parameter change:       Whether to subscribe or unsubscribe
         - parameter callback:     Callback to be called upon success
     */
-    private func modifySubscription(interest: String, change: SubscriptionChange, successCallback: @escaping (Any?) -> Void) {
-        guard pusherAppKey != nil && clientId != nil else {
-            self.delegate?.debugLog?(message: "pusherAppKey \(String(describing: pusherAppKey)) or clientId \(String(describing: clientId)) not set - waiting for both to be set")
+    private func subscribeOrUnsubscribeInterest(interest: String, change: SubscriptionChange, successCallback: @escaping (Any?) -> Void) {
+        guard
+            let clientId = clientId,
+            let pusherAppKey = pusherAppKey
+        else {
+            self.delegate?.debugLog?(message: "pusherAppKey or clientId not set - waiting for both to be set")
             self.requestQueue.pauseAndResetCurrentTask()
             return
         }
 
-        self.delegate?.debugLog?(message: "Attempt number: \(self.failedRequestAttempts + 1) of \(maxFailedRequestAttempts)")
+        let url = "\(CLIENT_API_V1_ENDPOINT)/clients/\(clientId)/interests/\(interest)"
+        let params: [String: Any] = ["app_key": pusherAppKey]
+        let request = self.setRequest(url: url, params: params, change: change)
+        self.doURLRequest(interests: [interest], request: request, change: change, successCallback: successCallback)
+    }
 
-        let url = "\(CLIENT_API_V1_ENDPOINT)/clients/\(clientId!)/interests/\(interest)"
-        var request = URLRequest(url: URL(string: url)!)
-        request.httpMethod = change.httpMethod()
+    /**
+     Makes a PUT request for given interests
+     - parameter interests:    The name of the interests to be subscribed to
+     - parameter callback:     Callback to be called upon success
+     */
+    private func replaceSubscriptionSet(interests: Array<String>, successCallback: @escaping (Any?) -> Void) {
+        guard
+            let clientId = clientId,
+            let pusherAppKey = pusherAppKey
+        else {
+            self.delegate?.debugLog?(message: "pusherAppKey or clientId not set - waiting for both to be set")
+            self.requestQueue.pauseAndResetCurrentTask()
+            return
+        }
 
-        let params: [String: Any] = ["app_key": pusherAppKey!]
-        try! request.httpBody = JSONSerialization.data(withJSONObject: params, options: [])
+        let url = "\(CLIENT_API_V1_ENDPOINT)/clients/\(clientId)/interests/"
+        let params: [String: Any] = ["app_key": pusherAppKey, "interests": interests]
+        let request = self.setRequest(url: url, params: params, change: .setSubscriptions)
+        self.doURLRequest(interests: interests, request: request, change: .setSubscriptions, successCallback: successCallback)
+    }
 
-        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
-        request.addValue(LIBRARY_NAME_AND_VERSION, forHTTPHeaderField: "X-Pusher-Library")
+    private func doURLRequest(interests: Array<String>, request: URLRequest, change: SubscriptionChange, successCallback: @escaping (Any?) -> Void) {
+        self.delegate?.debugLog?(message: "Attempt number: \(self.failedRequestAttempts + 1) of \(maxFailedRequestAttempts)")
 
         let task = URLSession.dataTask(
             with: request,
             completionHandler: { data, response, error in
                 guard let httpResponse = response as? HTTPURLResponse,
-                          (200 <= httpResponse.statusCode && httpResponse.statusCode < 300) &&
-                          error == nil
-                else {
-                    self.failedRequestAttempts += 1
-
-                    if error != nil {
-                        self.delegate?.debugLog?(message: "Error when trying to modify subscription to interest: \(String(describing: error?.localizedDescription))")
-                    } else if data != nil && response != nil {
-                        let responseBody = String(data: data!, encoding: .utf8)
-                        self.delegate?.debugLog?(message: "Bad response from server: \(response!) with body: \(String(describing: responseBody))")
-                    } else {
-                        self.delegate?.debugLog?(message: "Bad response from server when trying to modify subscription to interest: \(interest)")
-                    }
-
-                    if self.failedRequestAttempts >= self.maxFailedRequestAttempts {
-                        self.delegate?.debugLog?(message: "Max number of failed native service requests reached")
-
-                        self.requestQueue.paused = true
-                    } else {
-                        self.delegate?.debugLog?(message: "Retrying subscription modification request for interest: \(interest)")
-                        self.requestQueue.retry(Double(self.failedRequestAttempts * self.failedRequestAttempts))
-                    }
-
-                    return
+                    (200 <= httpResponse.statusCode && httpResponse.statusCode < 300) &&
+                        error == nil
+                    else {
+                        self.failedRequestAttempts += 1
+
+                        if error != nil {
+                            self.delegate?.debugLog?(message: "Error when trying to modify subscription to interest(s): \(String(describing: error?.localizedDescription))")
+                        } else if data != nil && response != nil {
+                            let responseBody = String(data: data!, encoding: .utf8)
+                            self.delegate?.debugLog?(message: "Bad response from server: \(response!) with body: \(String(describing: responseBody))")
+                        } else {
+                            self.delegate?.debugLog?(message: "Bad response from server when trying to modify subscription to interest(s): \(interests)")
+                        }
+
+                        if self.failedRequestAttempts >= self.maxFailedRequestAttempts {
+                            self.delegate?.debugLog?(message: "Max number of failed native service requests reached")
+
+                            self.requestQueue.paused = true
+                        } else {
+                            self.delegate?.debugLog?(message: "Retrying subscription modification request for interest(s): \(interests)")
+                            self.requestQueue.retry(Double(self.failedRequestAttempts * self.failedRequestAttempts))
+                        }
+
+                        return
                 }
 
                 switch change {
                 case .subscribe:
+                    guard let interest = interests.first else { return }
                     self.delegate?.subscribedToInterest?(name: interest)
+                case .setSubscriptions:
+                    self.delegate?.subscribedToInterests?(interests: interests)
                 case .unsubscribe:
+                    guard let interest = interests.first else { return }
                     self.delegate?.unsubscribedFromInterest?(name: interest)
                 }
 
-                self.delegate?.debugLog?(message: "Success making \(change.stringValue) to \(interest)")
+                self.delegate?.debugLog?(message: "Success making \(change.rawValue) to \(interests)")
 
                 self.failedRequestAttempts = 0
                 successCallback(nil)
-            }
+        }
         )
 
         task.resume()
     }
+
+    private func setRequest(url: String, params: [String: Any], change: SubscriptionChange) -> URLRequest {
+        var request = URLRequest(url: URL(string: url)!)
+        request.httpMethod = change.httpMethod()
+
+        try! request.httpBody = JSONSerialization.data(withJSONObject: params, options: [])
+
+        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
+        request.addValue(LIBRARY_NAME_AND_VERSION, forHTTPHeaderField: "X-Pusher-Library")
+
+        return request
+    }
 }
 
-internal enum SubscriptionChange {
+internal enum SubscriptionChange: String {
     case subscribe
+    case setSubscriptions
     case unsubscribe
 
-    internal func stringValue() -> String {
-        switch self {
-        case .subscribe:
-            return "subscribe"
-        case .unsubscribe:
-            return "unsubscribe"
-        }
-    }
-
     internal func httpMethod() -> String {
         switch self {
         case .subscribe:
             return "POST"
+        case .setSubscriptions:
+            return "PUT"
         case .unsubscribe:
             return "DELETE"
         }

Sources/PusherDelegate.swift

@@ -12,6 +12,7 @@
     @objc optional func registeredForPushNotifications(clientId: String)
     @objc optional func failedToRegisterForPushNotifications(response: URLResponse, responseBody: String?)
     @objc optional func subscribedToInterest(name: String)
+    @objc optional func subscribedToInterests(interests: Array<String>)
     @objc optional func unsubscribedFromInterest(name: String)
 
     @objc optional func changedConnectionState(from old: ConnectionState, to new: ConnectionState)

Sources/PusherSwift.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 let PROTOCOL = 7
-let VERSION = "5.0.1"
+let VERSION = "5.1.0"
 let CLIENT_NAME = "pusher-websocket-swift"
 
 @objcMembers

Tests/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>5.0.1</string>
+	<string>5.1.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Tests/PusherClientInitializationTests.swift

@@ -9,7 +9,7 @@
 import PusherSwift
 import XCTest
 
-let VERSION = "5.0.1"
+let VERSION = "5.1.0"
 
 class ClientInitializationTests: XCTestCase {
     var key: String!