gitter 0.4.0

A library that provides Gitter 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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
use std::borrow::Cow;
use std::collections::HashMap;
use reqwest::{Client, IntoUrl};
use reqwest::header::{Accept, Authorization, Bearer, ContentType, Headers};
use serde::{Deserialize, Serialize};
use serde_urlencoded;
use std::time::Duration;

use models::*;

#[derive(Debug)]
pub struct Gitter<'a> {
    token: Cow<'a, str>,
    api_base_url: Cow<'a, str>,
    client: Client,
}

const API_BASE_URL: &str = "https://api.gitter.im/v1";

#[derive(Debug)]
pub enum ApiError {
    EmptyResponse,
    BadResponse(String),
    BadRequest(String),
    RoomNotFound,
    UserNotFound,
    Unknown(String),
}

type ApiResult<T> = Result<T, ApiError>;

impl<'a> Gitter<'a> {
    /// New initializes the Gitter API client
    pub fn new<S>(token: S) -> ApiResult<Gitter<'a>>
    where
        S: Into<Cow<'a, str>>,
    {
        match Client::builder().timeout(Duration::from_secs(40)).build() {
            Ok(client) => Ok(Gitter {
                token: token.into(),
                api_base_url: API_BASE_URL.into(),
                client,
            }),
            Err(e) => Err(ApiError::Unknown(e.to_string())),
        }
    }

    /// Returns the current user
    pub fn get_user(&self) -> ApiResult<User> {
        let full_url = format!("{}/user", self.api_base_url);
        match self.get::<&str, Vec<User>>(&full_url) {
            Ok(users) => {
                if !users.is_empty() {
                    Ok(users[0].clone())
                } else {
                    Err(ApiError::UserNotFound)
                }
            }
            Err(e) => Err(e),
        }
    }

    /// Returns a list of Rooms the user is part of
    pub fn get_user_rooms<S>(&self, user_id: S) -> ApiResult<Vec<Room>>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/rooms", self.api_base_url, user_id.as_ref());
        self.get(&full_url)
    }

    /// Receive user's unread items and mentions in the room
    pub fn get_unread_items<U, R>(&self, user_id: U, room_id: R) -> ApiResult<UnreadItems>
    where
        U: AsRef<str>,
        R: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/rooms/{}/unreadItems", self.api_base_url, user_id.as_ref(), room_id.as_ref());
        self.get(&full_url)
    }

    /// Mark user's given room messages as read
    pub fn mark_messages_as_read<U, R>(
        &self,
        user_id: U,
        room_id: R,
        message_ids: &[String],
    ) -> ApiResult<()>
    where
        U: AsRef<str>,
        R: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/rooms/{}/unreadItems", self.api_base_url, user_id.as_ref(), room_id.as_ref());
        let unread_items = UnreadItems::from_msg_ids(message_ids);
        self.post(&full_url, &unread_items)
    }

    /// Returns a list of rooms the current user is in
    pub fn get_rooms(&self) -> ApiResult<Vec<Room>> {
        let full_url = format!("{}/rooms", self.api_base_url);
        self.get(&full_url)
    }

    /// List of the user's GitHub Organizations and their respective Room if available.
    pub fn get_user_organizations<S>(&self, user_id: S) -> ApiResult<Vec<Organization>>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/orgs", self.api_base_url, user_id.as_ref());
        self.get(&full_url)
    }

    /// List of the user's GitHub Repositories and their respective Room if available.
    pub fn get_user_repositories<S>(&self, user_id: S) -> ApiResult<Vec<Repository>>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/repos", self.api_base_url, user_id.as_ref());
        self.get(&full_url)
    }

    /// List of Gitter channels nested under the current user.
    pub fn get_user_channels<S>(&self, user_id: S) -> ApiResult<Vec<Channel>>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/channels", self.api_base_url, user_id.as_ref());
        self.get(&full_url)
    }

    /// Returns the users in the room with the passed id
    pub fn get_users_in_room<S>(&self, room_id: S) -> ApiResult<Vec<User>>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}/users", self.api_base_url, room_id.as_ref());
        self.get(&full_url)
    }

    /// Returns a room with the passed id
    pub fn get_room<S>(&self, room_id: S) -> ApiResult<Room>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}", self.api_base_url, room_id.as_ref());
        self.get(&full_url)
    }

    /// Returns a list of messages in a room.
    /// Pagination is optional. You can pass nil or specific pagination params.
    pub fn get_messages<S>(&self, room_id: S, params: Option<Pagination>) -> ApiResult<Vec<Message>>
    where
        S: AsRef<str>,
    {
        let mut full_url = format!("{}/rooms/{}/chatMessages", self.api_base_url, room_id.as_ref());

        if let Some(p) = params {
            full_url.push_str("?");
            full_url.push_str(&p.encode());
        }

        self.get(&full_url)
    }

    /// Returns a message in a room.
    pub fn get_message<R, M>(&self, room_id: R, message_id: M) -> ApiResult<Message>
    where
        R: AsRef<str>,
        M: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}/chatMessages/{}", self.api_base_url, room_id.as_ref(), message_id.as_ref());
        self.get(&full_url)
    }

    /// Sends a message to a room
    pub fn send_message<R, T>(&self, room_id: R, text: T) -> ApiResult<Message>
    where
        R: AsRef<str>,
        T: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}/chatMessages", self.api_base_url, room_id.as_ref());
        let msg = OutMessage {
            text: text.as_ref()
        };

        self.post(&full_url, &msg)
    }

    /// Update a message
    pub fn update_message<R, M, T>(&self, room_id: R, msg_id: M, text: T) -> ApiResult<()>
    where
        R: AsRef<str>,
        M: AsRef<str>,
        T: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}/chatMessages/{}", self.api_base_url, room_id.as_ref(), msg_id.as_ref());
        let msg = OutMessage {
            text: text.as_ref()
        };

        self.put(&full_url, &msg)
    }

    /// Joins a room
    pub fn join_room<R, U>(&self, room_id: R, user_id: U) -> ApiResult<Room>
    where
        R: AsRef<str>,
        U: AsRef<str>,
    {
        let full_url = format!("{}/user/{}/rooms", self.api_base_url, user_id.as_ref());
        let room = JoinRoom::from_id(room_id);

        self.post(&full_url, &room)
    }

    /// Join a room (uri method)
    pub fn join_room_by_uri<S>(&self, uri: S) -> ApiResult<Room>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/rooms", self.api_base_url);
        let room = JoinRoom::from_uri(uri);

        self.post(&full_url, &room)
    }

    /// Update a room topic
    pub fn update_room_topic<R, T>(&self, room_id: R, topic: T) -> ApiResult<Room>
    where
        R: AsRef<str>,
        T: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}", self.api_base_url, room_id.as_ref());
        let room = UpdateRoom::from_topic(topic);

        self.post(&full_url, &room)
    }

    /// Update a room noindex (indexing in search engines)
    pub fn update_room_noindex<S>(&self, room_id: S, noindex: bool) -> ApiResult<Room>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}", self.api_base_url, room_id.as_ref());
        let room = UpdateRoom::from_noindex(noindex);

        self.post(&full_url, &room)
    }

    /// Update a room topic
    pub fn update_room_tags<R, T>(&self, room_id: R, tags: T) -> ApiResult<Room>
    where
        R: AsRef<str>,
        T: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}", self.api_base_url, room_id.as_ref());
        let room = UpdateRoom::from_tags(tags);

        self.post(&full_url, &room)
    }

    /// Removes a user from the room
    pub fn leave_room<R, U>(&self, room_id: R, user_id: U) -> ApiResult<()>
    where
        R: AsRef<str>,
        U: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}/users/{}", self.api_base_url, room_id.as_ref(), user_id.as_ref());

        self.delete(&full_url)
    }

    /// Delete a room
    pub fn delete_room<S>(&self, room_id: S) -> ApiResult<()>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/rooms/{}", self.api_base_url, room_id.as_ref());

        self.delete(&full_url)
    }

    /// Queries the Rooms resources of gitter API
    pub fn search_rooms<S>(&self, room: S) -> ApiResult<SearchResult>
    where
        S: AsRef<str>,
    {
        let query = &[("q", room.as_ref())];
        let full_url = format!("{}/rooms?{}", self.api_base_url, &serde_urlencoded::to_string(query).unwrap());

        self.get(&full_url)
    }

    /// Returns the room ID of a given URI
    pub fn get_room_id<S>(&self, uri: S) -> ApiResult<String>
    where
        S: AsRef<str>,
    {
        let uri = uri.as_ref();
        self.search_rooms(uri.to_string())?
            .rooms
            .iter()
            .find(|r| r.uri.as_ref().map_or(false, |u| u == uri))
            .map(|r| r.id.to_string())
            .ok_or(ApiError::RoomNotFound)
    }

    /// Returns a list of groups the current user is in
    pub fn get_groups(&self) -> ApiResult<Vec<Group>> {
        let full_url = format!("{}/groups", self.api_base_url);

        self.get(&full_url)
    }

    /// List of rooms nested under the specified group.
    pub fn get_group_rooms<S>(&self, group_id: S) -> ApiResult<Vec<Room>>
    where
        S: AsRef<str>,
    {
        let full_url = format!("{}/groups/{}/rooms", self.api_base_url, group_id.as_ref());

        self.get(&full_url)
    }

    /// create default headers
    fn default_headers(&self) -> Headers {
        let mut headers = Headers::new();

        headers.set(ContentType::json());
        headers.set(Accept::json());
        headers.set(Authorization(Bearer {
            token: self.token.to_string(),
        }));

        headers
    }

    /// Returns raw data in bytes from specified url
    fn get<S, T>(&self, url: S) -> ApiResult<T>
    where
        S: IntoUrl,
        for<'de> T: Deserialize<'de>,
    {
        match self.client.get(url).headers(self.default_headers()).send() {
            Ok(mut response) => response
                .json::<T>()
                .map_err(|e| ApiError::BadResponse(e.to_string())),
            Err(e) => Err(ApiError::BadRequest(e.to_string())),
        }
    }

    /// Posts raw body data to specified url and returns response raw data
    fn post<S, B, T>(&self, url: S, body: B) -> ApiResult<T>
    where
        S: IntoUrl,
        B: Serialize,
        for<'de> T: Deserialize<'de>,
    {
        match self.client
            .post(url)
            .headers(self.default_headers())
            .json(&body)
            .send()
        {
            Ok(mut response) => response
                .json::<T>()
                .map_err(|e| ApiError::BadResponse(e.to_string())),
            Err(e) => Err(ApiError::BadRequest(e.to_string())),
        }
    }

    /// Puts raw body data to specified url and returns response raw data
    fn put<S, B, T>(&self, url: S, body: B) -> ApiResult<T>
    where
        S: IntoUrl,
        B: Serialize,
        for<'de> T: Deserialize<'de>,
    {
        match self.client
            .put(url)
            .headers(self.default_headers())
            .json(&body)
            .send()
        {
            Ok(mut response) => response
                .json::<T>()
                .map_err(|e| ApiError::BadResponse(e.to_string())),
            Err(e) => Err(ApiError::BadRequest(e.to_string())),
        }
    }

    /// Deletes resource by specified url
    fn delete<S, T>(&self, url: S) -> ApiResult<T>
    where
        S: IntoUrl,
        for<'de> T: Deserialize<'de>,
    {
        match self.client
            .delete(url)
            .headers(self.default_headers())
            .send()
        {
            Ok(mut response) => response
                .json::<T>()
                .map_err(|e| ApiError::BadResponse(e.to_string())),
            Err(e) => Err(ApiError::BadRequest(e.to_string())),
        }
    }
}

/// Pagination params
pub struct Pagination<'a> {
    /// Skip n messages
    pub skip: i32,

    /// Get messages before beforeId
    pub before_id: Option<Cow<'a, str>>,

    /// Get messages after afterId
    pub after_id: Option<Cow<'a, str>>,

    /// Maximum number of messages to return
    pub limit: i32,

    /// Search query
    #[allow(dead_code)]
    pub query: Option<Cow<'a, str>>,
}

impl<'a> Pagination<'a> {
    pub fn encode(self) -> String {
        let mut values = HashMap::new();

        if let Some(after_id) = self.after_id {
            values.insert("afterId", after_id.to_string());
        }

        if let Some(before_id) = self.before_id {
            values.insert("beforeId", before_id.to_string());
        }

        if self.skip > 0 {
            values.insert("skip", self.skip.to_string());
        }

        if self.limit > 0 {
            values.insert("limit", self.limit.to_string());
        }

        serde_urlencoded::to_string(&values).unwrap()
    }
}