refactor: New file service handler and service

src/handlers/file.rs

@@ -0,0 +1,213 @@
+// Copyright (c) The Amphitheatre Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::sync::Arc;
+
+use axum::extract::{Path, State};
+use axum::http::StatusCode;
+use axum::response::IntoResponse;
+use axum::Json;
+use uuid::Uuid;
+
+use crate::context::Context;
+use crate::errors::Result;
+use crate::requests::file::{DestinationRequest, FileRequest};
+use crate::services::FileService;
+
+// The Files Service Handlers.
+
+/// Returns a file's content.
+#[utoipa::path(
+    get, path = "/v1/playbooks/{id}/files/{reference}/{path}",
+    params(
+        ("id" = Uuid, description = "The id of playbook"),
+        ("reference" = String, description = "The name of the commit/branch/tag."),
+        ("path" = String, description = "The file path relative to the root of the repository."),
+    ),
+    responses(
+        (status = 200, description = "The file content", body = Content),
+        (status = 404, description = "Playbook not found"),
+        (status = 404, description = "File not found"),
+        (status = 500, description = "Internal Server Error"),
+    ),
+    tag = "Files"
+)]
+pub async fn get(
+    State(ctx): State<Arc<Context>>,
+
+    Path(id): Path<Uuid>,
+    Path(reference): Path<String>,
+    Path(path): Path<String>,
+) -> Result<impl IntoResponse> {
+    Ok(Json(FileService::get(ctx, id, reference, path).await?))
+}
+
+/// Create a file
+#[utoipa::path(
+    post, path = "/v1/playbooks/{id}/files/{reference}/{path}",
+    params(
+        ("id" = Uuid, description = "The id of playbook"),
+        ("reference" = String, description = "The name of the commit/branch/tag."),
+        ("path" = String, description = "The file path relative to the root of the repository."),
+    ),
+    request_body(
+        content = inline(FileRequest),
+        description = "Create file request",
+        content_type = "application/json"
+    ),
+    responses(
+        (status = 201, description = "The file created successfully", body = Content),
+        (status = 404, description = "Playbook not found"),
+        (status = 500, description = "Internal Server Error"),
+    ),
+    tag = "Files"
+)]
+pub async fn create(
+    State(ctx): State<Arc<Context>>,
+
+    Path(id): Path<Uuid>,
+    Path(reference): Path<String>,
+    Path(path): Path<String>,
+
+    Json(req): Json<FileRequest>,
+) -> Result<impl IntoResponse> {
+    Ok((StatusCode::CREATED, Json(FileService::create(ctx, id, reference, path, req.content).await?)))
+}
+
+/// Update a file
+#[utoipa::path(
+    put, path = "/v1/playbooks/{id}/files/{reference}/{path}",
+    params(
+        ("id" = Uuid, description = "The id of playbook"),
+        ("reference" = String, description = "The name of the commit/branch/tag. Default: default branch."),
+        ("path" = String, description = "The file path relative to the root of the repository."),
+    ),
+    request_body(
+        content = inline(FileRequest),
+        description = "Update file request",
+        content_type = "application/json"
+    ),
+    responses(
+        (status = 200, description = "The file updated successfully", body = Content),
+        (status = 404, description = "Playbook not found"),
+        (status = 404, description = "File not found"),
+        (status = 500, description = "Internal Server Error"),
+    ),
+    tag = "Files"
+)]
+pub async fn update(
+    State(ctx): State<Arc<Context>>,
+
+    Path(id): Path<Uuid>,
+    Path(reference): Path<String>,
+    Path(path): Path<String>,
+
+    Json(req): Json<FileRequest>,
+) -> Result<impl IntoResponse> {
+    Ok(Json(FileService::update(ctx, id, reference, path, req.content).await?))
+}
+
+/// Delete a file
+#[utoipa::path(
+    delete, path = "/v1/playbooks/{id}/files/{reference}/{path}",
+    params(
+        ("id" = Uuid, description = "The id of playbook"),
+        ("reference" = String, description = "The name of the commit/branch/tag."),
+        ("path" = String, description = "The file path relative to the root of the repository."),
+    ),
+    responses(
+        (status = 204, description = "The file deleted successfully"),
+        (status = 404, description = "Playbook not found"),
+        (status = 404, description = "File not found"),
+        (status = 500, description = "Internal Server Error"),
+    ),
+    tag = "Files"
+)]
+pub async fn delete(
+    State(ctx): State<Arc<Context>>,
+
+    Path(id): Path<Uuid>,
+    Path(reference): Path<String>,
+    Path(path): Path<String>,
+) -> Result<impl IntoResponse> {
+    FileService::delete(ctx, id, reference, path).await?;
+
+    Ok(StatusCode::NO_CONTENT)
+}
+
+/// Copy a file
+#[utoipa::path(
+    post, path = "/v1/playbooks/{id}/files/{reference}/{path}/actions/copy",
+    params(
+        ("id" = Uuid, description = "The id of playbook"),
+        ("reference" = String, description = "The name of the commit/branch/tag. Default: default branch."),
+        ("path" = String, description = "The file path relative to the root of the repository."),
+    ),
+    request_body(
+        content = inline(DestinationRequest),
+        description = "The destination request",
+        content_type = "application/json"
+    ),
+    responses(
+        (status = 200, description = "The file copied successfully", body = Content),
+        (status = 404, description = "Playbook not found"),
+        (status = 404, description = "File not found"),
+        (status = 500, description = "Internal Server Error"),
+    ),
+    tag = "Files"
+)]
+pub async fn copy(
+    State(ctx): State<Arc<Context>>,
+
+    Path(id): Path<Uuid>,
+    Path(reference): Path<String>,
+    Path(path): Path<String>,
+
+    Json(req): Json<DestinationRequest>,
+) -> Result<impl IntoResponse> {
+    Ok(Json(FileService::copy(ctx, id, reference, path, req.destination).await?))
+}
+
+/// Move a file
+#[utoipa::path(
+    post, path = "/v1/playbooks/{id}/files/{reference}/{path}/actions/move",
+    params(
+        ("id" = Uuid, description = "The id of playbook"),
+        ("reference" = String, description = "The name of the commit/branch/tag. Default: default branch."),
+        ("path" = String, description = "The file path relative to the root of the repository."),
+    ),
+    request_body(
+        content = inline(DestinationRequest),
+        description = "The destination request",
+        content_type = "application/json"
+    ),
+    responses(
+        (status = 200, description = "The file moved successfully", body = Content),
+        (status = 404, description = "Playbook not found"),
+        (status = 404, description = "File not found"),
+        (status = 500, description = "Internal Server Error"),
+    ),
+    tag = "Files"
+)]
+pub async fn rename(
+    State(ctx): State<Arc<Context>>,
+
+    Path(id): Path<Uuid>,
+    Path(reference): Path<String>,
+    Path(path): Path<String>,
+
+    Json(req): Json<DestinationRequest>,
+) -> Result<impl IntoResponse> {
+    Ok(Json(FileService::rename(ctx, id, reference, path, req.destination).await?))
+}

src/handlers/logger.rs

@@ -21,7 +21,7 @@ use uuid::Uuid;
 
 use crate::context::Context;
 use crate::errors::Result;
-use crate::services::logger::LoggerService;
+use crate::services::LoggerService;
 
 // The Logging Service Handlers.
 

src/handlers/mod.rs

@@ -12,5 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+pub mod file;
 pub mod logger;
 pub mod playbook;

src/handlers/playbook.rs

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use amp_common::sync::Synchronization;
 use std::sync::Arc;
 
 use axum::extract::{Path, State};
@@ -23,8 +22,8 @@ use uuid::Uuid;
 
 use crate::context::Context;
 use crate::errors::Result;
-use crate::requests::playbook::{CreatePlaybookRequest, GetPlaybookRequest};
-use crate::services::playbook::PlaybookService;
+use crate::requests::playbook::CreatePlaybookRequest;
+use crate::services::PlaybookService;
 
 // The Playbooks Service Handlers.
 
@@ -48,53 +47,6 @@ pub async fn create(
     Ok((StatusCode::CREATED, Json(PlaybookService::create(ctx, &req).await?)))
 }
 
-/// Returns a playbook detail.
-#[utoipa::path(
-    get, path = "/v1/playbooks/{id}/files/{reference}/{path}",
-    params(
-        ("id" = Uuid, description = "The id of playbook"),
-        ("reference" = String, description = "The name of the commit/branch/tag. Default: the repository’s default branch."),
-        ("path" = String, description = "path parameter"),
-    ),
-    responses(
-        (status = 200, description = "Playbook found successfully", body = FilesResponse),
-        (status = 404, description = "Playbook not found"),
-        (status = 500, description = "Internal Server Error"),
-    ),
-    tag = "Playbooks"
-)]
-pub async fn detail(
-    Path(params): Path<GetPlaybookRequest>,
-    State(ctx): State<Arc<Context>>,
-) -> Result<impl IntoResponse> {
-    Ok(Json(PlaybookService::get(ctx, params.id, params.reference, params.path, true).await?))
-}
-/// Update a playbook.
-#[utoipa::path(
-    put, path = "/v1/playbooks/{id}",
-    params(
-        ("id" = Uuid, description = "The id of playbook"),
-    ),
-    request_body(
-        content = inline(Synchronization),
-        description = "Update playbook request",
-        content_type = "application/json"
-    ),
-    responses(
-        (status = 204, description = "Playbook updated successfully", body = PlaybookResponse),
-        (status = 404, description = "Playbook not found")
-    ),
-    tag = "Playbooks"
-)]
-pub async fn update(
-    Path(id): Path<Uuid>,
-    State(ctx): State<Arc<Context>>,
-    Json(req): Json<Synchronization>,
-) -> Result<impl IntoResponse> {
-    PlaybookService::update(ctx, id, req).await?;
-    Ok(StatusCode::NO_CONTENT)
-}
-
 /// Delete a playbook
 #[utoipa::path(
     delete, path = "/v1/playbooks/{id}",
@@ -108,7 +60,7 @@ pub async fn update(
     ),
     tag = "Playbooks"
 )]
-pub async fn delete(Path(id): Path<Uuid>, State(ctx): State<Arc<Context>>) -> Result<impl IntoResponse> {
+pub async fn delete(State(ctx): State<Arc<Context>>, Path(id): Path<Uuid>) -> Result<impl IntoResponse> {
     PlaybookService::delete(ctx, id).await?;
 
     Ok(StatusCode::NO_CONTENT)
@@ -127,7 +79,8 @@ pub async fn delete(Path(id): Path<Uuid>, State(ctx): State<Arc<Context>>) -> Re
     ),
     tag = "Playbooks"
 )]
-pub async fn start(Path(id): Path<Uuid>, State(ctx): State<Arc<Context>>) -> Result<impl IntoResponse> {
+pub async fn start(State(ctx): State<Arc<Context>>, Path(id): Path<Uuid>) -> Result<impl IntoResponse> {
     PlaybookService::start(ctx, id).await?;
+
     Ok(StatusCode::NO_CONTENT)
 }

src/requests/file.rs

@@ -0,0 +1,26 @@
+// Copyright (c) The Amphitheatre Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use serde::{Deserialize, Serialize};
+use utoipa::ToSchema;
+
+#[derive(Debug, Serialize, Deserialize, ToSchema)]
+pub struct FileRequest {
+    pub content: String,
+}
+
+#[derive(Debug, Serialize, Deserialize, ToSchema)]
+pub struct DestinationRequest {
+    pub destination: String,
+}

src/requests/mod.rs

@@ -12,4 +12,5 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+pub mod file;
 pub mod playbook;

src/requests/playbook.rs

@@ -15,24 +15,10 @@
 use amp_common::resource::Preface;
 use serde::{Deserialize, Serialize};
 use utoipa::ToSchema;
-use uuid::Uuid;
 
 #[derive(Debug, Serialize, Deserialize, ToSchema)]
 pub struct CreatePlaybookRequest {
     pub title: String,
     pub description: Option<String>,
     pub preface: Preface,
 }
-
-#[derive(Debug, Serialize, Deserialize, ToSchema)]
-pub struct UpdatePlaybookRequest {
-    pub title: Option<String>,
-    pub description: Option<String>,
-}
-
-#[derive(Debug, Serialize, Deserialize, ToSchema)]
-pub struct GetPlaybookRequest {
-    pub id: Uuid,
-    pub reference: String,
-    pub path: Option<String>,
-}