twitch_highway 0.2.1

Twitch API
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

pub mod request;
pub mod response;
pub mod types;

use request::{EndPollRequest, PollsRequest};
use response::PollsResponse;
use types::PollStatus;

use crate::{
    request::RequestBody,
    types::{
        constants::{BROADCASTER_ID, ID},
        BroadcasterId, Id, PaginationQuery, Title,
    },
};

endpoints! {
    PollsAPI {
        /// <https://dev.twitch.tv/docs/api/reference/#get-polls>
        fn get_polls(
            &self,
            broadcaster_id: &BroadcasterId,
            id: Option<&Id>,
            pagination: Option<PaginationQuery>,
        ) -> PollsResponse {
            endpoint_type: GetPolls,
            method: GET,
            path: ["polls"],
            query_params: {
                query(BROADCASTER_ID, broadcaster_id),
                opt(ID, id),
                pagination(pagination)
            }
        }

        /// <https://dev.twitch.tv/docs/api/reference/#create-poll>
        fn create_poll(
            &self,
            broadcaster_id: &BroadcasterId,
            title: &str,
            choices: &[Title],
            duration: u64,
            opts: Option<PollsRequest>,
        ) -> PollsResponse {
            endpoint_type: CreatePoll,
            method: POST,
            path: ["polls"],
            headers: [json],
            body: {
                let required = serde_json::json!({
                    "broadcaster_id": broadcaster_id,
                    "title": title,
                    "choices": choices,
                    "duration": duration,
                });

                RequestBody::new(required, opts).into_json()
            }
        }

        /// <https://dev.twitch.tv/docs/api/reference/#end-poll>
        fn end_poll(
            &self,
            broadcaster_id: &BroadcasterId,
            id: &Id,
            status: PollStatus,
        ) -> PollsResponse {
            endpoint_type: EndPoll,
            method: PATCH,
            path: ["polls"],
            headers: [json],
            body: EndPollRequest::new(broadcaster_id, id, status).into_json()
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        polls::{request::PollsRequest, types::PollStatus, PollsAPI},
        types::{BroadcasterId, Id, Title},
    };

    api_test!(
        get_polls,
        [
            &BroadcasterId::from("141981764"),
            Some(&Id::from("ed961efd-8a3f-4cf5-a9d0-e616c590cd2a")),
            None
        ]
    );
    api_test!(
        create_poll,
        [
            &BroadcasterId::from("141981764"),
            "Heads or Tails?",
            &[Title::new("Heads"), Title::new("Tails")],
            1800,
            Some(
                PollsRequest::new()
                    .channel_points_voting_enabled(true)
                    .channel_points_per_vote(100)
            )
        ]
    );
    api_test!(
        end_poll,
        [
            &BroadcasterId::from("141981764"),
            &Id::from("ed961efd-8a3f-4cf5-a9d0-e616c590cd2a"),
            PollStatus::TERMINATED
        ]
    );
}