Skip to content

SeamWebhook: normalize headers before passing to svix + add docstrings #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-balitskyi merged 13 commits into from
Jul 12, 2024
Merged

SeamWebhook: normalize headers before passing to svix + add docstrings #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b7b8020
Normalize headers to lowercase keys before passing to svix
andrii-balitskyi Jul 10, 2024
d8e484c
docs: Add docstrings to SeamWebhook class
andrii-balitskyi Jul 10, 2024
d054cf7
ci: Format code
seambot Jul 10, 2024
9503805
Update seam/seam_webhook.py
andrii-balitskyi Jul 11, 2024
2782edd
Update SeamWebhook dosctring and import
andrii-balitskyi Jul 11, 2024
f552f67
Export WebhookVerificationError
andrii-balitskyi Jul 11, 2024
8847438
Update SeamWebhook docstrings
andrii-balitskyi Jul 11, 2024
4a0fa87
Update seam/seam_webhook.py
andrii-balitskyi Jul 12, 2024
18294d9
Update seam/seam_webhook.py
andrii-balitskyi Jul 12, 2024
9c4a565
Update seam/seam_webhook.py
andrii-balitskyi Jul 12, 2024
16beac1
Alias WebhookVerificationError to SeamWebhookVerificationError
andrii-balitskyi Jul 12, 2024
95df0a8
Fix typo
andrii-balitskyi Jul 12, 2024
92e1409
Merge branch 'main' into normalize-webhook-headers
andrii-balitskyi Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions seam/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@
SeamActionAttemptTimeoutError,
)
from .seam_webhook import SeamWebhook
from svix.webhooks import WebhookVerificationError as SeamWebhookVerificationError
24 changes: 22 additions & 2 deletions seam/seam_webhook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,33 @@
from typing import Dict
from svix import Webhook
from svix.webhooks import Webhook
from .routes.models import SeamEvent


class SeamWebhook:
"""Verifies and parses incoming Seam webhook events using the Svix library."""

def __init__(self, secret: str):
"""
:param secret: The secret key used for webhook verification.
:type secret: str
"""
self._webhook = Webhook(secret)

def verify(self, payload: str, headers: Dict[str, str]) -> SeamEvent:
res = self._webhook.verify(payload, headers)
"""Verify and parse an incoming HTTP webhook request.

Normalizes the headers, verifies the payload using the Svix
Webhook instance, and returns a SeamEvent object.

:param payload: The raw HTTP request body.
:type payload: str
:param headers: The HTTP request headers.
:type headers: Dict[str, str]
:return: The SeamEvent object created from the verified payload.
:rtype: SeamEvent
:raises WebhookVerificationError: If the webhook signature verification fails.
"""
normalized_headers = {k.lower(): v for k, v in headers.items()}
res = self._webhook.verify(payload, normalized_headers)

return SeamEvent.from_dict(res)