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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/// Reddit base class.
/// Listing things have neither name nor id because they are indefinite objects.
/// That is, they are system generated, not user submitted, and are subject to change quickly and expire.
/// See https://github.com/reddit-archive/reddit/wiki/JSON#thing-reddit-base-class
#[derive(Debug, serde::Deserialize)]
pub struct Thing {
    /// this item's identifier, e.g. "8xwlg"
    pub id: Option<Box<str>>,

    /// Fullname of comment, e.g. "t1_c3v7f8u"
    pub name: Option<Box<str>>,

    /// Data
    #[serde(flatten)]
    pub data: ThingData,
}

/// kind:
/// All things have a kind. The kind is a String identifier that denotes the object's type.
/// Some examples: Listing, more, t1, t2
/// data:
/// A custom data structure used to hold valuable information.
/// This object's format will follow the data structure respective of its kind. See below for specific structures.
/// See https://www.reddit.com/dev/api#fullnames
#[derive(Debug, serde::Deserialize)]
#[serde(tag = "kind", content = "data")]
pub enum ThingData {
    #[serde(rename = "Listing")]
    Listing(Box<Listing>),

    // More is small + it already has a vector of things as a vec
    #[serde(rename = "more")]
    More(More),

    #[serde(rename = "t1")]
    Comment(Box<Comment>),

    // TODO: Finish type
    // #[serde(rename = "t2")]
    // Account(serde_json::Value),
    #[serde(rename = "t3")]
    Link(Box<Link>),
}

impl ThingData {
    /// Tries to get this ThingData as a listing
    pub fn as_listing(&self) -> Option<&Listing> {
        match self {
            ThingData::Listing(listing) => Some(listing),
            _ => None,
        }
    }

    /// Tries to get this ThingData as a mutable listing
    pub fn as_listing_mut(&mut self) -> Option<&mut Listing> {
        match self {
            ThingData::Listing(listing) => Some(listing),
            _ => None,
        }
    }

    /// Tries to turn this ThingData into a listing
    pub fn into_listing(self) -> Option<Box<Listing>> {
        match self {
            ThingData::Listing(listing) => Some(listing),
            _ => None,
        }
    }

    /// Tries to get this ThingData as a link
    pub fn as_link(&self) -> Option<&Link> {
        match self {
            ThingData::Link(link) => Some(link),
            _ => None,
        }
    }

    /// Tries to turn this ThingData into a link
    pub fn into_link(self) -> Option<Box<Link>> {
        match self {
            ThingData::Link(link) => Some(link),
            _ => None,
        }
    }
}

/// Used to paginate content that is too long to display in one go.
/// Add the query argument before or after with the value given to get the previous or next page.
/// This is usually used in conjunction with a count argument.
/// Exception: Unlike the other classes documented on this page, Listing is not a thing subclass, as it inherits directly from the Python base class, Object.
/// Although it does have data and kind as parameters, it does not have id and name.
/// A listing's kind will always be Listing and its data will be a List of things.
/// kind == "Listing"
/// See https://github.com/reddit-archive/reddit/wiki/JSON#listing
#[derive(Debug, serde::Deserialize)]
pub struct Listing {
    /// The fullname of the listing that follows before this page. null if there is no previous page.
    pub before: Option<Box<str>>,

    /// The fullname of the listing that follows after this page. null if there is no next page.
    pub after: Option<Box<str>>,

    /// This modhash is not the same modhash provided upon login.
    /// You do not need to update your user's modhash everytime you get a new modhash.
    /// You can reuse the modhash given upon login.
    pub modhash: Box<str>,

    /// A list of things that this Listing wraps.
    pub children: Vec<Thing>,
}

/// Implementation
/// See: https://github.com/reddit-archive/reddit/wiki/JSON#votable-implementation
#[derive(Debug, serde::Deserialize)]
pub struct Votable {
    /// the number of upvotes. (includes own)
    pub ups: i64,

    /// the number of downvotes. (includes own)
    pub downs: u64,

    /// true if thing is liked by the user, false if thing is disliked, null if the user has not voted or you are not logged in.
    /// Certain languages such as Java may need to use a boolean wrapper that supports null assignment.
    pub likes: Option<bool>,
}

/// Implementation
/// See https://github.com/reddit-archive/reddit/wiki/JSON#created-implementation
#[derive(Debug, serde::Deserialize)]
pub struct Created {
    // TODO: use chrono?
    /// the time of creation in local epoch-second format. ex: 1331042771.0
    pub created: f64,

    /// the time of creation in UTC epoch-second format. Note that neither of these ever have a non-zero fraction.
    pub created_utc: f64,
}

/// Implements votable | created
/// kind == "t1"
/// See https://github.com/reddit-archive/reddit/wiki/JSON#comment-implements-votable--created
#[derive(Debug, serde::Deserialize)]
pub struct Comment {
    /// who approved this comment. null if nobody or you are not a mod
    pub approved_by: Option<Box<str>>,

    /// the account name of the poster
    pub author: Box<str>,

    /// the CSS class of the author's flair. subreddit specific
    pub author_flair_css_class: Option<Box<str>>,

    /// the text of the author's flair. subreddit specific
    pub author_flair_text: Option<Box<str>>,

    /// who removed this comment. null if nobody or you are not a mod
    pub banned_by: Option<Box<str>>,

    /// the raw text.
    /// this is the unformatted text which includes the raw markup characters such as ** for bold. <, >, and & are escaped.
    pub body: Box<str>,

    /// the formatted HTML text as displayed on reddit.
    /// For example, text that is emphasised by * will now have <em> tags wrapping it.
    /// Additionally, bullets and numbered lists will now be in HTML list format.
    /// NOTE: The HTML string will be escaped. You must unescape to get the raw HTML.
    pub body_html: Box<str>,

    /// false if not edited, edit date in UTC epoch-seconds otherwise.
    /// NOTE: for some old edited comments on reddit.com, this will be set to true instead of edit date.
    pub special: Option<serde_json::Value>,

    /// the number of times this comment received reddit gold
    pub gilded: u64,

    /// how the logged-in user has voted on the comment - True = upvoted, False = downvoted, null = no vote
    pub likes: Option<bool>,

    /// present if the comment is being displayed outside its thread (user pages, /r/subreddit/comments/.json, etc.).
    /// Contains the author of the parent link
    pub link_author: Option<Box<str>>,

    /// ID of the link this comment is in
    pub link_id: Box<str>,

    /// present if the comment is being displayed outside its thread (user pages, /r/subreddit/comments/.json, etc.).
    /// Contains the title of the parent link
    pub link_title: Option<Box<str>>,

    /// present if the comment is being displayed outside its thread (user pages, /r/subreddit/comments/.json, etc.).
    /// Contains the URL of the parent link
    pub link_url: Option<Box<str>>,

    /// how many times this comment has been reported, null if not a mod
    pub num_reports: Option<u64>,

    /// ID of the thing this comment is a reply to, either the link or a comment in it
    pub parent_id: Box<str>,

    // TODO: Find out why this is a string sometimes
    /// A list of replies to this comment
    // pub replies: Thing,

    /// true if this post is saved by the logged in user
    pub saved: bool,

    /// the net-score of the comment
    pub score: i64,

    /// Whether the comment's score is currently hidden.
    pub score_hidden: bool,

    /// subreddit of thing excluding the /r/ prefix. "pics"
    pub subreddit: Box<str>,

    /// the id of the subreddit in which the thing is locatedss
    pub subreddit_id: Box<str>,

    /// to allow determining whether they have been distinguished by moderators/admins.
    /// null = not distinguished.
    /// moderator = the green \[M\].
    /// admin = the red \[A\].
    /// special = various other special distinguishes http://redd.it/19ak1b
    pub distinguished: Option<Box<str>>,

    /// Voting Implementation
    #[serde(flatten)]
    pub votable: Votable,

    /// Created Implementation
    #[serde(flatten)]
    pub created: Created,
    // Experimentally determined fields
    // TODO: These are VERY best-effort, but i should still try to document what i can
}

/// Implements votable | created
/// kind == "t3"
/// See https://github.com/reddit-archive/reddit/wiki/JSON#link-implements-votable--created
#[derive(Debug, serde::Deserialize)]
pub struct Link {
    /// the account name of the poster. null if this is a promotional link
    pub author: Box<str>,

    /// the CSS class of the author's flair. subreddit specific
    pub author_flair_css_class: Option<Box<str>>,

    /// the text of the author's flair. subreddit specific
    pub author_flair_text: Option<Box<str>>,

    /// probably always returns false
    pub clicked: bool,

    /// the domain of this link.
    /// Self posts will be self.<subreddit> while other examples include en.wikipedia.org and s3.amazon.com
    pub domain: Box<str>,

    /// true if the post is hidden by the logged in user. false if not logged in or not hidden.
    pub hidden: bool,

    /// true if this link is a selfpost
    pub is_self: bool,

    /// how the logged-in user has voted on the link - True = upvoted, False = downvoted, null = no vote
    pub likes: Option<bool>,

    /// the CSS class of the link's flair.
    pub link_flair_css_class: Option<Box<str>>,

    /// the text of the link's flair.
    pub link_flair_text: Option<Box<str>>,

    /// whether the link is locked (closed to new comments) or not.
    pub locked: bool,

    // TODO: Finish type
    /// Used for streaming video. Detailed information about the video and it's origins are placed here
    pub media: serde_json::Value,

    // TODO: Finish type
    /// Used for streaming video. Technical embed specific information is found here.
    pub media_embed: serde_json::Value,

    /// the number of comments that belong to this link. includes removed comments.
    pub num_comments: u64,

    /// true if the post is tagged as NSFW. False if otherwise
    pub over_18: bool,

    /// relative URL of the permanent link for this link
    pub permalink: Box<str>,

    /// true if this post is saved by the logged in user
    pub saved: bool,

    /// the net-score of the link.
    /// note: A submission's score is simply the number of upvotes minus the number of downvotes.
    /// If five users like the submission and three users don't it will have a score of 2.
    /// Please note that the vote numbers are not "real" numbers, they have been "fuzzed" to prevent spam bots etc.
    /// So taking the above example, if five users upvoted the submission, and three users downvote it,
    /// the upvote/downvote numbers may say 23 upvotes and 21 downvotes, or 12 upvotes, and 10 downvotes.
    /// The points score is correct, but the vote totals are "fuzzed".
    pub score: i64,

    /// the raw text.
    /// this is the unformatted text which includes the raw markup characters such as ** for bold.
    /// <, >, and & are escaped.
    /// Empty if not present.
    pub selftext: Box<str>,

    /// the formatted escaped HTML text.
    /// this is the HTML formatted version of the marked up text.
    /// Items that are boldened by ** or *** will now have <em> or *** tags on them.
    /// Additionally, bullets and numbered lists will now be in HTML list format.
    /// NOTE: The HTML string will be escaped. You must unescape to get the raw HTML. Null if not present.
    pub selftext_html: Option<Box<str>>,

    /// subreddit of thing excluding the /r/ prefix. "pics"
    pub subreddit: Box<str>,

    /// the id of the subreddit in which the thing is located
    pub subreddit_id: Box<str>,

    /// full URL to the thumbnail for this link;
    /// "self" if this is a self post;
    /// "image" if this is a link to an image but has no thumbnail;
    /// "default" if a thumbnail is not available
    pub thumbnail: Box<str>,

    /// the title of the link. may contain newlines for some reason
    pub title: Box<str>,

    /// the link of this post. the permalink if this is a self-post. May be a relative Url.
    pub url: Box<str>,

    /// Indicates if link has been edited.
    /// Will be the edit timestamp if the link has been edited and return false otherwise.
    /// https://github.com/reddit/reddit/issues/581
    pub edited: serde_json::Value,

    /// to allow determining whether they have been distinguished by moderators/admins.
    /// null = not distinguished.
    /// moderator = the green \[M\].
    /// admin = the red \[A\].
    /// special = various other special distinguishes
    /// http://bit.ly/ZYI47B
    pub distinguished: Option<Box<str>>,

    /// true if the post is set as the sticky in its subreddit.
    pub stickied: bool,

    /// Voting Implementation
    #[serde(flatten)]
    pub votable: Votable,

    /// Created Implementation
    #[serde(flatten)]
    pub created: Created,

    // Experimentally determined fields
    // TODO: These are VERY best-effort, but i should still try to document what i can
    pub archived: bool,
    pub author_flair_template_id: Option<Box<str>>,
    pub author_flair_text_color: Option<Box<str>>,
    pub author_flair_type: Option<Box<str>>,
    pub author_fullname: Option<Box<str>>,
    pub author_patreon_flair: Option<bool>,
    pub can_gild: bool,
    pub can_mod_post: bool,
    pub contest_mode: bool,

    /// I believe that this is included for crossposted posts to get the data for the main post
    pub crosspost_parent_list: Option<Vec<Link>>,

    pub gilded: u64,
    pub hide_score: bool,
    pub id: Box<str>,
    pub is_crosspostable: bool,
    pub is_meta: bool,
    pub is_original_content: bool,
    pub is_reddit_media_domain: bool,
    pub is_robot_indexable: bool,

    /// Returns true if its a video
    pub is_video: bool,

    pub link_flair_text_color: Option<Box<str>>,
    pub link_flair_type: Box<str>,
    pub media_only: bool,
    pub name: Box<str>,
    pub no_follow: bool,
    pub num_crossposts: u64,
    pub parent_whitelist_status: Option<Box<str>>,

    /// Whether this post is pinned
    pub pinned: bool,

    /// A "hint" about what this post may be
    pub post_hint: Option<PostHint>,

    pub pwls: Option<u64>,
    pub quarantine: bool,
    pub send_replies: bool,

    /// Whether this post has a spoiler
    pub spoiler: bool,

    pub subreddit_name_prefixed: Box<str>,
    pub subreddit_subscribers: u64,
    pub subreddit_type: Box<str>,
    pub suggested_sort: Option<Box<str>>,
    pub thumbnail_height: Option<u32>,
    pub thumbnail_width: Option<u32>,
    pub visited: bool,
    pub whitelist_status: Option<Box<str>>,
    pub wls: Option<u32>,
}

/// kind == "more"
/// See https://github.com/reddit-archive/reddit/wiki/JSON#more
#[derive(Debug, serde::Deserialize)]
pub struct More {
    /// A list of String ids that are the additional things that can be downloaded but are not because there are too many to list.
    pub children: Vec<Box<str>>,
}

/// Info on what the post may contain
#[derive(Debug, serde::Deserialize, PartialEq, Eq)]
pub enum PostHint {
    /// The post is an image
    #[serde(rename = "image")]
    Image,

    /// The post is a link
    #[serde(rename = "link")]
    Link,

    /// A video hosted on reddit
    #[serde(rename = "hosted:video")]
    HostedVideo,

    #[serde(rename = "rich:video")]
    RichVideo,

    #[serde(rename = "self")]
    DataSelf,

    #[serde(rename = "gallery")]
    Gallery,
}

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

    const SUBREDDIT_SAMPLE_1: &str = include_str!("../test_data/subreddit_dankmemes.json");
    const SUBREDDIT_SAMPLE_2: &str = include_str!("../test_data/subreddit_cromch.json");
    const SUBREDDIT_SAMPLE_3: &str = include_str!("../test_data/subreddit_cuddleroll.json");
    const SUBREDDIT_SAMPLE_4: &str = include_str!("../test_data/subreddit_cursed_images.json");

    const COMMENT_SAMPLE_1: &str = include_str!("../test_data/comment_h966lq.json");
    const COMMENT_SAMPLE_2: &str = include_str!("../test_data/comment_h8p0py.json");

    #[test]
    fn parse_subreddit_1() {
        let res = serde_json::from_str::<Thing>(SUBREDDIT_SAMPLE_1).unwrap();
        dbg!(res);
    }

    #[test]
    fn parse_subreddit_2() {
        let res = serde_json::from_str::<Thing>(SUBREDDIT_SAMPLE_2).unwrap();
        dbg!(res);
    }

    #[test]
    fn parse_subreddit_3() {
        let res = serde_json::from_str::<Thing>(SUBREDDIT_SAMPLE_3).unwrap();
        dbg!(res);
    }

    #[test]
    fn parse_subreddit_4() {
        let res = serde_json::from_str::<Thing>(SUBREDDIT_SAMPLE_4).unwrap();
        dbg!(res);
    }

    #[test]
    fn parse_comments_1() {
        let res = serde_json::from_str::<Vec<Thing>>(COMMENT_SAMPLE_1).unwrap();
        dbg!(res);
    }

    #[test]
    fn parse_comments_2() {
        let res = serde_json::from_str::<Vec<Thing>>(COMMENT_SAMPLE_2).unwrap();
        dbg!(res);
    }
}