litchee 0.1.5

Async, builder-pattern Rust client for the Lichess API: full endpoint coverage, NDJSON streaming, and OAuth2 PKCE ('Log in with Lichess').
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
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

//! Integration tests for the TV API.

use futures_util::StreamExt;
use litchee::LichessClient;
use litchee::api::broadcasting::tv::LichessTvFeedEvent;
use litchee::model::GameExportOptions;
use wiremock::matchers::{header, method, path, query_param, query_param_is_missing};
use wiremock::{Mock, MockServer, ResponseTemplate};

fn client(server: &MockServer) -> LichessClient {
    LichessClient::builder()
        .base_url(&server.uri().parse().expect("mock uri is a valid url"))
        .build()
        .expect("client builds")
}

#[tokio::test]
async fn channels_returns_featured_games() {
    let server = MockServer::start().await;
    let body = r#"{"bullet":{"user":{"id":"a","name":"A"},"rating":2900,
                   "gameId":"x","color":"white"}}"#;
    Mock::given(method("GET"))
        .and(path("/api/tv/channels"))
        .respond_with(ResponseTemplate::new(200).set_body_string(body))
        .mount(&server)
        .await;

    let channels = client(&server).tv().channels().await.unwrap();

    assert_eq!(channels.bullet.unwrap().rating, 2900);
}

#[tokio::test]
async fn feed_streams_tagged_events() {
    let server = MockServer::start().await;
    let body = concat!(
        r#"{"t":"featured","d":{"id":"g","orientation":"white","players":[{"color":"white","rating":1500,"seconds":60},{"color":"black","rating":1490,"seconds":60}],"fen":"startpos"}}"#,
        "\n",
        r#"{"t":"fen","d":{"fen":"x","lm":"e2e4","wc":60,"bc":59}}"#,
        "\n",
    );
    Mock::given(method("GET"))
        .and(path("/api/tv/feed"))
        .respond_with(ResponseTemplate::new(200).set_body_string(body))
        .mount(&server)
        .await;

    let stream = client(&server).tv().feed().await.unwrap();
    let events: Vec<_> = stream.collect().await;

    assert_eq!(events.len(), 2);
    assert!(matches!(
        events[0].as_ref().unwrap(),
        LichessTvFeedEvent::Featured(_)
    ));
    assert!(matches!(
        events[1].as_ref().unwrap(),
        LichessTvFeedEvent::Fen(_)
    ));
}

#[tokio::test]
async fn channel_feed_streams_tagged_events() {
    let server = MockServer::start().await;
    let body = concat!(
        r#"{"t":"featured","d":{"id":"g","orientation":"white","players":[{"color":"white","rating":1500,"seconds":60},{"color":"black","rating":1490,"seconds":60}],"fen":"startpos"}}"#,
        "\n",
        r#"{"t":"fen","d":{"fen":"x","lm":"e2e4","wc":60,"bc":59}}"#,
        "\n",
    );
    Mock::given(method("GET"))
        .and(path("/api/tv/blitz/feed"))
        .respond_with(ResponseTemplate::new(200).set_body_string(body))
        .mount(&server)
        .await;

    let stream = client(&server).tv().channel_feed("blitz").await.unwrap();
    let events: Vec<_> = stream.collect().await;

    assert_eq!(events.len(), 2);
    assert!(matches!(
        events[0].as_ref().unwrap(),
        LichessTvFeedEvent::Featured(_)
    ));
}

#[tokio::test]
async fn channel_games_streams_games() {
    let server = MockServer::start().await;
    let body = "{\"id\":\"g1\"}\n{\"id\":\"g2\"}\n";
    Mock::given(method("GET"))
        .and(path("/api/tv/blitz"))
        .and(query_param("nb", "2"))
        .and(header("accept", "application/x-ndjson"))
        .respond_with(ResponseTemplate::new(200).set_body_string(body))
        .mount(&server)
        .await;

    let stream = client(&server)
        .tv()
        .channel_games("blitz")
        .nb(2)
        .stream()
        .await
        .unwrap();
    let games: Vec<_> = stream.collect().await;

    assert_eq!(games.len(), 2);
}

#[tokio::test]
async fn channel_games_sends_export_params() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/tv/blitz"))
        .and(query_param("clocks", "true"))
        .and(query_param("opening", "true"))
        .and(query_param_is_missing("nb"))
        .respond_with(ResponseTemplate::new(200).set_body_string("{\"id\":\"g1\"}\n"))
        .mount(&server)
        .await;
    let stream = client(&server)
        .tv()
        .channel_games("blitz")
        .export(GameExportOptions::default().clocks(true).opening(true))
        .stream()
        .await
        .unwrap();
    let games: Vec<_> = stream.collect().await;
    assert_eq!(games.len(), 1);
}

#[tokio::test]
async fn channel_games_pgn_sets_accept_header() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/tv/blitz"))
        .and(header("accept", "application/x-chess-pgn"))
        .respond_with(ResponseTemplate::new(200).set_body_string("[Event \"x\"]\n\n1. e4 *"))
        .mount(&server)
        .await;
    let pgn = client(&server)
        .tv()
        .channel_games("blitz")
        .pgn()
        .await
        .unwrap();
    assert!(pgn.contains("1. e4"));
}