chesterfield 0.0.1

Ergonomic, strongly-typed CouchDB client in pure Rust.
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
mod delete;
mod get;
mod insert;
mod update;
pub use self::{
    delete::DeleteResponse, get::GetResponse, insert::InsertResponse, update::UpdateResponse,
};

pub mod sync {
    pub use super::{
        delete::sync::DeleteRequest, get::sync::GetRequest, insert::sync::InsertRequest,
        update::sync::UpdateRequest,
    };
    use crate::{inner_client::sync::InnerClient, Error};
    use serde::Serialize;

    /// A client to a database instance within a CouchDB node.
    ///
    /// A Database is created from a parent Client object.
    ///
    /// # Example
    /// ```
    /// use chesterfield::sync::Client;
    ///
    /// let client = Client::new("http://localhost:5984").unwrap();
    ///
    /// let items = client.database("items").unwrap();
    /// ```
    pub struct Database {
        client: InnerClient,
    }

    impl Database {
        pub(crate) fn new(client: InnerClient) -> Self {
            Database { client }
        }

        /// Create the database, if it doesn't exist.
        ///
        /// Creating the database object itself is lazy- no check is performed
        /// that the endpoint exists. Call this method if you need to create the endpoint
        /// (or if you're not sure).
        ///
        /// # Example
        /// ```
        /// use chesterfield::sync::Client;
        ///
        /// # {
        /// let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        /// #
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        /// # use std::{thread, time};
        /// # thread::sleep(time::Duration::from_millis(10000));
        ///
        /// let database = client.database("items").unwrap();
        ///
        /// database.create().unwrap();
        ///
        /// # couchdb.delete();
        /// ```
        pub fn create(&self) -> Result<(), Error> {
            self.client.put().send().map(|_| ()).map_err(Error::from)
        }

        /// Check whether the database exists
        ///
        /// # Example
        /// ```
        /// use chesterfield::sync::Client;
        ///
        /// # {
        /// let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        /// #
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        /// # use std::{thread, time};
        /// # thread::sleep(time::Duration::from_millis(10000));
        ///
        /// let database = client.database("items").unwrap();
        ///
        /// database.create().unwrap();
        ///
        /// assert!(database.exists().unwrap());
        ///
        /// # couchdb.delete();
        /// ```
        pub fn exists(&self) -> Result<bool, Error> {
            let request = self.client.head();
            println!("{:#?}", request);

            request
                .send()
                .map(|response| match response.status().as_u16() {
                    200 => true,
                    404 => false,
                    _ => unreachable!(),
                })
                .map_err(Error::from)
        }

        /// Retrieve a document from the database by ID.
        ///
        /// The returned GetRequest is lazy, and won't do a goddamn thing until
        /// you 'send' it. see [GetReqest](GetRequest) for details.
        pub fn get(&self, id: impl Into<String>) -> GetRequest {
            GetRequest::new(&self.client, id)
        }

        /// Insert pretty much anything into the database.
        ///
        /// Provided that is, that it implements [Serialize](serde::Serialize).
        ///
        /// You can optionally provide an id. If you don't, CouchDB will assign one for you
        /// (but you might not like it). The response will contain the ID and the revision.
        ///
        /// # Example
        /// ```
        /// use chesterfield::sync::Client;
        /// use serde::Serialize;
        ///
        /// #[derive(Serialize)]
        /// struct MyCoolStruct {
        ///     field1: String,
        ///     field2: u32,
        /// }
        ///
        /// let doc = MyCoolStruct {
        ///     field1: String::from("some string"),
        ///     field2: 42,
        /// };
        ///
        /// # {
        /// let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        /// #
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        /// # use std::{thread, time};
        /// # thread::sleep(time::Duration::from_millis(10000));
        ///
        /// let database = client.database("items").unwrap();
        ///
        /// database.create().unwrap();
        ///
        /// let response = database.insert(&doc, None)
        ///     .send()
        ///     .unwrap();
        ///
        /// assert!(response.ok);
        ///
        /// # couchdb.delete();
        /// ```
        pub fn insert<'a, T: Serialize>(
            &self,
            document: &'a T,
            id: impl Into<Option<String>>,
        ) -> InsertRequest<'a, T> {
            InsertRequest::new(&self.client, document, id)
        }

        /// Update an existing document.
        ///
        /// You'll need to know the ID and current revision of the document you wish to update
        ///
        /// # Example
        /// ```
        /// use chesterfield::sync::Client;
        /// use serde::Serialize;
        ///
        /// #[derive(Serialize, Clone)]
        /// struct MyCoolStruct {
        ///     field1: String,
        ///     field2: u32,
        /// }
        ///
        /// let mut doc = MyCoolStruct {
        ///     field1: String::from("some string"),
        ///     field2: 42,
        /// };
        ///
        /// # {
        /// let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        /// #
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        /// # use std::{thread, time};
        /// # thread::sleep(time::Duration::from_millis(10000));
        ///
        /// let database = client.database("items").unwrap();
        /// # database.create().unwrap();
        ///
        /// let response = database.insert(&doc, None)
        ///     .send()
        ///     .unwrap();
        ///
        /// assert!(response.ok);
        ///
        /// let id = response.id;
        /// let rev = response.rev;
        ///
        /// // modify the document
        /// doc.field2 = 100;
        ///
        /// // update it
        /// database.update(&doc, id, rev);
        ///
        /// # couchdb.delete();
        /// ```
        pub fn update<'a, T: Serialize>(
            &self,
            document: &'a T,
            id: impl Into<String>,
            rev: impl Into<String>,
        ) -> UpdateRequest<'a, T> {
            UpdateRequest::new(&self.client, document, id, rev)
        }

        /// Delete an existing document.
        ///
        /// You'll need to know the ID and current revision of the document you wish to delete
        ///
        /// # Example
        /// ```
        /// use chesterfield::sync::Client;
        /// use serde::{Serialize, Deserialize};
        ///
        /// #[derive(Serialize, Deserialize, Clone, Debug)]
        /// struct MyCoolStruct {
        ///     field1: String,
        ///     field2: u32,
        /// }
        ///
        /// let mut doc = MyCoolStruct {
        ///     field1: String::from("some string"),
        ///     field2: 42,
        /// };
        ///
        /// # {
        /// let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        /// #
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        /// # use std::{thread, time};
        /// # thread::sleep(time::Duration::from_millis(10000));
        ///
        /// let database = client.database("items").unwrap();
        /// # database.create().unwrap();
        ///
        /// let response = database.insert(&doc, None)
        ///     .send()
        ///     .unwrap();
        ///
        /// assert!(response.ok);
        ///
        /// let id = response.id;
        /// let rev = response.rev;
        ///
        /// // Check that the document exists
        /// assert!(
        ///     database.get(id.clone()).send::<MyCoolStruct>().is_ok()
        /// );
        ///
        /// // delete it
        /// database.delete(id.clone(), rev).send().unwrap();
        ///
        /// // Check that it's been deleted
        /// assert!(
        ///     database.get(id.clone()).send::<MyCoolStruct>().is_err()
        /// );
        ///
        /// # couchdb.delete();
        /// ```
        pub fn delete(&self, id: impl Into<String>, rev: impl Into<String>) -> DeleteRequest {
            DeleteRequest::new(&self.client, id, rev)
        }
    }
}

pub mod r#async {
    pub use super::{
        delete::r#async::DeleteRequest, get::r#async::GetRequest, insert::r#async::InsertRequest,
        update::r#async::UpdateRequest,
    };
    use crate::{inner_client::r#async::InnerClient, Error};
    use serde::Serialize;
    use tokio::prelude::Future;

    /// Interface for interacting with a specific CouchDB database within a CouchDB node.
    ///
    /// # Example
    /// ```
    /// use chesterfield::Client;
    ///
    /// let couchdb_url = "https://localhost:5984";
    /// let db = "collection";
    ///
    /// let client = Client::new(couchdb_url).unwrap();
    /// let database = client.database(db).unwrap();
    /// ```
    pub struct Database {
        client: InnerClient,
    }

    impl Database {
        pub(crate) fn new(client: InnerClient) -> Self {
            Database { client }
        }

        /// Create the database, if it doesn't exist.
        ///
        /// Creating the database object itself is lazy- no check is performed
        /// that the endpoint exists. Call this method if you need to create the endpoint
        /// (or if you're not sure).
        ///
        /// # Example
        /// ```
        /// use chesterfield::Client;
        /// use tokio::prelude::Future;
        ///
        /// # {
        /// let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        /// #
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        ///
        /// let database = client.database("items").unwrap();
        ///
        /// tokio::run(
        ///     database.create()
        ///     .map_err(|e| {
        ///         # panic!();
        ///         println!("{}", e);
        ///     })
        /// );
        ///
        /// # couchdb.delete();
        /// ```
        pub fn create(&self) -> impl Future<Item = (), Error = Error> {
            self.client.put().send().map(|_| ()).map_err(Error::from)
        }

        /// Check whether the database exists
        pub fn exists(&self) -> impl Future<Item = bool, Error = Error> {
            let request = self.client.head();
            println!("{:#?}", request);

            request
                .send()
                .map(|response| match response.status().as_u16() {
                    200 => true,
                    404 => false,
                    _ => unreachable!(),
                })
                .map_err(Error::from)
        }

        /// Retrieve a document from a database.
        ///
        /// # Example
        /// ```
        /// use chesterfield::Client;
        ///
        /// let couchdb_url = "https://localhost:5984";
        /// let db = "collection";
        /// let document_id = "some-unique-id";
        ///
        /// let client = Client::new(couchdb_url).unwrap();
        /// let database = client.database(db).unwrap();
        ///
        /// let get_request = database.get(document_id);
        ///
        /// ```
        pub fn get(&self, id: impl Into<String>) -> GetRequest {
            GetRequest::new(&self.client, id)
        }

        /// Insert pretty much anything into the database.
        ///
        /// Provided that is, that it implements [Serialize](serde::Serialize).
        ///
        /// You can optionally provide an id. If you don't, CouchDB will assign one for you
        /// (but you might not like it). The response will contain the ID and the revision.
        ///
        /// # Example
        /// ```
        /// # use chesterfield::Client;
        /// # use serde::Serialize;
        /// # use tokio::prelude::Future;
        ///
        /// #[derive(Serialize)]
        /// struct MyCoolStruct {
        ///     field1: String,
        ///     field2: u32,
        /// }
        ///
        /// let doc = MyCoolStruct {
        ///     field1: String::from("some string"),
        ///     field2: 42,
        /// };
        ///
        /// # {
        /// #     let client = Client::new("http://localhost:5984").unwrap();
        /// # }
        ///
        /// # use chesterfield::CouchDbContainer;
        /// # let couchdb = CouchDbContainer::default();
        /// # let url = format!("http://localhost:{}", couchdb.port());
        /// # let client = Client::new(url).unwrap();
        ///     
        /// # // Create the database client
        /// # let database = client.database("items").unwrap();
        /// #     
        /// # tokio::run(
        /// #     // ensure the database exists in the remote
        /// #     database.create().map_err(|e| panic!("{}", e)),
        /// # );
        ///     
        /// tokio::run(
        ///     database
        ///         // insert document into database
        ///         .insert(&doc, None)
        ///         .send()
        ///         // do something with the response
        ///         .map(|response| assert!(response.ok))
        ///         // handle any errors
        ///         .map_err(|e| panic!("{}", e)),
        /// );
        ///     
        /// # couchdb.delete();
        /// ```
        pub fn insert<'a, T: Serialize>(
            &self,
            document: &'a T,
            id: impl Into<Option<String>>,
        ) -> InsertRequest<'a, T> {
            InsertRequest::new(&self.client, document, id)
        }

        pub fn update<'a, T: Serialize>(
            &self,
            document: &'a T,
            id: impl Into<String>,
            rev: impl Into<String>,
        ) -> UpdateRequest<'a, T> {
            UpdateRequest::new(&self.client, document, id, rev)
        }

        pub fn delete(&self, id: impl Into<String>, rev: impl Into<String>) -> DeleteRequest {
            DeleteRequest::new(&self.client, id, rev)
        }
    }
}