mangadex_api/v5/settings/template/
post.rs

1//! Builder for creating a Settings template.
2//!
3//! <https://api.mangadex.org/docs/swagger.html#/Settings/post-settings-template>
4//!
5//! ```rust
6//! use mangadex_api::MangaDexClient;
7//! // use mangadex_api_types::{Password, Username};
8//!
9//! # async fn run() -> anyhow::Result<()> {
10//! let client = MangaDexClient::default();
11//!
12//! /*
13//!
14//!     let _login_res = client
15//!         .auth()
16//!         .login()
17//!         .post()
18//!         .username(Username::parse("myusername")?)
19//!         .password(Password::parse("hunter23")?)
20//!         .send()
21//!         .await?;
22//!
23//!  */
24//!
25//! let res = client
26//!     .settings()
27//!     .template()
28//!     .post()
29//!     .send()
30//!     .await?;
31//!
32//! println!("Create Settings template: {:?}", res);
33//! # Ok(())
34//! # }
35//! ```
36
37// TODO Implement a schema
38
39use derive_builder::Builder;
40use serde::Serialize;
41
42use crate::HttpClientRef;
43use mangadex_api_schema::NoData;
44use mangadex_api_types::error::Result;
45
46/// Create a Settings template.
47///
48/// This requires authentication.
49///
50/// Makes a request to `POST /settings/template`.
51#[cfg_attr(
52    feature = "deserializable-endpoint",
53    derive(serde::Deserialize, getset::Getters, getset::Setters)
54)]
55#[derive(Debug, Serialize, Clone, Builder)]
56#[serde(rename_all = "camelCase")]
57#[builder(
58    setter(into, strip_option),
59    build_fn(error = "mangadex_api_types::error::BuilderError")
60)]
61#[cfg_attr(feature = "non_exhaustive", non_exhaustive)]
62pub struct CreateSettingsTemplate {
63    /// This should never be set manually as this is only for internal use.
64    #[doc(hidden)]
65    #[serde(skip)]
66    #[builder(pattern = "immutable")]
67    #[allow(unused)]
68    #[cfg_attr(feature = "deserializable-endpoint", getset(set = "pub", get = "pub"))]
69    pub http_client: HttpClientRef,
70
71    #[builder(default)]
72    #[serde(flatten)]
73    pub template: serde_json::Value,
74}
75
76endpoint! {
77    POST "/settings/template",
78    #[body auth] CreateSettingsTemplate,
79    #[discard_result] Result<NoData>,
80    CreateSettingsTemplateBuilder
81}
82
83#[cfg(test)]
84mod tests {
85    use mangadex_api_schema::v5::AuthTokens;
86    use mangadex_api_types::ResultType;
87    use serde::Serialize;
88    use serde_json::json;
89    use url::Url;
90    use uuid::Uuid;
91    use wiremock::matchers::{body_json, header, method, path};
92    use wiremock::{Mock, MockServer, ResponseTemplate};
93
94    use crate::{HttpClient, MangaDexClient};
95    use mangadex_api_types::error::Error;
96
97    #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
98    struct TestTemplate {
99        description: String,
100        value: u32,
101    }
102    #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
103    struct TestTemplateResponse {
104        result: ResultType,
105        description: String,
106        value: u32,
107    }
108    impl From<TestTemplate> for TestTemplateResponse {
109        fn from(value: TestTemplate) -> Self {
110            Self {
111                result: ResultType::Ok,
112                description: value.description,
113                value: value.value,
114            }
115        }
116    }
117    #[tokio::test]
118    async fn create_settings_template_requires_auth() -> anyhow::Result<()> {
119        let mock_server = MockServer::start().await;
120        let http_client: HttpClient = HttpClient::builder()
121            .base_url(Url::parse(&mock_server.uri())?)
122            .auth_tokens(AuthTokens {
123                session: "sessiontoken".to_string(),
124                refresh: "refreshtoken".to_string(),
125            })
126            .build()?;
127        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
128        let resp = TestTemplate {
129            description: "Lorem ipsum".into(),
130            value: 13,
131        };
132
133        let response_body = serde_json::to_value(&resp)?;
134
135        Mock::given(method("POST"))
136            .and(path("/settings/template"))
137            .and(header("Content-Type", "application/json"))
138            .and(header("Authorization", "Bearer sessiontoken"))
139            .and(body_json(&resp))
140            .respond_with(ResponseTemplate::new(200).set_body_json({
141                let body: TestTemplateResponse = resp.into();
142                body
143            }))
144            .mount(&mock_server)
145            .await;
146
147        mangadex_client
148            .settings()
149            .template()
150            .post()
151            .template(response_body)
152            .send()
153            .await?;
154
155        Ok(())
156    }
157    #[tokio::test]
158    async fn create_settings_template_requires_auth_403() -> anyhow::Result<()> {
159        let mock_server = MockServer::start().await;
160        let http_client: HttpClient = HttpClient::builder()
161            .base_url(Url::parse(&mock_server.uri())?)
162            .build()?;
163        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
164
165        let error_id = Uuid::new_v4();
166        let response_body = json!({
167            "result": "error",
168            "errors": [{
169                "id": error_id.to_string(),
170                "status": 403,
171                "title": "Forbidden",
172                "detail": "You must be logged in to continue."
173            }]
174        });
175
176        Mock::given(method("POST"))
177            .and(path("/settings/template"))
178            .and(header("Content-Type", "application/json"))
179            .respond_with(ResponseTemplate::new(403).set_body_json(response_body))
180            .expect(0)
181            .mount(&mock_server)
182            .await;
183
184        let res = mangadex_client
185            .settings()
186            .template()
187            .post()
188            .send()
189            .await
190            .expect_err("expected error");
191
192        match res {
193            Error::MissingTokens => {}
194            Error::Api(e) => assert_eq!(e.errors[0].status, 403),
195            _ => panic!("unexpected error: {:#?}", res),
196        }
197
198        Ok(())
199    }
200}
mangadex_api/v5/settings/template/post.rs

mangadex_api/v5/settings/template/
post.rs
