Skip to content

Commit

Permalink
Issue #1217: whatsapp business platform incoming video message
Browse files Browse the repository at this point in the history
  • Loading branch information
nbartels committed Jul 3, 2022
1 parent 3e4aea7 commit e878afb
Show file tree
Hide file tree
Showing 5 changed files with 265 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import com.restfb.types.whatsapp.platform.message.Image;
import com.restfb.types.whatsapp.platform.message.MessageType;
import com.restfb.types.whatsapp.platform.message.Text;
import com.restfb.types.whatsapp.platform.message.Video;

import lombok.Getter;
import lombok.Setter;
Expand Down Expand Up @@ -88,11 +89,16 @@ public class Message extends AbstractFacebookType {
@Facebook
private MessageType type;

private JsonObject video;
@Getter
@Setter
@Facebook
private Video video;

public boolean isText() {
return text != null;
}

public boolean isImage() { return image != null; }

public boolean isVideo() { return video != null; }
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* Copyright (c) 2010-2022 Mark Allen, Norbert Bartels.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.restfb.types.whatsapp.platform.message;

import com.restfb.Facebook;
import com.restfb.types.AbstractFacebookType;

import lombok.Getter;
import lombok.Setter;

public class Video extends AbstractFacebookType {

/**
* The ID for the video
*/
@Getter
@Setter
@Facebook
private String id;

/**
* The mime type for the video file
*/
@Getter
@Setter
@Facebook("mime_type")
private String mimeType;

/**
* Image hash
*/
@Getter
@Setter
@Facebook
private String sha256;

/**
* The caption for the video, if provided
*/
@Getter
@Setter
@Facebook
private String caption;

/**
* The name for the file on the sender's device
*/
@Getter
@Setter
@Facebook
private String filename;
}
145 changes: 145 additions & 0 deletions src/test/java/com/restfb/types/WABPwebhookTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/*
* Copyright (c) 2010-2022 Mark Allen, Norbert Bartels.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.restfb.types;

import com.restfb.AbstractJsonMapperTests;
import com.restfb.types.webhook.ChangeValue;
import com.restfb.types.webhook.WebhookEntry;
import com.restfb.types.webhook.WebhookObject;
import com.restfb.types.webhook.whatsapp.WhatsappMessagesValue;
import com.restfb.types.whatsapp.platform.Contact;
import com.restfb.types.whatsapp.platform.Message;
import com.restfb.types.whatsapp.platform.message.Image;
import com.restfb.types.whatsapp.platform.message.Video;
import com.restfb.types.whatsapp.platform.message.MessageType;
import org.junit.jupiter.api.Test;

import java.util.Date;

import static org.assertj.core.api.Assertions.assertThat;

class WABPwebhookTest extends AbstractJsonMapperTests {

@Test
void incomingMessageText() {
WhatsappMessagesValue change = getWHObjectFromJson("webhook-incoming-message-text", WhatsappMessagesValue.class);
assertThat(change).isInstanceOf(WhatsappMessagesValue.class);

// check contact
checkContact(change);

// check Metadata
checkMetaData(change);

// check Message
assertThat(change.getMessages()).hasSize(1);
com.restfb.types.whatsapp.platform.Message message = change.getMessages().get(0);
assertThat(message.getText()).isNotNull();
assertThat(message.getText().getBody()).isEqualTo("Test");
assertThat(message.getTimestamp()).isEqualTo(new Date(1653253313000L));
assertThat(message.getType()).isEqualTo(MessageType.text);
assertThat(message.getFrom()).isEqualTo("491234567890");
assertThat(message.isText()).isTrue();
}

@Test
void incomingMessageImage() {
WhatsappMessagesValue change = getWHObjectFromJson("webhook-incoming-message-image", WhatsappMessagesValue.class);
assertThat(change).isInstanceOf(WhatsappMessagesValue.class);

// check contact
checkContact(change);

// check Metadata
checkMetaData(change);

// check Message
assertThat(change.getMessages()).hasSize(1);
Message message = change.getMessages().get(0);
assertThat(message.getImage()).isNotNull();
assertThat(message.isImage()).isTrue();
assertThat(message.isText()).isFalse();

Image image = message.getImage();
assertThat(image.getCaption()).isEqualTo("Some awesome image");
assertThat(image.getId()).isEqualTo("400962571939895");
assertThat(image.getMimeType()).isEqualTo("image\\/jpeg");
assertThat(image.getSha256()).isEqualTo("law0CgE277wMMnIJU0XIxhDne6Ptmwaek\\/thVM7mVtg=");

assertThat(message.getTimestamp()).isEqualTo(new Date(1653253313000L));
assertThat(message.getType()).isEqualTo(MessageType.image);
assertThat(message.getFrom()).isEqualTo("491234567890");
}

@Test
void incomingMessageVideo() {
WhatsappMessagesValue change = getWHObjectFromJson("webhook-incoming-message-video", WhatsappMessagesValue.class);
assertThat(change).isInstanceOf(WhatsappMessagesValue.class);

checkContact(change);

checkMetaData(change);

// check Message
assertThat(change.getMessages()).hasSize(1);
Message message = change.getMessages().get(0);
assertThat(message.getVideo()).isNotNull();
assertThat(message.isImage()).isFalse();
assertThat(message.isText()).isFalse();
assertThat(message.isVideo()).isTrue();

Video image = message.getVideo();
assertThat(image.getCaption()).isEqualTo("Video");
assertThat(image.getId()).isEqualTo("378911494190301");
assertThat(image.getMimeType()).isEqualTo("video\\/mp4");
assertThat(image.getSha256()).isEqualTo("r9TvFx8eGPq\\/nn7l\\/yVMfSmQjBPWlEGOpkBKMVNqDGk=");

assertThat(message.getTimestamp()).isEqualTo(new Date(1653253313000L));
assertThat(message.getType()).isEqualTo(MessageType.video);
assertThat(message.getFrom()).isEqualTo("491234567890");
}

private void checkMetaData(WhatsappMessagesValue change) {
// check Metadata
assertThat(change.getMetadata()).isNotNull();
assertThat(change.getMetadata().getDisplayPhoneNumber()).isEqualTo("1234567891");
assertThat(change.getMetadata().getPhoneNumberId()).isEqualTo("10634295353625");
}

private void checkContact(WhatsappMessagesValue change) {
// check contact
assertThat(change.getContacts()).hasSize(1);
Contact contact = change.getContacts().get(0);
assertThat(contact.getWaId()).isEqualTo("491234567890");
assertThat(contact.getProfile()).isNotNull();
assertThat(contact.getProfile().getName()).isEqualTo("TestUser");
}

private <T extends ChangeValue> T getWHObjectFromJson(String jsonName, Class<T> clazz) {
WebhookObject webhookObject =
createJsonMapper().toJavaObject(jsonFromClasspath("whatsapp/" + jsonName), WebhookObject.class);
assertThat(webhookObject.isWhatsAppBusinessAccount()).isTrue();
assertThat(webhookObject.getEntryList()).hasSize(1);
WebhookEntry entry = webhookObject.getEntryList().get(0);
return entry.getChanges().get(0).getValue().convertChangeValue(clazz);
}
}
69 changes: 0 additions & 69 deletions src/test/java/com/restfb/types/WebhookWhatsappTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,13 @@

import static com.restfb.testutils.RestfbAssertions.assertThat;

import java.util.Date;

import org.junit.jupiter.api.Test;

import com.restfb.AbstractJsonMapperTests;
import com.restfb.types.webhook.ChangeValue;
import com.restfb.types.webhook.WebhookEntry;
import com.restfb.types.webhook.WebhookObject;
import com.restfb.types.webhook.whatsapp.*;
import com.restfb.types.whatsapp.platform.Contact;
import com.restfb.types.whatsapp.platform.Message;
import com.restfb.types.whatsapp.platform.message.Image;
import com.restfb.types.whatsapp.platform.message.MessageType;

class WebhookWhatsappTest extends AbstractJsonMapperTests {

Expand Down Expand Up @@ -102,69 +96,6 @@ void accountReviewUpdate() {
assertThat(change.getDecision()).isEqualTo("APPROVED");
}

@Test
void incomingMessageText() {
WhatsappMessagesValue change = getWHObjectFromJson("webhook-incoming-message-text", WhatsappMessagesValue.class);
assertThat(change).isInstanceOf(WhatsappMessagesValue.class);

// check contact
assertThat(change.getContacts()).hasSize(1);
Contact contact = change.getContacts().get(0);
assertThat(contact.getWaId()).isEqualTo("491234567890");
assertThat(contact.getProfile()).isNotNull();
assertThat(contact.getProfile().getName()).isEqualTo("TestUser");

// check Metadata
assertThat(change.getMetadata()).isNotNull();
assertThat(change.getMetadata().getDisplayPhoneNumber()).isEqualTo("1234567891");
assertThat(change.getMetadata().getPhoneNumberId()).isEqualTo("10634295353625");

// check Message
assertThat(change.getMessages()).hasSize(1);
Message message = change.getMessages().get(0);
assertThat(message.getText()).isNotNull();
assertThat(message.getText().getBody()).isEqualTo("Test");
assertThat(message.getTimestamp()).isEqualTo(new Date(1653253313000L));
assertThat(message.getType()).isEqualTo(MessageType.text);
assertThat(message.getFrom()).isEqualTo("491234567890");
assertThat(message.isText()).isTrue();
}

@Test
void incomingMessageImage() {
WhatsappMessagesValue change = getWHObjectFromJson("webhook-incoming-message-image", WhatsappMessagesValue.class);
assertThat(change).isInstanceOf(WhatsappMessagesValue.class);

// check contact
assertThat(change.getContacts()).hasSize(1);
Contact contact = change.getContacts().get(0);
assertThat(contact.getWaId()).isEqualTo("491234567890");
assertThat(contact.getProfile()).isNotNull();
assertThat(contact.getProfile().getName()).isEqualTo("TestUser");

// check Metadata
assertThat(change.getMetadata()).isNotNull();
assertThat(change.getMetadata().getDisplayPhoneNumber()).isEqualTo("1234567891");
assertThat(change.getMetadata().getPhoneNumberId()).isEqualTo("10634295353625");

// check Message
assertThat(change.getMessages()).hasSize(1);
Message message = change.getMessages().get(0);
assertThat(message.getImage()).isNotNull();
assertThat(message.isImage()).isTrue();
assertThat(message.isText()).isFalse();

Image image = message.getImage();
assertThat(image.getCaption()).isEqualTo("Some awesome image");
assertThat(image.getId()).isEqualTo("400962571939895");
assertThat(image.getMimeType()).isEqualTo("image\\/jpeg");
assertThat(image.getSha256()).isEqualTo("law0CgE277wMMnIJU0XIxhDne6Ptmwaek\\/thVM7mVtg=");

assertThat(message.getTimestamp()).isEqualTo(new Date(1653253313000L));
assertThat(message.getType()).isEqualTo(MessageType.image);
assertThat(message.getFrom()).isEqualTo("491234567890");
}

private <T extends ChangeValue> T getWHObjectFromJson(String jsonName, Class<T> clazz) {
WebhookObject webhookObject =
createJsonMapper().toJavaObject(jsonFromClasspath("whatsapp/" + jsonName), WebhookObject.class);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "101809759215303",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "1234567891",
"phone_number_id": "10634295353625"
},
"contacts": [
{
"profile": {
"name": "TestUser"
},
"wa_id": "491234567890"
}
],
"messages": [
{
"from": "491234567890",
"id": "wamid.HBgNNDkxNTIwOTgzMzM5OBUCABIYHGDEHJVFHJEVCFHJEVBCMTkyODk1OEIyAA==",
"timestamp": "1653253313",
"type": "video",
"video": {
"caption": "Video",
"mime_type": "video\\/mp4",
"sha256": "r9TvFx8eGPq\\/nn7l\\/yVMfSmQjBPWlEGOpkBKMVNqDGk=",
"id": "378911494190301"
}
}
]
},
"field": "messages"
}
]
}
]
}

0 comments on commit e878afb

Please sign in to comment.