plex-api 0.0.12

Library for communication with Plex server. Work in progress, not ready for any use. See github for details.
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

//! This module contains a few structs that should help you handle the webhooks
//! received from a Plex server.
//!
//! The structs are implemented according to the [documentation](https://support.plex.tv/articles/115002267687-webhooks/),
//! please read it for further information.

use crate::media_container::server::library::Guid;
use serde::{Deserialize, Serialize};
use serde_aux::prelude::deserialize_option_number_from_string;
use time::OffsetDateTime;

#[derive(Deserialize, Debug)]
#[cfg_attr(feature = "tests_deny_unknown_fields", serde(deny_unknown_fields))]
pub struct Webhook {
    pub event: Event,
    pub user: bool,
    pub owner: bool,
    #[serde(rename = "Account")]
    pub account: Account,
    #[serde(rename = "Server")]
    pub server: Server,
    #[serde(rename = "Player")]
    pub player: Option<Player>,
    #[serde(rename = "Metadata")]
    pub metadata: Option<Metadata>,
}

#[derive(Deserialize, Debug)]
#[cfg_attr(feature = "tests_deny_unknown_fields", serde(deny_unknown_fields))]
pub struct Account {
    pub id: u64,
    #[serde(with = "http_serde::uri")]
    pub thumb: http::Uri,
    pub title: String,
}

#[derive(Deserialize, Debug)]
#[cfg_attr(feature = "tests_deny_unknown_fields", serde(deny_unknown_fields))]
pub struct Server {
    pub title: String,
    pub uuid: String,
}

#[derive(Deserialize, Debug)]
#[cfg_attr(feature = "tests_deny_unknown_fields", serde(deny_unknown_fields))]
#[serde(rename_all = "camelCase")]
pub struct Player {
    pub local: bool,
    pub public_address: String,
    pub title: String,
    pub uuid: String,
}

// TODO: combine with the regular metadata struct when we get one
#[derive(Deserialize, Debug)]
#[cfg_attr(feature = "tests_deny_unknown_fields", serde(deny_unknown_fields))]
#[serde(rename_all = "camelCase")]
pub struct Metadata {
    pub title: String,
    #[serde(with = "time::serde::timestamp")]
    pub added_at: OffsetDateTime,

    pub library_section_type: Option<String>,
    pub key: Option<String>,
    pub parent_key: Option<String>,
    pub grandparent_key: Option<String>,
    pub rating_key: Option<String>,
    pub parent_rating_key: Option<String>,
    pub grandparent_rating_key: Option<String>,
    pub guid: Option<Guid>,
    #[serde(rename = "librarySectionID")]
    #[serde(deserialize_with = "deserialize_option_number_from_string")]
    pub library_section_id: Option<u32>,
    pub r#type: Option<String>,
    pub parent_title: Option<String>,
    pub grandparent_title: Option<String>,
    pub summary: Option<String>,
    pub index: Option<u32>,
    pub parent_index: Option<u32>,
    pub rating_count: Option<u64>,
    pub thumb: Option<String>,
    pub parent_thumb: Option<String>,
    pub grandparent_thumb: Option<String>,
    pub art: Option<String>,
    pub grandparent_art: Option<String>,
    #[serde(with = "time::serde::timestamp::option")]
    pub updated_at: Option<OffsetDateTime>,
}

/// Event type as described in the [Plex documentation](https://support.plex.tv/articles/115002267687-webhooks/).
#[derive(Serialize, Deserialize, Debug, Clone, Copy)]
pub enum Event {
    /// A new item is added that appears in the user’s On Deck. A poster is
    /// also attached to this event.
    #[serde(rename = "library.on.deck")]
    LibraryOnDeck,
    /// A new item is added to a library to which the user has access. A poster
    /// is also attached to this event.
    #[serde(rename = "library.new")]
    LibraryNew,

    /// Media playback pauses.
    #[serde(rename = "media.pause")]
    MediaPause,
    /// Media starts playing. An appropriate poster is attached.
    #[serde(rename = "media.play")]
    MediaPlay,
    /// Media is rated. A poster is also attached to this event.
    #[serde(rename = "media.rate")]
    MediaRate,
    /// Media playback resumes.
    #[serde(rename = "media.resume")]
    MediaResume,
    /// Media is viewed (played past the 90% mark).
    #[serde(rename = "media.scrobble")]
    MediaScrobble,
    /// Media playback stops.
    #[serde(rename = "media.stop")]
    MediaStop,

    /// A database backup is completed successfully via Scheduled Tasks.
    #[serde(rename = "admin.database.backup")]
    AdminDatabaseBackup,
    /// Corruption is detected in the server database.
    #[serde(rename = "admin.database.corrupted")]
    AdminDatabaseCorrupted,
    /// A device accesses the owner’s server for any reason, which may come
    /// from background connection testing and doesn’t necessarily indicate
    /// active browsing or playback.
    #[serde(rename = "device.new")]
    DeviceNew,
    /// Playback is started by a shared user for the server. A poster is also
    /// attached to this event.
    #[serde(rename = "playback.started")]
    PlaybackStarted,

    #[cfg(not(feature = "tests_deny_unknown_fields"))]
    #[serde(other)]
    Unknown,
}

#[cfg(test)]
mod test {
    #[plex_api_test_helper::offline_test]
    fn check_parsing() {
        serde_json::from_str::<super::Webhook>(WEBHOOK_JSON).expect("failed to parse webhook");
    }

    const WEBHOOK_JSON: &str = r#"{
        "event": "media.play",
        "user": true,
        "owner": true,
        "Account": {
           "id": 1,
           "thumb": "https://plex.tv/users/1022b120ffbaa/avatar?c=1465525047",
           "title": "elan"
        },
        "Server": {
           "title": "Office",
           "uuid": "54664a3d8acc39983675640ec9ce00b70af9cc36"
        },
        "Player": {
           "local": true,
           "publicAddress": "200.200.200.200",
           "title": "Plex Web (Safari)",
           "uuid": "r6yfkdnfggbh2bdnvkffwbms"
        },
        "Metadata": {
           "librarySectionType": "artist",
           "ratingKey": "1936545",
           "key": "/library/metadata/1936545",
           "parentRatingKey": "1936544",
           "grandparentRatingKey": "1936543",
           "guid": "com.plexapp.agents.plexmusic://gracenote/track/7572499-91016293BE6BF7F1AB2F848F736E74E5/7572500-3CBAE310D4F3E66C285E104A1458B272?lang=en",
           "librarySectionID": 1224,
           "type": "track",
           "title": "Love The One You're With",
           "grandparentKey": "/library/metadata/1936543",
           "parentKey": "/library/metadata/1936544",
           "grandparentTitle": "Stephen Stills",
           "parentTitle": "Stephen Stills",
           "summary": "",
           "index": 1,
           "parentIndex": 1,
           "ratingCount": 6794,
           "thumb": "/library/metadata/1936544/thumb/1432897518",
           "art": "/library/metadata/1936543/art/1485951497",
           "parentThumb": "/library/metadata/1936544/thumb/1432897518",
           "grandparentThumb": "/library/metadata/1936543/thumb/1485951497",
           "grandparentArt": "/library/metadata/1936543/art/1485951497",
           "addedAt": 1000396126,
           "updatedAt": 1432897518
        }
     }
"#;
}