wiki-tui 0.6.0

A simple and easy to use Wikipedia Text User Interface
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

use crate::wiki::article::{compiled_article::Article, parser::Parser};

use anyhow::Result;
use reqwest::blocking::{get, Response};

/// A Builder which fetches and parses an article. Can work with either an article id or a link
pub struct ArticleBuilder {
    /// The id of the article to be fetched
    page_id: i32,
    /// The optional link of the article to be fetched
    target: Option<String>,
    /// The url of wikipedia
    base_url: String,
}

impl ArticleBuilder {
    /// Creates a new Articlebuilder
    pub fn new(page_id: i32, target: Option<String>, base_url: &str) -> ArticleBuilder {
        debug!("creating a new instance of ArticleBuilder");
        ArticleBuilder {
            page_id,
            target,
            base_url: base_url.to_string(),
        }
    }

    /// Fetches the article and parses it with a given parser. Any errors it encounters will be returned
    pub fn build(&self, parser: &mut impl Parser) -> Result<Article> {
        info!("beginning the build process");
        let url = self.build_url();

        info!("making the request to '{}'", url);
        let response = self.make_request(&url)?;

        info!("parsing the article");
        self.parse_response(parser, response)
    }

    /// Creates a url from the link
    fn build_url(&self) -> String {
        match self.target {
            Some(ref target) => format!("{}{}", self.base_url, target),
            None => format!("{}?curid={}", self.base_url, self.page_id),
        }
    }

    /// Makes the request to wikipedia and checks the response for errors
    fn make_request(&self, url: &str) -> Result<Response> {
        Ok(get(url)?.error_for_status()?)
    }

    /// Parses the response with a given parser
    fn parse_response(&self, parser: &mut impl Parser, response: Response) -> Result<Article> {
        parser.parse(response)
    }
}

#[cfg(test)]
mod tests {
    const BASE_URL: &str = "https://en.wikipedia.org/";

    #[test]
    fn correct_url() {
        use super::ArticleBuilder;
        assert_eq!(
            ArticleBuilder::new(1234, None, BASE_URL).build_url(),
            format!("{}?curid=1234", BASE_URL)
        );
        assert_eq!(
            ArticleBuilder::new(1234, Some("/wiki/Software".to_string()), BASE_URL).build_url(),
            format!("{}/wiki/Software", BASE_URL)
        );
    }
}