add error support for non-200 status codes, include body by default on PUT requests.

Author: mtzaquia

Sources/Bifrost/API.swift

@@ -1,6 +1,4 @@
 //
-//  API.swift
-//
 //  Copyright (c) 2021 @mtzaquia
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -129,12 +127,20 @@ public extension API {
             Logger.bifrost.debug("Header fields: \(urlRequest.allHTTPHeaderFields ?? [:])")
         }
 
-        let task = urlSession.dataTask(with: urlRequest) { data, _, error in
+        let task = urlSession.dataTask(with: urlRequest) { data, response, error in
             if let error = error {
                 callback(.failure(error))
                 return
             }
-            
+
+            if let statusCode = (response as? HTTPURLResponse)?.statusCode,
+               !(200..<300).contains(statusCode),
+               let error = request.error(for: statusCode)
+            {
+                callback(.failure(error))
+                return
+            }
+
             guard let data = data else {
                 callback(.failure(URLError(.cannotDecodeRawData)))
                 return

Sources/Bifrost/BifrostError.swift

@@ -0,0 +1,40 @@
+//
+//  Copyright (c) 2024 @mtzaquia
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+//
+
+import Foundation
+
+/// A custom type for generic errors with status code or wrapping underlying errors.
+public enum BifrostError: LocalizedError {
+    /// A request returned a response with a non-success (200-299) status code.
+    case unsuccessfulStatusCode(_: Int)
+    /// A request returned an error that has an underlying error.
+    case wrapping(Error)
+
+    public var errorDescription: String? {
+        switch self {
+        case .unsuccessfulStatusCode(let statusCode):
+            return "\(statusCode): An error ocurred."
+        case .wrapping(let error):
+            return error.localizedDescription
+        }
+    }
+}

Sources/Bifrost/Requestable.swift

@@ -1,6 +1,4 @@
 //
-//  Requestable.swift
-//
 //  Copyright (c) 2021 @mtzaquia
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -68,6 +66,15 @@ public protocol Requestable: Encodable {
     /// - Parameter encoder: The JSON encoder that should be used for building the result.
     /// - Returns: The HTTP body to be embeded with the request.
     func bodyParameters(_ encoder: JSONEncoder) throws -> Data?
+
+    /// A function providing a custom error for a given status code. 
+    ///
+    /// By default, ``BifrostError/unsuccessfulStatusCode(_:message:)`` is
+    /// returned when a response's status code is not within the 200-299 range.
+    ///
+    /// - Parameter statusCode: The status code from the response.
+    /// - Returns: The error to be thrown by the request.
+    func error(for statusCode: Int) -> BifrostError?
 }
 
 public extension Requestable {
@@ -83,10 +90,14 @@ public extension Requestable {
     }
 
     func bodyParameters(_ encoder: JSONEncoder) throws -> Data? {
-        if method == .post {
+        if [HTTPMethod.post, .put].contains(method) {
             return try encoder.encode(self)
         } else {
             return nil
         }
     }
+
+    func error(for statusCode: Int) -> BifrostError? {
+        BifrostError.unsuccessfulStatusCode(statusCode)
+    }
 }

Sources/Bifrost/Utils/DictionaryEncoder.swift

@@ -1,6 +1,4 @@
 //
-//  DictionaryEncoder.swift
-//
 //  Copyright (c) 2021 @mtzaquia
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -49,7 +47,9 @@ public class DictionaryEncoder {
 	}
 
 	func encode<T>(_ value: T) throws -> [String: Any] where T: Encodable {
-		try JSONSerialization.jsonObject(with: try encoder.encode(value),
-										 options: .allowFragments) as! [String: Any]
+        try JSONSerialization.jsonObject(
+            with: try encoder.encode(value),
+            options: .allowFragments
+        ) as! [String: Any]
 	}
 }

Sources/Bifrost/Utils/Logging.swift

@@ -1,6 +1,4 @@
 //
-//  Logging.swift
-//
 //  Copyright (c) 2021 @mtzaquia
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy