mangadex_api/v5/cover/cover_id/
put.rs

1//! Builder for the edit cover endpoint.
2//!
3//! <https://api.mangadex.org/docs/swagger.html#/Cover/edit-cover>
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//!     let _login_res = client
18//!         .auth()
19//!         .login()
20//!         .username(Username::parse("myusername")?)
21//!         .password(Password::parse("hunter23")?)
22//!         .send()
23//!         .await?;
24//! */
25//! let cover_id = Uuid::new_v4();
26//! let res = client
27//!     .cover()
28//!     .cover_id(cover_id)
29//!     .put()
30//!     .volume(Some("1".to_string()))
31//!     .version(2_u32)
32//!     .send()
33//!     .await?;
34//!
35//! println!("edit: {:?}", res);
36//! # Ok(())
37//! # }
38//! ```
39
40use derive_builder::Builder;
41use serde::Serialize;
42use uuid::Uuid;
43
44use crate::HttpClientRef;
45use mangadex_api_schema::v5::CoverData;
46use mangadex_api_types::Language;
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 = "mangadex_api_types::error::BuilderError")
57)]
58#[cfg_attr(feature = "non_exhaustive", non_exhaustive)]
59pub struct EditCover {
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    /// Manga **or** Cover ID.
68    #[serde(skip_serializing)]
69    pub cover_id: Uuid,
70
71    /// 0-8 characters in length.
72    pub volume: String,
73    /// 0-512 characters in length.
74    #[serde(skip_serializing_if = "Option::is_none")]
75    #[builder(default)]
76    pub description: Option<String>,
77    #[serde(skip_serializing_if = "Option::is_none")]
78    #[builder(default)]
79    pub locale: Option<Language>,
80    /// >= 1
81    pub version: u32,
82}
83
84endpoint! {
85    PUT ("/cover/{}", cover_id),
86    #[body auth] EditCover,
87    #[rate_limited] CoverData,
88    EditCoverBuilder
89}
90
91#[cfg(test)]
92mod tests {
93    use fake::faker::lorem::en::Sentence;
94    use fake::Fake;
95    use serde_json::json;
96    use time::OffsetDateTime;
97    use url::Url;
98    use uuid::Uuid;
99    use wiremock::matchers::{body_json, header, method, path_regex};
100    use wiremock::{Mock, MockServer, ResponseTemplate};
101
102    use crate::v5::AuthTokens;
103    use crate::{HttpClient, MangaDexClient};
104    use mangadex_api_types::MangaDexDateTime;
105
106    #[tokio::test]
107    async fn edit_cover_fires_a_request_to_base_url() -> anyhow::Result<()> {
108        let mock_server = MockServer::start().await;
109        let http_client = HttpClient::builder()
110            .base_url(Url::parse(&mock_server.uri())?)
111            .auth_tokens(AuthTokens {
112                session: "sessiontoken".to_string(),
113                refresh: "refreshtoken".to_string(),
114            })
115            .build()?;
116        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
117
118        let cover_id = Uuid::new_v4();
119        let description: String = Sentence(1..3).fake();
120
121        let datetime = MangaDexDateTime::new(&OffsetDateTime::now_utc());
122
123        let expected_body = json!({
124            "volume": "1",
125            "version": 2
126        });
127        let response_body = json!({
128            "result": "ok",
129            "response": "entity",
130            "data": {
131                "id": cover_id,
132                "type": "cover_art",
133                "attributes": {
134                    "volume": "1",
135                    "fileName": "1.jpg",
136                    "description": description,
137                    "locale": "en",
138                    "version": 1,
139                    "createdAt": datetime.to_string(),
140                    "updatedAt": datetime.to_string(),
141
142                },
143                "relationships": []
144            }
145        });
146
147        Mock::given(method("PUT"))
148            .and(path_regex(r"/cover/[0-9a-fA-F-]+"))
149            .and(header("Authorization", "Bearer sessiontoken"))
150            .and(header("Content-Type", "application/json"))
151            .and(body_json(expected_body))
152            .respond_with(
153                ResponseTemplate::new(200)
154                    .insert_header("x-ratelimit-retry-after", "1698723860")
155                    .insert_header("x-ratelimit-limit", "40")
156                    .insert_header("x-ratelimit-remaining", "39")
157                    .set_body_json(response_body),
158            )
159            .expect(1)
160            .mount(&mock_server)
161            .await;
162
163        let _ = mangadex_client
164            .cover()
165            .cover_id(cover_id)
166            .put()
167            .volume(String::from("1"))
168            .version(2_u32)
169            .send()
170            .await?;
171
172        Ok(())
173    }
174}
mangadex_api/v5/cover/cover_id/put.rs

mangadex_api/v5/cover/cover_id/
put.rs
