edx-ace 1.10.1__py2.py3-none-any.whl → 1.11.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.10.1'
+__version__ = '1.11.1'
 
 
 __all__ = [

edx_ace/delivery.py

@@ -10,6 +10,7 @@ import time
 from django.conf import settings
 
 from edx_ace.errors import RecoverableChannelDeliveryError
+from edx_ace.signals import ACE_MESSAGE_SENT
 from edx_ace.utils.date import get_current_time
 
 LOG = logging.getLogger(__name__)
@@ -60,6 +61,7 @@ def deliver(channel, rendered_message, message):
             message.report(f'{channel_type}_delivery_retried', num_seconds)
         else:
             message.report(f'{channel_type}_delivery_succeeded', True)
+            ACE_MESSAGE_SENT.send(sender=channel, message=message)
             return
 
     delivery_expired_report = f'{channel_type}_delivery_expired'

edx_ace/signals.py

@@ -0,0 +1,7 @@
+"""
+Signals for the edx_ace app
+"""
+from django.dispatch import Signal
+
+# signal to indicate that a message has been sent using ace
+ACE_MESSAGE_SENT = Signal()

edx_ace/tests/test_delivery.py

@@ -34,21 +34,26 @@ class TestDelivery(TestCase):  # pylint: disable=missing-class-docstring
         )
         self.current_time = datetime.datetime.utcnow().replace(tzinfo=tzutc())
 
-    def test_happy_path(self):
+    @patch('edx_ace.delivery.ACE_MESSAGE_SENT.send')
+    def test_happy_path(self, mock_ace_message_sent):
         deliver(self.mock_channel, sentinel.rendered_email, self.message)
         self.mock_channel.deliver.assert_called_once_with(self.message, sentinel.rendered_email)
+        # check if ACE_MESSAGE_SENT is raised
+        mock_ace_message_sent.assert_called_once_with(sender=self.mock_channel, message=self.message)
 
     def test_fatal_error(self):
         self.mock_channel.deliver.side_effect = FatalChannelDeliveryError('testing')
         with self.assertRaises(FatalChannelDeliveryError):
             deliver(self.mock_channel, sentinel.rendered_email, self.message)
 
+    @patch('edx_ace.delivery.ACE_MESSAGE_SENT.send')
     @patch('edx_ace.delivery.get_current_time')
-    def test_custom_message_expiration(self, mock_get_current_time):
+    def test_custom_message_expiration(self, mock_get_current_time, mock_ace_message_sent):
         self.message.expiration_time = self.current_time - datetime.timedelta(seconds=10)
         mock_get_current_time.return_value = self.current_time
         deliver(self.mock_channel, sentinel.rendered_email, self.message)
         assert not self.mock_channel.deliver.called
+        mock_ace_message_sent.assert_not_called()
 
     @patch('edx_ace.delivery.time')
     @patch('edx_ace.delivery.get_current_time')
@@ -100,3 +105,16 @@ class TestDelivery(TestCase):  # pylint: disable=missing-class-docstring
         deliver(self.mock_channel, sentinel.rendered_email, self.message)
         assert mock_time.sleep.call_args_list == [call(1), call(1)]
         assert self.mock_channel.deliver.call_count == 3
+
+    @patch('edx_ace.delivery.ACE_MESSAGE_SENT.send')
+    def test_message_sent_signal_for_push_channel(self, mock_ace_message_sent):
+        """
+        Test that ACE_MESSAGE_SENT signal is sent when a message is delivered to a push channel.
+        """
+        mock_push_channel = Mock(
+            name='push_channel',
+            channel_type=ChannelType.PUSH
+        )
+        deliver(mock_push_channel, sentinel.rendered_email, self.message)
+        # check if ACE_MESSAGE_SENT is raised
+        mock_ace_message_sent.assert_called_once_with(sender=mock_push_channel, message=self.message)

{edx_ace-1.10.1.dist-info → edx_ace-1.11.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-ace
-Version: 1.10.1
+Version: 1.11.1
 Summary: Framework for Messaging
 Home-page: https://github.com/openedx/edx-ace
 Author: edX
@@ -18,19 +18,19 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/x-rst
-Requires-Dist: Django >=2.2
-Requires-Dist: attrs >=17.2.0
+Requires-Dist: Django>=2.2
+Requires-Dist: attrs>=17.2.0
 Requires-Dist: django-push-notifications
-Requires-Dist: edx-django-utils >=5.14.2
+Requires-Dist: edx-django-utils>=5.14.2
 Requires-Dist: firebase-admin
 Requires-Dist: python-dateutil
-Requires-Dist: sailthru-client ==2.2.3
+Requires-Dist: sailthru-client==2.2.3
 Requires-Dist: six
-Requires-Dist: stevedore >=1.10.0
+Requires-Dist: stevedore>=1.10.0
 Provides-Extra: push_notifications
-Requires-Dist: django-push-notifications[fcm] ; extra == 'push_notifications'
+Requires-Dist: django-push-notifications[fcm]; extra == "push-notifications"
 Provides-Extra: sailthru
-Requires-Dist: sailthru-client <2.3,>2.2 ; extra == 'sailthru'
+Requires-Dist: sailthru-client<2.3,>2.2; extra == "sailthru"
 
 edX Automated Communication Engine (A.C.E.)
 ###########################################

{edx_ace-1.10.1.dist-info → edx_ace-1.11.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
-edx_ace/__init__.py,sha256=BEI_2W_-VD3LcjFTXuez9y9Mk05167aQI7kLCvVbvFs,636
+edx_ace/__init__.py,sha256=NNRZBB6kXsBqSeXn-kM6K_JUeSKuKmsOrDq7zJFW1ec,636
 edx_ace/ace.py,sha256=0nP8zvIWiME4qmpMT1PaV4nRDG6YR9Dxm7A6FGoBa8I,2501
 edx_ace/apps.py,sha256=xNedkdW6TNpm-W1uxnj3Vre2R1akkh2n_7DkSfKXmAk,216
-edx_ace/delivery.py,sha256=Tjc3GKubPaDsbKiBXO2jQBz9ursJ3nb7ZgZNSEeuqWQ,2690
+edx_ace/delivery.py,sha256=m_IOo4HTuuMZ61OOBZCA_TgLcfrME8BidWDutJmnaY0,2802
 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
@@ -11,6 +11,7 @@ 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/serialization.py,sha256=EptnQqbI9j5kVqdUDAlm2pcm3dUsFwsP9tAji3y5uqc,3775
+edx_ace/signals.py,sha256=7kwpw7SgpPP6TRTtTQeGEOZ2cD_AcD4sSrpVxd_a19w,160
 edx_ace/channel/__init__.py,sha256=l2qZdiQb2HFsMixWjqf50-si7aGr06M2MvEYc7XayjU,6890
 edx_ace/channel/braze.py,sha256=k-R9jZpiBQTV0FQ3Z2gOipVgxNpBMPSLBL71muh9go4,10240
 edx_ace/channel/django_email.py,sha256=9TNdiFJ2U3QjKEriUl3_9twAFkH-E2EmrWujStUOWN0,2174
@@ -23,7 +24,7 @@ edx_ace/templatetags/acetags.py,sha256=CFVLb1j7oCN0mNNOpjaUHqQBEGlYZyRUgbYr9vS-S
 edx_ace/test_utils/__init__.py,sha256=HfJqvOqVNFS0dMpj4TnnXrTWHO8nutRFdA1Qja7ktfY,1087
 edx_ace/tests/test_ace.py,sha256=H5ss4ah-v5XDJ47udl6Ob6iSVdcX0qkjPI2h0kgWp1k,3278
 edx_ace/tests/test_date.py,sha256=RteoiCrc269BXnIerrtz8I0K1weldZ_Qg9Oc0Nd8ixs,639
-edx_ace/tests/test_delivery.py,sha256=2y65-C3ED0A2j-pA553LWvSwNHNeio8h28JKQKrxi74,4850
+edx_ace/tests/test_delivery.py,sha256=0NYvFRWWcbEIdv5LE17EdYYcf9SE5g7mspC8poqPpNQ,5796
 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_presentation.py,sha256=elgVz_sR04h3KKs73G0qQBzt0CazOPWKrDF2rVC_R4U,541
@@ -39,9 +40,9 @@ edx_ace/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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-1.10.1.dist-info/LICENSE.txt,sha256=VrSJ4gO4NCpskzfNHbaTB4VcN9Q213YdcHbpOZSwcOA,35138
-edx_ace-1.10.1.dist-info/METADATA,sha256=U9p9FHLUjRfe1d8AjDfeIx0l5kshf10SToG_82-mAfo,10114
-edx_ace-1.10.1.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-edx_ace-1.10.1.dist-info/entry_points.txt,sha256=fiR8u0PqGyp2qIiJxcSrYhIZ3gEwl0vIMnTPWegXwRI,332
-edx_ace-1.10.1.dist-info/top_level.txt,sha256=5eg_80KI88VkeiCVqZUqcYcc_PfPOg8o1GA4HxsiRU8,8
-edx_ace-1.10.1.dist-info/RECORD,,
+edx_ace-1.11.1.dist-info/LICENSE.txt,sha256=VrSJ4gO4NCpskzfNHbaTB4VcN9Q213YdcHbpOZSwcOA,35138
+edx_ace-1.11.1.dist-info/METADATA,sha256=eTDhK8s6zluZDzmrBoanH8CN3hoVOqyVr8igrUydmi0,10106
+edx_ace-1.11.1.dist-info/WHEEL,sha256=fS9sRbCBHs7VFcwJLnLXN1MZRR0_TVTxvXKzOnaSFs8,110
+edx_ace-1.11.1.dist-info/entry_points.txt,sha256=fiR8u0PqGyp2qIiJxcSrYhIZ3gEwl0vIMnTPWegXwRI,332
+edx_ace-1.11.1.dist-info/top_level.txt,sha256=5eg_80KI88VkeiCVqZUqcYcc_PfPOg8o1GA4HxsiRU8,8
+edx_ace-1.11.1.dist-info/RECORD,,

{edx_ace-1.10.1.dist-info → edx_ace-1.11.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: bdist_wheel (0.44.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any