Merge pull request #134 from woocommerce/issue/session-manager

SessionManager: Credentials + Settings storage

Author: jleandroperez

WooCommerce/Classes/AppDelegate.swift

@@ -165,7 +165,7 @@ extension AppDelegate {
     /// Whenever there is no default WordPress.com Account, let's display the Authentication UI.
     ///
     func displayAuthenticatorIfNeeded() {
-        guard needsAuthentication else {
+        guard StoresManager.shared.isAuthenticated == false else {
             return
         }
 
@@ -181,10 +181,4 @@ extension AppDelegate {
 
         authenticationManager.displayAuthentication(from: rootViewController)
     }
-
-    /// Indicates if there's a default WordPress.com account.
-    ///
-    var needsAuthentication: Bool {
-        return CredentialsManager.shared.needsDefaultCredentials
-    }
 }

WooCommerce/Classes/Extensions/UserDefaults+Woo.swift

@@ -0,0 +1,58 @@
+import Foundation
+
+
+
+// MARK: - WooCommerce UserDefaults Keys
+//
+extension UserDefaults {
+    enum Key: String {
+        case defaultUsername
+        case defaultStoreID
+    }
+}
+
+
+// MARK: - Convenience Methods
+//
+extension UserDefaults {
+
+    /// Returns the Object (if any) associated with the specified Key.
+    ///
+    func object<T>(forKey key: Key) -> T? {
+        return value(forKey: key.rawValue) as? T
+    }
+
+    /// Stores the Key/Value Pair.
+    ///
+    func set<T>(_ value: T?, forKey key: Key) {
+        set(value, forKey: key.rawValue)
+    }
+
+    /// Nukes any object associated with the specified Key.
+    ///
+    func removeObject(forKey key: Key) {
+        removeObject(forKey: key.rawValue)
+    }
+
+    /// Subscript Accessible via our new Key type!
+    ///
+    subscript<T>(key: Key) -> T? {
+        get {
+            return value(forKey: key.rawValue) as? T
+        }
+        set {
+            set(newValue, forKey: key.rawValue)
+        }
+    }
+
+    /// Subscript: "Type Inference Fallback". To be used whenever the type cannot be automatically inferred!
+    ///
+    subscript(key: Key) -> Any? {
+        get {
+            return value(forKey: key.rawValue)
+        }
+        set {
+            set(newValue, forKey: key.rawValue)
+        }
+    }
+}

WooCommerce/Classes/System/CredentialsManager.swift

@@ -0,0 +1,100 @@
+import Foundation
+import Yosemite
+import KeychainAccess
+
+
+
+/// SessionManager provides persistent storage for Session-Y Properties.
+///
+struct SessionManager {
+
+    /// Standard Session Manager
+    ///
+    static var standard: SessionManager {
+        return SessionManager(defaults: .standard, keychainServiceName: WooConstants.keychainServiceName)
+    }
+
+    /// Reference to the UserDefaults Instance that should be used.
+    ///
+    private let defaults: UserDefaults
+
+    /// KeychainAccess Wrapper.
+    ///
+    private let keychain: Keychain
+
+    /// Active Credentials.
+    ///
+    var credentials: Credentials? {
+        get {
+            return loadCredentials()
+        }
+        set {
+            guard let credentials = newValue else {
+                removeCredentials()
+                return
+            }
+
+            saveCredentials(credentials)
+        }
+    }
+
+    /// Active Store's Site ID.
+    ///
+    var storeID: Int? {
+        get {
+            return defaults[.defaultStoreID]
+        }
+        set {
+            defaults[.defaultStoreID] = storeID
+        }
+    }
+
+
+    /// Designated Initializer.
+    ///
+    init(defaults: UserDefaults, keychainServiceName: String) {
+        self.defaults = defaults
+        self.keychain = Keychain(service: keychainServiceName).accessibility(.afterFirstUnlock)
+    }
+
+    /// Nukes all of the known Session's properties.
+    ///
+    mutating func reset() {
+        credentials = nil
+        storeID = nil
+    }
+}
+
+
+// MARK: - Private Methods
+//
+private extension SessionManager {
+
+    /// Returns the Default Credentials, if any.
+    ///
+    func loadCredentials() -> Credentials? {
+        guard let username = defaults[.defaultUsername] as? String, let authToken = keychain[username] else {
+            return nil
+        }
+
+        return Credentials(username: username, authToken: authToken)
+    }
+
+    /// Persists the Credentials's authToken in the keychain, and username in User Settings.
+    ///
+    func saveCredentials(_ credentials: Credentials) {
+        defaults[.defaultUsername] = credentials.username
+        keychain[credentials.username] = credentials.authToken
+    }
+
+    /// Nukes both, the AuthToken and Default Username.
+    ///
+    func removeCredentials() {
+        guard let username = defaults[.defaultUsername] as? String else {
+            return
+        }
+
+        keychain[username] = nil
+        defaults[.defaultUsername] = nil
+    }
+}

WooCommerce/Classes/System/SessionManager.swift

@@ -3,11 +3,11 @@ import Foundation
 
 /// WooCommerce Constants
 ///
-struct WooConstants {
+enum WooConstants {
 
-    /// Private: No-OP!
+    /// Keychain Access's Service Name
     ///
-    private init() {}
+    static let keychainServiceName = "com.automattic.woocommerce"
 
     /// Jetpack Setup URL
     ///

WooCommerce/Classes/System/WooConstants.swift

@@ -21,15 +21,10 @@ class AuthenticatedState: StoresManagerState {
     ///
     private let services: [ActionsProcessor]
 
-    /// CredentialsManager: By Reference, for unit testing purposes.
-    ///
-    private let keychain: CredentialsManager
-
-
 
     /// Designated Initializer
     ///
-    init(keychain: CredentialsManager, credentials: Credentials) {
+    init(credentials: Credentials) {
         let storageManager = CoreDataManager.global
         let network = AlamofireNetwork(credentials: credentials)
 
@@ -39,15 +34,12 @@ class AuthenticatedState: StoresManagerState {
         ]
 
         self.credentials = credentials
-        self.keychain = keychain
     }
 
 
     /// Executed whenever the state is activated.
     ///
-    func didEnter() {
-        keychain.saveDefaultCredentials(credentials)
-    }
+    func didEnter() { }
 
 
     /// Forwards the received action to the Actions Dispatcher.

WooCommerce/Classes/Yosemite/AuthenticatedState.swift

@@ -7,21 +7,9 @@ import Yosemite
 //
 class DeauthenticatedState: StoresManagerState {
 
-    /// CredentialsManager: By Reference, for unit testing purposes.
-    ///
-    private let keychain: CredentialsManager
-
-
-    /// Designated Initializer
-    ///
-    init(keychain: CredentialsManager) {
-        self.keychain = keychain
-    }
-
     /// This method should run only when the app got deauthenticated.
     ///
     func didEnter() {
-        keychain.removeDefaultCredentials()
         AppDelegate.shared.displayAuthenticator()
     }