automatons-github 0.3.0

GitHub integration for the automatons framework
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

use std::fmt::{Display, Formatter};

use serde::{Deserialize, Serialize};
use url::Url;

use crate::id;
use crate::resource::{Login, NodeId};

id!(
    /// Organization id
    ///
    /// The [`OrganizationId`] is a unique, numerical id that is used to interact with an
    /// organization through [GitHub's REST API](https://docs.github.com/en/rest).
    OrganizationId
);

/// Organization
///
/// Organizations enable users to collaborate and share resources with each other in a structured
/// way. Organizations can have members, teams, repositories, and other resources.
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct Organization {
    login: Login,
    id: OrganizationId,
    node_id: NodeId,
    url: Url,
    repos_url: Url,
    events_url: Url,
    hooks_url: Url,
    issues_url: Url,
    members_url: Url,
    public_members_url: Url,
    avatar_url: Url,
    description: String,
}

impl Organization {
    /// Returns the organization's [`Login`].
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn login(&self) -> &Login {
        &self.login
    }

    /// Returns the organization's [`OrganizationId`].
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn id(&self) -> OrganizationId {
        self.id
    }

    /// Returns the organization's [`NodeId`].
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn node_id(&self) -> &NodeId {
        &self.node_id
    }

    /// Returns the API endpoint to query the organization.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn url(&self) -> &Url {
        &self.url
    }

    /// Returns the API endpoint to query the organization's repositories.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn repos_url(&self) -> &Url {
        &self.repos_url
    }

    /// Returns the API endpoint to query the organization's events.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn events_url(&self) -> &Url {
        &self.events_url
    }

    /// Returns the API endpoint to query the organization's hooks.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn hooks_url(&self) -> &Url {
        &self.hooks_url
    }

    /// Returns the API endpoint to query the organization's issues.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn issues_url(&self) -> &Url {
        &self.issues_url
    }

    /// Returns the API endpoint to query the organization's members.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn members_url(&self) -> &Url {
        &self.members_url
    }

    /// Returns the API endpoint to query the organization's public members.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn public_members_url(&self) -> &Url {
        &self.public_members_url
    }

    /// Returns the URL to the organization's avatar.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn avatar_url(&self) -> &Url {
        &self.avatar_url
    }

    /// Returns the organization's description.
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    pub fn description(&self) -> &str {
        &self.description
    }
}

impl Display for Organization {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.login)
    }
}

#[cfg(test)]
mod tests {
    use super::Organization;

    #[test]
    fn trait_deserialize() {
        let organization: Organization = serde_json::from_str(include_str!(
            "../../tests/fixtures/resource/organization.json"
        ))
        .unwrap();

        assert_eq!("devxbots", organization.login().get());
    }

    #[test]
    fn trait_display() {
        let organization: Organization = serde_json::from_str(include_str!(
            "../../tests/fixtures/resource/organization.json"
        ))
        .unwrap();

        assert_eq!("devxbots", organization.to_string());
    }

    #[test]
    fn trait_send() {
        fn assert_send<T: Send>() {}
        assert_send::<Organization>();
    }

    #[test]
    fn trait_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<Organization>();
    }
}