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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
use crate::twitch::Capability;
use std::collections::BTreeSet;

/**
User configuration for 'registering' with Twitch

This is used to *register* the connection with the server

It contains your user name, your OAuth token and the capabilities you want to request.

# example using a builder
```
# use twitchchat::twitch::{Capability, UserConfig};
# std::env::set_var("TWITCH_NAME", "foo");
# std::env::set_var("TWITCH_TOKEN", format!("oauth:{}", "a".repeat(30)));
// as anonymous
let config = UserConfig::builder().anonymous().build().unwrap();
// or with a name/token
let name = std::env::var("TWITCH_NAME").unwrap();
let token = std::env::var("TWITCH_TOKEN").unwrap();
let config = UserConfig::builder()
    .name(name)
    .token(token)
    .capabilities(&[Capability::Tags])
    .build()
    .unwrap();
```
*/
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UserConfig {
    /// Requested name of your user

    pub name: String,
    /// OAuth token of the user

    pub token: String,
    /// Capabilities to be requested from the server

    pub capabilities: Vec<Capability>,
}

impl UserConfig {
    /// Create a builder to make a [UserConfig]

    pub fn builder() -> UserConfigBuilder {
        UserConfigBuilder::default()
    }

    /// Determines whether this config was requested as anonymous

    pub fn is_anonymous(&self) -> bool {
        self.name == crate::JUSTINFAN1234 && self.token == crate::JUSTINFAN1234
    }
}

/// User config error returned by the [UserConfigBuilder]

#[non_exhaustive]
#[derive(Debug, Copy, Clone)]
pub enum UserConfigError {
    /// An invalid name was provided

    InvalidName,
    /// An invalid token was provided.

    InvalidToken,
    /// Anonymous login was requested with a user-provided name or token

    PartialAnonymous,
}

impl std::fmt::Display for UserConfigError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::InvalidName => f.write_str("invalid name"),
            Self::InvalidToken => {
                f.write_str("invalid token. token must start with oauth: and be 36 characters")
            }
            Self::PartialAnonymous => f.write_str(
                "user provided name or token provided when an anonymous login was requested",
            ),
        }
    }
}

impl std::error::Error for UserConfigError {}

/// Builder for making a [UserConfig]

#[derive(Default, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UserConfigBuilder {
    capabilities: BTreeSet<Capability>,
    name: Option<String>,
    token: Option<String>,
}

impl UserConfigBuilder {
    /// Name for the connection

    pub fn name(mut self, name: impl ToString) -> Self {
        self.name.replace(name.to_string());
        self
    }

    /// Token for the connection

    ///

    /// This is an oauth token. It must have atleast two [scopes]: `chat:read`, `chat:edit`

    ///

    /// [scopes]: https://dev.twitch.tv/docs/authentication/#scopes

    pub fn token(mut self, token: impl ToString) -> Self {
        self.token.replace(token.to_string());
        self
    }

    /// Uses an anonymous login

    ///

    /// This uses `"justin1234"` as the name and token

    ///

    pub fn anonymous(self) -> Self {
        let (name, token) = crate::ANONYMOUS_LOGIN;
        self.name(name).token(token)
    }

    /// Capabilities to enable

    ///

    pub fn capabilities(mut self, caps: &[Capability]) -> Self {
        self.capabilities.extend(caps);
        self
    }

    /// Enables all of the capabilities.

    ///

    /// This is just a shortcut for enabling all of the Capabilities listed [here].

    ///

    /// [here]: Capability

    pub fn enable_all_capabilities(self) -> Self {
        self.capabilities(&[
            Capability::Membership,
            Capability::Tags,
            Capability::Commands,
        ])
    }

    /// Tries to build the UserConfig

    ///

    /// This returns an error if the name or token are invalid

    ///

    /// If the anonymous `name` OR `token` is used without the other matching one this will return an [error].

    ///

    /// [error]: UserConfigError

    pub fn build(self) -> Result<UserConfig, UserConfigError> {
        let name = self
            .name
            .filter(|s| validate_name(s))
            .ok_or(UserConfigError::InvalidName)?;

        let token = self
            .token
            .filter(|s| validate_token(s))
            .ok_or(UserConfigError::InvalidToken)?;

        match (name.as_str(), token.as_str()) {
            (crate::JUSTINFAN1234, crate::JUSTINFAN1234) => {
                // both are allowed

            }
            (crate::JUSTINFAN1234, ..) | (.., crate::JUSTINFAN1234) => {
                return Err(UserConfigError::PartialAnonymous)
            }
            _ => {}
        }

        Ok(UserConfig {
            name,
            token,
            capabilities: self.capabilities.into_iter().collect(),
        })
    }
}

#[inline]
const fn validate_name(s: &str) -> bool {
    !s.is_empty()
}

#[inline]
fn validate_token(s: &str) -> bool {
    if s == crate::JUSTINFAN1234 {
        return true;
    }
    !s.is_empty() && s.len() == 36 && &s[..6] == "oauth:"
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn valid_user_config_no_caps() {
        let config = UserConfig::builder()
            .name("foo")
            .token(format!("oauth:{}", "a".repeat(30)))
            .build()
            .unwrap();

        assert_eq!(
            config,
            UserConfig {
                name: "foo".to_string(),
                token: format!("oauth:{}", "a".repeat(30)),
                capabilities: vec![],
            }
        )
    }

    #[test]
    fn valid_user_config() {
        let config = UserConfig::builder()
            .name("foo")
            .token(format!("oauth:{}", "a".repeat(30)))
            .capabilities(&[Capability::Tags, Capability::Tags])
            .capabilities(&[Capability::Membership])
            .build()
            .unwrap();

        assert_eq!(
            config,
            UserConfig {
                name: "foo".to_string(),
                token: format!("oauth:{}", "a".repeat(30)),
                capabilities: vec![Capability::Membership, Capability::Tags,],
            }
        )
    }

    #[test]
    fn valid_user_config_anonymous() {
        let config = UserConfig::builder().anonymous().build().unwrap();

        assert_eq!(
            config,
            UserConfig {
                name: crate::JUSTINFAN1234.to_string(),
                token: crate::JUSTINFAN1234.to_string(),
                capabilities: vec![],
            }
        );

        assert!(config.is_anonymous());
    }

    #[test]
    fn invalid_name_missing() {
        let err = UserConfig::builder().build().unwrap_err();
        matches!(err, UserConfigError::InvalidName);
    }

    #[test]
    fn invalid_partial_login_name() {
        let err = UserConfig::builder()
            .anonymous()
            .name("foo")
            .build()
            .unwrap_err();
        matches!(err, UserConfigError::PartialAnonymous);
    }

    #[test]
    fn invalid_partial_login_token() {
        let err = UserConfig::builder()
            .anonymous()
            .token(format!("oauth:{}", "a".repeat(30)))
            .build()
            .unwrap_err();
        matches!(err, UserConfigError::PartialAnonymous);
    }

    #[test]
    fn invalid_token_missing() {
        let err = UserConfig::builder().name("foobar").build().unwrap_err();
        matches!(err, UserConfigError::InvalidToken);
    }

    #[test]
    fn invalid_token_empty() {
        let err = UserConfig::builder()
            .name("foobar")
            .token("")
            .build()
            .unwrap_err();
        matches!(err, UserConfigError::InvalidToken);
    }

    #[test]
    fn invalid_token_short() {
        let err = UserConfig::builder()
            .name("foobar")
            .token("foo")
            .build()
            .unwrap_err();
        matches!(err, UserConfigError::InvalidToken);
    }

    #[test]
    fn invalid_token_no_oauth() {
        let err = UserConfig::builder()
            .name("foobar")
            .token("a".repeat(36))
            .build()
            .unwrap_err();
        matches!(err, UserConfigError::InvalidToken);
    }
}