1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Blocks the specified user on behalf of the authenticated user.
//! [`block-user`](https://dev.twitch.tv/docs/api/reference#block-user)
//!
//! # Accessing the endpoint
//!
//! ## Request: [BlockUserRequest]
//!
//! To use this endpoint, construct a [`BlockUserRequest`] with the [`BlockUserRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::users::block_user::{self, Reason, SourceContext};
//! let request = block_user::BlockUserRequest::builder()
//!     .target_user_id("1234")
//!     .build();
//! // Or, specifying a reason for the block
//! let request = block_user::BlockUserRequest::builder()
//!     .target_user_id("1234")
//!     .source_context(SourceContext::Chat)
//!     .reason(Reason::Spam)
//!     .build();
//! ```
//!
//! ## Response: [BlockUser]
//!
//! Send the request to receive the response with [`HelixClient::req_put()`](helix::HelixClient::req_put).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, users::block_user};
//! # use twitch_api2::client;
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
//! # let client: helix::HelixClient<'static, client::DummyHttpClient> = helix::HelixClient::default();
//! # let token = twitch_oauth2::AccessToken::new("validtoken".to_string());
//! # let token = twitch_oauth2::UserToken::from_existing(&client, token, None, None).await?;
//! let request = block_user::BlockUserRequest::builder()
//!     .target_user_id("1234")
//!     .build();
//! let response: block_user::BlockUser = client.req_put(request, helix::EmptyBody, &token).await?.data;
//! # Ok(())
//! # }
//! ```
//!
//! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestPut::create_request)
//! and parse the [`http::Response`] with [`BlockUserRequest::parse_response(None, &request.get_uri(), response)`](BlockUserRequest::parse_response)

use super::*;
use helix::RequestPut;

/// Query Parameters for [Block User](super::block_user)
///
/// [`block-user`](https://dev.twitch.tv/docs/api/reference#block-user)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct BlockUserRequest {
    /// User ID of the follower
    #[builder(setter(into))]
    pub target_user_id: types::UserId,
    /// Source context for blocking the user. Valid values: "chat", "whisper".
    #[builder(default, setter(into))]
    pub source_context: Option<SourceContext>,
    /// Reason for blocking the user. Valid values: "spam", "harassment", or "other".
    #[builder(default, setter(into))]
    pub reason: Option<Reason>,
}

/// Source context for blocking the user.
#[derive(PartialEq, Deserialize, Serialize, Clone, Debug)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum SourceContext {
    /// Chat
    Chat,
    /// Whisper
    Whispher,
}

/// Reason for blocking the user.
#[derive(PartialEq, Deserialize, Serialize, Clone, Debug)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum Reason {
    /// Spam
    Spam,
    /// Harassment
    Harassment,
    /// Other
    Other,
}

/// Return Values for [Block User](super::block_user)
///
/// [`block-user`](https://dev.twitch.tv/docs/api/reference#block-user)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[non_exhaustive]
pub enum BlockUser {
    /// 204 - User blocked successfully.
    Success,
}

impl Request for BlockUserRequest {
    type Response = BlockUser;

    #[cfg(feature = "twitch_oauth2")]
    const OPT_SCOPE: &'static [twitch_oauth2::Scope] = &[];
    const PATH: &'static str = "users/blocks";
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: &'static [twitch_oauth2::Scope] = &[twitch_oauth2::Scope::UserManageBlockedUsers];
}

impl RequestPut for BlockUserRequest {
    type Body = helix::EmptyBody;

    fn parse_inner_response(
        request: Option<Self>,
        uri: &http::Uri,
        response: &str,
        status: http::StatusCode,
    ) -> Result<helix::Response<Self, Self::Response>, helix::HelixRequestPutError>
    where
        Self: Sized,
    {
        match status {
            http::StatusCode::NO_CONTENT => Ok(helix::Response {
                data: BlockUser::Success,
                pagination: None,
                request,
                total: None,
                other: None,
            }),
            _ => Err(helix::HelixRequestPutError::InvalidResponse {
                reason: "unexpected status",
                response: response.to_string(),
                status,
                uri: uri.clone(),
            }),
        }
    }
}

#[cfg(test)]
#[test]
fn test_request() {
    use helix::*;
    let req = BlockUserRequest::builder()
        .target_user_id("41245071".to_string())
        .build();

    dbg!(req.create_request(EmptyBody, "token", "clientid").unwrap());

    // From twitch docs
    let data = br#""#.to_vec();

    let http_response = http::Response::builder().status(204).body(data).unwrap();
    // FIXME: I have not tested this in production

    let uri = req.get_uri().unwrap();
    assert_eq!(
        uri.to_string(),
        "https://api.twitch.tv/helix/users/blocks?target_user_id=41245071"
    );

    dbg!(BlockUserRequest::parse_response(Some(req), &uri, http_response).unwrap());
}