Update messages api (#251)

* adding new viber channels

* adding new viber message types and tests

* adding tests for new viber action response

* add sticker as a whatsapp channel, add specific errors to validation tests, increase max client_ref value

* add new check for exclusive sticker dictionary keys

Author: maxkahan

src/vonage/messages.py

@@ -2,31 +2,32 @@
 
 import re
 
+
 class Messages:
     valid_message_channels = {'sms', 'mms', 'whatsapp', 'messenger', 'viber_service'}
     valid_message_types = {
         'sms': {'text'},
         'mms': {'image', 'vcard', 'audio', 'video'},
-        'whatsapp': {'text', 'image', 'audio', 'video', 'file', 'template', 'custom'},
+        'whatsapp': {'text', 'image', 'audio', 'video', 'file', 'template', 'sticker', 'custom'},
         'messenger': {'text', 'image', 'audio', 'video', 'file'},
-        'viber_service': {'text', 'image'}
+        'viber_service': {'text', 'image', 'video', 'file'},
     }
-    
+
     def __init__(self, client):
         self._client = client
         self._auth_type = 'jwt'
 
-    def send_message(self, params: dict):       
+    def send_message(self, params: dict):
         self.validate_send_message_input(params)
-        
+
         if not hasattr(self._client, '_application_id'):
-            self._auth_type='header'
+            self._auth_type = 'header'
         return self._client.post(
-            self._client.api_host(), 
+            self._client.api_host(),
             "/v1/messages",
-            params, 
+            params,
             auth_type=self._auth_type,
-            )
+        )
 
     def validate_send_message_input(self, params):
         self._check_input_is_dict(params)
@@ -36,24 +37,28 @@ def validate_send_message_input(self, params):
         self._check_valid_sender(params)
         self._channel_specific_checks(params)
         self._check_valid_client_ref(params)
-    
+
     def _check_input_is_dict(self, params):
         if type(params) is not dict:
             raise MessagesError('Parameters to the send_message method must be specified as a dictionary.')
 
     def _check_valid_message_channel(self, params):
         if params['channel'] not in Messages.valid_message_channels:
-            raise MessagesError(f"""
-            '{params['channel']}' is an invalid message channel. 
+            raise MessagesError(
+                f"""
+            "{params['channel']}" is an invalid message channel. 
             Must be one of the following types: {self.valid_message_channels}'
-            """)
+            """
+            )
 
     def _check_valid_message_type(self, params):
         if params['message_type'] not in self.valid_message_types[params['channel']]:
-            raise MessagesError(f"""
+            raise MessagesError(
+                f"""
                 "{params['message_type']}" is not a valid message type for channel "{params["channel"]}". 
                 Must be one of the following types: {self.valid_message_types[params["channel"]]}
-            """)
+            """
+            )
 
     def _check_valid_recipient(self, params):
         if not isinstance(params['to'], str):
@@ -65,20 +70,29 @@ def _check_valid_recipient(self, params):
 
     def _check_valid_sender(self, params):
         if not isinstance(params['from'], str) or params['from'] == "":
-            raise MessagesError(f'Message sender ("frm={params["from"]}") set incorrectly. Set a valid name or number for the sender.')
+            raise MessagesError(
+                f'Message sender ("frm={params["from"]}") set incorrectly. Set a valid name or number for the sender.'
+            )
 
     def _channel_specific_checks(self, params):
-        try:        
-            if params['channel'] == 'whatsapp' and params['message_type'] == 'template':
-                params['whatsapp']
-            if params['channel'] == 'viber_service':
-                params['viber_service']
-        except (KeyError, TypeError):
-            raise MessagesError(f'''You must specify all required properties for message channel "{params["channel"]}".''')
+        if (
+            (params['channel'] == 'whatsapp' and params['message_type'] == 'template' and 'whatsapp' not in params)
+            or (params['channel'] == 'whatsapp' and params['message_type'] == 'sticker' and 'sticker' not in params)
+            or (params['channel'] == 'viber_service' and 'viber_service' not in params)
+        ):
+            raise MessagesError(
+                f'''You must specify all required properties for message channel "{params["channel"]}".'''
+            )
+        elif params['channel'] == 'whatsapp' and params['message_type'] == 'sticker':
+            self._check_valid_whatsapp_sticker(params['sticker'])
 
     def _check_valid_client_ref(self, params):
         if 'client_ref' in params:
-            if len(params['client_ref']) <= 40:
+            if len(params['client_ref']) <= 100:
                 self._client_ref = params['client_ref']
             else:
-                raise MessagesError('client_ref can be a maximum of 40 characters.')
+                raise MessagesError('client_ref can be a maximum of 100 characters.')
+
+    def _check_valid_whatsapp_sticker(self, sticker):
+        if ('id' not in sticker and 'url' not in sticker) or ('id' in sticker and 'url' in sticker):
+            raise MessagesError('Must specify one, and only one, of "id" or "url" in the "sticker" field.')

tests/test_messages_send_message.py

@@ -1,15 +1,16 @@
 from util import *
 
+
 @responses.activate
 def test_send_sms_with_messages_api(messages, dummy_data):
     stub(responses.POST, 'https://api.nexmo.com/v1/messages')
 
     params = {
-        'channel': 'sms', 
-        'message_type': 'text', 
-        'to': '447123456789', 
+        'channel': 'sms',
+        'message_type': 'text',
+        'to': '447123456789',
         'from': 'Vonage',
-        'text': 'Hello from Vonage'
+        'text': 'Hello from Vonage',
     }
 
     assert isinstance(messages.send_message(params), dict)
@@ -18,21 +19,21 @@ def test_send_sms_with_messages_api(messages, dummy_data):
     assert b'"to": "447123456789"' in request_body()
     assert b'"text": "Hello from Vonage"' in request_body()
 
+
 @responses.activate
 def test_send_whatsapp_image_with_messages_api(messages, dummy_data):
     stub(responses.POST, 'https://api.nexmo.com/v1/messages')
 
     params = {
-        'channel': 'whatsapp', 
-        'message_type': 'image', 
-        'to': '447123456789', 
+        'channel': 'whatsapp',
+        'message_type': 'image',
+        'to': '447123456789',
         'from': '440123456789',
-        'image': {'url': 'https://example.com/image.jpg', 'caption': 'fake test image'}
+        'image': {'url': 'https://example.com/image.jpg', 'caption': 'fake test image'},
     }
 
     assert isinstance(messages.send_message(params), dict)
     assert request_user_agent() == dummy_data.user_agent
     assert b'"from": "440123456789"' in request_body()
     assert b'"to": "447123456789"' in request_body()
     assert b'"image": {"url": "https://example.com/image.jpg", "caption": "fake test image"}' in request_body()
-