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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
use std::collections::HashMap;
pub use reqwest;
pub use serde_json;
pub use serde;
pub type ParameterHashMap<'a> = HashMap<&'a str, Option<&'a str>>;
/// A trait for handling HTTP requests.
#[async_trait::async_trait]
pub trait RequestHandler<'a> {
/// The base URL for the requests.
const BASE_URL : &'static str;
/// The API key as string used for authentication.
const API_KEY : Option<&'static str> = Some("apiKey");
/// Joins the given endpoint with the base URL.
///
/// # Arguments
///
/// * `endpoint` - The endpoint to join with the base URL.
///
/// # Returns
///
/// The joined URL as a `String`.
///
/// # Example
///
/// ```rust
/// use std::collections::HashMap;
///
/// struct MyRequestHandler;
///
/// impl<'a> RequestHandler<'a> for MyRequestHandler {
/// const BASE_URL: &'static str = "https://api.example.com";
///
/// fn make_request_url(&self, endpoint: &str) -> String {
/// Self::join_endpoints(endpoint)
/// }
/// }
/// ```
fn join_endpoints(endpoint : &str) -> String {
format!("{}/{}",Self::BASE_URL,endpoint)
}
/// Builds the parameter hashmap using the given function.
///
/// # Arguments
///
/// * `function` - A closure that takes a mutable reference to a `ParameterHashMap` and modifies it.
///
/// # Returns
///
/// The populated `ParameterHashMap`.
///
/// # Example
///
/// ```rust
/// use std::collections::HashMap;
///
/// struct MyRequestHandler;
///
/// impl<'a> RequestHandler<'a> for MyRequestHandler {
/// const BASE_URL: &'static str = "https://api.example.com";
///
/// fn make_parameters(&self) -> ParameterHashMap<'a> {
/// self.parameters(|params| {
/// params.insert("key1", Some("value1"));
/// params.insert("key2", Some("value2"));
/// })
/// }
/// }
/// ```
fn parameters<Function>(&self,function: Function) -> ParameterHashMap<'a> where Function : FnOnce(&mut ParameterHashMap<'a>) {
let mut parameters : ParameterHashMap<'a> = HashMap::new();
function(&mut parameters);
parameters
}
/// Sends an HTTP request with the given `RequestBuilder`, and returns the parsed response.
///
/// # Arguments
///
/// * `request_builder` - The `RequestBuilder` containing the configured request.
///
/// # Returns
///
/// A `Result` containing the parsed response on success, or a `StatusCode` on failure.
///
/// # Example
///
/// ```rust
/// use std::collections::HashMap;
///
/// struct MyRequestHandler;
///
/// #[derive(serde::Deserialize)]
/// struct MyResponse {
/// // Define your response structure here
/// }
///
/// #[async_trait::async_trait]
/// impl<'a> RequestHandler<'a> for MyRequestHandler {
/// const BASE_URL: &'static str = "https://api.example.com";
///
/// async fn make_request<T>(&self, request_builder: RequestBuilder) -> Result<T, StatusCode>
/// where
/// T: for<'de> serde::Deserialize<'de>,
/// {
/// self.request(request_builder).await
/// }
/// }
/// ```
async fn request<T>(&self,request_builder : reqwest::RequestBuilder) -> std::result::Result<T,reqwest::StatusCode> where T : for<'de> serde::Deserialize<'de> {
let response = request_builder.send().await.expect("Error requesting request");
let status = response.status();
if status.is_success() {
let body = response.text().await.expect("Error in reading response body");
let deserialized : T = serde_json::from_str(&body).expect("Error deserializing response body");
Ok(deserialized)
}
else {
Err(status)
}
}
}
pub trait RequestDefaults<'a> {
/// Modifies the provided `RequestBuilder` with default headers.
///
/// # Arguments
///
/// * `request_builder` - The `RequestBuilder` to modify.
///
/// # Returns
///
/// The modified `RequestBuilder` with default headers set.
fn default_headers(&self,request_builder : reqwest::RequestBuilder) -> reqwest::RequestBuilder {
request_builder
}
/// Modifies the provided `RequestBuilder` with default parameters.
///
/// # Arguments
///
/// * `request_builder` - The `RequestBuilder` to modify.
///
/// # Returns
///
/// The modified `RequestBuilder` with default parameters set.
fn default_parameters(&self,request_builder : reqwest::RequestBuilder) -> reqwest::RequestBuilder {
request_builder
}
/// Modifies the provided `RequestBuilder` with default settings for post request.
///
/// # Arguments
///
/// * `endpoint` - The endpoint for the request.
/// * `json` - The JSON payload for the request.
///
/// # Returns
///
/// The modified `RequestBuilder` with default settings applied.
fn default_post_requestor(&self,endpoint : &'a str, json : &'a str) -> reqwest::RequestBuilder {
panic!("Method is not implemented")
}
/// Modifies the provided `RequestBuilder` with default settings for get request.
///
/// # Arguments
///
/// * `endpoint` - The endpoint for the request.
/// * `json` - The JSON payload for the request.
///
/// # Returns
///
/// The modified `RequestBuilder` with default settings applied.
fn default_get_requestor(&self,endpoint : &'a str,parameters : ParameterHashMap<'a>) -> reqwest::RequestBuilder {
panic!("Method is not implemented")
}
/// Adds an Authorization header to the given RequestBuilder with the provided token.
///
/// The Authorization header follows the format "Bearer TOKEN", where TOKEN is the
/// authentication token used for authorization.
///
/// # Arguments
///
/// * request_builder - The RequestBuilder to add the header to.
/// * token - The authentication token to include in the Authorization header.
///
/// # Returns
///
/// The modified RequestBuilder with the Authorization header added.
///
/// # Example
///
/// ```rust
/// use reqwest::RequestBuilder;
/// let request_builder = reqwest::Client::new().get("https://example.com");
/// let token = "YOUR_AUTH_TOKEN";
/// let modified_request_builder = authorization_header(&request_builder, token);
/// ```
fn authorization_header(&self,request_builder : reqwest::RequestBuilder,token : &'a str) -> reqwest::RequestBuilder {
request_builder.header("Authorization",format!(" Bearer {}",token))
}
}