Update to the latest OpenAPI spec (#413)

AdamGrzybkowski · hamorillo · web-flow · commit bca65e9e4199 · 2024-10-25T11:21:45.000+02:00
* Update the openAPI spec and related code

* Adjust QE code to only select an Avatar when none is set

* Make hash and selecteAvatar optional when uploading avatar

* Rely on backend default for selecting the avatar

* Generate gravatar.api file

* Update gravatar/src/main/java/com/gravatar/services/AvatarService.kt

Co-authored-by: Héctor Abraham Morillo Prieto &lt;hector.abraham.morillo.prieto@automattic.com&gt;

* Add test to verify null was passed to upload API call

---------

Co-authored-by: Héctor Abraham Morillo Prieto &lt;hector.abraham.morillo.prieto@automattic.com&gt;
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -77,7 +77,7 @@ comments:
     searchProtectedProperty: false
   OutdatedDocumentation:
     active: true
-    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/api/models/**', '**/restapi/models/**' ]
+    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/restapi/models/**', '**/restapi/apis/**' ]
     matchTypeParameters: true
     matchDeclarationsOrder: true
     allowParamOnConstructorProperties: false
diff --git a/gravatar-quickeditor/src/main/java/com/gravatar/quickeditor/data/repository/AvatarRepository.kt b/gravatar-quickeditor/src/main/java/com/gravatar/quickeditor/data/repository/AvatarRepository.kt
@@ -49,17 +49,19 @@ internal class AvatarRepository(
         } ?: GravatarResult.Failure(QuickEditorError.TokenNotFound)
     }
 
-    suspend fun uploadAvatar(email: Email, avatarUri: Uri): GravatarResult<Avatar, QuickEditorError> = withContext(
-        dispatcher,
-    ) {
-        val token = tokenStorage.getToken(email.hash().toString())
-        token?.let {
-            when (val result = avatarService.uploadCatching(avatarUri.toFile(), token)) {
-                is GravatarResult.Success -> GravatarResult.Success(result.value)
-                is GravatarResult.Failure -> GravatarResult.Failure(QuickEditorError.Request(result.error))
-            }
-        } ?: GravatarResult.Failure(QuickEditorError.TokenNotFound)
-    }
+    suspend fun uploadAvatar(email: Email, avatarUri: Uri): GravatarResult<Avatar, QuickEditorError> =
+        withContext(dispatcher) {
+            val hash = email.hash()
+            val token = tokenStorage.getToken(hash.toString())
+            token?.let {
+                when (
+                    val result = avatarService.uploadCatching(avatarUri.toFile(), token, hash)
+                ) {
+                    is GravatarResult.Success -> GravatarResult.Success(result.value)
+                    is GravatarResult.Failure -> GravatarResult.Failure(QuickEditorError.Request(result.error))
+                }
+            } ?: GravatarResult.Failure(QuickEditorError.TokenNotFound)
+        }
 }
 
 internal data class EmailAvatars(
diff --git a/gravatar-quickeditor/src/main/java/com/gravatar/quickeditor/ui/avatarpicker/AvatarPickerViewModel.kt b/gravatar-quickeditor/src/main/java/com/gravatar/quickeditor/ui/avatarpicker/AvatarPickerViewModel.kt
@@ -146,34 +146,33 @@ internal class AvatarPickerViewModel(
             when (val result = avatarRepository.uploadAvatar(email, uri)) {
                 is GravatarResult.Success -> {
                     fileUtils.deleteFile(uri)
-                    val isAutoSelected = _uiState.value.emailAvatars?.selectedAvatarId == null
-                    if (isAutoSelected) {
-                        fetchAvatars(showLoading = false, scrollToSelected = true)
-                        _uiState.update { currentState ->
-                            currentState.copy(
-                                uploadingAvatar = null,
-                                avatarUpdates = currentState.avatarUpdates.inc(),
-                            )
-                        }
-                        if (_uiState.value.emailAvatars?.selectedAvatarId != null) {
-                            _actions.send(AvatarPickerAction.AvatarSelected)
-                        }
-                    } else {
-                        _uiState.update { currentState ->
-                            val avatar = result.value
-                            currentState.copy(
-                                uploadingAvatar = null,
-                                emailAvatars = currentState.emailAvatars?.copy(
-                                    avatars = buildList {
-                                        add(avatar)
-                                        addAll(
-                                            currentState.emailAvatars.avatars.filter { it.imageId != avatar.imageId },
-                                        )
-                                    },
-                                ),
-                                scrollToIndex = null,
-                            )
-                        }
+                    val avatar = result.value
+                    if (avatar.selected == true) {
+                        _actions.send(AvatarPickerAction.AvatarSelected)
+                    }
+                    _uiState.update { currentState ->
+                        currentState.copy(
+                            uploadingAvatar = null,
+                            emailAvatars = currentState.emailAvatars?.copy(
+                                avatars = buildList {
+                                    add(avatar)
+                                    addAll(
+                                        currentState.emailAvatars.avatars.filter { it.imageId != avatar.imageId },
+                                    )
+                                },
+                                selectedAvatarId = if (avatar.selected == true) {
+                                    avatar.imageId
+                                } else {
+                                    currentState.emailAvatars.selectedAvatarId
+                                },
+                            ),
+                            scrollToIndex = null,
+                            avatarUpdates = if (avatar.selected == true) {
+                                currentState.avatarUpdates.inc()
+                            } else {
+                                currentState.avatarUpdates
+                            },
+                        )
                     }
                 }
 
diff --git a/gravatar-quickeditor/src/test/java/com/gravatar/quickeditor/data/repository/AvatarRepositoryTest.kt b/gravatar-quickeditor/src/test/java/com/gravatar/quickeditor/data/repository/AvatarRepositoryTest.kt
@@ -121,7 +121,9 @@ class AvatarRepositoryTest {
     fun `given token not stored when avatar upload then Failure result`() = runTest {
         val uri = mockk<Uri>()
         coEvery { tokenStorage.getToken(any()) } returns null
-        coEvery { avatarService.uploadCatching(any(), any()) } returns GravatarResult.Success(createAvatar("1"))
+        coEvery {
+            avatarService.uploadCatching(any(), any(), any(), any())
+        } returns GravatarResult.Success(createAvatar("1"))
 
         val result = avatarRepository.uploadAvatar(email, uri)
 
@@ -137,7 +139,7 @@ class AvatarRepositoryTest {
             every { toFile() } returns file
         }
         coEvery { tokenStorage.getToken(any()) } returns "token"
-        coEvery { avatarService.uploadCatching(any(), any()) } returns GravatarResult.Success(avatar)
+        coEvery { avatarService.uploadCatching(any(), any(), any(), any()) } returns GravatarResult.Success(avatar)
 
         val result = avatarRepository.uploadAvatar(email, uri)
 
@@ -152,7 +154,9 @@ class AvatarRepositoryTest {
             every { toFile() } returns file
         }
         coEvery { tokenStorage.getToken(any()) } returns "token"
-        coEvery { avatarService.uploadCatching(any(), any()) } returns GravatarResult.Failure(ErrorType.Server)
+        coEvery {
+            avatarService.uploadCatching(any(), any(), any(), any())
+        } returns GravatarResult.Failure(ErrorType.Server)
 
         val result = avatarRepository.uploadAvatar(email, uri)
 
diff --git a/gravatar-quickeditor/src/test/java/com/gravatar/quickeditor/ui/avatarpicker/AvatarPickerViewModelTest.kt b/gravatar-quickeditor/src/test/java/com/gravatar/quickeditor/ui/avatarpicker/AvatarPickerViewModelTest.kt
@@ -719,10 +719,9 @@ class AvatarPickerViewModelTest {
             expectMostRecentItem()
 
             val emailAvatarsUpdated = emailAvatars.copy(
-                avatars = listOf(createAvatar("1"), createAvatar("3")),
+                avatars = listOf(createAvatar("1", isSelected = true), createAvatar("3", isSelected = false)),
                 selectedAvatarId = "1",
             )
-            coEvery { avatarRepository.getAvatars(any()) } returns GravatarResult.Success(emailAvatarsUpdated)
             viewModel.onEvent(AvatarPickerEvent.ImageCropped(uriOne))
 
             // State before upload starts
@@ -741,25 +740,6 @@ class AvatarPickerViewModelTest {
                 avatarPickerUiState,
                 awaitItem(),
             )
-
-            // State produced by fetchAvatars within Upload.Success
-            avatarPickerUiState = AvatarPickerUiState(
-                email = email,
-                emailAvatars = emailAvatarsUpdated,
-                error = null,
-                profile = ComponentState.Loaded(profile),
-                selectingAvatarId = null,
-                uploadingAvatar = uriOne,
-                scrollToIndex = 0,
-                avatarPickerContentLayout = avatarPickerContentLayout,
-                avatarUpdates = 0,
-            )
-
-            assertEquals(
-                avatarPickerUiState,
-                awaitItem(),
-            )
-
             // State produced before finishing uploadAvatar, just after fetchAvatars has finished
             avatarPickerUiState = AvatarPickerUiState(
                 email = email,
@@ -768,11 +748,10 @@ class AvatarPickerViewModelTest {
                 profile = ComponentState.Loaded(profile),
                 selectingAvatarId = null,
                 uploadingAvatar = null,
-                scrollToIndex = 0,
+                scrollToIndex = null,
                 avatarPickerContentLayout = avatarPickerContentLayout,
                 avatarUpdates = 1,
             )
-
             assertEquals(
                 avatarPickerUiState,
                 awaitItem(),
diff --git a/gravatar/api/gravatar.api b/gravatar/api/gravatar.api
@@ -647,8 +647,10 @@ public final class com/gravatar/services/AvatarService {
 	public final fun retrieveCatching (Ljava/lang/String;Lcom/gravatar/types/Hash;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public final fun setAvatar (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public final fun setAvatarCatching (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
-	public final fun upload (Ljava/io/File;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
-	public final fun uploadCatching (Ljava/io/File;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public final fun upload (Ljava/io/File;Ljava/lang/String;Lcom/gravatar/types/Hash;Ljava/lang/Boolean;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun upload$default (Lcom/gravatar/services/AvatarService;Ljava/io/File;Ljava/lang/String;Lcom/gravatar/types/Hash;Ljava/lang/Boolean;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public final fun uploadCatching (Ljava/io/File;Ljava/lang/String;Lcom/gravatar/types/Hash;Ljava/lang/Boolean;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun uploadCatching$default (Lcom/gravatar/services/AvatarService;Ljava/io/File;Ljava/lang/String;Lcom/gravatar/types/Hash;Ljava/lang/Boolean;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 }
 
 public abstract interface class com/gravatar/services/ErrorType {
diff --git a/gravatar/openapi/api-gravatar.json b/gravatar/openapi/api-gravatar.json
@@ -610,7 +610,8 @@
           "implicit": {
             "authorizationUrl": "https://public-api.wordpress.com/oauth2/authorize",
             "tokenUrl": "https://public-api.wordpress.com/oauth2/token",
-            "scopes": {}
+            "scopes": {
+            }
           }
         },
         "description": "WordPress OAuth token to authenticate the request."
@@ -818,10 +819,10 @@
           {
             "name": "selected_email_hash",
             "in": "query",
-            "description": "The sha256 hash of the email address used to determine which avatar is selected. The 'selected' attribute in the avatar list will be set to 'true' for the avatar associated with this email.",
+            "description": "The SHA256 hash of the email address used to determine which avatar is selected. The 'selected' attribute in the avatar list will be set to 'true' for the avatar associated with this email.",
             "schema": {
               "type": "string",
-              "default": null
+              "default": ""
             }
           }
         ],
@@ -861,6 +862,30 @@
             "oauth": []
           }
         ],
+        "parameters": [
+          {
+            "name": "selected_email_hash",
+            "in": "query",
+            "description": "The SHA256 hash of email. If provided, the uploaded image will be selected as the avatar for this email.",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "select_avatar",
+            "in": "query",
+            "description": "Determines if the uploaded image should be set as the avatar for the email. If not passed, the image is only selected as the email's avatar if no previous avatar has been set. Accepts '1'/'true' to always set the avatar or '0'/'false' to never set the avatar.",
+            "required": false,
+            "schema": {
+              "type": [
+                "boolean",
+                "null"
+              ],
+              "default": null
+            }
+          }
+        ],
         "requestBody": {
           "required": true,
           "content": {
diff --git a/gravatar/src/main/java/com/gravatar/restapi/apis/AvatarsApi.kt b/gravatar/src/main/java/com/gravatar/restapi/apis/AvatarsApi.kt
@@ -28,12 +28,12 @@ internal interface AvatarsApi {
      *  - 401: Not Authorized
      *  - 403: Insufficient Scope
      *
-     * @param selectedEmailHash The sha256 hash of the email address used to determine which avatar is selected. The &#39;selected&#39; attribute in the avatar list will be set to &#39;true&#39; for the avatar associated with this email. (optional, default to "null")
+     * @param selectedEmailHash The SHA256 hash of the email address used to determine which avatar is selected. The &#39;selected&#39; attribute in the avatar list will be set to &#39;true&#39; for the avatar associated with this email. (optional, default to "")
      * @return [kotlin.collections.List<Avatar>]
      */
     @GET("me/avatars")
     suspend fun getAvatars(
-        @Query("selected_email_hash") selectedEmailHash: kotlin.String? = "null",
+        @Query("selected_email_hash") selectedEmailHash: kotlin.String? = "",
     ): Response<kotlin.collections.List<Avatar>>
 
     /**
@@ -64,11 +64,15 @@ internal interface AvatarsApi {
      *  - 403: Insufficient Scope
      *
      * @param `data` The avatar image file
+     * @param selectedEmailHash The SHA256 hash of email. If provided, the uploaded image will be selected as the avatar for this email. (optional)
+     * @param selectAvatar Determines if the uploaded image should be set as the avatar for the email. If not passed, the image is only selected as the email&#39;s avatar if no previous avatar has been set. Accepts &#39;1&#39;/&#39;true&#39; to always set the avatar or &#39;0&#39;/&#39;false&#39; to never set the avatar. (optional, default to null)
      * @return [Avatar]
      */
     @Multipart
     @POST("me/avatars")
     suspend fun uploadAvatar(
         @Part `data`: MultipartBody.Part,
+        @Query("selected_email_hash") selectedEmailHash: kotlin.String? = null,
+        @Query("select_avatar") selectAvatar: kotlin.Boolean? = null,
     ): Response<Avatar>
 }
diff --git a/gravatar/src/main/java/com/gravatar/services/AvatarService.kt b/gravatar/src/main/java/com/gravatar/services/AvatarService.kt
@@ -28,15 +28,28 @@ public class AvatarService(private val okHttpClient: OkHttpClient? = null) {
      *
      * @param file The image file to upload
      * @param oauthToken The OAuth token to use for authentication
+     * @param hash The hash of the email to associate the avatar with.
+     * If null the primary email of the account will be used.
+     * @param selectAvatar Determines if the uploaded image should be set automatically as the avatar
+     * for the given hash. If null, the avatar will be selected only if no other avatar is set.
      */
-    public suspend fun upload(file: File, oauthToken: String): Avatar = runThrowingExceptionRequest {
+    public suspend fun upload(
+        file: File,
+        oauthToken: String,
+        hash: Hash? = null,
+        selectAvatar: Boolean? = null,
+    ): Avatar = runThrowingExceptionRequest {
         withContext(GravatarSdkDI.dispatcherIO) {
             val service = instance.getGravatarV3Service(okHttpClient, oauthToken)
 
             val filePart =
                 MultipartBody.Part.createFormData("image", file.name, file.asRequestBody())
 
-            val response = service.uploadAvatar(filePart)
+            val response = service.uploadAvatar(
+                data = filePart,
+                selectedEmailHash = hash?.toString(),
+                selectAvatar = selectAvatar,
+            )
 
             if (response.isSuccessful && response.body() != null) {
                 response.body()!!
@@ -59,11 +72,19 @@ public class AvatarService(private val okHttpClient: OkHttpClient? = null) {
      * @param file The image file to upload
      * @param oauthToken The OAuth token to use for authentication
      * @return The result of the operation
+     * @param hash The hash of the email to associate the avatar with.
+     * If null the primary email of the account will be used.
+     * @param selectAvatar Determines if the uploaded image should be set automatically as the avatar
+     * for the given hash. If null, the avatar will be selected only if no other avatar is set.
      */
-    public suspend fun uploadCatching(file: File, oauthToken: String): GravatarResult<Avatar, ErrorType> =
-        runCatchingRequest {
-            upload(file, oauthToken)
-        }
+    public suspend fun uploadCatching(
+        file: File,
+        oauthToken: String,
+        hash: Hash? = null,
+        selectAvatar: Boolean? = null,
+    ): GravatarResult<Avatar, ErrorType> = runCatchingRequest {
+        upload(file, oauthToken, hash, selectAvatar)
+    }
 
     /**
      * Retrieves a list of available avatars for the authenticated user.
diff --git a/gravatar/src/test/java/com/gravatar/services/AvatarServiceTest.kt b/gravatar/src/test/java/com/gravatar/services/AvatarServiceTest.kt
