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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
use super::*;
use std::iter::Extend;
use log::trace;
use reqwest::{header, StatusCode, Url};
use serde::de::DeserializeOwned;
use crate::types::*;
pub struct SyncClient {
client: reqwest::Client,
base_url: Url,
}
impl SyncClient {
pub fn new() -> Self {
Self {
client: reqwest::Client::new(),
base_url: Url::parse("https://crates.io/api/v1/").unwrap(),
}
}
pub fn with_user_agent(user_agent: &str) -> Self {
let mut headers = header::HeaderMap::new();
headers.insert(
header::USER_AGENT,
header::HeaderValue::from_str(user_agent).unwrap(),
);
Self {
client: reqwest::Client::builder()
.default_headers(headers)
.build()
.unwrap(),
base_url: Url::parse("https://crates.io/api/v1/").unwrap(),
}
}
fn get<T: DeserializeOwned>(&self, url: Url) -> Result<T, Error> {
trace!("GET {}", url);
let mut res = {
let res = self.client.get(url).send()?;
if res.status() == StatusCode::NOT_FOUND {
return Err(Error::NotFound);
}
res.error_for_status()?
};
let data: T = res.json()?;
Ok(data)
}
pub fn summary(&self) -> Result<Summary, Error> {
let url = self.base_url.join("summary").unwrap();
self.get(url)
}
pub fn get_crate(&self, name: &str) -> Result<CrateResponse, Error> {
let url = self.base_url.join("crates/")?.join(name)?;
self.get(url)
}
pub fn crate_downloads(&self, name: &str) -> Result<Downloads, Error> {
let url = self.base_url.join(&format!("crates/{}/downloads", name))?;
self.get(url)
}
pub fn crate_owners(&self, name: &str) -> Result<Vec<User>, Error> {
let url = self.base_url.join(&format!("crates/{}/owners", name))?;
let resp: Owners = self.get(url)?;
Ok(resp.users)
}
pub fn crate_reverse_dependencies(&self, name: &str) -> Result<ReverseDependencies, Error> {
let mut page = 1;
let mut rdeps: ReverseDependenciesAsReceived;
let mut tidy_rdeps = ReverseDependencies {dependencies: Vec::new(), meta: Meta {total:0}};
loop {
let url = self.base_url.join(&format!(
"crates/{}/reverse_dependencies?per_page=100&page={}",
name, page
))?;
rdeps = self.get(url)?;
tidy_rdeps.from_received(&rdeps);
if !rdeps.dependencies.is_empty() {
tidy_rdeps.meta = rdeps.meta;
page += 1;
} else {
break;
}
}
Ok(tidy_rdeps)
}
pub fn crate_authors(&self, name: &str, version: &str) -> Result<Authors, Error> {
let url = self
.base_url
.join(&format!("crates/{}/{}/authors", name, version))?;
let res: AuthorsResponse = self.get(url)?;
Ok(Authors {
names: res.meta.names,
users: res.users,
})
}
pub fn crate_dependencies(&self, name: &str, version: &str) -> Result<Vec<Dependency>, Error> {
let url = self
.base_url
.join(&format!("crates/{}/{}/dependencies", name, version))?;
let resp: Dependencies = self.get(url)?;
Ok(resp.dependencies)
}
fn full_version(&self, version: Version) -> Result<FullVersion, Error> {
let authors = self.crate_authors(&version.crate_name, &version.num)?;
let deps = self.crate_dependencies(&version.crate_name, &version.num)?;
let v = FullVersion {
created_at: version.created_at,
updated_at: version.updated_at,
dl_path: version.dl_path,
downloads: version.downloads,
features: version.features,
id: version.id,
num: version.num,
yanked: version.yanked,
license: version.license,
links: version.links,
readme_path: version.readme_path,
author_names: authors.names,
authors: authors.users,
dependencies: deps,
};
Ok(v)
}
pub fn full_crate(&self, name: &str, all_versions: bool) -> Result<FullCrate, Error> {
let resp = self.get_crate(name)?;
let data = resp.crate_data;
let dls = self.crate_downloads(name)?;
let owners = self.crate_owners(name)?;
let reverse_dependencies = self.crate_reverse_dependencies(name)?;
let versions = if resp.versions.is_empty() {
vec![]
} else if all_versions {
resp.versions
.into_iter()
.map(|v| self.full_version(v))
.collect::<Result<Vec<FullVersion>, Error>>()?
} else {
let v = self.full_version(resp.versions[0].clone())?;
vec![v]
};
let full = FullCrate {
id: data.id,
name: data.name,
description: data.description,
license: versions[0].license.clone(),
documentation: data.documentation,
homepage: data.homepage,
repository: data.repository,
total_downloads: data.downloads,
max_version: data.max_version,
created_at: data.created_at,
updated_at: data.updated_at,
categories: resp.categories,
keywords: resp.keywords,
downloads: dls,
owners,
reverse_dependencies,
versions,
};
Ok(full)
}
pub fn crates(&self, spec: ListOptions) -> Result<CratesResponse, Error> {
let mut url = self.base_url.join("crates")?;
{
let mut q = url.query_pairs_mut();
q.append_pair("page", &spec.page.to_string());
q.append_pair("per_page", &spec.per_page.to_string());
q.append_pair("sort", spec.sort.to_str());
if let Some(query) = spec.query {
q.append_pair("q", &query);
}
}
self.get(url)
}
pub fn all_crates(&self, query: Option<String>) -> Result<Vec<Crate>, Error> {
let mut page = 1;
let mut crates = Vec::new();
loop {
let res = self.crates(ListOptions {
query: query.clone(),
sort: Sort::Alphabetical,
per_page: 100,
page,
})?;
if !res.crates.is_empty() {
crates.extend(res.crates);
page += 1;
} else {
break;
}
}
Ok(crates)
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_client() {
let client = SyncClient::new();
let summary = client.summary().unwrap();
assert!(summary.most_downloaded.len() > 0);
for item in &summary.most_downloaded[0..3] {
let _ = client.full_crate(&item.name, false).unwrap();
}
}
}