remove examples/postgres/todo-api as there is now a similar example in actix/examples

This commit is contained in:
Ryan Leckey 2020-07-27 02:12:11 -07:00
parent 811982db80
commit f66025b460
9 changed files with 0 additions and 327 deletions

View file

@ -1,4 +0,0 @@
HOST=127.0.0.1
PORT=5000
DATABASE_URL="postgres://user:pass@192.168.33.11/actix_sqlx_todo"
RUST_LOG=todo_api=info,actix=info

View file

@ -1,2 +0,0 @@
/target
.env

View file

@ -1,20 +0,0 @@
[package]
name = "todo_api"
version = "0.1.0"
authors = ["Milan Zivkovic <zivkovic.milan@gmail.com>"]
edition = "2018"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
listenfd = "0.3.3"
actix-web = "3.0.0-alpha.1"
actix-rt = "1.1.0"
serde = "1.0.106"
serde_json = "1.0.51"
sqlx = { version = "0.3", features = [ "postgres" ] }
futures = "0.3.4"
dotenv = "0.15.0"
env_logger = "0.7.1"
log = "0.4.8"
anyhow = "1.0.28"

View file

@ -1,33 +0,0 @@
# actix-sqlx-todo
Example Todo API using [Actix-web](https://github.com/actix/actix-web) and SQLx with posgresql
# Usage
## Prerequisites
* Rust
* PostgreSQL
## Change into the project sub-directory
All instructions assume you have changed into this folder:
```bash
cd examples/postgres/todo-api
```
## Set up the database
* Create new database using `schema.sql`
* Copy `.env-example` into `.env` and adjust DATABASE_URL to match your PostgreSQL address, username and password
## Run the application
To run the application execute:
```bash
cargo run
```
By default application will be available on `http://localhost:5000`. If you wish to change address or port you can do it inside `.env` file.

View file

@ -1,5 +0,0 @@
CREATE TABLE IF NOT EXISTS todos (
id SERIAL PRIMARY KEY,
description TEXT NOT NULL,
done BOOLEAN NOT NULL DEFAULT FALSE
);

View file

@ -1,65 +0,0 @@
#[macro_use]
extern crate log;
use actix_web::{web, App, HttpResponse, HttpServer, Responder};
use anyhow::Result;
use dotenv::dotenv;
use listenfd::ListenFd;
use sqlx::PgPool;
use std::env;
// import todo module (routes and model)
mod todo;
// default / handler
async fn index() -> impl Responder {
HttpResponse::Ok().body(r#"
Welcome to Actix-web with SQLx Todos example.
Available routes:
GET /todos -> list of all todos
POST /todo -> create new todo, example: { "description": "learn actix and sqlx", "done": false }
GET /todo/{id} -> show one todo with requested id
PUT /todo/{id} -> update todo with requested id, example: { "description": "learn actix and sqlx", "done": true }
DELETE /todo/{id} -> delete todo with requested id
"#
)
}
#[actix_rt::main]
async fn main() -> Result<()> {
dotenv().ok();
env_logger::init();
// this will enable us to keep application running during recompile: systemfd --no-pid -s http::5000 -- cargo watch -x run
let mut listenfd = ListenFd::from_env();
let database_url = env::var("DATABASE_URL").expect("DATABASE_URL is not set in .env file");
// PgPool::builder()
// .max_connections(5) // maximum number of connections in the pool
// .build(env::var("DATABASE_URL")?).await?;
let db_pool = PgPool::new(&database_url).await?;
let mut server = HttpServer::new(move || {
App::new()
.data(db_pool.clone()) // pass database pool to application so we can access it inside handlers
.route("/", web::get().to(index))
.configure(todo::init) // init todo routes
});
server = match listenfd.take_tcp_listener(0)? {
Some(listener) => server.listen(listener)?,
None => {
let host = env::var("HOST").expect("HOST is not set in .env file");
let port = env::var("PORT").expect("PORT is not set in .env file");
server.bind(format!("{}:{}", host, port))?
}
};
info!("Starting server");
server.run().await?;
Ok(())
}
// export DATABASE_URL="postgres://pguser:zx@192.168.33.11/realworld"
// systemfd --no-pid -s http::5000 -- cargo watch -x run

View file

@ -1,5 +0,0 @@
mod model;
mod routes;
pub use model::*;
pub use routes::init;

View file

@ -1,130 +0,0 @@
use serde::{Serialize, Deserialize};
use actix_web::{HttpResponse, HttpRequest, Responder, Error};
use futures::future::{ready, Ready};
use sqlx::{PgPool, FromRow, Row};
use sqlx::postgres::PgRow;
use anyhow::Result;
// this struct will use to receive user input
#[derive(Serialize, Deserialize)]
pub struct TodoRequest {
pub description: String,
pub done: bool
}
// this struct will be used to represent database record
#[derive(Serialize, FromRow)]
pub struct Todo {
pub id: i32,
pub description: String,
pub done: bool,
}
// implementation of Actix Responder for Todo struct so we can return Todo from action handler
impl Responder for Todo {
type Error = Error;
type Future = Ready<Result<HttpResponse, Error>>;
fn respond_to(self, _req: &HttpRequest) -> Self::Future {
let body = serde_json::to_string(&self).unwrap();
// create response and set content type
ready(Ok(
HttpResponse::Ok()
.content_type("application/json")
.body(body)
))
}
}
// Implementation for Todo struct, functions for read/write/update and delete todo from database
impl Todo {
pub async fn find_all(pool: &PgPool) -> Result<Vec<Todo>> {
let mut todos = vec![];
let recs = sqlx::query!(
r#"
SELECT id, description, done
FROM todos
ORDER BY id
"#
)
.fetch_all(pool)
.await?;
for rec in recs {
todos.push(Todo {
id: rec.id,
description: rec.description,
done: rec.done
});
}
Ok(todos)
}
pub async fn find_by_id(id: i32, pool: &PgPool) -> Result<Todo> {
let rec = sqlx::query!(
r#"
SELECT * FROM todos WHERE id = $1
"#,
id
)
.fetch_one(&*pool)
.await?;
Ok(Todo {
id: rec.id,
description: rec.description,
done: rec.done
})
}
pub async fn create(todo: TodoRequest, pool: &PgPool) -> Result<Todo> {
let mut tx = pool.begin().await?;
let todo = sqlx::query("INSERT INTO todos (description, done) VALUES ($1, $2) RETURNING id, description, done")
.bind(&todo.description)
.bind(todo.done)
.map(|row: PgRow| {
Todo {
id: row.get(0),
description: row.get(1),
done: row.get(2)
}
})
.fetch_one(&mut tx)
.await?;
tx.commit().await?;
Ok(todo)
}
pub async fn update(id: i32, todo: TodoRequest, pool: &PgPool) -> Result<Todo> {
let mut tx = pool.begin().await.unwrap();
let todo = sqlx::query("UPDATE todos SET description = $1, done = $2 WHERE id = $3 RETURNING id, description, done")
.bind(&todo.description)
.bind(todo.done)
.bind(id)
.map(|row: PgRow| {
Todo {
id: row.get(0),
description: row.get(1),
done: row.get(2)
}
})
.fetch_one(&mut tx)
.await?;
tx.commit().await.unwrap();
Ok(todo)
}
pub async fn delete(id: i32, pool: &PgPool) -> Result<u64> {
let mut tx = pool.begin().await?;
let deleted = sqlx::query("DELETE FROM todos WHERE id = $1")
.bind(id)
.execute(&mut tx)
.await?;
tx.commit().await?;
Ok(deleted)
}
}

View file

@ -1,63 +0,0 @@
use crate::todo::{Todo, TodoRequest};
use actix_web::{delete, get, post, put, web, HttpResponse, Responder};
use sqlx::PgPool;
#[get("/todos")]
async fn find_all(db_pool: web::Data<PgPool>) -> impl Responder {
let result = Todo::find_all(db_pool.get_ref()).await;
match result {
Ok(todos) => HttpResponse::Ok().json(todos),
_ => HttpResponse::BadRequest().body("Error trying to read all todos from database")
}
}
#[get("/todo/{id}")]
async fn find(id: web::Path<i32>, db_pool: web::Data<PgPool>) -> impl Responder {
let result = Todo::find_by_id(id.into_inner(), db_pool.get_ref()).await;
match result {
Ok(todo) => HttpResponse::Ok().json(todo),
_ => HttpResponse::BadRequest().body("Todo not found")
}
}
#[post("/todo")]
async fn create(todo: web::Json<TodoRequest>, db_pool: web::Data<PgPool>) -> impl Responder {
let result = Todo::create(todo.into_inner(), db_pool.get_ref()).await;
match result {
Ok(todo) => HttpResponse::Ok().json(todo),
_ => HttpResponse::BadRequest().body("Error trying to create new todo")
}
}
#[put("/todo/{id}")]
async fn update(id: web::Path<i32>, todo: web::Json<TodoRequest>, db_pool: web::Data<PgPool>) -> impl Responder {
let result = Todo::update(id.into_inner(), todo.into_inner(),db_pool.get_ref()).await;
match result {
Ok(todo) => HttpResponse::Ok().json(todo),
_ => HttpResponse::BadRequest().body("Todo not found")
}
}
#[delete("/todo/{id}")]
async fn delete(id: web::Path<i32>, db_pool: web::Data<PgPool>) -> impl Responder {
let result = Todo::delete(id.into_inner(), db_pool.get_ref()).await;
match result {
Ok(rows) => {
if rows > 0 {
HttpResponse::Ok().body(format!("Successfully deleted {} record(s)", rows))
} else {
HttpResponse::BadRequest().body("Todo not found")
}
},
_ => HttpResponse::BadRequest().body("Todo not found")
}
}
// function that will be called on new Application to configure routes for this module
pub fn init(cfg: &mut web::ServiceConfig) {
cfg.service(find_all);
cfg.service(find);
cfg.service(create);
cfg.service(update);
cfg.service(delete);
}