github-rs 0.7.0

Pure Rust bindings to the Github 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

//! Helper functions for end users for GitHub response Headers
use hyper::header::{HeaderValue, ETAG, LAST_MODIFIED, USER_AGENT};
use hyper::HeaderMap;
use std::str::FromStr;

/// Checks to see if a received payload from GitHub contains
/// the GitHub-Hookshot header in the `UserAgent`.
pub fn has_github_hookshot(head: &HeaderMap) -> bool {
    head.get(USER_AGENT).map_or(false, |user_agent| {
        user_agent
            .to_str()
            .ok()
            .map_or(false, |s| s.starts_with("GitHub-Hookshot"))
    })
}

/// Extract an `ETag` from the Headers if it exists
pub fn etag(head: &HeaderMap) -> Option<&HeaderValue> {
    head.get(ETAG)
}

/// Extract the Last-Modified from the Headers if it exists
pub fn last_modified(head: &HeaderMap) -> Option<&HeaderValue> {
    head.get(LAST_MODIFIED)
}

/// Extract however many requests the authenticated user can
/// do from the Headers
pub fn rate_limit_remaining(head: &HeaderMap) -> Option<u32> {
    head.get("X-RateLimit-Remaining")
        .map(|limit| u32::from_str(limit.to_str().unwrap_or("")).ok())
        .unwrap_or(None)
}

/// Extract however many requests the authenticated user can
/// make from the Headers
pub fn rate_limit(head: &HeaderMap) -> Option<u32> {
    head.get("X-RateLimit-Limit")
        .map(|limit| u32::from_str(limit.to_str().unwrap_or("")).ok())
        .unwrap_or(None)
}

/// Extract when the requests limit for the authenticated user
/// is reset from the Headers
pub fn rate_limit_reset(head: &HeaderMap) -> Option<u32> {
    head.get("X-RateLimit-Reset")
        .map(|limit| u32::from_str(limit.to_str().unwrap_or("")).ok())
        .unwrap_or(None)
}