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
use std::borrow::Cow;
use reqwest::header::HeaderMap;
use thiserror::Error;
use url::Url;
use crate::APODMetadata;
use crate::Date;
#[derive(Error, Debug)]
pub enum APODClientError {
#[error("Service URL cannot be created")]
InvalidURL { source: url::ParseError },
#[error("Rate limit exceeded for this API key")]
RateLimitError,
#[error("IO error encountered while performing request")]
IOError {
source: Box<dyn std::error::Error + Send + Sync>,
},
#[error("Request failed with invalid HTTP status code: {}", status)]
RequestStatusError {
status: u16,
source: Box<dyn std::error::Error + Send + Sync>,
},
#[error("Error while decoding response content")]
DecodeError {
source: Box<dyn std::error::Error + Send + Sync>,
},
}
pub type Result<T> = std::result::Result<T, APODClientError>;
pub struct APODClient {
base_url: Cow<'static, str>,
api_key: Cow<'static, str>,
}
#[derive(Debug, PartialEq, Eq)]
pub struct RateLimitInfo {
pub remaining: i32,
pub limit: i32,
}
impl APODClient {
pub fn new<S>(api_key: S) -> Self
where
S: Into<Cow<'static, str>>,
{
Self::config("https://api.nasa.gov/planetary/apod", api_key)
}
pub fn config<SA, SB>(base_url: SA, api_key: SB) -> Self
where
SA: Into<Cow<'static, str>>,
SB: Into<Cow<'static, str>>,
{
APODClient {
base_url: base_url.into(),
api_key: api_key.into(),
}
}
pub async fn get_picture(&self, date: &Date, hd: bool) -> Result<(APODMetadata, RateLimitInfo)> {
let url = self.build_url(date, hd)?;
let response = reqwest::get(url)
.await
.map_err(|e| APODClientError::IOError {
source: Box::new(e),
})?;
let rate_limit_info = get_rate_limit_info(response.headers());
if rate_limit_info.remaining == 0 {
return Err(APODClientError::RateLimitError);
}
let response = response.error_for_status().map_err(|e| {
let status = e
.status()
.map(|s| s.as_u16())
.expect("status code should be defined");
APODClientError::RequestStatusError {
status,
source: Box::new(e),
}
})?;
let pic = response
.json()
.await
.map_err(|e| APODClientError::DecodeError {
source: Box::new(e),
})?;
Ok((pic, rate_limit_info))
}
fn build_url(&self, date: &Date, hd: bool) -> Result<Url> {
let hd_param = hd.to_string();
let mut params = vec![
("api_key", self.api_key.as_ref()),
("hd", &hd_param)
];
let maybe_date_param = date.as_param();
if let Some(date_param) = maybe_date_param.as_ref() {
params.push(("date", date_param))
}
Url::parse_with_params(&self.base_url, ¶ms)
.map_err(|source| APODClientError::InvalidURL { source })
}
}
fn get_rate_limit_info(headers: &HeaderMap) -> RateLimitInfo {
let remaining: i32 = headers
.get("x-ratelimit-remaining")
.and_then(|h| h.to_str().ok())
.and_then(|s| s.parse().ok())
.unwrap_or(-1);
let limit: i32 = headers
.get("x-ratelimit-limit")
.and_then(|h| h.to_str().ok())
.and_then(|s| s.parse().ok())
.unwrap_or(-1);
RateLimitInfo { remaining, limit }
}
#[cfg(test)]
mod tests {
use crate::client::APODClient;
use crate::Date;
#[test]
fn test_build_url() {
let client = APODClient::new("my_key");
let url = client.build_url(&Date::Today, false).unwrap();
assert_eq!(
"https://api.nasa.gov/planetary/apod?api_key=my_key&hd=false",
url.as_str()
)
}
#[test]
fn test_build_url_with_date() {
let d = Date::Date {
day: 1,
month: 6,
year: 1986,
};
let client = APODClient::new("my_key");
let url = client.build_url(&d, true).unwrap();
assert_eq!(
"https://api.nasa.gov/planetary/apod?api_key=my_key&hd=true&date=1986-06-01",
url.as_str()
)
}
}