mangadex_api/v5/author/id/
delete.rs

1//! Builder for the author delete endpoint.
2//!
3//! <https://api.mangadex.org/docs/swagger.html#/Author/delete-author-id>
4//!
5//! # Examples
6//!
7//! ```rust
8//! use uuid::Uuid;
9//!
10//! use mangadex_api::v5::MangaDexClient;
11//! use mangadex_api_types::{Password, Username};
12//!
13//! # async fn run() -> anyhow::Result<()> {
14//! let client = MangaDexClient::default();
15//!
16//! /*
17//!     Put your logging script here
18//!     let _login_res = client
19//!         .auth()
20//!         .login()
21//!         .post()
22//!         .username(Username::parse("myusername")?)
23//!         .password(Password::parse("hunter23")?)
24//!         .build()?
25//!         .send()
26//!         .await?;
27//!  */
28//!
29//!
30//! let author_id = Uuid::new_v4();
31//! let res = client
32//!     .author()
33//!     .id(author_id)
34//!     .delete()
35//!     .send()
36//!     .await?;
37//!
38//! println!("author delete: {:?}", res);
39//! # Ok(())
40//! # }
41//! ```
42
43use derive_builder::Builder;
44use serde::Serialize;
45use uuid::Uuid;
46
47use crate::HttpClientRef;
48use mangadex_api_schema::NoData;
49
50#[cfg_attr(
51    feature = "deserializable-endpoint",
52    derive(serde::Deserialize, getset::Getters, getset::Setters)
53)]
54#[derive(Debug, Serialize, Clone, Builder)]
55#[serde(rename_all = "camelCase")]
56#[builder(
57    setter(into, strip_option),
58    build_fn(error = "mangadex_api_types::error::BuilderError")
59)]
60pub struct DeleteAuthor {
61    /// This should never be set manually as this is only for internal use.
62    #[doc(hidden)]
63    #[serde(skip)]
64    #[builder(pattern = "immutable")]
65    #[cfg_attr(feature = "deserializable-endpoint", getset(set = "pub", get = "pub"))]
66    pub http_client: HttpClientRef,
67
68    #[serde(skip_serializing)]
69    pub author_id: Uuid,
70}
71
72endpoint! {
73    DELETE ("/author/{}", author_id),
74    #[no_data auth] DeleteAuthor,
75    #[rate_limited] NoData,
76    DeleteAuthorBuilder
77}
78
79#[cfg(test)]
80mod tests {
81    use serde_json::json;
82    use url::Url;
83    use uuid::Uuid;
84    use wiremock::matchers::{header, method, path_regex};
85    use wiremock::{Mock, MockServer, ResponseTemplate};
86
87    use crate::v5::AuthTokens;
88    use crate::{HttpClient, MangaDexClient};
89
90    #[tokio::test]
91    async fn delete_author_fires_a_request_to_base_url() -> anyhow::Result<()> {
92        let mock_server = MockServer::start().await;
93        let http_client = HttpClient::builder()
94            .base_url(Url::parse(&mock_server.uri())?)
95            .auth_tokens(AuthTokens {
96                session: "sessiontoken".to_string(),
97                refresh: "refreshtoken".to_string(),
98            })
99            .build()?;
100        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
101
102        let author_id = Uuid::new_v4();
103        let response_body = json!({
104            "result": "ok",
105        });
106
107        Mock::given(method("DELETE"))
108            .and(path_regex(r"/author/[0-9a-fA-F-]+"))
109            .and(header("Authorization", "Bearer sessiontoken"))
110            .respond_with(
111                ResponseTemplate::new(200)
112                    .insert_header("x-ratelimit-retry-after", "1698723860")
113                    .insert_header("x-ratelimit-limit", "40")
114                    .insert_header("x-ratelimit-remaining", "39")
115                    .set_body_json(response_body),
116            )
117            .expect(1)
118            .mount(&mock_server)
119            .await;
120
121        mangadex_client
122            .author()
123            .id(author_id)
124            .delete()
125            .send()
126            .await?;
127
128        Ok(())
129    }
130}