Merge pull request #1592 from wordpress-mobile/woo/add-product-categories

Woo/add product categories

Author: nbradbury

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

@@ -13,6 +13,7 @@ import org.wordpress.android.fluxc.TestUtils
 import org.wordpress.android.fluxc.action.WCProductAction
 import org.wordpress.android.fluxc.annotations.action.Action
 import org.wordpress.android.fluxc.model.SiteModel
+import org.wordpress.android.fluxc.model.WCProductCategoryModel
 import org.wordpress.android.fluxc.model.WCProductImageModel
 import org.wordpress.android.fluxc.model.WCProductModel
 import org.wordpress.android.fluxc.module.ResponseMockingInterceptor
@@ -21,6 +22,7 @@ import org.wordpress.android.fluxc.persistence.ProductSqlUtils
 import org.wordpress.android.fluxc.persistence.SiteSqlUtils
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductReviewsResponsePayload
 import org.wordpress.android.fluxc.store.WCProductStore.ProductErrorType
+import org.wordpress.android.fluxc.store.WCProductStore.RemoteAddProductCategoryResponsePayload
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductCategoriesPayload
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductListPayload
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductPayload
@@ -665,6 +667,27 @@ class MockedStack_WCProductsTest : MockedStack_Base() {
         assertEquals(productAfter!!.getImages().size, 1)
     }
 
+    @Test
+    fun testAddProductCategorySuccess() {
+        interceptor.respondWith("wc-add-product-category-response-success.json")
+
+        val productCategoryModel = WCProductCategoryModel().apply { name = "test12" }
+        productRestClient.addProductCategory(siteModel, productCategoryModel)
+
+        countDownLatch = CountDownLatch(1)
+        assertTrue(countDownLatch.await(TestUtils.DEFAULT_TIMEOUT_MS.toLong(), TimeUnit.MILLISECONDS))
+
+        assertEquals(WCProductAction.ADDED_PRODUCT_CATEGORY, lastAction!!.type)
+        val payload = lastAction!!.payload as RemoteAddProductCategoryResponsePayload
+        assertFalse(payload.isError)
+        assertEquals(siteModel.id, payload.site.id)
+        assertEquals(productCategoryModel.name, payload.category?.name)
+
+        // Save product categories to the database
+        assertEquals(1, ProductSqlUtils.insertOrUpdateProductCategory(payload.category!!))
+        assertEquals(1, ProductSqlUtils.getProductCategoriesForSite(siteModel).size)
+    }
+
     @Test
     fun testFetchProductCategoriesSuccess() {
         interceptor.respondWith("wc-fetch-all-product-categories-response-success.json")

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

@@ -13,6 +13,7 @@ import org.wordpress.android.fluxc.action.WCProductAction
 import org.wordpress.android.fluxc.example.BuildConfig
 import org.wordpress.android.fluxc.generated.MediaActionBuilder
 import org.wordpress.android.fluxc.generated.WCProductActionBuilder
+import org.wordpress.android.fluxc.model.WCProductCategoryModel
 import org.wordpress.android.fluxc.model.WCProductImageModel
 import org.wordpress.android.fluxc.model.WCProductModel
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.product.CoreProductStatus
@@ -22,6 +23,7 @@ import org.wordpress.android.fluxc.persistence.ProductSqlUtils
 import org.wordpress.android.fluxc.store.MediaStore
 import org.wordpress.android.fluxc.store.MediaStore.OnMediaListFetched
 import org.wordpress.android.fluxc.store.WCProductStore
+import org.wordpress.android.fluxc.store.WCProductStore.AddProductCategoryPayload
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductCategoriesPayload
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductPasswordPayload
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductReviewsPayload
@@ -45,6 +47,7 @@ import org.wordpress.android.fluxc.store.WCProductStore.UpdateProductReviewStatu
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit.MILLISECONDS
 import javax.inject.Inject
+import kotlin.random.Random
 
 class ReleaseStack_WCProductTest : ReleaseStack_WCBase() {
     internal enum class TestEvent {
@@ -61,7 +64,8 @@ class ReleaseStack_WCProductTest : ReleaseStack_WCBase() {
         UPDATED_PRODUCT_REVIEW_STATUS,
         UPDATED_PRODUCT_IMAGES,
         UPDATED_PRODUCT_PASSWORD,
-        FETCH_PRODUCT_CATEGORIES
+        FETCH_PRODUCT_CATEGORIES,
+        ADDED_PRODUCT_CATEGORY
     }
 
     @Inject internal lateinit var productStore: WCProductStore
@@ -232,6 +236,31 @@ class ReleaseStack_WCProductTest : ReleaseStack_WCBase() {
         assertTrue(fetchAllCategories.isNotEmpty())
     }
 
+    @Throws(InterruptedException::class)
+    @Test
+    fun testAddProductCategory() {
+        // Remove all product categories from the database
+        ProductSqlUtils.deleteAllProductCategories()
+        assertEquals(0, ProductSqlUtils.getProductCategoriesForSite(sSite).size)
+
+        nextEvent = TestEvent.ADDED_PRODUCT_CATEGORY
+        mCountDownLatch = CountDownLatch(1)
+
+        val productCategoryModel = WCProductCategoryModel().apply {
+            // duplicate category names fail in the API level so added a random number next to the "Test"
+            name = "Test" + Random.nextInt(0, 10000)
+        }
+        mDispatcher.dispatch(WCProductActionBuilder.newAddProductCategoryAction(
+                AddProductCategoryPayload(sSite, productCategoryModel))
+        )
+        assertTrue(mCountDownLatch.await(TestUtils.DEFAULT_TIMEOUT_MS.toLong(), MILLISECONDS))
+
+        // Verify results
+        val fetchAllCategories = productStore.getProductCategoriesForSite(sSite)
+        assertTrue(fetchAllCategories.isNotEmpty())
+        assertTrue(fetchAllCategories.size == 1)
+    }
+
     @Throws(InterruptedException::class)
     @Test
     fun testFetchProductReviews() {
@@ -657,6 +686,10 @@ class ReleaseStack_WCProductTest : ReleaseStack_WCBase() {
                 assertEquals(TestEvent.FETCH_PRODUCT_CATEGORIES, nextEvent)
                 mCountDownLatch.countDown()
             }
+            WCProductAction.ADDED_PRODUCT_CATEGORY -> {
+                assertEquals(TestEvent.ADDED_PRODUCT_CATEGORY, nextEvent)
+                mCountDownLatch.countDown()
+            }
             else -> throw AssertionError("Unexpected cause of change: " + event.causeOfChange)
         }
     }

example/src/androidTest/resources/wc-add-product-category-response-success.json

@@ -0,0 +1,21 @@
+{
+  "data": {
+    "id": 105,
+    "name": "test12",
+    "slug": "test12",
+    "parent": 0,
+    "description": "",
+    "display": "default",
+    "image": null,
+    "menu_order": 0,
+    "count": 0,
+    "_links": {
+      "self": [{
+        "href": "https:\/\/awootestshop.mystagingwebsite.com\/wp-json\/wc\/v3\/products\/categories\/105"
+      }],
+      "collection": [{
+        "href": "https:\/\/awootestshop.mystagingwebsite.com\/wp-json\/wc\/v3\/products\/categories"
+      }]
+    }
+  }
+}

example/src/main/java/org/wordpress/android/fluxc/example/ui/products/WooProductsFragment.kt

@@ -12,6 +12,7 @@ import kotlinx.android.synthetic.main.fragment_woo_products.*
 import org.greenrobot.eventbus.Subscribe
 import org.greenrobot.eventbus.ThreadMode
 import org.wordpress.android.fluxc.Dispatcher
+import org.wordpress.android.fluxc.action.WCProductAction.ADDED_PRODUCT_CATEGORY
 import org.wordpress.android.fluxc.action.WCProductAction.FETCH_PRODUCTS
 import org.wordpress.android.fluxc.action.WCProductAction.FETCH_PRODUCT_CATEGORIES
 import org.wordpress.android.fluxc.action.WCProductAction.FETCH_PRODUCT_REVIEWS
@@ -27,9 +28,11 @@ import org.wordpress.android.fluxc.example.ui.StoreSelectorDialog
 import org.wordpress.android.fluxc.example.utils.showSingleLineDialog
 import org.wordpress.android.fluxc.generated.WCProductActionBuilder
 import org.wordpress.android.fluxc.model.SiteModel
+import org.wordpress.android.fluxc.model.WCProductCategoryModel
 import org.wordpress.android.fluxc.model.WCProductImageModel
 import org.wordpress.android.fluxc.store.MediaStore
 import org.wordpress.android.fluxc.store.WCProductStore
+import org.wordpress.android.fluxc.store.WCProductStore.AddProductCategoryPayload
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductCategoriesPayload
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductReviewsPayload
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductShippingClassListPayload
@@ -257,6 +260,23 @@ class WooProductsFragment : Fragment() {
             }
         }
 
+        add_product_category.setOnClickListener {
+            selectedSite?.let { site ->
+                showSingleLineDialog(
+                        activity,
+                        "Enter a catrgory name:"
+                ) { editText ->
+                    val categoryName = editText.text.toString()
+                    if (categoryName.isNotEmpty()) {
+                        prependToLog("Submitting request to add product category")
+                        val wcProductCategoryModel = WCProductCategoryModel().apply { name = categoryName }
+                        val payload = AddProductCategoryPayload(site, wcProductCategoryModel)
+                        dispatcher.dispatch(WCProductActionBuilder.newAddProductCategoryAction(payload))
+                    } else prependToLog("No category name entered...doing nothing")
+                }
+            }
+        }
+
         update_product_images.setOnClickListener {
             showSingleLineDialog(
                     activity,
@@ -414,6 +434,9 @@ class WooProductsFragment : Fragment() {
                         load_more_product_categories.isEnabled = false
                     }
                 }
+                ADDED_PRODUCT_CATEGORY -> {
+                    prependToLog("${event.rowsAffected} product category added")
+                } else -> { }
             }
         }
     }

example/src/main/res/layout/fragment_woo_products.xml

@@ -144,6 +144,13 @@
             android:visibility="gone"
             android:text="Load More Product Categories" />
 
+        <Button
+            android:id="@+id/add_product_category"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:enabled="false"
+            android:text="Add Product Category" />
+
         <Button
             android:id="@+id/update_product_images"
             android:layout_width="wrap_content"

plugins/woocommerce/src/main/java/org/wordpress/android/fluxc/action/WCProductAction.java

@@ -3,6 +3,7 @@
 import org.wordpress.android.fluxc.annotations.Action;
 import org.wordpress.android.fluxc.annotations.ActionEnum;
 import org.wordpress.android.fluxc.annotations.action.IAction;
+import org.wordpress.android.fluxc.store.WCProductStore.AddProductCategoryPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductCategoriesPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductPasswordPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.FetchProductReviewsPayload;
@@ -14,6 +15,7 @@
 import org.wordpress.android.fluxc.store.WCProductStore.FetchSingleProductPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.FetchSingleProductReviewPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.FetchSingleProductShippingClassPayload;
+import org.wordpress.android.fluxc.store.WCProductStore.RemoteAddProductCategoryResponsePayload;
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductCategoriesPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductListPayload;
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductPasswordPayload;
@@ -66,6 +68,8 @@ public enum WCProductAction implements IAction {
     UPDATE_PRODUCT_PASSWORD,
     @Action(payloadType = FetchProductCategoriesPayload.class)
     FETCH_PRODUCT_CATEGORIES,
+    @Action(payloadType = AddProductCategoryPayload.class)
+    ADD_PRODUCT_CATEGORY,
 
 
     // Remote responses
@@ -98,5 +102,7 @@ public enum WCProductAction implements IAction {
     @Action(payloadType = RemoteUpdatedProductPasswordPayload.class)
     UPDATED_PRODUCT_PASSWORD,
     @Action(payloadType = RemoteProductCategoriesPayload.class)
-    FETCHED_PRODUCT_CATEGORIES
+    FETCHED_PRODUCT_CATEGORIES,
+    @Action(payloadType = RemoteAddProductCategoryResponsePayload.class)
+    ADDED_PRODUCT_CATEGORY
 }

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

@@ -44,6 +44,7 @@ import org.wordpress.android.fluxc.store.WCProductStore.ProductSorting.DATE_ASC
 import org.wordpress.android.fluxc.store.WCProductStore.ProductSorting.DATE_DESC
 import org.wordpress.android.fluxc.store.WCProductStore.ProductSorting.TITLE_ASC
 import org.wordpress.android.fluxc.store.WCProductStore.ProductSorting.TITLE_DESC
+import org.wordpress.android.fluxc.store.WCProductStore.RemoteAddProductCategoryResponsePayload
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductCategoriesPayload
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductListPayload
 import org.wordpress.android.fluxc.store.WCProductStore.RemoteProductPasswordPayload
@@ -550,6 +551,43 @@ class ProductRestClient(
         add(request)
     }
 
+    /**
+     * Posts a new Add Category record to the API for a category.
+     *
+     * Makes a POST call `/wc/v3/products/categories/id` to save a Category record via the Jetpack tunnel.
+     * Returns a [WCProductCategoryModel] on successful response.
+     *
+     * Dispatches [WCProductAction.ADDED_PRODUCT_CATEGORY] action with the results.
+     */
+    fun addProductCategory(
+        site: SiteModel,
+        category: WCProductCategoryModel
+    ) {
+        val url = WOOCOMMERCE.products.categories.pathV3
+
+        val responseType = object : TypeToken<ProductCategoryApiResponse>() {}.type
+        val params = mutableMapOf(
+                "name" to category.name,
+                "parent" to category.parent.toString()
+        )
+        val request = JetpackTunnelGsonRequest.buildPostRequest(url, site.siteId, params, responseType,
+                { response: ProductCategoryApiResponse? ->
+                    val categoryResponse = response?.let {
+                        productCategoryResponseToProductCategoryModel(it).apply {
+                            localSiteId = site.id
+                        }
+                    }
+                    val payload = RemoteAddProductCategoryResponsePayload(site, categoryResponse)
+                    dispatcher.dispatch(WCProductActionBuilder.newAddedProductCategoryAction(payload))
+                },
+                WPComErrorListener { networkError ->
+                    val productCategorySaveError = networkErrorToProductError(networkError)
+                    val payload = RemoteAddProductCategoryResponsePayload(productCategorySaveError, site, category)
+                    dispatcher.dispatch(WCProductActionBuilder.newAddedProductCategoryAction(payload))
+                })
+        add(request)
+    }
+
     /**
      * Makes a GET call to `/wc/v3/products/reviews` via the Jetpack tunnel (see [JetpackTunnelGsonRequest]),
      * retrieving a list of product reviews for a given WooCommerce [SiteModel].
@@ -980,6 +1018,7 @@ class ProductRestClient(
             "woocommerce_rest_review_invalid_id" -> ProductErrorType.INVALID_REVIEW_ID
             "woocommerce_product_invalid_image_id" -> ProductErrorType.INVALID_IMAGE_ID
             "product_invalid_sku" -> ProductErrorType.DUPLICATE_SKU
+            "term_exists" -> ProductErrorType.TERM_EXISTS
             else -> ProductErrorType.fromString(wpComError.apiError)
         }
         return ProductError(productErrorType, wpComError.message)

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

@@ -139,11 +139,17 @@ class WCProductStore @Inject constructor(dispatcher: Dispatcher, private val wcP
         var productCategorySorting: ProductCategorySorting = DEFAULT_CATEGORY_SORTING
     ) : Payload<BaseNetworkError>()
 
+    class AddProductCategoryPayload(
+        val site: SiteModel,
+        val category: WCProductCategoryModel
+    ) : Payload<BaseNetworkError>()
+
     enum class ProductErrorType {
         INVALID_PARAM,
         INVALID_REVIEW_ID,
         INVALID_IMAGE_ID,
         DUPLICATE_SKU,
+        TERM_EXISTS, // indicates duplicate term name. Currently only used when adding product categories
         GENERIC_ERROR;
 
         companion object {
@@ -361,6 +367,17 @@ class WCProductStore @Inject constructor(dispatcher: Dispatcher, private val wcP
         }
     }
 
+    class RemoteAddProductCategoryResponsePayload(
+        val site: SiteModel,
+        val category: WCProductCategoryModel?
+    ) : Payload<ProductError>() {
+        constructor(
+            error: ProductError,
+            site: SiteModel,
+            category: WCProductCategoryModel?
+        ) : this(site, category) { this.error = error }
+    }
+
     // OnChanged events
     class OnProductChanged(
         var rowsAffected: Int,
@@ -541,6 +558,8 @@ class WCProductStore @Inject constructor(dispatcher: Dispatcher, private val wcP
                 updateProductPassword(action.payload as UpdateProductPasswordPayload)
             WCProductAction.FETCH_PRODUCT_CATEGORIES ->
                 fetchProductCategories(action.payload as FetchProductCategoriesPayload)
+            WCProductAction.ADD_PRODUCT_CATEGORY ->
+                addProductCategory(action.payload as AddProductCategoryPayload)
 
             // remote responses
             WCProductAction.FETCHED_SINGLE_PRODUCT ->
@@ -573,6 +592,8 @@ class WCProductStore @Inject constructor(dispatcher: Dispatcher, private val wcP
                 handleUpdatedProductPasswordCompleted(action.payload as RemoteUpdatedProductPasswordPayload)
             WCProductAction.FETCHED_PRODUCT_CATEGORIES ->
                 handleFetchProductCategories(action.payload as RemoteProductCategoriesPayload)
+            WCProductAction.ADDED_PRODUCT_CATEGORY ->
+                handleAddProductCategory(action.payload as RemoteAddProductCategoryResponsePayload)
         }
     }
 
@@ -641,6 +662,10 @@ class WCProductStore @Inject constructor(dispatcher: Dispatcher, private val wcP
                 site, pageSize, offset, productCategorySorting) }
     }
 
+    private fun addProductCategory(payload: AddProductCategoryPayload) {
+        with(payload) { wcProductRestClient.addProductCategory(site, category) }
+    }
+
     private fun updateProduct(payload: UpdateProductPayload) {
         with(payload) {
             val storedProduct = getProductByRemoteId(site, product.remoteProductId)
@@ -880,4 +905,18 @@ class WCProductStore @Inject constructor(dispatcher: Dispatcher, private val wcP
         onProductCategoryChanged.causeOfChange = WCProductAction.FETCH_PRODUCT_CATEGORIES
         emitChange(onProductCategoryChanged)
     }
+
+    private fun handleAddProductCategory(payload: RemoteAddProductCategoryResponsePayload) {
+        val onProductCategoryChanged: OnProductCategoryChanged
+
+        if (payload.isError) {
+            onProductCategoryChanged = OnProductCategoryChanged(0).also { it.error = payload.error }
+        } else {
+            val rowsAffected = payload.category?.let { ProductSqlUtils.insertOrUpdateProductCategory(it) } ?: 0
+            onProductCategoryChanged = OnProductCategoryChanged(rowsAffected)
+        }
+
+        onProductCategoryChanged.causeOfChange = WCProductAction.ADDED_PRODUCT_CATEGORY
+        emitChange(onProductCategoryChanged)
+    }
 }