clear-skies-aws 1.9.4__py3-none-any.whl → 1.9.6__py3-none-any.whl

{clear_skies_aws-1.9.4.dist-info → clear_skies_aws-1.9.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clear-skies-aws
-Version: 1.9.4
+Version: 1.9.6
 Summary: clearskies bindings for working in AWS
 Home-page: https://github.com/cmancone/clearskies-aws
 License: MIT

{clear_skies_aws-1.9.4.dist-info → clear_skies_aws-1.9.6.dist-info}/RECORD

@@ -1,5 +1,5 @@
 clearskies_aws/__init__.py,sha256=BZKL4SIyxx4MXpyP5hmwsMo2oJatyv5c2wjJOPzKBQ4,134
-clearskies_aws/actions/__init__.py,sha256=QEKR3TKEp7NWqhfz0g19Dv2v8KTTVewKi_3zeX_WyqI,2865
+clearskies_aws/actions/__init__.py,sha256=w_IWJg4UHV9Opv69zheH7ZHj1BnCzYLlm2JhFvHQCf8,2998
 clearskies_aws/actions/action_aws.py,sha256=hWYnYA0QNegWp2LDMYILs0Dk1TOsFykW5JgSEMwfDE8,3877
 clearskies_aws/actions/assume_role.py,sha256=tZHKMTQaImj_EAWormFZdIPkR_db7yBwOJxYaUyuGdA,4085
 clearskies_aws/actions/assume_role_test.py,sha256=MDMGePZLVyDNTjdAlGBDJzBlfMpGIpA3Q1Ur0qEPl1w,2450
@@ -7,8 +7,8 @@ clearskies_aws/actions/ses.py,sha256=iSo-dtQoreqOCveGpDAKWkbaa0gZx1xTymHYqlvL7hk
 clearskies_aws/actions/ses_test.py,sha256=lyNbqI46Ld_ZUKtWLgSwwfSOFksQ39H4hzPS3eTx7nk,3076
 clearskies_aws/actions/sns.py,sha256=m9LEoogTGGPr-u8oj39PIiOd9rkoF340nFbWefXJREA,2197
 clearskies_aws/actions/sns_test.py,sha256=iqlaZOA-0YHPOu52-XqpCIAgAv1JZodDdlm4YYYhj8U,2306
-clearskies_aws/actions/sqs.py,sha256=UZykBoi83EzzlqaPVdobZ8D_JRYqPFCwrCjWqg0ACzk,2340
-clearskies_aws/actions/sqs_test.py,sha256=Gsz1TxZDMlas6KS_splfs8cM75WeN5OKJeiddFHsARA,2346
+clearskies_aws/actions/sqs.py,sha256=3aY9plfYH8P6IkKS39C3t9q4ZIxIlNYsqtPgjdiywYQ,3338
+clearskies_aws/actions/sqs_test.py,sha256=aazVN-bY6E17Pu3hDwLldj6YPirbqXjM6LfYFomUVmQ,4040
 clearskies_aws/actions/step_function.py,sha256=0Sz1CVVeKJi3IohtLnnNmhAbuxR7Gl9ic56ml0K3Qmg,2363
 clearskies_aws/actions/step_function_test.py,sha256=3xrNYFQ8fCe3CqPEnVnJsE0rIUlnnFez4rfPzphYVUU,2742
 clearskies_aws/backends/__init__.py,sha256=kS6pmMKZuWzBefO7qQu1fkFdcXo180t76-a-pPc1YX8,83
@@ -61,7 +61,7 @@ clearskies_aws/secrets/parameter_store_test.py,sha256=UyqKE4AZYlldj9ww5f0fR15qsV
 clearskies_aws/secrets/secrets_manager.py,sha256=jlpfAFC23EeSpm50L8B-yrXg4IROQq-M_90zzXDp_ak,3056
 clearskies_aws/secrets/secrets_manager_test.py,sha256=mlNWtDm1wWS5C8aV0vJAzZVZB82KFR6NGRAPEkLtTyk,786
 clearskies_aws/web_socket_connection_model.py,sha256=d_Au_Pu7YXBfc7_lbuI7zz4MZ8ZOOwGM0oooppEofcI,1776
-clear_skies_aws-1.9.4.dist-info/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
-clear_skies_aws-1.9.4.dist-info/METADATA,sha256=jl5h5-AsvmXaQo6rwOA2yYsshSDdH8NQXw2l9VuqMqk,8480
-clear_skies_aws-1.9.4.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-clear_skies_aws-1.9.4.dist-info/RECORD,,
+clear_skies_aws-1.9.6.dist-info/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
+clear_skies_aws-1.9.6.dist-info/METADATA,sha256=9mOuyI9iqb6pIqU6K_3vg_wXNVxu63pkG6tsbnfZrcw,8480
+clear_skies_aws-1.9.6.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+clear_skies_aws-1.9.6.dist-info/RECORD,,

clearskies_aws/actions/__init__.py

@@ -1,6 +1,6 @@
 import clearskies
 
-from typing import Optional, Callable
+from typing import Optional, Callable, Union
 
 from .assume_role import AssumeRole
 from .ses import SES
@@ -57,9 +57,10 @@ def sqs(
     queue_url: str = '',
     queue_url_environment_key: str = '',
     queue_url_callable: Callable = '',
-    message_callable=None,
-    when=None,
+    message_callable: Callable = None,
+    when: Callable = None,
     assume_role=None,
+    message_group_id: Optional[Union[Callable, str]]=None,
 ):
     return clearskies.BindingConfig(
         SQS,
@@ -69,6 +70,7 @@ def sqs(
         message_callable=message_callable,
         when=when,
         assume_role=assume_role,
+        message_group_id=message_group_id,
     )
 def step_function(
     arn: str = "",

clearskies_aws/actions/sqs.py

@@ -8,7 +8,7 @@ from clearskies.model import Model
 from collections.abc import Sequence
 from collections import OrderedDict
 from types import ModuleType
-from typing import List, Optional, Callable
+from typing import List, Optional, Callable, Union
 
 from ..di import StandardDependencies
 from . import assume_role
@@ -28,12 +28,14 @@ class SQS(ActionAws):
         message_callable: Optional[Callable] = None,
         when: Optional[Callable] = None,
         assume_role: Optional[assume_role.AssumeRole] = None,
+        message_group_id: Optional[Union[str, Callable]] = None,
     ) -> None:
         super().configure(message_callable=message_callable, when=when, assume_role=assume_role)
 
         self.queue_url = queue_url
         self.queue_url_environment_key = queue_url_environment_key
         self.queue_url_callable = queue_url_callable
+        self.message_group_id = message_group_id
 
         queue_urls = 0
         for value in [queue_url, queue_url_environment_key, queue_url_callable]:
@@ -47,13 +49,28 @@ class SQS(ActionAws):
             raise ValueError(
                 "You must provide at least one of 'queue_url', 'queue_url_environment_key', or 'queue_url_callable'."
             )
+        if message_group_id and not callable(message_group_id) and not isinstance(message_group_id, str):
+            raise ValueError(
+                "If provided, 'message_group_id' must be a string or callable, but the provided value was neither."
+            )
 
     def _execute_action(self, client: ModuleType, model: Model) -> None:
         """Send a notification as configured."""
-        client.send_message(
-            QueueUrl=self.get_queue_url(model),
-            MessageBody=self.get_message_body(model),
-        )
+        params = {
+            "QueueUrl": self.get_queue_url(model),
+            "MessageBody": self.get_message_body(model),
+        }
+
+        if self.message_group_id:
+            if callable(self.message_group_id):
+                message_group_id = self.di.call_function(self.message_group_id, model=model)
+                if not isinstance(message_group_id, str):
+                    raise ValueError(f"I called the message_group_id function for SQS for model '{model.__class__.__name__}' but the value it returned was not a string.  The message group id must be a string.")
+            else:
+                message_group_id = self.message_group_id
+            params["MessageGroupId"] = message_group_id
+
+        client.send_message(**params)
 
     def get_queue_url(self, model: Model):
         if self.queue_url:

clearskies_aws/actions/sqs_test.py

@@ -59,6 +59,58 @@ class SQSTest(unittest.TestCase):
         ])
         self.assertEqual(id(user), id(self.when))
 
+    def test_send_message_group_id(self):
+        sqs = SQS(self.environment, self.boto3, self.di)
+        sqs.configure(
+            queue_url='https://queue.example.com',
+            when=self.always,
+            message_group_id='heysup',
+        )
+        user = self.users.model({
+            "id": "1-2-3-4",
+            "name": "Jane",
+            "email": "jane@example.com",
+        })
+        sqs(user)
+        self.sqs.send_message.assert_has_calls([
+            call(
+                QueueUrl='https://queue.example.com',
+                MessageGroupId='heysup',
+                MessageBody=json.dumps({
+                    "id": "1-2-3-4",
+                    "name": "Jane",
+                    "email": "jane@example.com",
+                }),
+            ),
+        ])
+        self.assertEqual(id(user), id(self.when))
+
+    def test_send_message_group_id_callable(self):
+        sqs = SQS(self.environment, self.boto3, self.di)
+        sqs.configure(
+            queue_url='https://queue.example.com',
+            when=self.always,
+            message_group_id=lambda model: model.id,
+        )
+        user = self.users.model({
+            "id": "1-2-3-4",
+            "name": "Jane",
+            "email": "jane@example.com",
+        })
+        sqs(user)
+        self.sqs.send_message.assert_has_calls([
+            call(
+                QueueUrl='https://queue.example.com',
+                MessageGroupId='1-2-3-4',
+                MessageBody=json.dumps({
+                    "id": "1-2-3-4",
+                    "name": "Jane",
+                    "email": "jane@example.com",
+                }),
+            ),
+        ])
+        self.assertEqual(id(user), id(self.when))
+
     def test_not_now(self):
         sqs = SQS(self.environment, self.boto3, self.di)
         sqs.configure(