Add in-app review for Play Store variants (#236)

* Initial plan

* Add in-app review functionality for Play Store variants

Co-authored-by: yogeshpaliyal <[email protected]>

* Refactor review manager classes and streamline creation methods

* Add Play Store review manager to handle in-app review requests

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: yogeshpaliyal <[email protected]>
Co-authored-by: Yogesh Choudhary Paliyal <[email protected]>

Author: Copilot

app/build.gradle.kts

@@ -156,10 +156,12 @@ dependencies {
     "proImplementation"(platform(libs.firebase.bom))
     "proImplementation"(libs.firebase.analytics)
     "proImplementation"(libs.firebase.crashlytics.ndk)
+    "proImplementation"(libs.play.core)
 
     "freePlaystoreImplementation"(platform(libs.firebase.bom))
     "freePlaystoreImplementation"(libs.firebase.analytics)
     "freePlaystoreImplementation"(libs.firebase.crashlytics.ndk)
+    "freePlaystoreImplementation"(libs.play.core)
 }
 
 kotlinter {

app/src/free/java/com/yogeshpaliyal/deepr/review/PlayStoreReviewManager.kt

@@ -0,0 +1,23 @@
+package com.yogeshpaliyal.deepr.review
+
+import android.app.Activity
+import android.content.ActivityNotFoundException
+import android.content.Intent
+import androidx.core.net.toUri
+import com.yogeshpaliyal.deepr.BuildConfig
+
+class PlayStoreReviewManager : ReviewManager {
+    override fun requestReview(activity: Activity) {
+        val appPackageName = BuildConfig.APPLICATION_ID
+        try {
+            activity.startActivity(
+                Intent(
+                    Intent.ACTION_VIEW,
+                    "https://play.google.com/store/apps/details?id=$appPackageName".toUri(),
+                ),
+            )
+        } catch (e: ActivityNotFoundException) {
+            // Handle case where Play Store is not available
+        }
+    }
+}

app/src/free/java/com/yogeshpaliyal/deepr/review/ReviewManagerFactory.kt

@@ -0,0 +1,5 @@
+package com.yogeshpaliyal.deepr.review
+
+object ReviewManagerFactory {
+    fun create(): ReviewManager = PlayStoreReviewManager()
+}

app/src/main/java/com/yogeshpaliyal/deepr/DeeprApplication.kt

@@ -13,6 +13,8 @@ import com.yogeshpaliyal.deepr.backup.ImportRepositoryImpl
 import com.yogeshpaliyal.deepr.data.HtmlParser
 import com.yogeshpaliyal.deepr.data.NetworkRepository
 import com.yogeshpaliyal.deepr.preference.AppPreferenceDataStore
+import com.yogeshpaliyal.deepr.review.ReviewManager
+import com.yogeshpaliyal.deepr.review.ReviewManagerFactory
 import com.yogeshpaliyal.deepr.server.LocalServerRepository
 import com.yogeshpaliyal.deepr.server.LocalServerRepositoryImpl
 import com.yogeshpaliyal.deepr.sync.SyncRepository
@@ -88,6 +90,10 @@ class DeeprApplication : Application() {
                 viewModel {
                     LocalServerViewModel(get())
                 }
+
+                single<ReviewManager> {
+                    ReviewManagerFactory.create()
+                }
             }
 
         startKoin {

app/src/main/java/com/yogeshpaliyal/deepr/review/ReviewManager.kt

@@ -0,0 +1,7 @@
+package com.yogeshpaliyal.deepr.review
+
+import android.app.Activity
+
+interface ReviewManager {
+    fun requestReview(activity: Activity)
+}

app/src/main/java/com/yogeshpaliyal/deepr/ui/screens/Settings.kt

@@ -1,6 +1,5 @@
 package com.yogeshpaliyal.deepr.ui.screens
 
-import android.content.ActivityNotFoundException
 import android.content.Intent
 import android.widget.Toast
 import androidx.activity.compose.rememberLauncherForActivityResult
@@ -510,16 +509,7 @@ fun SettingsScreen(
                     description = "Rate us on the Play Store",
                     shouldShowLoading = false,
                     onClick = {
-                        val appPackageName = BuildConfig.APPLICATION_ID
-                        try {
-                            context.startActivity(
-                                Intent(
-                                    Intent.ACTION_VIEW,
-                                    "https://play.google.com/store/apps/details?id=$appPackageName".toUri(),
-                                ),
-                            )
-                        } catch (e: ActivityNotFoundException) {
-                        }
+                        viewModel.requestReview(context as MainActivity)
                     },
                 )
 

app/src/main/java/com/yogeshpaliyal/deepr/viewmodel/AccountViewModel.kt

@@ -76,6 +76,7 @@ class AccountViewModel(
 ) : ViewModel(),
     KoinComponent {
     private val preferenceDataStore: AppPreferenceDataStore = get()
+    private val reviewManager: com.yogeshpaliyal.deepr.review.ReviewManager = get()
     private val searchQuery = MutableStateFlow("")
 
     // State for tags
@@ -555,4 +556,8 @@ class AccountViewModel(
             }
         }
     }
+
+    fun requestReview(activity: android.app.Activity) {
+        reviewManager.requestReview(activity)
+    }
 }

app/src/proFreePlaystore/java/com/yogeshpaliyal/deepr/review/InAppReviewManager.kt

@@ -0,0 +1,23 @@
+package com.yogeshpaliyal.deepr.review
+
+import android.app.Activity
+import com.google.android.play.core.review.ReviewManagerFactory
+
+class InAppReviewManager : ReviewManager {
+    override fun requestReview(activity: Activity) {
+        val reviewManager = ReviewManagerFactory.create(activity)
+        val request = reviewManager.requestReviewFlow()
+
+        request.addOnCompleteListener { task ->
+            if (task.isSuccessful) {
+                // We got the ReviewInfo object
+                val reviewInfo = task.result
+                val flow = reviewManager.launchReviewFlow(activity, reviewInfo)
+                flow.addOnCompleteListener {
+                    // The flow has finished. The API does not indicate whether the user
+                    // reviewed or not, or even whether the review dialog was shown.
+                }
+            }
+        }
+    }
+}

app/src/proFreePlaystore/java/com/yogeshpaliyal/deepr/review/ReviewManagerFactory.kt

@@ -0,0 +1,5 @@
+package com.yogeshpaliyal.deepr.review
+
+object ReviewManagerFactory {
+    fun create(): ReviewManager = InAppReviewManager()
+}

gradle/libs.versions.toml

@@ -31,6 +31,7 @@ haze = "1.6.10"
 kotlinter = "5.2.0"
 googleServices = "4.4.3"
 firebaseCrashlytics = "3.0.6"
+playCore = "1.10.3"
 
 [libraries]
 android-driver = { module = "app.cash.sqldelight:android-driver", version.ref = "androidDriver" }
@@ -82,6 +83,7 @@ ktor-serialization-kotlinx-json = { module = "io.ktor:ktor-serialization-kotlinx
 coil-compose = { module = "io.coil-kt.coil3:coil-compose", version.ref = "coilCompose" }
 coil-network-ktor3 = { module = "io.coil-kt.coil3:coil-network-ktor3", version.ref = "coilCompose" }
 firebase-crashlytics-ndk = { module = "com.google.firebase:firebase-crashlytics-ndk" }
+play-core = { module = "com.google.android.play:core", version.ref = "playCore" }
 androidx-work-runtime-ktx = { module = "androidx.work:work-runtime-ktx", version.ref = "workManager" }
 haze = { module = "dev.chrisbanes.haze:haze", version.ref = "haze" }
 haze-materials = { module = "dev.chrisbanes.haze:haze-materials", version.ref = "haze" }