Skip to main content

mangadex_api/v5/chapter/id/
delete.rs

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