[BWA-155] Copy reduced APIService and EnvironmentService into AuthenticatorShared (#1504)

Author: KatherineInCode

AuthenticatorShared/Core/Platform/Services/API/APIService.swift

@@ -0,0 +1,54 @@
+import BitwardenKit
+import Networking
+import UIKit
+
+/// A service used by the application to make API requests.
+///
+class APIService {
+    // MARK: Properties
+
+    /// The API service that is used for general unauthenticated requests.
+    let apiUnauthenticatedService: HTTPService
+
+    // MARK: Private Properties
+
+    /// The underlying `HTTPClient` that performs the network request.
+    private let client: HTTPClient
+
+    /// A `RequestHandler` that applies default headers (user agent, client type & name, etc) to requests.
+    private let defaultHeadersRequestHandler: DefaultHeadersRequestHandler
+
+    /// A `ResponseHandler` that validates that HTTP responses contain successful (2XX) HTTP status
+    /// codes or tries to parse the error otherwise.
+    private let responseValidationHandler = ResponseValidationHandler()
+
+    // MARK: Initialization
+
+    /// Initialize an `APIService` used to make API requests.
+    ///
+    /// - Parameters:
+    ///   - client: The underlying `HTTPClient` that performs the network request. Defaults
+    ///     to `URLSession.shared`.
+    ///   - environmentService: The service used by the application to retrieve the environment settings.
+    ///
+    init(
+        client: HTTPClient = URLSession.shared,
+        environmentService: EnvironmentService
+    ) {
+        self.client = client
+
+        defaultHeadersRequestHandler = DefaultHeadersRequestHandler(
+            appName: "Bitwarden_Authenticator_Mobile",
+            appVersion: Bundle.main.appVersion,
+            buildNumber: Bundle.main.buildNumber,
+            systemDevice: UIDevice.current
+        )
+
+        apiUnauthenticatedService = HTTPService(
+            baseURLGetter: { environmentService.apiURL },
+            client: client,
+            requestHandlers: [defaultHeadersRequestHandler],
+            responseHandlers: [responseValidationHandler]
+        )
+    }
+}

AuthenticatorShared/Core/Platform/Services/API/APIServiceTests.swift

@@ -0,0 +1,34 @@
+import BitwardenKit
+import TestHelpers
+import XCTest
+
+@testable import AuthenticatorShared
+@testable import Networking
+
+class APIServiceTests: BitwardenTestCase {
+    var subject: APIService!
+
+    override func setUp() {
+        super.setUp()
+
+        subject = APIService(client: MockHTTPClient())
+    }
+
+    override func tearDown() {
+        super.tearDown()
+
+        subject = nil
+    }
+
+    // MARK: Tests
+
+    /// `init(client:)` sets the default base URLs for the HTTP services.
+    func test_init_defaultURLs() {
+        let apiUnauthenticatedServiceBaseURL = subject.apiUnauthenticatedService.baseURL
+        XCTAssertEqual(apiUnauthenticatedServiceBaseURL, URL(string: "https://example.com/api")!)
+        XCTAssertTrue(
+            subject.apiUnauthenticatedService.requestHandlers.contains(where: { $0 is DefaultHeadersRequestHandler })
+        )
+        XCTAssertNil(subject.apiUnauthenticatedService.tokenProvider)
+    }
+}

AuthenticatorShared/Core/Platform/Services/API/TestHelpers/APIService+Mocks.swift

@@ -0,0 +1,16 @@
+import BitwardenKit
+import BitwardenKitMocks
+import Networking
+
+@testable import AuthenticatorShared
+
+extension APIService {
+    convenience init(
+        client: HTTPClient
+    ) {
+        self.init(
+            client: client,
+            environmentService: MockEnvironmentService()
+        )
+    }
+}

AuthenticatorShared/Core/Platform/Services/EnvironmentService.swift

@@ -0,0 +1,89 @@
+// swiftlint:disable:this file_name
+
+import BitwardenKit
+import Foundation
+
+// MARK: - DefaultEnvironmentService
+
+/// A default implementation of an `EnvironmentService` which manages the app's environment URLs.
+///
+class DefaultEnvironmentService: EnvironmentService {
+    // MARK: Private Properties
+
+    /// The app's current environment URLs.
+    private var environmentURLs: EnvironmentURLs
+
+    // MARK: Initialization
+
+    /// Initialize a `DefaultEnvironmentService`.
+    ///
+    init() {
+        environmentURLs = EnvironmentURLs(environmentURLData: .defaultUS)
+    }
+
+    // MARK: EnvironmentService
+
+    func loadURLsForActiveAccount() async {}
+
+    func setPreAuthURLs(urls: BitwardenKit.EnvironmentURLData) async {}
+}
+
+extension DefaultEnvironmentService {
+    var apiURL: URL {
+        environmentURLs.apiURL
+    }
+
+    var baseURL: URL {
+        environmentURLs.baseURL
+    }
+
+    var changeEmailURL: URL {
+        environmentURLs.changeEmailURL
+    }
+
+    var eventsURL: URL {
+        environmentURLs.eventsURL
+    }
+
+    var iconsURL: URL {
+        environmentURLs.iconsURL
+    }
+
+    var identityURL: URL {
+        environmentURLs.identityURL
+    }
+
+    var importItemsURL: URL {
+        environmentURLs.importItemsURL
+    }
+
+    var recoveryCodeURL: URL {
+        environmentURLs.recoveryCodeURL
+    }
+
+    var region: RegionType {
+        if environmentURLs.baseURL == EnvironmentURLData.defaultUS.base {
+            return .unitedStates
+        } else if environmentURLs.baseURL == EnvironmentURLData.defaultEU.base {
+            return .europe
+        } else {
+            return .selfHosted
+        }
+    }
+
+    var sendShareURL: URL {
+        environmentURLs.sendShareURL
+    }
+
+    var settingsURL: URL {
+        environmentURLs.settingsURL
+    }
+
+    var setUpTwoFactorURL: URL {
+        environmentURLs.setUpTwoFactorURL
+    }
+
+    var webVaultURL: URL {
+        environmentURLs.webVaultURL
+    }
+}

AuthenticatorShared/Core/Platform/Services/EnvironmentServiceTests.swift

@@ -0,0 +1,45 @@
+import BitwardenKit
+import BitwardenKitMocks
+import XCTest
+
+@testable import AuthenticatorShared
+
+class EnvironmentServiceTests: XCTestCase {
+    // MARK: Properties
+
+    var subject: EnvironmentService!
+
+    // MARK: Setup & Teardown
+
+    override func setUp() {
+        super.setUp()
+
+        subject = DefaultEnvironmentService()
+    }
+
+    override func tearDown() {
+        super.tearDown()
+
+        subject = nil
+    }
+
+    // MARK: Tests
+
+    /// The default US URLs are returned.
+    func test_defaultUrls() {
+        XCTAssertEqual(subject.apiURL, URL(string: "https://api.bitwarden.com"))
+        XCTAssertEqual(subject.baseURL, URL(string: "https://vault.bitwarden.com"))
+        XCTAssertEqual(subject.changeEmailURL, URL(string: "https://vault.bitwarden.com/#/settings/account"))
+        XCTAssertEqual(subject.eventsURL, URL(string: "https://events.bitwarden.com"))
+        XCTAssertEqual(subject.iconsURL, URL(string: "https://icons.bitwarden.net"))
+        XCTAssertEqual(subject.identityURL, URL(string: "https://identity.bitwarden.com"))
+        XCTAssertEqual(subject.importItemsURL, URL(string: "https://vault.bitwarden.com/#/tools/import"))
+        XCTAssertEqual(subject.recoveryCodeURL, URL(string: "https://vault.bitwarden.com/#/recover-2fa"))
+        XCTAssertEqual(subject.region, .unitedStates)
+        XCTAssertEqual(subject.sendShareURL, URL(string: "https://send.bitwarden.com/#"))
+        XCTAssertEqual(subject.settingsURL, URL(string: "https://vault.bitwarden.com/#/settings"))
+        // swiftlint:disable:next line_length
+        XCTAssertEqual(subject.setUpTwoFactorURL, URL(string: "https://vault.bitwarden.com/#/settings/security/two-factor"))
+        XCTAssertEqual(subject.webVaultURL, URL(string: "https://vault.bitwarden.com"))
+    }
+}

BitwardenKit/Core/Platform/Services/EnvironmentService.swift

@@ -0,0 +1,59 @@
+import Foundation
+
+// MARK: - EnvironmentService
+
+/// A protocol for an `EnvironmentService` which manages the app's environment URLs.
+///
+public protocol EnvironmentService {
+    /// The URL for the API.
+    var apiURL: URL { get }
+
+    /// The environment's base URL.
+    var baseURL: URL { get }
+
+    /// The URL for changing email address.
+    var changeEmailURL: URL { get }
+
+    /// The URL for the events API.
+    var eventsURL: URL { get }
+
+    /// The URL for the icons API.
+    var iconsURL: URL { get }
+
+    /// The URL for the identity API.
+    var identityURL: URL { get }
+
+    /// The URL for importing items.
+    var importItemsURL: URL { get }
+
+    /// The URL for the recovery code help page.
+    var recoveryCodeURL: URL { get }
+
+    /// The region of the current environment.
+    var region: RegionType { get }
+
+    /// The URL for sharing a send.
+    var sendShareURL: URL { get }
+
+    /// The URL for vault settings.
+    var settingsURL: URL { get }
+
+    /// The URL for setting up two-factor login.
+    var setUpTwoFactorURL: URL { get }
+
+    /// The URL for the web vault.
+    var webVaultURL: URL { get }
+
+    /// Loads the URLs for the active account into the environment. This can be called on app launch
+    /// whether there's an active account or not to pre-populate the environment. If there's no
+    /// active account, the US URLs will be used.
+    ///
+    func loadURLsForActiveAccount() async
+
+    /// Sets the pre-auth URLs for the environment. This should be called if there isn't an an
+    /// active account on app launch or if the user navigates through the add/create account flow.
+    ///
+    /// - Parameter urls: The URLs to set and use prior to user authentication.
+    ///
+    func setPreAuthURLs(urls: EnvironmentURLData) async
+}

BitwardenKit/Core/Platform/Services/Mocks/MockEnvironmentService.swift

@@ -0,0 +1,37 @@
+import Foundation
+
+@testable import BitwardenKit
+
+public class MockEnvironmentService: EnvironmentService {
+    public var didLoadURLsForActiveAccount = false
+    public var setActiveAccountEnvironmentURLsData: EnvironmentURLData?
+    public var setPreAuthEnvironmentURLsData: EnvironmentURLData?
+
+    public var apiURL = URL(string: "https://example.com/api")!
+    public var baseURL = URL(string: "https://example.com")!
+    public var changeEmailURL = URL(string: "https://example.com/#/settings/account")!
+    public var eventsURL = URL(string: "https://example.com/events")!
+    public var iconsURL = URL(string: "https://example.com/icons")!
+    public var identityURL = URL(string: "https://example.com/identity")!
+    public var importItemsURL = URL(string: "https://example.com/#/tools/import")!
+    public var recoveryCodeURL = URL(string: "https://example.com/#/recover-2fa")!
+    public var region = RegionType.selfHosted
+    public var sendShareURL = URL(string: "https://example.com/#/send")!
+    public var settingsURL = URL(string: "https://example.com/#/settings")!
+    public var setUpTwoFactorURL = URL(string: "https://example.com/#/settings/security/two-factor")!
+    public var webVaultURL = URL(string: "https://example.com")!
+
+    public init() {}
+
+    public func loadURLsForActiveAccount() async {
+        didLoadURLsForActiveAccount = true
+    }
+
+    public func setActiveAccountURLs(urls: EnvironmentURLData) {
+        setActiveAccountEnvironmentURLsData = urls
+    }
+
+    public func setPreAuthURLs(urls: EnvironmentURLData) async {
+        setPreAuthEnvironmentURLsData = urls
+    }
+}

BitwardenShared/Core/Auth/Services/API/Organization/OrganizationAPIServiceTests.swift

@@ -1,3 +1,4 @@
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Auth/Services/API/OrganizationUser/OrganizationUserAPIServiceTests.swift

@@ -1,3 +1,4 @@
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Auth/Services/CaptchaService.swift

@@ -1,3 +1,4 @@
+import BitwardenKit
 import Foundation
 
 // MARK: - CaptchaURLError

BitwardenShared/Core/Auth/Services/CaptchaServiceTests.swift

@@ -1,3 +1,4 @@
+import BitwardenKitMocks
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Auth/Services/TrustDeviceServiceTests.swift

@@ -1,4 +1,5 @@
 import BitwardenSdk
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Platform/Services/API/APIServiceTests.swift

@@ -1,3 +1,4 @@
+import TestHelpers
 import XCTest
 
 @testable import BitwardenKit

BitwardenShared/Core/Platform/Services/API/AccountTokenProviderTests.swift

@@ -1,4 +1,5 @@
 import Networking
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Platform/Services/API/ConfigAPIServiceTests.swift

@@ -1,4 +1,6 @@
 import BitwardenKit
+import BitwardenKitMocks
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Platform/Services/API/EventAPIServiceTests.swift

@@ -1,3 +1,4 @@
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared

BitwardenShared/Core/Platform/Services/API/NotificationAPIServiceTests.swift

@@ -1,3 +1,4 @@
+import TestHelpers
 import XCTest
 
 @testable import BitwardenShared