Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions codegen/templates/events.py.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ class {{ .ClassName }}(FetchableEvent[{{ .ObjectType }}]):
"""

EVENT_TYPE: typing.ClassVar[str] = {{ printf "%q" .EventType }}
type: typing.Literal[{{ printf "%q" .EventType }}] = {{ printf "%q" .EventType }}
_object_type: typing.ClassVar[str] = {{ printf "%q" .ObjectKind }}
type: typing.Literal[{{ printf "%q" .EventType }}] = pydantic.Field(default={{ printf "%q" .EventType }}, frozen=True)
_object_type: typing.ClassVar[str | None] = {{ printf "%q" .ObjectKind }}
_response_model: typing.ClassVar[typing.Type[pydantic.BaseModel]] = {{ .ObjectType }}


Expand Down
4 changes: 2 additions & 2 deletions sumup/_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@ class EventNotification(pydantic.BaseModel):

Attributes:
id: Event identifier. Use it to recognize repeated deliveries.
type: Event name, such as "members.updated".
type: Read-only event name, such as "members.updated".
created_at: Time the event was created, as a timezone-aware datetime.
Signature verification checks the header's signing timestamp instead.
object: Reference to the associated API resource.
"""

id: _NonemptyString
type: _NonemptyString
type: _NonemptyString = pydantic.Field(frozen=True)
created_at: pydantic.AwareDatetime
object: EventObject

Expand Down
60 changes: 34 additions & 26 deletions sumup/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ class CheckoutCreatedEvent(FetchableEvent[Checkout]):
"""

EVENT_TYPE: typing.ClassVar[str] = "checkouts.created"
type: typing.Literal["checkouts.created"] = "checkouts.created"
_object_type: typing.ClassVar[str] = "checkout"
type: typing.Literal["checkouts.created"] = pydantic.Field(
default="checkouts.created", frozen=True
)
_object_type: typing.ClassVar[str | None] = "checkout"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Checkout


Expand All @@ -59,8 +61,10 @@ class CheckoutExpiredEvent(FetchableEvent[Checkout]):
"""

EVENT_TYPE: typing.ClassVar[str] = "checkouts.expired"
type: typing.Literal["checkouts.expired"] = "checkouts.expired"
_object_type: typing.ClassVar[str] = "checkout"
type: typing.Literal["checkouts.expired"] = pydantic.Field(
default="checkouts.expired", frozen=True
)
_object_type: typing.ClassVar[str | None] = "checkout"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Checkout


Expand All @@ -73,8 +77,10 @@ class CheckoutFailedEvent(FetchableEvent[Checkout]):
"""

EVENT_TYPE: typing.ClassVar[str] = "checkouts.failed"
type: typing.Literal["checkouts.failed"] = "checkouts.failed"
_object_type: typing.ClassVar[str] = "checkout"
type: typing.Literal["checkouts.failed"] = pydantic.Field(
default="checkouts.failed", frozen=True
)
_object_type: typing.ClassVar[str | None] = "checkout"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Checkout


Expand All @@ -87,8 +93,8 @@ class CheckoutPaidEvent(FetchableEvent[Checkout]):
"""

EVENT_TYPE: typing.ClassVar[str] = "checkouts.paid"
type: typing.Literal["checkouts.paid"] = "checkouts.paid"
_object_type: typing.ClassVar[str] = "checkout"
type: typing.Literal["checkouts.paid"] = pydantic.Field(default="checkouts.paid", frozen=True)
_object_type: typing.ClassVar[str | None] = "checkout"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Checkout


Expand All @@ -101,8 +107,10 @@ class CheckoutUpdatedEvent(FetchableEvent[Checkout]):
"""

EVENT_TYPE: typing.ClassVar[str] = "checkouts.updated"
type: typing.Literal["checkouts.updated"] = "checkouts.updated"
_object_type: typing.ClassVar[str] = "checkout"
type: typing.Literal["checkouts.updated"] = pydantic.Field(
default="checkouts.updated", frozen=True
)
_object_type: typing.ClassVar[str | None] = "checkout"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Checkout


Expand All @@ -115,8 +123,8 @@ class MemberCreatedEvent(FetchableEvent[Member]):
"""

EVENT_TYPE: typing.ClassVar[str] = "members.created"
type: typing.Literal["members.created"] = "members.created"
_object_type: typing.ClassVar[str] = "member"
type: typing.Literal["members.created"] = pydantic.Field(default="members.created", frozen=True)
_object_type: typing.ClassVar[str | None] = "member"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Member


Expand All @@ -129,8 +137,8 @@ class MemberDeletedEvent(FetchableEvent[Member]):
"""

EVENT_TYPE: typing.ClassVar[str] = "members.deleted"
type: typing.Literal["members.deleted"] = "members.deleted"
_object_type: typing.ClassVar[str] = "member"
type: typing.Literal["members.deleted"] = pydantic.Field(default="members.deleted", frozen=True)
_object_type: typing.ClassVar[str | None] = "member"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Member


Expand All @@ -143,8 +151,8 @@ class MemberUpdatedEvent(FetchableEvent[Member]):
"""

EVENT_TYPE: typing.ClassVar[str] = "members.updated"
type: typing.Literal["members.updated"] = "members.updated"
_object_type: typing.ClassVar[str] = "member"
type: typing.Literal["members.updated"] = pydantic.Field(default="members.updated", frozen=True)
_object_type: typing.ClassVar[str | None] = "member"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Member


Expand All @@ -157,8 +165,8 @@ class ReaderCreatedEvent(FetchableEvent[Reader]):
"""

EVENT_TYPE: typing.ClassVar[str] = "readers.created"
type: typing.Literal["readers.created"] = "readers.created"
_object_type: typing.ClassVar[str] = "reader"
type: typing.Literal["readers.created"] = pydantic.Field(default="readers.created", frozen=True)
_object_type: typing.ClassVar[str | None] = "reader"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Reader


Expand All @@ -171,8 +179,8 @@ class ReaderDeletedEvent(FetchableEvent[Reader]):
"""

EVENT_TYPE: typing.ClassVar[str] = "readers.deleted"
type: typing.Literal["readers.deleted"] = "readers.deleted"
_object_type: typing.ClassVar[str] = "reader"
type: typing.Literal["readers.deleted"] = pydantic.Field(default="readers.deleted", frozen=True)
_object_type: typing.ClassVar[str | None] = "reader"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Reader


Expand All @@ -185,8 +193,8 @@ class RoleCreatedEvent(FetchableEvent[Role]):
"""

EVENT_TYPE: typing.ClassVar[str] = "roles.created"
type: typing.Literal["roles.created"] = "roles.created"
_object_type: typing.ClassVar[str] = "role"
type: typing.Literal["roles.created"] = pydantic.Field(default="roles.created", frozen=True)
_object_type: typing.ClassVar[str | None] = "role"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Role


Expand All @@ -199,8 +207,8 @@ class RoleDeletedEvent(FetchableEvent[Role]):
"""

EVENT_TYPE: typing.ClassVar[str] = "roles.deleted"
type: typing.Literal["roles.deleted"] = "roles.deleted"
_object_type: typing.ClassVar[str] = "role"
type: typing.Literal["roles.deleted"] = pydantic.Field(default="roles.deleted", frozen=True)
_object_type: typing.ClassVar[str | None] = "role"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Role


Expand All @@ -213,8 +221,8 @@ class RoleUpdatedEvent(FetchableEvent[Role]):
"""

EVENT_TYPE: typing.ClassVar[str] = "roles.updated"
type: typing.Literal["roles.updated"] = "roles.updated"
_object_type: typing.ClassVar[str] = "role"
type: typing.Literal["roles.updated"] = pydantic.Field(default="roles.updated", frozen=True)
_object_type: typing.ClassVar[str | None] = "role"
_response_model: typing.ClassVar[builtins.type[pydantic.BaseModel]] = Role


Expand Down
20 changes: 20 additions & 0 deletions tests/test_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import json

import httpx
import pydantic
import pytest

from sumup import APIError, AsyncSumup
Expand Down Expand Up @@ -98,6 +99,25 @@ def test_parse_event_notification(sdk, event_type, model):
assert "Bearer" not in repr(event)


@pytest.mark.parametrize("model", [EventNotification, ReaderCreatedEvent, UnknownEvent])
def test_event_type_is_read_only(model):
event = model.model_validate_json(_body())
with pytest.raises(pydantic.ValidationError) as raised:
event.type = "other.event"
assert raised.value.errors()[0]["type"] == "frozen_field"
assert event.model_dump()["type"] == "readers.created"


def test_known_event_type_default_and_validation():
payload = json.loads(_body())
del payload["type"]
assert ReaderCreatedEvent.model_validate(payload).type == "readers.created"
payload["type"] = "readers.deleted"
with pytest.raises(pydantic.ValidationError) as raised:
ReaderCreatedEvent.model_validate(payload)
assert raised.value.errors()[0]["type"] == "literal_error"


@pytest.mark.parametrize(
"body", [b'{ "name": "caf\xc3\xa9" }\n', bytearray(b"body"), memoryview(b"body"), "café"]
)
Expand Down
Loading
Loading