mangadex_api/v5/auth/check/
get.rs

1//! Builder for the auth session check endpoint.
2//!
3//! <https://api.mangadex.org/docs/swagger.html#/Auth/get-auth-check>
4//!
5//! # Examples
6//!
7//! ```rust
8//! use mangadex_api::MangaDexClient;
9//! use mangadex_api_types::{Password, Username};
10//!
11//! # async fn run() -> anyhow::Result<()> {
12//! let client = MangaDexClient::default();
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//! let auth_check_res = client
24//!     .auth()
25//!     .check()
26//!     .get()
27//!     .send()
28//!     .await?;
29//!
30//! println!("auth check: {:?}", auth_check_res);
31//! # Ok(())
32//! # }
33//! ```
34
35use derive_builder::Builder;
36use serde::Serialize;
37
38use crate::HttpClientRef;
39use mangadex_api_schema::v5::CheckTokenResponse;
40use mangadex_api_types::error::Result;
41
42/// Check the session token and get additional user information.
43///
44/// Makes a request to `POST /auth/check`.
45// It doesn't make much sense to make this a builder pattern but for consistency, it is.
46#[cfg_attr(
47    feature = "deserializable-endpoint",
48    derive(serde::Deserialize, getset::Getters, getset::Setters)
49)]
50#[derive(Debug, Serialize, Clone, Builder)]
51#[serde(rename_all = "camelCase")]
52#[builder(
53    setter(into, strip_option),
54    build_fn(error = "mangadex_api_types::error::BuilderError")
55)]
56pub struct CheckToken {
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
65endpoint! {
66    GET "/auth/check",
67    #[no_data auth] CheckToken,
68    #[flatten_result] Result<CheckTokenResponse>,
69    CheckTokenBuilder
70}
71
72#[cfg(test)]
73mod tests {
74    use serde_json::json;
75    use url::Url;
76    use wiremock::matchers::{header, method, path};
77    use wiremock::{Mock, MockServer, ResponseTemplate};
78
79    use crate::v5::AuthTokens;
80    use crate::{HttpClient, MangaDexClient};
81
82    #[tokio::test]
83    async fn check_token_fires_a_request_to_base_url() -> anyhow::Result<()> {
84        let mock_server = MockServer::start().await;
85        let http_client: HttpClient = HttpClient::builder()
86            .base_url(Url::parse(&mock_server.uri())?)
87            .auth_tokens(AuthTokens {
88                session: "sessiontoken".to_string(),
89                refresh: "refreshtoken".to_string(),
90            })
91            .build()?;
92        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
93
94        let response_body = json!({
95            "result": "ok",
96            "isAuthenticated": true,
97            "roles": [
98                "ROLE_MEMBER",
99                "IS_JWT_AUTHENTICATED",
100                "IS_AUTHENTICATED_FULLY",
101                "IS_AUTHENTICATED_ANONYMOUSLY",
102                "IS_AUTHENTICATED_REMEMBERED"
103            ],
104            "permissions": [
105                "user.list",
106                "manga.view",
107                "chapter.view",
108                "author.view",
109                "scanlation_group.view",
110                "cover.view",
111                "manga.list",
112                "chapter.list",
113                "author.list",
114                "scanlation_group.list",
115                "cover.list"
116            ]
117        });
118
119        Mock::given(method("GET"))
120            .and(path(r"/auth/check"))
121            .and(header("Authorization", "Bearer sessiontoken"))
122            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
123            .expect(1)
124            .mount(&mock_server)
125            .await;
126
127        let _ = mangadex_client.auth().check().get().send().await?;
128
129        Ok(())
130    }
131}
mangadex_api/v5/auth/check/get.rs

mangadex_api/v5/auth/check/
get.rs
