Merge pull request #6 from BinaryBirds/dev

using swift-format

Author: viaszkadi

Makefile

@@ -0,0 +1,15 @@
+
+
+# swift-format commands
+
+format:
+	@curl -s https://raw.githubusercontent.com/BinaryBirds/swift-format-template/main/config.json >> swift-format.json && \
+	swift-format --configuration swift-format.json -i -r ./Sources && \
+	swift-format --configuration swift-format.json -i -r ./Tests && \
+	rm -f ./swift-format.json
+
+lint:
+	@curl -s https://raw.githubusercontent.com/BinaryBirds/swift-format-template/main/config.json >> swift-format.json && \
+	swift-format lint --configuration swift-format.json -r ./Sources && \
+	swift-format lint --configuration swift-format.json -r ./Tests && \
+	rm -f ./swift-format.json

Sources/SwiftHttp/Data+Logger.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 extension Data {
-    
+
     /// A variable that represents a `String` object representing the `Data` object in utf8 encoding.
     var logValue: String {
         "\n" + String(data: self, encoding: .utf8)!

Sources/SwiftHttp/HttpClient.swift

@@ -27,7 +27,7 @@ public protocol HttpClient {
     /// - Returns: A HttpResponse object
     ///
     func dataTask(_ req: HttpRequest) async throws -> HttpResponse
-    
+
     ///
     /// Retreives the contetns of the request (to a file), then returns the location (URL) of the file as a response data object
     ///
@@ -38,7 +38,7 @@ public protocol HttpClient {
     /// - Returns: A HttpResponse object
     ///
     func downloadTask(_ req: HttpRequest) async throws -> HttpResponse
-    
+
     ///
     /// Performs a HTTP request and uploads the body as binary data to the server
     ///

Sources/SwiftHttp/HttpCodablePipeline.swift

@@ -8,16 +8,18 @@
 import Foundation
 
 /// A fully Codable HTTP request pipeline, where the req body is encodable and the response is decodable
-public struct HttpCodablePipeline<T: Encodable, U: Decodable>: HttpRequestPipeline {
-    
+public struct HttpCodablePipeline<T: Encodable, U: Decodable>:
+    HttpRequestPipeline
+{
+
     let url: HttpUrl
     let method: HttpMethod
     let headers: [HttpHeaderKey: String]
     let body: T
     let validators: [HttpResponseValidator]
     let encoder: HttpRequestEncoder<T>
     let decoder: HttpResponseDecoder<U>
-    
+
     ///
     /// Init a new codable pipeline
     ///
@@ -46,7 +48,7 @@ public struct HttpCodablePipeline<T: Encodable, U: Decodable>: HttpRequestPipeli
         self.encoder = encoder
         self.decoder = decoder
     }
-    
+
     ///
     /// Executes  the request, encodes the body, validates the response and decodes the data
     ///
@@ -59,16 +61,16 @@ public struct HttpCodablePipeline<T: Encodable, U: Decodable>: HttpRequestPipeli
     public func execute(
         _ executor: ((HttpRequest) async throws -> HttpResponse)
     ) async throws -> U {
-        let req = HttpRawRequest(url: url,
-                                  method: method,
-                                  headers: headers.merging(encoder.headers) { $1 },
-                                  body: try encoder.encode(body))
-        
+        let req = HttpRawRequest(
+            url: url,
+            method: method,
+            headers: headers.merging(encoder.headers) { $1 },
+            body: try encoder.encode(body)
+        )
+
         let response = try await executor(req)
         let validation = HttpResponseValidation(validators + decoder.validators)
         try validation.validate(response)
         return try decoder.decode(response.data)
     }
 }
-
-

Sources/SwiftHttp/HttpCodablePipelineCollection.swift

@@ -16,7 +16,7 @@ public protocol HttpCodablePipelineCollection {
     /// - Returns: The generic request encoder instance
     ///
     func encoder<T: Encodable>() -> HttpRequestEncoder<T>
-    
+
     ///
     /// The generic decoder object used to decode response data
     ///
@@ -25,25 +25,25 @@ public protocol HttpCodablePipelineCollection {
     func decoder<T: Decodable>() -> HttpResponseDecoder<T>
 }
 
-public extension HttpCodablePipelineCollection {
+extension HttpCodablePipelineCollection {
 
     ///
     /// The generic encoder object used to encode body values
     ///
     /// - Returns: The default json encoder
     ///
-    func encoder<T: Encodable>() -> HttpRequestEncoder<T> { .json() }
-    
+    public func encoder<T: Encodable>() -> HttpRequestEncoder<T> { .json() }
+
     ///
     /// The generic decoder object used to decode response data
     ///
     /// - Returns: The default json decoder
     ///
-    func decoder<T: Decodable>() -> HttpResponseDecoder<T> { .json() }
+    public func decoder<T: Decodable>() -> HttpResponseDecoder<T> { .json() }
 }
 
-public extension HttpCodablePipelineCollection {
-    
+extension HttpCodablePipelineCollection {
+
     ///
     /// Executes a raw request pipeline using a data values as a body and returns the response
     ///
@@ -58,7 +58,7 @@ public extension HttpCodablePipelineCollection {
     ///
     /// - Returns: The HTTP response object
     ///
-    func rawRequest(
+    public func rawRequest(
         executor: ((HttpRequest) async throws -> HttpResponse),
         url: HttpUrl,
         method: HttpMethod,
@@ -75,7 +75,7 @@ public extension HttpCodablePipelineCollection {
         )
         return try await pipeline.execute(executor)
     }
-    
+
     ///
     /// Executes an encodable request pipeline using an encodable object as a body value and returns the response
     ///
@@ -90,7 +90,7 @@ public extension HttpCodablePipelineCollection {
     ///
     /// - Returns: The HTTP response object
     ///
-    func encodableRequest<T: Encodable>(
+    public func encodableRequest<T: Encodable>(
         executor: ((HttpRequest) async throws -> HttpResponse),
         url: HttpUrl,
         method: HttpMethod,
@@ -108,7 +108,7 @@ public extension HttpCodablePipelineCollection {
         )
         return try await pipeline.execute(executor)
     }
-    
+
     ///
     /// Executes a raw request pipeline using a data values as a body and returns the response
     ///
@@ -123,7 +123,7 @@ public extension HttpCodablePipelineCollection {
     ///
     /// - Returns: The decoded response object
     ///
-    func decodableRequest<U: Decodable>(
+    public func decodableRequest<U: Decodable>(
         executor: ((HttpRequest) async throws -> HttpResponse),
         url: HttpUrl,
         method: HttpMethod,
@@ -141,7 +141,7 @@ public extension HttpCodablePipelineCollection {
         )
         return try await pipeline.execute(executor)
     }
-    
+
     ///
     /// Executes a codable request pipeline using an encodable body and decodes the response
     ///
@@ -156,7 +156,7 @@ public extension HttpCodablePipelineCollection {
     ///
     /// - Returns: The decoded response object
     ///
-    func codableRequest<T: Encodable, U: Decodable>(
+    public func codableRequest<T: Encodable, U: Decodable>(
         executor: ((HttpRequest) async throws -> HttpResponse),
         url: HttpUrl,
         method: HttpMethod,

Sources/SwiftHttp/HttpDataDecoder.swift

@@ -9,7 +9,7 @@ import Foundation
 
 /// A generic HTTP data decoder
 public protocol HttpDataDecoder {
-    
+
     ///
     /// Decodes the response data into a custom decodable object
     ///
@@ -20,7 +20,8 @@ public protocol HttpDataDecoder {
     ///
     /// - Returns: The decoded object
     ///
-    func decode<T>(_ type: T.Type, from data: Data) throws -> T where T : Decodable
+    func decode<T>(_ type: T.Type, from data: Data) throws -> T
+    where T: Decodable
 }
 
 /// The JSON decoder is already a valid HTTP data decoder

Sources/SwiftHttp/HttpDataEncoder.swift

@@ -9,7 +9,7 @@ import Foundation
 
 /// Encodes an encodable object into a HTTP data representation
 public protocol HttpDataEncoder {
-    
+
     ///
     /// Encodes the object value into raw HTTP data
     ///
@@ -19,7 +19,7 @@ public protocol HttpDataEncoder {
     ///
     /// - Returns: The encoded data value
     ///
-    func encode<T>(_ value: T) throws -> Data where T : Encodable
+    func encode<T>(_ value: T) throws -> Data where T: Encodable
 }
 
 /// The JSON encoder is already a valid HTTP data encoder

Sources/SwiftHttp/HttpDecodablePipeline.swift

@@ -9,14 +9,14 @@ import Foundation
 
 /// A decodable pipeline workflow, to decode a value from the response
 public struct HttpDecodablePipeline<U: Decodable>: HttpRequestPipeline {
-    
+
     let url: HttpUrl
     let method: HttpMethod
     let headers: [HttpHeaderKey: String]
     let body: Data?
     let validators: [HttpResponseValidator]
     let decoder: HttpResponseDecoder<U>
-    
+
     ///
     /// Initialize the pipeline
     ///
@@ -42,7 +42,7 @@ public struct HttpDecodablePipeline<U: Decodable>: HttpRequestPipeline {
         self.validators = validators
         self.decoder = decoder
     }
-    
+
     ///
     /// Executes  the request, encodes the body, validates the response and decodes the data
     ///
@@ -68,4 +68,3 @@ public struct HttpDecodablePipeline<U: Decodable>: HttpRequestPipeline {
         return try decoder.decode(response.data)
     }
 }
-

Sources/SwiftHttp/HttpEncodablePipeline.swift

@@ -9,14 +9,14 @@ import Foundation
 
 /// An encodable pipeline can be used to send an encodable object as a request body
 public struct HttpEncodablePipeline<T: Encodable>: HttpRequestPipeline {
-    
+
     let url: HttpUrl
     let method: HttpMethod
     let headers: [HttpHeaderKey: String]
     let body: T
     let validators: [HttpResponseValidator]
     let encoder: HttpRequestEncoder<T>
-    
+
     ///
     /// Initialize the pipeline
     ///
@@ -42,7 +42,7 @@ public struct HttpEncodablePipeline<T: Encodable>: HttpRequestPipeline {
         self.validators = validators
         self.encoder = encoder
     }
-    
+
     ///
     /// Executes  the request, encodes the body, validates the response and decodes the data
     ///
@@ -61,7 +61,7 @@ public struct HttpEncodablePipeline<T: Encodable>: HttpRequestPipeline {
             headers: headers.merging(encoder.headers) { $1 },
             body: try encoder.encode(body)
         )
-        
+
         let response = try await executor(req)
         let validation = HttpResponseValidation(validators)
         try validation.validate(response)

Sources/SwiftHttp/HttpError.swift

@@ -9,28 +9,28 @@ import Foundation
 
 /// A generic error object to transfer HTTP related error messages
 public enum HttpError: LocalizedError {
-    
+
     /// The response is not a valid HTTP response
     case invalidResponse
-    
+
     /// The response has a unknown status code
     case unknownStatusCode
-    
+
     /// The response has an invalid status code
     case invalidStatusCode(HttpResponse)
-    
+
     /// The response is missing a header
     case missingHeader(HttpResponse)
-    
+
     /// The response has an invalid header value
     case invalidHeaderValue(HttpResponse)
-    
+
     /// Upload request does not have data to send
     case missingUploadData
-    
+
     /// Unknown error
     case unknown(Error)
-    
+
     /// Proper error descriptions  for the HttpError values
     public var errorDescription: String? {
         switch self {