code review

Author: matsk-sinch

examples/sinch_events/README.md

@@ -34,7 +34,7 @@ This directory contains both the Event handlers and the server application (`ser
    ```
    NUMBERS_WEBHOOKS_SECRET=Your Sinch Numbers Webhook Secret
    ```
-     - SMS controller: To configure the `sms` webhooks secret, contact your account manager to enable authentication for SMS callbacks. For more details, refer to
+     - SMS controller: To configure the `sms` Sinch Event secret, contact your account manager to enable authentication for SMS callbacks. For more details, refer to
        [SMS API](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/section/Callbacks), 
 
    ```
@@ -108,6 +108,6 @@ Use this value to configure the Sinch Events URLs:
 
 You can also set these Sinch Events URLs in the Sinch dashboard; the API parameters above override the default values configured there.
 
-> **Note**: If you have set a webhook secret (e.g., `SMS_WEBHOOKS_SECRET`), the Sinch Event URL must be configured in the Sinch dashboard
-> and cannot be overridden via API parameters. The webhook secret is used to validate incoming webhook requests,
+> **Note**: If you have set a Sinch Event secret (e.g., `SMS_WEBHOOKS_SECRET`), the Sinch Event URL must be configured in the Sinch dashboard
+> and cannot be overridden via API parameters. The Sinch Event secret is used to validate incoming webhook requests,
 > and the URL associated with it must be set in the dashboard.

examples/sinch_events/server.py

@@ -18,7 +18,7 @@
 config = load_config()
 port = int(config.get('SERVER_PORT') or 3001)
 numbers_webhooks_secret = config.get('NUMBERS_WEBHOOKS_SECRET')
-sms_webhooks_secret = config.get('SMS_WEBHOOKS_SECRET')
+sms_sinch_event_secret = config.get('SMS_WEBHOOKS_SECRET')
 conversation_webhooks_secret = config.get('CONVERSATION_WEBHOOKS_SECRET')
 sinch_client = get_sinch_client(config)
 
@@ -27,7 +27,7 @@
 sinch_client.configuration.logger.setLevel(logging.INFO)
 
 numbers_controller = NumbersController(sinch_client, numbers_webhooks_secret)
-sms_controller = SmsController(sinch_client, sms_webhooks_secret)
+sms_controller = SmsController(sinch_client, sms_sinch_event_secret)
 conversation_controller = ConversationController(sinch_client, conversation_webhooks_secret or '')
 
 

examples/sinch_events/sms_api/controller.py

@@ -5,16 +5,16 @@
 
 
 class SmsController:
-    def __init__(self, sinch_client, webhooks_secret):
+    def __init__(self, sinch_client, sinch_event_secret):
         self.sinch_client = sinch_client
-        self.webhooks_secret = webhooks_secret
+        self.sinch_event_secret = sinch_event_secret
         self.logger = self.sinch_client.configuration.logger
 
     def sms_event(self):
         headers = dict(request.headers)
         raw_body = request.raw_body if request.raw_body else b""
 
-        sinch_events_service = self.sinch_client.sms.sinch_events(self.webhooks_secret)
+        sinch_events_service = self.sinch_client.sms.sinch_events(self.sinch_event_secret)
 
         # Signature headers may be absent unless your account manager enables them
         # (see README: Configuration -> Controller Settings -> SMS controller);

sinch/domains/sms/sinch_events/v1/events/sms_sinch_event.py

@@ -25,7 +25,7 @@ class MediaBody(SinchEvent):
     media: conlist(MediaItem) = Field(..., description="Array of media items")
 
 
-class BaseIncomingSMSWebhookEvent(SinchEvent):
+class BaseIncomingSMSSinchEvent(SinchEvent):
     from_: StrictStr = Field(
         ...,
         alias="from",
@@ -54,7 +54,7 @@ class BaseIncomingSMSWebhookEvent(SinchEvent):
     )
 
 
-class MOTextSinchEvent(BaseIncomingSMSWebhookEvent):
+class MOTextSinchEvent(BaseIncomingSMSSinchEvent):
     body: StrictStr = Field(
         ...,
         description="The incoming message body. Maximum 2000 characters.",
@@ -64,7 +64,7 @@ class MOTextSinchEvent(BaseIncomingSMSWebhookEvent):
     )
 
 
-class MOBinarySinchEvent(BaseIncomingSMSWebhookEvent):
+class MOBinarySinchEvent(BaseIncomingSMSSinchEvent):
     body: StrictStr = Field(
         ..., description="The incoming message body (Base64 encoded)."
     )
@@ -76,7 +76,7 @@ class MOBinarySinchEvent(BaseIncomingSMSWebhookEvent):
     )
 
 
-class MOMediaSinchEvent(BaseIncomingSMSWebhookEvent):
+class MOMediaSinchEvent(BaseIncomingSMSSinchEvent):
     body: MediaBody = Field(
         ...,
         description="The media message body containing subject, message, and media items.",
@@ -87,11 +87,11 @@ class MOMediaSinchEvent(BaseIncomingSMSWebhookEvent):
 
 
 # Union type for isinstance checks
-_IncomingSMSWebhookEventUnion = Union[
+_IncomingSMSSinchEventUnion = Union[
     MOTextSinchEvent, MOBinarySinchEvent, MOMediaSinchEvent
 ]
 
 # Discriminated union for validation
 IncomingSMSSinchEvent = Annotated[
-    _IncomingSMSWebhookEventUnion, Field(discriminator="type")
+    _IncomingSMSSinchEventUnion, Field(discriminator="type")
 ]

sinch/domains/sms/sinch_events/v1/sms_sinch_event.py

@@ -21,7 +21,7 @@
 )
 
 
-SmsCallback = Union[
+SmsSinchEventPayload = Union[
     BatchDeliveryReport,
     RecipientDeliveryReport,
     MOTextSinchEvent,
@@ -64,7 +64,7 @@ def parse_event(
         self,
         event_body: Union[str, bytes, Dict[str, Any]],
         headers: Optional[Dict[str, str]] = None,
-    ) -> SmsCallback:
+    ) -> SmsSinchEventPayload:
         """
         Parse the event payload into an SMS callback object.
 
@@ -75,8 +75,8 @@ def parse_event(
         :type event_body: Union[str, bytes, Dict[str, Any]]
         :param headers: Request headers (used to decode charset when event_body is bytes).
         :type headers: Optional[Dict[str, str]]
-        :returns: A parsed SMS callback object.
-        :rtype: SmsCallback
+        :returns: A parsed SMS Sinch Event payload object.
+        :rtype: SmsSinchEventPayload
         :raises ValueError: If the event type is unknown or parsing fails.
         """
         if isinstance(event_body, bytes):

sinch/domains/sms/sms.py

@@ -17,13 +17,13 @@ def __init__(self, sinch):
         self.batches = Batches(self._sinch)
         self.delivery_reports = DeliveryReports(self._sinch)
 
-    def sinch_events(self, callback_secret: str) -> SmsSinchEvent:
+    def sinch_events(self, sinch_event_secret: str) -> SmsSinchEvent:
         """
-        Create an SMS Sinch Events handler with the specified callback secret.
+        Create an SMS Sinch Events handler with the specified Sinch Event secret.
 
-        :param callback_secret: Secret used for webhook validation.
-        :type callback_secret: str
+        :param sinch_event_secret: Secret used for Sinch Event validation.
+        :type sinch_event_secret: str
         :returns: A configured Sinch Events handler
         :rtype: SmsSinchEvent
         """
-        return SmsSinchEvent(callback_secret)
+        return SmsSinchEvent(sinch_event_secret)

tests/e2e/sms/features/steps/webhooks.steps.py

@@ -11,25 +11,25 @@
 )
 from tests.e2e.helpers import store_webhook_response
 
-SINCH_SMS_CALLBACK_SECRET = 'KayakingTheSwell'
+SINCH_SMS_SINCH_EVENT_SECRET = 'KayakingTheSwell'
 
 
-@given('the SMS Webhooks handler is available')
+@given('the SMS Sinch Events handler is available')
 def step_webhook_handler_is_available(context):
-    context.sms_webhook = SmsSinchEvent(SINCH_SMS_CALLBACK_SECRET)
+    context.sms_sinch_event = SmsSinchEvent(SINCH_SMS_SINCH_EVENT_SECRET)
 
 
 @when('I send a request to trigger an "incoming SMS" event')
 def step_send_incoming_sms_event(context):
     response = requests.get('http://localhost:3017/webhooks/sms/incoming-sms')
     store_webhook_response(context, response)
-    context.event = context.sms_webhook.parse_event(context.raw_event)
+    context.event = context.sms_sinch_event.parse_event(context.raw_event)
 
 
 @then('the header of the event "{event_type}" contains a valid signature')
 @then('the header of the event "{event_type}" with the status "{status}" contains a valid signature')
 def step_check_valid_signature(context, event_type, status=None):
-    assert context.sms_webhook.validate_authentication_header(
+    assert context.sms_sinch_event.validate_authentication_header(
         context.webhook_headers, context.raw_event
     ), 'Signature validation failed'
 
@@ -51,7 +51,7 @@ def step_check_incoming_sms_event(context):
 def step_send_delivery_report_event(context):
     response = requests.get('http://localhost:3017/webhooks/sms/delivery-report-sms')
     store_webhook_response(context, response)
-    context.event = context.sms_webhook.parse_event(context.raw_event)
+    context.event = context.sms_sinch_event.parse_event(context.raw_event)
 
 
 @then('the SMS event describes an "SMS delivery report" event')
@@ -79,7 +79,7 @@ def step_send_recipient_delivery_report_event_delivered(context):
         'http://localhost:3017/webhooks/sms/recipient-delivery-report-sms-delivered'
     )
     store_webhook_response(context, response)
-    context.event = context.sms_webhook.parse_event(context.raw_event)
+    context.event = context.sms_sinch_event.parse_event(context.raw_event)
 
 
 @when('I send a request to trigger an "SMS recipient delivery report" event with the status "Aborted"')
@@ -88,7 +88,7 @@ def step_send_recipient_delivery_report_event_aborted(context):
         'http://localhost:3017/webhooks/sms/recipient-delivery-report-sms-aborted'
     )
     store_webhook_response(context, response)
-    context.event = context.sms_webhook.parse_event(context.raw_event)
+    context.event = context.sms_sinch_event.parse_event(context.raw_event)
 
 
 @then('the SMS event describes an SMS recipient delivery report event with the status "Delivered"')