Fix capitalization and property names

jackcook · jackcook · commit d09aa42583ec · 2016-08-17T10:27:44.000-04:00
diff --git a/BeamAPI.podspec b/BeamAPI.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name       = "BeamAPI"
-  s.version    = "1.2"
+  s.version    = "1.2.1"
   s.summary    = "An interface to communicate with Beam's backend."
   s.homepage   = "https://github.com/WatchBeam/beam-client-swift"
   s.license    = "MIT"
diff --git a/Example/Tests/InteractiveClientTests.swift b/Example/Tests/InteractiveClientTests.swift
@@ -31,7 +31,7 @@ class InteractiveClientTests: XCTestCase, InteractiveClientDelegate {
             
             self.channel = channel
             
-            BeamClient.sharedClient.Interactive.getInteractiveDataByChannel(self.channel.id) { (data, error) in
+            BeamClient.sharedClient.interactive.getInteractiveDataByChannel(self.channel.id) { (data, error) in
                 guard let address = data?.address else {
                     XCTFail()
                     return
@@ -47,22 +47,22 @@ class InteractiveClientTests: XCTestCase, InteractiveClientDelegate {
     }
     
     func testConnect() {
-        expectation = expectationWithDescription("test joining a channel through Interactive")
+        expectation = expectationWithDescription("test joining a channel with interactive capabilities")
         
         client = InteractiveClient(delegate: self)
         client.connect(url: address, channelId: channel.id)
         
         waitForExpectationsWithTimeout(10, handler: nil)
     }
     
-    func InteractiveDidConnect() {
+    func interactiveDidConnect() {
         client.disconnect()
     }
     
-    func InteractiveDidDisconnect() {
+    func interactiveDidDisconnect() {
         expectation.fulfill()
     }
     
-    func InteractiveChangedState(state: String) {}
-    func InteractiveReceivedPacket(packet: InteractivePacket) {}
+    func interactiveChangedState(state: String) {}
+    func interactiveReceivedPacket(packet: InteractivePacket) {}
 }
diff --git a/Example/Tests/InteractiveTests.swift b/Example/Tests/InteractiveTests.swift
@@ -14,9 +14,9 @@ class InteractiveTests: XCTestCase {
     let channelId = 50772
     
     func testInteractiveData() {
-        let expectation = expectationWithDescription("tests the Interactive data endpoint")
+        let expectation = expectationWithDescription("tests the interactive data endpoint")
         
-        BeamClient.sharedClient.Interactive.getInteractiveDataByChannel(channelId) { (data, error) in
+        BeamClient.sharedClient.interactive.getInteractiveDataByChannel(channelId) { (data, error) in
             XCTAssertNotNil(data)
             XCTAssertNil(error)
             expectation.fulfill()
diff --git a/Pod/Classes/Clients/BeamClient.swift b/Pod/Classes/Clients/BeamClient.swift
@@ -29,6 +29,9 @@ public class BeamClient {
     /// The property through which all ingest methods are accessed.
     public let ingests: IngestsRoutes
     
+    /// The property through which all interactive methods are accessed.
+    public let interactive: InteractiveRoutes
+    
     /// The property through which all notification methods are accessed.
     public let notifications: NotificationsRoutes
     
@@ -44,9 +47,6 @@ public class BeamClient {
     /// The property through which all team methods are accessed.
     public let teams: TeamsRoutes
     
-    /// The property through which all Interactive methods are accessed.
-    public let Interactive: InteractiveRoutes
-    
     /// The property through which all type methods are accessed.
     public let types: TypesRoutes
     
@@ -59,12 +59,12 @@ public class BeamClient {
         channels = ChannelsRoutes()
         chat = ChatRoutes()
         ingests = IngestsRoutes()
+        interactive = InteractiveRoutes()
         notifications = NotificationsRoutes()
         oauth = OAuthRoutes()
         recordings = RecordingsRoutes()
         shop = ShopRoutes()
         teams = TeamsRoutes()
-        Interactive = InteractiveRoutes()
         types = TypesRoutes()
         users = UsersRoutes()
     }
diff --git a/Pod/Classes/Clients/InteractiveClient.swift b/Pod/Classes/Clients/InteractiveClient.swift
@@ -9,7 +9,7 @@
 import Starscream
 import SwiftyJSON
 
-/// Used to connect to a channel's interactive controls through our Interactive protocol.
+/// Used to connect to a channel's interactive controls through our interactive protocol.
 public class InteractiveClient: WebSocketDelegate {
     
     // MARK: Properties
@@ -26,25 +26,25 @@ public class InteractiveClient: WebSocketDelegate {
     /// The id of the authenticated user in the app.
     private var userId: Int?
     
-    /// The current Interactive control state.
+    /// The current interactive control state.
     private var state: String?
     
     /// The websocket through which control updates are received and sent.
     private var socket: WebSocket?
     
     /// Initializes an interactive connection, which needs to be stored by your own class.
-    public init(delegate InteractiveDelegate: InteractiveClientDelegate) {
-        delegate = InteractiveDelegate
+    public init(delegate interactiveDelegate: InteractiveClientDelegate) {
+        delegate = interactiveDelegate
     }
     
     // MARK: Public Methods
     
     /**
      Connects to an interactive channel given data that is received with InteractiveRoutes.getInteractiveDataByChannel
     
-     :param: url The base URL of the Interactive server being connected to.
+     :param: url The base URL of the interactive server being connected to.
      :param: channelId The id of the channel being connected to.
-     :param: key The key used to authenticate with Interactive.
+     :param: key The key used to authenticate with interactive.
      :param: userId The id of the authenticated user in the app.
      */
     public func connect(url baseUrl: String, channelId: Int, key: String? = nil, userId: Int? = nil) {
@@ -61,13 +61,13 @@ public class InteractiveClient: WebSocketDelegate {
         socket?.connect()
     }
     
-    /// Disconnects from the Interactive server.
+    /// Disconnects from the interactive server.
     public func disconnect() {
         self.socket?.disconnect()
     }
     
     /**
-     Sends a packet to the Interactive server.
+     Sends a packet to the interactive server.
      
      :param: packet The packet being sent.
      */
@@ -86,14 +86,14 @@ public class InteractiveClient: WebSocketDelegate {
     private func updateState(state: String) {
         if state != self.state {
             self.state = state
-            delegate?.InteractiveChangedState(state)
+            delegate?.interactiveChangedState(state)
         }
     }
     
     // MARK: WebSocketDelegate
     
     public func websocketDidConnect(socket: WebSocket) {
-        delegate?.InteractiveDidConnect()
+        delegate?.interactiveDidConnect()
         
         guard let authKey = authKey,
             userId = userId else {
@@ -108,13 +108,13 @@ public class InteractiveClient: WebSocketDelegate {
     }
     
     public func websocketDidDisconnect(socket: WebSocket, error: NSError?) {
-        delegate?.InteractiveDidDisconnect()
+        delegate?.interactiveDidDisconnect()
     }
     
     public func websocketDidReceiveMessage(socket: WebSocket, text: String) {
         if let (packet, state) = InteractivePacket.receivePacket(text) {
             if let packet = packet {
-                delegate?.InteractiveReceivedPacket(packet)
+                delegate?.interactiveReceivedPacket(packet)
             }
             
             if let state = state {
@@ -127,18 +127,18 @@ public class InteractiveClient: WebSocketDelegate {
     }
 }
 
-/// The Interactive client's delegate, through which information is relayed to your app.
+/// The interactive client's delegate, through which information is relayed to your app.
 public protocol InteractiveClientDelegate: class {
     
-    /// Called when a connection is made to the Interactive server.
-    func InteractiveDidConnect()
+    /// Called when a connection is made to the interactive server.
+    func interactiveDidConnect()
     
     /// Called when the client disconnects, whether on purpose or due to an error.
-    func InteractiveDidDisconnect()
+    func interactiveDidDisconnect()
     
     /// Called when the control state is changed by the broadcaster.
-    func InteractiveChangedState(state: String)
+    func interactiveChangedState(state: String)
     
     /// Called when a packet is received and interpreted.
-    func InteractiveReceivedPacket(packet: InteractivePacket)
+    func interactiveReceivedPacket(packet: InteractivePacket)
 }
diff --git a/Pod/Classes/Models/BeamChannel.swift b/Pod/Classes/Models/BeamChannel.swift
@@ -59,8 +59,8 @@ public struct BeamChannel {
     /// True if the channel's content is interactive.
     public let interactive: Bool
     
-    /// The id of the Interactive game being used by the channel.
-    public let InteractiveGameId: Int?
+    /// The id of the interactive game being used by the channel.
+    public let interactiveGameId: Int?
     
     /// FTL is enabled if this value is > 0.
     public let ftl: Int
@@ -163,7 +163,7 @@ public struct BeamChannel {
         desc = json["description"].string
         typeId = json["typeId"].int
         interactive = json["interactive"].bool ?? (json["interactive"].int ?? 0) == 1
-        InteractiveGameId = json["InteractiveGameId"].int
+        interactiveGameId = json["tetrisGameId"].int
         ftl = json["ftl"].int ?? 0
         hasVod = json["hasVod"].bool ?? false
         createdAt = NSDate.fromBeam(json["createdAt"].string)
diff --git a/Pod/Classes/Models/Constellation/ConstellationPacket.swift b/Pod/Classes/Models/Constellation/ConstellationPacket.swift
@@ -14,6 +14,10 @@ public class ConstellationPacket {
     /// The string of the packet's raw JSON data.
     private var packetString: String?
     
+    /// Initializes an empty constellation packet.
+    public init() {
+    }
+    
     class func prepareToSend(packet: ConstellationSendable) -> String {
         let packet = [
             "type": "method",
diff --git a/Pod/Classes/Models/Interactive/InteractiveControl.swift b/Pod/Classes/Models/Interactive/InteractiveControl.swift
@@ -8,7 +8,7 @@
 
 import SwiftyJSON
 
-/// A base Interactive control object.
+/// A base interactive control object.
 public class InteractiveControl {
     
     /// The control's blueprint, containing valid configurations.
diff --git a/Pod/Classes/Models/Interactive/InteractiveData.swift b/Pod/Classes/Models/Interactive/InteractiveData.swift
@@ -11,10 +11,10 @@ import SwiftyJSON
 /// Holds data retrieved by InteractiveRoutes.getInteractiveDataByChannel.
 public struct InteractiveData {
     
-    /// The URL address of the Interactive server that should be connected to.
+    /// The URL address of the interactive server that should be connected to.
     public let address: String?
     
-    /// The key used for authentication with the Interactive servers.
+    /// The key used for authentication with the interactive servers.
     public let key: String?
     
     /// The id of the user being authenticated.
diff --git a/Pod/Classes/Models/Interactive/InteractiveVersion.swift b/Pod/Classes/Models/Interactive/InteractiveVersion.swift
@@ -8,7 +8,7 @@
 
 import SwiftyJSON
 
-/// The version of Interactive controls being used by a channel.
+/// The version of interactive controls being used by a channel.
 public struct InteractiveVersion {
     
     /// The version's identifier.
diff --git a/Pod/Classes/Models/Interactive/Packets/HandshakeAcknowledgmentPacket.swift b/Pod/Classes/Models/Interactive/Packets/HandshakeAcknowledgmentPacket.swift
@@ -8,7 +8,7 @@
 
 import SwiftyJSON
 
-/// A packet received when a handshake has been acknowledged by the Interactive servers.
+/// A packet received when a handshake has been acknowledged by the interactive servers.
 public class InteractiveHandshakeAcknowledgmentPacket: InteractivePacket {
     
     /// The current control state.
diff --git a/Pod/Classes/Models/Interactive/Packets/InteractiveErrorPacket.swift b/Pod/Classes/Models/Interactive/Packets/InteractiveErrorPacket.swift
@@ -8,7 +8,7 @@
 
 import SwiftyJSON
 
-/// A packet received when an error has occurred with Interactive.
+/// A packet received when an error has occurred with interactive.
 public class InteractiveErrorPacket: InteractivePacket {
     
     /// The error message.
diff --git a/Pod/Classes/Models/Interactive/Packets/InteractiveHandshakePacket.swift b/Pod/Classes/Models/Interactive/Packets/InteractiveHandshakePacket.swift
@@ -6,13 +6,13 @@
 //
 //
 
-/// A packet sent to initialize a handshake with Interactive.
+/// A packet sent to initialize a handshake with interactive.
 public class InteractiveHandshakePacket: InteractivePacket, InteractiveSendable {
     
     /// The id of the user being authenticated.
     public let id: Int?
     
-    /// The authentication key required by Interactive for authentication.
+    /// The authentication key required by interactive for authentication.
     public let key: String?
     
     /// Used when there is no locally authenticated user.
@@ -27,7 +27,7 @@ public class InteractiveHandshakePacket: InteractivePacket, InteractiveSendable
      Used when there is a locally authenticated user.
      
      :param: id The id of the user being authenticated.
-     :param: key The authentication key required by Interactive for authentication.
+     :param: key The authentication key required by interactive for authentication.
      */
     public init(id: Int, key: String) {
         self.id = id
diff --git a/Pod/Classes/Models/Interactive/Packets/InteractivePacket.swift b/Pod/Classes/Models/Interactive/Packets/InteractivePacket.swift
@@ -8,7 +8,7 @@
 
 import SwiftyJSON
 
-/// The base Interactive packet class. Also has methods used to send and receive Interactive packets.
+/// The base interactive packet class. Also has methods used to send and receive interactive packets.
 public class InteractivePacket {
     
     /// The string of the packet's raw data.
@@ -26,7 +26,7 @@ public class InteractivePacket {
      Creates a raw packet string from an interactive packet object.
      
      :param: packet The packet being sent by the app.
-     :returns: The raw packet string to be sent to the Interactive servers.
+     :returns: The raw packet string to be sent to the interactive servers.
      */
     class func prepareToSend(packet: InteractiveSendable) -> String {
         let method = packet.identifier
@@ -58,10 +58,10 @@ public class InteractivePacket {
     }
     
     /**
-     Interprets JSON packets received from the Interactive servers.
+     Interprets JSON packets received from the interactive servers.
      
      :param: string The string being interpreted.
-     :returns: A tuple with the Interactive packet and the current control state, if it has been updated.
+     :returns: A tuple with the interactive packet and the current control state, if it has been updated.
      */
     class func receivePacket(string: String) -> (packet: InteractivePacket?, state: String?)? {
         var packet: InteractivePacket?
diff --git a/Pod/Classes/Models/Interactive/Packets/InteractiveSendable.swift b/Pod/Classes/Models/Interactive/Packets/InteractiveSendable.swift
@@ -6,7 +6,7 @@
 //
 //
 
-/// The protocol inherited by Interactive packets that are being sent.
+/// The protocol adopted by interactive packets that are being sent.
 public protocol InteractiveSendable {
     
     /// The packet's data.
diff --git a/Pod/Classes/Routes/InteractiveRoutes.swift b/Pod/Classes/Routes/InteractiveRoutes.swift
@@ -12,10 +12,10 @@ public class InteractiveRoutes {
     // MARK: Retrieving Interactive Data
     
     /**
-     Retrieves details used to connect to a channel's Interactive socket.
+     Retrieves details used to connect to a channel's interactive socket.
     
      :param: channelId The id of the channel being connected to.
-     :param: completion An optional completion block with retrieved Interactive details.
+     :param: completion An optional completion block with retrieved interactive details.
      */
     public func getInteractiveDataByChannel(channelId: Int, completion: ((data: InteractiveData?, error: BeamRequestError?) -> Void)?) {
         BeamRequest.request("/interactive/\(channelId)") { (json, error) in

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class InteractiveClientTests: XCTestCase, InteractiveClientDelegate {`
`31`	`31`
`32`	`32`	`self.channel = channel`
`33`	`33`
`34`		`- BeamClient.sharedClient.Interactive.getInteractiveDataByChannel(self.channel.id) { (data, error) in`
	`34`	`+ BeamClient.sharedClient.interactive.getInteractiveDataByChannel(self.channel.id) { (data, error) in`
`35`	`35`	`guard let address = data?.address else {`
`36`	`36`	`XCTFail()`
`37`	`37`	`return`
`@@ -47,22 +47,22 @@ class InteractiveClientTests: XCTestCase, InteractiveClientDelegate {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`func testConnect() {`
`50`		`- expectation = expectationWithDescription("test joining a channel through Interactive")`
	`50`	`+ expectation = expectationWithDescription("test joining a channel with interactive capabilities")`
`51`	`51`
`52`	`52`	`client = InteractiveClient(delegate: self)`
`53`	`53`	`client.connect(url: address, channelId: channel.id)`
`54`	`54`
`55`	`55`	`waitForExpectationsWithTimeout(10, handler: nil)`
`56`	`56`	`}`
`57`	`57`
`58`		`- func InteractiveDidConnect() {`
	`58`	`+ func interactiveDidConnect() {`
`59`	`59`	`client.disconnect()`
`60`	`60`	`}`
`61`	`61`
`62`		`- func InteractiveDidDisconnect() {`
	`62`	`+ func interactiveDidDisconnect() {`
`63`	`63`	`expectation.fulfill()`
`64`	`64`	`}`
`65`	`65`
`66`		`- func InteractiveChangedState(state: String) {}`
`67`		`- func InteractiveReceivedPacket(packet: InteractivePacket) {}`
	`66`	`+ func interactiveChangedState(state: String) {}`
	`67`	`+ func interactiveReceivedPacket(packet: InteractivePacket) {}`
`68`	`68`	`}`