add docs for subscription deserialization

Author: jenschude

commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Subscriptions.java

@@ -0,0 +1,33 @@
+
+package com.commercetools.docs.meta;
+
+/**
+ * {@include.toc}
+ <h2 id="subscriptions">Subscriptions</h2>
+
+ <h3 id="delivery-payloads">Delivery Payloads</h3>
+ <p>The SDK provides the JsonUtils class which can be used to deserialize the delivery payload sent
+ by a subscription. Using the {@link com.commercetools.api.models.subscription.DeliveryPayload} class
+ it will deserialize it correctly to a {@link com.commercetools.api.models.subscription.MessageDeliveryPayload},
+ {@link com.commercetools.api.models.subscription.ResourceCreatedDeliveryPayload},
+ {@link com.commercetools.api.models.subscription.ResourceUpdatedDeliveryPayload}, or
+ {@link com.commercetools.api.models.subscription.ResourceDeletedDeliveryPayload}</p>
+
+ {@include.example example.SerializationTest#deliveryPayloads()}
+
+ <h4 id="message-payloads">Message Payloads</h4>
+ <p>The {@link com.commercetools.api.models.subscription.MessageDeliveryPayload} include a helper method to
+ cast to the inner message delivery and return the wrapped message.</p>
+
+ {@include.example example.SerializationTest#messageDeliveryPayloads()}
+
+ <h4 id="change-payloads">Change Payloads</h4>
+ <p></p>
+
+ {@include.example example.SerializationTest#changeDeliveryPayloads()}
+
+ */
+public final class Subscriptions {
+    private Subscriptions() {
+    }
+}

commercetools/internal-docs/src/test/java/example/SerializationTest.java

@@ -3,6 +3,7 @@
 
 import static com.commercetools.TestUtils.*;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import java.time.LocalDate;
 import java.time.LocalTime;
@@ -13,9 +14,14 @@
 import com.commercetools.api.defaultconfig.ApiRootBuilder;
 import com.commercetools.api.defaultconfig.ServiceRegion;
 import com.commercetools.api.json.ApiModuleOptions;
+import com.commercetools.api.models.message.CustomerFirstNameSetMessagePayload;
+import com.commercetools.api.models.message.CustomerLastNameSetMessagePayload;
 import com.commercetools.api.models.product.Attribute;
 import com.commercetools.api.models.product.AttributeAccessor;
 import com.commercetools.api.models.product.ProductVariant;
+import com.commercetools.api.models.subscription.DeliveryPayload;
+import com.commercetools.api.models.subscription.MessageDeliveryPayload;
+import com.commercetools.api.models.subscription.ResourceCreatedDeliveryPayload;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
@@ -91,4 +97,38 @@ public void attributesNumberAsDouble() throws JsonProcessingException {
         assertThat(variant.getAttribute("integer").getValue()).isEqualTo(10.0);
     }
 
+    @Test
+    public void deliveryPayloads() {
+        DeliveryPayload delivery = JsonUtils.fromJsonString(stringFromResource("messagedeliverypayload.json"),
+            DeliveryPayload.class);
+        assertThat(delivery).isInstanceOf(DeliveryPayload.class);
+        assertThat(delivery).isInstanceOf(MessageDeliveryPayload.class);
+    }
+
+    @Test
+    public void messageDeliveryPayloads() {
+        DeliveryPayload delivery = JsonUtils.fromJsonString(stringFromResource("messagedeliverypayload.json"),
+            DeliveryPayload.class);
+
+        assertThat(delivery).isInstanceOf(MessageDeliveryPayload.class);
+        MessageDeliveryPayload messageDelivery = (MessageDeliveryPayload) delivery;
+
+        assertThat(messageDelivery.getMessagePayload()).isInstanceOf(CustomerLastNameSetMessagePayload.class);
+
+        assertThat(messageDelivery.getMessagePayload().as(CustomerLastNameSetMessagePayload.class))
+                .isInstanceOf(CustomerLastNameSetMessagePayload.class);
+
+        assertThat(messageDelivery.hasCompleteMessage()).isTrue();
+
+        assertThatThrownBy(() -> messageDelivery.getMessagePayload().as(CustomerFirstNameSetMessagePayload.class))
+                .isInstanceOf(IllegalArgumentException.class);
+    }
+
+    @Test
+    public void changeDeliveryPayloads() {
+        DeliveryPayload delivery = JsonUtils.fromJsonString(stringFromResource("changedeliverypayload.json"),
+            DeliveryPayload.class);
+
+        assertThat(delivery).isInstanceOf(ResourceCreatedDeliveryPayload.class);
+    }
 }

commercetools/internal-docs/src/test/resources/changedeliverypayload.json

@@ -0,0 +1,16 @@
+{
+    "notificationType": "ResourceCreated",
+    "projectKey": "<project_key>",
+    "resource": {
+        "typeId": "product",
+        "id": "<product_id>"
+    },
+    "resourceUserProvidedIdentifiers": {
+        "key": "example-product-key",
+        "slug": {
+            "en": "example-slug"
+        }
+    },
+    "version": 1,
+    "modifiedAt": "2022-10-25T13:23:05.384Z"
+}

commercetools/internal-docs/src/test/resources/messagedeliverypayload.json

@@ -0,0 +1,17 @@
+{
+    "notificationType": "Message",
+    "projectKey": "<project_key>",
+    "id": "<message_id>",
+    "version": 1,
+    "sequenceNumber": 2,
+    "resource": {
+        "typeId": "customer",
+        "id": "<customer_id>"
+    },
+    "resourceVersion": 2,
+    "resourceUserProvidedIdentifiers": {},
+    "type": "CustomerLastNameSet",
+    "lastName": "Doe",
+    "createdAt": "2022-10-25T13:30:09.760Z",
+    "lastModifiedAt": "2022-10-25T13:30:09.760Z"
+}

src/main/javadoc/overview.html

@@ -49,6 +49,13 @@ <h2>Products and ProductTypes</h2>
                 {@include.toc com.commercetools.docs.meta.ProductAttributeDocumentation}
             </li>
         </ol>
+        <h2>Subscriptions</h2>
+        <ol>
+            <li>
+                {@link com.commercetools.docs.meta.Subscriptions Subscriptions}
+                {@include.toc com.commercetools.docs.meta.Subscriptions}
+            </li>
+        </ol>
         <h2>Preparing for the worst</h2>
         <ol>
             <li>