edx-ace 1.11.4__tar.gz → 1.12.0__tar.gz

{edx-ace-1.11.4/edx_ace.egg-info → edx-ace-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-ace
-Version: 1.11.4
+Version: 1.12.0
 Summary: Framework for Messaging
 Home-page: https://github.com/openedx/edx-ace
 Author: edX

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace/__init__.py

@@ -13,7 +13,7 @@ from .policy import Policy, PolicyResult
 from .recipient import Recipient
 from .recipient_resolver import RecipientResolver
 
-__version__ = '1.11.4'
+__version__ = '1.12.0'
 
 
 __all__ = [

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace/channel/__init__.py

@@ -28,6 +28,7 @@ class ChannelType(Enum):
 
     EMAIL = 'email'
     PUSH = 'push'
+    BRAZE_PUSH = 'braze_push'
 
     def __str__(self):
         return str(self.value)
@@ -184,6 +185,8 @@ def get_channel_for_message(channel_type, message):
             channel_names = [settings.ACE_CHANNEL_DEFAULT_EMAIL]
     elif channel_type == ChannelType.PUSH and getattr(settings, "ACE_CHANNEL_DEFAULT_PUSH", None):
         channel_names = [settings.ACE_CHANNEL_DEFAULT_PUSH]
+    elif channel_type == ChannelType.BRAZE_PUSH and getattr(settings, "ACE_CHANNEL_BRAZE_PUSH", None):
+        channel_names = [settings.ACE_CHANNEL_BRAZE_PUSH]
 
     try:
         possible_channels = [

edx-ace-1.12.0/edx_ace/channel/braze_push_notification.py

@@ -0,0 +1,64 @@
+"""
+Channel for sending push notifications using braze.
+"""
+import logging
+
+from django.conf import settings
+
+from edx_ace.channel import Channel, ChannelType
+from edx_ace.message import Message
+from edx_ace.renderers import RenderedPushNotification
+from edx_ace.utils.braze import get_braze_client
+
+LOG = logging.getLogger(__name__)
+
+
+class BrazePushNotificationChannel(Channel):
+    """
+    A channel for sending push notifications using braze.
+    """
+    channel_type = ChannelType.BRAZE_PUSH
+    _CAMPAIGNS_SETTING = 'ACE_CHANNEL_BRAZE_PUSH_CAMPAIGNS'
+
+    @classmethod
+    def enabled(cls):
+        """
+        Returns: True iff braze client is available.
+        """
+        return bool(get_braze_client())
+
+    def deliver(self, message: Message, rendered_message: RenderedPushNotification) -> None:
+        """
+        Transmit a rendered message to a recipient.
+
+        Args:
+            message: The message to transmit.
+            rendered_message: The rendered content of the message that has been personalized
+                for this particular recipient.
+        """
+        braze_campaign = message.options['braze_campaign']
+        emails = message.options.get('emails') or [message.recipient.email_address]
+        campaign_id = self._campaign_id(braze_campaign)
+        if not campaign_id:
+            LOG.info('Could not find braze campaign for notification %s', braze_campaign)
+            return
+
+        try:
+            braze_client = get_braze_client()
+            braze_client.send_campaign_message(
+                campaign_id=campaign_id,
+                trigger_properties=message.context['post_data'],
+                emails=emails
+            )
+            LOG.info('Sent push notification for %s with Braze', braze_campaign)
+        except Exception as exc:  # pylint: disable=broad-except
+            LOG.error(
+                'Unable to send push notification for %s with Braze. Reason: %s',
+                braze_campaign,
+                str(exc)
+            )
+
+    @classmethod
+    def _campaign_id(cls, braze_campaign):
+        """Returns the campaign ID for a given ACE message name or None if no match is found"""
+        return getattr(settings, cls._CAMPAIGNS_SETTING, {}).get(braze_campaign)

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace/presentation.py

@@ -10,6 +10,7 @@ from edx_ace.channel import ChannelType
 RENDERERS = {
     ChannelType.EMAIL: renderers.EmailRenderer(),
     ChannelType.PUSH: renderers.PushNotificationRenderer(),
+    ChannelType.BRAZE_PUSH: renderers.BrazePushNotificationRenderer(),
 }
 
 

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace/renderers.py

@@ -99,3 +99,18 @@ class PushNotificationRenderer(AbstractRenderer):
     A renderer for :attr:`.ChannelType.PUSH` channels.
     """
     rendered_message_cls = RenderedPushNotification
+
+
+@attr.s
+class RenderedBrazePushNotification:
+    """
+    Encapsulates all values needed to send a :class:`.Message`
+    over an :attr:`.ChannelType.BRAZE_PUSH`.
+    """
+
+
+class BrazePushNotificationRenderer(AbstractRenderer):
+    """
+    A renderer for :attr:`.ChannelType.PUSH` channels.
+    """
+    rendered_message_cls = RenderedBrazePushNotification

edx-ace-1.12.0/edx_ace/tests/channel/test_braze_push_notification.py

@@ -0,0 +1,105 @@
+"""
+Tests for TestBrazePushNotificationChannel.
+"""
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from django.contrib.auth import get_user_model
+from django.test import TestCase, override_settings
+
+from edx_ace.channel.braze_push_notification import BrazePushNotificationChannel
+from edx_ace.message import Message
+from edx_ace.recipient import Recipient
+from edx_ace.renderers import RenderedBrazePushNotification
+
+BRAZE_URL = "https://example.braze.com"
+API_KEY = "test-api-key"
+User = get_user_model()
+
+
+@pytest.mark.django_db
+@override_settings(
+    EDX_BRAZE_API_KEY=API_KEY,
+    EDX_BRAZE_API_SERVER=BRAZE_URL,
+)
+class TestBrazePushNotificationChannel(TestCase):
+
+    def setUp(self):
+        super().setUp()
+        self.user = User.objects.create(username='username', email='email@example.com')
+        self.lms_user_id = self.user.id
+        self.mocked_post_data = {
+                'notification_type': 'new_response',
+                'course_id': 'course-v1:edX+DemoX+Demo_Course',
+                'content_url': 'http://localhost',
+                'replier_name': 'verified',
+                'post_title': 'New test response',
+                'course_name': 'Demonstration Course',
+                'thread_id': '67bedeb9ceb0b101343294c5',
+                'topic_id': 'i4x-edx-eiorguegnru-course-foobarbaz',
+                'response_id': '67ffa1f1ceb0b10134db3d8e',
+                'comment_id': None,
+                'strong': 'strong', 'p': 'p'
+        }
+
+        self.mocked_payload = {
+            'campaign_id': '1234test',
+            'trigger_properties': self.mocked_post_data,
+            'emails': ['edx@example.com']
+        }
+
+    @patch('edx_ace.channel.braze_push_notification.get_braze_client', return_value=True)
+    def test_enabled(self, mock_braze_client):
+        """
+        Test that the channel is enabled when the settings are configured.
+        """
+        assert BrazePushNotificationChannel.enabled()
+
+    @patch('edx_ace.channel.braze_push_notification.get_braze_client', return_value=False)
+    def test_disabled(self, mock_braze_client):
+        """
+        Test that the channel is disabled when the settings are not configured.
+        """
+        assert not BrazePushNotificationChannel.enabled()
+
+    @override_settings(ACE_CHANNEL_BRAZE_PUSH_CAMPAIGNS={'new_response': "1234test"})
+    @patch('edx_ace.channel.braze_push_notification.get_braze_client')
+    def test_deliver_success(self, mock_braze_function):
+        mock_braze_client = MagicMock()
+        mock_braze_function.return_value = mock_braze_client
+        mock_braze_client.send_campaign_message = MagicMock(return_value=True)
+
+        rendered_message = RenderedBrazePushNotification()
+        message = Message(
+            app_label='testapp',
+            name="test_braze",
+            recipient=Recipient(lms_user_id="1", email_address="user@example.com"),
+            context={'post_data': self.mocked_post_data},
+            options={'emails': ['edx@example.com'], 'braze_campaign': 'new_response'}
+        )
+        channel = BrazePushNotificationChannel()
+        channel.deliver(message, rendered_message)
+        mock_braze_client.send_campaign_message.assert_called_once()
+        args, kwargs = mock_braze_client.send_campaign_message.call_args
+
+        # Verify the payload
+        self.assertEqual(kwargs, self.mocked_payload)
+
+    @patch('edx_ace.channel.braze_push_notification.get_braze_client')
+    def test_campaign_not_configured(self, mock_braze_function):
+        mock_braze_client = MagicMock()
+        mock_braze_function.return_value = mock_braze_client
+        mock_braze_client.send_campaign_message = MagicMock(return_value=True)
+
+        rendered_message = RenderedBrazePushNotification()
+        message = Message(
+            app_label='testapp',
+            name="test_braze",
+            recipient=Recipient(lms_user_id="1", email_address="user@example.com"),
+            context={'post_data': self.mocked_post_data},
+            options={'emails': ['edx@example.com'], 'braze_campaign': 'new_response'}
+        )
+        channel = BrazePushNotificationChannel()
+        channel.deliver(message, rendered_message)
+        mock_braze_client.send_campaign_message.assert_not_called()

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace/tests/test_policy.py

@@ -24,12 +24,16 @@ class TestPolicy(TestCase):
         PolicyCase(deny_values=[set(ChannelType)], expected_channels=set()),
 
         # deny only email
-        PolicyCase(deny_values=[{ChannelType.EMAIL}], expected_channels={ChannelType.PUSH}),  # single policy
-        PolicyCase(deny_values=[{ChannelType.EMAIL}, set()], expected_channels={ChannelType.PUSH}),  # multiple policies
-
-        # deny both email and push
-        PolicyCase(deny_values=[{ChannelType.EMAIL, ChannelType.PUSH}], expected_channels=set()),  # single policy
-        PolicyCase(deny_values=[{ChannelType.EMAIL}, {ChannelType.PUSH}], expected_channels=set()),  # multiple policies
+        PolicyCase(deny_values=[{ChannelType.EMAIL}],
+                   expected_channels={ChannelType.PUSH, ChannelType.BRAZE_PUSH}),  # single policy
+        PolicyCase(deny_values=[{ChannelType.EMAIL}, set()],
+                   expected_channels={ChannelType.PUSH, ChannelType.BRAZE_PUSH}),  # multiple policies
+
+        # deny email, push and braze_push
+        PolicyCase(deny_values=[{ChannelType.EMAIL, ChannelType.PUSH, ChannelType.BRAZE_PUSH}],
+                   expected_channels=set()),  # single policy
+        PolicyCase(deny_values=[{ChannelType.EMAIL}, {ChannelType.PUSH},
+                                {ChannelType.BRAZE_PUSH}], expected_channels=set()),  # multiple policies
 
         # deny all and email
         PolicyCase(deny_values=[{ChannelType.EMAIL}, set(ChannelType)], expected_channels=set()),

edx-ace-1.12.0/edx_ace/tests/utils/test_braze_utils.py

@@ -0,0 +1,59 @@
+"""
+Test cases for utils.braze
+"""
+from unittest.mock import patch
+
+import pytest
+
+from django.contrib.auth import get_user_model
+from django.test import TestCase, override_settings
+
+from edx_ace.utils.braze import get_braze_client
+
+BRAZE_URL = "https://example.braze.com"
+API_KEY = "test-api-key"
+User = get_user_model()
+
+
+@pytest.mark.django_db
+class TestBrazeClient(TestCase):
+    """ Test cases for utils.braze """
+
+    @patch('edx_ace.utils.braze.BrazeClient')
+    def test_disabled(self, mock_braze_client):
+        """
+        Test that the channel is settings aren't configured.
+        """
+        result = get_braze_client()
+        self.assertEqual(result, None)
+        mock_braze_client.assert_not_called()
+
+    @override_settings(ACE_CHANNEL_BRAZE_API_KEY=API_KEY)
+    @patch('edx_ace.utils.braze.BrazeClient')
+    def test_braze_url_not_configured(self, mock_braze_client):
+        """
+        Test that the channel is settings aren't configured.
+        """
+        result = get_braze_client()
+        self.assertEqual(result, None)
+        mock_braze_client.assert_not_called()
+
+    @override_settings(ACE_CHANNEL_BRAZE_REST_ENDPOINT=API_KEY)
+    @patch('edx_ace.utils.braze.BrazeClient')
+    def test_braze_api_key_not_configured(self, mock_braze_client):
+        """
+        Test that the channel is settings aren't configured.
+        """
+        result = get_braze_client()
+        self.assertEqual(result, None)
+        mock_braze_client.assert_not_called()
+
+    @override_settings(ACE_CHANNEL_BRAZE_REST_ENDPOINT=API_KEY, ACE_CHANNEL_BRAZE_API_KEY=API_KEY)
+    @patch('edx_ace.utils.braze.BrazeClient', return_value=True)
+    def test_success(self, mock_braze_client):
+        """
+        Test that the channel is settings aren't configured.
+        """
+        result = get_braze_client()
+        self.assertEqual(result, True)
+        mock_braze_client.assert_called_once()

edx-ace-1.12.0/edx_ace/utils/braze.py

@@ -0,0 +1,27 @@
+"""
+Helper Methods related to braze client
+"""
+
+try:
+    from braze.client import BrazeClient
+except ImportError:
+    BrazeClient = None
+from django.conf import settings
+
+
+def get_braze_client():
+    """ Returns a Braze client. """
+    if not BrazeClient:
+        return None
+
+    braze_api_key = getattr(settings, 'ACE_CHANNEL_BRAZE_API_KEY', None)
+    braze_api_url = getattr(settings, 'ACE_CHANNEL_BRAZE_REST_ENDPOINT', None)
+
+    if not braze_api_key or not braze_api_url:
+        return None
+
+    return BrazeClient(
+        api_key=braze_api_key,
+        api_url=f"https://{braze_api_url}",
+        app_id='',
+    )

{edx-ace-1.11.4 → edx-ace-1.12.0/edx_ace.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-ace
-Version: 1.11.4
+Version: 1.12.0
 Summary: Framework for Messaging
 Home-page: https://github.com/openedx/edx-ace
 Author: edX

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ edx_ace.egg-info/requires.txt
 edx_ace.egg-info/top_level.txt
 edx_ace/channel/__init__.py
 edx_ace/channel/braze.py
+edx_ace/channel/braze_push_notification.py
 edx_ace/channel/django_email.py
 edx_ace/channel/file.py
 edx_ace/channel/mixins.py
@@ -42,6 +43,7 @@ edx_ace/tests/test_message.py
 edx_ace/tests/test_policy.py
 edx_ace/tests/test_presentation.py
 edx_ace/tests/channel/test_braze.py
+edx_ace/tests/channel/test_braze_push_notification.py
 edx_ace/tests/channel/test_channel_helpers.py
 edx_ace/tests/channel/test_django_email.py
 edx_ace/tests/channel/test_file_email.py
@@ -49,8 +51,10 @@ edx_ace/tests/channel/test_push_notification.py
 edx_ace/tests/channel/test_sailthru.py
 edx_ace/tests/test_templates/testapp/edx_ace/testmessage/email/body.html
 edx_ace/tests/test_templates/testapp/edx_ace/testmessage/email/head.html
+edx_ace/tests/utils/test_braze_utils.py
 edx_ace/tests/utils/test_signals.py
 edx_ace/utils/__init__.py
+edx_ace/utils/braze.py
 edx_ace/utils/date.py
 edx_ace/utils/once.py
 edx_ace/utils/plugins.py

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace.egg-info/entry_points.txt

@@ -1,5 +1,6 @@
 [openedx.ace.channel]
 braze_email = edx_ace.channel.braze:BrazeEmailChannel
+braze_push = edx_ace.channel.braze_push_notification:BrazePushNotificationChannel
 django_email = edx_ace.channel.django_email:DjangoEmailChannel
 file_email = edx_ace.channel.file:FileEmailChannel
 push_notification = edx_ace.channel.push_notification:PushNotificationChannel

{edx-ace-1.11.4 → edx-ace-1.12.0}/edx_ace.egg-info/requires.txt

@@ -1,6 +1,7 @@
 Django>=2.2
 attrs>=17.2.0
 django-push-notifications
+edx-braze-client==1.0.1
 edx-django-utils>=5.14.2
 firebase-admin
 python-dateutil

{edx-ace-1.11.4 → edx-ace-1.12.0}/requirements/base.in

@@ -5,6 +5,7 @@ Django>=2.2                       # Web application framework
 python-dateutil                   # Python Date Utilities
 attrs>=17.2.0                     # Attributes without boilerplate
 sailthru-client==2.2.3
+edx-braze-client==1.0.1
 six
 stevedore>=1.10.0
 edx-django-utils>=5.14.2

{edx-ace-1.11.4 → edx-ace-1.12.0}/setup.py

@@ -30,20 +30,48 @@ def load_requirements(*requirements_paths):
     """
     # UPDATED VIA SEMGREP - if you need to remove/modify this method remove this line and add a comment specifying why.
 
+    # e.g. {"django": "Django", "confluent-kafka": "confluent_kafka[avro]"}
+    by_canonical_name = {}
+
+    def check_name_consistent(package):
+        """
+        Raise exception if package is named different ways.
+
+        This ensures that packages are named consistently so we can match
+        constraints to packages. It also ensures that if we require a package
+        with extras we don't constrain it without mentioning the extras (since
+        that too would interfere with matching constraints.)
+        """
+        canonical = package.lower().replace('_', '-').split('[')[0]
+        seen_spelling = by_canonical_name.get(canonical)
+        if seen_spelling is None:
+            by_canonical_name[canonical] = package
+        elif seen_spelling != package:
+            raise Exception(
+                f'Encountered both "{seen_spelling}" and "{package}" in requirements '
+                'and constraints files; please use just one or the other.'
+            )
+
     requirements = {}
     constraint_files = set()
 
-    # groups "my-package-name<=x.y.z,..." into ("my-package-name", "<=x.y.z,...")
-    requirement_line_regex = re.compile(r"([a-zA-Z0-9-_.]+)([<>=][^#\s]+)?")
+    # groups "pkg<=x.y.z,..." into ("pkg", "<=x.y.z,...")
+    re_package_name_base_chars = r"a-zA-Z0-9\-_."  # chars allowed in base package name
+    # Two groups: name[maybe,extras], and optionally a constraint
+    requirement_line_regex = re.compile(
+        r"([%s]+(?:\[[%s,\s]+\])?)([<>=][^#\s]+)?"
+        % (re_package_name_base_chars, re_package_name_base_chars)
+    )
 
     def add_version_constraint_or_raise(current_line, current_requirements, add_if_not_present):
         regex_match = requirement_line_regex.match(current_line)
         if regex_match:
             package = regex_match.group(1)
             version_constraints = regex_match.group(2)
+            check_name_consistent(package)
             existing_version_constraints = current_requirements.get(package, None)
-            # it's fine to add constraints to an unconstrained package, but raise an error if there are already
-            # constraints in place
+            # It's fine to add constraints to an unconstrained package,
+            # but raise an error if there are already constraints in place.
             if existing_version_constraints and existing_version_constraints != version_constraints:
                 raise BaseException(f'Multiple constraint definitions found for {package}:'
                                     f' "{existing_version_constraints}" and "{version_constraints}".'
@@ -52,7 +80,8 @@ def load_requirements(*requirements_paths):
             if add_if_not_present or package in current_requirements:
                 current_requirements[package] = version_constraints
 
-    # process .in files and store the path to any constraint files that are pulled in
+    # Read requirements from .in files and store the path to any
+    # constraint files that are pulled in.
     for path in requirements_paths:
         with open(path) as reqs:
             for line in reqs:
@@ -61,7 +90,7 @@ def load_requirements(*requirements_paths):
                 if line and line.startswith('-c') and not line.startswith('-c http'):
                     constraint_files.add(os.path.dirname(path) + '/' + line.split('#')[0].replace('-c', '').strip())
 
-    # process constraint files and add any new constraints found to existing requirements
+    # process constraint files: add constraints to existing requirements
     for constraint_file in constraint_files:
         with open(constraint_file) as reader:
             for line in reader:
@@ -136,6 +165,7 @@ setup(
             'file_email = edx_ace.channel.file:FileEmailChannel',
             'django_email = edx_ace.channel.django_email:DjangoEmailChannel',
             'push_notification = edx_ace.channel.push_notification:PushNotificationChannel',
+            'braze_push = edx_ace.channel.braze_push_notification:BrazePushNotificationChannel',
         ]
     }
 )