Feature/deeplink api

LeadKit.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name            = "LeadKit"
-  s.version         = "1.31.0"
+  s.version         = "1.33.0"
   s.summary         = "iOS framework with a bunch of tools for rapid development"
   s.homepage        = "https://github.com/TouchInstinct/LeadKit"
   s.license         = "Apache License, Version 2.0"

Package.swift

@@ -21,6 +21,7 @@ let package = Package(
     .library(name: "TIKeychainUtils", targets: ["TIKeychainUtils"]),
     .library(name: "TITableKitUtils", targets: ["TITableKitUtils"]),
     .library(name: "TILogging", targets: ["TILogging"]),
+    .library(name: "TIDeeplink", targets: ["TIDeeplink"]),
 
     // MARK: - Networking
 
@@ -32,7 +33,7 @@ let package = Package(
 
     .library(name: "TIMapUtils", targets: ["TIMapUtils"]),
     .library(name: "TIAppleMapUtils", targets: ["TIAppleMapUtils"]),
-    
+
     // MARK: - Elements
     .library(name: "OTPSwiftView", targets: ["OTPSwiftView"]),
     .library(name: "TITransitions", targets: ["TITransitions"]),
@@ -65,6 +66,7 @@ let package = Package(
     .target(name: "TIKeychainUtils", dependencies: ["TIFoundationUtils", "KeychainAccess"], path: "TIKeychainUtils/Sources"),
     .target(name: "TITableKitUtils", dependencies: ["TIUIElements", "TableKit"], path: "TITableKitUtils/Sources"),
     .target(name: "TILogging", dependencies: ["TIUIElements", "TISwiftUtils", "TIUIKitCore"], path: "TILogging/Sources"),
+    .target(name: "TIDeeplink", dependencies: ["TIFoundationUtils"], path: "TIDeeplink/Sources"),
 
     // MARK: - Networking
     .target(name: "TINetworking", dependencies: ["TIFoundationUtils", "Alamofire"], path: "TINetworking/Sources"),
@@ -74,7 +76,7 @@ let package = Package(
     // MARK: - Maps
     .target(name: "TIMapUtils", dependencies: [], path: "TIMapUtils/Sources"),
     .target(name: "TIAppleMapUtils", dependencies: ["TIMapUtils"], path: "TIAppleMapUtils/Sources"),
-    
+
     // MARK: - Elements
     .target(name: "OTPSwiftView", dependencies: ["TIUIElements"], path: "OTPSwiftView/Sources"),
     .target(name: "TITransitions", path: "TITransitions/Sources"),

TIAppleMapUtils/TIAppleMapUtils.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'TIAppleMapUtils'
-  s.version          = '1.31.0'
+  s.version          = '1.33.0'
   s.summary          = 'Set of helpers for map objects clustering and interacting using Apple MapKit.'
   s.homepage         = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
   s.license          = { :type => 'MIT', :file => 'LICENSE' }

TIAuth/TIAuth.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'TIAuth'
-  s.version          = '1.31.0'
+  s.version          = '1.33.0'
   s.summary          = 'Login, registration, confirmation and other related actions'
   s.homepage         = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
   s.license          = { :type => 'MIT', :file => 'LICENSE' }

TIDeepLink/Sources/DeeplinkHandler/BaseNavigationStackDeeplinkHandler.swift

@@ -0,0 +1,50 @@
+//
+//  Copyright (c) 2023 Touch Instinct
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the Software), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import Foundation
+import UIKit
+
+open class BaseNavigationStackDeeplinkHandler<ControllerKeeper: RootViewControllerKeeper>: DeeplinkHandler {
+
+    public typealias DeeplinkType = ControllerKeeper.DeeplinkHandler.DeeplinkType
+    public typealias Handler = ControllerKeeper.DeeplinkHandler
+
+    public var rootViewControllerKeeper: ControllerKeeper?
+
+    // MARK: - DeeplinkHandler
+
+    open func handle(deeplink: DeeplinkType) -> Operation? {
+        let handler = findHandler(for: deeplink)
+        return handler?.handle(deeplink: deeplink)
+    }
+
+    // MARK: - Open methods
+
+    open func findHandler(for deeplink: DeeplinkType) -> Handler? {
+
+        guard let rootController = rootViewControllerKeeper?.rootDeeplinkHandlerController else {
+            return nil
+        }
+
+        return rootController.findHandler(for: deeplink)
+    }
+}

TIDeepLink/Sources/DeeplinkHandler/DeeplinkHandler.swift

@@ -0,0 +1,29 @@
+//
+//  Copyright (c) 2023 Touch Instinct
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the Software), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import Foundation
+
+public protocol DeeplinkHandler {
+    associatedtype DeeplinkType: Hashable
+
+    func handle(deeplink: DeeplinkType) -> Operation?
+}

TIDeepLink/Sources/DeeplinkHandler/Helpers/UIViewController+DeeplinkHandler.swift

@@ -0,0 +1,87 @@
+//
+//  Copyright (c) 2023 Touch Instinct
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the Software), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import UIKit
+
+public typealias DeeplinkHandlerViewController = DeeplinkHandler & UIViewController
+
+public extension UIViewController {
+
+    func findHandler<DeeplinkHandler: DeeplinkHandlerViewController>(
+        for deeplink: DeeplinkHandler.DeeplinkType
+    ) -> DeeplinkHandler? {
+
+        if let deeplinksHandler = self as? DeeplinkHandler,
+           let _ = deeplinksHandler.handle(deeplink: deeplink) {
+            return deeplinksHandler
+        }
+
+        if let deeplinksHandler: DeeplinkHandler = presentedViewController?.findHandler(for: deeplink) {
+            return deeplinksHandler
+        }
+
+        return findHandlerInViewHierarchy(for: deeplink)
+    }
+
+    private func findHandlerInViewHierarchy<DeeplinkHandler: DeeplinkHandlerViewController>(
+        for deeplink: DeeplinkHandler.DeeplinkType
+    ) -> DeeplinkHandler? {
+
+        switch self {
+        case let navController as UINavigationController:
+            let deeplinksHandler: DeeplinkHandler? = navController.viewControllers.reversed().findHandler(for: deeplink)
+            return deeplinksHandler
+
+        case let tabController as UITabBarController:
+            if let deeplinksHandler: DeeplinkHandler = tabController.selectedViewController?.findHandler(for: deeplink) {
+                return deeplinksHandler
+            } else if var tabControllers = tabController.viewControllers {
+                if tabController.selectedIndex != NSNotFound {
+                    tabControllers.remove(at: tabController.selectedIndex)
+                }
+
+                if let deeplinksHandler: DeeplinkHandler = tabControllers.findHandler(for: deeplink) {
+                    return deeplinksHandler
+                }
+            }
+
+        default:
+            return nil
+        }
+
+        return nil
+    }
+}
+
+private extension Sequence where Element: UIViewController {
+    func findHandler<DeeplinkHandler: DeeplinkHandlerViewController>(
+        for deeplink: DeeplinkHandler.DeeplinkType
+    ) -> DeeplinkHandler? {
+
+        for controller in self {
+            if let deeplinksHandler: DeeplinkHandler = controller.findHandler(for: deeplink) {
+                return deeplinksHandler
+            }
+        }
+        return nil
+    }
+}

TIDeepLink/Sources/DeeplinkHandler/RootViewControllerKeeper.swift

@@ -0,0 +1,29 @@
+//
+//  Copyright (c) 2023 Touch Instinct
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the Software), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import UIKit
+
+public protocol RootViewControllerKeeper {
+    associatedtype DeeplinkHandler: DeeplinkHandlerViewController
+
+    var rootDeeplinkHandlerController: DeeplinkHandler { get }
+}

TIDeepLink/Sources/DeeplinkMapper.swift

@@ -0,0 +1,29 @@
+//
+//  Copyright (c) 2023 Touch Instinct
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the Software), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import Foundation
+
+public protocol DeeplinkMapper {
+    associatedtype DeeplinkType
+
+    func map(url: URL) -> DeeplinkType?
+}

TIDeeplink/Sources/TIDeeplinkService.swift

@@ -0,0 +1,98 @@
+//
+//  Copyright (c) 2023 Touch Instinct
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the Software), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import Foundation
+import TIFoundationUtils
+
+open class TIDeeplinksService<DeeplinkType: Hashable,
+                              Mapper: DeeplinkMapper,
+                              Handler: DeeplinkHandler> where Mapper.DeeplinkType == Handler.DeeplinkType,
+                                                              Mapper.DeeplinkType == DeeplinkType {
+
+    // MARK: - Private properties
+
+    private var operationQueue: OperationQueue
+
+    private var deeplinkQueue: [DeeplinkType] = []
+    private var inProcessingSet: Set<DeeplinkType> = []
+
+    // MARK: - Public properties
+
+    public var deeplinkMapper: Mapper?
+    public var deeplinkHandler: Handler?
+
+    // MARK: - Init
+
+    public init(mapper: Mapper, handler: Handler, operationQueue: OperationQueue = .main) {
+        self.deeplinkMapper = mapper
+        self.deeplinkHandler = handler
+        self.operationQueue = operationQueue
+    }
+
+    // MARK: - Open methods
+
+    /// Mapping the given url to deeplink model and appending it to the queue.
+    /// - Parameter url: URL to map into deeplink model
+    /// - Returns: true if a mapper mapped url to deeplink model successfully. Also returns false if `deeplinkMapper` is nil
+    @discardableResult
+    open func deferredHandle(url: URL) -> Bool {
+        let deeplink = deeplinkMapper?.map(url: url)
+
+        guard let deeplink = deeplink else {
+            return false
+        }
+
+        deeplinkQueue.append(deeplink)
+
+        return true
+    }
+
+    open func reset() {
+        operationQueue.cancelAllOperations()
+        deeplinkQueue.removeAll()
+        inProcessingSet.removeAll()
+    }
+
+    open func handlePendingDeeplinks() {
+        guard let deeplink = deeplinkQueue.first,
+              let handler = deeplinkHandler else {
+            return
+        }
+
+        deeplinkQueue.remove(at: .zero)
+
+        guard !inProcessingSet.contains(deeplink),
+              let operation = handler.handle(deeplink: deeplink) else {
+            return
+        }
+
+        inProcessingSet.formUnion([deeplink])
+
+        let competionOperation = BlockOperation { [weak self] in
+            self?.inProcessingSet.subtract([deeplink])
+        }
+
+        competionOperation.addDependency(operation)
+
+        competionOperation.add(to: operationQueue)
+    }
+}