Core: Feature - Username token

BLOCKv.podspec

@@ -12,18 +12,19 @@ Pod::Spec.new do |s|
     s.author                = { 'BLOCKv' => 'developer.blockv.io' }
     s.source                = { :git => 'https://github.com/BLOCKvIO/ios-sdk.git', :tag => s.version.to_s }
     s.social_media_url      = 'https://twitter.com/blockv_io'
-    s.ios.deployment_target = '10.0'
-    s.swift_version         = '4.2'
+    s.ios.deployment_target = '11.0'
+    s.swift_version         = '5.0'
     s.default_subspecs      = 'Face'
 
     s.subspec 'Core' do |s|
         s.source_files = 'BlockV/Core/**/*.{swift}'
-        s.dependency 'Alamofire',  '~> 4.7'  # Networking
-        s.dependency 'Starscream', '~> 3.0'  # Web socket
-        s.dependency 'JWTDecode',  '~> 2.1'  # JWT decoding
-        s.dependency 'Signals',    '~> 6.0'  # Elegant eventing
-        s.dependency 'SwiftLint',  '~> 0.26' # Linter
-        s.dependency 'GenericJSON', '~> 1.2' # JSON
+        s.dependency 'Alamofire',  '~> 4.7'     # Networking
+        s.dependency 'Starscream', '~> 3.0.6'   # Web socket
+        s.dependency 'JWTDecode',  '~> 2.1'     # JWT decoding
+        s.dependency 'Signals',    '~> 6.0'     # Elegant eventing
+        s.dependency 'SwiftLint',  '~> 0.26'    # Linter
+        s.dependency 'GenericJSON', '~> 2.0'    # JSON
+        s.dependency 'PromiseKit', '~> 6.8'     # Promises
         #s.exclude_files = '**/Info*.plist'
     end
 

BlockV/Core/BLOCKv.swift

@@ -12,10 +12,11 @@
 import Foundation
 import Alamofire
 import JWTDecode
+import Nuke
 
 /*
  Goal:
- BLOCKv should be invariant over App ID and Environment. In other words, the properties should
+ BLOCKv should be invariant over App ID and Environment. In other words, the properties should not
  change, once set. Possibly targets for each environemnt?
  */
 
@@ -27,7 +28,7 @@ public final class BLOCKv {
     /// The App ID to be passed to the BLOCKv platform.
     ///
     /// Must be set once by the host app.
-    fileprivate static var appID: String? {
+    internal fileprivate(set) static var appID: String? {
         // willSet is only called outside of the initialisation context, i.e.
         // setting the appID after its init will cause a fatal error.
         willSet {
@@ -42,7 +43,7 @@ public final class BLOCKv {
     /// The BLOCKv platform environment to use.
     ///
     /// Must be set by the host app.
-    fileprivate static var environment: BVEnvironment? {
+    internal fileprivate(set) static var environment: BVEnvironment? {
         willSet {
             if environment != nil { reset() }
         }
@@ -60,31 +61,6 @@ public final class BLOCKv {
     public static func configure(appID: String) {
         self.appID = appID
 
-        // NOTE: Since `configure` is called only once in the app's lifecycle. We do not
-        // need to worry about multiple registrations.
-        NotificationCenter.default.addObserver(BLOCKv.self,
-                                               selector: #selector(handleUserAuthorisationRequired),
-                                               name: Notification.Name.BVInternal.UserAuthorizationRequried,
-                                               object: nil)
-    }
-
-    // MARK: - Client
-
-    // FIXME: Should this be nil on logout?
-    // FIXME: This MUST become a singleton (since only a single instance should ever exist).
-    private static let oauthHandler = OAuth2Handler(appID: BLOCKv.appID!,
-                                     baseURLString: BLOCKv.environment!.apiServerURLString,
-                                     refreshToken: CredentialStore.refreshToken?.token ?? "")
-
-    /// Computes the configuration object needed to initialise clients and sockets.
-    fileprivate static var clientConfiguration: Client.Configuration {
-        // ensure host app has set an app id
-        let warning = """
-            Please call 'BLOCKv.configure(appID:)' with your issued app ID before making network
-            requests.
-            """
-        precondition(BLOCKv.appID != nil, warning)
-
         // - CONFIGURE ENVIRONMENT
 
         // only modify if not set
@@ -117,6 +93,44 @@ public final class BLOCKv {
 
         }
 
+        // NOTE: Since `configure` is called only once in the app's lifecycle. We do not
+        // need to worry about multiple registrations.
+        NotificationCenter.default.addObserver(BLOCKv.self,
+                                               selector: #selector(handleUserAuthorisationRequired),
+                                               name: Notification.Name.BVInternal.UserAuthorizationRequried,
+                                               object: nil)
+
+        // configure in-memory cache (store processed images ready for display)
+        ImageCache.shared.costLimit = ImageCache.defaultCostLimit()
+
+        // configure http cache (store unprocessed image data at the http level)
+        DataLoader.sharedUrlCache.memoryCapacity = 80 * 1024 * 1024  // 80 MB
+        DataLoader.sharedUrlCache.diskCapacity = 180  // 180 MB
+
+        // handle session launch
+        if self.isLoggedIn {
+            self.onSessionLaunch()
+        }
+
+    }
+
+    // MARK: - Client
+
+    // FIXME: Should this be nil on logout?
+    // FIXME: This MUST become a singleton (since only a single instance should ever exist).
+    private static let oauthHandler = OAuth2Handler(appID: BLOCKv.appID!,
+                                     baseURLString: BLOCKv.environment!.apiServerURLString,
+                                     refreshToken: CredentialStore.refreshToken?.token ?? "")
+
+    /// Computes the configuration object needed to initialise clients and sockets.
+    fileprivate static var clientConfiguration: Client.Configuration {
+        // ensure host app has set an app id
+        let warning = """
+            Please call 'BLOCKv.configure(appID:)' with your issued app ID before making network
+            requests.
+            """
+        precondition(BLOCKv.appID != nil, warning)
+
         // return the configuration (inexpensive object)
         return Client.Configuration(baseURLString: BLOCKv.environment!.apiServerURLString,
                                     appID: BLOCKv.appID!)
@@ -171,7 +185,7 @@ public final class BLOCKv {
     fileprivate static var _socket: WebSocketManager?
 
     //TODO: What if this is accessed before the client is accessed?
-    //TODO: What if the viewer suscribes to an event before auth (login/reg) has occured?
+    //TODO: What if the viewer subscribes to an event before auth (login/reg) has occured?
     public static var socket: WebSocketManager {
         if _socket == nil {
             _socket = WebSocketManager(baseURLString: self.environment!.webSocketURLString,
@@ -194,8 +208,10 @@ public final class BLOCKv {
         // disconnect and nil out socekt
         self._socket?.disconnect()
         self._socket = nil
+        // clear data pool
+        DataPool.clear()
 
-        printBV(info: "Reset")
+        printBV(info: "Reseting SDK")
     }
 
     // - Public Lifecycle
@@ -223,10 +239,10 @@ public final class BLOCKv {
         BLOCKv.client.getAccessToken(completion: completion)
     }
 
-    /// Called when the networking client detects the user is unathorized.
+    /// Called when the networking client detects the user is unauthenticated.
     ///
     /// This method perfroms a clean up operation before notifying the viewer that the SDK requires
-    /// user authorization.
+    /// user authentication.
     ///
     /// - important: This method may be called multiple times. For example, consider the case where
     /// multiple requests fail due to the refresh token being invalid.
@@ -245,20 +261,50 @@ public final class BLOCKv {
 
     }
 
+    /// Called when the user authenticates (logs in).
+    ///
+    /// - important:
+    /// This method is *not* called when the access token refreshes.
+    static internal func onLogin() {
+
+        // stand up the session
+        self.onSessionLaunch()
+
+    }
+
     /// Holds a closure to call on logout
     public static var onLogout: (() -> Void)?
 
-    /// Sets the BLOCKv platform environment.
+    /// This function is called everytime a user session is launched.
     ///
-    /// By setting the environment you are informing the SDK which BLOCKv
-    /// platform environment to interact with.
+    /// A 'session launch' means the user has logged in (received a new refresh token), or the app has been cold
+    /// launched with an existing *valid* refresh token.
     ///
-    /// Typically, you would call `setEnvironment` in `application(_:didFinishLaunchingWithOptions:)`.
-    @available(*, deprecated, message: "BLOCKv now defaults to production. You may remove this call.")
-    public static func setEnvironment(_ environment: BVEnvironment) {
-        self.environment = environment
+    /// - note:
+    /// This is slightly broader than 'log in' since it includes the lifecycle of the app. This function is responsible
+    /// for creating objects which are depenedent on a user session, e.g. data pool.
+    ///
+    /// Its compainion `onSessionTerminated` is `onLogout` since there is no app event signalling app termination.
+    ///
+    /// Triggered by:
+    /// - User authentication
+    /// - App launch & user is authenticated
+    static private func onSessionLaunch() {
+
+        guard let refreshToken = CredentialStore.refreshToken?.token else {
+            fatalError("Invlalid session")
+        }
+
+        guard let claim = try? decode(jwt: refreshToken).claim(name: "user_id"), let userId = claim.string else {
+            fatalError("Invalid cliam")
+        }
+
+        // standup the client & socket
+        _ = client
+        _ = socket.connect()
 
-        //FIXME: *Changing* the environment should nil out the client and access credentials.
+        // standup data pool
+        DataPool.sessionInfo = ["userID": userId]
 
     }
 
@@ -304,3 +350,29 @@ func printBV(info string: String) {
 func printBV(error string: String) {
     print("\nBV SDK >>> Error: \(string)")
 }
+
+extension BLOCKv {
+
+    public enum Debug {
+
+        //// Returns the cache size of the face data resource disk caches.
+        public static var faceDataResourceCacheSize: UInt64? {
+            return try? FileManager.default.allocatedSizeOfDirectory(at: DataDownloader.recommendedCacheDirectory)
+        }
+
+        /// Returns the cache size of all data pool region disk caches.
+        public static var regionCacheSize: UInt64? {
+            return try? FileManager.default.allocatedSizeOfDirectory(at: Region.recommendedCacheDirectory)
+        }
+
+        /// Clears all disk caches.
+        public static func clearCache() {
+            ImageCache.shared.removeAll()
+            DataLoader.sharedUrlCache.removeAllCachedResponses()
+            try? FileManager.default.removeItem(at: DataDownloader.recommendedCacheDirectory)
+            try? FileManager.default.removeItem(at: Region.recommendedCacheDirectory)
+        }
+
+    }
+
+}

BlockV/Core/BVEnvironment.swift

@@ -34,4 +34,11 @@ public enum BVEnvironment: String {
         }
     }
 
+    var oauthWebApp: String {
+        switch self {
+        case .production: return "https://login.blockv.io"
+        case .development: return "https:/login.blockv.net"
+        }
+    }
+
 }