Merge pull request #2948 from wordpress-mobile/10611-backend-receipts-add-the-new-endpoint

[Backend Receipts] Add the new endpoint

Author: kidinov

example/src/androidTest/java/org/wordpress/android/fluxc/mocked/MockedStack_WCOrdersTest.kt

@@ -541,6 +541,29 @@ class MockedStack_WCOrdersTest : MockedStack_Base() {
         assertEquals(payload.error.type, OrderErrorType.INVALID_RESPONSE)
     }
 
+    @Test
+    fun testFetchOrdersReceipt() = runBlocking {
+        interceptor.respondWith("wc-order-receipt-success.json")
+
+        val result = orderRestClient.fetchOrdersReceipt(
+            siteModel,
+            0,
+            expirationDate = "2024-01-23",
+            expirationDays = 365,
+            forceNew = false,
+        )
+
+        assertFalse(result.isError)
+        assertEquals(
+            "https://test.site/wc/file/transient/7e811783b66f468b61b4738231287b2a706ce1",
+            result.result!!.receiptUrl
+        )
+        assertEquals(
+            "2024-01-23",
+            result.result!!.expirationDate
+        )
+    }
+
     @Suppress("unused")
     @Subscribe
     fun onAction(action: Action<*>) {

example/src/androidTest/java/org/wordpress/android/fluxc/release/ReleaseStack_WCOrderExtTest.kt

@@ -222,4 +222,14 @@ class ReleaseStack_WCOrderExtTest : ReleaseStack_WCBase() {
         val providers = orderStore.getShipmentProvidersForSite(sSite)
         assertTrue(providers.isNotEmpty())
     }
+
+    @Test
+    fun givenOrderDoesntExit_WhenFetchOrderReceipt_ThenErrorReturned() = runBlocking {
+        val result = orderStore.fetchOrdersReceipt(
+            sSite,
+            Long.MAX_VALUE,
+        )
+
+        assertTrue(result.isError)
+    }
 }

example/src/androidTest/resources/wc-order-receipt-success.json

@@ -0,0 +1,6 @@
+{
+  "data": {
+    "receipt_url": "https:\/\/test.site\/wc\/file\/transient\/7e811783b66f468b61b4738231287b2a706ce1",
+    "expiration_date": "2024-01-23"
+  }
+}

example/src/test/java/org/wordpress/android/fluxc/wc/order/WCOrderStoreTest.kt

@@ -444,6 +444,33 @@ class WCOrderStoreTest {
         }
     }
 
+    @Test
+    fun testFetchOrdersReceipt() {
+        runBlocking {
+            val orderModel = OrderTestUtils.generateSampleOrder(42)
+            val site = SiteModel().apply { id = orderModel.localSiteId.value }
+            val orderId = 42L
+            val expirationDate = "2021-01-05"
+            val expirationDays = 30
+            val forceNew = true
+
+            orderStore.fetchOrdersReceipt(
+                site,
+                orderId,
+                expirationDate,
+                expirationDays,
+                forceNew
+            )
+
+            verify(orderRestClient).fetchOrdersReceipt(
+                site,
+                orderId,
+                expirationDate,
+                expirationDays,
+                forceNew
+            )
+        }
+    }
 
     private fun setupMissingOrders(): MutableMap<WCOrderSummaryModel, OrderEntity?> {
         return mutableMapOf<WCOrderSummaryModel, OrderEntity?>().apply {

fluxc-processor/src/main/resources/wc-wp-api-endpoints.txt

@@ -4,6 +4,7 @@
 /orders/<id>/shipment-trackings/
 /orders/<id>/shipment-trackings/<tracking>#String/
 /orders/<id>/shipment-trackings/providers/
+/orders/<id>/receipt/
 
 /products/<id>/
 /products/<id>/variations/

plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/order/OrderReceiptResponse.kt

@@ -0,0 +1,8 @@
+package org.wordpress.android.fluxc.network.rest.wpcom.wc.order
+
+import com.google.gson.annotations.SerializedName
+
+data class OrderReceiptResponse(
+    @SerializedName("receipt_url") val receiptUrl: String,
+    @SerializedName("expiration_date") val expirationDate: String,
+)

plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/order/OrderRestClient.kt

@@ -2,6 +2,7 @@
 
 package org.wordpress.android.fluxc.network.rest.wpcom.wc.order
 
+import android.net.Uri
 import com.google.gson.JsonElement
 import org.wordpress.android.fluxc.Dispatcher
 import org.wordpress.android.fluxc.action.WCOrderAction
@@ -839,6 +840,40 @@ class OrderRestClient @Inject constructor(
         }
     }
 
+    /**
+     * expirationDate: Formatted as yyyy-mm-dd.
+     * expirationDays: A number, 0 is today, 1 is tomorrow, etc.
+     * forceNew: Defaults to false, if true, creates a new receipt even if one already exists for the order.
+     */
+    suspend fun fetchOrdersReceipt(
+        site: SiteModel,
+        orderId: Long,
+        expirationDate: String? = null,
+        expirationDays: Int? = null,
+        forceNew: Boolean? = null
+    ): WooPayload<OrderReceiptResponse> {
+        val params = mutableMapOf<String, String>().apply {
+            expirationDate?.let { put("expiration_date", it) }
+            expirationDays?.let { put("expiration_days", it.toString()) }
+            forceNew?.let { put("force_new", it.toString()) }
+        }
+
+        val url = Uri.parse(WOOCOMMERCE.orders.id(orderId).receipt.pathV3)
+            .buildUpon().apply {
+                params.forEach { (key, value) ->
+                    appendQueryParameter(key, value)
+                }
+            }.build().toString()
+
+        val response = wooNetwork.executePostGsonRequest(
+            site = site,
+            path = url,
+            clazz = OrderReceiptResponse::class.java
+        )
+
+        return response.toWooPayload { it }
+    }
+
     private suspend fun doFetchOrderCount(site: SiteModel, filterByStatus: String?): FetchOrdersCountResponsePayload {
         val url = WOOCOMMERCE.reports.orders.totals.pathV3
 

plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCOrderStore.kt

@@ -635,6 +635,20 @@ class WCOrderStore @Inject constructor(
         }
     }
 
+    suspend fun fetchOrdersReceipt(
+        site: SiteModel,
+        orderId: Long,
+        expirationDate: String? = null,
+        expirationDays: Int? = null,
+        forceNew: Boolean? = null
+    ) = wcOrderRestClient.fetchOrdersReceipt(
+        site,
+        orderId,
+        expirationDate,
+        expirationDays,
+        forceNew
+    )
+
     private suspend fun updateOrderStatusLocally(orderId: Long, localSiteId: LocalId, newStatus: String) {
         val updatedOrder = ordersDao.getOrder(orderId, localSiteId)!!
             .copy(status = newStatus)