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

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

use request::AnalyticsRequest;
use response::{ExtensionAnalyticsResponse, GameAnalyticsResponse};

use crate::types::{
    constants::{EXTENSIONS, EXTENSION_ID, GAMES, GAME_ID},
    ExtensionId, GameId, PaginationQuery,
};

const ANALYTICS: &str = "analytics";

endpoints! {
    AnalyticsAPI {
        /// <https://dev.twitch.tv/docs/api/reference/#get-extension-analytics>
        fn get_extension_analytics(
            &self,
            extension_id: Option<&ExtensionId>,
            opts: Option<AnalyticsRequest>,
            pagination: Option<PaginationQuery>,
        ) -> ExtensionAnalyticsResponse {
            endpoint_type: GetExtensionAnalytics,
            method: GET,
            path: [ANALYTICS, EXTENSIONS],
            query_params: {
                opt(EXTENSION_ID, extension_id),
                opt_into_query(opts),
                pagination(pagination)
            }
        }

        /// <https://dev.twitch.tv/docs/api/reference/#get-game-analytics>
        fn get_game_analytics(
            &self,
            game_id: Option<&GameId>,
            opts: Option<AnalyticsRequest>,
            pagination: Option<PaginationQuery>,
        ) -> GameAnalyticsResponse {
            endpoint_type: GetGameAnalytics,
            method: GET,
            path: [ANALYTICS, GAMES],
            query_params: {
                opt(GAME_ID, game_id),
                opt_into_query(opts),
                pagination(pagination)
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        analytics::{request::AnalyticsRequest, AnalyticsAPI},
        types::{GameId, PaginationQuery},
    };

    api_test!(get_extension_analytics, [None, None, None]);
    api_test!(
        get_game_analytics,
        [
            Some(&GameId::from("493057")),
            Some(
                AnalyticsRequest::new()
                    .started_at(&"2018-01-01T00:00:00Z".parse().unwrap())
                    .ended_at(&"2018-03-01T00:00:00Z".parse().unwrap())
            ),
            None
        ]
    );

    api_test!(extra
        get_game_analytics,
        get_game_analytics2,
        [
            None,
            None,
            Some(PaginationQuery::new().first(5))
        ]
    );
}