lettr 1.0.0

Official Rust SDK for the Lettr Email 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

use reqwest::header::{HeaderMap, HeaderValue, AUTHORIZATION, CONTENT_TYPE, USER_AGENT};
use reqwest::Method;

const BASE_URL: &str = "https://app.lettr.com/api";

// Use the correct reqwest types based on blocking feature.
#[cfg(feature = "blocking")]
use reqwest::blocking::Client as HttpClient;
#[cfg(not(feature = "blocking"))]
use reqwest::Client as HttpClient;

#[cfg(not(feature = "blocking"))]
pub(crate) type RequestBuilder = reqwest::RequestBuilder;
#[cfg(feature = "blocking")]
pub(crate) type RequestBuilder = reqwest::blocking::RequestBuilder;

#[cfg(not(feature = "blocking"))]
pub(crate) type Response = reqwest::Response;
#[cfg(feature = "blocking")]
pub(crate) type Response = reqwest::blocking::Response;

/// Internal configuration for the Lettr HTTP client.
#[derive(Debug, Clone)]
pub(crate) struct Config {
    http: HttpClient,
    base_url: String,
}

impl Config {
    /// Creates a new [`Config`] with the given API key.
    pub fn new(api_key: &str) -> Self {
        Self::with_base_url(api_key, BASE_URL)
    }

    /// Creates a new [`Config`] with a custom base URL.
    pub fn with_base_url(api_key: &str, base_url: &str) -> Self {
        let mut headers = HeaderMap::new();
        headers.insert(
            AUTHORIZATION,
            HeaderValue::from_str(&format!("Bearer {api_key}"))
                .expect("API key must be valid ASCII"),
        );
        headers.insert(CONTENT_TYPE, HeaderValue::from_static("application/json"));
        headers.insert(
            USER_AGENT,
            HeaderValue::from_static(concat!("lettr-rust/", env!("CARGO_PKG_VERSION"))),
        );

        let http = HttpClient::builder()
            .default_headers(headers)
            .build()
            .expect("Failed to build HTTP client");

        Self {
            http,
            base_url: base_url.to_owned(),
        }
    }

    /// Build an HTTP request for the given method and path.
    pub fn build(&self, method: Method, path: &str) -> RequestBuilder {
        let url = format!("{}{path}", self.base_url);
        self.http.request(method, url)
    }

    /// Send a built request and handle non-success status codes.
    ///
    /// Returns the raw response on success, or an appropriate error.
    #[maybe_async::maybe_async]
    pub async fn send(&self, request: RequestBuilder) -> crate::Result<Response> {
        let response = request.send().await?;
        let status = response.status();

        if status.is_success() {
            Ok(response)
        } else {
            let body = response.text().await.unwrap_or_default();

            match serde_json::from_str::<crate::error::RawErrorResponse>(&body) {
                Ok(raw) => Err(raw.into_error()),
                Err(_) => Err(crate::Error::Parse(format!("HTTP {status}: {body}"))),
            }
        }
    }
}