add status and status_changed_at

Author: calebbourg

docs/db/refactor_platform_rs.dbml

@@ -66,6 +66,8 @@ Table refactor_platform.agreements {
   coaching_session_id uuid [not null]
   details varchar [note: 'Either a short or long description of an agreement reached between coach and coachee in a coaching session']
   user_id uuid [not null, note: 'User that created (owns) the agreement']
+  status status [not null]
+  status_changed_at timestamptz
   created_at timestamptz [not null, default: `now()`]
   updated_at timestamptz [not null, default: `now()`, note: 'The last date and time an overarching agreement\'s fields were changed']
 }
@@ -77,12 +79,18 @@ Table refactor_platform.actions {
   // its due_by is passed or it was completed by the coachee
   coaching_session_id uuid [not null]
   due_by timestamptz
-  completed boolean // May be unnecessary if there's a valid completed_at timestamp
-  completed_at timestamptz
+  status status [not null]
+  status_changed_at timestamptz
   created_at timestamp [not null, default: `now()`]
   updated_at timestamp [not null, default: `now()`]
 }
 
+enum status {
+  in_progress
+  completed
+  wont_do
+}
+
 // coaching_relationships relationships
 Ref: refactor_platform.coaching_relationships.organization_id > refactor_platform.organizations.id
 Ref: refactor_platform.coaching_relationships.coachee_id > refactor_platform.users.id

entity/src/actions.rs

@@ -1,6 +1,6 @@
 //! `SeaORM` Entity. Generated by sea-orm-codegen 0.12.3
 
-use crate::Id;
+use crate::{status, Id};
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 
@@ -13,6 +13,8 @@ pub struct Model {
     pub due_by: Option<DateTimeWithTimeZone>,
     pub completed: Option<bool>,
     pub completed_at: Option<DateTimeWithTimeZone>,
+    pub status: status::Status,
+    pub status_changed_at: Option<DateTimeWithTimeZone>,
     pub created_at: DateTimeWithTimeZone,
     pub updated_at: DateTimeWithTimeZone,
 }

entity/src/agreements.rs

@@ -1,6 +1,6 @@
 //! `SeaORM` Entity. Generated by sea-orm-codegen 0.12.3
 
-use crate::Id;
+use crate::{status, Id};
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 use utoipa::ToSchema;
@@ -17,6 +17,10 @@ pub struct Model {
     pub details: Option<String>,
     pub user_id: Id,
     #[serde(skip_deserializing)]
+    pub status: status::Status,
+    #[serde(skip_deserializing)]
+    pub status_changed_at: Option<DateTimeWithTimeZone>,
+    #[serde(skip_deserializing)]
     pub created_at: DateTimeWithTimeZone,
     #[serde(skip_deserializing)]
     pub updated_at: DateTimeWithTimeZone,

entity/src/lib.rs

@@ -11,6 +11,7 @@ pub mod coaching_sessions;
 pub mod notes;
 pub mod organizations;
 pub mod overarching_goals;
+pub mod status;
 pub mod users;
 
 /// A type alias that represents any Entity's internal id field data type.

entity/src/status.rs

@@ -0,0 +1,19 @@
+use sea_orm::entity::prelude::*;
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, Eq, PartialEq, EnumIter, Deserialize, Serialize, DeriveActiveEnum)]
+#[sea_orm(rs_type = "String", db_type = "Enum", enum_name = "status")]
+pub enum Status {
+    #[sea_orm(string_value = "InProgress")]
+    InProgress,
+    #[sea_orm(string_value = "Completed")]
+    Completed,
+    #[sea_orm(string_value = "WontDo")]
+    WontDo,
+}
+
+impl std::default::Default for Status {
+    fn default() -> Self {
+        Self::InProgress
+    }
+}

entity_api/src/agreement.rs

@@ -22,6 +22,7 @@ pub async fn create(db: &DatabaseConnection, agreement_model: Model) -> Result<M
         user_id: Set(agreement_model.user_id),
         created_at: Set(now.into()),
         updated_at: Set(now.into()),
+        status_changed_at: Set(None),
         ..Default::default()
     };
 
@@ -40,6 +41,8 @@ pub async fn update(db: &DatabaseConnection, id: Id, model: Model) -> Result<Mod
                 coaching_session_id: Unchanged(agreement.coaching_session_id),
                 details: Set(model.details),
                 user_id: Unchanged(agreement.user_id),
+                status: Unchanged(agreement.status),
+                status_changed_at: Unchanged(agreement.status_changed_at),
                 updated_at: Set(chrono::Utc::now().into()),
                 created_at: Unchanged(agreement.created_at),
             };

migration/src/refactor_platform_rs.sql

@@ -1,8 +1,14 @@
 -- SQL dump generated using DBML (dbml-lang.org)
 -- Database: PostgreSQL
--- Generated at: 2024-06-28T21:45:29.597Z
+-- Generated at: 2024-08-09T12:23:43.194Z
 
 
+CREATE TYPE "status" AS ENUM (
+  'in_progress',
+  'completed',
+  'wont_do'
+);
+
 CREATE TABLE "refactor_platform"."organizations" (
   "id" uuid UNIQUE PRIMARY KEY NOT NULL DEFAULT (gen_random_uuid()),
   "name" varchar NOT NULL,
@@ -66,6 +72,8 @@ CREATE TABLE "refactor_platform"."agreements" (
   "coaching_session_id" uuid NOT NULL,
   "details" varchar,
   "user_id" uuid NOT NULL,
+  "status" status NOT NULL,
+  "status_changed_at" timestamptz,
   "created_at" timestamptz NOT NULL DEFAULT (now()),
   "updated_at" timestamptz NOT NULL DEFAULT (now())
 );
@@ -74,8 +82,8 @@ CREATE TABLE "refactor_platform"."actions" (
   "id" uuid UNIQUE PRIMARY KEY NOT NULL DEFAULT (gen_random_uuid()),
   "coaching_session_id" uuid NOT NULL,
   "due_by" timestamptz,
-  "completed" boolean,
-  "completed_at" timestamptz,
+  "status" status NOT NULL,
+  "status_changed_at" timestamptz,
   "created_at" timestamp NOT NULL DEFAULT (now()),
   "updated_at" timestamp NOT NULL DEFAULT (now())
 );

web/src/controller/agreement_controller.rs

@@ -45,7 +45,40 @@ pub async fn create(
 
     debug!("New Agreement: {:?}", agreement);
 
-    Ok(Json(ApiResponse::new(StatusCode::CREATED.into(), agreement)))
+    Ok(Json(ApiResponse::new(
+        StatusCode::CREATED.into(),
+        agreement,
+    )))
+}
+
+/// GET a particular Agreement specified by its id.
+#[utoipa::path(
+    get,
+    path = "/agreements/{id}",
+    params(
+        ApiVersion,
+        ("id" = String, Path, description = "Agreement id to retrieve")
+    ),
+    responses(
+        (status = 200, description = "Successfully retrieved a specific Agreement by its id", body = [entity::notes::Model]),
+        (status = 401, description = "Unauthorized"),
+        (status = 404, description = "Note not found"),
+        (status = 405, description = "Method not allowed")
+    ),
+    security(
+        ("cookie_auth" = [])
+    )
+)]
+pub async fn read(
+    CompareApiVersion(_v): CompareApiVersion,
+    State(app_state): State<AppState>,
+    Path(id): Path<Id>,
+) -> Result<impl IntoResponse, Error> {
+    debug!("GET Agreement by id: {}", id);
+
+    let note: Option<Model> = AgreementApi::find_by_id(app_state.db_conn_ref(), id).await?;
+
+    Ok(Json(ApiResponse::new(StatusCode::OK.into(), note)))
 }
 
 #[utoipa::path(
@@ -114,8 +147,5 @@ pub async fn index(
 
     debug!("Found Agreements: {:?}", agreements);
 
-    Ok(Json(ApiResponse::new(
-        StatusCode::OK.into(),
-        agreements,
-    )))
+    Ok(Json(ApiResponse::new(StatusCode::OK.into(), agreements)))
 }

web/src/router.rs

@@ -8,8 +8,8 @@ use entity_api::user::Backend;
 use tower_http::services::ServeDir;
 
 use crate::controller::{
-    agreement_controller, coaching_session_controller, note_controller, organization, organization_controller,
-    user_session_controller,
+    agreement_controller, coaching_session_controller, note_controller, organization,
+    organization_controller, user_session_controller,
 };
 
 use utoipa::{
@@ -29,6 +29,7 @@ use utoipa_rapidoc::RapiDoc;
             agreement_controller::create,
             agreement_controller::update,
             agreement_controller::index,
+            agreement_controller::read,
             note_controller::create,
             note_controller::update,
             note_controller::index,
@@ -108,6 +109,7 @@ fn agreement_routes(app_state: AppState) -> Router {
         .route("/agreements", post(agreement_controller::create))
         .route("/agreements/:id", put(agreement_controller::update))
         .route("/agreements", get(agreement_controller::index))
+        .route("/agreements/:id", get(agreement_controller::read))
         .route_layer(login_required!(Backend, login_url = "/login"))
         .with_state(app_state)
 }