Update Gravatar to 3.0.0 (#23701)

* Bump up to latest 3.0.0 revision

* Update to latest commit

* Adjust the update method

* Update the commit hash

* Set Gravatar to 3.0.0

* Add `squared()` for the image

* Move squared() to Gravatar service

* Add release notes

* Add unit test for

Author: pinarol

Modules/Package.swift

@@ -21,7 +21,7 @@ let package = Package(
         .package(url: "https://github.com/AliSoftware/OHHTTPStubs", from: "9.1.0"),
         .package(url: "https://github.com/Automattic/Automattic-Tracks-iOS", from: "3.4.2"),
         .package(url: "https://github.com/Automattic/AutomatticAbout-swift", from: "1.1.4"),
-        .package(url: "https://github.com/Automattic/Gravatar-SDK-iOS", from: "2.1.0"),
+        .package(url: "https://github.com/Automattic/Gravatar-SDK-iOS", from: "3.0.0"),
         .package(url: "https://github.com/Automattic/Gridicons-iOS", branch: "develop"),
         .package(url: "https://github.com/Automattic/ScreenObject", from: "0.2.3"),
         .package(url: "https://github.com/Automattic/XCUITestHelpers", from: "0.4.0"),

Modules/Sources/WordPressUI/Extensions/UIImage+Crop.swift

@@ -18,4 +18,20 @@ extension UIImage {
         }
         return self
     }
+
+    /// Crops the image in a perfectly square size. Longer edge is cropped out.
+    /// If the image is already square, then just returns `self`.
+    public func squared() -> UIImage {
+        let currentSizeInPixels: CGSize = .init(width: size.width * scale, height: size.height * scale)
+        guard currentSizeInPixels.width != currentSizeInPixels.height else { return self }
+        let squareEdge = floor(min(currentSizeInPixels.width, currentSizeInPixels.height))
+        let newSize = CGSize(width: squareEdge, height: squareEdge)
+        let format = UIGraphicsImageRendererFormat()
+        format.scale = 1
+        let renderer = UIGraphicsImageRenderer(size: newSize, format: format)
+        let squareImage = renderer.image { _ in
+            self.draw(in: CGRect(origin: .zero, size: newSize))
+        }
+        return squareImage
+    }
 }

Modules/Tests/WordPressUITests/Extensions/UIImage+CropTests.swift

@@ -0,0 +1,20 @@
+import XCTest
+import WordPressUI
+
+final class UIImage_CropTests: XCTestCase {
+
+    func testSquared() throws {
+        let image = try XCTUnwrap(createImage(size: .init(width: 96.0, height: 96.1)))
+        let squareImage = image.squared()
+        XCTAssertEqual(squareImage.size.width, squareImage.size.height)
+    }
+
+    private func createImage(color: UIColor = .blue, size: CGSize) -> UIImage? {
+        UIGraphicsBeginImageContextWithOptions(size, false, 0)
+        color.setFill()
+        UIRectFill(CGRectMake(0, 0, size.width, size.height))
+        let image = UIGraphicsGetImageFromCurrentImageContext()
+        UIGraphicsEndImageContext()
+        return image
+    }
+}

RELEASE-NOTES.txt

@@ -1,3 +1,7 @@
+25.6
+-----
+* [*] [internal] Update Gravatar SDK to 3.0.0 [#23701]
+
 25.5
 -----
 

WordPress.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -8,7 +8,7 @@ import Gravatar
 
 public protocol GravatarImageUploader {
     @discardableResult
-    func upload(_ image: UIImage, email: Email, accessToken: String) async throws -> URLResponse
+    func upload(_ image: UIImage, selectionBehavior: AvatarSelection, accessToken: String) async throws -> AvatarType
 }
 
 extension AvatarService: GravatarImageUploader { }
@@ -68,7 +68,10 @@ public class GravatarService {
 
         Task {
             do {
-                try await imageUploader.upload(image, email: Email(email), accessToken: accountToken)
+                // The `/v3` gravatar upload endpoint expects the image to be a perfect square, otherwise fails.
+                // Thus, we call `.squared()` (which will do nothing if the image is already square).
+                // cropping(to: ...) sometimes generates edges a few pixels uneven. So `.squared()` will compensate.
+                try await imageUploader.upload(image.squared(), selectionBehavior: .selectUploadedImage(for: Email(email)), accessToken: accountToken)
                 DDLogInfo("GravatarService.uploadImage Success!")
                 completion?(nil)
             } catch {

WordPress/Classes/Services/GravatarService.swift

@@ -20,14 +20,23 @@ class GravatarServiceTests: CoreDataTestCase {
             }
         }
     }
+    struct AvatarMock: AvatarType {
+        var url: String
+        var id: String
+    }
 
     class ImageServiceMock: GravatarImageUploader {
         var capturedAccountToken: String = ""
         var capturedAccountEmail: String = ""
-        func upload(_ image: UIImage, email: Email, accessToken: String) async throws -> URLResponse {
-            capturedAccountEmail = email.rawValue
+        func upload(_ image: UIImage, selectionBehavior: AvatarSelection, accessToken: String) async throws -> AvatarType {
+            switch selectionBehavior {
+            case .selectUploadedImage(for: let email):
+                capturedAccountEmail = email.rawValue
+            default:
+                break
+            }
             capturedAccountToken = accessToken
-            return URLResponse()
+            return AvatarMock(url: "https://domain.com/avatar", id: "ID")
         }
     }