wikibase_rest_api 0.1.16

A Rust client for the Wikibase REST 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
150
151
152
153
154
155
156
157
158
159

/// NOTE: THIS IS INCOMPLETE AND UNTESTED!
use crate::{
    entity::{Entity, EntityType},
    patch_entry::PatchEntry,
    EditMetadata, EntityId, HttpMisc, Item, Property, RestApi, RestApiError,
};
use serde::Serialize;
use serde_json::json;

#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct EntityPatch {
    patch: Vec<PatchEntry>,
    mode: EntityType,
}

impl EntityPatch {
    pub const fn item() -> Self {
        Self {
            patch: vec![],
            mode: EntityType::Item,
        }
    }

    pub const fn property() -> Self {
        Self {
            patch: vec![],
            mode: EntityType::Property,
        }
    }

    /// Returns the patch entries
    pub const fn patch(&self) -> &Vec<PatchEntry> {
        &self.patch
    }

    /// Returns the mutable patch entries
    pub const fn patch_mut(&mut self) -> &mut Vec<PatchEntry> {
        &mut self.patch
    }

    /// checks if the patch list is empty
    pub const fn is_empty(&self) -> bool {
        self.patch().is_empty()
    }

    /// Applies the entire patch against the API
    pub async fn apply_item(&self, id: &EntityId, api: &mut RestApi) -> Result<Item, RestApiError> {
        self.apply_match_item(id, api, EditMetadata::default())
            .await
    }

    pub async fn apply_property(
        &self,
        id: &EntityId,
        api: &mut RestApi,
    ) -> Result<Property, RestApiError> {
        self.apply_match_property(id, api, EditMetadata::default())
            .await
    }

    /// Applies the entire patch against the API
    pub async fn apply_match_item(
        &self,
        id: &EntityId,
        api: &mut RestApi,
        em: EditMetadata,
    ) -> Result<Item, RestApiError> {
        let j0 = json!({"patch": self.patch()});
        let request = self
            .generate_json_request(id, reqwest::Method::PATCH, j0, api, &em)
            .await?;
        let response = api.execute(request).await?;
        let (j1, header_info) = self.filter_response_error(response).await?;
        Item::from_json_header_info(j1, header_info)
    }

    /// Applies the entire patch against the API, conditional on metadata
    pub async fn apply_match_property(
        // TODO
        &self,
        id: &EntityId,
        api: &mut RestApi,
        em: EditMetadata,
    ) -> Result<Property, RestApiError> {
        let j0 = json!({"patch": self.patch()});
        let request = self
            .generate_json_request(id, reqwest::Method::PATCH, j0, api, &em)
            .await?;
        let response = api.execute(request).await?;
        let (j1, header_info) = self.filter_response_error(response).await?;
        Property::from_json_header_info(j1, header_info)
    }
}

impl HttpMisc for EntityPatch {
    fn get_my_rest_api_path(&self, id: &EntityId) -> Result<String, RestApiError> {
        Ok(format!(
            "/entities/{group}/{id}/{mode}",
            group = id.group()?,
            mode = self.mode.as_str()
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn test_mode() {
        assert_eq!(EntityType::Item.as_str(), "item");
        assert_eq!(EntityType::Property.as_str(), "property");
    }

    #[test]
    fn test_get_rest_api_path() {
        let patch = EntityPatch::item();
        let id = EntityId::new("Q123").unwrap();
        assert_eq!(
            patch.get_my_rest_api_path(&id).unwrap(),
            "/entities/items/Q123/item"
        );
    }

    #[test]
    fn test_item() {
        let patch = EntityPatch::item();
        assert!(patch.is_empty());
        assert_eq!(patch.mode, EntityType::Item);
    }

    #[test]
    fn test_property() {
        let patch = EntityPatch::property();
        assert!(patch.is_empty());
        assert_eq!(patch.mode, EntityType::Property);
    }

    #[test]
    fn test_patch() {
        let mut patch = EntityPatch::item();
        assert!(patch.is_empty());
        patch
            .patch_mut()
            .push(PatchEntry::new("add", "/enwiki/title", json!("foo")));
        assert_eq!(patch.patch().len(), 1);
    }

    #[test]
    fn test_is_empty() {
        let mut patch = EntityPatch::item();
        assert!(patch.is_empty());
        patch
            .patch_mut()
            .push(PatchEntry::new("add", "/enwiki/title", json!("foo")));
        assert!(!patch.is_empty());
    }
}