kozabrada123/chorus
kozabrada123
/
chorus
mirror of https://github.com/polyphony-chat/chorus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #100 from polyphony-chat/refactor/refcell-across-await-and-boilerplate-reduction 

Refactor/refcell across await and boilerplate reduction
This commit is contained in:
Flori 2023-06-11 14:01:43 +02:00 committed by GitHub
parent 1a6b54833a 8b8ea03513
commit d2867d9496
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
63 changed files with 370 additions and 342 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
examples/gateway_simple.rs
View File

@ -1,5 +1,4 @@
use chorus::{self, gateway::Gateway, types::GatewayIdentifyPayload};
use tokio;
/// This example creates a simple gateway connection and a session with an Identify event
#[tokio::main]

130
src/api/auth/login.rs
View File

@ -1,72 +1,70 @@
pub mod login {
use std::cell::RefCell;
use std::rc::Rc;
use std::cell::RefCell;
use std::rc::Rc;
use reqwest::Client;
use serde_json::{from_str, json};
use reqwest::Client;
use serde_json::{from_str, json};
use crate::api::limits::LimitType;
use crate::errors::ChorusLibError;
use crate::instance::{Instance, UserMeta};
use crate::limit::LimitedRequester;
use crate::types::{ErrorResponse, LoginResult, LoginSchema};
use crate::api::limits::LimitType;
use crate::errors::ChorusLibError;
use crate::instance::{Instance, UserMeta};
use crate::limit::LimitedRequester;
use crate::types::{ErrorResponse, LoginResult, LoginSchema};
impl Instance {
pub async fn login_account(
&mut self,
login_schema: &LoginSchema,
) -> Result<UserMeta, ChorusLibError> {
let mut requester = LimitedRequester::new().await;
let json_schema = json!(login_schema);
let client = Client::new();
let endpoint_url = self.urls.get_api().to_string() + "/auth/login";
let request_builder = client.post(endpoint_url).body(json_schema.to_string());
// We do not have a user yet, and the UserRateLimits will not be affected by a login
// request (since login is an instance wide limit), which is why we are just cloning the
// instances' limits to pass them on as user_rate_limits later.
let mut cloned_limits = self.limits.clone();
let response = requester
.send_request(
request_builder,
LimitType::AuthRegister,
&mut self.limits,
&mut cloned_limits,
)
.await;
if response.is_err() {
return Err(ChorusLibError::NoResponse);
}
let response_unwrap = response.unwrap();
let status = response_unwrap.status();
let response_text_string = response_unwrap.text().await.unwrap();
if status.is_client_error() {
let json: ErrorResponse = serde_json::from_str(&response_text_string).unwrap();
let error_type = json.errors.errors.iter().next().unwrap().0.to_owned();
let mut error = "".to_string();
for (_, value) in json.errors.errors.iter() {
for error_item in value._errors.iter() {
error += &(error_item.message.to_string() + " (" + &error_item.code + ")");
}
}
return Err(ChorusLibError::InvalidFormBodyError { error_type, error });
}
let cloned_limits = self.limits.clone();
let login_result: LoginResult = from_str(&response_text_string).unwrap();
let object = self
.get_user(login_result.token.clone(), None)
.await
.unwrap();
let user = UserMeta::new(
Rc::new(RefCell::new(self.clone())),
login_result.token,
cloned_limits,
login_result.settings,
object,
);
Ok(user)
impl Instance {
pub async fn login_account(
&mut self,
login_schema: &LoginSchema,
) -> Result<UserMeta, ChorusLibError> {
let mut requester = LimitedRequester::new().await;
let json_schema = json!(login_schema);
let client = Client::new();
let endpoint_url = self.urls.get_api().to_string() + "/auth/login";
let request_builder = client.post(endpoint_url).body(json_schema.to_string());
// We do not have a user yet, and the UserRateLimits will not be affected by a login
// request (since login is an instance wide limit), which is why we are just cloning the
// instances' limits to pass them on as user_rate_limits later.
let mut cloned_limits = self.limits.clone();
let response = requester
.send_request(
request_builder,
LimitType::AuthRegister,
&mut self.limits,
&mut cloned_limits,
)
.await;
if response.is_err() {
return Err(ChorusLibError::NoResponse);
}
let response_unwrap = response.unwrap();
let status = response_unwrap.status();
let response_text_string = response_unwrap.text().await.unwrap();
if status.is_client_error() {
let json: ErrorResponse = serde_json::from_str(&response_text_string).unwrap();
let error_type = json.errors.errors.iter().next().unwrap().0.to_owned();
let mut error = "".to_string();
for (_, value) in json.errors.errors.iter() {
for error_item in value._errors.iter() {
error += &(error_item.message.to_string() + " (" + &error_item.code + ")");
}
}
return Err(ChorusLibError::InvalidFormBodyError { error_type, error });
}
let cloned_limits = self.limits.clone();
let login_result: LoginResult = from_str(&response_text_string).unwrap();
let object = self
.get_user(login_result.token.clone(), None)
.await
.unwrap();
let user = UserMeta::new(
Rc::new(RefCell::new(self.clone())),
login_result.token,
cloned_limits,
login_result.settings,
object,
);
Ok(user)
}
}

6
src/api/auth/mod.rs
View File

@ -1,5 +1,5 @@
pub mod login;
pub mod register;
pub use login::*;
pub use register::*;
pub mod login;
pub mod register;

144
src/api/auth/register.rs
View File

@ -1,79 +1,77 @@
pub mod register {
use std::{cell::RefCell, rc::Rc};
use std::{cell::RefCell, rc::Rc};
use reqwest::Client;
use serde_json::{from_str, json};
use reqwest::Client;
use serde_json::{from_str, json};
use crate::{
api::limits::LimitType,
errors::ChorusLibError,
instance::{Instance, Token, UserMeta},
limit::LimitedRequester,
types::{ErrorResponse, RegisterSchema},
};
use crate::{
api::limits::LimitType,
errors::ChorusLibError,
instance::{Instance, Token, UserMeta},
limit::LimitedRequester,
types::{ErrorResponse, RegisterSchema},
};
impl Instance {
/**
Registers a new user on the Spacebar server.
# Arguments
* `register_schema` - The [`RegisterSchema`] that contains all the information that is needed to register a new user.
# Errors
* [`ChorusLibError`] - If the server does not respond.
*/
pub async fn register_account(
&mut self,
register_schema: &RegisterSchema,
) -> Result<UserMeta, ChorusLibError> {
let json_schema = json!(register_schema);
let mut limited_requester = LimitedRequester::new().await;
let client = Client::new();
let endpoint_url = self.urls.get_api().to_string() + "/auth/register";
let request_builder = client.post(endpoint_url).body(json_schema.to_string());
// We do not have a user yet, and the UserRateLimits will not be affected by a login
// request (since register is an instance wide limit), which is why we are just cloning
// the instances' limits to pass them on as user_rate_limits later.
let mut cloned_limits = self.limits.clone();
let response = limited_requester
.send_request(
request_builder,
LimitType::AuthRegister,
&mut self.limits,
&mut cloned_limits,
)
.await;
if response.is_err() {
return Err(ChorusLibError::NoResponse);
}
let response_unwrap = response.unwrap();
let status = response_unwrap.status();
let response_unwrap_text = response_unwrap.text().await.unwrap();
let token = from_str::<Token>(&response_unwrap_text).unwrap();
let token = token.token;
if status.is_client_error() {
let json: ErrorResponse = serde_json::from_str(&token).unwrap();
let error_type = json.errors.errors.iter().next().unwrap().0.to_owned();
let mut error = "".to_string();
for (_, value) in json.errors.errors.iter() {
for error_item in value._errors.iter() {
error += &(error_item.message.to_string() + " (" + &error_item.code + ")");
}
}
return Err(ChorusLibError::InvalidFormBodyError { error_type, error });
}
let user_object = self.get_user(token.clone(), None).await.unwrap();
let settings =
UserMeta::get_settings(&token, &self.urls.get_api().to_string(), &mut self.limits)
.await
.unwrap();
let user: UserMeta = UserMeta::new(
Rc::new(RefCell::new(self.clone())),
token.clone(),
cloned_limits,
settings,
user_object,
);
Ok(user)
impl Instance {
/**
Registers a new user on the Spacebar server.
# Arguments
* `register_schema` - The [`RegisterSchema`] that contains all the information that is needed to register a new user.
# Errors
* [`ChorusLibError`] - If the server does not respond.
*/
pub async fn register_account(
&mut self,
register_schema: &RegisterSchema,
) -> Result<UserMeta, ChorusLibError> {
let json_schema = json!(register_schema);
let mut limited_requester = LimitedRequester::new().await;
let client = Client::new();
let endpoint_url = self.urls.get_api().to_string() + "/auth/register";
let request_builder = client.post(endpoint_url).body(json_schema.to_string());
// We do not have a user yet, and the UserRateLimits will not be affected by a login
// request (since register is an instance wide limit), which is why we are just cloning
// the instances' limits to pass them on as user_rate_limits later.
let mut cloned_limits = self.limits.clone();
let response = limited_requester
.send_request(
request_builder,
LimitType::AuthRegister,
&mut self.limits,
&mut cloned_limits,
)
.await;
if response.is_err() {
return Err(ChorusLibError::NoResponse);
}
let response_unwrap = response.unwrap();
let status = response_unwrap.status();
let response_unwrap_text = response_unwrap.text().await.unwrap();
let token = from_str::<Token>(&response_unwrap_text).unwrap();
let token = token.token;
if status.is_client_error() {
let json: ErrorResponse = serde_json::from_str(&token).unwrap();
let error_type = json.errors.errors.iter().next().unwrap().0.to_owned();
let mut error = "".to_string();
for (_, value) in json.errors.errors.iter() {
for error_item in value._errors.iter() {
error += &(error_item.message.to_string() + " (" + &error_item.code + ")");
}
}
return Err(ChorusLibError::InvalidFormBodyError { error_type, error });
}
let user_object = self.get_user(token.clone(), None).await.unwrap();
let settings =
UserMeta::get_settings(&token, &self.urls.get_api().to_string(), &mut self.limits)
.await
.unwrap();
let user: UserMeta = UserMeta::new(
Rc::new(RefCell::new(self.clone())),
token.clone(),
cloned_limits,
settings,
user_object,
);
Ok(user)
}
}

10
src/api/channels/mod.rs
View File

@ -1,9 +1,9 @@
pub mod channels;
pub mod messages;
pub mod permissions;
pub mod reactions;
pub use channels::*;
pub use messages::*;
pub use permissions::*;
pub use reactions::*;
pub mod channels;
pub mod messages;
pub mod permissions;
pub mod reactions;

10
src/api/channels/reactions.rs
View File

@ -28,7 +28,7 @@ impl ReactionMeta {
# Reference
See [https://discord.com/developers/docs/resources/channel#delete-all-reactions](https://discord.com/developers/docs/resources/channel#delete-all-reactions)
*/
*/
pub async fn delete_all(
&self,
user: &mut UserMeta,
@ -66,7 +66,7 @@ impl ReactionMeta {
# Reference
See [https://discord.com/developers/docs/resources/channel#get-reactions](https://discord.com/developers/docs/resources/channel#get-reactions)
*/
*/
pub async fn get(
&self,
emoji: &str,
@ -108,7 +108,7 @@ impl ReactionMeta {
# Reference
See [https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji](https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji)
*/
*/
pub async fn delete_emoji(
&self,
emoji: &str,
@ -154,7 +154,7 @@ impl ReactionMeta {
# Reference
See [https://discord.com/developers/docs/resources/channel#create-reaction](https://discord.com/developers/docs/resources/channel#create-reaction)
*/
*/
pub async fn create(
&self,
emoji: &str,
@ -241,7 +241,7 @@ impl ReactionMeta {
# Reference
See [https://discord.com/developers/docs/resources/channel#delete-own-reaction](https://discord.com/developers/docs/resources/channel#delete-own-reaction)
*/
*/
pub async fn delete_user(
&self,
user_id: &str,

4
src/api/guilds/guilds.rs
View File

@ -173,7 +173,7 @@ impl Guild {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
let _: Vec<Channel> = match from_str(&stringed_response) {
@ -181,7 +181,7 @@ impl Guild {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
}

2
src/api/guilds/member.rs
View File

@ -43,7 +43,7 @@ impl types::GuildMember {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
let member = from_str::<types::GuildMember>(&response_text);

8
src/api/guilds/mod.rs
View File

@ -1,7 +1,7 @@
pub mod guilds;
pub mod member;
pub mod roles;
pub use guilds::*;
pub use roles::*;
pub use roles::*;
pub mod guilds;
pub mod member;
pub mod roles;

16
src/api/guilds/roles.rs
View File

@ -48,7 +48,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
@ -105,7 +105,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
@ -139,7 +139,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::FormCreationError {
error: e.to_string(),
})
});
}
};
let request = Client::new().post(url).bearer_auth(user.token()).body(body);
@ -161,7 +161,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
Ok(role)
@ -194,7 +194,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::FormCreationError {
error: e.to_string(),
})
});
}
};
let request = Client::new()
@ -216,7 +216,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
Ok(role)
@ -256,7 +256,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::FormCreationError {
error: e.to_string(),
})
});
}
};
let request = Client::new()
@ -281,7 +281,7 @@ impl types::RoleObject {
Err(e) => {
return Err(ChorusLibError::InvalidResponseError {
error: e.to_string(),
})
});
}
};
Ok(role)

10
src/api/mod.rs
View File

@ -1,10 +1,10 @@
pub use channels::messages::*;
pub use guilds::*;
pub use policies::instance::instance::*;
pub use policies::instance::limits::*;
pub mod auth;
pub mod channels;
pub mod guilds;
pub mod policies;
pub mod users;
pub use channels::messages::*;
pub use guilds::*;
pub use policies::instance::instance::*;
pub use policies::instance::limits::*;

2
src/api/policies/instance/instance.rs
View File

@ -10,7 +10,7 @@ impl Instance {
Gets the instance policies schema.
# Errors
[`ChorusLibError`] - If the request fails.
*/
*/
pub async fn general_configuration_schema(
&self,
) -> Result<GeneralConfiguration, ChorusLibError> {

6
src/api/policies/instance/limits.rs
View File

@ -47,7 +47,6 @@ pub mod limits {
#[derive(Debug, Deserialize, Serialize)]
#[allow(non_snake_case)]
pub struct Guild {
pub maxRoles: u64,
pub maxEmojis: u64,
@ -58,7 +57,6 @@ pub mod limits {
#[derive(Debug, Deserialize, Serialize)]
#[allow(non_snake_case)]
pub struct Message {
pub maxCharacters: u64,
pub maxTTSCharacters: u64,
@ -70,7 +68,6 @@ pub mod limits {
#[derive(Debug, Deserialize, Serialize)]
#[allow(non_snake_case)]
pub struct Channel {
pub maxPins: u64,
pub maxTopic: u64,
@ -102,7 +99,6 @@ pub mod limits {
#[derive(Debug, Deserialize, Serialize)]
#[allow(non_snake_case)]
pub struct AuthRoutes {
pub login: Window,
pub register: Window,
@ -110,7 +106,6 @@ pub mod limits {
#[derive(Debug, Deserialize, Serialize)]
#[allow(non_snake_case)]
pub struct AbsoluteRate {
pub register: AbsoluteWindow,
pub sendMessage: AbsoluteWindow,
@ -125,7 +120,6 @@ pub mod limits {
#[derive(Debug, Deserialize, Serialize)]
#[allow(non_snake_case)]
pub struct Config {
pub user: User,
pub guild: Guild,

6
src/api/policies/instance/mod.rs
View File

@ -1,5 +1,5 @@
pub mod instance;
pub mod limits;
pub use instance::*;
pub use limits::*;
pub mod instance;
pub mod limits;

4
src/api/policies/mod.rs
View File

@ -1,3 +1,3 @@
pub mod instance;
pub use instance::limits::*;
pub mod instance;

4
src/api/users/mod.rs
View File

@ -1,3 +1,3 @@
pub mod users;
pub use users::*;
pub mod users;

31
src/gateway.rs
View File

@ -1,11 +1,9 @@
use crate::errors::ObserverError;
use crate::gateway::events::Events;
use crate::types;
use std::sync::Arc;
use futures_util::stream::SplitSink;
use futures_util::SinkExt;
use futures_util::StreamExt;
use native_tls::TlsConnector;
use std::sync::Arc;
use tokio::net::TcpStream;
use tokio::sync::mpsc;
use tokio::sync::mpsc::error::TryRecvError;
@ -18,6 +16,10 @@ use tokio::time::Instant;
use tokio_tungstenite::MaybeTlsStream;
use tokio_tungstenite::{connect_async_tls_with_config, Connector, WebSocketStream};
use crate::errors::ObserverError;
use crate::gateway::events::Events;
use crate::types;
// Gateway opcodes
/// Opcode received when the server dispatches a [crate::types::WebSocketEvent]
const GATEWAY_DISPATCH: u8 = 0;
@ -72,7 +74,7 @@ Represents a handle to a Gateway connection. A Gateway connection will create ob
[`GatewayEvents`](GatewayEvent), which you can subscribe to. Gateway events include all currently
implemented [Types] with the trait [`WebSocketEvent`]
Using this handle you can also send Gateway Events directly.
*/
*/
pub struct GatewayHandle {
pub url: String,
pub events: Arc<Mutex<Events>>,
@ -1198,7 +1200,7 @@ impl Gateway {
/**
Handles sending heartbeats to the gateway in another thread
*/
*/
struct HeartbeatHandler {
/// The heartbeat interval in milliseconds
pub heartbeat_interval: u128,
@ -1267,7 +1269,7 @@ impl HeartbeatHandler {
/**
Used to communicate with the main thread.
Either signifies a sequence number update or a received heartbeat ack
*/
*/
#[derive(Clone, Copy, Debug)]
struct HeartbeatThreadCommunication {
/// The opcode for the communication we received
@ -1287,8 +1289,7 @@ pub trait Observer<T: types::WebSocketEvent>: std::fmt::Debug {
/** GatewayEvent is a wrapper around a WebSocketEvent. It is used to notify the observers of a
change in the WebSocketEvent. GatewayEvents are observable.
*/
*/
#[derive(Default, Debug)]
pub struct GatewayEvent<T: types::WebSocketEvent> {
observers: Vec<Arc<Mutex<dyn Observer<T> + Sync + Send>>>,
@ -1307,7 +1308,7 @@ impl<T: types::WebSocketEvent> GatewayEvent<T> {
/**
Returns true if the GatewayEvent is observed by at least one Observer.
*/
*/
pub fn is_observed(&self) -> bool {
self.is_observed
}
@ -1318,7 +1319,7 @@ impl<T: types::WebSocketEvent> GatewayEvent<T> {
# Errors
Returns an error if the GatewayEvent is already observed.
Error type: [`ObserverError::AlreadySubscribedError`]
*/
*/
pub fn subscribe(
&mut self,
observable: Arc<Mutex<dyn Observer<T> + Sync + Send>>,
@ -1333,7 +1334,7 @@ impl<T: types::WebSocketEvent> GatewayEvent<T> {
/**
Unsubscribes an Observer from the GatewayEvent.
*/
*/
pub fn unsubscribe(&mut self, observable: Arc<Mutex<dyn Observer<T> + Sync + Send>>) {
// .retain()'s closure retains only those elements of the vector, which have a different
// pointer value than observable.
@ -1346,7 +1347,7 @@ impl<T: types::WebSocketEvent> GatewayEvent<T> {
/**
Updates the GatewayEvent's data and notifies the observers.
*/
*/
async fn update_data(&mut self, new_event_data: T) {
self.event_data = new_event_data;
self.notify().await;
@ -1354,7 +1355,7 @@ impl<T: types::WebSocketEvent> GatewayEvent<T> {
/**
Notifies the observers of the GatewayEvent.
*/
*/
async fn notify(&self) {
for observer in &self.observers {
observer.lock().await.update(&self.event_data);
@ -1364,6 +1365,7 @@ impl<T: types::WebSocketEvent> GatewayEvent<T> {
mod events {
use super::*;
#[derive(Default, Debug)]
pub struct Events {
pub application: Application,
@ -1528,6 +1530,7 @@ mod example {
#[derive(Debug)]
struct Consumer;
impl Observer<types::GatewayResume> for Consumer {
fn update(&self, data: &types::GatewayResume) {
println!("{}", data.token)

10
src/instance.rs
View File

@ -1,3 +1,7 @@
use std::cell::RefCell;
use std::fmt;
use std::rc::Rc;
use serde::{Deserialize, Serialize};
use crate::api::limits::Limits;
@ -5,10 +9,6 @@ use crate::errors::{ChorusLibError, FieldFormatError};
use crate::types::{GeneralConfiguration, User, UserSettings};
use crate::URLBundle;
use std::cell::RefCell;
use std::fmt;
use std::rc::Rc;
#[derive(Debug, Clone)]
/**
The [`Instance`] what you will be using to perform all sorts of actions on the Spacebar server.
@ -47,7 +47,7 @@ impl Instance {
Err(e) => {
return Err(ChorusLibError::CantGetInfoError {
error: e.to_string(),
})
});
}
};
Ok(instance)

4
src/lib.rs
View File

@ -1,3 +1,5 @@
use url::{ParseError, Url};
#[cfg(feature = "client")]
pub mod api;
pub mod errors;
@ -11,9 +13,7 @@ pub mod types;
#[cfg(feature = "client")]
pub mod voice;
use url::{ParseError, Url};
#[derive(Clone, Default, Debug, PartialEq, Eq)]
/// A URLBundle is a struct which bundles together the API-, Gateway- and CDN-URLs of a Spacebar
/// instance.
pub struct URLBundle {

20
src/limit.rs
View File

@ -1,11 +1,12 @@
use std::collections::VecDeque;
use reqwest::{Client, RequestBuilder, Response};
use crate::{
api::limits::{Limit, LimitType, Limits, LimitsMutRef},
errors::ChorusLibError,
};
use reqwest::{Client, RequestBuilder, Response};
use std::collections::VecDeque;
// Note: There seem to be some overlapping request limiters. We need to make sure that sending a
// request checks for all the request limiters that apply, and blocks if any of the limiters are 0
@ -64,7 +65,7 @@ impl LimitedRequester {
- There has been an error with processing (unwrapping) the [`Response`](`reqwest::Response`)
- The call to [`update_limits`](`crate::limits::update_limits`) yielded errors. Read the
methods' Errors section for more information.
*/
*/
pub async fn send_request(
&mut self,
request: RequestBuilder,
@ -79,7 +80,7 @@ impl LimitedRequester {
return Err(ChorusLibError::RequestErrorError {
url: "".to_string(),
error: e.to_string(),
})
});
}
};
let result = self.http.execute(built_request).await;
@ -88,7 +89,7 @@ impl LimitedRequester {
Err(e) => {
return Err(ChorusLibError::ReceivedErrorCodeError {
error_code: e.to_string(),
})
});
}
};
self.update_limits(
@ -104,7 +105,7 @@ impl LimitedRequester {
_ => {
return Err(ChorusLibError::ReceivedErrorCodeError {
error_code: response.status().as_str().to_string(),
})
});
}
}
} else {
@ -281,10 +282,11 @@ impl LimitedRequester {
mod rate_limit {
use serde_json::from_str;
use super::*;
use crate::{api::limits::Config, URLBundle};
#[tokio::test]
use super::*;
#[tokio::test]
async fn create_limited_requester() {
let _urls = URLBundle::new(
String::from("http://localhost:3001/api/"),

9
src/types/config/types/guild_configuration.rs
View File

@ -1,3 +1,8 @@
use std::fmt::{Display, Formatter};
use std::io::Write;
use std::ops::{Deref, DerefMut};
use std::str::FromStr;
use serde::{Deserialize, Serialize};
#[cfg(feature = "sqlx")]
use sqlx::{
@ -6,10 +11,6 @@ use sqlx::{
error::BoxDynError,
Decode, Encode, MySql,
};
use std::fmt::{Display, Formatter};
use std::io::Write;
use std::ops::{Deref, DerefMut};
use std::str::FromStr;
use crate::types::config::types::subconfigs::guild::{
autojoin::AutoJoinConfiguration, discovery::DiscoverConfiguration,

1
src/types/config/types/subconfigs/register/email.rs
View File

@ -9,6 +9,7 @@ pub struct RegistrationEmailConfiguration {
#[serde(default)]
pub domains: Vec<String>,
}
impl Default for RegistrationEmailConfiguration {
fn default() -> Self {
Self {

8
src/types/config/types/subconfigs/register/mod.rs
View File

@ -1,7 +1,7 @@
mod date_of_birth;
mod email;
mod password;
pub use date_of_birth::DateOfBirthConfiguration;
pub use email::RegistrationEmailConfiguration;
pub use password::PasswordConfiguration;
mod date_of_birth;
mod email;
mod password;

6
src/types/config/types/subconfigs/security/mod.rs
View File

@ -1,5 +1,5 @@
mod captcha;
mod twofactor;
pub use captcha::{CaptchaConfiguration, CaptchaService};
pub use twofactor::TwoFactorConfiguration;
mod captcha;
mod twofactor;

5
src/types/entities/application.rs
View File

@ -1,10 +1,11 @@
use crate::types::utils::Snowflake;
use crate::types::{Team, User};
use bitflags::{bitflags, Flags};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use serde_repr::{Deserialize_repr, Serialize_repr};
use crate::types::utils::Snowflake;
use crate::types::{Team, User};
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "sqlx", derive(sqlx::FromRow))]
pub struct Application {

1
src/types/entities/attachment.rs
View File

@ -23,7 +23,6 @@ pub struct Attachment {
}
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct PartialDiscordFileAttachment {
pub id: Option<i16>,
pub filename: String,

1
src/types/entities/message.rs
View File

@ -170,7 +170,6 @@ pub struct EmbedAuthor {
}
#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
pub struct EmbedField {
name: String,
value: String,

46
src/types/entities/mod.rs
View File

@ -1,26 +1,3 @@
mod application;
mod attachment;
mod audit_log;
mod auto_moderation;
mod channel;
mod config;
mod emoji;
mod guild;
mod guild_member;
mod integration;
mod message;
mod relationship;
mod role;
mod security_key;
mod stage_instance;
mod sticker;
mod team;
mod template;
mod user;
mod user_settings;
mod voice_state;
mod webhook;
pub use application::*;
pub use attachment::*;
pub use audit_log::*;
@ -43,3 +20,26 @@ pub use user::*;
pub use user_settings::*;
pub use voice_state::*;
pub use webhook::*;
mod application;
mod attachment;
mod audit_log;
mod auto_moderation;
mod channel;
mod config;
mod emoji;
mod guild;
mod guild_member;
mod integration;
mod message;
mod relationship;
mod role;
mod security_key;
mod stage_instance;
mod sticker;
mod team;
mod template;
mod user;
mod user_settings;
mod voice_state;
mod webhook;

3
src/types/entities/template.rs
View File

@ -21,7 +21,8 @@ pub struct GuildTemplate {
pub updated_at: DateTime<Utc>,
pub source_guild_id: String,
#[cfg_attr(feature = "sqlx", sqlx(skip))]
pub source_guild: Vec<Guild>, // Unsure how a {recursive: Guild} looks like, might be a Vec?
pub source_guild: Vec<Guild>,
// Unsure how a {recursive: Guild} looks like, might be a Vec?
#[cfg_attr(feature = "sqlx", sqlx(skip))]
pub serialized_source_guild: Vec<Guild>,
}

10
src/types/events/call.rs
View File

@ -10,12 +10,14 @@ pub struct CallCreate {
pub voice_states: Vec<VoiceState>,
/// Seems like a vec of channel ids
pub ringing: Vec<String>,
pub region: String, // milan
pub region: String,
// milan
pub message_id: String,
/// What is this?
pub embedded_activities: Vec<serde_json::Value>,
pub channel_id: String,
}
impl WebSocketEvent for CallCreate {}
#[derive(Debug, Deserialize, Serialize, Default)]
@ -25,11 +27,13 @@ impl WebSocketEvent for CallCreate {}
pub struct CallUpdate {
/// Seems like a vec of channel ids
pub ringing: Vec<String>,
pub region: String, // milan
pub region: String,
// milan
pub message_id: String,
pub guild_id: Option<String>,
pub channel_id: String,
}
impl WebSocketEvent for CallUpdate {}
#[derive(Debug, Deserialize, Serialize, Default)]
@ -39,6 +43,7 @@ impl WebSocketEvent for CallUpdate {}
pub struct CallDelete {
pub channel_id: String,
}
impl WebSocketEvent for CallDelete {}
#[derive(Debug, Deserialize, Serialize, Default)]
@ -48,4 +53,5 @@ impl WebSocketEvent for CallDelete {}
pub struct CallSync {
pub channel_id: String,
}
impl WebSocketEvent for CallSync {}

5
src/types/events/channel.rs
View File

@ -1,8 +1,9 @@
use crate::types::entities::Channel;
use crate::types::events::WebSocketEvent;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use crate::types::entities::Channel;
use crate::types::events::WebSocketEvent;
#[derive(Debug, Default, Deserialize, Serialize)]
/// See https://discord.com/developers/docs/topics/gateway-events#channel-pins-update
pub struct ChannelPinsUpdate {

6
src/types/events/guild.rs
View File

@ -1,8 +1,9 @@
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use crate::types::entities::{Guild, PublicUser, UnavailableGuild};
use crate::types::events::WebSocketEvent;
use crate::types::{AuditLogEntry, Emoji, GuildMember, GuildScheduledEvent, RoleObject, Sticker};
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use super::PresenceUpdate;
@ -26,6 +27,7 @@ impl Default for GuildCreateDataOption {
GuildCreateDataOption::UnavailableGuild(UnavailableGuild::default())
}
}
impl WebSocketEvent for GuildCreate {}
#[derive(Debug, Default, Deserialize, Serialize)]

3
src/types/events/heartbeat.rs
View File

@ -1,6 +1,7 @@
use crate::types::events::WebSocketEvent;
use serde::{Deserialize, Serialize};
use crate::types::events::WebSocketEvent;
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct GatewayHeartbeat {
pub op: u8,

3
src/types/events/hello.rs
View File

@ -1,6 +1,7 @@
use crate::types::events::WebSocketEvent;
use serde::{Deserialize, Serialize};
use crate::types::events::WebSocketEvent;
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct GatewayHello {
pub op: i32,

6
src/types/events/identify.rs
View File

@ -1,7 +1,8 @@
use crate::types::events::{PresenceUpdate, WebSocketEvent};
use serde::{Deserialize, Serialize};
use serde_with::serde_as;
use crate::types::events::{PresenceUpdate, WebSocketEvent};
#[derive(Debug, Deserialize, Serialize)]
pub struct GatewayIdentifyPayload {
pub token: String,
@ -9,7 +10,8 @@ pub struct GatewayIdentifyPayload {
#[serde(skip_serializing_if = "Option::is_none")]
pub compress: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub large_threshold: Option<i16>, //default: 50
pub large_threshold: Option<i16>,
//default: 50
#[serde(skip_serializing_if = "Option::is_none")]
pub shard: Option<Vec<(i32, i32)>>,
#[serde(skip_serializing_if = "Option::is_none")]

1
src/types/events/lazy_request.rs
View File

@ -24,4 +24,5 @@ pub struct LazyRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub channels: Option<HashMap<String, Vec<Vec<u64>>>>,
}
impl WebSocketEvent for LazyRequest {}

1
src/types/events/message.rs
View File

@ -126,4 +126,5 @@ pub struct MessageACK {
pub flags: Option<serde_json::Value>,
pub channel_id: String,
}
impl WebSocketEvent for MessageACK {}

53
src/types/events/mod.rs
View File

@ -1,31 +1,5 @@
use serde::{Deserialize, Serialize};
mod application;
mod auto_moderation;
mod call;
mod channel;
mod guild;
mod heartbeat;
mod hello;
mod identify;
mod integration;
mod interaction;
mod invite;
mod lazy_request;
mod message;
mod passive_update;
mod presence;
mod ready;
mod relationship;
mod request_members;
mod resume;
mod session;
mod stage_instance;
mod thread;
mod user;
mod voice;
mod webhooks;
pub use application::*;
pub use auto_moderation::*;
pub use call::*;
@ -52,6 +26,32 @@ pub use user::*;
pub use voice::*;
pub use webhooks::*;
mod application;
mod auto_moderation;
mod call;
mod channel;
mod guild;
mod heartbeat;
mod hello;
mod identify;
mod integration;
mod interaction;
mod invite;
mod lazy_request;
mod message;
mod passive_update;
mod presence;
mod ready;
mod relationship;
mod request_members;
mod resume;
mod session;
mod stage_instance;
mod thread;
mod user;
mod voice;
mod webhooks;
pub trait WebSocketEvent {}
#[derive(Debug, Default, Serialize, Clone)]
@ -79,7 +79,6 @@ impl WebSocketEvent for GatewaySendPayload {}
///
/// Similar to [GatewaySendPayload], except we send a [Value] for d whilst we receive a [serde_json::value::RawValue]
/// Also, we never need to sent the event name
pub struct GatewayReceivePayload<'a> {
#[serde(rename = "op")]
pub op_code: u8,

3
src/types/events/passive_update.rs
View File

@ -1,8 +1,9 @@
use serde::{Deserialize, Serialize};
use super::{ChannelUnreadUpdateObject, WebSocketEvent};
use crate::types::{GuildMember, VoiceState};
use super::{ChannelUnreadUpdateObject, WebSocketEvent};
#[derive(Debug, Deserialize, Serialize, Default)]
/// Officially Undocumented
///

3
src/types/events/presence.rs
View File

@ -1,7 +1,8 @@
use serde::{Deserialize, Serialize};
use crate::types::events::WebSocketEvent;
use crate::types::interfaces::Activity;
use crate::types::PublicUser;
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize, Default, Clone)]
/// See https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields

3
src/types/events/ready.rs
View File

@ -1,8 +1,9 @@
use serde::{Deserialize, Serialize};
use crate::types::entities::{Guild, User};
use crate::types::events::{Session, WebSocketEvent};
use crate::types::interfaces::ClientStatusObject;
use crate::types::{Activity, GuildMember, PresenceUpdate, VoiceState};
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize, Default)]
/// Sort of documented, though most fields are left out

3
src/types/events/relationship.rs
View File

@ -1,6 +1,7 @@
use crate::types::{events::WebSocketEvent, Relationship, RelationshipType, Snowflake};
use serde::{Deserialize, Serialize};
use crate::types::{events::WebSocketEvent, Relationship, RelationshipType, Snowflake};
#[derive(Debug, Deserialize, Serialize, Default)]
/// See https://github.com/spacebarchat/server/issues/204
pub struct RelationshipAdd {

3
src/types/events/request_members.rs
View File

@ -1,6 +1,7 @@
use crate::types::events::WebSocketEvent;
use serde::{Deserialize, Serialize};
use crate::types::events::WebSocketEvent;
#[derive(Debug, Deserialize, Serialize, Default)]
/// See https://discord.com/developers/docs/topics/gateway-events#request-guild-members-request-guild-members-structure
pub struct GatewayRequestGuildMembers {

3
src/types/events/resume.rs
View File

@ -1,6 +1,7 @@
use crate::types::events::WebSocketEvent;
use serde::{Deserialize, Serialize};
use crate::types::events::WebSocketEvent;
#[derive(Debug, Deserialize, Serialize, Default)]
pub struct GatewayResume {
pub token: String,

3
src/types/events/thread.rs
View File

@ -1,6 +1,7 @@
use serde::{Deserialize, Serialize};
use crate::types::entities::{Channel, ThreadMember};
use crate::types::events::WebSocketEvent;
use serde::{Deserialize, Serialize};
#[derive(Debug, Default, Deserialize, Serialize)]
/// See https://discord.com/developers/docs/topics/gateway-events#thread-create

3
src/types/events/user.rs
View File

@ -1,7 +1,8 @@
use serde::{Deserialize, Serialize};
use crate::types::entities::PublicUser;
use crate::types::events::WebSocketEvent;
use crate::types::utils::Snowflake;
use serde::{Deserialize, Serialize};
#[derive(Debug, Default, Deserialize, Serialize)]
/// See https://discord.com/developers/docs/topics/gateway-events#user-update

3
src/types/events/voice.rs
View File

@ -1,6 +1,7 @@
use crate::types::{events::WebSocketEvent, VoiceState};
use serde::{Deserialize, Serialize};
use crate::types::{events::WebSocketEvent, VoiceState};
#[derive(Debug, Deserialize, Serialize, Default)]
/// See https://discord.com/developers/docs/topics/gateway-events#update-voice-state
///

3
src/types/interfaces/activity.rs
View File

@ -1,6 +1,7 @@
use crate::types::entities::Emoji;
use serde::{Deserialize, Serialize};
use crate::types::entities::Emoji;
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct Activity {
name: String,

3
src/types/interfaces/guild_welcome_screen.rs
View File

@ -1,6 +1,7 @@
use crate::types::utils::Snowflake;
use serde::{Deserialize, Serialize};
use crate::types::utils::Snowflake;
#[derive(Serialize, Deserialize, Debug, Default, Clone, PartialEq)]
pub struct WelcomeScreenObject {
pub enabled: bool,

5
src/types/interfaces/interaction.rs
View File

@ -1,8 +1,9 @@
use crate::types::entities::{AllowedMention, Embed};
use crate::types::utils::Snowflake;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use crate::types::entities::{AllowedMention, Embed};
use crate::types::utils::Snowflake;
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
pub struct Interaction {
pub id: Snowflake,

12
src/types/interfaces/mod.rs
View File

@ -1,11 +1,11 @@
mod activity;
mod connected_account;
mod guild_welcome_screen;
mod interaction;
mod status;
pub use activity::*;
pub use connected_account::*;
pub use guild_welcome_screen::*;
pub use interaction::*;
pub use status::*;
mod activity;
mod connected_account;
mod guild_welcome_screen;
mod interaction;
mod status;

4
src/types/schema/auth.rs
View File

@ -1,7 +1,8 @@
use crate::errors::FieldFormatError;
use regex::Regex;
use serde::{Deserialize, Serialize};
use crate::errors::FieldFormatError;
/**
A struct that represents a well-formed email address.
*/
@ -100,7 +101,6 @@ You will receive a [`FieldFormatError`], if:
- The username is not between 2 and 32 characters.
- The password is not between 1 and 72 characters.
*/
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub struct RegisterSchema {

3
src/types/schema/guild.rs
View File

@ -1,6 +1,7 @@
use crate::types::entities::Channel;
use serde::{Deserialize, Serialize};
use crate::types::entities::Channel;
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
/// Represents the schema which needs to be sent to create a Guild.

3
src/types/schema/message.rs
View File

@ -1,7 +1,8 @@
use serde::{Deserialize, Serialize};
use crate::types::entities::{
AllowedMention, Component, Embed, MessageReference, PartialDiscordFileAttachment,
};
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]

19
src/types/schema/mod.rs
View File

@ -1,11 +1,3 @@
mod apierror;
mod auth;
mod channel;
mod guild;
mod message;
mod role;
mod user;
pub use apierror::*;
pub use auth::*;
pub use channel::*;
@ -14,11 +6,20 @@ pub use message::*;
pub use role::*;
pub use user::*;
mod apierror;
mod auth;
mod channel;
mod guild;
mod message;
mod role;
mod user;
#[cfg(test)]
mod schemas_tests {
use super::*;
use crate::errors::FieldFormatError;
use super::*;
#[test]
fn password_too_short() {
assert_eq!(

1
src/types/schema/role.rs
View File

@ -1,4 +1,3 @@
use crate::types::Snowflake;
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize)]

8
src/types/utils/mod.rs
View File

@ -1,8 +1,8 @@
pub use regexes::*;
pub use rights::Rights;
pub use snowflake::{DeconstructedSnowflake, Snowflake};
pub mod jwt;
mod regexes;
mod rights;
mod snowflake;
pub use regexes::*;
pub use rights::Rights;
pub use snowflake::{DeconstructedSnowflake, Snowflake};

3
tests/auth.rs
View File

@ -1,6 +1,7 @@
mod common;
use chorus::types;
mod common;
#[tokio::test]
async fn test_registration() {
let mut bundle = common::setup().await;

7
tests/channel.rs
View File

@ -1,15 +1,16 @@
mod common;
use chorus::types::{self, Channel, PermissionFlags, PermissionOverwrite};
mod common;
#[tokio::test]
async fn get_channel() {
let mut bundle = common::setup().await;
let bundle_channel = bundle.channel.clone();
let mut bundle_user = &mut bundle.user;
let bundle_user = &mut bundle.user;
assert_eq!(
bundle_channel,
Channel::get(&mut bundle_user, &bundle_channel.id.to_string(),)
Channel::get(bundle_user, &bundle_channel.id.to_string())
.await
.unwrap()
);

3
tests/guild.rs
View File

@ -1,6 +1,7 @@
mod common;
use chorus::types::{Guild, GuildCreateSchema};
mod common;
#[tokio::test]
async fn guild_creation_deletion() {
let mut bundle = common::setup().await;

4
tests/member.rs
View File

@ -7,7 +7,7 @@ async fn add_remove_role() {
let role_id = &bundle.role.id.to_string();
let user_id = &bundle.user.object.id.to_string();
chorus::types::GuildMember::add_role(&mut bundle.user, guild_id, user_id, role_id).await;
let member = chorus::types::GuildMember::get(&mut bundle.user, &guild_id, &user_id)
let member = chorus::types::GuildMember::get(&mut bundle.user, guild_id, user_id)
.await
.unwrap();
let mut role_found = false;
@ -21,7 +21,7 @@ async fn add_remove_role() {
assert!(false)
}
chorus::types::GuildMember::remove_role(&mut bundle.user, guild_id, user_id, role_id).await;
let member = chorus::types::GuildMember::get(&mut bundle.user, &guild_id, &user_id)
let member = chorus::types::GuildMember::get(&mut bundle.user, guild_id, user_id)
.await
.unwrap();
for role in member.roles.iter() {

7
tests/message.rs
View File

@ -1,9 +1,10 @@
mod common;
use chorus::types;
use std::fs::File;
use std::io::{BufReader, Read};
use chorus::types;
mod common;
#[tokio::test]
async fn send_message() {
let mut bundle = common::setup().await;

4
tests/roles.rs
View File

@ -1,7 +1,7 @@
mod common;
use chorus::types::{self, RoleCreateModifySchema};
mod common;
#[tokio::test]
async fn create_and_get_roles() {
let mut bundle = common::setup().await;