Add "Client-Type" header for avatar upload request (#174)

* Add header "Client-Type":"ios" to avatar upload

* Update version as 1.0.1

Sources/Gravatar/Network/Services/AvatarService.swift

@@ -46,6 +46,6 @@ public struct AvatarService {
     /// - Returns: An asynchronously-delivered `URLResponse` instance, containing the response of the upload network task.
     @discardableResult
     public func upload(_ image: UIImage, email: Email, accessToken: String) async throws -> URLResponse {
-        try await imageUploader.uploadImage(image, email: email, accessToken: accessToken)
+        try await imageUploader.uploadImage(image, email: email, accessToken: accessToken, additionalHTTPHeaders: [(name: "Client-Type", value: "ios")])
     }
 }

Sources/Gravatar/Network/Services/ImageUploadService.swift

@@ -13,17 +13,18 @@ struct ImageUploadService: ImageUploader {
     }
 
     @discardableResult
-    func uploadImage(_ image: UIImage, email: Email, accessToken: String) async throws -> URLResponse {
+    func uploadImage(_ image: UIImage, email: Email, accessToken: String, additionalHTTPHeaders: [HTTPHeaderField]?) async throws -> URLResponse {
         guard let data = image.pngData() else {
             throw ImageUploadError.cannotConvertImageIntoData
         }
 
-        return try await uploadImage(data: data, email: email, accessToken: accessToken)
+        return try await uploadImage(data: data, email: email, accessToken: accessToken, additionalHTTPHeaders: additionalHTTPHeaders)
     }
 
-    private func uploadImage(data: Data, email: Email, accessToken: String) async throws -> URLResponse {
+    private func uploadImage(data: Data, email: Email, accessToken: String, additionalHTTPHeaders: [HTTPHeaderField]?) async throws -> URLResponse {
         let boundary = "Boundary-\(UUID().uuidString)"
-        let request = URLRequest.imageUploadRequest(with: boundary).settingAuthorizationHeaderField(with: accessToken)
+        let request = URLRequest.imageUploadRequest(with: boundary, additionalHTTPHeaders: additionalHTTPHeaders)
+            .settingAuthorizationHeaderField(with: accessToken)
         // For the Multipart form/data, we need to send the email address, not the id of the emai address
         let body = imageUploadBody(with: data, account: email.rawValue, boundary: boundary) // TODO:
         do {
@@ -75,11 +76,14 @@ extension Data {
 }
 
 extension URLRequest {
-    fileprivate static func imageUploadRequest(with boundary: String) -> URLRequest {
+    fileprivate static func imageUploadRequest(with boundary: String, additionalHTTPHeaders: [HTTPHeaderField]?) -> URLRequest {
         let url = URL(string: "https://api.gravatar.com/v1/upload-image")!
         var request = URLRequest(url: url)
         request.addValue("multipart/form-data; boundary=\(boundary)", forHTTPHeaderField: "Content-Type")
         request.httpMethod = "POST"
+        additionalHTTPHeaders?.forEach { headerTuple in
+            request.addValue(headerTuple.value, forHTTPHeaderField: headerTuple.name)
+        }
         return request
     }
 }

Sources/Gravatar/Network/Services/ImageUploader.swift

@@ -1,5 +1,7 @@
 import UIKit
 
+typealias HTTPHeaderField = (name: String, value: String)
+
 /// Represents a type which can be used by Gravatar to upload an  image to Gravatar.
 protocol ImageUploader {
     /// Uploads an image to be used as the user's Gravatar profile image, and returns the `URLResponse` of the network tasks asynchronously. Throws
@@ -8,11 +10,13 @@ protocol ImageUploader {
     ///   - image: The image to be uploaded.
     ///   - email: The user email account.
     ///   - accessToken: The authentication token for the user.
+    ///   - additionalHTTPHeaders: Additional headers to add.
     /// - Returns: An asynchronously-delivered `URLResponse` instance, containing the response of the upload network task.
     @discardableResult
     func uploadImage(
         _ image: UIImage,
         email: Email,
-        accessToken: String
+        accessToken: String,
+        additionalHTTPHeaders: [HTTPHeaderField]?
     ) async throws -> URLResponse
 }

Tests/GravatarTests/AvatarServiceTests.swift

@@ -35,6 +35,7 @@ final class AvatarServiceTests: XCTestCase {
         XCTAssertTrue(sessionMock.request?.value(forHTTPHeaderField: "Authorization")?.hasPrefix("Bearer ") ?? false)
         XCTAssertNotNil(sessionMock.request?.value(forHTTPHeaderField: "Content-Type"))
         XCTAssertTrue(sessionMock.request?.value(forHTTPHeaderField: "Content-Type")?.hasPrefix("multipart/form-data; boundary=Boundary") ?? false)
+        XCTAssertTrue(sessionMock.request?.value(forHTTPHeaderField: "Client-Type") == "ios")
     }
 
     func testUploadImageError() async throws {

version.rb

@@ -1,3 +1,3 @@
 module Gravatar
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
 end