simkl 0.1.0

Library to build queries for SIMKL and decoding JSON responses using Serde
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
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

use chrono::{DateTime, Utc};
use serde::Deserialize;

use crate::API_URL;

/// User settings, requires those headers in your request:
/// * `Content-Type:application/json`
/// * `Authorization:Bearer [token]`
/// * `simkl-api-key:[client_id]`
///
/// Response will look like:
/// ``` json
/// {
///   "user": {
///     "name": "Andrew Masyk",
///     "joined_at": "2007-11-04T22:04:46Z",
///     "gender": "male",
///     "avatar": "https://graph.facebook.com/736253775/picture?width=100&height=100",
///     "bio": "I'm a founder and developer at simkl.com - a socially powered TV show and movie tracking service",
///     "loc": "New York, NY, USA",
///     "age": "30 years"
///   },
///   "account": {
///     "id": 51,
///     "timezone": "America/New_York",
///     "type": "free"
///   },
///   "connections": {
///     "facebook": true
///   }
/// }
/// ```
pub const SETTINGS_URL: &str = "https://api.simkl.com/users/settings";

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct User {
    pub name: String,
    pub joined_at: DateTime<Utc>,
    pub gender: String,
    /// Avatar URL
    pub avatar: String,
    pub bio: String,
    pub loc: String,
    pub age: String,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Account {
    pub id: u32,
    pub timezone: String,
    pub r#type: String,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Connections {
    pub facebook: bool,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Settings {
    pub user: User,
    pub account: Account,
    pub connections: Connections,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct WatchedLastWeek {
    pub total_mins: u32,
    pub movies_mins: u32,
    pub tv_mins: u32,
    pub anime_mins: u32,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Count {
    pub mins: u32,
    pub count: u16,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Watched {
    pub watched_episodes_count: u16,
    pub count: u16,
    pub left_to_watch_episodes: u16,
    pub left_to_watch_mins: u16,
    pub total_episodes_count: u16,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct CompletedOrNotInteresting {
    pub watched_episodes_count: u16,
    pub count: u16,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Movies {
    pub total_mins: u32,
    #[serde(rename = "plantowatch")]
    pub plan_to_watch: Count,
    #[serde(rename = "notinteresting")]
    pub not_interesting: Count,
    pub completed: CompletedOrNotInteresting,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct TvOrAnime {
    pub total_mins: u32,
    pub watching: Watched,
    pub hold: Watched,
    #[serde(rename = "plantowatch")]
    pub plan_to_watch: Watched,
    #[serde(rename = "notinteresting")]
    pub not_interesting: CompletedOrNotInteresting,
    pub completed: CompletedOrNotInteresting,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Stats {
    pub total_mins: u32,
    pub movies: Movies,
    pub tv: TvOrAnime,
    pub anime: TvOrAnime,
    pub watched_last_week: WatchedLastWeek,
}

#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct LastWatchedArts {
    pub id: u32,
    pub url: String,
    pub title: String,
    pub poster: String,
    pub fanart: String,
}

pub fn get_last_watched_arts(user_id: u32, client_id: String) -> String {
    let mut result = String::with_capacity(128);
    result.push_str(API_URL);
    result.push_str("/users/recently-watched-background/");
    result.push_str(&user_id.to_string());
    result.push_str("?client_id=");
    result.push_str(&client_id);
    result
}

/// Response will redirect (`HTTP 302`) to the image to download or display. Header will look like:
///
/// `location: https://simkl.in/fanart/50/500671636445e211e_0.jpg`
pub fn get_last_watched_image_request(user_id: u32, fanart: bool, client_id: String) -> String {
    let mut result = String::with_capacity(128);
    result.push_str(API_URL);
    result.push_str("/users/recently-watched-background/");
    result.push_str(&user_id.to_string());
    result.push_str("?image=");
    if fanart {
        result.push_str("fanart")
    } else {
        result.push_str("poster");
    }
    result.push_str("&client_id=");
    result.push_str(&client_id);
    result
}

#[cfg(test)]
mod tests {
    use crate::user::get_last_watched_arts;

    #[test]
    fn test_last_watched_arts_request() {
        let client_id = String::from("azerty123456");
        assert_eq!(
            get_last_watched_arts(4321, client_id),
            "https://api.simkl.com/users/recently-watched-background/4321?client_id=azerty123456"
        );
    }
}