Repository: relayrides/pushy (java)

Issue:
Add support for "thread-id" in SimpleApnsPushNotification class
The SimpleApnsPushNotification class is missing the `thread-id` attribute, see:

https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW1

> Provide this key with a string value that represents the app-specific identifier for grouping notifications. The system groups notifications with the same thread identifier together in Notification Center and other system interfaces. For local notifications, this key corresponds to the threadIdentifier property of the UNNotificationContent object.

Pull request description:
Add `thread-id` to the payload builder (closes #382)
As requested in #382, this adds support for the `thread-id` field to the payload builder.

Patch:
diff --git a/pushy/src/main/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilder.java b/pushy/src/main/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilder.java
index 82738f23..666996e1 100644
--- a/pushy/src/main/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilder.java
+++ b/pushy/src/main/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilder.java
@@ -60,6 +60,7 @@ public class ApnsPayloadBuilder {
     private String categoryName = null;
     private boolean contentAvailable = false;
     private boolean mutableContent = false;
+    private String threadId = null;
     private String[] urlArguments = null;
 
     private boolean preferStringRepresentationForAlerts = false;
@@ -73,6 +74,7 @@ public class ApnsPayloadBuilder {
     private static final String CATEGORY_KEY = "category";
     private static final String CONTENT_AVAILABLE_KEY = "content-available";
     private static final String MUTABLE_CONTENT_KEY = "mutable-content";
+    private static final String THREAD_ID_KEY = "thread-id";
     private static final String URL_ARGS_KEY = "url-args";
 
     private static final String ALERT_TITLE_KEY = "title";
@@ -423,6 +425,26 @@ public class ApnsPayloadBuilder {
         return this;
     }
 
+    /**
+     * <p>Sets the thread ID for this notification. According to to the APNs documentation, the thread ID is:</p>
+     *
+     * <blockquote>…a string value that represents the app-specific identifier for grouping notifications. The system
+     * groups notifications with the same thread identifier together in Notification Center and other system
+     * interfaces.</blockquote>
+     *
+     * <p>By default, no thread ID is included.</p>
+     *
+     * @param threadId the thread ID for this notification
+     *
+     * @return a reference to this payload builder
+     *
+     * @since 0.8.2
+     */
+    public ApnsPayloadBuilder setThreadId(final String threadId) {
+        this.threadId = threadId;
+        return this;
+    }
+
     /**
      * <p>Sets the list of arguments to populate placeholders in the {@code urlFormatString} associated with a Safari
      * push notification. Has no effect for non-Safari notifications. According to the Notification Programming Guide
@@ -543,6 +565,14 @@ public class ApnsPayloadBuilder {
                 aps.put(MUTABLE_CONTENT_KEY, 1);
             }
 
+            if (this.threadId != null) {
+                aps.put(THREAD_ID_KEY, this.threadId);
+            }
+
+            if (this.urlArguments != null) {
+                aps.put(URL_ARGS_KEY, this.urlArguments);
+            }
+
             final Map<String, Object> alert = new HashMap<>();
             {
                 if (this.alertBody != null) {
@@ -605,10 +635,6 @@ public class ApnsPayloadBuilder {
                 aps.put(ALERT_KEY, alert);
             }
 
-            if (this.urlArguments != null) {
-                aps.put(URL_ARGS_KEY, this.urlArguments);
-            }
-
             payload.put(APS_KEY, aps);
         }
 


Test patch:
diff --git a/pushy/src/test/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilderTest.java b/pushy/src/test/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilderTest.java
index 12ed91d6..a1f5fa74 100644
--- a/pushy/src/test/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilderTest.java
+++ b/pushy/src/test/java/com/relayrides/pushy/apns/util/ApnsPayloadBuilderTest.java
@@ -402,6 +402,16 @@ public class ApnsPayloadBuilderTest {
         }
     }
 
+    @Test
+    public void testSetThreadId() {
+        final String threadId = "example.thread.identifier";
+
+        this.builder.setThreadId(threadId);
+
+        final Map<String, Object> aps = this.extractApsObjectFromPayloadString(this.builder.buildWithDefaultMaximumLength());
+        assertEquals(threadId, aps.get("thread-id"));
+    }
+
     @Test
     public void testAddCustomProperty() {
         final String customKey = "string";