rustyhub 0.3.0

A client for the Github v3 API
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

// Copyright 2016 Alex Frappier Lachapelle
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! # Feeds
//!
//! These are the responses and API call functions related
//! to the feeds endpoints of the API.
//!
//! Reference: https://developer.github.com/v3/activity/feeds/

use client::Client;
use error;
use utils;

///Response to feeds requests
#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct Feeds {
    pub timeline_url:                   String,
    pub user_url:                       String,
    pub current_user_public_ur:         Option<String>,
    pub current_user_url:               Option<String>,
    pub current_user_actor_url:         Option<String>,
    pub current_user_organization_url:  Option<String>,
    pub current_user_organization_urls: Option<Vec<String>>,
    #[serde(rename = "_links")]
    pub links: Links
}

#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct Links {
    pub timeline:                   FeedsElem,
    pub user:                       FeedsElem,
    pub current_user_public:        Option<FeedsElem>,
    pub current_user:               Option<FeedsElem>,
    pub current_user_actor:         Option<FeedsElem>,
    pub current_user_organization:  Option<FeedsElem>,
    pub current_user_organizations: Option<FeedsElem>,
}

#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct FeedsElem {
    pub href: String,
    #[serde(rename = "type")]
    pub mime_type: String
}


////////////////////////////////////////////////////////////
//                    Extension Trait                     //
////////////////////////////////////////////////////////////

pub trait FeedsExt {

    /// \[[Reference](https://developer.github.com/v3/activity/feeds/#list-feeds)\]
    /// Returns the list of feeds.
    /// ## Endpoint:
    /// GET /feeds
    fn get_feeds(&mut self) -> Result<Feeds, error::Error>;
}

impl FeedsExt for Client {
    fn get_feeds(&mut self) -> Result<Feeds, error::Error> {
        utils::request_endpoint(self, "/feeds".into())
    }
}

//TODO:TESTS