twilight-http 0.2.4

Discord REST API client for the Twilight ecosystem.
Documentation
use super::{Client, State};
use crate::{
    error::{Error, Result},
    ratelimiting::Ratelimiter,
    request::channel::message::allowed_mentions::AllowedMentions,
};
use reqwest::{ClientBuilder as ReqwestClientBuilder, Proxy};
use std::{
    sync::{atomic::AtomicBool, Arc},
    time::Duration,
};

#[derive(Debug)]
/// A builder for [`Client`].
///
/// [`Client`]: struct.Client.html
pub struct ClientBuilder {
    pub(crate) default_allowed_mentions: Option<AllowedMentions>,
    pub(crate) proxy: Option<Proxy>,
    pub(crate) proxy_http: bool,
    pub(crate) ratelimiter: Option<Ratelimiter>,
    pub(crate) reqwest_client: Option<ReqwestClientBuilder>,
    pub(crate) timeout: Duration,
    pub(crate) token: Option<String>,
}

impl ClientBuilder {
    /// Create a new builder to create a [`Client`].
    ///
    /// [`Client`]: struct.Client.html
    pub fn new() -> Self {
        Self::default()
    }

    /// Build the [`Client`].
    ///
    /// # Errors
    ///
    /// Errors if `reqwest` fails to build the client.
    ///
    /// [`Client`]: struct.Client.html
    pub fn build(self) -> Result<Client> {
        let mut builder = self
            .reqwest_client
            .unwrap_or_else(ReqwestClientBuilder::new)
            .timeout(self.timeout);

        if let Some(proxy) = self.proxy {
            builder = builder.proxy(proxy)
        }

        Ok(Client {
            state: Arc::new(State {
                http: builder
                    .build()
                    .map_err(|source| Error::BuildingClient { source })?,
                ratelimiter: self.ratelimiter,
                token_invalid: AtomicBool::new(false),
                token: self.token,
                use_http: self.proxy_http,
                default_allowed_mentions: self.default_allowed_mentions,
            }),
        })
    }

    /// Set the default allowed mentions setting to use on all messages sent through the HTTP
    /// client.
    pub fn default_allowed_mentions(mut self, allowed_mentions: AllowedMentions) -> Self {
        self.default_allowed_mentions.replace(allowed_mentions);

        self
    }

    /// Sets the proxy to use for all HTTP requests.
    ///
    /// This accepts a `reqwest::Proxy`.
    pub fn proxy(mut self, proxy: Proxy) -> Self {
        self.proxy.replace(proxy);

        self
    }

    /// Set whether to proxy over HTTP.
    ///
    /// The default is `false`.
    pub fn proxy_http(mut self, proxy_http: bool) -> Self {
        self.proxy_http = proxy_http;

        self
    }

    /// Set a pre-configured reqwest client builder to build off of.
    ///
    /// The proxy and timeout settings in the reqwest client will be overridden by
    /// those in this builder.
    ///
    /// The default client uses Rustls as its TLS backend.
    pub fn reqwest_client(mut self, client: ReqwestClientBuilder) -> Self {
        self.reqwest_client.replace(client);

        self
    }

    /// Set a ratelimiter to use.
    ///
    /// If the argument is `None` then the client's ratelimiter will be skipped
    /// before making a request.
    ///
    /// If this method is not called at all then a default ratelimiter will be
    /// created by `ClientBuilder::build`.
    ///
    /// [`ClientBuilder::build`]: #method.build
    pub fn ratelimiter(mut self, ratelimiter: impl Into<Option<Ratelimiter>>) -> Self {
        self.ratelimiter = ratelimiter.into();

        self
    }

    /// Set the timeout for HTTP requests.
    ///
    /// The default is 10 seconds.
    pub fn timeout(mut self, duration: Duration) -> Self {
        self.timeout = duration;

        self
    }

    /// Set the token to use for HTTP requests.
    pub fn token(mut self, token: impl Into<String>) -> Self {
        let mut token = token.into();

        let is_bot = token.starts_with("Bot ");
        let is_bearer = token.starts_with("Bearer ");

        // Make sure it is either a bot or bearer token, and assume it's a bot
        // token if no prefix is given
        if !is_bot && !is_bearer {
            token.insert_str(0, "Bot ");
        }

        self.token.replace(token);

        self
    }
}

impl Default for ClientBuilder {
    fn default() -> Self {
        Self {
            default_allowed_mentions: None,
            proxy: None,
            proxy_http: false,
            reqwest_client: None,
            ratelimiter: Some(Ratelimiter::new()),
            timeout: Duration::from_secs(10),
            token: None,
        }
    }
}