Skip to content
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.

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

feat(http,model): scheduled events #1347

Merged
merged 14 commits into from
Jan 13, 2022

Conversation

7596ff
Copy link
Contributor

@7596ff 7596ff commented Dec 23, 2021

This PR implements Scheduled Events.

It is targeted at next to save effort in implementing validation once #1331 is merged.

Closes #1283.

Blocks on #1331. Merged.

This PR implements Scheduled events.

Closes twilight-rs#1283.
@7596ff 7596ff added c-http Affects the http crate c-http-ratelimiting Affects the http ratelimiting crate c-model Affects the model crate d-api Change related to Discord's API. t-feature Addition of a new feature labels Dec 23, 2021
AEnterprise
AEnterprise previously approved these changes Dec 30, 2021
http/src/routing/route_display.rs Show resolved Hide resolved
model/src/scheduled_event/mod.rs Show resolved Hide resolved
model/src/lib.rs Show resolved Hide resolved
http/src/routing/route_display.rs Show resolved Hide resolved
http/src/routing/route.rs Outdated Show resolved Hide resolved
* vilgotf: edit path matching
vilgotf
vilgotf previously approved these changes Dec 31, 2021
Copy link
Member

@vilgotf vilgotf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some things were marked as resolved, but not implemented from my previous review.
I suppose you disagreed rather than forgot.

@vilgotf
Copy link
Member

vilgotf commented Jan 3, 2022

Should this PR include guild_scheduled_events on Audit Log too?

@7596ff
Copy link
Contributor Author

7596ff commented Jan 3, 2022

Yeah, I'll update it with those soon.

@7596ff
Copy link
Contributor Author

7596ff commented Jan 7, 2022

Should this PR include guild_scheduled_events on Audit Log too?

Just kidding, I actually got those in #1324

@github-actions github-actions bot added the c-validate Affects the validate crate label Jan 7, 2022
@7596ff 7596ff dismissed stale reviews from vilgotf and AEnterprise January 7, 2022 03:42

new changes

vilgotf
vilgotf previously requested changes Jan 7, 2022
Copy link
Member

@vilgotf vilgotf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the audit log guild_scheduled_events changes on model.

@7596ff 7596ff merged commit d996ebf into twilight-rs:next Jan 13, 2022
@7596ff 7596ff deleted the feat/scheduled-events branch January 13, 2022 16:07
7596ff added a commit that referenced this pull request Jan 23, 2022
Additions

Add `Path` variants for scheduled events ([#1347] - [@7596ff]).

Changes

`Method::into_http` has been renamed to `to_http` ([#1398] -
[@vilgotf]).

`Path` variants that contained a `Box<str>` now contain a `String`
([#1398] - [@vilgotf]).

`Present::into_bucket` now returns a `String` ([#1398] - [@vilgotf]).

The MSRV has been updated to 1.57 ([#1402] - [@zeylahellyer]).

The Rust edition has been updated to 2021 ([#1412] - [@vilgotf]).

[#1347]: #1347
[#1398]: #1398
[#1402]: #1402
[#1412]: #1412

[@7596ff]: https://github.com/7596ff
[@vilgotf]: https://github.com/vilgotf
[@zeylahellyer]: https://github.com/zeylahellyer
7596ff added a commit that referenced this pull request Jan 23, 2022
Validation

Validation has been moved to a new crate, `twilight_validate` ([#1331] -
[@7596ff]). Similar concerns such as creating messages
(`MessageValidationError`) or editing channels (`ChannelValidationError`) have
been grouped together in error types, and these error types replace the custom
error types associated with each request builder. Miscellaneous validation
functions that were associated things like get user limits are also placed under
one error type, `ValidationError`.

The following error types are now returned by the following methods:
- `ChannelValidationError`
  - `Client::create_guild_channel`
  - `Client::create_thread_from_message`
  - `Client::create_thread`
  - `CreateGuildChannel::rate_limit_per_user`
  - `CreateGuildChannel::topic`
  - `UpdateChannel::name`
  - `UpdateChannel::rate_limit_per_user`
  - `UpdateChannel::topic`
  - `UpdateThread::name`
  - `UpdateThread::rate_limit_per_user`
- `CommandValidationError`
  - `InteractionClient::set_command_permissions`
  - `InteractionClient::update_command_permissions`
- `MessageValidationError`
  - `CreateFollowupMessage::components`
  - `CreateMessage::components`
  - `CreateMessage::content`
  - `CreateMessage::embeds`
  - `CreateMessage::stickers`
  - `CreateWebhookMessage::components`
  - `UpdateFollowupMessage::components`
  - `UpdateFollowupMessage::content`
  - `UpdateFollowupMessage::embeds`
  - `UpdateMessage::components`
  - `UpdateMessage::content`
  - `UpdateMessage::embeds`
  - `UpdateOriginalResponse::components`
  - `UpdateOriginalResponse::content`
  - `UpdateOriginalResponse::embeds`
  - `UpdateWebhookMessage::components`
  - `UpdateWebhookMessage::content`
  - `UpdateWebhookMessage::embeds`
- `ValidationError`
  - `AddGuildMember::nick`
  - `Client::create_guild_from_template`
  - `Client::create_stage_instance`
  - `Client::create_template`
  - `CreateBan::delete_message_days`
  - `CreateGuildPrune::days`
  - `CreateInvite::max_uses`
  - `CreateTemplate::description`
  - `GetChannelMessages::limit`
  - `GetCurrentUserGuilds::limit`
  - `GetGuildAuditLog::limit`
  - `GetGuildMembers::limit`
  - `GetGuildPruneCount::limit`
  - `GetReactions::limit`
  - `SearchGuildMembers::limit`
  - `UpdateCurrentMember::nick`
  - `UpdateCurrentUser::username`
  - `UpdateGuild::name`
  - `UpdateGuildMember::communication_disabled_until`
  - `UpdateGuildMember::nick`
  - `UpdateStageInstance::topic`
  - `UpdateTemplate::description`
  - `UpdateTemplate::name`

The following functions now perform validation:
- `MessageValidationError`
  - `CreateFollowupMessage::content`
  - `CreateFollowupMessage::embeds`
  - `CreateWebhookMessage::content`
  - `CreateWebhookMessage::embeds`

Additions

Add a sealed trait located at `request::TryIntoRequest` for converting a
typed request builder into a raw `request::Request` ([#1162] -
[@zeylahellyer]). This allows users to inspect requests prior to sending
them which may be useful for debugging and unit testing.

Support guild scheduled events ([#1347] - [@7596ff]). Adds the following
methods: `Client::create_guild_scheduled_event`,
`Client::delete_guild_scheduled_event`,
`Client::guild_scheduled_event_users`, `Client::guild_scheduled_event`,
`Client::guild_scheduled_events`,
`Client::update_guild_scheduled_event`.

Changes

All types and method signatures have been updated to use the new `Id<T>`
syntax ([#1260] - [@zeylahellyer]).

Requests requiring an `Id<ApplicationMarker>` are now created through an
`InteractionClient` ([#1275] - [@zeylahellyer]]). This is created by
passing the ID to `Client::interaction`. It replaces
`set_application_id`. The interaction methods are no longer on `Client`.

The `rustls` feature has been removed ([#1314] - [@Gelbpunkt]). Users
must manually select one of `rustls-native-roots` or
`rustls-webpki-roots`.

The `ErrorCode` which contained custom names and descriptions for each
API error code has been removed ([#1394] - [@zeylahellyer]). Users can
now read `GeneralApiError::code: u64` to see the code.

`InteractionClient::{create_global_command, create_guild_command}` no
longer accept a `name` when first creating the request ([#1395] -
[@baptiste0928]).  Instead, depending on the type of command the user is
created, different validation is performed. For `ChatInput` commands,
validation ensures that the name is between 1 and 32 characters in
length and that it contains no uppercase letters. For `Message` and
`User` commands, validation only ensures the length is correct. Similar
validation is performed on `ChatInput` `option`s.

`Route` now directly implements `Display` ([#1397] - [@vilgotf]).

The MSRV has been updated to 1.57 ([#1402] - [@zeylahellyer]).

The Rust edition has been updated to 2021 ([#1412] - [@vilgotf]).

`RequestReactionType` now directly implements `Display` ([#1457] -
[@vilgotf]).

[#1162]: #1162
[#1260]: #1260
[#1275]: #1275
[#1314]: #1314
[#1331]: #1331
[#1394]: #1394
[#1395]: #1395
[#1402]: #1402
[#1412]: #1412
[#1457]: #1457

[@7596ff]: https://github.com/7596ff
[@baptiste0928]: https://github.com/baptiste0928
[@Gelbpunkt]: https://github.com/Gelbpunkt
[@vilgotf]: https://github.com/vilgotf
[@zeylahellyer]: https://github.com/zeylahellyer
7596ff added a commit that referenced this pull request Jan 23, 2022
`Id<T>`

IDs are now a unified type (`Id`) with marker generics
(`ApplicationMarker`, ...) ([#1260] - [@zeylahellyer]). The new type
implements all of what each type used to implement, as well as
`FromStr`, `TryFrom<u64>`, and `TryFrom<i64>`, and others. `Id::cast`
aids in converting between IDs without copying. See the PR and the
documentation for more details.

Additions

Support scheduled events ([#1347] - [@7596ff]). Adds the following
types: `EntityMetadata`, `EntityType`, `GuildScheduledEventUser`,
`GuildScheduledEvent`, `PrivacyLevel`, and `Status`.

Changes

All types and method signatures have been updated to use the new `Id<T>`
syntax ([#1260] - [@zeylahellyer]).

The MSRV has been updated to 1.57 ([#1402] - [@zeylahellyer]).

Image hashes are now parsed and stored in a more efficient struct,
rather than deserializing as a `String` ([#1405] - [@zeylahellyer]).

The Rust edition has been updated to 2021 ([#1412] - [@vilgotf]).

`StageInstance::discoverable_disabled` and `PrivacyLevel::Public` have
been removed, as public stage instances are no longer supported ([#1479]
- [@itohatweb]).

`GuildWidget::channel_id` is now optional ([#1480] - [@itohatweb]).

[#1260]: #1260
[#1402]: #1402
[#1405]: #1405
[#1412]: #1412
[#1479]: #1479
[#1480]: #1480

[@7596ff]: https://github.com/7596ff
[@itohatweb]: https://github.com/itohatweb
[@vilgotf]: https://github.com/vilgotf
[@zeylahellyer]: https://github.com/zeylahellyer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-http Affects the http crate c-http-ratelimiting Affects the http ratelimiting crate c-model Affects the model crate c-validate Affects the validate crate d-api Change related to Discord's API. t-feature Addition of a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants