Cleaned code with swiftlint, changed name of app to Watson ML

dokun1 · dokun1 · commit e835ba301701 · 2018-05-16T23:48:17.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -72,5 +72,3 @@ fastlane/test_output
 # The frameworks folder is where they should go, but keep the frameworks themselves out of Xcode
 Frameworks/*
 
-**/WatsonMLClientCredentials.json
-
diff --git a/Server/rainbow-server/.swiftlint.yml b/Server/rainbow-server/.swiftlint.yml
@@ -1,5 +1,6 @@
 disabled_rules:
   - line_length
+  - trailing_whitespace
 file_length:
   warning: 600
   error: 1000
diff --git a/Server/rainbow-server/Sources/Application/Constant.swift b/Server/rainbow-server/Sources/Application/Constant.swift
@@ -8,8 +8,6 @@
 import Foundation
 
 public struct Constant {
-    
-    public static let NOTIFICATION_MESSAGE_KNOCKED_FROM_TOP: String = "You have been knocked from the top spot on the leaderboard. Play again to reclaim your spot!"
-    public static let NOTIFICATION_MESSAGE_KNOCKED_FROM_TOP_TEN: String = "ou have been knocked from the top ten spots of the leaderboard. Play again to reclaim your spot!"
-    
+    public static let knockedFromTop = "You have been knocked from the top spot on the leaderboard. Play again to reclaim your spot!"
+    public static let knockedFromTopTen = "You have been knocked from the top ten spots of the leaderboard. Play again to reclaim your spot!"
 }
diff --git a/Server/rainbow-server/Sources/Application/EncodedPassword.swift b/Server/rainbow-server/Sources/Application/EncodedPassword.swift
@@ -35,7 +35,6 @@ public class EncodedPassword {
     /// hashed password
     private let encodedPassword: [UInt8]
     
-    
     ///
     /// Initialize an EncodedPassword object
     ///
@@ -49,7 +48,7 @@ public class EncodedPassword {
                 usingSalt saltFromUser: [UInt8]? = nil, encoding: SecureEncoding) throws {
         
         // Define our constants
-        let mySaltLength:UInt = 32
+        let mySaltLength: UInt = 32
         let myRoundsOfPBKDF: UInt32 = 2
         
         let mySalt: [UInt8] = try saltFromUser ?? Random.generate(byteCount: Int(mySaltLength))
@@ -60,7 +59,7 @@ public class EncodedPassword {
         userName = name
         encodingType = encoding
         
-        switch (encoding) {
+        switch encoding {
         case .PBKDF2:
             encodedPassword = try PBKDF.deriveKey(fromPassword: password, salt: mySalt,
                                               prf: .sha512, rounds: roundsOfPBKDF,
@@ -76,16 +75,14 @@ public class EncodedPassword {
     /// Verify the password passed with the input password
     /// this is done by encoding the input password and comparing the two encoded passwords.
     ///
-    public func verifyPassword(withPassword testPassword: String) throws -> Bool{
-        let testPassword_encoded: [UInt8]
-        switch (encodingType) {
+    public func verifyPassword(withPassword testPassword: String) throws -> Bool {
+        let testPasswordEncoded: [UInt8]
+        switch encodingType {
         case .PBKDF2:
-            testPassword_encoded = try PBKDF.deriveKey(fromPassword: testPassword, salt: salt,
-                                                   prf: .sha512, rounds: roundsOfPBKDF,
-                                                   derivedKeyLength: saltLength)
+            testPasswordEncoded = try PBKDF.deriveKey(fromPassword: testPassword, salt: salt, prf: .sha512, rounds: roundsOfPBKDF, derivedKeyLength: saltLength)
         default:
             throw EncodedPasswordError.invalidEncoding
         }
-        return ( encodedPassword == testPassword_encoded)
+        return encodedPassword == testPasswordEncoded
     }    
 }
diff --git a/Server/rainbow-server/Sources/Application/Model/Authentication.swift b/Server/rainbow-server/Sources/Application/Model/Authentication.swift
@@ -13,7 +13,7 @@ struct Authentication: Codable {
     var password: String
 }
 
-extension Authentication{
+extension Authentication {
     init(document: JSON) {
         username = document["username"].stringValue
         password = document["password"].stringValue
diff --git a/Server/rainbow-server/Sources/Application/Model/AuthenticationPersistence.swift b/Server/rainbow-server/Sources/Application/Model/AuthenticationPersistence.swift
@@ -10,7 +10,7 @@ import CouchDB
 import LoggerAPI
 import SwiftyJSON
 
-extension Authentication{
+extension Authentication {
     class Persistence {
         private static func getDatabase(from client: CouchDBClient, completion: @escaping (_ database: Database?, _ error: Error?) -> Void) {
             client.dbExists("routes-users") { exists, error in
@@ -27,7 +27,7 @@ extension Authentication{
                 guard let database = database else {
                     return completion(nil, error)
                 }
-                database.retrieveAll(includeDocuments: true, callback: { documents, retrieveError in
+                database.retrieveAll(includeDocuments: true, callback: { documents, _ in
                     guard let documents = documents else {
                         return completion(nil, error)
                     }
diff --git a/Server/rainbow-server/Sources/Application/Model/EntryPersistence.swift b/Server/rainbow-server/Sources/Application/Model/EntryPersistence.swift
@@ -36,20 +36,20 @@ extension ScoreEntry {
                 guard let updatedCopy = entryCopy.toJSONDocument() else {
                     return completion(nil, RainbowPersistenceError.noAvatar)
                 }
-                database.create(updatedCopy, callback: { id, _, _, error in
-                    completion(id, error)
+                database.create(updatedCopy, callback: { identifier, _, _, error in
+                    completion(identifier, error)
                 })
             }
         }
         
         // Update document        
-        static func update(id: String, entry: ScoreEntry, to client: CouchDBClient, completion: @escaping (_ entryID: String?, _ error: Error?) -> Void) {
+        static func update(identifier: String, entry: ScoreEntry, to client: CouchDBClient, completion: @escaping (_ entryID: String?, _ error: Error?) -> Void) {
             getDatabase(from: client) { database, error in
                 guard let database = database else {
                     return completion(nil, error)
                 }
                 
-                database.retrieve(id, callback: { document, error in
+                database.retrieve(identifier, callback: { document, error in
                     guard let document = document else {
                         return completion(nil, error)
                     }
@@ -61,7 +61,7 @@ extension ScoreEntry {
                         return completion(nil, RainbowPersistenceError.noAvatar)
                     }
                     
-                    database.update(id, rev: document["_rev"].stringValue, document: updatedCopy, callback: { rev, _, error in
+                    database.update(identifier, rev: document["_rev"].stringValue, document: updatedCopy, callback: { rev, _, error in
                         completion(rev, error)
                     })
                })
@@ -77,7 +77,7 @@ extension ScoreEntry {
                     guard let document = document else {
                         return completion(nil, error)
                     }
-                    return completion(ScoreEntry(document: document, _id: document["_id"].stringValue), nil)
+                    return completion(ScoreEntry(document: document, entryId: document["_id"].stringValue), nil)
                 })
             }
         }
@@ -93,7 +93,7 @@ extension ScoreEntry {
                     }
                     var entries = [ScoreEntry]()
                     for document in documents["rows"].arrayValue {
-                        if let newEntry = ScoreEntry(document: document["doc"], _id: document["doc"]["_id"].stringValue) {
+                        if let newEntry = ScoreEntry(document: document["doc"], entryId: document["doc"]["_id"].stringValue) {
                             entries.append(newEntry)
                         }
                     }
diff --git a/Server/rainbow-server/Sources/Application/Model/ScoreEntry+SwiftyJSON.swift b/Server/rainbow-server/Sources/Application/Model/ScoreEntry+SwiftyJSON.swift
@@ -9,8 +9,8 @@ import Foundation
 import SwiftyJSON
 
 extension ScoreEntry {
-    init?(document: JSON, _id: String) {
-        id = _id
+    init?(document: JSON, entryId: String) {
+        id = entryId
         deviceIdentifier = document["deviceIdentifier"].stringValue
         username = document["username"].stringValue
         startDate = document["startDate"].dateTime
@@ -42,7 +42,6 @@ extension ScoreEntry {
         totalTime = nil
     }
     
-
     mutating func toJSONDocument() -> JSON? {        
         do {
             let encoded = try JSONEncoder().encode(self)
diff --git a/Server/rainbow-server/Sources/Application/Model/ScoreEntry.swift b/Server/rainbow-server/Sources/Application/Model/ScoreEntry.swift
@@ -14,12 +14,13 @@ struct ObjectEntry: Codable {
 }
 
 struct ScoreEntry: Codable {
+    //swiftlint:disable identifier_name
     var id: String?
     var username: String
     var startDate: Date?
     var finishDate: Date?
     var deviceIdentifier: String?
-    var avatarImage: Data?    
+    var avatarImage: Data?
     var objects: [ObjectEntry]?
     var totalTime: Double?
 }
diff --git a/Server/rainbow-server/Sources/Application/Routes/RouteAutheticator.swift b/Server/rainbow-server/Sources/Application/Routes/RouteAutheticator.swift
@@ -41,13 +41,12 @@ func setupBasicAuth(app: App) {
     let basicCredentials = CredentialsHTTPBasic( verifyPassword: { userId, password, callback in
         if let user = userDB[userId] {
             do {
-                let result: Bool = try user.verifyPassword(withPassword: password)
-                if ( result ) {
+                let result = try user.verifyPassword(withPassword: password)
+                if result {
                     Log.debug("Successfully authenticated!")
                     callback(UserProfile(id: userId, displayName: userId, provider: "HTTPBasic-Kitura"))
                 }
-            }
-            catch {
+            } catch {
                 Log.error("VerifyPassword internal error")
             }
         }
@@ -67,19 +66,17 @@ func setupBasicAuth(app: App) {
         response.headers["Content-Type"] = "application/json; charset=utf-8"
         do {
             // if userProfile exists, it means user logged in
-            if let userProfile = request.userProfile  {
+            if let userProfile = request.userProfile {
                 Log.debug("User Successfully Authenticated \(userProfile.id)")
                 next()
                 return
             }
-            
             // if 401 returned
             Log.debug("User Authentication failed")
-            try response.status(.unauthorized).send(
-                "You are not authorized to use this API"
-                ).end()
+            try response.status(.unauthorized).send("You are not authorized to use this API").end()
+        } catch {
+            Log.error("Could not send unauthorized status.")
         }
-        catch {}
         next()
     })
 }
diff --git a/Server/rainbow-server/Sources/Application/Routes/ScoreRoutes.swift b/Server/rainbow-server/Sources/Application/Routes/ScoreRoutes.swift
@@ -33,11 +33,11 @@ func getAllEntries(completion: @escaping ([ScoreEntry]?, RequestError?) -> Void)
     }
 }
 
-func getOneEntry(id: String, completion: @escaping (ScoreEntry?, RequestError?) -> Void) {
+func getOneEntry(identifier: String, completion: @escaping (ScoreEntry?, RequestError?) -> Void) {
     guard let client = client else {
         return completion(nil, .failedDependency)
     }
-    ScoreEntry.Persistence.get(from: client, with: id) { entry, error in
+    ScoreEntry.Persistence.get(from: client, with: identifier) { entry, error in
         return completion(entry, error as? RequestError)
     }
 }
@@ -56,24 +56,24 @@ func addNewEntry(newEntry: ScoreEntry, completion: @escaping(ScoreEntry?, Reques
     }
 }
 
-func updateEntry(id: String,newEntry: ScoreEntry, completion: @escaping (ScoreEntry?, RequestError?) -> Void) {
+func updateEntry(identifier: String, newEntry: ScoreEntry, completion: @escaping (ScoreEntry?, RequestError?) -> Void) {
     Log.info("Updating entry document")
     guard let client = client else {
         return completion(nil, .failedDependency)
     }
 
     // update database with new entry
-    ScoreEntry.Persistence.update(id: id, entry: newEntry, to: client) { revID, error in
+    ScoreEntry.Persistence.update(identifier: identifier, entry: newEntry, to: client) { revID, error in
         guard let revID = revID else {
             return completion(nil, .noContent)
         }
         Log.info("Document updated with new revision: ", functionName: revID)
-        ScoreEntry.Persistence.get(from: client, with: id, completion: { entry, error in
+        ScoreEntry.Persistence.get(from: client, with: identifier, completion: { entry, error in
             // logic for push notification. If the update is for game completion
             // check to see if notification has to be sent.
             
             guard let entry = entry else {
-                return completion(nil, error)
+                return completion(nil, error as? RequestError)
             }
             
             if entry.finishDate != nil {
@@ -86,13 +86,12 @@ func updateEntry(id: String,newEntry: ScoreEntry, completion: @escaping (ScoreEn
                 /// call push notification service
                 Log.info("Sending push notification")
                 DispatchQueue.global(qos: .background).async {
-                    pushNotification?.sendNotification(scoreEntry: entry)
+                    pushNotification.sendNotification(scoreEntry: entry)
                 }
             }
             return completion(entry, error as? RequestError)
         })
     }
-    
 }
 
 /// returns sorted list of scores by time taken
diff --git a/Server/rainbow-server/Sources/Application/Services/ServicePush.swift b/Server/rainbow-server/Sources/Application/Services/ServicePush.swift
@@ -9,9 +9,9 @@ class PushNotification {
     var pushNotifications: PushNotifications?
     var couchDBClient: CouchDBClient?
     //Score Entry order by time taken
-    var scoresOrderedByTotalTime : [ScoreEntry] = []
+    var scoresOrderedByTotalTime = [ScoreEntry]()
     
-    public init(cloudEnv: CloudEnv, couchDBClient:  CouchDBClient) throws {
+    public init(cloudEnv: CloudEnv, couchDBClient: CouchDBClient) throws {
         guard let pushNotificationsCredentials = cloudEnv.getPushSDKCredentials(name: "push") else {
             throw ServiceInitializationError.pushNotificationError("Could not load credentials for Push Notifications.")
         }
@@ -34,12 +34,11 @@ class PushNotification {
             self.scoresOrderedByTotalTime = scoreEntryArray
         })
     }
-    
-    
+
     /// send push notification in two cases:
     /// 1- knocked from top spot of leaderboard
     /// 2- knocked from top 10
-    public func sendNotification(scoreEntry: ScoreEntry) -> Void {
+    public func sendNotification(scoreEntry: ScoreEntry) {
         guard let couchDBClient = couchDBClient else {
             return
         }
@@ -62,26 +61,26 @@ class PushNotification {
             
             if indexFromDb  == nil {
                 return
-            }else if index == nil {
+            } else if index == nil {
                 self.scoresOrderedByTotalTime = scoreEntryArray
                 return
             }
             
             let target = Notification.Target(deviceIds: [scoreEntry.deviceIdentifier!])
-            if(index! == 0 && indexFromDb! > 0){
+            if index! == 0, indexFromDb! > 0 {
                 //send notification
-                let message = Notification.Message.init(alert: Constant.NOTIFICATION_MESSAGE_KNOCKED_FROM_TOP, url: nil)
+                let message = Notification.Message.init(alert: Constant.knockedFromTop, url: nil)
                 let notification = Notification.init(message: message, target: target)
-                self.pushNotifications?.send(notification: notification) { (data, status, error) in
+                self.pushNotifications?.send(notification: notification) { _, _, error in
                     if error != nil {
                         print("Failed to send push notification. Error: \(error!)")
                     }
                 }
-            }else if(index! <= 9 && indexFromDb! > 9){
+            } else if index! <= 9, indexFromDb! > 9 {
                 //send notification
-                let message = Notification.Message.init(alert: Constant.NOTIFICATION_MESSAGE_KNOCKED_FROM_TOP_TEN, url: nil)
+                let message = Notification.Message.init(alert: Constant.knockedFromTopTen, url: nil)
                 let notification = Notification.init(message: message, target: target)
-                self.pushNotifications?.send(notification: notification) { (data, status, error) in
+                self.pushNotifications?.send(notification: notification) { _, _, error in
                     if error != nil {
                         print("Failed to send push notification. Error: \(error!)")
                     }
diff --git a/Server/rainbow-server/Sources/Application/SwiftyJSONUtil.swift b/Server/rainbow-server/Sources/Application/SwiftyJSONUtil.swift
@@ -13,7 +13,7 @@ class Formatter {
     private static var internalJsonDateTimeFormatter: DateFormatter?
     
     static var jsonDateTimeFormatter: DateFormatter {
-        if (internalJsonDateTimeFormatter == nil) {
+        if internalJsonDateTimeFormatter == nil {
             internalJsonDateTimeFormatter = DateFormatter()
             internalJsonDateTimeFormatter!.dateFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.SSS'Z'"
         }
diff --git a/iOS/rainbow/Controller/AppDelegate.swift b/iOS/rainbow/Controller/AppDelegate.swift
@@ -170,12 +170,13 @@ class AppDelegate: UIResponder, UIApplicationDelegate, BMSPushObserver {
         alert.addAction(UIAlertAction(title: "OK", style: UIAlertActionStyle.default, handler: nil))
         
         // show the alert
-        self.window!.rootViewController!.present(alert, animated: true, completion: nil)
+        if let rootViewController = self.window?.rootViewController {
+            rootViewController.present(alert, animated: true, completion: nil)
+        }
     }
     
     func convertStringToDictionary(text: String) -> [String: AnyObject]? {
-        if let data = text.data(using: String.Encoding.utf8) {
-            
+        if let data = text.data(using: .utf8) {
             guard let result = try? JSONSerialization.jsonObject(with: data, options: []) as? [String: AnyObject] else {
                 return [:]
             }
diff --git a/iOS/rainbow/Controller/Booklet/AssetViewController.swift b/iOS/rainbow/Controller/Booklet/AssetViewController.swift
@@ -11,7 +11,7 @@ import UIKit
 
 class AssetViewController: UIViewController {
     
-    @IBOutlet weak var webView: UIWebView!
+    @IBOutlet weak var webView: UIWebView?
     
     @IBAction func back(_ sender: UIBarButtonItem) {
         self.dismiss(animated: true, completion: nil)
@@ -28,13 +28,12 @@ class AssetViewController: UIViewController {
             let session = URLSession.shared
             
             let task = session.dataTask(with: request) { (_, _, error) in
-                if error == nil {
-                    self.webView.loadRequest(request)
+                if error == nil, let webView = self.webView {
+                    webView.loadRequest(request)
                 } else {
                     print(String(describing: error))
                 }
             }
-            
             task.resume()
         }
     }
diff --git a/iOS/rainbow/Controller/Booklet/BookletBaseController.swift b/iOS/rainbow/Controller/Booklet/BookletBaseController.swift
diff --git a/iOS/rainbow/Controller/Booklet/BookletViewController.swift b/iOS/rainbow/Controller/Booklet/BookletViewController.swift
diff --git a/iOS/rainbow/Controller/Camera/CameraController.swift b/iOS/rainbow/Controller/Camera/CameraController.swift
diff --git a/iOS/rainbow/Controller/Camera/GameStartView.swift b/iOS/rainbow/Controller/Camera/GameStartView.swift
diff --git a/iOS/rainbow/Model/KituraKit/WatsonMLClientCredentials.json b/iOS/rainbow/Model/KituraKit/WatsonMLClientCredentials.json

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ struct Authentication: Codable {`
`13`	`13`	`var password: String`
`14`	`14`	`}`
`15`	`15`
`16`		`-extension Authentication{`
	`16`	`+extension Authentication {`
`17`	`17`	`init(document: JSON) {`
`18`	`18`	`username = document["username"].stringValue`
`19`	`19`	`password = document["password"].stringValue`
Original file line number	Diff line number	Diff line change
`@@ -36,20 +36,20 @@ extension ScoreEntry {`
`36`	`36`	`guard let updatedCopy = entryCopy.toJSONDocument() else {`
`37`	`37`	`return completion(nil, RainbowPersistenceError.noAvatar)`
`38`	`38`	`}`
`39`		`- database.create(updatedCopy, callback: { id, _, _, error in`
`40`		`- completion(id, error)`
	`39`	`+ database.create(updatedCopy, callback: { identifier, _, _, error in`
	`40`	`+ completion(identifier, error)`
`41`	`41`	`})`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`// Update document`
`46`		`- static func update(id: String, entry: ScoreEntry, to client: CouchDBClient, completion: @escaping (_ entryID: String?, _ error: Error?) -> Void) {`
	`46`	`+ static func update(identifier: String, entry: ScoreEntry, to client: CouchDBClient, completion: @escaping (_ entryID: String?, _ error: Error?) -> Void) {`
`47`	`47`	`getDatabase(from: client) { database, error in`
`48`	`48`	`guard let database = database else {`
`49`	`49`	`return completion(nil, error)`
`50`	`50`	`}`
`51`	`51`
`52`		`- database.retrieve(id, callback: { document, error in`
	`52`	`+ database.retrieve(identifier, callback: { document, error in`
`53`	`53`	`guard let document = document else {`
`54`	`54`	`return completion(nil, error)`
`55`	`55`	`}`
`@@ -61,7 +61,7 @@ extension ScoreEntry {`
`61`	`61`	`return completion(nil, RainbowPersistenceError.noAvatar)`
`62`	`62`	`}`
`63`	`63`
`64`		`- database.update(id, rev: document["_rev"].stringValue, document: updatedCopy, callback: { rev, _, error in`
	`64`	`+ database.update(identifier, rev: document["_rev"].stringValue, document: updatedCopy, callback: { rev, _, error in`
`65`	`65`	`completion(rev, error)`
`66`	`66`	`})`
`67`	`67`	`})`
`@@ -77,7 +77,7 @@ extension ScoreEntry {`
`77`	`77`	`guard let document = document else {`
`78`	`78`	`return completion(nil, error)`
`79`	`79`	`}`
`80`		`- return completion(ScoreEntry(document: document, _id: document["_id"].stringValue), nil)`
	`80`	`+ return completion(ScoreEntry(document: document, entryId: document["_id"].stringValue), nil)`
`81`	`81`	`})`
`82`	`82`	`}`
`83`	`83`	`}`
`@@ -93,7 +93,7 @@ extension ScoreEntry {`
`93`	`93`	`}`
`94`	`94`	`var entries = [ScoreEntry]()`
`95`	`95`	`for document in documents["rows"].arrayValue {`
`96`		`- if let newEntry = ScoreEntry(document: document["doc"], _id: document["doc"]["_id"].stringValue) {`
	`96`	`+ if let newEntry = ScoreEntry(document: document["doc"], entryId: document["doc"]["_id"].stringValue) {`
`97`	`97`	`entries.append(newEntry)`
`98`	`98`	`}`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,12 +14,13 @@ struct ObjectEntry: Codable {`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`struct ScoreEntry: Codable {`
	`17`	`+ //swiftlint:disable identifier_name`
`17`	`18`	`var id: String?`
`18`	`19`	`var username: String`
`19`	`20`	`var startDate: Date?`
`20`	`21`	`var finishDate: Date?`
`21`	`22`	`var deviceIdentifier: String?`
`22`		`- var avatarImage: Data?`
	`23`	`+ var avatarImage: Data?`
`23`	`24`	`var objects: [ObjectEntry]?`
`24`	`25`	`var totalTime: Double?`
`25`	`26`	`}`