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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

use std::fmt;

use serde::Deserialize;
use serde_json::Value;

use crate::Result;

pub use query::Query;

mod query;

/// Uses [Github]'s search API.
///
/// # Example
/// ## Get merged PRs
///
/// ```no_run
/// # async fn run() {
/// use github_stats::{Query, Search};
///
/// let query = Query::new()
///     .repo("rust-lang", "rust")
///     .is("pr")
///     .is("merged");
///
/// let results = Search::issues(&query)
///     .per_page(10)
///     .page(1)
///     .search("<my user agent>")
///     .await;
///
/// match results {
///     Ok(results) => { /* do stuff */ }
///     Err(e) => eprintln!(":("),
/// }
/// # }
/// ```
///
/// [Github]: https://github.com/
pub struct Search {
    search_area: SearchArea,
    query: String,
    per_page: usize,
    page: usize,
    authorization: Option<String>,
}

enum SearchArea {
    Issues,
    Users,
}

impl fmt::Display for SearchArea {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        use SearchArea::*;
        write!(f, "{}", match self {
            Issues => "issues",
            Users => "users",
        })
    }
}

#[derive(Debug, Deserialize)]
pub struct SearchResults {
    total_count: u64,
    items: Vec<Value>,
}

impl Search {
    fn new(search_area: SearchArea, query: &Query) -> Self {
        Search {
            search_area,
            query: query.to_string(),
            per_page: 10,
            page: 1,
            authorization: None,
        }
    }

    pub fn issues(query: &Query) -> Self {
        Search::new(SearchArea::Issues, query)
    }

    pub fn users(query: &Query) -> Self {
        Search::new(SearchArea::Users, query)
    }

    /// Sets an authorization token for querying the API
    pub fn authorization(mut self, token: &str) -> Self {
        self.authorization = Some(String::from(token));
        self
    }

    /// Gets the query that will be used for the search.
    pub fn get_query(&self) -> &str {
        &self.query
    }

    /// Defaults to 10.
    pub fn per_page(mut self, per_page: usize) -> Self {
        self.per_page = per_page;
        self
    }

    /// Defaults to 1.
    pub fn page(mut self, page: usize) -> Self {
        self.page = page;
        self
    }

    /// Moves one page forward.
    pub fn next_page(&mut self) {
        if self.page < std::usize::MAX {
            self.page += 1;
        }
    }

    /// Moves one page backward.
    pub fn prev_page(&mut self) {
        if self.page > std::usize::MIN {
            self.page -= 1;
        }
    }

    /// Runs the search.
    pub async fn search(&self, user_agent: &str) -> Result<SearchResults> {
        let request = reqwest::Client::builder()
             .user_agent(user_agent)
             .build()?
             .get(&self.to_string());
        let request = match &self.authorization {
            Some(t) => request.header("Authorization", format!("Bearer {token}", token=t)),
            None => request,
        };
        let results: SearchResults = request
             .send()
             .await?
             .json()
             .await?;
        Ok(results)
    }
}

impl SearchResults {
    /// Gets total count of values matching query.
    ///
    /// This ignores `per_page`. If you only want the total count, it is
    /// recommended that you set `per_page` to `1` to shrink results size.
    pub fn total_count(&self) -> u64 {
        self.total_count
    }

    /// Items matching the query.
    pub fn items(&self) -> &Vec<Value> {
        &self.items
    }
}

impl fmt::Display for Search {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let search_area = match self.search_area {
            SearchArea::Issues => "issues",
            SearchArea::Users => "users",
        };
        write!(
            f,
            "https://api.github.com/search/{0}?per_page={1}&page={2}&q={3}",
            search_area, self.per_page, self.page, self.query,
        )
    }
}

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

    #[test]
    fn built_search() {
        const EXPECTED: &str = "https://api.github.com/search/issues?per_page=1&page=1&q=repo:rust-lang/rust+is:pr+is:merged";
        let search = Search::issues(
            &Query::new().repo("rust-lang", "rust").is("pr").is("merged"),
        )
        .per_page(1);

        assert_eq!(EXPECTED, search.to_string());
    }
}