lichess-api 1.0.0

A client library for the Lichess 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
122
123
124

use bytes::Bytes;

use futures::AsyncBufReadExt;
use futures::TryStreamExt;
use futures::stream::StreamExt;

use serde::de::DeserializeOwned;
use tracing::debug;

use crate::error::{Error, Result};

#[derive(Debug, Clone)]
pub struct LichessApi<HttpClient> {
    pub client: HttpClient,
    bearer_auth: Option<String>,
}

impl<HttpClient> LichessApi<HttpClient> {
    pub fn new(client: HttpClient, auth_token: Option<String>) -> Self {
        let bearer_auth = auth_token.map(|token| format!("Bearer {}", token));
        Self {
            client,
            bearer_auth,
        }
    }

    pub(crate) async fn expect_one_model<Model, G>(&self, stream: &mut G) -> Result<Model>
    where
        G: StreamExt<Item = Result<Model>> + std::marker::Unpin,
    {
        stream
            .next()
            .await
            .ok_or(Error::Response("empty response stream".to_string()))?
    }

    pub(crate) async fn expect_empty<G>(&self, stream: &mut G) -> Result<()>
    where
        G: StreamExt<Item = Result<()>> + std::marker::Unpin,
    {
        if stream.next().await.is_some() {
            Err(Error::Response(
                "expected empty response stream".to_string(),
            ))
        } else {
            Ok(())
        }
    }
}

impl LichessApi<reqwest::Client> {
    pub(crate) async fn make_request<Model: DeserializeOwned>(
        &self,
        http_request: http::Request<Bytes>,
    ) -> Result<impl StreamExt<Item = Result<Model>>> {
        let stream =
            self.make_request_as_raw_lines(http_request)
                .await?
                .map(|l| -> Result<Model> {
                    serde_json::from_str(&l?).map_err(crate::error::Error::Json)
                });

        Ok(stream)
    }

    pub(crate) async fn make_request_as_raw_lines(
        &self,
        mut http_request: http::Request<Bytes>,
    ) -> Result<impl StreamExt<Item = Result<String>>> {
        if let Some(auth) = &self.bearer_auth {
            let mut auth_header = http::HeaderValue::from_str(auth)
                .map_err(|e| Error::HttpRequestBuilder(http::Error::from(e)))?;
            // exclude the auth header from being logged
            auth_header.set_sensitive(true);
            http_request
                .headers_mut()
                .insert(http::header::AUTHORIZATION, auth_header);
        };

        let convert_err = |e: reqwest::Error| Error::Request(e.to_string());
        let request = reqwest::Request::try_from(http_request).map_err(convert_err)?;
        let body_text = if let Some(body) = request.body() {
            match body.as_bytes() {
                Some(bytes) => String::from_utf8_lossy(bytes).to_string(),
                None => "<streaming body>".to_string(),
            }
        } else {
            "<empty body>".to_string()
        };
        debug!(?request, body = %body_text, "sending");
        let response = self.client.execute(request).await;
        debug!(?response, "received");
        let stream = response
            .map_err(convert_err)?
            .bytes_stream()
            .map_err(futures::io::Error::other)
            .into_async_read()
            .lines()
            .filter(|l| {
                // To avoid trying to serialize blank keep alive lines.
                futures::future::ready(match l {
                    Ok(line) => !line.is_empty(),
                    Err(_) => true,
                })
            })
            .map(|l| -> Result<String> {
                let line = l?;
                debug!(line, "model line");
                if line.starts_with("<!DOCTYPE html>") {
                    return Err(crate::error::Error::PageNotFound());
                }
                // Check for error responses returned as json before model serialization is attempted.
                // This can happen when not authorized to access an endpoint.
                if let Ok(error_value) = serde_json::from_str::<serde_json::Value>(&line)
                    && let Some(error_msg) = error_value.get("error").and_then(|e| e.as_str())
                {
                    return Err(crate::error::Error::Response(error_msg.to_string()));
                }
                Ok(line)
            });

        Ok(stream)
    }
}