rusty-box 0.2.0-alpha

//! This module contains the common traits and types used by the HTTP clients.
//! Leaving the door open for developers to implement other http clients.
use std::collections::HashMap;
use std::fmt;

use async_trait::async_trait;
// use maybe_async::maybe_async;
use serde_json::Value;

/// HTTP headers.
pub type Headers = HashMap<String, String>;
/// Query parameters.
pub type Query<'a> = HashMap<&'a str, &'a str>;
/// Form parameters.
pub type Form<'a> = HashMap<&'a str, &'a str>;

/// This trait represents the interface to be implemented for an HTTP client,
/// which is kept separate from the Box client for cleaner code. Thus, it
/// also requires other basic traits that are needed for the Box client.
///
/// When a request doesn't need to pass parameters, the empty or default value
/// of the payload type should be passed, like `json!({})` or `Query::new()`.
/// This avoids using `Option<T>` because `Value` itself may be null in other
/// different ways (`Value::Null`, an empty `Value::Object`...), so this removes
/// redundancy and edge cases (a `Some(Value::Null), for example, doesn't make
/// much sense).
#[async_trait]
pub trait BaseHttpClient: Send + Default + Clone + fmt::Debug {
    type Error;

    // This internal function should always be given an object value in JSON.
    async fn get(
        &self,
        url: &str,
        headers: Option<&Headers>,
        payload: &Query,
    ) -> Result<String, Self::Error>;

    async fn post(
        &self,
        url: &str,
        headers: Option<&Headers>,
        query: Option<&Query>,
        payload: &Value,
    ) -> Result<String, Self::Error>;

    async fn post_form(
        &self,
        url: &str,
        headers: Option<&Headers>,
        payload: &Form<'_>,
    ) -> Result<String, Self::Error>;

    async fn put(
        &self,
        url: &str,
        headers: Option<&Headers>,
        query: Option<&Query>,
        payload: &Value,
    ) -> Result<String, Self::Error>;

    async fn delete(
        &self,
        url: &str,
        headers: Option<&Headers>,
        payload: &Value,
    ) -> Result<String, Self::Error>;
}