github-scopes-rs 1.0.1

Discover GitHub token scope permission and return you an easy interface for checking token permission before querying GitHub
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

//! `github-scopes-rs` Discover GitHub token scope permission and return you an easy interface for checking token permission before querying GitHub.
//!
//! In many cases, you try to do actions to GitHub, but you get unclear permissions errors. This project allows you to get which permission your token has before,
//! called GitHub, and if you don’t have the right permissions, you can tell the user the exact permission the user needs.
//!
//! ## How it works
//! We called Github api with the given token and get which permissions scope the token has in order the access to the API. Then, the permissions are being converted to a simple object that you can work with.
//! click [here](https://docs.github.com/en/developers/apps/building-oauth-apps/scopes-for-oauth-apps) read GitHub documentation.
//!
//! ## Get token permission
//! ```rust
//! use github_scopes_rs::oauth::OAuthContext;
//!
//! # fn run()  {
//! let permissions = OAuthContext::new("token").unwrap().get_scope_permissions();
//!
//! if !permissions.repo.all {
//!     // do something
//! }
//! # }
//! ```
extern crate env_logger;
pub mod oauth;
pub mod transform;

#[cfg(test)]
mod tests {

    use super::oauth::OAuthContext;
    use mockito::mock;
    use std::env;

    #[test]
    fn can_get_oauth_scope() {
        let m = mock("GET", "/rate_limit")
            .match_header("user-agent", env!("CARGO_PKG_NAME"))
            .match_header("authorization", "token dummy-token")
            .with_status(200)
            .with_header("x-oauth-scopes", "repo")
            .expect_at_most(1)
            .create();

        let scope = OAuthContext::with_domain("dummy-token", mockito::server_url().as_ref());
        m.assert();
        assert!(scope.is_ok());

        let permissions = scope.unwrap().get_scope_permissions();
        assert!(permissions.repo.all);
    }

    #[test]
    fn cat_refresh_oauth_scope_with_new_token() {
        let mock_first_request = mock("GET", "/rate_limit")
            .match_header("user-agent", env!("CARGO_PKG_NAME"))
            .match_header("authorization", "token dummy-token")
            .with_status(200)
            .with_header("x-oauth-scopes", "")
            .expect_at_most(1)
            .create();

        let mock_refresh_request = mock("GET", "/rate_limit")
            .match_header("user-agent", env!("CARGO_PKG_NAME"))
            .match_header("authorization", "token dummy-token2")
            .with_status(200)
            .with_header("x-oauth-scopes", "repo")
            .expect_at_most(1)
            .create();

        let mut scope =
            OAuthContext::with_domain("dummy-token", mockito::server_url().as_ref()).unwrap();
        mock_first_request.assert();

        let permissions = scope.get_scope_permissions();
        assert!(!permissions.repo.all);

        let refresh = scope.refresh(Some("dummy-token2".to_string()));
        mock_refresh_request.assert();
        assert!(refresh.is_ok());

        let permissions = scope.get_scope_permissions();
        assert!(permissions.repo.all);
    }

    #[test]
    fn invalid_status_code() {
        let m = mock("GET", "/rate_limit")
            .match_header("user-agent", env!("CARGO_PKG_NAME"))
            .match_header("authorization", "token dummy-token")
            .with_status(500)
            .with_header("x-oauth-scopes", "repo")
            .expect_at_most(1)
            .create();

        let scope = OAuthContext::with_domain("dummy-token", mockito::server_url().as_ref());
        m.assert();
        assert!(scope.is_err());
    }

    #[test]
    fn scope_header_not_found() {
        let m = mock("GET", "/rate_limit")
            .match_header("user-agent", env!("CARGO_PKG_NAME"))
            .match_header("authorization", "token dummy-token")
            .with_status(200)
            .expect_at_most(1)
            .create();

        let scope = OAuthContext::with_domain("dummy-token", mockito::server_url().as_ref());
        m.assert();
        assert!(scope.is_err());
    }
}