Merge pull request #23 from pvzig/feature/client-improvements

Feature/client-improvements

Author: pvzig

Podfile.lock

@@ -1,10 +1,10 @@
 PODS:
-  - Starscream (1.0.2)
+  - Starscream (1.1.2)
 
 DEPENDENCIES:
   - Starscream
 
 SPEC CHECKSUMS:
-  Starscream: 40e2c4c1c770d811f24116b8b7dbeb4542c56767
+  Starscream: 58a12fd35a3cb6aaa105716c2d42765f7c1c732f
 
 COCOAPODS: 0.39.0

README.md

@@ -48,6 +48,11 @@ If you want to receive messages from the Slack RTM API, connect to it.
 client.connect()
 ```
 
+You can also set options for a ping/pong interval, timeout interval, and automatic reconnection:
+```swift
+client.connect(pingInterval: 2, timeout: 10, reconnect: false)
+```
+
 Once connected, the client will begin to consume any messages sent by the Slack RTM API.
 
 ####Web API Methods
@@ -65,6 +70,9 @@ SlackKit currently supports the a subset of the Slack Web APIs that are availabl
 - chat.postMessage
 - chat.update
 - emoji.list
+- files.comments.add
+- files.comments.edit
+- files.comments.delete
 - files.delete
 - files.upload
 - groups.close
@@ -187,8 +195,8 @@ func itemStarred(item: Item, star: Bool)
 
 #####ReactionEventsDelegate
 ```swift
-func reactionAdded(reaction: String?, item: Item?)
-func reactionRemoved(reaction: String?, item: Item?)
+func reactionAdded(reaction: String?, item: Item?, itemUser: String?)
+func reactionRemoved(reaction: String?, item: Item?, itemUser: String?)
 ```
 
 #####TeamEventsDelegate

SlackKit.podspec

@@ -12,5 +12,6 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.source_files = 'SlackKit/Sources/*.swift'  
   s.frameworks = 'Foundation'
-  s.dependency 'Starscream', '~> 1.0.2'
+  s.dependency 'Starscream', '~> 1.1.2'
 end
+

SlackKit/Sources/Channel.swift

@@ -43,7 +43,7 @@ public struct Channel {
     internal(set) public var unread: Int?
     internal(set) public var unreadCountDisplay: Int?
     internal(set) public var hasPins: Bool?
-    internal(set) public var members = [String]()
+    internal(set) public var members: [String]?
     // Client use
     internal(set) public var pinnedItems = [Item]()
     internal(set) public var usersTyping = [String]()
@@ -70,11 +70,7 @@ public struct Channel {
         unread = channel?["unread_count"] as? Int
         unreadCountDisplay = channel?["unread_count_display"] as? Int
         hasPins = channel?["has_pins"] as? Bool
-        
-        if let members = channel?["members"] as? [String] {
-            self.members = members
-        }
-        
+        members = channel?["members"] as? [String]
     }
 
     internal init?(id:String?) {

SlackKit/Sources/Client.swift

@@ -53,7 +53,7 @@ public class Client: WebSocketDelegate {
     public var teamProfileEventsDelegate: TeamProfileEventsDelegate?
 
     internal var token = "SLACK_AUTH_TOKEN"
-
+    
     public func setAuthToken(token: String) {
         self.token = token
     }
@@ -63,15 +63,25 @@ public class Client: WebSocketDelegate {
     }
 
     internal var webSocket: WebSocket?
+    internal let api = NetworkInterface()
     private var dispatcher: EventDispatcher?
 
-    internal let api = NetworkInterface()
+    private let pingPongQueue = dispatch_queue_create("com.launchsoft.SlackKit", DISPATCH_QUEUE_SERIAL)
+    internal var ping: Double?
+    internal var pong: Double?
+    
+    internal var pingInterval: NSTimeInterval?
+    internal var timeout: NSTimeInterval?
+    internal var reconnect: Bool?
 
     required public init(apiToken: String) {
         self.token = apiToken
     }
 
-    public func connect() {
+    public func connect(pingInterval pingInterval: NSTimeInterval? = nil, timeout: NSTimeInterval? = nil, reconnect: Bool? = nil) {
+        self.pingInterval = pingInterval
+        self.timeout = timeout
+        self.reconnect = reconnect
         dispatcher = EventDispatcher(client: self)
         webAPI.rtmStart(success: {
             (response) -> Void in
@@ -85,19 +95,24 @@ public class Client: WebSocketDelegate {
             }, failure:nil)
     }
 
+    public func disconnect() {
+        webSocket?.disconnect()
+    }
+    
     //MARK: - Message send
     public func sendMessage(message: String, channelID: String) {
         if (connected) {
             if let data = formatMessageToSlackJsonString(msg: message, channel: channelID) {
-                let string = NSString(data: data, encoding: NSUTF8StringEncoding)
-                webSocket?.writeString(string as! String)
+                if let string = NSString(data: data, encoding: NSUTF8StringEncoding) as? String {
+                    webSocket?.writeString(string)
+                }
             }
         }
     }
 
     private func formatMessageToSlackJsonString(message: (msg: String, channel: String)) -> NSData? {
         let json: [String: AnyObject] = [
-            "id": NSDate().timeIntervalSince1970,
+            "id": NSDate().slackTimestamp(),
             "type": "message",
             "channel": message.channel,
             "text": message.msg.slackFormatEscaping()
@@ -121,6 +136,52 @@ public class Client: WebSocketDelegate {
         sentMessages[ts!.stringValue] = Message(message: message)
     }
 
+    //MARK: - RTM Ping
+    private func pingRTMServerAtInterval(interval: NSTimeInterval) {
+        let delay = dispatch_time(DISPATCH_TIME_NOW, Int64(interval * Double(NSEC_PER_SEC)))
+        dispatch_after(delay, pingPongQueue, {
+            if self.connected && self.timeoutCheck() {
+                self.sendRTMPing()
+                self.pingRTMServerAtInterval(interval)
+            } else {
+                self.disconnect()
+            }
+        })
+    }
+    
+    private func sendRTMPing() {
+        if connected {
+            let json: [String: AnyObject] = [
+                "id": NSDate().slackTimestamp(),
+                "type": "ping",
+            ]
+            do {
+                let data = try NSJSONSerialization.dataWithJSONObject(json, options: NSJSONWritingOptions.PrettyPrinted)
+                let string = NSString(data: data, encoding: NSUTF8StringEncoding)
+                if let writePing = string as? String {
+                    ping = json["id"] as? Double
+                    webSocket?.writeString(writePing)
+                }
+            }
+            catch _ {
+                
+            }
+        }
+    }
+    
+    private func timeoutCheck() -> Bool {
+        if let pong = pong, ping = ping, timeout = timeout {
+            if pong - ping < timeout {
+                return true
+            } else {
+                return false
+            }
+        // Ping-pong or timeout not configured
+        } else {
+            return true
+        }
+    }
+    
     //MARK: - Client setup
     internal func initialSetup(json: [String: AnyObject]) {
         team = Team(team: json["team"] as? [String: AnyObject])
@@ -207,14 +268,21 @@ public class Client: WebSocketDelegate {
     }
 
     // MARK: - WebSocketDelegate
-    public func websocketDidConnect(socket: WebSocket) {}
+    public func websocketDidConnect(socket: WebSocket) {
+        if let pingInterval = pingInterval {
+            pingRTMServerAtInterval(pingInterval)
+        }
+    }
 
     public func websocketDidDisconnect(socket: WebSocket, error: NSError?) {
         connected = false
         authenticated = false
         webSocket = nil
-        if let delegate = slackEventsDelegate {
-            delegate.clientDisconnected()
+        dispatcher = nil
+        authenticatedUser = nil
+        slackEventsDelegate?.clientDisconnected()
+        if reconnect == true {
+            connect(pingInterval: pingInterval, timeout: timeout, reconnect: reconnect)
         }
     }
 
@@ -223,7 +291,9 @@ public class Client: WebSocketDelegate {
             return
         }
         do {
-            try dispatcher?.dispatch(NSJSONSerialization.JSONObjectWithData(data, options: NSJSONReadingOptions.AllowFragments) as! [String: AnyObject])
+            if let json = try NSJSONSerialization.JSONObjectWithData(data, options: NSJSONReadingOptions.AllowFragments) as? [String: AnyObject] {
+                dispatcher?.dispatch(json)
+            }
         }
         catch _ {
 

SlackKit/Sources/ClientExtensions.swift

@@ -26,20 +26,11 @@ import Foundation
 extension Client {
 
     //MARK: - User & Channel
-    public func getChannelOrUserIdByName(name: String) -> String? {
-        if (name[name.startIndex] == "@") {
-            return getUserIdByName(name)
-        } else if (name[name.startIndex] == "C") {
-            return getChannelIDByName(name)
-        }
-        return nil
-    }
-    
     public func getChannelIDByName(name: String) -> String? {
         return channels.filter{$0.1.name == stripString(name)}.first?.0
     }
 
-    public func getUserIdByName(name: String) -> String? {
+    public func getUserIDByName(name: String) -> String? {
         return users.filter{$0.1.name == stripString(name)}.first?.0
     }
 
@@ -54,13 +45,14 @@ extension Client {
     }
 
     //MARK: - Utilities
-    internal func stripString(var string: String) -> String {
+    internal func stripString(string: String) -> String? {
+        var strippedString: String?
         if string[string.startIndex] == "@" {
-            string = string.substringFromIndex(string.startIndex.advancedBy(1))
+            strippedString = string.substringFromIndex(string.startIndex.advancedBy(1))
         } else if string[string.startIndex] == "#" {
-            string = string.substringFromIndex(string.startIndex.advancedBy(1))
+            strippedString = string.substringFromIndex(string.startIndex.advancedBy(1))
         }
-        return string
+        return strippedString
     }
 
 }
@@ -78,8 +70,8 @@ internal extension String {
 
 public extension NSDate {
 
-    func slackTimestamp() -> String {
-        return NSNumber(double: timeIntervalSince1970).stringValue
+    func slackTimestamp() -> Double {
+        return NSNumber(double: timeIntervalSince1970).doubleValue
     }
 
 }

SlackKit/Sources/Event.swift

@@ -62,6 +62,7 @@ internal enum EventType: String {
     case FileCommentDeleted = "file_comment_deleted"
     case PinAdded = "pin_added"
     case PinRemoved = "pin_removed"
+    case Pong = "pong"
     case PresenceChange = "presence_change"
     case ManualPresenceChange = "manual_presence_change"
     case PrefChange = "pref_change"

SlackKit/Sources/EventDispatcher.swift

@@ -96,6 +96,8 @@ internal class EventDispatcher {
                 handler.pinAdded(event)
             case .PinRemoved:
                 handler.pinRemoved(event)
+            case .Pong:
+                handler.pong(event)
             case .PresenceChange:
                 handler.presenceChange(event)
             case .ManualPresenceChange:
@@ -146,7 +148,7 @@ internal class EventDispatcher {
                 // Other clients should ignore this event.
                 break
             case .TeamMigrationStarted:
-                client.connect()
+                client.connect(pingInterval: client.pingInterval, timeout: client.timeout, reconnect: client.reconnect)
             case .ReconnectURL:
                 // The reconnect_url event is currently unsupported and experimental.
                 break

SlackKit/Sources/EventHandler.swift

@@ -38,6 +38,11 @@ internal class EventHandler {
         }
     }
 
+    //MARK: - Pong
+    func pong(event: Event) {
+        client.pong = event.replyTo
+    }
+    
     //MARK: - Messages
     func messageSent(event: Event) {
         if let reply = event.replyTo, message = client.sentMessages[NSNumber(double: reply).stringValue], channel = message.channel, ts = message.ts {
@@ -147,8 +152,8 @@ internal class EventHandler {
 
     func channelLeft(event: Event) {
         if let channel = event.channel, id = channel.id, userID = client.authenticatedUser?.id {
-            if let index = client.channels[id]?.members.indexOf(userID) {
-                client.channels[id]?.members.removeAtIndex(index)
+            if let index = client.channels[id]?.members?.indexOf(userID) {
+                client.channels[id]?.members?.removeAtIndex(index)
 
                 if let delegate = client.channelEventsDelegate {
                     delegate.channelLeft(channel)

SlackKit/Sources/File.swift

@@ -62,7 +62,7 @@ public struct File {
     internal(set) public var comments = [String: Comment]()
     internal(set) public var reactions = [String: Reaction]()
 
-    init?(file:[String: AnyObject]?) {
+    public init?(file:[String: AnyObject]?) {
         id = file?["id"] as? String
         created = file?["created"] as? Int
         name = file?["name"] as? String
@@ -105,7 +105,7 @@ public struct File {
 
     }
 
-    init?(id:String?) {
+    internal init?(id:String?) {
         self.id = id
         created = nil
         name = nil