Merge pull request #14171 from woocommerce/issue/WOOMOB-370-shipping-label-refund-network

[Shipping labels] Request label refund network

Author: irfano

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/networking/DTOs.kt

@@ -214,6 +214,8 @@ data class CustomsItemDTO(
     @SerializedName("product_id") val productId: Long
 )
 
+data class RefundLabelResponseDTO(val success: Boolean)
+
 private class ShipmentMapDeserializer : JsonDeserializer<ShipmentMap> {
     override fun deserialize(json: JsonElement, typeOfT: Type, context: JsonDeserializationContext): ShipmentMap {
         // Handle string-encoded JSON or direct JSON object

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/networking/WooShippingLabelRepository.kt

@@ -245,4 +245,10 @@ class WooShippingLabelRepository @Inject constructor(
         shipments = shipments,
         shipmentIdsToUpdate = shipmentIdsToUpdate
     ).asWooResult()
+
+    suspend fun refundLabel(
+        site: SiteModel,
+        orderId: Long,
+        labelId: Long
+    ): WooResult<RefundLabelResponseDTO> = restClient.refundShippingLabel(orderId, labelId, site).asWooResult()
 }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/networking/WooShippingLabelRestClient.kt

@@ -222,4 +222,17 @@ class WooShippingLabelRestClient @Inject constructor(
 
         return result.toWooPayload()
     }
+
+    suspend fun refundShippingLabel(
+        orderId: Long,
+        labelId: Long,
+        site: SiteModel
+    ): WooPayload<RefundLabelResponseDTO> {
+        val url = "/wcshipping/v1/label/refund/$orderId/$labelId"
+        return wooNetwork.executePostGsonRequest(
+            site = site,
+            path = url,
+            clazz = RefundLabelResponseDTO::class.java,
+        ).toWooPayload()
+    }
 }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/refund/WooShippingLabelRefundViewModel.kt

@@ -7,6 +7,8 @@ import androidx.lifecycle.viewModelScope
 import com.woocommerce.android.R
 import com.woocommerce.android.extensions.formatToLocalizedMedium
 import com.woocommerce.android.tools.NetworkStatus
+import com.woocommerce.android.tools.SelectedSite
+import com.woocommerce.android.ui.orders.wooshippinglabels.networking.WooShippingLabelRepository
 import com.woocommerce.android.util.CurrencyFormatter
 import com.woocommerce.android.viewmodel.MultiLiveEvent.Event.Exit
 import com.woocommerce.android.viewmodel.MultiLiveEvent.Event.ShowSnackbar
@@ -23,6 +25,8 @@ import javax.inject.Inject
 @HiltViewModel
 class WooShippingLabelRefundViewModel @Inject constructor(
     savedState: SavedStateHandle,
+    private val selectedSite: SelectedSite,
+    private val repository: WooShippingLabelRepository,
     private val networkStatus: NetworkStatus,
     private val currencyFormatter: CurrencyFormatter,
 ) : ScopedViewModel(savedState) {
@@ -56,6 +60,17 @@ class WooShippingLabelRefundViewModel @Inject constructor(
         if (networkStatus.isConnected()) {
             _viewState.update { ViewState.Loading }
             launch {
+                repository.refundLabel(
+                    selectedSite.get(),
+                    arguments.orderId,
+                    arguments.shipment.labelId ?: return@launch
+                ).takeIf { it.isError.not() }?.let {
+                    triggerEvent(ShowSnackbar(R.string.shipping_label_refund_success))
+                    triggerEvent(Exit)
+                } ?: run {
+                    triggerEvent(ShowSnackbar(R.string.order_refunds_amount_refund_error))
+                    loadDataState()
+                }
             }
         } else {
             triggerEvent(ShowSnackbar(R.string.offline_error))

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/refund/WooShippingLabelRefundViewModelTest.kt

@@ -0,0 +1,84 @@
+package com.woocommerce.android.ui.orders.wooshippinglabels.refund
+
+import com.woocommerce.android.R
+import com.woocommerce.android.tools.NetworkStatus
+import com.woocommerce.android.tools.SelectedSite
+import com.woocommerce.android.ui.orders.wooshippinglabels.models.ShipmentUIModel
+import com.woocommerce.android.ui.orders.wooshippinglabels.networking.RefundLabelResponseDTO
+import com.woocommerce.android.ui.orders.wooshippinglabels.networking.WooShippingLabelRepository
+import com.woocommerce.android.viewmodel.BaseUnitTest
+import com.woocommerce.android.viewmodel.MultiLiveEvent.Event
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.Before
+import org.mockito.kotlin.doReturn
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+import org.wordpress.android.fluxc.model.SiteModel
+import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooResult
+import kotlin.test.Test
+
+@OptIn(ExperimentalCoroutinesApi::class)
+class WooShippingLabelRefundViewModelTest : BaseUnitTest() {
+    private lateinit var viewModel: WooShippingLabelRefundViewModel
+    private val mockOrderId = 456L
+    private val mockLabelId = 789L
+    val mockSite = SiteModel().apply { siteId = 123 }
+
+    private val selectedSite: SelectedSite = mock { on { get() } doReturn mockSite }
+    private val repository: WooShippingLabelRepository = mock()
+    private val networkStatus: NetworkStatus = mock { on { isConnected() } doReturn true }
+
+    @Before
+    fun setup() {
+        viewModel = WooShippingLabelRefundViewModel(
+            WooShippingLabelRefundFragmentArgs(
+                orderId = mockOrderId,
+                shipment = ShipmentUIModel(
+                    localId = "0",
+                    items = emptyList(),
+                    labelId = mockLabelId
+                )
+            ).toSavedStateHandle(),
+            selectedSite = selectedSite,
+            repository = repository,
+            networkStatus = networkStatus,
+            currencyFormatter = mock()
+        )
+    }
+
+    @Test
+    fun `when refund is successful, show success message and exit`() = testBlocking {
+        // Given
+        var capturedEvents = mutableListOf<Event>()
+        viewModel.event.observeForever { capturedEvents.add(it) }
+        whenever(
+            repository.refundLabel(site = mockSite, orderId = mockOrderId, labelId = mockLabelId)
+        ) doReturn WooResult(RefundLabelResponseDTO(true))
+
+        // When
+        viewModel.onRefundShippingLabelButtonClicked()
+
+        // Then
+        assertThat(capturedEvents.first()).isInstanceOf(Event.ShowSnackbar::class.java)
+        assertThat((capturedEvents.first() as Event.ShowSnackbar).message)
+            .isEqualTo(R.string.shipping_label_refund_success)
+        assertThat(capturedEvents.last()).isEqualTo(Event.Exit)
+    }
+
+    @Test
+    fun `when refund fails, show error message`() = testBlocking {
+        // Given
+        var capturedEvent: Event.Exit? = null
+        viewModel.event.observeForever { capturedEvent = it as? Event.Exit }
+        whenever(
+            repository.refundLabel(site = mockSite, orderId = mockOrderId, labelId = mockLabelId)
+        ) doReturn WooResult(RefundLabelResponseDTO(false))
+
+        // When
+        viewModel.onRefundShippingLabelButtonClicked()
+
+        // Then
+        assertThat(capturedEvent).isNotNull()
+    }
+}