crate-checker 0.1.0

Rust crate information retrieval tool with CLI and API server
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
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
//! Data types and structures for the crate checker application

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Main crate information structure
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CrateInfo {
    /// Crate name
    pub name: String,

    /// Crate description
    pub description: Option<String>,

    /// Latest version number
    pub newest_version: String,

    /// Total download count
    pub downloads: u64,

    /// Creation timestamp
    pub created_at: DateTime<Utc>,

    /// Last update timestamp
    pub updated_at: DateTime<Utc>,

    /// Homepage URL
    pub homepage: Option<String>,

    /// Repository URL
    pub repository: Option<String>,

    /// Documentation URL
    pub documentation: Option<String>,

    /// Associated keywords
    pub keywords: Vec<String>,

    /// Associated categories
    pub categories: Vec<String>,

    /// Maximum upload size in bytes
    pub max_upload_size: Option<u64>,

    /// License information
    pub license: Option<String>,

    /// Whether the crate is yanked
    pub yanked: Option<bool>,

    /// Links to various resources
    pub links: Option<CrateLinks>,
}

/// Links associated with a crate
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CrateLinks {
    pub owner_team: Option<String>,
    pub owner_user: Option<String>,
    pub reverse_dependencies: Option<String>,
    pub version_downloads: Option<String>,
    pub versions: Option<String>,
}

/// Version information
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Version {
    /// Version number
    pub num: String,

    /// Creation timestamp
    pub created_at: DateTime<Utc>,

    /// Last update timestamp
    pub updated_at: DateTime<Utc>,

    /// Download count for this version
    pub downloads: u64,

    /// Whether this version is yanked
    pub yanked: bool,

    /// Version ID
    pub id: Option<u64>,

    /// Crate size in bytes
    pub crate_size: Option<u64>,

    /// Published by user
    pub published_by: Option<User>,

    /// Audit actions
    pub audit_actions: Option<Vec<AuditAction>>,

    /// License information
    pub license: Option<String>,

    /// Links for this version
    pub links: Option<VersionLinks>,
}

/// User information
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct User {
    pub id: u64,
    pub login: String,
    pub name: Option<String>,
    pub avatar: Option<String>,
    pub url: Option<String>,
}

/// Audit action information
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct AuditAction {
    pub action: String,
    pub user: User,
    pub time: DateTime<Utc>,
}

/// Links for a specific version
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct VersionLinks {
    pub dependencies: Option<String>,
    pub version_downloads: Option<String>,
    pub authors: Option<String>,
}

/// Crate status enumeration
#[derive(Debug, Clone, PartialEq)]
pub enum CrateStatus {
    /// Crate exists and is available
    Exists,
    /// Crate was not found
    NotFound,
    /// All versions are yanked
    Yanked,
    /// Some versions are yanked
    PartiallyYanked,
}

/// Search result for crates
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CrateSearchResult {
    pub name: String,
    pub description: Option<String>,
    pub newest_version: String,
    pub downloads: u64,
    pub exact_match: bool,
}

/// Dependency information
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Dependency {
    #[serde(rename = "crate_id")]
    pub name: String,
    pub req: String,
    #[serde(default)]
    pub features: Vec<String>,
    pub optional: bool,
    pub default_features: bool,
    pub target: Option<String>,
    pub kind: String,
    #[serde(default)]
    pub downloads: Option<u64>,
}

impl Dependency {
    /// Get the dependency name (alias for crate_id)
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Get the version requirement
    pub fn version_req(&self) -> &str {
        &self.req
    }
}

/// Download statistics
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct DownloadStats {
    /// Total all-time downloads
    pub total: u64,
    /// Per-version download statistics  
    pub versions: Vec<VersionDownload>,
}

/// Download stats for a specific version
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct VersionDownload {
    pub version: String,
    pub downloads: u64,
    pub date: DateTime<Utc>,
}

/// Crate owner information
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Owner {
    pub id: u64,
    pub login: String,
    pub name: Option<String>,
    pub email: Option<String>,
    pub avatar: Option<String>,
    pub url: Option<String>,
    pub kind: String, // "user" or "team"
}

// Batch processing types

/// Batch input format - supports multiple input types
#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(untagged)]
pub enum BatchInput {
    /// Map of crate names to specific versions
    CrateVersionMap(HashMap<String, String>),

    /// List of crate names (will check latest versions)
    CrateList { crates: Vec<String> },

    /// Advanced operations format
    Operations { operations: Vec<BatchOperation> },
}

/// A single batch operation
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct BatchOperation {
    /// The target(s) for this operation
    #[serde(flatten)]
    pub target: BatchTarget,

    /// The operation to perform
    pub operation: String,
}

/// Target for batch operations
#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(untagged)]
pub enum BatchTarget {
    /// Single crate with optional version
    Single {
        #[serde(rename = "crate")]
        crate_name: String,
        version: Option<String>,
    },

    /// Multiple crates
    Multiple { crates: Vec<String> },
}

/// Result for checking a single crate
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct CrateCheckResult {
    pub crate_name: String,
    pub exists: bool,
    pub latest_version: Option<String>,
    pub requested_version: Option<String>,
    pub version_exists: Option<bool>,
    pub error: Option<String>,
    pub info: Option<CrateInfo>,
}

/// Overall batch processing result
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct BatchResult {
    pub results: Vec<CrateCheckResult>,
    pub total_processed: usize,
    pub successful: usize,
    pub failed: usize,
    pub processing_time_ms: u64,
}

// Server API types

/// Request format for batch API endpoint
#[derive(Debug, Serialize, Deserialize)]
pub struct BatchRequest {
    /// The batch input data
    #[serde(flatten)]
    pub input: BatchInput,

    /// Processing options
    #[serde(default)]
    pub options: BatchOptions,
}

/// Options for batch processing
#[derive(Debug, Serialize, Deserialize, Default)]
pub struct BatchOptions {
    /// Include detailed crate information
    #[serde(default)]
    pub include_details: bool,

    /// Process requests in parallel
    #[serde(default)]
    pub parallel: bool,

    /// Timeout for the entire batch operation
    #[serde(default = "default_timeout")]
    pub timeout_seconds: u64,

    /// Maximum number of concurrent requests
    #[serde(default = "default_concurrency")]
    pub max_concurrent: usize,
}

fn default_timeout() -> u64 {
    30
}

fn default_concurrency() -> usize {
    10
}

/// Response format for batch API endpoint
#[derive(Debug, Serialize, Deserialize)]
pub struct BatchResponse {
    pub request_id: String,
    pub status: String,

    /// The batch processing result
    #[serde(flatten)]
    pub result: BatchResult,
}

/// Health check response
#[derive(Debug, Serialize, Deserialize)]
pub struct HealthResponse {
    pub status: String,
    pub timestamp: DateTime<Utc>,
    pub version: String,
    pub uptime_seconds: u64,
}

/// Search request parameters
#[derive(Debug, Serialize, Deserialize)]
pub struct SearchParams {
    pub q: String,
    pub limit: Option<usize>,
    pub offset: Option<usize>,
    pub sort: Option<String>,
}

/// Metrics response
#[derive(Debug, Serialize, Deserialize)]
pub struct MetricsResponse {
    pub requests_total: u64,
    pub requests_successful: u64,
    pub requests_failed: u64,
    pub average_response_time_ms: f64,
    pub cache_hits: u64,
    pub cache_misses: u64,
    pub uptime_seconds: u64,
}

// Crates.io API response types (internal)

/// Response from crates.io for crate information
#[derive(Debug, Deserialize)]
pub struct CrateResponse {
    #[serde(rename = "crate")]
    pub crate_info: CrateApiInfo,
    pub versions: Option<Vec<Version>>,
    pub keywords: Option<Vec<Keyword>>,
    pub categories: Option<Vec<Category>>,
}

/// Crate information from crates.io API
#[derive(Debug, Deserialize)]
pub struct CrateApiInfo {
    pub name: String,
    pub description: Option<String>,
    pub newest_version: String,
    pub downloads: u64,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub homepage: Option<String>,
    pub repository: Option<String>,
    pub documentation: Option<String>,
    pub max_upload_size: Option<u64>,
    #[serde(rename = "recent_downloads")]
    pub recent_downloads: Option<u64>,
}

/// Keyword information
#[derive(Debug, Deserialize)]
pub struct Keyword {
    pub keyword: String,
}

/// Category information
#[derive(Debug, Deserialize)]
pub struct Category {
    pub category: String,
}

/// Response from crates.io versions endpoint
#[derive(Debug, Deserialize)]
pub struct VersionsResponse {
    pub versions: Vec<Version>,
}

/// Response from crates.io search endpoint
#[derive(Debug, Deserialize)]
pub struct SearchResponse {
    pub crates: Vec<CrateSearchResult>,
    pub meta: SearchMeta,
}

/// Search metadata
#[derive(Debug, Deserialize)]
pub struct SearchMeta {
    pub total: u32,
}

/// Response from dependencies endpoint
#[derive(Debug, Deserialize)]
pub struct DependenciesResponse {
    pub dependencies: Vec<Dependency>,
}

/// Response from downloads endpoint
#[derive(Debug, Deserialize)]
pub struct DownloadsResponse {
    pub version_downloads: Vec<VersionDownloadApi>,
    pub meta: DownloadsMeta,
}

/// Downloads metadata
#[derive(Debug, Deserialize)]
pub struct DownloadsMeta {
    pub extra_downloads: Vec<ExtraDownload>,
}

/// Version download info from API
#[derive(Debug, Deserialize)]
pub struct VersionDownloadApi {
    pub version: String,
    pub downloads: u64,
    pub date: String, // API returns date as string, not DateTime
}

/// Extra download information
#[derive(Debug, Deserialize)]
pub struct ExtraDownload {
    pub date: String, // API returns date as string
    pub downloads: u64,
}

impl From<CrateApiInfo> for CrateInfo {
    fn from(api_info: CrateApiInfo) -> Self {
        Self {
            name: api_info.name,
            description: api_info.description,
            newest_version: api_info.newest_version,
            downloads: api_info.downloads,
            created_at: api_info.created_at,
            updated_at: api_info.updated_at,
            homepage: api_info.homepage,
            repository: api_info.repository,
            documentation: api_info.documentation,
            keywords: Vec::new(),   // Will be populated separately
            categories: Vec::new(), // Will be populated separately
            max_upload_size: api_info.max_upload_size,
            license: None,
            yanked: None,
            links: None,
        }
    }
}