edx-ace 1.11.4__py2.py3-none-any.whl → 1.12.1__py2.py3-none-any.whl

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.1'
 
 
 __all__ = [

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/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/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/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/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/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/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/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.dist-info → edx_ace-1.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-ace
-Version: 1.11.4
+Version: 1.12.1
 Summary: Framework for Messaging
 Home-page: https://github.com/openedx/edx-ace
 Author: edX
@@ -21,6 +21,7 @@ License-File: LICENSE.txt
 Requires-Dist: Django>=2.2
 Requires-Dist: attrs>=17.2.0
 Requires-Dist: django-push-notifications
+Requires-Dist: edx-braze-client==1.0.2
 Requires-Dist: edx-django-utils>=5.14.2
 Requires-Dist: firebase-admin
 Requires-Dist: python-dateutil

{edx_ace-1.11.4.dist-info → edx_ace-1.12.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-edx_ace/__init__.py,sha256=G-qIKxlqAqzy9u_msaKLkPFJqCvqVgw0ose1zPyN15s,636
+edx_ace/__init__.py,sha256=8Te55LBdi7YPJOeNm5m6rlR0mkXoxjvd8w6JDfYwTMc,636
 edx_ace/ace.py,sha256=0nP8zvIWiME4qmpMT1PaV4nRDG6YR9Dxm7A6FGoBa8I,2501
 edx_ace/apps.py,sha256=xNedkdW6TNpm-W1uxnj3Vre2R1akkh2n_7DkSfKXmAk,216
 edx_ace/delivery.py,sha256=zo5lNHngycEn0tu-e3JM26njRVmaAttAH3D5ohz_468,2812
@@ -6,14 +6,15 @@ edx_ace/errors.py,sha256=y0MqT55qXLkpn_r5LVhHcYuU2-zHs56CQTAbNCqb72k,1065
 edx_ace/message.py,sha256=lhmPor9vnaLvC4NPyRgB-obpGjGv9Lni0obcOUTgyCg,8340
 edx_ace/monitoring.py,sha256=6nEcAJMCr9keCTJw9JjGecTg_J1ubcGJfuGiFq2B8G4,257
 edx_ace/policy.py,sha256=Zi0oupnmvgnW7jOkEpgsOd-gj6isR-3Mna2SxsdG4U8,2915
-edx_ace/presentation.py,sha256=XCQwPsl_2LZMcyF_aFX7b91d7rEzmQJiv8XgOSCyLQ0,838
+edx_ace/presentation.py,sha256=o_BbUOzNxBqmcGHIq0PAhxouDo3cVaEnn7uJGCK9y4o,909
 edx_ace/recipient.py,sha256=ogZjjKorAc6yiqvcnXcAMsHz2uAfhYU5qLPUoifofXQ,576
 edx_ace/recipient_resolver.py,sha256=ChY0cgLSt_HioKSHyuCh7iHSJOsBWuivsOvAc6QyedE,959
-edx_ace/renderers.py,sha256=eJcTWyRhny-3PLHDV4Rozk1TJ0fjsqgOcFOWO_TTngk,3143
+edx_ace/renderers.py,sha256=f1bPdmWpBvMa9OCPsq0NgnxsZi2Y4gwW5ZcYk9Qmpsw,3499
 edx_ace/serialization.py,sha256=EptnQqbI9j5kVqdUDAlm2pcm3dUsFwsP9tAji3y5uqc,3775
 edx_ace/signals.py,sha256=7kwpw7SgpPP6TRTtTQeGEOZ2cD_AcD4sSrpVxd_a19w,160
-edx_ace/channel/__init__.py,sha256=bQ8rpb_o0CvyWxZjOkmU9Au2S4kUCeKM8upvUb3yG7g,7030
+edx_ace/channel/__init__.py,sha256=PzfSJhBbsW5a8r1NnMm5q1PhwSadSoeIehjhU-C88pM,7221
 edx_ace/channel/braze.py,sha256=k-R9jZpiBQTV0FQ3Z2gOipVgxNpBMPSLBL71muh9go4,10240
+edx_ace/channel/braze_push_notification.py,sha256=XzFARmDotqthpARqvdvmcUy-ieEzusY-pH449nuciM4,2239
 edx_ace/channel/django_email.py,sha256=9TNdiFJ2U3QjKEriUl3_9twAFkH-E2EmrWujStUOWN0,2174
 edx_ace/channel/file.py,sha256=_Jx8o5Cw8IpEdaF7g-ljF7CEqswBHmuwyupm_tkI2wk,3028
 edx_ace/channel/mixins.py,sha256=kmSBFcBU2OhMqlzaDZPrZpT3lh6ccte0cQeCCvo8FNc,1313
@@ -26,9 +27,10 @@ edx_ace/tests/test_ace.py,sha256=H5ss4ah-v5XDJ47udl6Ob6iSVdcX0qkjPI2h0kgWp1k,327
 edx_ace/tests/test_date.py,sha256=RteoiCrc269BXnIerrtz8I0K1weldZ_Qg9Oc0Nd8ixs,639
 edx_ace/tests/test_delivery.py,sha256=6nTSm3y28U0J0ChfduVPxkRyMA-IVEZ9H8TkmSHktAI,5787
 edx_ace/tests/test_message.py,sha256=uAf3XltW605WieNGdi0u5p6bY_oSqLsmV5pHU3J_TiQ,4430
-edx_ace/tests/test_policy.py,sha256=T6Mm_q1Bi935WMBPS7sK5XbXM5izQ3y0KW0yiaQ5_GU,1597
+edx_ace/tests/test_policy.py,sha256=bksNJntzD7YXaVx95LCR4n9uyxAfugXlen3HElUHsaU,1791
 edx_ace/tests/test_presentation.py,sha256=elgVz_sR04h3KKs73G0qQBzt0CazOPWKrDF2rVC_R4U,541
 edx_ace/tests/channel/test_braze.py,sha256=J7p9_xF5NTzZDC-9P8aFsV3cLc2RyDMBNVlyimwORuU,7296
+edx_ace/tests/channel/test_braze_push_notification.py,sha256=1BhDIOjuCnZCjKWTy3jpf7978SyeLSv0xJqZ1Av-DXU,4241
 edx_ace/tests/channel/test_channel_helpers.py,sha256=QwzHhdpEGkdW_WV0bfLkj8nBzHy4zFoo_lsIVlN31QU,3196
 edx_ace/tests/channel/test_django_email.py,sha256=FCllUVAAtGEtDsosU-auf7zOApk-12oM_xWYs7CqVn8,4114
 edx_ace/tests/channel/test_file_email.py,sha256=0kWb5xhdHJMgMNrnlEM2QV4NFLZERWgRU-3Lx0MQxLM,1795
@@ -36,15 +38,17 @@ edx_ace/tests/channel/test_push_notification.py,sha256=u6BBplfPwQLMRL02VFlWlNDEw
 edx_ace/tests/channel/test_sailthru.py,sha256=Hfs-v2y9N9H2u0LlA_cJkhcuU0iC02wzwTt4pHsRS7o,3197
 edx_ace/tests/test_templates/testapp/edx_ace/testmessage/email/body.html,sha256=gDeXQeQFnC2EFzdJ-OwWL7yDdkiR42sUYIxyeJJUD9s,646
 edx_ace/tests/test_templates/testapp/edx_ace/testmessage/email/head.html,sha256=XvxX2Go_eKUtG0Oo1qPPMOtdS2IoGi7PSY98Di_Ev3s,19
+edx_ace/tests/utils/test_braze_utils.py,sha256=aywPWmpnhUqSToWPiKMpduAyVojZ_s1ZeKzR3oSLu-o,1899
 edx_ace/tests/utils/test_signals.py,sha256=k0F76oxcnECd95MeGw666YD3d2z-mIx4AS_MTYjwY5Q,1513
 edx_ace/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+edx_ace/utils/braze.py,sha256=I0CcJELYkbfMTI3EWGkb8-unxO3Wkxu6C1GHA93H_0Y,622
 edx_ace/utils/date.py,sha256=Rmz3RAUCdd30hu1qcKH7FmAypaw1aSoZg-yfZig1c8A,1483
 edx_ace/utils/once.py,sha256=sY3szBh3gvvAjrKbKq4S2mCejompjh5YcYD7XOhzjGU,2024
 edx_ace/utils/plugins.py,sha256=U-l-eU2uWUiiwYV-H-2DfmwjoksqskAsYwS7QnThy2Q,2090
 edx_ace/utils/signals.py,sha256=efmnxI78juMLo6PJkPyfJ6pYTMY3kHnGy-_IR8FsDm8,1637
-edx_ace-1.11.4.dist-info/LICENSE.txt,sha256=VrSJ4gO4NCpskzfNHbaTB4VcN9Q213YdcHbpOZSwcOA,35138
-edx_ace-1.11.4.dist-info/METADATA,sha256=l7cVBcI9N2pVQnjasjuU0P--O3ZIIClIbBeurI1NqvM,10039
-edx_ace-1.11.4.dist-info/WHEEL,sha256=Kh9pAotZVRFj97E15yTA4iADqXdQfIVTHcNaZTjxeGM,110
-edx_ace-1.11.4.dist-info/entry_points.txt,sha256=hvoHnxCJGiV3KDdVi9YKPCCsub5O__3Q4dbVpTGPJoY,331
-edx_ace-1.11.4.dist-info/top_level.txt,sha256=5eg_80KI88VkeiCVqZUqcYcc_PfPOg8o1GA4HxsiRU8,8
-edx_ace-1.11.4.dist-info/RECORD,,
+edx_ace-1.12.1.dist-info/LICENSE.txt,sha256=VrSJ4gO4NCpskzfNHbaTB4VcN9Q213YdcHbpOZSwcOA,35138
+edx_ace-1.12.1.dist-info/METADATA,sha256=yc-FIlMAsN3VbiKOjkSCaG62Q6fVla9s31OZEpm1ZzA,10078
+edx_ace-1.12.1.dist-info/WHEEL,sha256=Kh9pAotZVRFj97E15yTA4iADqXdQfIVTHcNaZTjxeGM,110
+edx_ace-1.12.1.dist-info/entry_points.txt,sha256=9jbgYKntqyu4kP1pI_Js1BSWqKBG7OacftVn1BAKsLI,413
+edx_ace-1.12.1.dist-info/top_level.txt,sha256=5eg_80KI88VkeiCVqZUqcYcc_PfPOg8o1GA4HxsiRU8,8
+edx_ace-1.12.1.dist-info/RECORD,,

{edx_ace-1.11.4.dist-info → edx_ace-1.12.1.dist-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