Address Gravatar deprecation warnings around user auth flows (#16340)

Author: iamgabrielma

Modules/Sources/WordPressUI/Extensions/Gravatar/Gravatar.swift

@@ -1,33 +1,5 @@
 import Foundation
 
-/// Helper Enum that specifies all of the available Gravatar Image Ratings
-/// TODO: Convert into a pure Swift String Enum. It's done this way to maintain ObjC Compatibility
-///
-@available(*, deprecated, message: "Use `Rating` from the Gravatar iOS SDK. See: https://github.com/Automattic/Gravatar-SDK-iOS.")
-@objc
-public enum GravatarRatings: Int {
-    case g
-    case pg
-    case r
-    case x
-    case `default`
-
-    func stringValue() -> String {
-        switch self {
-        case .default:
-            fallthrough
-        case .g:
-            return "g"
-        case .pg:
-            return "pg"
-        case .r:
-            return "r"
-        case .x:
-            return "x"
-        }
-    }
-}
-
 /// Helper Enum that specifies some of the options for default images
 /// To see all available options, visit : https://en.gravatar.com/site/implement/images/
 ///
@@ -84,14 +56,14 @@ public struct Gravatar {
     public static func gravatarUrl(for email: String,
                                    defaultImage: GravatarDefaultImage? = nil,
                                    size: Int? = nil,
-                                   rating: GravatarRatings = .default) -> URL? {
+                                   rating: Rating = .general) -> URL? {
         let hash = gravatarHash(of: email)
         let targetURL = String(format: "%@/%@?d=%@&s=%d&r=%@",
                                Defaults.baseURL,
                                hash,
                                defaultImage?.rawValue ?? GravatarDefaultImage.fileNotFound.rawValue,
                                size ?? Defaults.imageSize,
-                               rating.stringValue())
+                               rating.rawValue)
         return URL(string: targetURL)
     }
 

Modules/Sources/WordPressUI/Extensions/Gravatar/Rating.swift

@@ -0,0 +1,19 @@
+import Foundation
+
+/// Sources:
+/// - https://github.com/Automattic/Gravatar-SDK-iOS/blob/trunk/Sources/Gravatar/Options/Rating.swift
+/// Gravatar allows users to self-rate their images so that they can indicate if an image is appropriate for a certain audience. By default, only `general`
+/// rated
+/// images are displayed unless you indicate that you would like to see higher ratings.
+///
+/// If the requested email hash does not have an image meeting the requested rating level, then the default avatar is returned (See: ``DefaultAvatarOption``)
+public enum Rating: String, Sendable, CaseIterable {
+    /// Suitable for display on all websites with any audience type.
+    case general = "g"
+    /// May contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence.
+    case parentalGuidance = "pg"
+    /// May contain such things as harsh profanity, intense violence, nudity, or hard drug use.
+    case restricted = "r"
+    /// May contain sexual imagery or extremely disturbing violence.
+    case x
+}

Modules/Sources/WordPressUI/Extensions/UIImageView+Gravatar.swift

@@ -21,31 +21,13 @@ private class GravatarNotificationWrapper {
 /// UIImageView Helper Methods that allow us to download a Gravatar, given the User's Email
 ///
 extension UIImageView {
-
-    /// Downloads and sets the User's Gravatar, given his email.
-    /// TODO: This is a convenience method. Please, remove once all of the code has been migrated over to Swift.
-    ///
-    /// - Parameters:
-    ///     - email: the user's email
-    ///     - rating: expected image rating
-    ///
-    ///   This method uses deprecated types. Please check the deprecation warning in `GravatarRatings`. Also check out the UIImageView extension from the Gravatar iOS SDK as an alternative to download images. See: https://github.com/Automattic/Gravatar-SDK-iOS.
-    @available(*, deprecated, message: "Usage of the deprecated type: GravatarRatings.")
-    @objc
-    public func downloadGravatarWithEmail(_ email: String, rating: GravatarRatings) {
-        downloadGravatarWithEmail(email, rating: rating, placeholderImage: .gravatarPlaceholderImage)
-    }
-
     /// Downloads and sets the User's Gravatar, given his email.
     ///
     /// - Parameters:
     ///     - email: the user's email
     ///     - rating: expected image rating
     ///     - placeholderImage: Image to be used as Placeholder
-    ///   This method uses deprecated types. Please check the deprecation warning in `GravatarRatings`. Also check out the UIImageView extension from the Gravatar iOS SDK as an alternative to download images. See: https://github.com/Automattic/Gravatar-SDK-iOS.
-    @available(*, deprecated, message: "Usage of the deprecated type: GravatarRatings.")
-    @objc
-    public func downloadGravatarWithEmail(_ email: String, rating: GravatarRatings = .default, placeholderImage: UIImage = .gravatarPlaceholderImage) {
+    public func downloadGravatarWithEmail(_ email: String, rating: Rating = .general, placeholderImage: UIImage = .gravatarPlaceholderImage) {
         let gravatarURL = Gravatar.gravatarUrl(for: email, size: gravatarDefaultSize(), rating: rating)
 
         listenForGravatarChanges(forEmail: email)
@@ -124,35 +106,6 @@ extension UIImageView {
         })
     }
 
-    /// Sets an Image Override in both, AFNetworking's Private Cache + NSURLCache
-    ///
-    /// - Parameters:
-    ///   - image: new UIImage
-    ///   - rating: rating for the new image.
-    ///   - email: associated email of the new gravatar
-    /// - Note: You may want to use `updateGravatar(image:, email:)` instead
-    ///
-    /// *WHY* is this required?. *WHY* life has to be so complicated?, is the universe against us?
-    /// This has been implemented as a workaround. During Upload, we want any async calls made to the
-    /// `downloadGravatar` API to return the "Fresh" image.
-    ///
-    /// Note II:
-    /// We cannot just clear NSURLCache, since the helper that's supposed to do that, is broken since iOS 8.
-    /// Ref: Ref: http://blog.airsource.co.uk/2014/10/11/nsurlcache-ios8-broken/
-    ///
-    /// P.s.:
-    /// Hope buddah, and the code reviewer, can forgive me for this hack.
-    ///
-    @available(*, deprecated, message: "Usage of the deprecated type: GravatarRatings.")
-    @objc public func overrideGravatarImageCache(_ image: UIImage, rating: GravatarRatings, email: String) {
-        guard let gravatarURL = Gravatar.gravatarUrl(for: email, size: gravatarDefaultSize(), rating: rating) else {
-            return
-        }
-
-        listenForGravatarChanges(forEmail: email)
-        overrideImageCache(for: gravatarURL, with: image)
-    }
-
     /// Updates the gravatar image for the given email, and notifies all gravatar image views
     ///
     /// - Parameters: