274 be refactor model binding student languages endpoint

app/Annotations/OpenApi/Controllers/StudentResume/StudentLanguagesDetailAnnotation.php

@@ -10,7 +10,7 @@ class StudentLanguagesDetailAnnotation
 {
     /**
      * @OA\Get(
-     *      path="/student/{studentId}/resume/languages",
+     *      path="/student/{student}/resume/languages",
      *      operationId="getStudentResumeLanguages",
      *      tags={"Student -> Resume"},
      *      summary="Gets the languages spoken by a student",
@@ -19,7 +19,7 @@ class StudentLanguagesDetailAnnotation
 It returns a list of languages along with any other relevant information, such as the proficiency level in each language.",
      *
      *      @OA\Parameter(
-     *          name="studentId",
+     *          name="student",
      *          description="Student ID",
      *          required=true,
      *          in="path",
@@ -39,19 +39,19 @@ class StudentLanguagesDetailAnnotation
      *                  @OA\Items(
      *                      type="object",
      *                      @OA\Property(
-     *                          property="language_id",
+     *                          property="id",
      *                          type="string",
      *                          description="Language UUID",
      *                          example="e6b4432b-d2f8-4e06-b727-6ecaf40e6e0e"
      *                      ),
      *                      @OA\Property(
-     *                          property="language_name",
+     *                          property="name",
      *                          type="string",
      *                          description="Language name",
      *                          example="Anglès"
      *                      ),
      *                      @OA\Property(
-     *                          property="language_level",
+     *                          property="level",
      *                          type="string",
      *                          description="The student's proficiency level in the language",
      *                          example="Bàsic"
@@ -65,8 +65,7 @@ class StudentLanguagesDetailAnnotation
         *     description="Student or Resume not found",
         *     @OA\JsonContent(
         *         type="object",
-        *         @OA\Property(property="message", type="string", example="No s'ha trobat cap estudiant amb aquest ID {studentId}"),
-        *         @OA\Property(property="message2", type="string", example="No s'ha trobat cap currículum per a l'estudiant amb id: {studentId}")
+        *         @OA\Property(property="message", type="string", example="No query results for model [App\Models\Student] {studentId}"),
         *     )
      *     ),
      *     @OA\Response(

app/Annotations/OpenApi/Controllers/StudentResume/UpdateStudentLanguagesAnnotation.php

@@ -30,12 +30,12 @@ class UpdateStudentLanguagesAnnotation
      *         @OA\JsonContent(
      *             type="object",
      *             @OA\Property(
-     *                 property="language_name",
+     *                 property="name",
      *                 type="string",
      *                 example="Català"
      *             ),
      *             @OA\Property(
-     *                 property="language_level",
+     *                 property="level",
      *                 type="string",
      *                 enum={"Bàsic", "Intermedi", "Avançat", "Natiu"},
      *                 example="Intermedi"

app/Http/Controllers/api/Student/StudentLanguagesDetailController.php

@@ -1,34 +1,18 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Http\Controllers\api\Student;
 
-use Exception;
 use App\Http\Controllers\Controller;
-use App\Service\Student\StudentLanguageDetailService;
-use App\Exceptions\StudentNotFoundException;
-use App\Exceptions\ResumeNotFoundException;
+use App\Http\Resources\LanguageCollection;
+use App\Models\Student;
 use Illuminate\Http\JsonResponse;
 
 class StudentLanguagesDetailController extends Controller
 {
-    private StudentLanguageDetailService $studentLanguageDetailService;
-
-    public function __construct(StudentLanguageDetailService $studentLanguageDetailService)
-    {
-        $this->studentLanguageDetailService = $studentLanguageDetailService;
-    }
-
-    public function __invoke(string $studentId): JsonResponse
+    public function __invoke(Student $student): JsonResponse
     {
-        try {
-            $service = $this->studentLanguageDetailService->execute($studentId);
-            return response()->json(['languages' => $service]);
-        } catch (StudentNotFoundException | ResumeNotFoundException $e) {
-            return response()->json(['message' => $e->getMessage()], $e->getCode());
-        } catch (Exception $e) {
-            return response()->json(['message' => $e->getMessage()], $e->getCode() ?: 500);
-        }
+        $languages = $student->resume?->languages ?? collect();
+        return response()->json(new LanguageCollection($languages));
     }
 }

app/Http/Controllers/api/Student/UpdateStudentLanguagesController.php

@@ -29,7 +29,7 @@ public function __invoke(string $studentId, UpdateStudentLanguagesRequest $reque
 
             $resume = $this->updateStudentLanguagesService->findStudentResume($student);
 
-            if ($this->updateStudentLanguagesService->updateStudentLanguage($resume, $data['language_name'], $data['language_level'])) {
+            if ($this->updateStudentLanguagesService->updateStudentLanguage($resume, $data['name'], $data['level'])) {
                 return response()->json(['message' => 'Language updated successfully']);
             } else {
                 return response()->json(['message' => 'Language not found for this student'], 404);

app/Http/Requests/UpdateStudentLanguagesRequest.php

@@ -9,8 +9,8 @@ class UpdateStudentLanguagesRequest extends FormRequest
     public function rules(): array
     {
         return [
-            'language_name' => 'required|exists:languages,language_name',
-            'language_level' => 'required|in:Bàsic,Intermedi,Avançat,Natiu'
+            'name' => 'required|exists:languages,name',
+            'level' => 'required|in:Bàsic,Intermedi,Avançat,Natiu'
         ];
     }
 }

app/Http/Resources/LanguageCollection.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+
+class LanguageCollection extends ResourceCollection
+{
+    /**
+     * Transform the resource collection into an array.
+     *
+     * @return array<int|string, mixed>
+     */
+    public function toArray(Request $request): array
+    {
+        return [
+            'languages' => $this->collection->map(function ($language): array {
+                return [
+                    'id' => $language->id,
+                    'name' => $language->name,
+                    'level' => $language->level
+                ];
+            })
+        ];
+    }
+}

app/Service/Student/UpdateStudentLanguagesService.php

@@ -47,12 +47,12 @@ public function getResumeLanguages($resume)
     public function findLanguageByNameAndLevel(string $languageName, string $languageLevel): Language
     {
         try {
-            $language = Language::where('language_name', $languageName)
-                ->where('language_level', $languageLevel)
+            $language = Language::where('name', $languageName)
+                ->where('level', $languageLevel)
                 ->firstOrFail();
             return $language;
         } catch (ModelNotFoundException $e) {
-            Log::error('Language not found', ['language_name' => $languageName, 'language_level' => $languageLevel, 'error' => $e->getMessage()]);
+            Log::error('Language not found', ['name' => $languageName, 'level' => $languageLevel, 'error' => $e->getMessage()]);
             throw new ModelNotFoundException('Language not found');
         }
     }
@@ -64,7 +64,7 @@ public function updateStudentLanguage($resume, $languageName, $languageLevel): b
             $languagesToUpdate = $this->getResumeLanguages($resume);
 
             foreach ($languagesToUpdate as $languageToUpdate) {
-                if ($languageToUpdate->language_name === $languageName) {
+                if ($languageToUpdate->name === $languageName) {
                     $resume->languages()->updateExistingPivot($languageToUpdate->id, ['language_id' => $newLanguage->id]);
                     return true;
                 }

database/migrations/2024_10_02_133940_change_columns_names_to_name_and_level_in_languages_table.php

@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('languages', function (Blueprint $table) {
+            $table->renameColumn(from: 'language_name', to: 'name');
+            $table->renameColumn(from: 'language_level', to: 'level');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('languages', function (Blueprint $table) {
+            $table->renameColumn(from: 'name', to: 'language_name');
+            $table->renameColumn(from: 'level', to: 'language_level');
+        });
+    }
+};

database/seeders/LanguageSeeder.php

@@ -19,8 +19,8 @@ public function run(): void
             foreach ($levels as $level) {
                 DB::table('languages')->insert([
                     'id' => (string) Str::uuid(),
-                    'language_name' => $language,
-                    'language_level' => $level,
+                    'name' => $language,
+                    'level' => $level,
                 ]);
             }
         }

database/seeders/ResumeLanguageSeeder.php

@@ -42,7 +42,7 @@ private function attachSecondLanguage($resume, $languageIds, $selectedLanguage):
                     $selectedLanguageModel = Language::find($selectedLanguage);
                     $additionalLanguageModel = Language::find($additionalLanguage);
                 } while ($additionalLanguage === $selectedLanguage ||
-                        $additionalLanguageModel->language_name === $selectedLanguageModel->language_name);
+                        $additionalLanguageModel->name === $selectedLanguageModel->name);
                 $this->attachLanguage($resume, $additionalLanguage);
             }
         }

routes/api/v1.php

@@ -47,6 +47,8 @@
 
 Route::get('student/resume/list', StudentListController::class)->name('students.list');
 
+Route::get('student/{student}/resume/languages', StudentLanguagesDetailController::class)->name('student.languages');
+
 Route::get('student/{student}/resume/detail', StudentDetailController::class)->name('student.details');
 Route::put('student/{student}/resume/profile', UpdateStudentProfileController::class)->name('student.updateProfile');
 Route::get('student/{student}/resume/bootcamp', StudentBootcampDetailController::class)->name('student.bootcamp');
@@ -56,7 +58,6 @@
 
 Route::prefix('student/{studentId}/resume')->group(function () {
     Route::get('collaborations', StudentCollaborationDetailController::class)->name('student.collaborations');
-    Route::get('languages', StudentLanguagesDetailController::class)->name('student.languages');
     Route::put('languages', UpdateStudentLanguagesController::class)->name('student.languages.update');
     Route::get('modality', StudentModalityController::class)->name('student.modality');
     Route::get('photo', GetStudentImageController::class)->middleware('auth:api', EnsureStudentOwner::class)->name('student.photo.get');

src/__tests__/components/studentDetailCards/LanguagesCard.test.tsx

@@ -24,8 +24,8 @@ describe('LanguagesCard component', () => {
   const studentUUID = '123'; // You can replace this with a sample UUID
   const setStudentUUID = () => { }
   const languagesData = [
-    { language_id: 1, language_name: 'Spanish' },
-    { language_id: 2, language_name: 'English' },
+    { language_id: 1, name: 'Spanish' },
+    { language_id: 2, name: 'English' },
   ];
 
   test('renders languages correctly', async () => {

src/__tests__/store/reducers/getStudentLanguages/studentLanguages.test.ts

@@ -46,16 +46,16 @@ describe("StudentLanguagesTest reducer", () => {
             type: "getStudentLanguagesThunk/fulfilled",
             payload: {
                 language_id: "string",
-                language_name: "string",
-                language_level: "string",
+                name: "string",
+                level: "string",
             }
         })).toEqual({
             isLoadingLanguages: false,
             isErrorLanguages: false,
             languagesData: {
                 language_id: "string",
-                language_name: "string",
-                language_level: "string",
+                name: "string",
+                level: "string",
             }
         })
     })

src/components/studentDetailCards/languagesSection/LanguagesCard.tsx

@@ -16,7 +16,7 @@ const LanguagesCard: React.FC = () => {
             {languagesData.map((language) => (
               <ul key={language.language_id} className="flex flex-col">
                 <li className="text-sm font-semibold text-black-2">
-                  {language.language_name}
+                  {language.name}
                 </li>
               </ul>
             ))}

src/interfaces/interfaces.ts

@@ -64,8 +64,8 @@ export type TProject = {
 
 export type TLanguage = {
   language_id: string
-  language_name: string
-  language_level: string
+  name: string
+  level: string
 }
 
 export type TAbout = {