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 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
//! Bridge to provide a client implementation for the `reqwest` crate. //! //! # Examples //! //! Refer to the documentation for [`WeebApiRequester`]. //! //! [`WeebApiRequester`]: trait.WeebApiRequester.html use std::io::{Cursor, Read}; use reqwest::header::Authorization; use reqwest::multipart::{Form, Part}; use reqwest::{Client as ReqwestClient, RequestBuilder, StatusCode, Url}; use serde::de::DeserializeOwned; use serde_json; use ::model::{ ApiResponse, Image, ImageTagsResponse, ImageTypesResponse, ImageUploadResponse }; use ::{Error, ImageParams, Result, UploadParams, constants}; /// Trait which defines the methods necessary to interact with the service. /// /// # Examples /// /// To bring in the implemenation for the `reqwest` Client, simply use the /// trait: /// /// ```rust,no_run /// use weeb_api::WeebApiReqwestRequester; /// ``` /// /// At this point, the methods will be on your Reqwest Client. pub trait WeebApiRequester { /// Retrieves information about the API. /// /// # Examples /// /// Get basic info about the API: /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use weeb_api::WeebApiReqwestRequester; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let response = client.get_images()?; /// /// println!("Info: {:?}", response); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns [`Error::Json`] if there was an error parsing the response /// body. /// /// Returns [`Error::ReqwestBad`] if the request was otherwise bad for some /// reason, containing the response. /// /// Returns [`Error::ReqwestInvalid`] if the response was a non-OK (status /// code 200) response, containing the response. /// /// [`Error::Json`]: ../enum.Error.html#variant.Json /// [`Error::ReqwestBad`]: ../enum.Error.html#variant.ReqwestBad /// [`Error::ReqwestInvalid`]: ../enum.Error.html#variant.ReqwestInvalid fn get_images(&self) -> Result<ApiResponse>; /// Get info on an image. /// /// # Examples /// /// Get info about the image with the id "ryh6x04Rb": /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use weeb_api::WeebApiReqwestRequester; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let id = "ryh6x04Rb"; /// let response = client.get_image_info(token, id)?; /// /// println!("Info: {:?}", response); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns [`Error::Json`] if there was an error parsing the response /// body. /// /// Returns [`Error::ReqwestBad`] if the request was otherwise bad for some /// reason, containing the response. /// /// Returns [`Error::ReqwestInvalid`] if the response was a non-OK (status /// code 200) response, containing the response. /// /// Returns [`Error::ReqwestUnauthorized`] if the authorization token was /// invalid. /// /// [`Error::Json`]: ../enum.Error.html#variant.Json /// [`Error::ReqwestBad`]: ../enum.Error.html#variant.ReqwestBad /// [`Error::ReqwestInvalid`]: ../enum.Error.html#variant.ReqwestInvalid /// [`Error::ReqwestUnauthorized`]: ../enum.Error.html#variant.ReqwestUnauthorized fn get_image_info<S>(&self, auth: S, id: &str) -> Result<Image> where S: Into<String>; /// Retrieves a random image given the matching parameters. /// /// **Note**: You must specify at least one of [`kind`] or [`tags`] in the /// image params. /// /// # Examples /// /// Retrieve a random image with the "sleepy" kind: /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use weeb_api::{ImageParams, WeebApiReqwestRequester}; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let params = ImageParams::kind("sleepy"); /// let response = client.get_image_random(token, params)?; /// /// println!("URL: {}", response.url); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// Retrieve a random image with the "girl" tag: /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use weeb_api::{ImageParams, WeebApiReqwestRequester}; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let params = ImageParams::tags(vec!["girl"]); /// let response = client.get_image_random(token, params)?; /// /// println!("URL: {}", response.url); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns [`Error::Json`] if there was an error parsing the response /// body. /// /// Returns [`Error::NoParamsSpecified`] if the input did not specify one of /// the required image parameters, containing the image parameters. /// /// Returns [`Error::ReqwestBad`] if the request was otherwise bad for some /// reason, containing the response. /// /// Returns [`Error::ReqwestInvalid`] if the response was a non-OK (status /// code 200) response, containing the response. /// /// Returns [`Error::ReqwestParse`] if there was an error parsing the image /// parameters into a valid URL. /// /// Returns [`Error::ReqwestUnauthorized`] if the authorization token was /// invalid. /// /// [`Error::Json`]: ../enum.Error.html#variant.Json /// [`Error::NoParamsSpecified`]: ../enum.Error.html#variant.NoParamsSpecified /// [`Error::ReqwestBad`]: ../enum.Error.html#variant.ReqwestBad /// [`Error::ReqwestInvalid`]: ../enum.Error.html#variant.ReqwestInvalid /// [`Error::ReqwestParse`]: ../enum.Error.html#variant.ReqwestParse /// [`Error::ReqwestUnauthorized`]: ../enum.Error.html#variant.ReqwestUnauthorized fn get_image_random<S>(&self, auth: S, params: ImageParams) -> Result<Image> where S: Into<String>; /// Retrieves all the current image tags. /// /// # Examples /// /// Retrieve all image tags including hidden ones: /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use weeb_api::WeebApiReqwestRequester; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let response = client.get_image_tags(token, true)?; /// /// println!("Tags: {:?}", response); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns [`Error::Json`] if there was an error parsing the response /// body. /// /// Returns [`Error::ReqwestBad`] if the request was otherwise bad for some /// reason, containing the response. /// /// Returns [`Error::ReqwestInvalid`] if the response was a non-OK (status /// code 200) response, containing the response. /// /// Returns [`Error::ReqwestUnauthorized`] if the authorization token was /// invalid. /// /// [`Error::Json`]: ../enum.Error.html#variant.Json /// [`Error::ReqwestBad`]: ../enum.Error.html#variant.ReqwestBad /// [`Error::ReqwestInvalid`]: ../enum.Error.html#variant.ReqwestInvalid /// [`Error::ReqwestUnauthorized`]: ../enum.Error.html#variant.ReqwestUnauthorized fn get_image_tags<S>(&self, auth: S, hidden: bool) -> Result<Vec<String>> where S: Into<String>; /// Retrieves all the current image types. /// /// # Examples /// /// Retrieve all image tags including hidden ones: /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use weeb_api::WeebApiReqwestRequester; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let response = client.get_image_types(token, true)?; /// /// println!("Types: {:?}", response); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns [`Error::Json`] if there was an error parsing the response /// body. /// /// Returns [`Error::ReqwestBad`] if the request was otherwise bad for some /// reason, containing the response. /// /// Returns [`Error::ReqwestInvalid`] if the response was a non-OK (status /// code 200) response, containing the response. /// /// Returns [`Error::ReqwestUnauthorized`] if the authorization token was /// invalid. /// /// [`Error::Json`]: ../enum.Error.html#variant.Json /// [`Error::ReqwestBad`]: ../enum.Error.html#variant.ReqwestBad /// [`Error::ReqwestInvalid`]: ../enum.Error.html#variant.ReqwestInvalid /// [`Error::ReqwestUnauthorized`]: ../enum.Error.html#variant.ReqwestUnauthorized fn get_image_types<S>(&self, auth: S, hidden: bool) -> Result<Vec<String>> where S: Into<String>; /// Uploads an image to the Api. /// /// # Examples /// /// Upload an image after reading it from the disk: /// /// ```rust,no_run /// extern crate reqwest; /// extern crate weeb_api; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # /// use reqwest::Client; /// use std::env; /// use std::fs::File; /// use std::io::Read; /// use weeb_api::{UploadParams, WeebApiReqwestRequester}; /// /// let token = env::var("WEEB_TOKEN")?; /// /// let client = Client::new(); /// /// let mut buffer = vec![]; /// let mut file = File::open("./file.png")?; /// file.read_to_end(&mut buffer)?; /// let params = UploadParams::simple("hug".to_string(), buffer); /// /// let response = client.upload_image(token, params)?; /// /// println!("Status: {}", response.message); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns [`Error::Json`] if there was an error parsing the response /// body. /// /// Returns [`Error::NoUploadSpecified`] if the input did not specify one of /// the required image upload parameters. /// /// Returns [`Error::ReqwestBad`] if the request was otherwise bad for some /// reason, containing the response. /// /// Returns [`Error::ReqwestInvalid`] if the response was a non-OK (status /// code 200) response, containing the response. /// /// Returns [`Error::ReqwestParse`] if there was an error parsing the image /// parameters into a valid URL. /// /// Returns [`Error::ReqwestUnauthorized`] if the authorization token was /// invalid. /// /// [`Error::Json`]: ../enum.Error.html#variant.Json /// [`Error::NoParamsSpecified`]: ../enum.Error.html#variant.NoUploadSpecified /// [`Error::ReqwestBad`]: ../enum.Error.html#variant.ReqwestBad /// [`Error::ReqwestInvalid`]: ../enum.Error.html#variant.ReqwestInvalid /// [`Error::ReqwestParse`]: ../enum.Error.html#variant.ReqwestParse /// [`Error::ReqwestUnauthorized`]: ../enum.Error.html#variant.ReqwestUnauthorized fn upload_image<S>(&self, auth: S, params: UploadParams) -> Result<ImageUploadResponse> where S: Into<String>; } impl WeebApiRequester for ReqwestClient { fn get_images(&self) -> Result<ApiResponse> { handle_request(&mut self.get(constants::GET_IMAGES)) } fn get_image_info<S>(&self, auth: S, id: &str) -> Result<Image> where S: Into<String> { let url = Url::parse(&format!("{}{}", constants::GET_IMAGE_INFO, id))?; handle_request(self.get(url).header(Authorization(auth.into()))) } fn get_image_random<S>(&self, auth: S, params: ImageParams) -> Result<Image> where S: Into<String> { let built = params.into_data(); if built.is_empty() { return Err(Error::NoParamsSpecified); } let url = Url::parse_with_params(constants::GET_IMAGE_RANDOM, built)?; handle_request(self.get(url).header(Authorization(auth.into()))) } fn get_image_tags<S>(&self, auth: S, hidden: bool) -> Result<Vec<String>> where S: Into<String> { let param = [("hidden", &hidden.to_string())]; let url = Url::parse_with_params(constants::GET_IMAGE_TAGS, ¶m)?; let mut request = self.get(url); request.header(Authorization(auth.into())); handle_request::<ImageTagsResponse>(&mut request).map(|x| x.tags) } fn get_image_types<S>(&self, auth: S, hidden: bool) -> Result<Vec<String>> where S: Into<String> { let param = [("hidden", &hidden.to_string())]; let url = Url::parse_with_params(constants::GET_IMAGE_TYPES, ¶m)?; let mut request = self.get(url); request.header(Authorization(auth.into())); handle_request::<ImageTypesResponse>(&mut request).map(|x| x.types) } fn upload_image<S>(&self, auth: S, params: UploadParams) -> Result<ImageUploadResponse> where S: Into<String> { let (built, file) = params.into_data(); if built.is_empty() { return Err(Error::NoUploadSpecified); } let url = Url::parse_with_params(constants::POST_IMAGE, built)?; let part = Part::reader(Cursor::new(file)); let form = Form::new().part("file", part); let mut request = self.post(url); request.multipart(form); request.header(Authorization(auth.into())); handle_request(&mut request) } } fn handle_request<T: DeserializeOwned>(request: &mut RequestBuilder) -> Result<T> { let response = request.send()?; match response.status() { StatusCode::Ok => {}, StatusCode::BadRequest => { return Err(Error::ReqwestBad(Box::new(response))); }, StatusCode::Unauthorized => { return Err(Error::ReqwestUnauthorized(Box::new(response))); }, _ => return Err(Error::ReqwestInvalid(Box::new(response))), } from_reader(response) } #[inline] fn from_reader<T: DeserializeOwned, U: Read>(reader: U) -> Result<T> { serde_json::from_reader(reader).map_err(From::from) }