wikibase 0.7.6

A library to access Wikibase
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

#![deny(
//    missing_docs,
    missing_debug_implementations,
    missing_copy_implementations,
    trivial_casts,
    trivial_numeric_casts,
    unsafe_code,
    unstable_features,
    unused_import_braces,
    unused_qualifications
)]

use crate::error::WikibaseError;
use crate::validate;

const USER_AGENT_BASE: &str = concat!("Wikibase-RS/", env!("CARGO_PKG_VERSION"));

/// Configurations for Wikibase RS
///
/// The Configuration struct holds all the parameters that can can be
/// customized. The api_url is the api endpoint or a particular Wikibase
/// instance. It defaults to Wikidata.
#[derive(Debug, Clone)]
pub struct Configuration {
    api_url: String,
    user_agent_prefix: String,
    api: mediawiki::api::Api,
}

impl Configuration {
    pub async fn new_with_url(
        user_agent_prefix: &str,
        api_url: &str,
    ) -> Result<Configuration, WikibaseError> {
        let valid_user_agent_prefix = validate::validate_user_agent(user_agent_prefix)?;
        let api = match mediawiki::api::Api::new(api_url).await {
            Ok(api) => api,
            _ => {
                return Err(WikibaseError::Configuration(
                    "Can't create mediawiki API object".to_string(),
                ));
            }
        };
        let mut ret = Self {
            api_url: api_url.to_string(),
            user_agent_prefix: valid_user_agent_prefix.to_string(),
            api,
        };
        let ua = ret.user_agent();
        ret.api_mut().set_user_agent(ua);
        Ok(ret)
    }

    pub async fn new(user_agent_prefix: &str) -> Result<Configuration, WikibaseError> {
        let valid_user_agent_prefix = validate::validate_user_agent(user_agent_prefix)?;
        let default_api_url = "https://www.wikidata.org/w/api.php";

        let api = match mediawiki::api::Api::new(default_api_url).await {
            Ok(api) => api,
            _ => {
                return Err(WikibaseError::Configuration(
                    "Can't create mediawiki API object".to_string(),
                ));
            }
        };

        let mut ret = Self {
            api_url: default_api_url.to_string(),
            user_agent_prefix: valid_user_agent_prefix.to_string(),
            api,
        };
        let ua = ret.user_agent();
        ret.api_mut().set_user_agent(ua);
        Ok(ret)
    }

    pub fn api_mut(&mut self) -> &mut mediawiki::api::Api {
        &mut self.api
    }

    pub fn api(&self) -> &mediawiki::api::Api {
        &self.api
    }

    pub fn api_url(&self) -> &str {
        &self.api_url
    }

    pub async fn set_api_url<S: Into<String>>(&mut self, api_url: S) {
        let new_api_url = api_url.into();
        if self.api_url == new_api_url {
            return;
        }
        self.api_url = new_api_url;
        self.api = match mediawiki::api::Api::new(&self.api_url).await {
            Ok(api) => api,
            _ => return, // TODO that should be an error I guess...
        };
        let ua = self.user_agent();
        self.api.set_user_agent(ua);
    }

    /// Returns the complete user agent that is used for requests
    ///
    /// The full user agent is a combination of the user agent prefix,
    /// that is set by a library and the Wikibase RS user agent.
    /// For example: `my_bot/0.2 Wikibase-RS/1.0.2`.
    pub fn user_agent(&self) -> String {
        format!("{} {}", &self.user_agent_prefix, USER_AGENT_BASE)
    }

    pub fn user_agent_prefix(&self) -> &str {
        &self.user_agent_prefix
    }
}