Updated Sofa 0.6 to use tokio-async, latest serde and reqwest libraries and follow 2018 standard

.gitignore

@@ -12,5 +12,9 @@ Cargo.lock
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
+# Exclude IntelliJ files
+.idea
+
+test_db.json
 
 # End of https://www.gitignore.io/api/rust

CHANGELOG.md

@@ -7,17 +7,72 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [0.6.0] - 2018-08-23
+## [0.8.0] - 2020-09-26
+
+- the `find()` operations takes a FindQuery
+
+## [0.7.18] - 2020-09-25
+
+- Views now use QueryParams instead of an untyped map.
+- Views can now return the optional "doc" item.
+- BREAKING CHANGE: `execute_view` has been removed. Use `query` instead.
+
+## [0.7.17] - 2020-09-14
+
+- Sort takes an array of key/value pairs, like: [{"first_name":"desc"}]
+
+## [0.7.16] - 2020-09-14
+
+- Make total_rows in ViewCollection optional.
+
+## [0.7.15] - 2020-09-14
+
+- Make id in ViewItem optional.
+
+## [0.7.14] - 2020-09-14
+- Return value in ViewItem as a Value, not String
+
+## [0.7.13] - 2020-09-11
+- Use reqwest's `error_for_status()` on responses, where we are not actively checking the result.
+- Return an Error when one occurs during batch reading.
+- Removed the `'static` lifetime on some of the `str` parameters; contribution from kallisti5
+- Included `execute_update()` operation; contribution from horacimacias 
+
+## [0.7.12] - 2020-09-10
+- Check response success for create_view()
+
+## [0.7.11] - 2020-09-09
+- Allow to query a view with a different design name
+
+## [0.7.10] - 2020-09-09
+- BREAKING CHANGE: get_all_params now takes a typed QueryParams as input.
+- get_all_params uses POST, instead of GET, for greater flexibility.
+
+## [0.7.9] - 2020-09-09
+- `json_extr!` does not panic when called on a non-existent field. Like in find for _id, 
+   when the find result does not include an _id.
+
+## [0.7.8] - 2020-09-09
+- Implemented Display for FindQuery
+
+## [0.7.7] - 2020-09-09
+- Allow FindQuery to be converted to Value
+
+## [0.7.6] - 2020-09-09
+- Added `find_batched` to allow asynchronous customized searches 
+
+## [0.7.0] - 2020-02-03
 
 ### Added
 
-- Added `failure` dependency
 - Added `Client::make_db`
 - Added `docker-compose.yml`
 - Added `.rustfmt.toml`
 
 ### Changed
 
+- Updated to the Rust 2018 edition standards
+- Compiles against the latest reqwest and serde libraries
 - Optimized memory consumption by moving `iter()` calls to `into_iter()` where needed
 - Changed `SofaError` to derive `failure`
 - Changed `Client::check_status` signature to remove potentially panicking `unwrap()` calls
@@ -45,3 +100,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Removed
 
 - Removed env files that were necessary for single-threaded test run. Added section in README to reflect that.
+- Removed the `failure` dependency

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "sofa"
-version = "0.6.0"
-authors = ["Mathieu Amiot <mathieu.amiot@yellowinnovation.fr>"]
+version = "0.8.0"
+authors = ["Mathieu Amiot <mathieu.amiot@yellowinnovation.fr>", "mibes <mibes@mibesco.com>"]
 license = "MIT/Apache-2.0"
 description = "Sofa - CouchDB for Rust"
 readme = "README.md"
@@ -10,17 +10,22 @@ homepage = "https://github.com/YellowInnovation/sofa"
 repository = "https://github.com/YellowInnovation/sofa"
 keywords = ["couchdb", "orm", "database", "nosql"]
 categories = ["database"]
+edition = "2018"
 include = [
     "**/*.rs",
     "Cargo.toml"
 ]
 
 [dependencies]
-failure = "0.1"
-serde = "1.0"
-serde_derive = "1.0"
-serde_json = "1.0"
-reqwest = "0.8"
+serde = { version = "^1.0.114", features = ["derive"] }
+serde_json = "^1.0.56"
+url = "^2.1.1"
+tokio = { version = "^0.2.22", features = ["full"] }
+
+[dependencies.reqwest]
+version = "^0.10.7"
+features = ["json", "gzip", "cookies"]
 
 [dev-dependencies]
-pretty_assertions = "0.5"
+pretty_assertions = "^0.6.1"
+tokio = { version = "^0.2.22", features = ["full"] }

README.md

@@ -1,67 +1,95 @@
-# Sofa - CouchDB for Rust
-
-[![Crates.io](https://img.shields.io/crates/v/sofa.svg)](https://crates.io/crates/sofa)[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FYellowInnovation%2Fsofa.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FYellowInnovation%2Fsofa?ref=badge_shield)
-
-[![docs.rs](https://docs.rs/sofa/badge.svg)](https://docs.rs/sofa)
-
-![sofa-logo](https://raw.githubusercontent.com/YellowInnovation/sofa/master/docs/logo-sofa.png "Logo Sofa")
-
-## Documentation
-
-Here: [http://docs.rs/sofa](http://docs.rs/sofa)
-
-## Installation
-
-```toml
-[dependencies]
-sofa = "0.6"
-```
-
-## Description
-
-This crate is an interface to CouchDB HTTP REST API. Works with stable Rust.
-
-Does not support `#![no_std]`
-
-After trying most crates for CouchDB in Rust (`chill`, `couchdb` in particular), none of them fit our needs hence the need to create our own.
-
-No async I/O (yet), uses a mix of Reqwest and Serde under the hood, with a few nice abstractions out there.
-
-**NOT 1.0 YET, so expect changes**
-
-**Supports CouchDB 2.0 and up.**
-
-Be sure to check [CouchDB's Documentation](http://docs.couchdb.org/en/latest/index.html) in detail to see what's possible.
-
-## Running tests
-
-Make sure that you have an instance of CouchDB 2.0+ running, either via the supplied `docker-compose.yml` file or by yourself. It must be listening on the default port.
-
-And then
-`cargo test -- --test-threads=1`
-
-Single-threading the tests is very important because we need to make sure that the basic features are working before actually testing features on dbs/documents.
-
-## Why the name "Sofa"
-
-CouchDB has a nice name, and I wanted to reflect that.
-
-## License
-
-Licensed under either of these:
-
-* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
-   [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
-* MIT license ([LICENSE-MIT](LICENSE-MIT) or
-   [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT))
-
+# Sofa - CouchDB for Rust
+
+[![Crates.io](https://img.shields.io/crates/v/sofa.svg)](https://crates.io/crates/sofa)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FYellowInnovation%2Fsofa.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FYellowInnovation%2Fsofa?ref=badge_shield)
+
+[![docs.rs](https://docs.rs/sofa/badge.svg)](https://docs.rs/sofa)
+
+![sofa-logo](https://raw.githubusercontent.com/mibes/sofa/master/docs/logo-sofa.png "Logo Sofa")
+
+## Migration Notice
+
+Please note that we are no longer maintaining this fork, but have spun off a new project: 
+[couch-rs](https://github.com/mibes/couch-rs)  
+
+## Documentation
+
+Here: [http://docs.rs/sofa](http://docs.rs/sofa)
+
+## Installation
+
+If you want to use this particular fork, include this dependency in the Cargo.toml file:
+```toml
+[dependencies]
+sofa = { git = "https://github.com/mibes/sofa.git", version = "0.8.0" }
+```
+
+If you want to continue to use the "old" 0.6 version use this dependency instead:
+```toml
+[dependencies]
+sofa = "0.6"
+```
+
+## Description
+
+This crate is an interface to CouchDB HTTP REST API. Works with stable Rust.
+
+After trying most crates for CouchDB in Rust (`chill`, `couchdb` in particular), none of them fit our needs hence the need to create our own.
+
+Uses async I/O, with a mix of Reqwest and Serde under the hood, and a few nice abstractions out there.
+
+**NOT 1.0 YET, so expect changes**
+
+**Supports CouchDB 2.3.0 and up, including the newly released 3.0 version.**
+
+Be sure to check [CouchDB's Documentation](http://docs.couchdb.org/en/latest/index.html) in detail to see what's possible.
+
+The 0.7 version is based on the 0.6 release from https://github.com/YellowInnovation/sofa.
+It has been updated to the Rust 2018 edition standards, uses async I/O, and compiles against the latest serde and 
+reqwest libraries.
+
+## Example code
+
+You can launch the included example with:
+```shell script
+cargo run --example basic_operations
+```
+
+## Running tests
+
+Make sure that you have an instance of CouchDB 2.0+ running, either via the supplied `docker-compose.yml` file or by yourself. It must be listening on the default port.
+Since Couch 3.0 the "Admin Party" mode is no longer supported. This means you need to provide a username and password during launch. 
+The tests and examples assume an "admin" CouchDB user with a "password" CouchDB password. Docker run command:
+
+```shell script
+docker run --rm -p 5984:5984 -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password couchdb:3
+```
+
+And then
+`cargo test -- --test-threads=1`
+
+Single-threading the tests is very important because we need to make sure that the basic features are working before actually testing features on dbs/documents.
+
+## Why the name "Sofa"
+
+CouchDB has a nice name, and I wanted to reflect that.
+
+## License
+
+Licensed under either of these:
+
+* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+   [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or
+   [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT))
+
 
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FYellowInnovation%2Fsofa.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FYellowInnovation%2Fsofa?ref=badge_large)
 
-## Yellow Innovation
-
-Yellow Innovation is the innovation laboratory of the French postal service: La Poste.
-
-We create innovative user experiences and journeys through services with a focus on IoT lately.
-
+## Yellow Innovation
+
+Yellow Innovation is the innovation laboratory of the French postal service: La Poste.
+
+We create innovative user experiences and journeys through services with a focus on IoT lately.
+
 [Yellow Innovation's website and works](http://yellowinnovation.fr/en/)

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
 
   couchdb:
-    image: couchdb:2.2
+    image: couchdb:3
     restart: always
     ports:
       - '5984:5984'

examples/async_batch_read/main.rs

@@ -0,0 +1,54 @@
+extern crate sofa;
+
+use sofa::document::DocumentCollection;
+use std::fs::File;
+use std::io::prelude::*;
+use std::time::SystemTime;
+use tokio::sync::mpsc;
+use tokio::sync::mpsc::{Receiver, Sender};
+
+const DB_HOST: &str = "http://admin:password@localhost:5984";
+const TEST_DB: &str = "test_db";
+
+#[tokio::main]
+async fn main() {
+    println!("Connecting...");
+    let now = SystemTime::now();
+
+    // Create a sender and receiver channel pair
+    let (tx, mut rx): (Sender<DocumentCollection>, Receiver<DocumentCollection>) = mpsc::channel(100);
+
+    // Spawn a separate thread to retrieve the batches from Couch
+    let t = tokio::spawn(async move {
+        let client = sofa::Client::new_with_timeout(DB_HOST, 120).unwrap();
+        let db = client.db(TEST_DB).await.unwrap();
+
+        if let Err(err) = db.get_all_batched(tx, 0, 0).await {
+            println!("error during batch read: {:?}", err);
+        }
+    });
+
+    // Open a file for writing
+    let mut file = File::create("test_db.json").unwrap();
+
+    // Loop until the receiving channel is closed.
+    while let Some(all_docs) = rx.recv().await {
+        println!("Received {} docs", all_docs.total_rows);
+
+        // unmarshal the documents and write them to a file.
+        // (there is probably a more efficient way of doing this...)
+        for row in all_docs.rows {
+            file.write_all(serde_json::to_string(&row.doc).unwrap().as_bytes())
+                .unwrap();
+        }
+    }
+
+    // Make sure the file is written before exiting
+    file.sync_all().unwrap();
+
+    let elapsed = now.elapsed().unwrap_or_default();
+    println!("{} ms", elapsed.as_millis());
+
+    // Wait for the spawned task to finish (should be done by now).
+    t.await.unwrap();
+}