Added member and invitation endpoints

app/Http/Controllers/Api/V1/InvitationController.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Controllers\Api\V1;
+
+use App\Http\Requests\V1\Invitation\InvitationIndexRequest;
+use App\Http\Requests\V1\Invitation\InvitationStoreRequest;
+use App\Http\Resources\V1\Invitation\InvitationCollection;
+use App\Http\Resources\V1\Invitation\InvitationResource;
+use App\Models\Organization;
+use Illuminate\Auth\Access\AuthorizationException;
+use Illuminate\Http\JsonResponse;
+use Laravel\Jetstream\Contracts\InvitesTeamMembers;
+
+class InvitationController extends Controller
+{
+    /**
+     * List all invitations of an organization
+     *
+     * @return InvitationCollection<InvitationResource>
+     *
+     * @throws AuthorizationException
+     *
+     * @operationId getInvitations
+     */
+    public function index(Organization $organization, InvitationIndexRequest $request): InvitationCollection
+    {
+        $this->checkPermission($organization, 'invitations:view');
+
+        $invitations = $organization->teamInvitations()
+            ->paginate();
+
+        return InvitationCollection::make($invitations);
+    }
+
+    /**
+     * Invite a user to the organization
+     *
+     * @throws AuthorizationException
+     *
+     * @operationId invite
+     */
+    public function store(Organization $organization, InvitationStoreRequest $request): JsonResponse
+    {
+        $this->checkPermission($organization, 'invitations:create');
+
+        app(InvitesTeamMembers::class)->invite(
+            $request->user(),
+            $organization,
+            $request->input('email'),
+            $request->input('role')
+        );
+
+        return response()->json(null, 204);
+    }
+}

app/Http/Controllers/Api/V1/MemberController.php

@@ -6,21 +6,32 @@ namespace App\Http\Controllers\Api\V1;
 
 use App\Exceptions\Api\UserNotPlaceholderApiException;
 use App\Http\Requests\V1\Member\MemberIndexRequest;
-use App\Http\Resources\V1\User\MemberCollection;
-use App\Http\Resources\V1\User\MemberResource;
+use App\Http\Requests\V1\Member\MemberUpdateRequest;
+use App\Http\Resources\V1\Member\MemberCollection;
+use App\Http\Resources\V1\Member\MemberPivotResource;
+use App\Http\Resources\V1\Member\MemberResource;
+use App\Models\Membership;
 use App\Models\Organization;
-use App\Models\User;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
 use Laravel\Jetstream\Contracts\InvitesTeamMembers;
 
 class MemberController extends Controller
 {
+    protected function checkPermission(Organization $organization, string $permission, ?Membership $membership = null): void
+    {
+        parent::checkPermission($organization, $permission);
+        if ($membership !== null && $membership->organization_id !== $organization->id) {
+            throw new AuthorizationException('Member does not belong to organization');
+        }
+    }
+
     /**
      * List all members of an organization
      *
-     * @return MemberCollection<MemberResource>>
+     * @return MemberCollection<MemberPivotResource>>
      *
      * @throws AuthorizationException
      *
@@ -37,15 +48,51 @@ class MemberController extends Controller
     }
 
     /**
-     * Invite a placeholder user to become a member of the organization
+     * Update a member of the organization
+     *
+     * @throws AuthorizationException
+     *
+     * @operationId updateMember
+     */
+    public function update(Organization $organization, Membership $membership, MemberUpdateRequest $request): JsonResource
+    {
+        $this->checkPermission($organization, 'members:update', $membership);
+
+        $membership->billable_rate = $request->input('billable_rate');
+        $membership->role = $request->input('role');
+        $membership->save();
+
+        return new MemberResource($membership);
+    }
+
+    /**
+     * Remove a member of the organization.
+     *
+     * @throws AuthorizationException
+     *
+     * @operationId removeMember
+     */
+    public function destroy(Organization $organization, Membership $membership): JsonResponse
+    {
+        $this->checkPermission($organization, 'members:delete', $membership);
+
+        $membership->delete();
+
+        return response()
+            ->json(null, 204);
+    }
+
+    /**
+     * Invite a placeholder member to become a real member of the organization
      *
      * @throws AuthorizationException|UserNotPlaceholderApiException
      *
      * @operationId invitePlaceholder
      */
-    public function invitePlaceholder(Organization $organization, User $user, Request $request): JsonResponse
+    public function invitePlaceholder(Organization $organization, Membership $membership, Request $request): JsonResponse
     {
-        $this->checkPermission($organization, 'members:invite-placeholder');
+        $this->checkPermission($organization, 'members:invite-placeholder', $membership);
+        $user = $membership->user;
 
         if (! $user->is_placeholder) {
             throw new UserNotPlaceholderApiException();

app/Http/Controllers/Api/V1/ProjectMemberController.php

@@ -4,6 +4,8 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Api\V1;
 
+use App\Exceptions\Api\InactiveUserCanNotBeUsedApiException;
+use App\Exceptions\Api\UserIsAlreadyMemberOfProjectApiException;
 use App\Http\Requests\V1\ProjectMember\ProjectMemberStoreRequest;
 use App\Http\Requests\V1\ProjectMember\ProjectMemberUpdateRequest;
 use App\Http\Resources\V1\ProjectMember\ProjectMemberCollection;
@@ -11,6 +13,7 @@ use App\Http\Resources\V1\ProjectMember\ProjectMemberResource;
 use App\Models\Organization;
 use App\Models\Project;
 use App\Models\ProjectMember;
+use App\Models\User;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\JsonResource;
@@ -51,16 +54,25 @@ class ProjectMemberController extends Controller
     /**
      * Add project member to project
      *
-     * @throws AuthorizationException
+     * @throws AuthorizationException|InactiveUserCanNotBeUsedApiException|UserIsAlreadyMemberOfProjectApiException
      *
      * @operationId createProjectMember
      */
     public function store(Organization $organization, Project $project, ProjectMemberStoreRequest $request): JsonResource
     {
         $this->checkPermission($organization, 'project-members:create', $project);
+
+        $user = User::findOrFail((string) $request->input('user_id'));
+        if ($user->is_placeholder) {
+            throw new InactiveUserCanNotBeUsedApiException();
+        }
+        if (ProjectMember::whereBelongsTo($project, 'project')->whereBelongsTo($user, 'user')->exists()) {
+            throw new UserIsAlreadyMemberOfProjectApiException();
+        }
+
         $projectMember = new ProjectMember();
-        $projectMember->user_id = $request->input('user_id');
         $projectMember->billable_rate = $request->input('billable_rate');
+        $projectMember->user()->associate($user);
         $projectMember->project()->associate($project);
         $projectMember->save();
 

app/Http/Requests/V1/Invitation/InvitationIndexRequest.php

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

app/Http/Requests/V1/Invitation/InvitationStoreRequest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests\V1\Invitation;
+
+use App\Enums\Role;
+use App\Models\Organization;
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+/**
+ * @property Organization $organization
+ */
+class InvitationStoreRequest extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, array<string|ValidationRule|\Illuminate\Contracts\Validation\Rule>>
+     */
+    public function rules(): array
+    {
+        return [
+            'email' => [
+                'required',
+                'email',
+            ],
+            'role' => [
+                'required',
+                'string',
+                // TODO: placeholder role should not be allowed
+                Rule::enum(Role::class),
+            ],
+        ];
+    }
+}

app/Http/Requests/V1/Member/MemberUpdateRequest.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests\V1\Member;
+
+use App\Enums\Role;
+use App\Models\Organization;
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+/**
+ * @property Organization $organization
+ */
+class MemberUpdateRequest extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, array<string|ValidationRule|\Illuminate\Contracts\Validation\Rule>>
+     */
+    public function rules(): array
+    {
+        return [
+            'billable_rate' => [
+                'nullable',
+                'integer',
+                'min:0',
+            ],
+            'role' => [
+                'required',
+                'string',
+                // TODO: placeholder role should not be allowed
+                Rule::enum(Role::class),
+            ],
+        ];
+    }
+}

app/Http/Resources/V1/Invitation/InvitationCollection.php

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

app/Http/Resources/V1/Invitation/InvitationResource.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Resources\V1\Invitation;
+
+use App\Http\Resources\V1\BaseResource;
+use App\Models\OrganizationInvitation;
+use Illuminate\Http\Request;
+
+/**
+ * @property OrganizationInvitation $resource
+ */
+class InvitationResource extends BaseResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @return array<string, string|bool|int|null|array<string>>
+     */
+    public function toArray(Request $request): array
+    {
+        return [
+            /** @var string $id ID of the invitation */
+            'id' => $this->resource->id,
+            /** @var string $email Email */
+            'user_id' => $this->resource->email,
+            /** @var string $role Role */
+            'name' => $this->resource->role,
+        ];
+    }
+}

app/Http/Resources/V1/Member/MemberCollection.php

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

app/Http/Resources/V1/Member/MemberPivotResource.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Http\Resources\V1\User;
+namespace App\Http\Resources\V1\Member;
 
 use App\Http\Resources\V1\BaseResource;
 use App\Models\Membership;
@@ -12,7 +12,7 @@ use Illuminate\Http\Request;
 /**
  * @property User $resource
  */
-class MemberResource extends BaseResource
+class MemberPivotResource extends BaseResource
 {
     /**
      * Transform the resource into an array.
@@ -25,8 +25,10 @@ class MemberResource extends BaseResource
         $membership = $this->resource->getRelationValue('membership');
 
         return [
-            /** @var string $id ID */
-            'id' => $this->resource->id,
+            /** @var string $id ID of membership */
+            'id' => $membership->id,
+            /** @var string $id ID of user */
+            'user_id' => $this->resource->id,
             /** @var string $name Name */
             'name' => $this->resource->name,
             /** @var string $email Email */

app/Http/Resources/V1/Member/MemberResource.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Resources\V1\Member;
+
+use App\Http\Resources\V1\BaseResource;
+use App\Models\Membership;
+use App\Models\User;
+use Illuminate\Http\Request;
+
+/**
+ * @property Membership $resource
+ */
+class MemberResource extends BaseResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @return array<string, string|bool|int|null|array<string>>
+     */
+    public function toArray(Request $request): array
+    {
+        return [
+            /** @var string $id ID of membership */
+            'id' => $this->resource->id,
+            /** @var string $id ID of user */
+            'user_id' => $this->resource->user->id,
+            /** @var string $name Name */
+            'name' => $this->resource->user->name,
+            /** @var string $email Email */
+            'email' => $this->resource->user->email,
+            /** @var string $role Role */
+            'role' => $this->resource->role,
+            /** @var bool $is_placeholder Placeholder user for imports, user might not really exist and does not know about this placeholder membership */
+            'is_placeholder' => $this->resource->user->is_placeholder,
+            /** @var int|null $billable_rate Billable rate in cents per hour */
+            'billable_rate' => $this->resource->billable_rate,
+        ];
+    }
+}

app/Http/Resources/V1/User/MemberCollection.php

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