Merge pull request #3038 from wordpress-mobile/add/woo-gla-eligibility-check

[Woo: Google Listings and Ads] Create store and add functionality to check Google Ads connection status

Author: JorgeMucientes

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

@@ -30,6 +30,7 @@ import org.wordpress.android.fluxc.example.ui.storecreation.WooStoreCreationFrag
 import org.wordpress.android.fluxc.example.ui.taxes.WooTaxFragment
 import org.wordpress.android.fluxc.example.ui.wooadmin.WooAdminFragment
 import org.wordpress.android.fluxc.store.WCDataStore
+import org.wordpress.android.fluxc.store.WCGoogleStore
 import org.wordpress.android.fluxc.store.WCUserStore
 import org.wordpress.android.fluxc.store.WooCommerceStore
 import org.wordpress.android.util.AppLog
@@ -41,6 +42,7 @@ class WooCommerceFragment : StoreSelectingFragment() {
     @Inject lateinit var wooCommerceStore: WooCommerceStore
     @Inject lateinit var wooDataStore: WCDataStore
     @Inject lateinit var wooUserStore: WCUserStore
+    @Inject lateinit var wooGoogleStore: WCGoogleStore
 
     private val coroutineScope = CoroutineScope(Dispatchers.Main)
 
@@ -231,6 +233,22 @@ class WooCommerceFragment : StoreSelectingFragment() {
         woo_admin.setOnClickListener {
             replaceFragment(WooAdminFragment())
         }
+
+        woo_gla_google_ads_status.setOnClickListener {
+            selectedSite?.let { selectedSite ->
+                coroutineScope.launch {
+                    val result = withContext(Dispatchers.Default) {
+                        wooGoogleStore.isGoogleAdsAccountConnected(selectedSite)
+                    }
+                    result.error?.let {
+                        prependToLog("Error in fetchGoogleAdsConnectionStatus: ${it.type} - ${it.message}")
+                    }
+                    result.model?.let {
+                        prependToLog("Google Ads connection status: $it")
+                    } ?: prependToLog("Couldn't fetch Google Ads connection status.")
+                }
+            } ?: showNoWCSitesToast()
+        }
     }
 
     @Suppress("TooGenericExceptionCaught")

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

@@ -147,5 +147,11 @@
             android:layout_height="wrap_content"
             android:text="WooCommerce Admin" />
 
+        <Button
+            android:id="@+id/woo_gla_google_ads_status"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:text="Google Listing and Ads: Check Google Ads Connection Status" />
+
     </LinearLayout>
 </ScrollView>

fluxc-annotations/src/main/java/org/wordpress/android/fluxc/annotations/endpoint/WCWPAPIEndpoint.java

@@ -1,6 +1,8 @@
 package org.wordpress.android.fluxc.annotations.endpoint;
 
 public class WCWPAPIEndpoint {
+    private static final String WC_PREFIX = "wc";
+
     private static final String WC_PREFIX_V3 = "wc/v3";
 
     private static final String WC_PREFIX_V1 = "wc/v1";
@@ -51,6 +53,10 @@ public String getPathV4() {
         return "/" + WC_PREFIX_V4 + mEndpoint;
     }
 
+    public String getPathNoVersion() {
+        return "/" + WC_PREFIX + mEndpoint;
+    }
+
     public String getPathV4Analytics() {
         return "/" + WC_PREFIX_V4_ANALYTICS + mEndpoint;
     }

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

@@ -122,4 +122,6 @@
 /options
 
 /shipping_methods
-/shipping_methods/<id>#String
+/shipping_methods/<id>#String
+
+/gla/ads/connection

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

@@ -0,0 +1,44 @@
+package org.wordpress.android.fluxc.network.rest.wpcom.wc.google
+
+import com.google.gson.annotations.SerializedName
+import org.wordpress.android.fluxc.generated.endpoint.WOOCOMMERCE
+import org.wordpress.android.fluxc.model.SiteModel
+import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooNetwork
+import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooPayload
+import org.wordpress.android.fluxc.utils.toWooPayload
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+class WCGoogleRestClient  @Inject constructor(private val wooNetwork: WooNetwork) {
+    companion object {
+        const val GOOGLE_ADS_CONNECTED_STATUS = "connected"
+    }
+
+    suspend fun fetchGoogleAdsConnectionStatus(
+        site: SiteModel
+    ): WooPayload<Boolean> {
+        val url = WOOCOMMERCE.gla.ads.connection.pathNoVersion
+        val result = wooNetwork.executeGetGsonRequest(
+            site = site,
+            path = url,
+            clazz = GoogleAdsConnectionStatusResponse::class.java
+        ).toWooPayload()
+
+        return when {
+            result.isError -> WooPayload(result.error)
+            result.result != null -> WooPayload(result.result.status == GOOGLE_ADS_CONNECTED_STATUS)
+            else -> WooPayload(false)
+        }
+    }
+}
+
+/**
+ * Response model for the Google Ads connection status.
+ * The full response has more fields, but for now we only care about the status.
+ */
+data class GoogleAdsConnectionStatusResponse(
+    @SerializedName("status")
+    val status: String
+)
+

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

@@ -0,0 +1,35 @@
+package org.wordpress.android.fluxc.store
+
+import org.wordpress.android.fluxc.model.SiteModel
+import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooResult
+import org.wordpress.android.fluxc.network.rest.wpcom.wc.google.WCGoogleRestClient
+import org.wordpress.android.fluxc.tools.CoroutineEngine
+import org.wordpress.android.util.AppLog.T.API
+import javax.inject.Inject
+import javax.inject.Singleton
+
+/**
+ * This store is intended to be used to support the Google Listings and Ads plugin.
+ * https://wordpress.org/plugins/google-listings-and-ads/
+ */
+@Singleton
+class WCGoogleStore @Inject constructor(
+    private val restClient: WCGoogleRestClient,
+    private val coroutineEngine: CoroutineEngine
+) {
+    /**
+     * Checks the connection status of the Google Ads account used in the plugin.
+     *
+     * @return WooResult<Boolean> true if the account is connected, false otherwise. Optionally,
+     * passes error, too.
+     */
+    suspend fun isGoogleAdsAccountConnected(site: SiteModel): WooResult<Boolean> =
+        coroutineEngine.withDefaultContext(API, this, "fetchGoogleAdsConnectionStatus") {
+            val response = restClient.fetchGoogleAdsConnectionStatus(site)
+            when {
+                response.isError -> WooResult(response.error)
+                response.result != null -> response.asWooResult()
+                else -> WooResult(false)
+            }
+    }
+}