update(26718): adding builder to instantiate SDK (#5)

* update: adding build to instantiate SDK * typo fixed * typo fixed
twilio · Aug 22, 2022 · 70e355a · 70e355a
1 parent 802df05
commit 70e355a
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -107,7 +107,7 @@ import TwilioVerifySNA
 2. Instantiate the SDK
 
 ```swift
-private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNASession()
+private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNABuilder.build()
 ```
 
 3. Process the SNA URL by calling the method:
@@ -156,7 +156,7 @@ import UIKit
 import TwilioVerifySNA
 
 class ViewController: UIViewController {
-    private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNASession()
+  private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNABuilder.build()
 
      override func viewDidLoad() {
         super.viewDidLoad()
@@ -226,10 +226,10 @@ To be added once the sample backend gets released.
     - CA - Bell, Rogers and Telus
 - Set the country code (only US during pilot stage)
 - Set your sample backend url
-- Subit the form by using the CTA button
+- Submit the form by using the CTA button
 
 **Expected behavior:**
-The app will ask the network carrier if the provided phone number is the same used on the network request, if the phone number is correct, then the app will redirect to a sucess screen.
+The app will ask the network carrier if the provided phone number is the same used on the network request, if the phone number is correct, then the app will redirect to a success screen.
 
 <a name='Errors'></a>
 

diff --git a/Sources/Documentation.docc/Usage.md b/Sources/Documentation.docc/Usage.md
@@ -39,7 +39,7 @@ import UIKit
 import TwilioVerifySNA
 
 class ViewController: UIViewController {
-    private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNASession()
+    private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNABuilder.build()
 
      override func viewDidLoad() {
         super.viewDidLoad()

diff --git a/Sources/Domain/TwilioVerifySNA/TwilioVerifySNA.swift b/Sources/Domain/TwilioVerifySNA/TwilioVerifySNA.swift
@@ -19,7 +19,7 @@
 
 import Foundation
 
-public typealias ProcessURLResult = Result<Void, TwilioVerifySNASession.Error>
+public typealias ProcessURLResult = Result<Void, TwilioVerifySNAError>
 public typealias ProcessURLCallback = (ProcessURLResult) -> Void
 
 public protocol TwilioVerifySNA {

diff --git a/Sources/Domain/TwilioVerifySNA/TwilioVerifySNABuilder.swift b/Sources/Domain/TwilioVerifySNA/TwilioVerifySNABuilder.swift
@@ -0,0 +1,14 @@
+import Foundation
+import SNANetworking
+
+public class TwilioVerifySNABuilder {
+    public static func build(
+        requestManager: RequestManagerProtocol = RequestManager(
+            networkProvider: NetworkRequestProvider(
+                cellularSession: CellularSession()
+            )
+        )
+    ) -> TwilioVerifySNA {
+        TwilioVerifySNASession(requestManager: requestManager)
+    }
+}
diff --git a/...lioVerifySNA/TwilioVerifySNA+Errors.swift → ...wilioVerifySNA/TwilioVerifySNAError.swift b/...lioVerifySNA/TwilioVerifySNA+Errors.swift → ...wilioVerifySNA/TwilioVerifySNAError.swift
@@ -19,49 +19,44 @@
 
 import Foundation
 
-// MARK: - Associated errors
-
-extension TwilioVerifySNASession {
-
-    public enum Error: TwilioVerifySNAErrorProtocol, Equatable {
-        case cellularNetworkNotAvailable
-        case requestError(cause: RequestManager.RequestError)
-
-        public var description: String {
-            switch self {
-                case .requestError(let cause):
-                    return """
+public enum TwilioVerifySNAError: TwilioVerifySNAErrorProtocol, Equatable {
+    case cellularNetworkNotAvailable
+    case requestError(cause: RequestManager.RequestError)
+
+    public var description: String {
+        switch self {
+            case .requestError(let cause):
+                return """
                         Error processing the SNAURL request,
                         cause: \(cause.errorDescription ?? "Undefined")
                     """
 
-                case .cellularNetworkNotAvailable:
-                    return "Cellular network not available"
-            }
+            case .cellularNetworkNotAvailable:
+                return "Cellular network not available"
         }
+    }
 
-        public var technicalError: String {
-            switch self {
-                case .requestError(let cause):
-                    return """
+    public var technicalError: String {
+        switch self {
+            case .requestError(let cause):
+                return """
                     Request manager got an error processing the SNAURL request,
                     cause: \(cause.technicalError)
                     """
 
-                case .cellularNetworkNotAvailable:
-                    return """
+            case .cellularNetworkNotAvailable:
+                return """
                         "The network monitor established that a cellular network is not available,
                         if you are running on a simulator or a device with no sim card for development
                         use the `setEnvironment()` method.
                         """
-            }
         }
+    }
 
-        public static func == (
-            lhs: TwilioVerifySNASession.Error,
-            rhs: TwilioVerifySNASession.Error
-        ) -> Bool {
-            String(describing: lhs) == String(describing: rhs)
-        }
+    public static func == (
+        lhs: TwilioVerifySNAError,
+        rhs: TwilioVerifySNAError
+    ) -> Bool {
+        String(describing: lhs) == String(describing: rhs)
     }
 }
diff --git a/Sources/Domain/TwilioVerifySNA/TwilioVerifySNASession.swift b/Sources/Domain/TwilioVerifySNA/TwilioVerifySNASession.swift
@@ -21,7 +21,7 @@ import Foundation
 import Network
 import SNANetworking
 
-open class TwilioVerifySNASession: TwilioVerifySNA {
+final class TwilioVerifySNASession: TwilioVerifySNA {
 
     // MARK: - Properties
 
@@ -58,9 +58,7 @@ open class TwilioVerifySNASession: TwilioVerifySNA {
 
     // MARK: - Class lifecycle
 
-    /// Initializer: You could inject your own dependencies here, although this is only recommended for unit testing,
-    /// if you change any of the implementations down here, we can't guarantee the proper functionality of the SDK.
-    public init(
+    init(
         requestManager: RequestManagerProtocol = RequestManager(
             networkProvider: NetworkRequestProvider(
                 cellularSession: CellularSession()
@@ -82,7 +80,7 @@ open class TwilioVerifySNASession: TwilioVerifySNA {
     /// - Parameters:
     ///   - url: SNA URL provided by your backend.
     ///   - onComplete: Closure with `Result<Void, TwilioVerifySNASession.Error>`.
-    public func processURL(
+    func processURL(
         _ url: String,
         onComplete: @escaping ProcessURLCallback
     ) {
@@ -93,7 +91,7 @@ open class TwilioVerifySNASession: TwilioVerifySNA {
 
     /// `processURL` method  async support.
     @available(iOS 13, *)
-    public func processURL(_ url: String) async -> ProcessURLResult {
+    func processURL(_ url: String) async -> ProcessURLResult {
         return await withCheckedContinuation { continuation in
             processURL(url) { result in
                 continuation.resume(returning: result)

diff --git a/Tests/Domain/TwilioVerifySNASessionTests.swift b/Tests/Domain/TwilioVerifySNASessionTests.swift
@@ -27,7 +27,7 @@ final class TwilioVerifySNASessionTests: XCTestCase {
 
     func test_invalidNetworkStatus_shouldResponseWithExpectedError() async {
         // Arrange
-        let expectedError: TwilioVerifySNASession.Error = .cellularNetworkNotAvailable
+        let expectedError: TwilioVerifySNAError = .cellularNetworkNotAvailable
         let mockUrl = "https://google.com"
         sut.set(networkStatus: .disconnected)
 
@@ -66,6 +66,8 @@ final class TwilioVerifySNASessionTests: XCTestCase {
             case .failure(.requestError(let  cause)):
                 // Assert
                 XCTAssertEqual(cause, expectedError)
+                XCTAssertFalse(expectedError.description.isEmpty)
+                XCTAssertFalse(expectedError.technicalError.isEmpty)
 
             default:
                 XCTFail("Unexpected error received ")

diff --git a/TwilioVerifySNADemo/Screens/PhoneNumber/PhoneNumberViewController.swift b/TwilioVerifySNADemo/Screens/PhoneNumber/PhoneNumberViewController.swift
@@ -37,7 +37,7 @@ final class PhoneNumberViewController: UIViewController {
      in the best practices you will probably create
      this instance on your ViewModel/Presenter or logic layer
      */
-    private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNASession()
+    private lazy var twilioVerify: TwilioVerifySNA = TwilioVerifySNABuilder.build()
 
     /**
      Network layer to communicate with the backend: (not required for your SDK implementation)