aboutsummaryrefslogtreecommitdiffstats
path: root/src/item.rs
blob: 7c5935dac1b108e56fe85f4da7f1a0126a382d77 (plain) (blame)
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
160
161
162
163
164
165
166
167
168
169
170
171
// zotapi - Rust wrapper for Sot API as implemented by Hubzilla
// Copyright (C) 2018  Harald Eilertsen <haraldei@anduin.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use crate::{client::Client, error::Error};
use reqwest::{
    self,
    header::{CONTENT_TYPE},
};
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

/// Data type for values that an Item can hold.
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum ItemData<'a> {
    /// A single value, either textual or numeric.
    Value(&'a str),

    /// A list ov values.
    List(Vec<&'a str>),
}

impl<'a> From<&'a str> for ItemData<'a> {
    fn from(orig: &'a str) -> ItemData<'a> {
        ItemData::Value(orig)
    }
}

impl<'a> ToString for ItemData<'a> {
    fn to_string(&self) -> String {
        match &self {
            ItemData::Value(s) => s.to_string(),
            ItemData::List(v) => v.join(","),
        }
    }
}

impl<'a> ItemData<'a> {
    /// Push a new value into
    pub fn push(&mut self, value: &'a str) {
        match self {
            ItemData::Value(_) => std::panic!("Pushing to a simple value is not allowed."),
            ItemData::List(v) => v.push(value),
        };
    }
}

#[test]
fn convert_itemdata_list_to_a_string() {
    let l = ItemData::List(vec!["one", "two", "everything"]);
    assert_eq!(l.to_string(), "one,two,everything");
}

#[test]
fn convert_itemdata_list_with_one_member_to_a_string() {
    let l = ItemData::List(vec!["one"]);
    assert_eq!(l.to_string(), "one");
}

#[derive(Debug, Deserialize)]
pub struct ItemCreatedResponse {
    pub success: bool,
    pub item_id: u32,
}

/// A structure to help you create an item in a declarative way.
///
/// Typical usage:
///
/// ```no_run
/// let client = zotapi::client("https://myhub.com", "mychannel", "mypw");
/// let new_post = zotapi::item()
///     .title("A title")
///     .body("The body of the post")
///     .file("/my/photo.jpg")
///     .create(&client)?;
/// # Ok::<(), zotapi::Error>(())
/// ```
#[derive(Debug)]
pub struct ItemBuilder<'a> {
    data: BTreeMap<&'a str, ItemData<'a>>,
    files: Vec<&'a str>,
}

pub fn item<'a>() -> ItemBuilder<'a> {
    ItemBuilder {
        data: BTreeMap::new(),
        files: vec![],
    }
}

impl<'a> ItemBuilder<'a> {
    /// Add a title to the post
    pub fn title(&mut self, text: &'a str) -> &mut ItemBuilder<'a> {
        self.data.insert("title", ItemData::Value(text));
        self
    }

    /// Add the body of the post
    pub fn body(&mut self, text: &'a str) -> &mut ItemBuilder<'a> {
        self.data.insert("body", ItemData::Value(text));
        self
    }

    /// Add a file attachment to the post
    pub fn file(&mut self, fname: &'a str) -> &mut ItemBuilder<'a> {
        self.files.push(fname);
        self
    }

    /// Set groups allowed to access item
    pub fn group_allow(&mut self, group: &'a str) -> &mut ItemBuilder<'a> {
        let groups_allow = self
            .data
            .entry("groups_allow")
            .or_insert(ItemData::List(Vec::<&str>::new()));

        groups_allow.push(group);
        self
    }

    /// Create the item by poting it to the server
    pub fn create(&self, client: &Client) -> Result<ItemCreatedResponse, Error> {
        dbg!(self);
        let mut req = client.post("item/update");

        if self.files.is_empty() {
            req = req
                .header(CONTENT_TYPE, "application/x-www-form-urlencoded")
                .body(serde_qs::to_string(&self.data)?)
        } else {
            let mut form = reqwest::multipart::Form::new();

            for (key, value) in self.data.iter() {
                form = form.text(key.to_string(), value.to_string());
            }

            for f in self.files.iter() {
                form = form.file("media", f)?;
            }

            req = req.multipart(form)
        }

        Ok(serde_json::from_str(&req.send()?.text()?)?)
    }
}

#[test]
fn add_group_to_list_of_groups_allowed() {
    let mut item = item();
    item.group_allow("test");
    match item.data.get("groups_allow") {
        Some(ItemData::List(v)) => assert_eq!(v.len(), 1),
        Some(ItemData::Value(s)) => assert!(false, "Expected a list, found value: {}", s),
        None => assert!(false, "List not found!"),
    };
}