Merge pull request #17 from hjr3/refactor

refactor(*): change middleware interface and update dependencies

Cargo.toml

@@ -1,16 +1,14 @@
 [package]
 
 name = "nickel_postgres"
-version = "0.0.0"
+version = "0.2.0"
 authors = [
     "bguiz"
 ]
 
 [dependencies]
-postgres = "*"
-r2d2 = "*"
-r2d2_postgres = "*"
-plugin = "*"
-typemap = "*"
-openssl = "*"
-nickel = "*"
+nickel = "0.8.1"
+r2d2 = "0.7.0"
+r2d2_postgres = "0.10.1"
+typemap = "0.3.3"
+plugin = "0.2.6"

examples/example.rs

@@ -1,26 +1,19 @@
-extern crate r2d2;
-extern crate postgres;
-extern crate openssl;
 #[macro_use] extern crate nickel;
 extern crate nickel_postgres;
 
 use std::env;
-use r2d2::NopErrorHandler;
-use postgres::SslMode;
 use nickel::{Nickel, HttpRouter};
 use nickel_postgres::{PostgresMiddleware, PostgresRequestExtensions};
 
 fn main() {
     let mut app = Nickel::new();
 
     let postgres_url = env::var("DATABASE_URL").unwrap();
-    let dbpool = PostgresMiddleware::new(&*postgres_url,
-                                         SslMode::None,
-                                         5,
-                                         Box::new(NopErrorHandler)).unwrap();
-    app.utilize(dbpool);
-    app.get("/my_counter", middleware! { |request|
-        let _connection = request.db_conn();
+    let mw = PostgresMiddleware::new(&postgres_url).unwrap();
+    app.utilize(mw);
+
+    app.get("/my_counter", middleware! { |request, response|
+        let _connection = try_with!(response, request.pg_conn());
 
         // use connection
     });

examples/with_pool.rs

@@ -0,0 +1,31 @@
+extern crate r2d2;
+extern crate r2d2_postgres;
+#[macro_use] extern crate nickel;
+extern crate nickel_postgres;
+
+use std::env;
+use r2d2::{Config, Pool};
+use r2d2_postgres::{PostgresConnectionManager, SslMode};
+use nickel::{Nickel, HttpRouter};
+use nickel_postgres::{PostgresMiddleware, PostgresRequestExtensions};
+
+fn main() {
+    let mut app = Nickel::new();
+
+    let postgres_url = env::var("DATABASE_URL").unwrap();
+    let db_mgr = PostgresConnectionManager::new(postgres_url.as_ref(), SslMode::None)
+        .expect("Unable to connect to database");
+
+    let db_pool = Pool::new(Config::default(), db_mgr)
+        .expect("Unable to initialize connection pool");
+
+    app.utilize(PostgresMiddleware::with_pool(db_pool));
+
+    app.get("/my_counter", middleware! { |request, response|
+        let _connection = try_with!(response, request.pg_conn());
+
+        // use connection
+    });
+
+    app.get("**", middleware! { println!("!!!") });
+}

src/lib.rs

@@ -1,9 +1,8 @@
 extern crate nickel;
-extern crate postgres;
 extern crate r2d2;
 extern crate r2d2_postgres;
-extern crate plugin;
 extern crate typemap;
+extern crate plugin;
 
 pub use middleware::{ PostgresMiddleware, PostgresRequestExtensions };
 

src/middleware.rs

@@ -1,51 +1,69 @@
-use std::sync::Arc;
-use std::error::Error as StdError;
-
+use std::error::Error;
+use std::result::Result;
 use nickel::{Request, Response, Middleware, Continue, MiddlewareResult};
-use postgres::{SslMode};
-use r2d2_postgres::{PostgresConnectionManager};
-use r2d2::{Pool, HandleError, Config, PooledConnection};
+use nickel::status::StatusCode;
+use r2d2_postgres::{PostgresConnectionManager, SslMode};
+use r2d2::{Config, Pool, PooledConnection, GetTimeout};
 use typemap::Key;
-use plugin::{Pluggable, Extensible};
+use plugin::Extensible;
 
 pub struct PostgresMiddleware {
-    pub pool: Arc<Pool<PostgresConnectionManager>>
+    pub pool: Pool<PostgresConnectionManager>,
 }
 
 impl PostgresMiddleware {
-    pub fn new(connect_str: &str,
-               ssl_mode: SslMode,
-               num_connections: u32,
-               error_handler: Box<HandleError<::r2d2_postgres::Error>>)
-                    -> Result<PostgresMiddleware, Box<StdError>> {
-        let manager = try!(PostgresConnectionManager::new(connect_str, ssl_mode));
-
-        let config = Config::builder()
-          .pool_size(num_connections)
-          .error_handler(error_handler)
-          .build();
+    /// Create middleware using defaults
+    ///
+    /// The middleware will be setup with no ssl and the r2d2 defaults.
+    pub fn new(db_url: &str) -> Result<PostgresMiddleware, Box<Error>> {
+        let manager = try!(PostgresConnectionManager::new(db_url, SslMode::None));
+        let pool = try!(Pool::new(Config::default(), manager));
 
-        let pool = try!(Pool::new(config, manager));
+        Ok(PostgresMiddleware { pool: pool })
+    }
 
-        Ok(PostgresMiddleware { pool: Arc::new(pool) })
+    /// Create middleware using pre-built `r2d2::Pool`
+    ///
+    /// This allows the caller to create and configure the pool with specific settings.
+    pub fn with_pool(pool: Pool<PostgresConnectionManager>) -> PostgresMiddleware {
+        PostgresMiddleware { pool: pool }
     }
 }
 
-impl Key for PostgresMiddleware { type Value = Arc<Pool<PostgresConnectionManager>>; }
+impl Key for PostgresMiddleware { type Value = Pool<PostgresConnectionManager>; }
 
 impl<D> Middleware<D> for PostgresMiddleware {
     fn invoke<'mw, 'conn>(&self, req: &mut Request<'mw, 'conn, D>, res: Response<'mw, D>) -> MiddlewareResult<'mw, D> {
         req.extensions_mut().insert::<PostgresMiddleware>(self.pool.clone());
+
         Ok(Continue(res))
     }
 }
 
+/// Add `pg_conn()` helper method to `nickel::Request`
+///
+/// This trait must only be used in conjunction with `PostgresMiddleware`.
+///
+/// On error, the method returns a tuple per Nickel convention. This allows the route to use the
+/// `try_with!` macro.
+///
+/// Example:
+///
+/// ```ignore
+/// app.get("/my_counter", middleware! { |request, response|
+/// 	let db = try_with!(response, request.pg_conn());
+/// });
+/// ```
 pub trait PostgresRequestExtensions {
-    fn db_conn(&self) -> PooledConnection<PostgresConnectionManager>;
+    fn pg_conn(&self) -> Result<PooledConnection<PostgresConnectionManager>, (StatusCode, GetTimeout)>;
 }
 
 impl<'a, 'b, D> PostgresRequestExtensions for Request<'a, 'b, D> {
-    fn db_conn(&self) -> PooledConnection<PostgresConnectionManager> {
-        self.extensions().get::<PostgresMiddleware>().unwrap().get().unwrap()
+    fn pg_conn(&self) -> Result<PooledConnection<PostgresConnectionManager>, (StatusCode, GetTimeout)> {
+        self.extensions()
+            .get::<PostgresMiddleware>()
+            .expect("PostgresMiddleware must be registered before using PostgresRequestExtensions::pg_conn()")
+            .get()
+            .or_else(|err| Err((StatusCode::InternalServerError, err)))
     }
 }