🧪 📚 ✨ Adds zip convenience to request plugins.

- Adds convenience functions to HTTPRequest for each plugin's zip.
- Adds tests to validate the convenience functions.
- Adds some mark docs.

Author: connor-ricks

Sources/HTTPNetworking/Plugins/Adaptors/Adaptor.swift

@@ -1,10 +1,14 @@
 import Foundation
 
+// MARK: - AdaptationHandler
+
 public typealias AdaptationHandler = (
     _ request: URLRequest,
     _ session: URLSession
 ) async throws -> URLRequest
 
+// MARK: - Adaptor
+
 /// An ``HTTPRequestAdaptor`` that can be used to manipulate a `URLRequest` before it is sent out over the network.
 public struct Adaptor: HTTPRequestAdaptor {
 

Sources/HTTPNetworking/Plugins/Adaptors/HeadersAdaptor.swift

@@ -1,5 +1,7 @@
 import Foundation
 
+// MARK: - HeadersAdaptor
+
 /// An ``HTTPRequestAdaptor`` that can be used to append HTTP headers to a request before it is sent out over the network.
 public struct HeadersAdaptor: HTTPRequestAdaptor {
 

Sources/HTTPNetworking/Plugins/Adaptors/ParametersAdaptor.swift

@@ -1,5 +1,7 @@
 import Foundation
 
+// MARK: - ParametersAdaptor
+
 /// An ``HTTPRequestAdaptor`` that can be used to append query parameters to a request before it is sent out over the network.
 ///
 /// > Warning: This adaptor will **not** overwrite existing parameters, instead it will append to existing parameters.

Sources/HTTPNetworking/Plugins/Adaptors/ZipAdaptor.swift

@@ -1,5 +1,7 @@
 import Foundation
 
+// MARK: - ZipAdaptor
+
 /// An ``HTTPRequestAdaptor`` that combines multiple adaptors into one, executing each adaptation in sequence.
 public struct ZipAdaptor: HTTPRequestAdaptor {
 
@@ -37,3 +39,13 @@ public struct ZipAdaptor: HTTPRequestAdaptor {
         return request
     }
 }
+
+// MARK: - HTTPRequest + ZipAdaptor
+
+extension HTTPRequest {
+    /// Applies a ``ZipAdaptor`` that bundles up all the provided adaptors.
+    @discardableResult
+    public func adapt(zipping adaptors: [any HTTPRequestAdaptor]) -> Self {
+        adapt(with: ZipAdaptor(adaptors))
+    }
+}

Sources/HTTPNetworking/Plugins/HTTPResponseValidator.swift

@@ -1,7 +1,11 @@
 import Foundation
 
+// MARK: - ValidationResult
+
 public typealias ValidationResult = Result<Void, Error>
 
+// MARK: - HTTPResponseValidator
+
 /// An ``HTTPResponseValidator`` is used to validate the response from an ``HTTPRequest``.
 ///
 /// By conforming to ``HTTPResponseValidator`` you can implement both simple and complex logic for validating

Sources/HTTPNetworking/Plugins/Retriers/Retrier.swift

@@ -1,5 +1,7 @@
 import Foundation
 
+// MARK: - RetryHandler
+
 public typealias RetryHandler = (
     _ request: URLRequest,
     _ session: URLSession,
@@ -8,6 +10,8 @@ public typealias RetryHandler = (
     _ previousAttempts: Int
 ) async throws -> RetryStrategy
 
+// MARK: - Retrier
+
 /// An ``HTTPRequestRetrier`` that can be used to retry an ``HTTPRequest`` upon failure.
 public struct Retrier: HTTPRequestRetrier {
 

Sources/HTTPNetworking/Plugins/Retriers/ZipRetrier.swift

@@ -1,5 +1,7 @@
 import Foundation
 
+// MARK: - ZipRetrier
+
 /// An ``HTTPRequestRetrier`` that combines multiple retriers into one, executing each retrier in sequence.
 public struct ZipRetrier: HTTPRequestRetrier {
 
@@ -55,3 +57,13 @@ public struct ZipRetrier: HTTPRequestRetrier {
         return .concede
     }
 }
+
+// MARK: - HTTPRequest + ZipRetrier
+
+extension HTTPRequest {
+    /// Applies a ``ZipRetrier`` that bundles up all the provided retriers.
+    @discardableResult
+    public func retry(zipping retriers: [any HTTPRequestRetrier]) -> Self {
+        retry(with: ZipRetrier(retriers))
+    }
+}

Sources/HTTPNetworking/Plugins/Validators/ZipValidator.swift

@@ -1,5 +1,7 @@
 import Foundation
 
+// MARK: - ZipValidator
+
 /// An ``HTTPResponseValidator`` that combines multiple validators into one, executing each validation in sequence.
 public struct ZipValidator: HTTPResponseValidator {
 
@@ -38,3 +40,13 @@ public struct ZipValidator: HTTPResponseValidator {
         return .success
     }
 }
+
+// MARK: - HTTPRequest + ZipValidator
+
+extension HTTPRequest {
+    /// Applies a ``ZipValidator`` that bundles up all the provided validators.
+    @discardableResult
+    public func validate(zipping validators: [any HTTPResponseValidator]) -> Self {
+        validate(with: ZipValidator(validators))
+    }
+}

Tests/HTTPNetworkingTests/Plugins/Adaptors/ZipAdaptorTests.swift

@@ -51,6 +51,27 @@ class ZipAdaptorTests: XCTestCase {
             }
         }
 
-        await fulfillment(of: [adaptorOneExpectation, adaptorTwoExpectation])
+        await fulfillment(of: [adaptorOneExpectation, adaptorTwoExpectation], enforceOrder: true)
+    }
+    
+    func test_zipAdaptor_adaptorConvenience_isAddedToRequestAdaptors() async throws {
+        let client = HTTPClient()
+        let request = client.request(for: .get, to: .mock, expecting: String.self)
+        let expectationOne = expectation(description: "Expected adaptor one to be called.")
+        let expectationTwo = expectation(description: "Expected adaptor two to be called.")
+        request.adapt(zipping: [
+            Adaptor { request, _ in
+                expectationOne.fulfill()
+                return request
+            },
+            Adaptor { request, _ in
+                expectationTwo.fulfill()
+                return request
+            },
+        ])
+        
+        _ = try await request.adaptors.first?.adapt(request.request, for: client.dispatcher.session)
+        
+        await fulfillment(of: [expectationOne, expectationTwo], enforceOrder: true)
     }
 }

Tests/HTTPNetworkingTests/Plugins/Retriers/ZipRetrierTests.swift

@@ -63,6 +63,33 @@ class ZipRetrierTests: XCTestCase {
             }
         }
 
-        await fulfillment(of: [retrierOneExpectation, retrierTwoExpectation])
+        await fulfillment(of: [retrierOneExpectation, retrierTwoExpectation], enforceOrder: true)
+    }
+    
+    func test_zipRetrier_retrierConvenience_isAddedToRequestRetriers() async throws {
+        let client = HTTPClient()
+        let request = client.request(for: .get, to: .mock, expecting: String.self)
+        let expectationOne = expectation(description: "Expected retrier one to be called.")
+        let expectationTwo = expectation(description: "Expected retrier two to be called.")
+        request.retry(zipping: [
+            Retrier { _, _, _, _, _ in
+                expectationOne.fulfill()
+                return .concede
+            },
+            Retrier { _, _, _, _, _ in
+                expectationTwo.fulfill()
+                return .concede
+            },
+        ])
+        
+        _ = try await request.retriers.first?.retry(
+            request.request,
+            for: .shared,
+            with: nil,
+            dueTo: URLError(.cannotParseResponse),
+            previousAttempts: 0
+        )
+        
+        await fulfillment(of: [expectationOne, expectationTwo], enforceOrder: true)
     }
 }