goodbrother 1.0.0

List open PRs in Github by user
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

use std::error::Error;

mod api;
mod response;
pub use response::{SearchResponse, PullRequestResponse, PullRequestUser};

pub const API_URL: &str = "https://api.github.com";
const MAX_REQUESTS: i8 = 5;

pub fn get_pull_request_response(username: &str, api_url: &str) -> Result<SearchResponse, Box<dyn Error>> {
    let mut requests = 1;
    let mut has_more_results = true;
    let mut result = SearchResponse {
        total_count: 0,
        items: vec![],
    };

    while has_more_results && requests <= MAX_REQUESTS {
        let request_url = api::parse_request_url(username, api_url, requests);
        let response = api::get_response(request_url)?;
        let body = response.text()?;
        
        let mut pull_requests: SearchResponse = serde_json::from_str(&body)?;

        result.total_count = pull_requests.total_count;
        result.items.append(&mut pull_requests.items);

        if result.items.len() as i32 >= pull_requests.total_count {
            has_more_results = false;
        }

        requests += 1;
    }

    Ok(result)
}


#[cfg(test)]
mod tests {
    use super::*;
    use httpmock::prelude::*;
    use serde_json::json;

    #[test]
    fn gets_pull_request_response() {
        // Setup mock response for API to send.
        let mock_response = json!(
            {
                "total_count": 2,
                "items": [
                    {
                        "id": 123456,
                        "title": "Unit Test PR",
                        "user": {
                            "login": "RustyMock",
                        },
                        "html_url": "https://github.com/stscoundrel/goodbrother-rs/pulls/666",
                        "repository_url": "https://github.com/stscoundrel/goodbrother-rs",
                    },
                    {
                        "id": 654321,
                        "title": "Secondary Unit Test PR",
                        "user": {
                            "login": "RustyMock",
                        },
                        "html_url": "https://github.com/stscoundrel/goodbrother-rs/pulls/667",
                        "repository_url": "https://github.com/stscoundrel/goodbrother-rs",
                    }
                ]
            }
        );


        let server = MockServer::start();
        let github_mock = server.mock(|when, then| {
            when.method(GET)
                .path("/search/issues");
            then.status(200)
                .header("content-type", "text/html")
                .json_body(mock_response);
        });

        let result = get_pull_request_response("stscoundrel", &server.base_url()).unwrap();

        // Assert JSON reply was parsed.
        assert_eq!(result.total_count, 2);
        assert_eq!(result.items.len(), 2);
        assert_eq!(result.items[0].title, "Unit Test PR");
        assert_eq!(result.items[0].user.login, "RustyMock");
        assert_eq!(result.items[0].html_url, "https://github.com/stscoundrel/goodbrother-rs/pulls/666");
        assert_eq!(result.items[0].repository_url, "https://github.com/stscoundrel/goodbrother-rs");

        // Assert it came from the mock server.
        github_mock.assert()
    }

    #[test]
    fn paginates_pull_request_responses() {
        // Setup mock response for API to send.
        let individual_pr = json!(
            {
                "id": 123456,
                "title": "Unit Test PR",
                "user": {
                    "login": "RustyMock",
                },
                "html_url": "https://github.com/stscoundrel/goodbrother-rs/pulls/666",
                "repository_url": "https://github.com/stscoundrel/goodbrother-rs",
            }
        );

        let mut hundred_prs = vec![];

        for _ in 0..100 {
            hundred_prs.push(&individual_pr)
        }

        let mock_response = json!(
            {
                "total_count": 203,
                "items": hundred_prs
            }
        );


        let server = MockServer::start();
        let github_mock = server.mock(|when, then| {
            when.method(GET)
                .path("/search/issues");
            then.status(200)
                .header("content-type", "text/html")
                .json_body(mock_response);
        });

        let result = get_pull_request_response("stscoundrel", &server.base_url()).unwrap();

        // Assert JSON reply was parsed.
        assert_eq!(result.total_count, 203);

        // Due to total_count of 203, it should take three requests to get "all"
        // As responses use same fixture, final number will be 300 instead of real 203.
        assert_eq!(result.items.len(), 300);

        // Assert we called search API three times
        github_mock.assert_hits(3);
    }
}