Update to latest analytics-kotlin 1.16.1 and make the testapp more useful by adding the consent plugin to the timeline. (#10)

Author: didiergarcia

lib/build.gradle.kts

@@ -42,7 +42,7 @@ android {
 
 dependencies {
     implementation("com.segment:sovran-kotlin:1.3.1")
-    implementation("com.segment.analytics.kotlin:android:1.14.0")
+    implementation("com.segment.analytics.kotlin:android:1.16.1")
     implementation("androidx.multidex:multidex:2.0.1")
     implementation("androidx.core:core-ktx:1.10.1")
 

testapp/build.gradle.kts

@@ -38,7 +38,8 @@ android {
 
 dependencies {
     implementation(project(mapOf("path" to ":lib")))
-
+    implementation("com.segment:sovran-kotlin:1.3.1")
+    implementation("com.segment.analytics.kotlin:android:1.16.1")
     implementation("androidx.core:core-ktx:1.7.0")
     implementation("androidx.appcompat:appcompat:1.4.1")
     implementation("com.google.android.material:material:1.6.0")

testapp/src/main/AndroidManifest.xml

@@ -1,7 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.INTERNET" />
+
     <application
+        android:name=".MainApplication"
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"

testapp/src/main/java/com/segment/analytics/destinations/mydestination/testapp/CustomConsentCategoryProvider.kt

@@ -0,0 +1,24 @@
+package com.segment.analytics.destinations.mydestination.testapp
+
+import com.segment.analytics.kotlin.destinations.consent.ConsentCategoryProvider
+
+/**
+ * A toy implementation of a ConsentCategoryProvider. Normally, an implementation would
+ * be tied to a CMP tool like OneTrust and get information regarding consent from it, but
+ * this will work for our simple use-case.
+ */
+class CustomConsentCategoryProvider: ConsentCategoryProvider {
+    var categories: List<String>? = null
+    override fun setCategoryList(categories: List<String>) {
+        this.categories = categories
+    }
+
+    override fun getCategories(): Map<String, Boolean> {
+        val result = mutableMapOf<String,Boolean>()
+
+        // Allow all categories
+        categories?.forEach { cat -> result.put(cat, true) }
+
+        return result
+    }
+}

testapp/src/main/java/com/segment/analytics/destinations/mydestination/testapp/MainActivity.kt

@@ -2,10 +2,29 @@ package com.segment.analytics.destinations.mydestination.testapp
 
 import androidx.appcompat.app.AppCompatActivity
 import android.os.Bundle
+import android.widget.Button
+import com.google.android.material.snackbar.Snackbar
+import java.text.SimpleDateFormat
+import java.util.Date
 
 class MainActivity : AppCompatActivity() {
+
+    companion object {
+        val TAG = "main-activity"
+    }
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
+
+        val button = findViewById<Button>(R.id.sendTrackEventButton)
+        button.setOnClickListener {v ->
+            val sdf = SimpleDateFormat("M/dd/yyyy hh:mm:ss.SSS")
+            val currentDate = sdf.format(Date())
+            MainApplication.analytics.track("Test Event ${currentDate}")
+
+            if (v != null) {
+                Snackbar.make(v, "Track Event created.", Snackbar.LENGTH_LONG).show()
+            }
+        }
     }
 }

testapp/src/main/java/com/segment/analytics/destinations/mydestination/testapp/MainApplication.kt

@@ -0,0 +1,60 @@
+package com.segment.analytics.destinations.mydestination.testapp
+
+import android.app.Application
+import com.segment.analytics.kotlin.core.Analytics
+import com.segment.analytics.kotlin.android.Analytics
+import com.segment.analytics.kotlin.core.platform.policies.CountBasedFlushPolicy
+import com.segment.analytics.kotlin.core.platform.policies.FrequencyFlushPolicy
+import com.segment.analytics.kotlin.destinations.consent.ConsentManager
+import org.json.JSONException
+import org.json.JSONObject
+import sovran.kotlin.SynchronousStore
+
+
+class MainApplication: Application() {
+
+    val SEGMENT_WRITE_KEY = "<writekey>"
+    companion object {
+        lateinit var analytics: Analytics
+        const val TAG = "application"
+    }
+
+    private fun getGroupIds(domainGroupData: JSONObject): List<String> {
+        val result: MutableList<String> = ArrayList()
+        try {
+            val groups = domainGroupData.getJSONArray("Groups")
+            for (i in 0 until groups.length()) {
+                val group = groups.getJSONObject(i)
+                val groupId = group.getString("OptanonGroupId")
+                result.add(groupId)
+            }
+        } catch (ex: JSONException) {
+            ex.printStackTrace()
+        }
+        return result
+    }
+
+    override fun onCreate() {
+        super.onCreate()
+
+        Analytics.debugLogsEnabled = true
+        analytics = Analytics(SEGMENT_WRITE_KEY, applicationContext) {
+            this.collectDeviceId = true
+            this.trackApplicationLifecycleEvents = true
+            this.trackDeepLinks = true
+            this.flushPolicies = mutableListOf(
+                CountBasedFlushPolicy(1), // Flush after each event
+                FrequencyFlushPolicy(5000) // Flush after 5 Seconds
+            )
+        }
+
+        val consentCategoryProvider = CustomConsentCategoryProvider()
+        val store = SynchronousStore()
+
+        val consentPlugin = ConsentManager(store, consentCategoryProvider)
+
+        analytics.add(consentPlugin)
+    }
+
+
+}

testapp/src/main/res/layout/activity_main.xml

@@ -6,10 +6,11 @@
     android:layout_height="match_parent"
     tools:context=".MainActivity">
 
-    <TextView
+    <Button
+        android:id="@+id/sendTrackEventButton"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:text="Hello World!"
+        android:text="@string/send_track_event"
         app:layout_constraintBottom_toBottomOf="parent"
         app:layout_constraintLeft_toLeftOf="parent"
         app:layout_constraintRight_toRightOf="parent"

testapp/src/main/res/values/strings.xml

@@ -1,3 +1,4 @@
 <resources>
     <string name="app_name">testApp</string>
+    <string name="send_track_event">Send Track Event</string>
 </resources>