Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Messaging abstraction updates #134

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Messaging abstraction updates #134

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1558c89
WIP First Commit, Refactoring SMS/Messaging abstraction
Levi-Lehman May 15, 2023
c3f33a1
Refactored the ENV + Filled out necessary methods
Levi-Lehman May 16, 2023
fedd8c2
Initial Client Setup
Levi-Lehman May 18, 2023
39eafdc
WIP Initial MessageBird Integration
Levi-Lehman May 31, 2023
e502b2b
PR Comments
Levi-Lehman May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/main/java/com/impactupgrade/nucleus/client/MessageBirdClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package com.impactupgrade.nucleus.client;

import com.impactupgrade.nucleus.environment.Environment;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class MessageBirdClient {
private static final Logger log = LogManager.getLogger(MessageBirdClient.class);

private static final String MESSAGE_BIRD_API_URL = "https://nest.messagebird.com/";

private String accessKey;

protected Environment env;

public MessageBirdClient(Environment env){
this.env = env;
this.accessKey = env.getConfig().messageBird.accesKey;
}


}
319 changes: 319 additions & 0 deletions src/main/java/com/impactupgrade/nucleus/controller/MessagingController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,319 @@
package com.impactupgrade.nucleus.controller;

import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.impactupgrade.nucleus.entity.JobType;
import com.impactupgrade.nucleus.environment.Environment;
import com.impactupgrade.nucleus.environment.EnvironmentConfig;
import com.impactupgrade.nucleus.environment.EnvironmentFactory;
import com.impactupgrade.nucleus.model.ContactSearch;
import com.impactupgrade.nucleus.model.CrmContact;
import com.impactupgrade.nucleus.model.CrmOpportunity;
import com.impactupgrade.nucleus.security.SecurityUtil;
import com.impactupgrade.nucleus.service.logic.MessagingService;
import com.impactupgrade.nucleus.util.Utils;
import com.twilio.twiml.MessagingResponse;
import com.twilio.twiml.VoiceResponse;
import com.twilio.twiml.voice.Dial;
import com.twilio.twiml.voice.Gather;
import com.twilio.twiml.voice.Redirect;
import com.twilio.twiml.voice.Say;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Form;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;

import static com.impactupgrade.nucleus.util.Utils.noWhitespace;
import static com.impactupgrade.nucleus.util.Utils.trim;

@Path("/messaging")
Levi-Lehman marked this conversation as resolved.
Show resolved Hide resolved
public class MessagingController {
private static final Logger log = LogManager.getLogger(TwilioController.class);

protected final EnvironmentFactory envFactory;
public MessagingController(EnvironmentFactory envFactory) {
this.envFactory = envFactory;
}
@Path("/outbound/crm-list")
Levi-Lehman marked this conversation as resolved.
Show resolved Hide resolved
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public Response outboundToCrmList(
@FormParam("list-id") List<String> listIds,
@FormParam("sender") String _sender,
@FormParam("message") String message,
@FormParam("nucleus-username") String nucleusUsername,
@FormParam("nucleus-email") String nucleusEmail,
@Context HttpServletRequest request) throws Exception {
Environment env = envFactory.init(request);
SecurityUtil.verifyApiKey(env);

MessagingService messagingService = env.messagingService();

log.info("listIds={} sender={} message={}", Joiner.on(",").join(listIds), _sender, message);

String sender;
if (!Strings.isNullOrEmpty(_sender)) {
sender = _sender;
} else {
Map<String, EnvironmentConfig.TwilioUser> users = env.getConfig().twilio.users; //TODO NOTE twilio specific
if (users != null && (users.containsKey(nucleusUsername) || users.containsKey(nucleusEmail))) {
if (users.containsKey(nucleusUsername)) {
sender = users.get(nucleusUsername).senderPn;
} else {
sender = users.get(nucleusEmail).senderPn;
}
} else {
sender = env.getConfig().twilio.senderPn;
}
}

// first grab all the contacts, since we want to fail early if there's an issue and give a clear error in the portal
List<CrmContact> contacts = new ArrayList<>();
for (String listId : listIds) {
try {
log.info("retrieving contacts from list {}", listId);
contacts.addAll(env.messagingCrmService().getContactsFromList(listId));
log.info("found {} contacts in list {}", contacts.size(), listId);
} catch (Exception e) {
log.warn("failed to retrieve list {}", listId, e);
return Response.serverError().build();
}
}

// takes a while, so spin it off as a new thread
Runnable thread = () -> {
try {
String jobName = "SMS Blast";
log.info("STARTED: {}", jobName);
env.startJobLog(JobType.PORTAL_TASK, null, jobName, env.textingService().name());

List<CrmContact> filteredContacts = contacts.stream()
.filter(c -> !Strings.isNullOrEmpty(c.phoneNumberForSMS()))
.collect(Collectors.toList());
int messagesSent = 0;

for (CrmContact c: filteredContacts) {
messagingService.sendMessage(message, c, sender);
env.logJobProgress(++messagesSent + " message(s) sent");
}

env.endJobLog(jobName);
log.info("FINISHED: {}", jobName);

} catch (Exception e) {
log.error("job failed", e);
env.logJobError(e.getMessage());
}

};
new Thread(thread).start();

return Response.ok().build();
}

/**
* This webhook is to be used by Twilio Studio flows, Twilio Functions, etc. for more complex
* interactions. Try to make use of the standard form params whenever possible to maintain the overlap!
*/
@Path("twilio/inbound/sms/signup") //TODO make this generic
Levi-Lehman marked this conversation as resolved.
Show resolved Hide resolved
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Produces(MediaType.APPLICATION_XML)
public Response inboundSignup(
@FormParam("From") String from,
@FormParam("FirstName") String _firstName,
@FormParam("LastName") String _lastName,
@FormParam("FullName") String fullName,
@FormParam("Email") String _email,
@FormParam("EmailOptIn") String emailOptIn,
@FormParam("SmsOptIn") String smsOptIn,
@FormParam("Language") String _language,
@FormParam("ListId") String _listId,
@FormParam("HubSpotListId") @Deprecated Long hsListId,
@FormParam("CampaignId") String campaignId,
@FormParam("OpportunityName") String opportunityName,
@FormParam("OpportunityRecordTypeId") String opportunityRecordTypeId,
@FormParam("OpportunityOwnerId") String opportunityOwnerId,
@FormParam("OpportunityNotes") String opportunityNotes,
@FormParam("nucleus-username") String nucleusUsername,
@Context HttpServletRequest request
) throws Exception {
log.info("from={} firstName={} lastName={} fullName={} email={} emailOptIn={} smsOptIn={} language={} listId={} hsListId={} campaignId={} opportunityName={} opportunityRecordTypeId={} opportunityOwnerId={} opportunityNotes={}",
from, _firstName, _lastName, fullName, _email, emailOptIn, smsOptIn, _language, _listId, hsListId, campaignId, opportunityName, opportunityRecordTypeId, opportunityOwnerId, opportunityNotes);
Environment env = envFactory.init(request);

_firstName = trim(_firstName);
_lastName = trim(_lastName);
fullName = trim(fullName);
final String email = noWhitespace(_email);
final String language = noWhitespace(_language);

String firstName;
String lastName;
if (!Strings.isNullOrEmpty(fullName)) {
String[] split = Utils.fullNameToFirstLast(fullName);
firstName = split[0];
lastName = split[1];
} else {
firstName = _firstName;
lastName = _lastName;
}

String listId;
if (hsListId != null && hsListId > 0) {
listId = hsListId + "";
} else {
listId = _listId;
}

Runnable thread = () -> {
try {
String jobName = "SMS Flow";
env.startJobLog(JobType.EVENT, null, jobName, env.textingService().name());
CrmContact crmContact = env.messagingService().processSignup(
from,
firstName,
lastName,
email,
emailOptIn,
smsOptIn,
language,
campaignId,
listId
);

// avoid the insertOpportunity call unless we're actually creating a non-donation opportunity
CrmOpportunity crmOpportunity = new CrmOpportunity();
crmOpportunity.contact.id = crmContact.id;

if (!Strings.isNullOrEmpty(opportunityName)) {
crmOpportunity.name = opportunityName;
crmOpportunity.recordTypeId = opportunityRecordTypeId;
crmOpportunity.ownerId = opportunityOwnerId;
crmOpportunity.campaignId = campaignId;
crmOpportunity.description = opportunityNotes;
env.messagingCrmService().insertOpportunity(crmOpportunity);
env.endJobLog(jobName);
}
} catch (Exception e) {
log.warn("inbound SMS signup failed", e);
env.logJobError(e.getMessage());
}
};
new Thread(thread).start();

//TODO removed OG Twilio response, revisit after sorting out MB
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might need to shake up the whole flow to make this happen.

  • Remove the use of a new thread in this whole endpoint.
  • Break apart the processing code in MessagingService. Spin up a new thread there instead.
  • Allow a vender-specific response to be created and bubbled up from the underlying segment service. Something like TwilioService (whatever we call it) -> MessagingService -> MessagingController.

However, you receive bonus points for the use of "OG".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Started implementing this and am getting a bit lost in the separation of everything. It seems to me like there is nothing super Twilio-specific besides how the response is being generated. Do we just need something like
textingService.buildResponse() for now? Could be misunderstanding

Copy link
Contributor

@Levi-Lehman Levi-Lehman May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we will have more complex needs as we get deeper into MessageBird flows though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A buildResponse() would work for the default "yup I got it" responses, but we might need something else more specific for certain circumstances.

In Twilio land, webhooks out to external services are expected to respond back with TwiML, which is just an XML schema used to tell Twilio what to do next. So in some situations, we might return a reply with message "foobar". It's more useful for things like decision trees being handled by external services. But in our cases, often we're simply returning back empty TwiML since there's nothing extra to do.

That part is definitely Twilio-specific -- not sure if we'll need something similar in MB land.

return Response.ok().build();
}

private static final List<String> STOP_WORDS = List.of("STOP", "STOPALL", "UNSUBSCRIBE", "CANCEL", "END", "QUIT");

/**
* This webhook serves as a more generic catch-all endpoint for inbound messages from Twilio.
*/
@Path("twilio/inbound/sms/webhook")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Produces(MediaType.APPLICATION_XML)
public Response inboundWebhook(
Form rawFormData,
@Context HttpServletRequest request
) throws Exception {
Environment env = envFactory.init(request);

MultivaluedMap<String, String> smsData = rawFormData.asMap();
log.info(smsData.entrySet().stream().map(e -> e.getKey() + "=" + String.join(",", e.getValue())).collect(Collectors.joining(" ")));

String from = smsData.get("From").get(0);
if (smsData.containsKey("Body")) {
String body = smsData.get("Body").get(0).trim();
// prevent opt-out messages, like "STOP", from polluting the notifications
if (!STOP_WORDS.contains(body.toUpperCase(Locale.ROOT))) {
String jobName = "SMS Inbound";
env.startJobLog(JobType.EVENT, null, jobName, "Twilio");
Levi-Lehman marked this conversation as resolved.
Show resolved Hide resolved
String targetId = env.messagingCrmService().searchContacts(ContactSearch.byPhone(from)).getSingleResult().map(c -> c.id).orElse(null);
env.notificationService().sendNotification(
"Text Message Received",
"Text message received from " + from + ": " + body,
targetId,
"sms:inbound-default"
);
env.endJobLog(jobName);
}
}
//TODO removed OG Twilio response, revisit after sorting out MB
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

return Response.ok().build();
}

/**
* Positioned as a webhook on fundraiser proxy phone numbers, allowing outbound masked calls and inbound call forwarding.
*
* @param from
* @param to
* @param digits
* @param owner
* @return
*/
@Path("/twilio/proxy/voice") //TODO adding a /twilio path for now to keep platform specific endpoints
Levi-Lehman marked this conversation as resolved.
Show resolved Hide resolved
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Produces(MediaType.APPLICATION_XML)
public Response proxyVoice(
@FormParam("From") String from,
@FormParam("To") String to,
@FormParam("Digits") String digits,
@QueryParam("owner") String owner,
@Context HttpServletRequest request
) {
log.info("from={} owner={}", from, owner);
Environment env = envFactory.init(request);

String xml;

// if the owner of this number is calling, assume they want to proxy an outbound call
if (from.equals(owner)) {
// beginning of the process, so prompt for the destination number
if (Strings.isNullOrEmpty(digits)) {
log.info("prompting owner for recipient phone number");
xml = new VoiceResponse.Builder()
.gather(new Gather.Builder().say(new Say.Builder("Please enter the destination phone number, followed by #.").build()).build())
// redirect to this endpoint again, which will include the response in a Digits form param
.redirect(new Redirect.Builder("/api/twilio/proxy/voice?owner=" + owner).build())
.build().toXml();
}
// we already prompted, then redirected back to this endpoint, so use the Digits that were included to dial the recipient
else {
log.info("owner provided recipient phone number; dialing {}", digits);
xml = new VoiceResponse.Builder()
// note: in this case, 'to' is the Twilio masking number
.dial(new Dial.Builder(digits).callerId(to).build())
.build().toXml();
}
}
// else, it's someone else calling inbound, so send it to the owner
else {
log.info("inbound call from {}; connecting to {}", from, owner);
xml = new VoiceResponse.Builder()
.dial(new Dial.Builder(owner).build())
.build().toXml();
}

return Response.ok().entity(xml).build();
}
}
8 changes: 8 additions & 0 deletions src/main/java/com/impactupgrade/nucleus/environment/Environment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import com.google.common.base.Strings;
import com.impactupgrade.nucleus.client.DonorWranglerClient;
import com.impactupgrade.nucleus.client.MessageBirdClient;
import com.impactupgrade.nucleus.client.SfdcBulkClient;
import com.impactupgrade.nucleus.client.SfdcClient;
import com.impactupgrade.nucleus.client.SfdcMetadataClient;
Expand All @@ -28,6 +29,7 @@
import com.impactupgrade.nucleus.service.segment.NoOpCrmService;
import com.impactupgrade.nucleus.service.segment.PaymentGatewayService;
import com.impactupgrade.nucleus.service.segment.SegmentService;
import com.impactupgrade.nucleus.service.segment.TextingService;
import org.apache.http.client.utils.URLEncodedUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Expand Down Expand Up @@ -164,6 +166,10 @@ public CrmService messagingCrmService() {
return crmService(getConfig().crmMessaging);
}

public TextingService textingService(){
return segmentService(getConfig().textingService, TextingService.class);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sold on TextingService as the name, since it's not really different than MessagingService, but I don't have any better ideas either. Let's circle back on it...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah wasn't sold on it myself either... words are hard

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we simply used MessagingLogicService for logic and MessagingSegmentService for segment?

}

public PaymentGatewayService paymentGatewayService(String name) {
return segmentService(name, PaymentGatewayService.class);
}
Expand Down Expand Up @@ -246,6 +252,8 @@ private <T extends SegmentService> List<T> segmentServices(Class<T> clazz) {
public StripeClient stripeClient() { return new StripeClient(this); }
public TwilioClient twilioClient() { return new TwilioClient(this); }

public MessageBirdClient messageBirdClient() { return new MessageBirdClient(this); }

// job logging services

private JobLoggingService _jobLoggingService = null;
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/com/impactupgrade/nucleus/environment/EnvironmentConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ public class EnvironmentConfig implements Serializable {

public String emailTransactional = "";

public String textingService = "";

public static class Platform implements Serializable {
// if keys
public String publicKey = "";
Expand Down Expand Up @@ -235,6 +237,11 @@ public static class Donorwrangler extends Platform {
public String subdomain = "";
}

public MessageBird messageBird = new MessageBird();
public static class MessageBird extends Platform {
public String accesKey = "";
Levi-Lehman marked this conversation as resolved.
Show resolved Hide resolved
}

public Twilio twilio = new Twilio();

public static class Twilio extends Platform {
Expand Down
Loading