Skip to content

Task Management system #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 160 additions & 0 deletions api-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Task API Documentation

# List Tasks

**Endpoint**: `GET /api/v1/tasks`

Retrieves a paginated list of tasks.

## Authentication

Bearer Token required

## Query Parameters

| Parameter | Type | Required | Default | Description |
|-----------|---------|----------|---------|------------------|
| page | integer | No | 1 | Page number |
| perPage | integer | No | 10 | Items per page |
| sortBy | string | No | id | Field to sort by |
| sortType | string | No | asc | Sort direction |

## Example Request

```http
GET /api/v1/tasks?perPage=10&page=1&sortBy=id&sortType=asc
Authorization: Bearer <your_token>
```

# Get Single Task

**Endpoint**: `GET /api/v1/tasks/{id}`

Retrieves a single task by ID.

## Authentication

Bearer Token required

## Example Request

```http
GET /api/v1/tasks/2
Authorization: Bearer <your_token>
```

# Create Task

**Endpoint**: `POST /api/v1/tasks`

Creates a new task.

## Authentication

Bearer Token required

## Request Body (form-data)

| Parameter | Type | Required | Default | Constraints |
|----------------|---------|----------|---------|-----------------------------------|
| board_id | integer | No | 1 | |
| task_status_id | integer | No | 1 | |
| title | string | Yes | - | |
| description | string | No | - | |
| start_date | string | No | - | Format: Y-m-d H:i |
| due_date | string | No | - | Must be after or equal start_date |

## Example Request

```http
POST /api/v1/tasks
Authorization: Bearer <your_token>
Content-Type: multipart/form-data

title: GÖREV 1
start_date: 2025-04-06 15:00
due_date: 2025-04-06 18:00
board_id: 1
task_status_id: 1
description: GÖREV 1 AÇIKLAMASI
```

# Update Task

**Endpoint**: `PUT /api/v1/tasks/{id}`

Updates an existing task.

## Authentication

Bearer Token required

## Request Body (form-data)

| Parameter | Type | Required | Constraints |
|-------------|--------|----------|-----------------------------------|
| title | string | No | |
| description | string | No | |
| start_date | string | No | Format: Y-m-d H:i |
| due_date | string | No | Must be after or equal start_date |

## Example Request

```http
PUT /api/v1/tasks/1
Authorization: Bearer <your_token>
Content-Type: multipart/form-data

title: Updated Task
due_date: 2025-04-06 18:30
description: Updated description
```

# Delete Task

**Endpoint**: `DELETE /api/v1/tasks/{id}`

Deletes a task with optional recovery.

## Authentication

Bearer Token required

## Query Parameters

| Parameter | Type | Required | Description |
|-------------|---------|----------|----------------------|
| is_recovery | boolean | No | Enable recovery mode |

## Example Request

```http
DELETE /api/v1/tasks/1?is_recovery=true
Authorization: Bearer <your_token>
```

# Change Task Status

**Endpoint**: `PATCH /api/v1/tasks/{id}/status-change`

Updates a task's status.

## Authentication

Bearer Token required

## Request Body (x-www-form-urlencoded)

| Parameter | Type | Required | Description |
|-----------|---------|----------|---------------|
| status_id | integer | Yes | New status ID |

## Example Request

```http
PATCH /api/v1/tasks/2/status-change
Authorization: Bearer <your_token>
Content-Type: application/x-www-form-urlencoded

status_id=2
```
25 changes: 25 additions & 0 deletions app/Board.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

namespace App;

use App\Observers\BoardObserver as Observer;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Board extends Model
{
use SoftDeletes;

protected $table = 'boards';

protected $fillable = [
'name'
];

public static function boot(): void
{
parent::boot();

parent::observe(Observer::class);
}
}
36 changes: 36 additions & 0 deletions app/BoardAssignment.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

namespace App;

use App\Observers\BoardAssignmentObserver as Observer;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class BoardAssignment extends Model
{
use SoftDeletes;

protected $table = 'board_assignments';

protected $fillable = [
'user_id',
'board_id'
];

public static function boot(): void
{
parent::boot();

parent::observe(Observer::class);
}

public function user(): \Illuminate\Database\Eloquent\Relations\BelongsTo
{
return $this->belongsTo(User::class);
}

public function board(): \Illuminate\Database\Eloquent\Relations\BelongsTo
{
return $this->belongsTo(Board::class);
}
}
7 changes: 5 additions & 2 deletions app/Console/Kernel.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace App\Console;

use App\Jobs\TaskStartJob;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

Expand All @@ -19,14 +20,16 @@ class Kernel extends ConsoleKernel
/**
* Define the application's command schedule.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
$schedule->command('backup:clean')->daily()->at('00:00');

$schedule->command('backup:run')->daily()->at('01:00');

$schedule->job(TaskStartJob::class)->everyFiveMinutes();
}

/**
Expand All @@ -36,7 +39,7 @@ protected function schedule(Schedule $schedule)
*/
protected function commands()
{
$this->load(__DIR__.'/Commands');
$this->load(__DIR__ . '/Commands');

require base_path('routes/console.php');
}
Expand Down
138 changes: 138 additions & 0 deletions app/Http/Controllers/Api/V1/TaskCTRL.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
<?php

namespace App\Http\Controllers\Api\V1;

use App\Http\Controllers\Controller;
use App\Http\Requests\Api\V1\TaskRequest;
use App\Task as Model;
use Carbon\Carbon;
use Exception;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache;

class TaskCTRL extends Controller
{
public function index(Request $request): JsonResponse
{
$perPage = $request->get('perPage', 10);
$sortBy = $request->get('sortBy', 'id');
$sortType = $request->get('sortType', 'asc');

$cacheKey = "tasks_{$perPage}_{$sortBy}_{$sortType}";

$tasks = Cache::remember($cacheKey, now()->addMinutes(10), function () use ($sortBy, $sortType, $perPage) {
return Model::withTrashed()->with('task_status')->orderBy($sortBy, $sortType)->paginate($perPage);
});

return response()->json([
'success' => true,
'message' => 'Task index',
'data' => $tasks,
]);
}

public function getAll(): JsonResponse
{
$tasks = Model::with([
'task_status',
'board',
'user',
'task_reviewers'
])->get();

return response()->json([
'success' => true,
'message' => 'Task index',
'data' => $tasks,
]);
}

public function show($id): JsonResponse
{
$task = Model::with([
'task_status',
'board',
'user',
'task_reviewers'
])->findOrFail($id);
return response()->json([
'success' => true,
'message' => 'Task show',
'data' => $task,
]);
}

public function store(TaskRequest $request): JsonResponse
{
$task = new Model();
$task->fill($request->toArray());
$task->user_id = auth()->user()->id;
$task->start_date = $request->input('start_date') ? (Carbon::parse($request->input('start_date'))->format('Y-m-d H:i:s')) : null;
$task->due_date = $request->input('due_date') ? (Carbon::parse($request->input('due_date'))->format('Y-m-d H:i:s')) : null;
$task->save();

return response()->json([
'success' => true,
'message' => 'Task created',
'data' => $task,
]);
}

public function update(TaskRequest $request, $id): JsonResponse
{
$task = Model::findOrFail($id);
$task->fill($request->toArray());
$task->user_id = auth()->user()->id;
$task->start_date = $request->input('start_date') ? (Carbon::parse($request->input('start_date'))->format('Y-m-d H:i:s')) : null;
$task->due_date = $request->input('due_date') ? (Carbon::parse($request->input('due_date'))->format('Y-m-d H:i:s')) : null;
$task->update();

return response()->json([
'success' => true,
'message' => 'Task updated',
'data' => $task,
]);
}

/**
* @throws Exception
*/
public function destroy($id): JsonResponse
{
$task = Model::withTrashed()->findOrFail($id);

if (request()->input('is_recovery') === 'true') {
$task->restore();
return response()->json([
'success' => true,
'message' => 'Task restored',
'data' => $task,
]);
}

$task->delete();
return response()->json([
'success' => true,
'message' => 'Task deleted',
'data' => null,
]);
}

public function statusChange($id, Request $request): JsonResponse
{
$request->validate([
'status_id' => 'required|int|exists:task_statuses,id',
]);

$task = Model::findOrFail($id);
$task->task_status_id = $request->input('status_id');
$task->save();

return response()->json([
'success' => true,
'message' => 'Task status changed',
'data' => $task,
]);
}
}
Loading