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

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

use serde::{Deserialize, Serialize};

use crate::id;
use crate::resource::NodeId;

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

/// App installation
///
/// When a user adds a GitHub App to an account, a new app installation is created. The installation
/// id can be used by the app to request a scoped access token that allows it to interact with the
/// resources of the account.
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct Installation {
    id: InstallationId,
    node_id: NodeId,
}

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

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

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

#[cfg(test)]
mod tests {
    use crate::resource::NodeId;

    use super::{Installation, InstallationId};

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

        assert_eq!(25802826, installation.id().get());
    }

    #[test]
    fn trait_display() {
        let installation = Installation {
            id: InstallationId::new(42),
            node_id: NodeId::new("node_id"),
        };

        assert_eq!("42", installation.to_string());
    }

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

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