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
115
116
117
118
119
120
121

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

use request::CreatePredictionRequest;
use response::PredictionsResponse;
use types::PredictionStatus;

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

endpoints! {
    PredictionsAPI {
        /// <https://dev.twitch.tv/docs/api/reference/#get-predictions>
        fn get_predictions(
            &self,
            broadcaster_id: &BroadcasterId,
            id: Option<&[Id]>,
            pagination: Option<PaginationQuery>,
        ) -> PredictionsResponse {
            endpoint_type: GetPredictions,
            method: GET,
            path: ["predictions"],
            query_params: {
                query(BROADCASTER_ID, broadcaster_id),
                extend(id.unwrap_or(&[]).iter().map(|id| (ID, id))),
                pagination(pagination)
            }
        }

        /// <https://dev.twitch.tv/docs/api/reference/#create-prediction>
        fn create_prediction(
            &self,
            broadcaster_id: &BroadcasterId,
            title: &str,
            outcomes: &[Title],
            prediction_window: u64,
        ) -> PredictionsResponse {
            endpoint_type: CreatePrediction,
            method: POST,
            path: ["predictions"],
            headers: [json],
            body: CreatePredictionRequest::new(broadcaster_id, title, outcomes, prediction_window).into_json()
        }

        /// <https://dev.twitch.tv/docs/api/reference/#end-prediction>
        fn end_prediction(
            &self,
            broadcaster_id: &BroadcasterId,
            id: &Id,
            status: PredictionStatus,
            winning_outcome_id: Option<&str>,
        ) -> PredictionsResponse {
            endpoint_type: EndPrediction,
            method: PATCH,
            path: ["predictions"],
            headers: [json],
            body: {
                let required = if winning_outcome_id.is_some() {
                    serde_json::json!({
                        "broadcaster_id": broadcaster_id,
                        "id": id,
                        "status":status,
                        "winning_outcome_id": winning_outcome_id.unwrap()
                    })
                } else {
                    serde_json::json!({
                        "broadcaster_id": broadcaster_id,
                        "id": id,
                        "status":status
                    })
                };

                RequestBody::new(required, None::<NoContent>).into_json()
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        predictions::{types::PredictionStatus, PredictionsAPI},
        types::{BroadcasterId, Id, Title},
    };

    api_test!(
        get_predictions,
        [
            &BroadcasterId::from("55696719"),
            Some(&[Id::from("d6676d5c-c86e-44d2-bfc4-100fb48f0656")]),
            None
        ]
    );
    api_test!(
        create_prediction,
        [
            &BroadcasterId::from("141981764"),
            "Any leeks in the stream?",
            &[
                Title::new("Yes, give it time."),
                Title::new("Yes, give it time.")
            ],
            120
        ]
    );
    api_test!(
        end_prediction,
        [
            &BroadcasterId::from("141981764"),
            &Id::from("bc637af0-7766-4525-9308-4112f4cbf178"),
            PredictionStatus::RESOLVED,
            Some("73085848-a94d-4040-9d21-2cb7a89374b7")
        ]
    );
}