Added client and organization endpoints

This commit is contained in:
Constantin Graf
2024-03-01 16:34:26 +01:00
parent a86e72f655
commit e8912650c0
18 changed files with 679 additions and 17 deletions

View File

@@ -0,0 +1,88 @@
<?php
declare(strict_types=1);
namespace App\Http\Controllers\Api\V1;
use App\Http\Requests\V1\Tag\TagStoreRequest;
use App\Http\Requests\V1\Tag\TagUpdateRequest;
use App\Http\Resources\V1\Client\ClientCollection;
use App\Http\Resources\V1\Client\ClientResource;
use App\Models\Client;
use App\Models\Organization;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Http\JsonResponse;
class ClientController extends Controller
{
protected function checkPermission(Organization $organization, string $permission, ?Client $client = null): void
{
parent::checkPermission($organization, $permission);
if ($client !== null && $client->organization_id !== $organization->getKey()) {
throw new AuthorizationException('Tag does not belong to organization');
}
}
/**
* Get clients
*
* @throws AuthorizationException
*/
public function index(Organization $organization): ClientCollection
{
$this->checkPermission($organization, 'clients:view');
$clients = Client::query()
->whereBelongsTo($organization, 'organization')
->orderBy('created_at', 'desc')
->get();
return new ClientCollection($clients);
}
/**
* Create client
*
* @throws AuthorizationException
*/
public function store(Organization $organization, TagStoreRequest $request): ClientResource
{
$this->checkPermission($organization, 'clients:create');
$client = new Client();
$client->name = $request->input('name');
$client->organization()->associate($organization);
$client->save();
return new ClientResource($client);
}
/**
* Update client
*
* @throws AuthorizationException
*/
public function update(Organization $organization, Client $client, TagUpdateRequest $request): ClientResource
{
$this->checkPermission($organization, 'clients:update', $client);
$client->name = $request->input('name');
$client->save();
return new ClientResource($client);
}
/**
* Delete client
*
* @throws AuthorizationException
*/
public function destroy(Organization $organization, Client $client): JsonResponse
{
$this->checkPermission($organization, 'clients:delete', $client);
$client->delete();
return response()->json(null, 204);
}
}

View File

@@ -0,0 +1,40 @@
<?php
declare(strict_types=1);
namespace App\Http\Controllers\Api\V1;
use App\Http\Requests\V1\Organization\OrganizationUpdateRequest;
use App\Http\Resources\V1\Organization\OrganizationResource;
use App\Models\Organization;
use Illuminate\Auth\Access\AuthorizationException;
class OrganizationController extends Controller
{
/**
* Get organization
*
* @throws AuthorizationException
*/
public function show(Organization $organization): OrganizationResource
{
$this->checkPermission($organization, 'organizations:view');
return new OrganizationResource($organization);
}
/**
* Update organization
*
* @throws AuthorizationException
*/
public function update(Organization $organization, OrganizationUpdateRequest $request): OrganizationResource
{
$this->checkPermission($organization, 'organizations:update');
$organization->name = $request->input('name');
$organization->save();
return new OrganizationResource($organization);
}
}

View File

@@ -64,6 +64,7 @@ class ProjectController extends Controller
$project = new Project();
$project->name = $request->input('name');
$project->color = $request->input('color');
$project->client_id = $request->input('client_id');
$project->organization()->associate($organization);
$project->save();

View File

@@ -0,0 +1,31 @@
<?php
declare(strict_types=1);
namespace App\Http\Requests\V1\Organization;
use App\Models\Organization;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Foundation\Http\FormRequest;
/**
* @property Organization $organization Organization from model binding
*/
class OrganizationUpdateRequest extends FormRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, array<string|ValidationRule>>
*/
public function rules(): array
{
return [
'name' => [
'required',
'string',
'max:255',
],
];
}
}

View File

@@ -4,9 +4,16 @@ declare(strict_types=1);
namespace App\Http\Requests\V1\Project;
use App\Models\Client;
use App\Models\Organization;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Foundation\Http\FormRequest;
use Korridor\LaravelModelValidationRules\Rules\ExistsEloquent;
/**
* @property Organization $organization Organization from model binding
*/
class ProjectStoreRequest extends FormRequest
{
/**
@@ -28,6 +35,13 @@ class ProjectStoreRequest extends FormRequest
'string',
'max:255',
],
'client_id' => [
'nullable',
new ExistsEloquent(Client::class, null, function (Builder $builder): Builder {
/** @var Builder<Client> $builder */
return $builder->whereBelongsTo($this->organization, 'organization');
}),
],
];
}
}

View File

@@ -4,9 +4,16 @@ declare(strict_types=1);
namespace App\Http\Requests\V1\Project;
use App\Models\Client;
use App\Models\Organization;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Foundation\Http\FormRequest;
use Korridor\LaravelModelValidationRules\Rules\ExistsEloquent;
/**
* @property Organization $organization Organization from model binding
*/
class ProjectUpdateRequest extends FormRequest
{
/**
@@ -27,6 +34,13 @@ class ProjectUpdateRequest extends FormRequest
'string',
'max:255',
],
'client_id' => [
'nullable',
new ExistsEloquent(Client::class, null, function (Builder $builder): Builder {
/** @var Builder<Client> $builder */
return $builder->whereBelongsTo($this->organization, 'organization');
}),
],
];
}
}

View File

@@ -0,0 +1,17 @@
<?php
declare(strict_types=1);
namespace App\Http\Resources\V1\Client;
use Illuminate\Http\Resources\Json\ResourceCollection;
class ClientCollection extends ResourceCollection
{
/**
* The resource that this resource collects.
*
* @var string
*/
public $collects = ClientResource::class;
}

View File

@@ -0,0 +1,34 @@
<?php
declare(strict_types=1);
namespace App\Http\Resources\V1\Client;
use App\Http\Resources\V1\BaseResource;
use App\Models\Client;
use Illuminate\Http\Request;
/**
* @property Client $resource
*/
class ClientResource extends BaseResource
{
/**
* Transform the resource into an array.
*
* @return array<string, string|bool|int|null>
*/
public function toArray(Request $request): array
{
return [
/** @var string $id ID */
'id' => $this->resource->id,
/** @var string $name Name */
'name' => $this->resource->name,
/** @var string $created_at When the tag was created */
'created_at' => $this->formatDateTime($this->resource->created_at),
/** @var string $updated_at When the tag was last updated */
'updated_at' => $this->formatDateTime($this->resource->updated_at),
];
}
}

View File

@@ -0,0 +1,32 @@
<?php
declare(strict_types=1);
namespace App\Http\Resources\V1\Organization;
use App\Http\Resources\V1\BaseResource;
use App\Models\Organization;
use Illuminate\Http\Request;
/**
* @property Organization $resource
*/
class OrganizationResource extends BaseResource
{
/**
* Transform the resource into an array.
*
* @return array<string, string|bool|int|null>
*/
public function toArray(Request $request): array
{
return [
/** @var string $id ID */
'id' => $this->resource->id,
/** @var string $name Name */
'name' => $this->resource->name,
/** @var string $color Personal organizations automatically created after registration */
'is_personal' => $this->resource->personal_team,
];
}
}

View File

@@ -9,13 +9,15 @@ use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Carbon;
/**
* @property string $id
* @property string $name
* @property string $organization_id
* @property string $created_at
* @property string $updated_at
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
* @property-read Organization $organization
*
* @method static ClientFactory factory()
@@ -41,4 +43,12 @@ class Client extends Model
{
return $this->belongsTo(Organization::class, 'organization_id');
}
/**
* @return HasMany<Project>
*/
public function projects(): HasMany
{
return $this->hasMany(Project::class, 'client_id');
}
}

View File

@@ -15,6 +15,8 @@ use Laravel\Jetstream\Team as JetstreamTeam;
/**
* @property string $id
* @property string $name
* @property bool $personal_team
* @property User $owner
*
* @method HasMany<OrganizationInvitation> teamInvitations()
@@ -31,6 +33,7 @@ class Organization extends JetstreamTeam
* @var array<string, string>
*/
protected $casts = [
'name' => 'string',
'personal_team' => 'boolean',
];

View File

@@ -68,6 +68,12 @@ class JetstreamServiceProvider extends ServiceProvider
'tags:create',
'tags:update',
'tags:delete',
'clients:view',
'clients:create',
'clients:update',
'clients:delete',
'organizations:view',
'organizations:update',
])->description('Administrator users can perform any action.');
Jetstream::role('manager', 'Manager', [
@@ -87,6 +93,7 @@ class JetstreamServiceProvider extends ServiceProvider
'tags:create',
'tags:update',
'tags:delete',
'organizations:view',
])->description('Editor users have the ability to read, create, and update.');
Jetstream::role('employee', 'Employee', [
@@ -96,6 +103,7 @@ class JetstreamServiceProvider extends ServiceProvider
'time-entries:create:own',
'time-entries:update:own',
'time-entries:delete:own',
'organizations:view',
])->description('Editor users have the ability to read, create, and update.');
}
}