✨ Remove unused default headers & allow request specific headers

Add global configuration, refactoring & updated testing

.gitea/workflows/hermes.yml

@@ -0,0 +1,20 @@
+name: Run Swift Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: macos
+
+    steps:
+    - name: ⬇️ Checkout code v3
+      uses: actions/checkout@v4
+
+    - name: 🛠️ Setup node
+      uses: actions/setup-node@v4
+
+    - name: 🧪 Test
+      run: swift test

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 /.build
+/.vscode
 /Packages
 xcuserdata/
 DerivedData/

README.md

@@ -17,5 +17,5 @@ You can use Swift Package Manager to integrate Hermes into your project. Add the
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/yourusername/Hermes.git", from: "1.0.0")
+    .package(url: "https://git.mahtan-melwasul.com/Mahtan/Hermes.git", from: "1.0.0")
 ]

Sources/Hermes/Hermes.swift

@@ -11,6 +11,12 @@ public enum NetworkError: Error {
     case serverError(String)
     case decodingError
     case invalidResponse
+    case notFound
+}
+
+public protocol HermesMiddleware {
+    func processRequest(_ request: inout URLRequest)
+    func processResponse(_ data: Data?, _ response: URLResponse?, error: Error?)
 }
 
 extension NetworkError: LocalizedError {
@@ -19,19 +25,22 @@ extension NetworkError: LocalizedError {
             case .badRequest:
                 return NSLocalizedString("Unable to perform request", comment: "badRequestError")
             case .serverError(let errorMessage):
-                print(errorMessage)
                 return NSLocalizedString(errorMessage, comment: "serverError")
             case .decodingError:
                 return NSLocalizedString("Unable to decode successfully", comment: "decodingError")
             case .invalidResponse:
                 return NSLocalizedString("Invalid response", comment: "invalidResponse")
+            case .notFound:
+                return NSLocalizedString("Not Found", comment: "notFound")
         }
     }
 }
 
 public enum HTTPMethod {
-    case get([URLQueryItem])
+    case get([URLQueryItem]? = nil)
     case post(Data?)
+    case put(Data?)
+    case patch(Data?)
     case delete
     
     var name: String {
@@ -40,6 +49,10 @@ public enum HTTPMethod {
                 return "GET"
             case .post:
                 return "POST"
+            case .put:
+                return "PUT"
+            case .patch:
+                return "PATCH"
             case .delete:
                 return "DELETE"
         }
@@ -50,54 +63,118 @@ public struct Resource<T: Codable> {
     let url: URL
     var method: HTTPMethod = .get([])
     var modelType: T.Type
+    var headers: [String: String]
     
-    public init(url: URL, method: HTTPMethod, modelType: T.Type) {
+    public init(url: URL, method: HTTPMethod, modelType: T.Type, headers: [String: String] = [:]) {
         self.url = url
         self.method = method
         self.modelType = modelType
+        self.headers = headers
     }
 }
 
-public struct Hermes {
+public final class Hermes {
+    public static let shared = Hermes()
+    private var config: HermesConfiguration
+    private var middlewares: [HermesMiddleware] = []
+
+    private init(config: HermesConfiguration = HermesConfiguration()) {
+        self.config = config
+    }
     
-    public init() { }
+    public func configure(_ config: HermesConfiguration) {
+        self.config = config
+    }
+
+    public func addMiddleware(_ middleware: HermesMiddleware) {
+        middlewares.append(middleware)
+    }
+
+    private var defaultHeaders: [String: String] {
+        var headers = [
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+        ]
+        
+        headers.merge(config.defaultHeaders) { _, new in new }
+        
+        return headers
+    }
     
     public func load<T: Codable>(_ resource: Resource<T>) async throws -> T {
-        
         var request = URLRequest(url: resource.url)
-        
+        request.httpMethod = resource.method.name
+
+        for middleware in middlewares {
+            middleware.processRequest(&request)
+        }
+
         switch resource.method {
             case .get(let queryItems):
-                var components = URLComponents(url: resource.url, resolvingAgainstBaseURL: false)
-                components?.queryItems = queryItems
-            guard let url = components?.url else {
-                throw NetworkError.badRequest
+                if let queryItems = queryItems {
+                    var components = URLComponents(url: resource.url, resolvingAgainstBaseURL: false)
+                    components?.queryItems = queryItems
+                    request.url = components?.url
+                }
+            case .post(let data),
+                 .put(let data),
+                 .patch(let data):
+                request.httpBody = data
+            case .delete:
+                break
+        }
+        
+        var headers = defaultHeaders
+        
+        if !resource.headers.isEmpty {
+            headers.merge(resource.headers) { _, new in new }
+        }
+        
+        request.allHTTPHeaderFields = headers
+        
+        let session = URLSession(configuration: URLSessionConfiguration.default)
+        
+        do {
+            let (data, response) = try await session.data(for: request)
+
+            for middleware in middlewares {
+                middleware.processResponse(data, response, error: nil)
             }
-            
-            request = URLRequest(url: url)
-            
-        case .post(let data):
-            request.httpMethod = resource.method.name
-            request.httpBody = data
-            
-        case .delete:
-            request.httpMethod = resource.method.name
+
+            guard let httpResponse = response as? HTTPURLResponse else {
+                throw NetworkError.invalidResponse
+            }
+
+            try validate(response: httpResponse)
+
+            let decoder = JSONDecoder()
+            decoder.keyDecodingStrategy = config.decodingStrategy
+
+            do {
+                return try decoder.decode(resource.modelType, from: data)
+            } catch {
+                throw NetworkError.decodingError
+            }
+        } catch {
+            for middleware in middlewares {
+                middleware.processResponse(nil, nil, error: error)
+            }
+            throw error
         }
-        
-        let configuration = URLSessionConfiguration.default
-        configuration.httpAdditionalHeaders = ["Content-Type": "application/json"]
-        let session = URLSession(configuration: configuration)
-        
-        let (data, response) = try await session.data(for: request)
-        
-        guard let _ = response as? HTTPURLResponse else {
-            throw NetworkError.invalidResponse
+    }
+    
+    private func validate(response: HTTPURLResponse) throws {
+        switch response.statusCode {
+            case 200 ... 299:
+                return
+            case 400:
+                throw NetworkError.badRequest
+            case 404:
+                throw NetworkError.notFound
+            case 500:
+                throw NetworkError.serverError("Internal Server Error")
+            default:
+                throw NetworkError.invalidResponse
         }
-        
-        guard let result = try? JSONDecoder().decode(resource.modelType, from: data) else {
-            throw NetworkError.decodingError
-        }
-        
-        return result
     }
 }

Sources/Hermes/HermesConfiguration.swift

@@ -0,0 +1,18 @@
+//
+//  HermesConfiguration.swift
+//
+//
+//  Created by Victor on 28/05/2024.
+//
+
+import Foundation
+
+public struct HermesConfiguration {
+    var defaultHeaders: [String: String] = [:]
+    var decodingStrategy: JSONDecoder.KeyDecodingStrategy = .useDefaultKeys
+    
+    public init(defaultHeaders: [String: String] = [:], decodingStrategy: JSONDecoder.KeyDecodingStrategy = .useDefaultKeys) {
+        self.defaultHeaders = defaultHeaders
+        self.decodingStrategy = decodingStrategy
+    }
+}

Tests/HermesTests/HermesTests.swift

@@ -1,12 +1,139 @@
-import XCTest
 @testable import Hermes
+import XCTest
 
 final class HermesTests: XCTestCase {
-    func testExample() throws {
-        // XCTest Documentation
-        // https://developer.apple.com/documentation/xctest
-
-        // Defining Test Cases and Test Methods
-        // https://developer.apple.com/documentation/xctest/defining_test_cases_and_test_methods
+    override func setUp() {
+        super.setUp()
+        configureHermes()
+    }
+    
+    private func configureHermes() {
+        let defaultHeaders = ["Custom-Header": "HeaderValue"]
+        let decodingStrategy = JSONDecoder.KeyDecodingStrategy.convertFromSnakeCase
+        let config = HermesConfiguration(defaultHeaders: defaultHeaders, decodingStrategy: decodingStrategy)
+        Hermes.shared.configure(config)
+    }
+    
+    func testGetRequest() async throws {
+        let queryParams = [URLQueryItem(name: "foo", value: "bar")]
+        let resource = Resource(url: URL(string: "https://httpbin.org/get")!, method: .get(queryParams), modelType: GetResponse.self)
+        
+        let getResponse = try await Hermes.shared.load(resource)
+        
+        XCTAssertEqual(getResponse.url, "https://httpbin.org/get?foo=bar")
+        XCTAssertEqual(getResponse.args.count, 1)
+        XCTAssertGreaterThan(getResponse.headers.count, 0)
+    }
+    
+    func testPostRequest() async throws {
+        let postDatas = try? JSONEncoder().encode(["foo": "bar"])
+        let resource = Resource(url: URL(string: "https://httpbin.org/post")!, method: .post(postDatas), modelType: PostResponse.self)
+        
+        let postResponse = try await Hermes.shared.load(resource)
+        
+        XCTAssertEqual(postResponse.url, "https://httpbin.org/post")
+        XCTAssertEqual(postResponse.args.count, 0)
+        XCTAssertNotNil(postResponse.json)
+        XCTAssertEqual(postResponse.json?.count, 1)
+        XCTAssertGreaterThan(postResponse.headers.count, 0)
+    }
+    
+    func testPutRequest() async throws {
+        let postDatas = try? JSONEncoder().encode(["foo": "bar"])
+        let resource = Resource(url: URL(string: "https://httpbin.org/put")!, method: .put(postDatas), modelType: PostResponse.self)
+        
+        let putResponse = try await Hermes.shared.load(resource)
+        
+        XCTAssertEqual(putResponse.url, "https://httpbin.org/put")
+        XCTAssertEqual(putResponse.args.count, 0)
+        XCTAssertNotNil(putResponse.json)
+        XCTAssertEqual(putResponse.json?.count, 1)
+        XCTAssertGreaterThan(putResponse.headers.count, 0)
+    }
+    
+    func testPatchRequest() async throws {
+        let postDatas = try? JSONEncoder().encode(["foo": "bar"])
+        let resource = Resource(url: URL(string: "https://httpbin.org/patch")!, method: .patch(postDatas), modelType: PostResponse.self)
+        
+        let patchResponse = try await Hermes.shared.load(resource)
+        
+        XCTAssertEqual(patchResponse.url, "https://httpbin.org/patch")
+        XCTAssertEqual(patchResponse.args.count, 0)
+        XCTAssertNotNil(patchResponse.json)
+        XCTAssertEqual(patchResponse.json?.count, 1)
+        XCTAssertGreaterThan(patchResponse.headers.count, 0)
+    }
+    
+    func testDeleteRequest() async throws {
+        let resource = Resource(url: URL(string: "https://httpbin.org/delete")!, method: .delete, modelType: PostResponse.self)
+        
+        let deleteResponse = try await Hermes.shared.load(resource)
+        
+        XCTAssertEqual(deleteResponse.url, "https://httpbin.org/delete")
+        XCTAssertEqual(deleteResponse.args.count, 0)
+        XCTAssertNil(deleteResponse.json)
+        XCTAssertGreaterThan(deleteResponse.headers.count, 0)
+    }
+    
+    func testNotFound() async throws {
+        let resource = Resource(url: URL(string: "https://httpbin.org/status/404")!, method: .get(), modelType: GetResponse.self)
+        
+        do {
+            let _ = try await Hermes.shared.load(resource)
+            XCTFail("Expected to throw NetworkError.notFound")
+        } catch NetworkError.notFound {
+            XCTAssert(true)
+        } catch {
+            XCTFail("Unexpected error: \(error)")
+        }
+    }
+    
+    func testServerError() async throws {
+        let resource = Resource(url: URL(string: "https://httpbin.org/status/500")!, method: .get(), modelType: GetResponse.self)
+        
+        do {
+            let _ = try await Hermes.shared.load(resource)
+            XCTFail("Expected to throw NetworkError.serverError")
+        } catch NetworkError.serverError(_) {
+            XCTAssert(true)
+        } catch {
+            XCTFail("Unexpected error: \(error)")
+        }
+    }
+    
+    func testDecodeError() async throws {
+        let resource = Resource(url: URL(string: "https://httpbin.org/get")!, method: .get(), modelType: DummyResponse.self)
+        
+        do {
+            let _ = try await Hermes.shared.load(resource)
+            XCTFail("Expected to throw NetworkError.decodingError")
+        } catch NetworkError.decodingError {
+            XCTAssert(true)
+        } catch {
+            XCTFail("Unexpected error: \(error)")
+        }
     }
 }
+
+struct GetResponse: Codable {
+    let args: [String: String]
+    let headers: [String: String]
+    let origin: String
+    let url: String
+}
+
+struct PostResponse: Codable {
+    let args: [String: String]
+    let data: String
+    let files: [String: String]
+    let form: [String: String]
+    let headers: [String: String]
+    let json: [String: String]?
+    let origin: String
+    let url: String
+}
+
+struct DummyResponse: Codable {
+    let dumb: Int
+    let dumber: Double
+}