aboutsummaryrefslogtreecommitdiffstats
path: root/rust/fatcat-api/src/lib.rs
blob: a01189ef11d047cabed330137710d3f357ee25c7 (plain)
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
#![allow(missing_docs, trivial_casts, unused_variables, unused_mut, unused_imports, unused_extern_crates, non_camel_case_types)]
extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate serde_json;

extern crate chrono;
extern crate futures;

#[macro_use]
extern crate lazy_static;
#[macro_use]
extern crate log;

// Logically this should be in the client and server modules, but rust doesn't allow `macro_use` from a module.
#[cfg(any(feature = "client", feature = "server"))]
#[macro_use]
extern crate hyper;

extern crate swagger;

use futures::Stream;
use std::io::Error;

#[allow(unused_imports)]
use std::collections::HashMap;

pub use futures::Future;

#[cfg(any(feature = "client", feature = "server"))]
mod mimetypes;

pub use swagger::{ApiError, Context, ContextWrapper};

#[derive(Debug, PartialEq)]
pub enum ContainerIdGetResponse {
    /// fetch a single container by id
    FetchASingleContainerById(models::ContainerEntity),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum ContainerLookupGetResponse {
    /// find a single container by external identifer
    FindASingleContainerByExternalIdentifer(models::ContainerEntity),
    /// bad request
    BadRequest(models::Error),
    /// no such container
    NoSuchContainer(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum ContainerPostResponse {
    /// created
    Created(models::EntityEdit),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum CreatorIdGetResponse {
    /// fetch a single creator by id
    FetchASingleCreatorById(models::CreatorEntity),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum CreatorLookupGetResponse {
    /// find a single creator by external identifer
    FindASingleCreatorByExternalIdentifer(models::CreatorEntity),
    /// bad request
    BadRequest(models::Error),
    /// no such creator
    NoSuchCreator(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum CreatorPostResponse {
    /// created
    Created(models::EntityEdit),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum EditgroupIdAcceptPostResponse {
    /// merged editgroup successfully (\"live\")
    MergedEditgroupSuccessfully_(models::Success),
    /// editgroup is in an unmergable state
    EditgroupIsInAnUnmergableState(models::Error),
    /// no such editgroup
    NoSuchEditgroup(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum EditgroupIdGetResponse {
    /// fetch editgroup by identifier
    FetchEditgroupByIdentifier(models::Editgroup),
    /// no such editgroup
    NoSuchEditgroup(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum EditgroupPostResponse {
    /// successfully created
    SuccessfullyCreated(models::Editgroup),
    /// invalid request parameters
    InvalidRequestParameters(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum EditorUsernameChangelogGetResponse {
    /// find changes (editgroups) by this editor which have been merged
    FindChanges_(models::Changelogentry),
    /// username not found
    UsernameNotFound(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum EditorUsernameGetResponse {
    /// fetch generic information about an editor
    FetchGenericInformationAboutAnEditor(models::Editor),
    /// username not found
    UsernameNotFound(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum FileIdGetResponse {
    /// fetch a single file by id
    FetchASingleFileById(models::FileEntity),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum FileLookupGetResponse {
    /// find a single file by external identifer
    FindASingleFileByExternalIdentifer(models::FileEntity),
    /// bad request
    BadRequest(models::Error),
    /// no such file
    NoSuchFile(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum FilePostResponse {
    /// created
    Created(models::EntityEdit),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum ReleaseIdGetResponse {
    /// fetch a single release by id
    FetchASingleReleaseById(models::ReleaseEntity),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum ReleaseLookupGetResponse {
    /// find a single release by external identifer
    FindASingleReleaseByExternalIdentifer(models::ReleaseEntity),
    /// bad request
    BadRequest(models::Error),
    /// no such release
    NoSuchRelease(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum ReleasePostResponse {
    /// created
    Created(models::EntityEdit),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum WorkIdGetResponse {
    /// fetch a single work by id
    FetchASingleWorkById(models::WorkEntity),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

#[derive(Debug, PartialEq)]
pub enum WorkPostResponse {
    /// created
    Created(models::EntityEdit),
    /// bad request
    BadRequest(models::Error),
    /// generic error response
    GenericErrorResponse(models::Error),
}

/// API
pub trait Api {
    fn container_id_get(&self, id: String, context: &Context) -> Box<Future<Item = ContainerIdGetResponse, Error = ApiError> + Send>;

    fn container_lookup_get(&self, issn: String, context: &Context) -> Box<Future<Item = ContainerLookupGetResponse, Error = ApiError> + Send>;

    fn container_post(&self, body: Option<models::ContainerEntity>, context: &Context) -> Box<Future<Item = ContainerPostResponse, Error = ApiError> + Send>;

    fn creator_id_get(&self, id: String, context: &Context) -> Box<Future<Item = CreatorIdGetResponse, Error = ApiError> + Send>;

    fn creator_lookup_get(&self, orcid: String, context: &Context) -> Box<Future<Item = CreatorLookupGetResponse, Error = ApiError> + Send>;

    fn creator_post(&self, body: Option<models::CreatorEntity>, context: &Context) -> Box<Future<Item = CreatorPostResponse, Error = ApiError> + Send>;

    fn editgroup_id_accept_post(&self, id: i32, context: &Context) -> Box<Future<Item = EditgroupIdAcceptPostResponse, Error = ApiError> + Send>;

    fn editgroup_id_get(&self, id: i32, context: &Context) -> Box<Future<Item = EditgroupIdGetResponse, Error = ApiError> + Send>;

    fn editgroup_post(&self, context: &Context) -> Box<Future<Item = EditgroupPostResponse, Error = ApiError> + Send>;

    fn editor_username_changelog_get(&self, username: String, context: &Context) -> Box<Future<Item = EditorUsernameChangelogGetResponse, Error = ApiError> + Send>;

    fn editor_username_get(&self, username: String, context: &Context) -> Box<Future<Item = EditorUsernameGetResponse, Error = ApiError> + Send>;

    fn file_id_get(&self, id: String, context: &Context) -> Box<Future<Item = FileIdGetResponse, Error = ApiError> + Send>;

    fn file_lookup_get(&self, sha1: String, context: &Context) -> Box<Future<Item = FileLookupGetResponse, Error = ApiError> + Send>;

    fn file_post(&self, body: Option<models::FileEntity>, context: &Context) -> Box<Future<Item = FilePostResponse, Error = ApiError> + Send>;

    fn release_id_get(&self, id: String, context: &Context) -> Box<Future<Item = ReleaseIdGetResponse, Error = ApiError> + Send>;

    fn release_lookup_get(&self, doi: String, context: &Context) -> Box<Future<Item = ReleaseLookupGetResponse, Error = ApiError> + Send>;

    fn release_post(&self, body: Option<models::ReleaseEntity>, context: &Context) -> Box<Future<Item = ReleasePostResponse, Error = ApiError> + Send>;

    fn work_id_get(&self, id: String, context: &Context) -> Box<Future<Item = WorkIdGetResponse, Error = ApiError> + Send>;

    fn work_post(&self, body: Option<models::WorkEntity>, context: &Context) -> Box<Future<Item = WorkPostResponse, Error = ApiError> + Send>;
}

/// API without a `Context`
pub trait ApiNoContext {
    fn container_id_get(&self, id: String) -> Box<Future<Item = ContainerIdGetResponse, Error = ApiError> + Send>;

    fn container_lookup_get(&self, issn: String) -> Box<Future<Item = ContainerLookupGetResponse, Error = ApiError> + Send>;

    fn container_post(&self, body: Option<models::ContainerEntity>) -> Box<Future<Item = ContainerPostResponse, Error = ApiError> + Send>;

    fn creator_id_get(&self, id: String) -> Box<Future<Item = CreatorIdGetResponse, Error = ApiError> + Send>;

    fn creator_lookup_get(&self, orcid: String) -> Box<Future<Item = CreatorLookupGetResponse, Error = ApiError> + Send>;

    fn creator_post(&self, body: Option<models::CreatorEntity>) -> Box<Future<Item = CreatorPostResponse, Error = ApiError> + Send>;

    fn editgroup_id_accept_post(&self, id: i32) -> Box<Future<Item = EditgroupIdAcceptPostResponse, Error = ApiError> + Send>;

    fn editgroup_id_get(&self, id: i32) -> Box<Future<Item = EditgroupIdGetResponse, Error = ApiError> + Send>;

    fn editgroup_post(&self) -> Box<Future<Item = EditgroupPostResponse, Error = ApiError> + Send>;

    fn editor_username_changelog_get(&self, username: String) -> Box<Future<Item = EditorUsernameChangelogGetResponse, Error = ApiError> + Send>;

    fn editor_username_get(&self, username: String) -> Box<Future<Item = EditorUsernameGetResponse, Error = ApiError> + Send>;

    fn file_id_get(&self, id: String) -> Box<Future<Item = FileIdGetResponse, Error = ApiError> + Send>;

    fn file_lookup_get(&self, sha1: String) -> Box<Future<Item = FileLookupGetResponse, Error = ApiError> + Send>;

    fn file_post(&self, body: Option<models::FileEntity>) -> Box<Future<Item = FilePostResponse, Error = ApiError> + Send>;

    fn release_id_get(&self, id: String) -> Box<Future<Item = ReleaseIdGetResponse, Error = ApiError> + Send>;

    fn release_lookup_get(&self, doi: String) -> Box<Future<Item = ReleaseLookupGetResponse, Error = ApiError> + Send>;

    fn release_post(&self, body: Option<models::ReleaseEntity>) -> Box<Future<Item = ReleasePostResponse, Error = ApiError> + Send>;

    fn work_id_get(&self, id: String) -> Box<Future<Item = WorkIdGetResponse, Error = ApiError> + Send>;

    fn work_post(&self, body: Option<models::WorkEntity>) -> Box<Future<Item = WorkPostResponse, Error = ApiError> + Send>;
}

/// Trait to extend an API to make it easy to bind it to a context.
pub trait ContextWrapperExt<'a>
where
    Self: Sized,
{
    /// Binds this API to a context.
    fn with_context(self: &'a Self, context: Context) -> ContextWrapper<'a, Self>;
}

impl<'a, T: Api + Sized> ContextWrapperExt<'a> for T {
    fn with_context(self: &'a T, context: Context) -> ContextWrapper<'a, T> {
        ContextWrapper::<T>::new(self, context)
    }
}

impl<'a, T: Api> ApiNoContext for ContextWrapper<'a, T> {
    fn container_id_get(&self, id: String) -> Box<Future<Item = ContainerIdGetResponse, Error = ApiError> + Send> {
        self.api().container_id_get(id, &self.context())
    }

    fn container_lookup_get(&self, issn: String) -> Box<Future<Item = ContainerLookupGetResponse, Error = ApiError> + Send> {
        self.api().container_lookup_get(issn, &self.context())
    }

    fn container_post(&self, body: Option<models::ContainerEntity>) -> Box<Future<Item = ContainerPostResponse, Error = ApiError> + Send> {
        self.api().container_post(body, &self.context())
    }

    fn creator_id_get(&self, id: String) -> Box<Future<Item = CreatorIdGetResponse, Error = ApiError> + Send> {
        self.api().creator_id_get(id, &self.context())
    }

    fn creator_lookup_get(&self, orcid: String) -> Box<Future<Item = CreatorLookupGetResponse, Error = ApiError> + Send> {
        self.api().creator_lookup_get(orcid, &self.context())
    }

    fn creator_post(&self, body: Option<models::CreatorEntity>) -> Box<Future<Item = CreatorPostResponse, Error = ApiError> + Send> {
        self.api().creator_post(body, &self.context())
    }

    fn editgroup_id_accept_post(&self, id: i32) -> Box<Future<Item = EditgroupIdAcceptPostResponse, Error = ApiError> + Send> {
        self.api().editgroup_id_accept_post(id, &self.context())
    }

    fn editgroup_id_get(&self, id: i32) -> Box<Future<Item = EditgroupIdGetResponse, Error = ApiError> + Send> {
        self.api().editgroup_id_get(id, &self.context())
    }

    fn editgroup_post(&self) -> Box<Future<Item = EditgroupPostResponse, Error = ApiError> + Send> {
        self.api().editgroup_post(&self.context())
    }

    fn editor_username_changelog_get(&self, username: String) -> Box<Future<Item = EditorUsernameChangelogGetResponse, Error = ApiError> + Send> {
        self.api().editor_username_changelog_get(username, &self.context())
    }

    fn editor_username_get(&self, username: String) -> Box<Future<Item = EditorUsernameGetResponse, Error = ApiError> + Send> {
        self.api().editor_username_get(username, &self.context())
    }

    fn file_id_get(&self, id: String) -> Box<Future<Item = FileIdGetResponse, Error = ApiError> + Send> {
        self.api().file_id_get(id, &self.context())
    }

    fn file_lookup_get(&self, sha1: String) -> Box<Future<Item = FileLookupGetResponse, Error = ApiError> + Send> {
        self.api().file_lookup_get(sha1, &self.context())
    }

    fn file_post(&self, body: Option<models::FileEntity>) -> Box<Future<Item = FilePostResponse, Error = ApiError> + Send> {
        self.api().file_post(body, &self.context())
    }

    fn release_id_get(&self, id: String) -> Box<Future<Item = ReleaseIdGetResponse, Error = ApiError> + Send> {
        self.api().release_id_get(id, &self.context())
    }

    fn release_lookup_get(&self, doi: String) -> Box<Future<Item = ReleaseLookupGetResponse, Error = ApiError> + Send> {
        self.api().release_lookup_get(doi, &self.context())
    }

    fn release_post(&self, body: Option<models::ReleaseEntity>) -> Box<Future<Item = ReleasePostResponse, Error = ApiError> + Send> {
        self.api().release_post(body, &self.context())
    }

    fn work_id_get(&self, id: String) -> Box<Future<Item = WorkIdGetResponse, Error = ApiError> + Send> {
        self.api().work_id_get(id, &self.context())
    }

    fn work_post(&self, body: Option<models::WorkEntity>) -> Box<Future<Item = WorkPostResponse, Error = ApiError> + Send> {
        self.api().work_post(body, &self.context())
    }
}

#[cfg(feature = "client")]
pub mod client;

// Re-export Client as a top-level name
#[cfg(feature = "client")]
pub use self::client::Client;

#[cfg(feature = "server")]
pub mod server;

// Re-export router() as a top-level name
#[cfg(feature = "server")]
pub use self::server::router;

pub mod models;