Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Commit

Permalink
feat: use a braze api-triggered campaign for ent offer usage
Browse files Browse the repository at this point in the history
  • Loading branch information
@iloveagent57 @long74100
iloveagent57 authored and long74100 committed Jun 29, 2022
1 parent a8ac58d commit f722987
Show file tree
Hide file tree
Showing 6 changed files with 517 additions and 100 deletions.
209 changes: 170 additions & 39 deletions ecommerce/enterprise/management/commands/send_enterprise_offer_limit_emails.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from requests.exceptions import RequestException

from ecommerce.core.models import User
from ecommerce.extensions.offer.constants import OfferUsageEmailTypes
from ecommerce.programs.custom import get_model

ConditionalOffer = get_model('offer', 'ConditionalOffer')
Expand All @@ -23,39 +24,27 @@

EMAIL_SUBJECT = 'Offer Usage Notification'

# Reasons why an email should not be sent
THRESHOLD_NOT_REACHED = 'Threshold not reached.'
EMAIL_SENT_BEFORE_OFFER_NOT_REPLENISHED = 'Email sent before, offer has not been replenished.'


class Command(BaseCommand):
"""
Send the enterprise offer limits emails.
"""

@staticmethod
def is_eligible_for_alert(enterprise_offer):
"""
Return the bool whether given offer is eligible for sending the email.
"""
offer_usage = OfferUsageEmail.objects.filter(offer=enterprise_offer).last()
diff_of_days = datetime.now().toordinal() - offer_usage.created.toordinal() if offer_usage else 0

if not enterprise_offer.max_global_applications and not enterprise_offer.max_discount:
is_eligible = False
elif not offer_usage:
is_eligible = True
elif enterprise_offer.usage_email_frequency == ConditionalOffer.DAILY:
is_eligible = diff_of_days >= 1
elif enterprise_offer.usage_email_frequency == ConditionalOffer.WEEKLY:
is_eligible = diff_of_days >= 7
else:
is_eligible = diff_of_days >= 30
return is_eligible

@staticmethod
def get_enrollment_limits(offer):
"""
Return the total limit, percentage usage and current usage of enrollment limit.
"""
percentage_usage = int((offer.num_orders / offer.max_global_applications) * 100)
return int(offer.max_global_applications), percentage_usage, int(offer.num_orders)
return {
'total_limit': int(offer.max_global_applications),
'percentage_usage': percentage_usage,
'current_usage': int(offer.num_orders)
}

@staticmethod
def get_booking_limits(site, offer):
Expand All @@ -72,29 +61,158 @@ def get_booking_limits(site, offer):
response.raise_for_status()
offer_analytics = response.json()

return (
offer_analytics['max_discount'],
offer_analytics['percent_of_offer_spent'],
offer_analytics['amount_of_offer_spent'],
return {
'total_limit': offer_analytics['max_discount'],
'percentage_usage': offer_analytics['percent_of_offer_spent'] * 100, # percent_of_offer_spent is 0-1
'current_usage': offer_analytics['amount_of_offer_spent']
}

@staticmethod
def is_eligible_for_email(enterprise_offer):
"""
Return whether given offer is eligible for sending a usage email.
"""
return enterprise_offer.max_global_applications or enterprise_offer.max_discount

def should_send_email_type(self, enterprise_offer, email_type, total_limit):
"""
Return whether an email of the given type should be sent for the offer.
Evaluates to True if an email of the given type has not been sent before or if the offer has been re-upped.
"""
last_email_of_type_sent = OfferUsageEmail.objects.filter(offer=enterprise_offer, email_type=email_type).last()

if not last_email_of_type_sent:
return True

email_metadata = last_email_of_type_sent.offer_email_metadata

# All emails sent after 6/28/22 should have this field in the metadata
previous_usage_data = email_metadata.get('email_usage_data')
if not previous_usage_data:
return True

# Offer limit has been increased, we can send emails again
previous_total_limit = previous_usage_data['total_limit']
if total_limit > previous_total_limit:
return True

return False

def is_eligible_for_no_balance_email(self, enterprise_offer, usage_info, is_enrollment_limit_offer):
"""
Return whether an offer is eligible for the out of balance email.
"""
percentage_usage = usage_info['percentage_usage']
total_limit = usage_info['total_limit']
current_usage = usage_info['current_usage']

should_send_email = self.should_send_email_type(
enterprise_offer,
OfferUsageEmailTypes.OUT_OF_BALANCE,
total_limit
)

if not should_send_email:
return (False, EMAIL_SENT_BEFORE_OFFER_NOT_REPLENISHED)

if is_enrollment_limit_offer:
return (percentage_usage == 100, THRESHOLD_NOT_REACHED)

return (total_limit - current_usage <= 100, THRESHOLD_NOT_REACHED)

def is_eligible_for_low_balance_email(
self,
enterprise_offer,
usage_info,
):
"""
Return whether an offer is eligible for the low balance email.
"""
percentage_usage = usage_info['percentage_usage']
total_limit = usage_info['total_limit']

return percentage_usage >= 75 and self.should_send_email_type(
enterprise_offer, OfferUsageEmailTypes.LOW_BALANCE, total_limit
)

def is_eligible_for_digest_email(self, enterprise_offer):
"""
Return whether given offer is eligible for the digest email.
"""
last_digest_email = OfferUsageEmail.objects.filter(
offer=enterprise_offer,
email_type=OfferUsageEmailTypes.DIGEST
).last()

diff_of_days = datetime.now().toordinal() - (last_digest_email.created.toordinal() if last_digest_email else 0)

if enterprise_offer.usage_email_frequency == ConditionalOffer.DAILY:
return diff_of_days >= 1

if enterprise_offer.usage_email_frequency == ConditionalOffer.WEEKLY:
return diff_of_days >= 7

return diff_of_days >= 30

def get_email_type(
self,
enterprise_offer,
usage_info,
is_enrollment_limit_offer
):
"""
Return the type of email that should be sent for the offer.
Evaluates to None if an email should not be sent.
"""
eligible_for_no_balance_email, ineligible_for_no_balance_email_reason = self.is_eligible_for_no_balance_email(
enterprise_offer, usage_info, is_enrollment_limit_offer
)

if eligible_for_no_balance_email:
return OfferUsageEmailTypes.OUT_OF_BALANCE

# Don't send low balance email or digest email until offer has been reupped
if ineligible_for_no_balance_email_reason == EMAIL_SENT_BEFORE_OFFER_NOT_REPLENISHED:
return None

if self.is_eligible_for_low_balance_email(enterprise_offer, usage_info):
return OfferUsageEmailTypes.LOW_BALANCE

if self.is_eligible_for_digest_email(enterprise_offer):
return OfferUsageEmailTypes.DIGEST

return None

def get_email_content(self, site, offer):
"""
Return the appropriate email body and subject of given offer.
"""
is_enrollment_limit_offer = bool(offer.max_global_applications)
total_limit, percentage_usage, current_usage = (

usage_info = (
self.get_enrollment_limits(offer)
if is_enrollment_limit_offer
else self.get_booking_limits(site, offer)
)

total_limit = usage_info['total_limit']
percentage_usage = usage_info['percentage_usage']
current_usage = usage_info['current_usage']

email_type = self.get_email_type(offer, usage_info, is_enrollment_limit_offer)

return {
'email_type': email_type,
'percent_usage': percentage_usage,
'total_limit': total_limit if is_enrollment_limit_offer else "${}".format(total_limit),
'is_enrollment_limit_offer': is_enrollment_limit_offer,
'total_limit': total_limit,
'total_limit_str': total_limit if is_enrollment_limit_offer else "${}".format(total_limit),
'offer_type': 'Enrollment' if is_enrollment_limit_offer else 'Booking',
'offer_name': offer.name,
'current_usage': current_usage if is_enrollment_limit_offer else "${}".format(current_usage),
'current_usage': current_usage,
'current_usage_str': current_usage if is_enrollment_limit_offer else "${}".format(current_usage),
}

@staticmethod
Expand Down Expand Up @@ -125,13 +243,9 @@ def handle(self, *args, **options):
total_enterprise_offers_count = enterprise_offers.count()
logger.info('[Offer Usage Alert] Total count of enterprise offers is %s.', total_enterprise_offers_count)
for enterprise_offer in enterprise_offers:
if self.is_eligible_for_alert(enterprise_offer):
logger.info(
'[Offer Usage Alert] Sending email for Offer with Name %s, ID %s',
enterprise_offer.name,
enterprise_offer.id
)
if self.is_eligible_for_email(enterprise_offer):
site = Site.objects.get_current()

try:
email_body_variables = self.get_email_content(site, enterprise_offer)
except RequestException as exc:
Expand All @@ -142,6 +256,18 @@ def handle(self, *args, **options):
)
continue

email_type = email_body_variables['email_type']

if email_type is None:
continue

logger.info(
'[Offer Usage Alert] Sending %s email for Offer with Name %s, ID %s',
email_type,
enterprise_offer.name,
enterprise_offer.id
)

lms_user_ids_by_email = {
user_email: User.get_lms_user_attribute_using_email(site, user_email, attribute='id')
for user_email in enterprise_offer.emails_for_usage_alert.strip().split(',')
Expand All @@ -151,18 +277,23 @@ def handle(self, *args, **options):
lms_user_ids_by_email,
EMAIL_SUBJECT,
email_body_variables,
campaign_id=settings.CAMPAIGN_IDS_BY_EMAIL_TYPE[email_type]
)

# Block until the task is done, since we're inside a management command
# and likely running from a job scheduler (ex. Jenkins).
# propagate=False means we won't re-raise (and exit this method) if any one task fails.
task_result.get(propagate=False)
if task_result.successful():
successful_send_count += 1
OfferUsageEmail.create_record(enterprise_offer, meta_data={
'email_usage_data': email_body_variables,
'email_subject': EMAIL_SUBJECT,
'email_addresses': enterprise_offer.emails_for_usage_alert
})
OfferUsageEmail.create_record(
email_type=email_type,
offer=enterprise_offer,
meta_data={
'email_usage_data': email_body_variables,
'email_subject': EMAIL_SUBJECT,
'email_addresses': enterprise_offer.emails_for_usage_alert
})
logger.info(
'[Offer Usage Alert] %s of %s offers with usage alerts configured had an email sent.',
successful_send_count,
Expand Down
Loading

0 comments on commit f722987

Please sign in to comment.