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
//! Wrapper for [Openlibrary's Web API](https://openlibrary.org/developers/api)
//!
//! # Overview
//!
//! **PLEASE NOTE**: this crate is currently in an experimental stage.
//! Meaning expect frequent, large breaking changes from version to version until we are in a stable state.
//!
//! There are currently 8 sub APIs offered by Openlibrary's Web API.
//! You can check the table below to see the status of each.
//!
//! - [X] [Books](https://openlibrary.org/dev/docs/api/books) [^books_completeness]
//! - [ ] [Authors](https://openlibrary.org/dev/docs/api/authors)
//! - [ ] [Subjects](https://openlibrary.org/dev/docs/api/subjects)
//! - [X] [Search](https://openlibrary.org/dev/docs/api/search)
//! - [ ] [Search inside](https://openlibrary.org/dev/docs/api/search_inside)
//! - [ ] [Partner](https://openlibrary.org/dev/docs/api/read)
//! - [ ] [Covers](https://openlibrary.org/dev/docs/api/covers)
//! - [ ] [Recent Changes](https://openlibrary.org/dev/docs/api/recentchanges)
//!
//! # Books
//!
//! You can view information about books by Works, Editions, and ISBN ids by using the [`books::Books`] struct
//!
//! ``` rust
//! use openlibrary_rs::books::{BookType, BooksBuilder};
//! use openlibrary_rs::OpenlibraryRequest;
//!
//! // execute request to Works API and pretty print debug of result
//! let books = BooksBuilder::default()
//! .book_type(BookType::Works)
//! .id("OL45883W")
//! .build()
//! .unwrap();
//!
//! println!("{:#?}", books.execute());
//! ```
//!
//! # Search
//!
//! You can search for books, authors, and more using the [`search::Search`] struct
//!
//! ``` rust
//! use openlibrary_rs::search::SearchBuilder;
//! use openlibrary_rs::OpenlibraryRequest;
//!
//! // execute search and pretty print debug of first result
//! let search = SearchBuilder::default()
//! .query("the lord of the rings")
//! .build()
//! .unwrap();
//!
//! println!("{:#?}", search.execute());
//! ```
//!
//! [^books_completeness]: Everything excluding the generic Books API is complete(i.e. Works, Editions, and ISBN APIs are done).
//!
use reqwest::Url;
use serde_json::Value;
#[allow(dead_code)]
const OPENLIBRARY_HOST: &str = "https://openlibrary.org";
pub mod books;
pub mod search;
/// Trait representation of an Openlibrary request
pub trait OpenlibraryRequest {
fn host() -> String {
#[cfg(not(test))]
return OPENLIBRARY_HOST.to_string();
#[cfg(test)]
return mockito::server_url().to_string();
}
fn url(&self) -> Url;
fn execute(&self) -> Value {
let response = reqwest::blocking::get(self.url()).unwrap();
response.json().unwrap()
}
}