DEVX-10006: addig tests and implementation for RCS Create Calendar Event suggestion action

Author: superchilled

messages/src/vonage_messages/models/__init__.py

@@ -10,7 +10,22 @@
     MessengerVideo,
 )
 from .mms import MmsAudio, MmsImage, MmsResource, MmsVcard, MmsVideo
-from .rcs import RcsCustom, RcsFile, RcsImage, RcsResource, RcsText, RcsVideo, RcsSuggestionBase, RcsSuggestionReply, RcsSuggestionActionDial, RcsSuggestionActionViewLocation, RcsSuggestionActionShareLocation, RcsSuggestionActionOpenUrl, RcsSuggestionActionOpenUrlWebview
+from .rcs import (
+    RcsCustom,
+    RcsFile,
+    RcsImage,
+    RcsResource,
+    RcsText,
+    RcsVideo,
+    RcsSuggestionBase,
+    RcsSuggestionReply,
+    RcsSuggestionActionDial,
+    RcsSuggestionActionViewLocation,
+    RcsSuggestionActionShareLocation,
+    RcsSuggestionActionOpenUrl,
+    RcsSuggestionActionOpenUrlWebview,
+    RcsSuggestionActionCreateCalendarEvent,
+)
 from .sms import Sms, SmsOptions
 from .viber import (
     ViberAction,

messages/src/vonage_messages/models/enums.py

@@ -48,6 +48,7 @@ class SuggestionType(str, Enum):
     SHARE_LOCATION = 'share_location'
     OPEN_URL = 'open_url'
     OPEN_URL_IN_WEBVIEW = 'open_url_in_webview'
+    CREATE_CALENDAR_EVENT = 'create_calendar_event'
 
 
 class UrlWebviewViewMode(str, Enum):

messages/src/vonage_messages/models/rcs.py

@@ -110,6 +110,26 @@ class RcsSuggestionActionOpenUrlWebview(RcsSuggestionActionOpenUrl):
     type_: SuggestionType = Field(SuggestionType.OPEN_URL_IN_WEBVIEW, serialization_alias='type')
     view_mode: Optional[UrlWebviewViewMode] = None
 
+class RcsSuggestionActionCreateCalendarEvent(RcsSuggestionBase):
+    """Model for a create calendar event action suggestion in an RCS message.
+
+    Args:
+        text (str): The text to display on the suggestion chip.
+        postback_data (str): The data that will be sent via the Inbound Message webhook when the suggestion is selected.
+        start_time (str): The start time of the calendar event in ISO 8601 format.
+        end_time (str): The end time of the calendar event in ISO 8601 format
+        title (str): The title of the calendar event.
+        description (str): The description of the calendar event.
+        fallback_url (str, Optional): The URL to open if the device doesn't support the create calendar event action.
+    """
+
+    type_: SuggestionType = Field(SuggestionType.CREATE_CALENDAR_EVENT, serialization_alias='type')
+    start_time: str
+    end_time: str
+    title: str = Field(..., min_length=1, max_length=100)
+    description: str = Field(..., min_length=1, max_length=500)
+    fallback_url: Optional[str] = None
+
 
 class BaseRcs(BaseMessage):
     """Model for a base RCS message.

messages/tests/test_rcs_models.py

@@ -14,6 +14,7 @@
     RcsSuggestionActionShareLocation,
     RcsSuggestionActionOpenUrl,
     RcsSuggestionActionOpenUrlWebview,
+    RcsSuggestionActionCreateCalendarEvent,
 )
 
 
@@ -391,7 +392,6 @@ def test_rcs_suggestion_action_open_url_in_webview():
     assert suggestion.model_dump(by_alias=True, exclude_none=True) == suggestion_dict
 
 
-# @pytest.mark.skip(reason="Not yet implemented")
 def test_rcs_suggestion_action_open_url_in_webview_without_url():
     with pytest.raises(ValidationError) as err:
         suggestion = RcsSuggestionActionOpenUrlWebview(
@@ -402,7 +402,6 @@ def test_rcs_suggestion_action_open_url_in_webview_without_url():
     assert "Field required" in str(err.value)
 
 
-# @pytest.mark.skip(reason="Not yet implemented")
 def test_rcs_suggestion_action_open_url_in_webview_without_description():
     with pytest.raises(ValidationError) as err:
         suggestion = RcsSuggestionActionOpenUrlWebview(
@@ -413,7 +412,6 @@ def test_rcs_suggestion_action_open_url_in_webview_without_description():
     assert "Field required" in str(err.value)
 
 
-# @pytest.mark.skip(reason="Not yet implemented")
 def test_rcs_suggestion_action_open_url_in_webview_with_description_too_short():
     with pytest.raises(ValidationError) as err:
         suggestion = RcsSuggestionActionOpenUrlWebview(
@@ -425,7 +423,6 @@ def test_rcs_suggestion_action_open_url_in_webview_with_description_too_short():
     assert "String should have at least 1 character" in str(err.value)
 
 
-# @pytest.mark.skip(reason="Not yet implemented")
 def test_rcs_suggestion_action_open_url_in_webview_with_description_too_long():
     with pytest.raises(ValidationError) as err:
         suggestion = RcsSuggestionActionOpenUrlWebview(
@@ -447,3 +444,126 @@ def test_rcs_suggestion_action_open_url_in_webview_with_invalid_view_mode():
             view_mode='INVALID_VIEW_MODE',
         )
     assert "Input should be 'FULL', 'TALL' or 'HALF'" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event():
+    suggestion = RcsSuggestionActionCreateCalendarEvent(
+        text='Add to calendar',
+        postback_data='postback-data',
+        start_time='2024-01-01T12:00:00Z',
+        end_time='2024-01-01T13:00:00Z',
+        title='Meeting with Bob',
+        description='Discuss project updates',
+        fallback_url='https://example.com/calendar-event',
+    )
+    suggestion_dict = {
+        'type': 'create_calendar_event',
+        'text': 'Add to calendar',
+        'postback_data': 'postback-data',
+        'start_time': '2024-01-01T12:00:00Z',
+        'end_time': '2024-01-01T13:00:00Z',
+        'title': 'Meeting with Bob',
+        'description': 'Discuss project updates',
+        'fallback_url': 'https://example.com/calendar-event',
+    }
+    assert suggestion.model_dump(by_alias=True, exclude_none=True) == suggestion_dict
+
+
+def test_rcs_suggestion_action_create_calendar_event_without_start_time():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            end_time='2024-01-01T13:00:00Z',
+            title='Meeting with Bob',
+            description='Discuss project updates',
+        )
+    assert "Field required" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_without_end_time():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            title='Meeting with Bob',
+            description='Discuss project updates',
+        )
+    assert "Field required" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_without_title():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            end_time='2024-01-01T13:00:00Z',
+            description='Discuss project updates',
+        )
+    assert "Field required" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_without_description():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            end_time='2024-01-01T13:00:00Z',
+            title='Meeting with Bob',
+        )
+    assert "Field required" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_with_title_too_short():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            end_time='2024-01-01T13:00:00Z',
+            title='',
+            description='Discuss project updates',
+        )
+    assert "String should have at least 1 character" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_with_title_too_long():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            end_time='2024-01-01T13:00:00Z',
+            title='A' * 100 + 'B',
+            description='Discuss project updates',
+        )
+    assert "String should have at most 100 characters" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_with_description_too_short():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            end_time='2024-01-01T13:00:00Z',
+            title='Meeting with Bob',
+            description='',
+        )
+    assert "String should have at least 1 character" in str(err.value)
+
+
+def test_rcs_suggestion_action_create_calendar_event_with_description_too_long():
+    with pytest.raises(ValidationError) as err:
+        suggestion = RcsSuggestionActionCreateCalendarEvent(
+            text='Add to calendar',
+            postback_data='postback-data',
+            start_time='2024-01-01T12:00:00Z',
+            end_time='2024-01-01T13:00:00Z',
+            title='Meeting with Bob',
+            description='A' * 500 + 'B',
+        )
+    assert "String should have at most 500 characters" in str(err.value)