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

#![doc(alias = "gift")]
#![doc(alias = "channel-sub-gifts-v1")]
//! PubSub messages for sub gifts
use crate::{pubsub, types};
use serde::{Deserialize, Serialize};

/// A user gifts subs.
///
/// This allows one to know how many subs were gifted in a single event. See also [`pubsub::channel_subscriptions::ChannelSubscribeEventsV1`] which needs token from broadcaster
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
#[serde(into = "String", try_from = "String")]
pub struct ChannelSubGiftsV1 {
    /// The channel_id to watch. Can be fetched with the [Get Users](crate::helix::users::get_users) endpoint
    pub channel_id: u32,
}

impl_de_ser!(
    ChannelSubGiftsV1,
    "channel-sub-gifts-v1",
    channel_id // FIXME: add trailing comma
);

impl pubsub::Topic for ChannelSubGiftsV1 {
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: &'static [twitch_oauth2::Scope] = &[];

    fn into_topic(self) -> pubsub::Topics { super::Topics::ChannelSubGiftsV1(self) }
}

/// Mystery gift
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct MysteryGiftPurchase {
    /// Channel where mystery gifts were distributed
    pub channel_id: types::UserId,
    /// Amount of mystery gifts
    pub count: i64,
    /// Tier of mystery gifts
    pub tier: types::SubscriptionTier,
    /// User ID of user that purchased mystery gifts
    pub user_id: types::UserId,
    /// User name of user that purchased mystery gifts
    pub user_name: types::UserName,
    /// Display name of user that purchased mystery gifts
    pub display_name: types::DisplayName,
    /// Unknown
    pub uuid: String,
}

/// Reply from [ChannelSubGiftsV1]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[serde(tag = "type")]
#[non_exhaustive]
pub enum ChannelSubGiftsV1Reply {
    /// Mystery gift
    #[serde(rename = "mystery-gift-purchase")]
    MysteryGiftPurchase(MysteryGiftPurchase),
}

#[cfg(test)]
mod tests {
    use super::super::{Response, TopicData};
    use super::*;

    #[test]
    fn channel_sub_gifts() {
        let message = r##"
{
    "count": 5,
    "tier": "1000",
    "user_id": "1234",
    "channel_id": "27620241",
    "uuid": "deadbeef",
    "type": "mystery-gift-purchase",
    "user_name": "user",
    "display_name": "User"
}
"##;

        let source = format!(
            r#"{{"type": "MESSAGE", "data": {{ "topic": "channel-sub-gifts-v1.27620241", "message": {:?} }}}}"#,
            message
        );
        let actual = dbg!(Response::parse(&source).unwrap());
        assert!(matches!(
            actual,
            Response::Message {
                data: TopicData::ChannelSubGiftsV1 { .. },
            }
        ));
    }

    #[test]
    fn check_deser() {
        use std::convert::TryInto as _;
        let s = "channel-sub-gifts-v1.1234";
        assert_eq!(
            ChannelSubGiftsV1 { channel_id: 1234 },
            s.to_string().try_into().unwrap()
        );
    }

    #[test]
    fn check_ser() {
        let s = "channel-sub-gifts-v1.1234";
        let right: String = ChannelSubGiftsV1 { channel_id: 1234 }.into();
        assert_eq!(s.to_string(), right);
    }
}