[Improvement] Naming of libraries and package (#22)

This PR contains the work done to fix the naming of the libraries and the package, along with tweaks to the folder structure. Reviewed-on: #22 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2023-08-13 21:53:47 +00:00
parent 060d8a84a9
commit e6e82b3b40
54 changed files with 65 additions and 53 deletions
@@ -0,0 +1,122 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftLibs open source project
+//
+// Copyright (c) 2023 Röck+Cöde VoF. and the SwiftLibs project authors
+// Licensed under the EUPL 1.2 or later.
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftLibs project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+
+/// This class overrides the `URLProtocol` protocol used by the `URLSession` to handle the loading of protocol-specific URL data so it is possible to mock URL response for testing purposes.
+public class MockURLProtocol: URLProtocol {
+    
+    // MARK: Properties
+    
+    /// The dictionary in which the mock requests with its respective mock responses will be injected.
+    public static var mockData: [MockURLRequest: MockURLResponse] = [:]
+    
+    // MARK: Functions
+    
+    public override class func canInit(with task: URLSessionTask) -> Bool {
+        true
+    }
+    
+    public override class func canInit(with request: URLRequest) -> Bool {
+        true
+    }
+    
+    public override class func canonicalRequest(for request: URLRequest) -> URLRequest {
+        request
+    }
+    
+    public override func startLoading() {
+        guard
+            let httpMethod = request.httpMethod,
+            let method = HTTPRequestMethod(rawValue: httpMethod),
+            let url = request.url,
+            let response = Self.mockData[.init(
+                method: method,
+                url: url
+            )]
+        else {
+            client?.urlProtocolDidFinishLoading(self)
+            return
+        }
+        
+        if let data = response.data {
+            client?.urlProtocol(self, didLoad: data)
+        }
+        
+        if let httpResponse = HTTPURLResponse(
+            url: url,
+            statusCode: response.status.rawValue,
+            httpVersion: nil,
+            headerFields: response.headers
+        ) {
+            client?.urlProtocol(
+                self,
+                didReceive: httpResponse, 
+                cacheStoragePolicy: .allowedInMemoryOnly
+            )
+        }
+
+        client?.urlProtocolDidFinishLoading(self)
+    }
+    
+    public override func stopLoading() {}
+
+}
+
+// MARK: - Structs
+
+///  This model includes the data to be injected into an specific URL at the time of mocking its request.
+public struct MockURLRequest: Hashable {
+    
+    // MARK: Properties
+    
+    public let method: HTTPRequestMethod
+    public let url: URL
+    
+    // MARK: Initialisers
+    
+    public init(
+        method: HTTPRequestMethod,
+        url: URL
+    ) {
+        self.method = method
+        self.url = url
+    }
+
+}
+
+///  This model includes the data to be injected into an specific URL at the time of mocking its response.
+public struct MockURLResponse {
+    
+    // MARK: Properties
+    
+    public let status: HTTPResponseCode
+    public let headers: [String: String]
+    public let data: Data?
+    
+    // MARK: Initialisers
+    
+    public init(
+        status: HTTPResponseCode,
+        headers: [String : String] = [:],
+        data: Data? = nil
+    ) {
+        self.status = status
+        self.headers = headers
+        self.data = data
+    }
+
+}