mangadex_api/v5/api_client/id/
delete.rs

1//! Builder for the delete manga endpoint.
2//!
3//! <https://api.mangadex.org/docs/redoc.html#tag/ApiClient/operation/delete-apiclient>
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//!     // Putting your login script
18//!     let _login_res = client
19//!         .auth()
20//!         .login()
21//!         .username(Username::parse("myusername")?)
22//!         .password(Password::parse("hunter23")?)
23//!         .send()
24//!         .await?;
25//!  */
26//!
27//!
28//! let client_id = Uuid::new_v4();
29//! let res = client
30//!     .client()
31//!     .id(client_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;
47use mangadex_api_types::error::Result;
48
49#[cfg_attr(
50    feature = "deserializable-endpoint",
51    derive(serde::Deserialize, getset::Getters, getset::Setters)
52)]
53#[derive(Debug, Serialize, Clone, Builder)]
54#[serde(rename_all = "camelCase")]
55#[builder(build_fn(error = "mangadex_api_types::error::BuilderError"))]
56pub struct DeleteClient {
57    /// This should never be set manually as this is only for internal use.
58    #[doc(hidden)]
59    #[serde(skip)]
60    #[builder(pattern = "immutable")]
61    #[cfg_attr(feature = "deserializable-endpoint", getset(set = "pub", get = "pub"))]
62    pub http_client: HttpClientRef,
63
64    #[serde(skip_serializing)]
65    pub client_id: Uuid,
66    #[serde(skip_serializing_if = "Option::is_none")]
67    #[builder(default)]
68    pub version: Option<u32>,
69}
70
71endpoint! {
72    DELETE ("/client/{}", client_id),
73    #[query auth] DeleteClient,
74    #[discard_result] Result<NoData>,
75    DeleteClientBuilder
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_client_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(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 client_id = Uuid::new_v4();
102        let response_body = json!({
103            "result": "ok",
104        });
105
106        Mock::given(method("DELETE"))
107            .and(path_regex(r"/client/[0-9a-fA-F-]+"))
108            .and(header("Authorization", "Bearer sessiontoken"))
109            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
110            .expect(1)
111            .mount(&mock_server)
112            .await;
113
114        mangadex_client
115            .client()
116            .id(client_id)
117            .delete()
118            .send()
119            .await?;
120
121        Ok(())
122    }
123}
mangadex_api/v5/api_client/id/delete.rs

mangadex_api/v5/api_client/id/
delete.rs
