feat(BeaconBuilder): Add assign/unassign methods for handling dynamic groups.

Author: amarose

README.md

@@ -155,7 +155,7 @@ dependencyResolutionManagement {
 
 // /libs.versions.toml
 [versions]
-ppgSdk = "3.0.2"
+ppgSdk = "3.1.0"
 
 [libraries]
 ppg-sdk = { module = "com.github.ppgco.android-sdk:sdk", version.ref = "ppgSdk" }
@@ -242,6 +242,20 @@ PushPushGo.getInstance().createBeacon()
 .send();
 ```
 
+- Assign subscriber to dynamic group:
+```java
+PushPushGo.getInstance().createBeacon()
+.assignToGroup("my-group-name")
+.send();
+```
+
+- Unassign subscriber from dynamic group:
+```java
+PushPushGo.getInstance().createBeacon()
+.unassignFromGroup("my-group-name")
+.send();
+```
+
 ## Publishing
 
 To maven local repository:

library/api/library.api

@@ -4,6 +4,7 @@ public final class com/pushpushgo/sdk/BeaconBuilder {
 	public final fun appendTag (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lcom/pushpushgo/sdk/BeaconBuilder;
 	public final fun appendTag (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;I)Lcom/pushpushgo/sdk/BeaconBuilder;
 	public static synthetic fun appendTag$default (Lcom/pushpushgo/sdk/BeaconBuilder;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;IILjava/lang/Object;)Lcom/pushpushgo/sdk/BeaconBuilder;
+	public final fun assignToGroup (Ljava/lang/String;)Lcom/pushpushgo/sdk/BeaconBuilder;
 	public final fun getTags ()Ljava/util/List;
 	public final fun getTagsToDelete ()Ljava/util/List;
 	public final fun removeTag ([Ljava/lang/String;)Lcom/pushpushgo/sdk/BeaconBuilder;
@@ -13,6 +14,7 @@ public final class com/pushpushgo/sdk/BeaconBuilder {
 	public final fun set (Ljava/lang/String;Ljava/lang/Object;)Lcom/pushpushgo/sdk/BeaconBuilder;
 	public final fun setCustomId (Ljava/lang/Integer;)Lcom/pushpushgo/sdk/BeaconBuilder;
 	public final fun setCustomId (Ljava/lang/String;)Lcom/pushpushgo/sdk/BeaconBuilder;
+	public final fun unassignFromGroup (Ljava/lang/String;)Lcom/pushpushgo/sdk/BeaconBuilder;
 }
 
 public final class com/pushpushgo/sdk/BuildConfig {

library/src/main/java/com/pushpushgo/sdk/BeaconBuilder.kt

@@ -17,6 +17,10 @@ class BeaconBuilder internal constructor(
 
   private var customId = ""
 
+  private var assignToGroup: String? = null
+
+  private var unassignFromGroup: String? = null
+
   /**
    * Add beacon selector
    *
@@ -112,6 +116,32 @@ class BeaconBuilder internal constructor(
     return this
   }
 
+  /**
+   * Assign subscriber to a dynamic group
+   *
+   * @param groupId ID of the dynamic group to assign to
+   *
+   * @return instance of builder
+   */
+  fun assignToGroup(groupId: String): BeaconBuilder {
+    assignToGroup = groupId
+
+    return this
+  }
+
+  /**
+   * Unassign subscriber from a dynamic group
+   *
+   * @param groupId ID of the dynamic group to unassign from
+   *
+   * @return instance of builder
+   */
+  fun unassignFromGroup(groupId: String): BeaconBuilder {
+    unassignFromGroup = groupId
+
+    return this
+  }
+
   /**
    * @throws PushPushException on unsupported selector value type
    */
@@ -122,6 +152,8 @@ class BeaconBuilder internal constructor(
         addTags()
         addTagsToDelete()
         if (customId.isNotEmpty()) put("customId", customId)
+        assignToGroup?.let { put("assignToGroup", it) }
+        unassignFromGroup?.let { put("unassignFromGroup", it) }
       },
     )
   }

library/src/main/java/com/pushpushgo/sdk/PushPushGo.kt

@@ -41,7 +41,7 @@ class PushPushGo private constructor(
   private val customBaseUrl: String?,
 ) {
   companion object {
-    const val VERSION = "3.0.3"
+    const val VERSION = "3.1.0"
 
     internal const val TAG = "PPGo"
 

library/src/test/java/com/pushpushgo/sdk/BeaconBuilderTest.kt

@@ -274,4 +274,88 @@ internal class BeaconBuilderTest {
       )
     }
   }
+
+  @Test
+  fun `assign to group`() {
+    every { uploadDelegate.sendBeacon(any()) } just Runs
+
+    beaconBuilder = BeaconBuilder(uploadDelegate)
+
+    beaconBuilder.assignToGroup("my-segment-123")
+
+    beaconBuilder.send()
+
+    verify {
+      uploadDelegate.sendBeacon(
+        match {
+          it["assignToGroup"] == "my-segment-123"
+        },
+      )
+    }
+  }
+
+  @Test
+  fun `unassign from group`() {
+    every { uploadDelegate.sendBeacon(any()) } just Runs
+
+    beaconBuilder = BeaconBuilder(uploadDelegate)
+
+    beaconBuilder.unassignFromGroup("my-segment-333")
+
+    beaconBuilder.send()
+
+    verify {
+      uploadDelegate.sendBeacon(
+        match {
+          it["unassignFromGroup"] == "my-segment-333"
+        },
+      )
+    }
+  }
+
+  @Test
+  fun `assign and unassign from groups simultaneously`() {
+    every { uploadDelegate.sendBeacon(any()) } just Runs
+
+    beaconBuilder = BeaconBuilder(uploadDelegate)
+
+    beaconBuilder
+      .assignToGroup("my-segment-123")
+      .unassignFromGroup("my-segment-333")
+
+    beaconBuilder.send()
+
+    verify {
+      uploadDelegate.sendBeacon(
+        match {
+          it["assignToGroup"] == "my-segment-123" &&
+            it["unassignFromGroup"] == "my-segment-333"
+        },
+      )
+    }
+  }
+
+  @Test
+  fun `assign to group with other beacon data`() {
+    every { uploadDelegate.sendBeacon(any()) } just Runs
+
+    beaconBuilder = BeaconBuilder(uploadDelegate)
+
+    beaconBuilder
+      .setCustomId("xxsampleId")
+      .assignToGroup("my-segment-123")
+      .appendTag("tag1", "label1")
+
+    beaconBuilder.send()
+
+    verify {
+      uploadDelegate.sendBeacon(
+        match {
+          it["customId"] == "xxsampleId" &&
+            it["assignToGroup"] == "my-segment-123" &&
+            it.has("tags")
+        },
+      )
+    }
+  }
 }

sample/src/main/java/com/pushpushgo/sample/activity/BeaconActivity.kt

@@ -71,5 +71,25 @@ class BeaconActivity : AppCompatActivity(R.layout.activity_beacon) {
                 .setCustomId("TEST1")
                 .send()
         }
+
+        findViewById<Button>(R.id.beacon7).setOnClickListener {
+            ppg.createBeacon()
+                .assignToGroup("test-group-123")
+                .send()
+        }
+
+        findViewById<Button>(R.id.beacon8).setOnClickListener {
+            ppg.createBeacon()
+                .unassignFromGroup("test-group-123")
+                .send()
+        }
+
+        findViewById<Button>(R.id.beacon9).setOnClickListener {
+            ppg.createBeacon()
+                .assignToGroup("group-to-join")
+                .unassignFromGroup("group-to-leave")
+                .setCustomId("GROUPS_TEST")
+                .send()
+        }
     }
 }

sample/src/main/res/layout/activity_beacon.xml

@@ -50,6 +50,24 @@
                 android:layout_height="wrap_content"
                 android:text="custom_id=TEST1" />
 
+            <Button
+                android:id="@+id/beacon7"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:text="assignToGroup(test-group-123)" />
+
+            <Button
+                android:id="@+id/beacon8"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:text="unassignFromGroup(test-group-123)" />
+
+            <Button
+                android:id="@+id/beacon9"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:text="assign + unassign (different groups)" />
+
         </LinearLayout>
 
     </ScrollView>

settings.gradle

@@ -11,7 +11,7 @@ if (!System.env.JITPACK) include ':sample', ':samplehms', ':samplejava', ':sampl
 dependencyResolutionManagement {
     versionCatalogs {
         libs {
-            version('sdk', '3.0.3')
+            version('sdk', '3.1.0')
             version('kotlin', '2.2.0')
             version('ksp', '2.2.0-2.0.2')
             version('coroutines', '1.10.1')

settings.gradle.kts

@@ -0,0 +1,9 @@
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+        google()
+        mavenCentral()
+    }
+}
+include ':library', ":library-no-op", ":library-inappmessages"
+if (!System.env.JITPACK) include ':sample', ':samplehms', ':samplejava', ':sample-inapp'