Updated docs to take into account recent TLS and library name changes.

Author: kaibyao

README.md

@@ -4,10 +4,8 @@ Libraries for exposing your PostgreSQL database as a REST API.
 
 ## Libraries
 
-- [`postgres-rest-actix`](postgres-rest-actix/)
-
+- [`postgres-rest-actix`](postgres-rest-actix/)  
   Use `actix-web` to serve a REST API for your PostgreSQL database.
 
-- [`postgres-rest`](postgres-rest/)
-
+- [`postgres-rest`](postgres-rest/)  
   Contains the functions necessary to turn a PostgreSQL database into a REST API. Used by `postgres-rest-actix`.

postgres-rest-actix/README.md

@@ -4,7 +4,8 @@ Use `actix-web` to serve a REST API for your PostgreSQL database.
 
 ```rust
 use actix_web::{App, HttpServer};
-use rust_postgres_rest_actix::{Config};
+use postgres_rest_actix::{Config};
+use tokio_postgres::NoTls;
 
 fn main() {
     let ip_address = "127.0.0.1:3000";
@@ -13,7 +14,7 @@ fn main() {
     HttpServer::new(move || {
         App::new().service(
             // appends an actix-web Scope under the "/api" endpoint to app.
-            Config::new("postgresql://[email protected]:5432/postgres")
+            Config::new("postgresql://[email protected]:5432/postgres", NoTls)
                 .generate_scope("/api"),
         )
     })
@@ -112,7 +113,17 @@ Will return the following JSON:
 
 #### Alias (`AS`) syntax is supported too
 
-Changing the previous API endpoint to `/api/child?columns=id,name,parent_id.name as parent_name,parent_id.company_id.name as parent_company_name` or `/api/child?columns=id,name,parent_id.name parent_name,parent_id.company_id.name parent_company_name` will return the aliased fields instead:
+Change the previous API endpoint:
+
+**Before:**  
+`/api/child?columns=id,name,parent_id.name,parent_id.company_id.name`
+
+**After:**  
+`/api/child?columns=id,name,parent_id.name as parent_name,parent_id.company_id.name as parent_company_name`  
+or  
+`/api/child?columns=id,name,parent_id.name parent_name,parent_id.company_id.name parent_company_name`
+
+Now, the response will return the aliased fields instead:
 
 ```json
 [
@@ -137,7 +148,10 @@ Changing the previous API endpoint to `/api/child?columns=id,name,parent_id.name
 The `Config` struct contains the configuration options used by this library.
 
 ```rust
-let config = Config::new("postgresql://[email protected]:5432/postgres");
+use postgres_rest_actix::Config;
+use tokio_postgres::NoTls;
+
+let config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);
 let scope = config.generate_scope("/api");
 ```
 

postgres-rest-actix/src/endpoints/query_params_from_request.rs

@@ -1,7 +1,7 @@
 use crate::error::Error;
 use actix_web::HttpRequest;
 use rayon::prelude::*;
-use rust_postgres_rest::queries::{DeleteParams, InsertParams, SelectParams, UpdateParams};
+use postgres_rest::queries::{DeleteParams, InsertParams, SelectParams, UpdateParams};
 use serde::Deserialize;
 use serde_json::{Map, Value};
 

postgres-rest-actix/src/endpoints/table.rs

@@ -20,7 +20,7 @@ use super::query_params_from_request::{
     RequestQueryStringParams,
 };
 use crate::{Config, Error};
-use rust_postgres_rest::queries;
+use postgres_rest::queries;
 
 /// Deletes table rows and optionally returns the column data in the deleted rows.
 pub fn delete_table<T>(

postgres-rest-actix/src/error.rs

@@ -1,6 +1,6 @@
 use actix_web::{http, HttpResponse};
 use failure::Fail;
-use rust_postgres_rest::Error as RestError;
+use postgres_rest::Error as RestError;
 use serde::Serialize;
 
 #[derive(Debug, Fail, Serialize)]

postgres-rest-actix/src/lib.rs

@@ -11,7 +11,7 @@
 //!
 //! ```no_run
 //! use actix_web::{App, HttpServer};
-//! use rust_postgres_rest_actix::{Config};
+//! use postgres_rest_actix::{Config};
 //! use tokio_postgres::tls::NoTls;
 //! # use std::thread;
 //!
@@ -46,7 +46,7 @@
 ///
 /// ```no_run
 /// use actix_web::{App, HttpServer, web};
-/// use rust_postgres_rest_actix::{Config, endpoints};
+/// use postgres_rest_actix::{Config, endpoints};
 /// use tokio_postgres::tls::NoTls;
 ///
 /// fn main() {
@@ -87,7 +87,7 @@ use endpoints::{
 };
 
 pub use error::Error;
-use rust_postgres_rest::Config as InnerConfig;
+use postgres_rest::Config as InnerConfig;
 
 use actix_web::{web, Scope};
 use futures::future::Future;
@@ -98,7 +98,7 @@ use tokio_postgres::{
 
 /// Configures and creates the REST API `Scope`.
 /// ```no_run
-/// use rust_postgres_rest_actix::Config;
+/// use postgres_rest_actix::Config;
 /// use tokio_postgres::NoTls;
 ///
 /// let config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);
@@ -129,7 +129,7 @@ where
 {
     /// Creates a Config object with default values. `db_url` must be [Postgres-formatted](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6).
     /// ```
-    /// use rust_postgres_rest_actix::Config;
+    /// use postgres_rest_actix::Config;
     /// use tokio_postgres::NoTls;
     ///
     /// let config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);
@@ -157,7 +157,7 @@ where
     /// ```no_run
     /// use futures::future::{Future, ok};
     /// use futures::stream::Stream;
-    /// use rust_postgres_rest_actix::Config;
+    /// use postgres_rest_actix::Config;
     /// use tokio_postgres::NoTls;
     ///
     /// actix::run(|| Config::new("postgresql://[email protected]:5432/postgres", NoTls).connect()
@@ -187,7 +187,7 @@ where
 
     /// Creates the Actix scope url at `scope_name`, which contains all of the other API endpoints.
     /// ```no_run
-    /// use rust_postgres_rest_actix::Config;
+    /// use postgres_rest_actix::Config;
     /// use tokio_postgres::NoTls;
     ///
     /// let config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);
@@ -225,7 +225,7 @@ where
     /// Set the timer to automatically reset the table stats cache on a recurring interval. If this
     /// is not set, the cache is never reset after server start.
     /// ```
-    /// use rust_postgres_rest_actix::Config;
+    /// use postgres_rest_actix::Config;
     /// use tokio_postgres::NoTls;
     ///
     /// let mut config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);

postgres-rest-actix/tests/setup.rs

@@ -1,7 +1,7 @@
 use actix::spawn as actix_spawn;
 use actix_web::{test::block_fn, App, HttpServer};
 use futures::{stream::Stream, Future};
-use rust_postgres_rest_actix::Config;
+use postgres_rest_actix::Config;
 use std::{fs::read_to_string, thread::spawn as thread_spawn};
 use tokio_postgres::{connect, NoTls};
 

postgres-rest/src/lib.rs

@@ -41,7 +41,7 @@ where
 impl<T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static> Config<T> {
     /// Creates a new Config.
     /// ```
-    /// use rust_postgres_rest::Config;
+    /// use postgres_rest::Config;
     /// use tokio_postgres::tls::NoTls;
     ///
     /// let mut config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);
@@ -71,7 +71,7 @@ impl<T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static> Config<T> {
     /// ```no_run
     /// use futures::future::{Future, ok};
     /// use futures::stream::Stream;
-    /// use rust_postgres_rest::{Config};
+    /// use postgres_rest::{Config};
     /// use tokio_postgres::tls::NoTls;
     ///
     /// let mut config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);
@@ -134,7 +134,7 @@ impl<T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static> Config<T> {
     /// Set the interval timer to automatically reset the table stats cache. If this is not set, the
     /// cache is never reset.
     /// ```
-    /// use rust_postgres_rest::Config;
+    /// use postgres_rest::Config;
     /// use tokio_postgres::tls::NoTls;
     ///
     /// let mut config = Config::new("postgresql://[email protected]:5432/postgres", NoTls);