twitch_oauth_token 4.0.1

Type-safe Twitch OAuth 2.0 authentication library with CSRF protection and full scope support
Documentation 
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

use asknothingx2_util::oauth::ClientId;
use chrono::Utc;
use serde::{Deserialize, Serialize, Serializer};

use crate::{scope::Scope, AccessToken, RefreshToken};

#[derive(Debug, Clone, Deserialize)]
pub struct UserToken {
    pub access_token: AccessToken,
    pub expires_in: u64,
    pub token_type: String,
    pub refresh_token: RefreshToken,
    #[serde(default, deserialize_with = "deserialize_scopes")]
    pub scope: Vec<Scope>,
    #[serde(default = "default_created_at")]
    pub created_at: i64,
}

impl UserToken {
    pub fn is_expired(&self) -> bool {
        let now = Utc::now().timestamp();
        now >= (self.created_at + self.expires_in as i64)
    }
}

impl Serialize for UserToken {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        use serde::ser::SerializeStruct;

        let mut state = serializer.serialize_struct("Token", 5)?;
        state.serialize_field("access_token", &self.access_token)?;
        state.serialize_field("expires_in", &self.expires_in)?;
        state.serialize_field("token_type", &self.token_type)?;
        state.serialize_field("refresh_token", &self.refresh_token)?;
        state.serialize_field("scope", &self.scope)?;
        state.end()
    }
}

/// <https://dev.twitch.tv/docs/authentication/validate-tokens/>
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TokenInfo {
    pub client_id: ClientId,
    pub login: String,
    #[serde(default, deserialize_with = "deserialize_scopes")]
    pub scopes: Vec<Scope>,
    pub user_id: String,
    pub expires_in: u64,
}

/// <https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/#client-credentials-grant-flow>
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AppToken {
    pub access_token: AccessToken,
    pub expires_in: u64,
    pub token_type: String,
}

fn default_created_at() -> i64 {
    Utc::now().timestamp()
}

fn deserialize_scopes<'de, D>(deserializer: D) -> Result<Vec<Scope>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let scopes: Vec<String> = Vec::deserialize(deserializer)?;
    Ok(scopes
        .into_iter()
        .filter_map(|s| (!s.is_empty()).then(|| s.parse().ok()).flatten())
        .collect())
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use crate::{TokenInfo, UserToken};

    #[test]
    fn user_token_deserialize_custom_scope() {
        let json = json!({
            "access_token":"d19bb4cb705d1f0",
            "refresh_token":"",
            "expires_in":86399,
            "scope":[""],
            "token_type":"bearer"
        });

        let token: UserToken = serde_json::from_value(json).unwrap();
        assert_eq!(token.scope.len(), 0);

        let json = json!({
            "access_token":"d19bb4cb705d1f0",
            "refresh_token":"",
            "expires_in":86399,
            "scope":[],
            "token_type":"bearer"
        });

        let token: UserToken = serde_json::from_value(json).unwrap();
        assert_eq!(token.scope.len(), 0);
    }

    #[test]
    fn validate_token_deserialize_custom_scope() {
        let json = json!({
          "client_id": "wbmytr93xzw8zbg0p1izqyzzc5mbiz",
          "login": "twitchdev",
          "scopes": [""],
          "user_id": "141981764",
          "expires_in": 5520838
        });

        let token: TokenInfo = serde_json::from_value(json).unwrap();
        assert_eq!(token.scopes.len(), 0);

        let json = json!({
          "client_id": "wbmytr93xzw8zbg0p1izqyzzc5mbiz",
          "login": "twitchdev",
          "scopes": [""],
          "user_id": "141981764",
          "expires_in": 5520838
        });

        let token: TokenInfo = serde_json::from_value(json).unwrap();
        assert_eq!(token.scopes.len(), 0);
    }
}