mangadex_api/v5/settings/
post.rs

1//! Builder for creating or updating a user's Settings.
2//!
3//! <https://api.mangadex.org/docs/swagger.html#/Settings/post-settings>
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//!     .post()
28//!     .send()
29//!     .await?;
30//!
31//! println!("Create Settings: {:?}", res);
32//! # Ok(())
33//! # }
34//! ```
35
36use std::collections::HashMap;
37
38use derive_builder::Builder;
39use mangadex_api_schema::v5::UserSettingsAttributes;
40// use mangadex_api_schema::v5::UserSettingsResponse;
41// use crate::Result;
42use mangadex_api_types::MangaDexDateTime;
43use serde::Serialize;
44
45use crate::HttpClientRef;
46
47/// Create or update a user's Settings.
48///
49/// This requires authentication.
50///
51/// Makes a request to `POST /settings`.
52#[cfg_attr(
53    feature = "deserializable-endpoint",
54    derive(serde::Deserialize, getset::Getters, getset::Setters)
55)]
56#[derive(Debug, Serialize, Clone, Builder)]
57#[serde(rename_all = "camelCase")]
58#[builder(
59    setter(into, strip_option),
60    build_fn(error = "crate::error::BuilderError")
61)]
62#[non_exhaustive]
63pub struct CreateOrUpdateUserSettings {
64    /// This should never be set manually as this is only for internal use.
65    #[doc(hidden)]
66    #[serde(skip)]
67    #[builder(pattern = "immutable")]
68    #[allow(unused)]
69    #[cfg_attr(feature = "deserializable-endpoint", getset(set = "pub", get = "pub"))]
70    pub http_client: HttpClientRef,
71
72    // TODO: Flesh out body.
73    #[builder(default)]
74    pub settings: HashMap<String, String>,
75    #[builder(default)]
76    pub updated_at: MangaDexDateTime,
77}
78
79endpoint! {
80    POST "/settings",
81    #[body auth] CreateOrUpdateUserSettings,
82    #[flatten_result] crate::Result<UserSettingsAttributes>,
83    CreateOrUpdateUserSettingsBuilder
84}
85
86#[cfg(test)]
87mod tests {
88    use serde_json::json;
89    use url::Url;
90    use uuid::Uuid;
91    use wiremock::matchers::{header, method, path};
92    use wiremock::{Mock, MockServer, ResponseTemplate};
93
94    use crate::error::Error;
95    use crate::{HttpClient, MangaDexClient};
96
97    #[tokio::test]
98    async fn create_or_update_user_settings_requires_auth() -> anyhow::Result<()> {
99        let mock_server = MockServer::start().await;
100        let http_client: HttpClient = HttpClient::builder()
101            .base_url(Url::parse(&mock_server.uri())?)
102            .build()?;
103        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
104
105        let error_id = Uuid::new_v4();
106        let response_body = json!({
107            "result": "error",
108            "errors": [{
109                "id": error_id.to_string(),
110                "status": 403,
111                "title": "Forbidden",
112                "detail": "You must be logged in to continue."
113            }]
114        });
115
116        Mock::given(method("POST"))
117            .and(path("/settings"))
118            .and(header("Content-Type", "application/json"))
119            .respond_with(ResponseTemplate::new(403).set_body_json(response_body))
120            .expect(0)
121            .mount(&mock_server)
122            .await;
123
124        let res = mangadex_client
125            .settings()
126            .post()
127            .send()
128            .await
129            .expect_err("expected error");
130
131        match res {
132            Error::MissingTokens => {}
133            _ => panic!("unexpected error: {res:#?}"),
134        }
135
136        Ok(())
137    }
138}
mangadex_api/v5/settings/post.rs

mangadex_api/v5/settings/
post.rs
