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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
use constants::{Method, Response, AUTH};
use errors::{RequestResult, UrlParseResult};
use params::Params;
use reqwest::StatusCode;
use serde::de::DeserializeOwned;
use serde::Serialize;
use serde_json::Value;
use std::fmt::Debug;
use url::Url;
use utils::check_uri;
use crate::sse::ServerEvents;
pub use errors::{RequestError, ServerEventError, UrlParseError};
mod constants;
mod errors;
mod params;
mod sse;
mod utils;
#[derive(Debug)]
pub struct Firebase {
uri: Url,
}
impl Firebase {
/// ```rust
/// use firebase_rs::Firebase;
///
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap();
/// ```
pub fn new(uri: &str) -> UrlParseResult<Self>
where
Self: Sized,
{
match check_uri(&uri) {
Ok(uri) => Ok(Self { uri }),
Err(err) => Err(err),
}
}
/// ```rust
/// const URI: &str = "...";
/// const AUTH_KEY: &str = "...";
///
/// use firebase_rs::Firebase;
///
/// let firebase = Firebase::auth("https://myfirebase.firebaseio.com", AUTH_KEY).unwrap();
/// ```
pub fn auth(uri: &str, auth_key: &str) -> UrlParseResult<Self>
where
Self: Sized,
{
match check_uri(&uri) {
Ok(mut uri) => {
uri.set_query(Some(&format!("{}={}", AUTH, auth_key)));
Ok(Self { uri })
}
Err(err) => Err(err),
}
}
/// ```rust
/// use firebase_rs::Firebase;
///
/// # async fn run() {
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().with_params().start_at(1).order_by("name").equal_to(5).finish();
/// let result = firebase.get::<String>().await;
/// # }
/// ```
pub fn with_params(&self) -> Params {
let uri = self.uri.clone();
Params::new(uri)
}
/// To use simple interface with synchronous callbacks, pair with `.listen()`:
/// ```rust
/// use firebase_rs::Firebase;
/// # async fn run() {
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
/// let stream = firebase.with_realtime_events().unwrap();
/// stream.listen(|event_type, data| {
/// println!("{:?} {:?}" ,event_type, data);
/// }, |err| println!("{:?}" ,err), false).await;
/// # }
/// ```
///
/// To use streaming interface for async code, pair with `.stream()`:
/// ```rust
/// use firebase_rs::Firebase;
/// use futures_util::StreamExt;
///
/// # async fn run() {
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
/// let stream = firebase.with_realtime_events()
/// .unwrap()
/// .stream(true);
/// stream.for_each(|event| {
/// match event {
/// Ok((event_type, maybe_data)) => println!("{:?} {:?}" ,event_type, maybe_data),
/// Err(err) => println!("{:?}" ,err),
/// }
/// futures_util::future::ready(())
/// }).await;
/// # }
/// ```
pub fn with_realtime_events(&self) -> Option<ServerEvents> {
ServerEvents::new(self.uri.as_str())
}
/// ```rust
/// use firebase_rs::Firebase;
///
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID").at("f69111a8a5258c15286d3d0bd4688c55");
/// ```
pub fn at(&self, path: &str) -> Self {
let mut new_path = String::default();
let paths = self.uri.path_segments().map(|p| p.collect::<Vec<_>>());
for mut path in paths.unwrap() {
if path.find(".json").is_some() {
path = path.trim_end_matches(".json");
}
new_path += format!("{}/", path).as_str();
}
new_path += path;
if new_path.find(".json").is_some() {
new_path = new_path.trim_end_matches(".json").to_string();
}
let mut uri = self.uri.clone();
uri.set_path(&format!("{}.json", new_path));
Self { uri }
}
/// ```rust
/// use firebase_rs::Firebase;
///
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
/// let uri = firebase.get_uri();
/// ```
pub fn get_uri(&self) -> String {
self.uri.to_string()
}
async fn request(&self, method: Method, data: Option<Value>) -> RequestResult<Response> {
let client = reqwest::Client::new();
return match method {
Method::GET => {
let request = client.get(self.uri.to_string()).send().await;
match request {
Ok(response) => {
if response.status() == StatusCode::from_u16(200).unwrap() {
return match response.text().await {
Ok(data) => {
if data.as_str() == "null" {
return Err(RequestError::NotFoundOrNullBody);
}
return Ok(Response { data });
}
Err(_) => Err(RequestError::NotJSON),
};
} else {
Err(RequestError::NetworkError)
}
}
Err(_) => return Err(RequestError::NetworkError),
}
}
Method::POST => {
if !data.is_some() {
return Err(RequestError::SerializeError);
}
let request = client.post(self.uri.to_string()).json(&data).send().await;
match request {
Ok(response) => {
let data = response.text().await.unwrap();
Ok(Response { data })
}
Err(_) => Err(RequestError::NetworkError),
}
}
Method::PATCH => {
if !data.is_some() {
return Err(RequestError::SerializeError);
}
let request = client.patch(self.uri.to_string()).json(&data).send().await;
match request {
Ok(response) => {
let data = response.text().await.unwrap();
Ok(Response { data })
}
Err(_) => Err(RequestError::NetworkError),
}
}
Method::DELETE => {
let request = client.delete(self.uri.to_string()).send().await;
match request {
Ok(_) => Ok(Response {
data: String::default(),
}),
Err(_) => Err(RequestError::NetworkError),
}
}
};
}
async fn request_generic<T>(&self, method: Method) -> RequestResult<T>
where
T: Serialize + DeserializeOwned + Debug,
{
let request = self.request(method, None).await;
match request {
Ok(response) => {
let data: T = serde_json::from_str(response.data.as_str()).unwrap();
Ok(data)
}
Err(err) => Err(err),
}
}
/// ```rust
/// use firebase_rs::Firebase;
/// use serde::{Serialize, Deserialize};
///
/// #[derive(Serialize, Deserialize, Debug)]
/// struct User {
/// name: String
/// }
///
/// # async fn run() {
/// let user = User { name: String::default() };
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
/// let users = firebase.set(&user).await;
/// # }
/// ```
pub async fn set<T>(&self, data: &T) -> RequestResult<Response>
where
T: Serialize + DeserializeOwned + Debug,
{
let data = serde_json::to_value(&data).unwrap();
self.request(Method::POST, Some(data)).await
}
/// ```rust
/// use std::collections::HashMap;
/// use firebase_rs::Firebase;
/// use serde::{Serialize, Deserialize};
///
/// #[derive(Serialize, Deserialize, Debug)]
/// struct User {
/// name: String
/// }
///
/// # async fn run() {
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
/// let users = firebase.get::<HashMap<String, User>>().await;
/// # }
/// ```
pub async fn get_as_string(&self) -> RequestResult<Response> {
self.request(Method::GET, None).await
}
/// ```rust
/// use std::collections::HashMap;
/// use firebase_rs::Firebase;
/// use serde::{Serialize, Deserialize};
///
/// #[derive(Serialize, Deserialize, Debug)]
/// struct User {
/// name: String
/// }
///
/// # async fn run() {
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID");
/// let user = firebase.get::<User>().await;
///
/// // OR
///
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
/// let user = firebase.get::<HashMap<String, User>>().await;
/// # }
/// ```
pub async fn get<T>(&self) -> RequestResult<T>
where
T: Serialize + DeserializeOwned + Debug,
{
self.request_generic::<T>(Method::GET).await
}
/// ```rust
/// use firebase_rs::Firebase;
///
/// # async fn run() {
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID");
/// firebase.delete().await;
/// # }
/// ```
pub async fn delete(&self) -> RequestResult<Response> {
self.request(Method::DELETE, None).await
}
/// ```rust
/// use firebase_rs::Firebase;
/// use serde::{Serialize, Deserialize};
///
/// #[derive(Serialize, Deserialize, Debug)]
/// struct User {
/// name: String
/// }
///
/// # async fn run() {
/// let user = User { name: String::default() };
/// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID");
/// let users = firebase.update(&user).await;
/// # }
/// ```
pub async fn update<T>(&self, data: &T) -> RequestResult<Response>
where
T: DeserializeOwned + Serialize + Debug,
{
let value = serde_json::to_value(&data).unwrap();
self.request(Method::PATCH, Some(value)).await
}
}
#[cfg(test)]
mod tests {
use crate::{Firebase, UrlParseError};
const URI: &str = "https://firebase_id.firebaseio.com";
const URI_WITH_SLASH: &str = "https://firebase_id.firebaseio.com/";
const URI_NON_HTTPS: &str = "http://firebase_id.firebaseio.com/";
#[tokio::test]
async fn simple() {
let firebase = Firebase::new(URI).unwrap();
assert_eq!(URI_WITH_SLASH.to_string(), firebase.get_uri());
}
#[tokio::test]
async fn non_https() {
let firebase = Firebase::new(URI_NON_HTTPS).map_err(|e| e.to_string());
assert_eq!(
firebase.err(),
Some(String::from(UrlParseError::NotHttps.to_string()))
);
}
#[tokio::test]
async fn with_auth() {
let firebase = Firebase::auth(URI, "auth_key").unwrap();
assert_eq!(
format!("{}/?auth=auth_key", URI.to_string()),
firebase.get_uri()
);
}
#[tokio::test]
async fn with_sse_events() {
// TODO: SSE Events Test
}
}