openlibrary-rs 0.3.1

A wrapper around openlibrary's Web API.
Documentation 
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

use std::fmt::Display;

use derive_builder::Builder;

use crate::OpenlibraryRequest;

#[derive(Default, Clone, Debug)]
pub enum BookType {
    #[default]
    Works,
    Editions,
    ISBN,
}

impl Display for BookType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Self::Works => "/works",
                Self::Editions => "/books",
                Self::ISBN => "/isbn",
            }
        )
    }
}

/// The struct representation of a request to the [Books API](https://openlibrary.org/dev/docs/api/books)
///
/// The fields of this struct are private. If you want to view available fields that can be set please look at the [`BooksBuilder`] struct.
#[derive(Builder, Default, Debug)]
#[builder(setter(into), default)]
pub struct Books {
    book_type: BookType,
    id: String,
}

impl OpenlibraryRequest for Books {
    fn path(&self) -> String {
        format!("{}/{}.json", self.book_type, self.id)
    }

    fn query(&self) -> Vec<(&'static str, String)> {
        vec![]
    }
}

/// The struct representation of a request to the generic [Books API](https://openlibrary.org/dev/docs/api/books)
///
/// The fields of this struct are private. If you want to view available fields that can be set please look at the [`BooksGenericBuilder`] struct.
#[derive(Builder, Default, Debug)]
#[builder(setter(into), default)]
pub struct BooksGeneric {
    #[builder(default = "vec![]")]
    bibkeys: Vec<String>,
    #[builder(default = r#"String::from("viewapi")"#)]
    jscmd: String,
}

impl OpenlibraryRequest for BooksGeneric {
    fn path(&self) -> String {
        String::from("/api/books")
    }

    fn query(&self) -> Vec<(&'static str, String)> {
        vec![
            ("format", String::from("json")),
            ("bibkeys", self.bibkeys.join(",")),
            ("jscmd", self.jscmd.clone()),
        ]
    }
}

#[cfg(test)]
mod tests {
    use mockito::{mock, Matcher};
    use serde_json::json;

    use crate::OpenlibraryRequest;

    use super::{BooksBuilder, BooksGenericBuilder};

    #[test]
    fn test_books_execute() {
        let books = BooksBuilder::default().id("1234").build().unwrap();

        let json = json!({
            "title": "test",
            "description": "this is a test",
            "key": "/works/1234"
        });

        let _m = mock("GET", Matcher::Regex(format!(r"{}\w*", books.url().path())))
            .with_header("content-type", "application/json")
            .with_body(json.to_string())
            .create();

        let books_result = books.execute();

        assert_eq!(books_result["title"], "test");
        assert_eq!(books_result["description"], "this is a test");
        assert_eq!(books_result["key"], "/works/1234");
    }

    #[test]
    fn test_books_generic_execute() {
        let books_generic = BooksGenericBuilder::default()
            .bibkeys(vec!["ISBN:0385472579".to_string()])
            .build()
            .unwrap();

        let json = json!({
            "ISBN:0385472579": {
                "bib_key": "ISBN:0385472579",
                "preview": "noview",
                "thumbnail_url": "https://covers.openlibrary.org/b/id/240726-S.jpg",
                "preview_url": "https://openlibrary.org/books/OL1397864M/Zen_speaks",
                "info_url": "https://openlibrary.org/books/OL1397864M/Zen_speaks"
            }
        });

        let _m = mock(
            "GET",
            Matcher::Regex(format!(r"{}\w*", books_generic.url().path())),
        )
        .with_header("content-type", "application/json")
        .with_body(json.to_string())
        .create();

        let result = books_generic.execute();
        let inner_result = &result["ISBN:0385472579"];

        assert_eq!(inner_result["bib_key"], "ISBN:0385472579");
        assert_eq!(inner_result["preview"], "noview");
        assert_eq!(
            inner_result["thumbnail_url"],
            "https://covers.openlibrary.org/b/id/240726-S.jpg"
        );
        assert_eq!(
            inner_result["preview_url"],
            "https://openlibrary.org/books/OL1397864M/Zen_speaks"
        );
        assert_eq!(
            inner_result["info_url"],
            "https://openlibrary.org/books/OL1397864M/Zen_speaks"
        );
    }
}