add ApiResponse::invalid helper

kodepandai · Dec 11, 2023 · 171a986 · 171a986
1 parent 6d11964
commit 171a986
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 4 deletions.
diff --git a/src/ApiResponse.php b/src/ApiResponse.php
@@ -104,6 +104,15 @@ public function badRequest(mixed $errors = []): static
             ->message(__('api-response::trans.request_is_bad_request'));
     }
 
+    public function invalid(string $key, string|array $messages): static
+    {
+        $messages = is_string($messages) ? [$messages] : $messages;
+
+        return static::error([$key => $messages], static::HTTP_UNPROCESSABLE_ENTITY)
+            ->title(__('api-response::trans.validation_error'))
+            ->message(__('api-response::trans.given_data_was_invalid'));
+    }
+
     public function statusCode(int $code): static
     {
         return $this->setStatusCode($code);

diff --git a/src/Facades/ApiResponse.php b/src/Facades/ApiResponse.php
@@ -13,6 +13,7 @@
  * @method static \KodePandai\ApiResponse\ApiResponse unauthorized(mixed $errors = [])
  * @method static \KodePandai\ApiResponse\ApiResponse forbidden(mixed $errors = [])
  * @method static \KodePandai\ApiResponse\ApiResponse badRequest(mixed $errors = [])
+ * @method static \KodePandai\ApiResponse\ApiResponse invalid(string $key, string|array $messages)
  * @method \KodePandai\ApiResponse\ApiResponse statusCode(int $code)
  * @method \KodePandai\ApiResponse\ApiResponse successful()
  * @method \KodePandai\ApiResponse\ApiResponse notSuccessful()

diff --git a/tests/Features/ApiResponseTest.php b/tests/Features/ApiResponseTest.php
@@ -23,6 +23,7 @@
     Route::get('api-unauthorized', fn () => ApiResponse::unauthorized());
     Route::get('api-forbidden', fn () => ApiResponse::forbidden());
     Route::get('api-badRequest', fn () => ApiResponse::badRequest());
+    Route::get('api-invalid', fn () => ApiResponse::invalid('key', []));
 
     getJson('api-create')->assertStatus(Response::HTTP_OK);
     getJson('api-success')->assertStatus(Response::HTTP_OK);
@@ -32,6 +33,7 @@
     getJson('api-unauthorized')->assertStatus(Response::HTTP_UNAUTHORIZED);
     getJson('api-forbidden')->assertStatus(Response::HTTP_FORBIDDEN);
     getJson('api-badRequest')->assertStatus(Response::HTTP_BAD_REQUEST);
+    getJson('api-invalid')->assertStatus(Response::HTTP_UNPROCESSABLE_ENTITY);
 });
 
 it('returns correct response header', function () {
@@ -88,18 +90,40 @@
 
     Route::get('api-error', function () use ($errors) {
         return ApiResponse::error($errors)
-            ->statusCode(Response::HTTP_UNPROCESSABLE_ENTITY);
+            ->statusCode(Response::HTTP_GATEWAY_TIMEOUT);
     });
 
     getJson('api-error')
-        ->assertStatus(Response::HTTP_UNPROCESSABLE_ENTITY)
+        ->assertStatus(Response::HTTP_GATEWAY_TIMEOUT)
         ->assertJsonPath('success', false)
-        ->assertJsonPath('title', __('Error'))
-        ->assertJsonPath('message', __('Oops! Something went wrong.'))
+        ->assertJsonPath('title', __('api-response::trans.error'))
+        ->assertJsonPath('message', __('api-response::trans.something_went_wrong'))
         ->assertJsonPath('data', [])
         ->assertJsonPath('errors', $errors);
 });
 
+it('returns correct json structure for invalid api response', function () {
+    //
+    $messages = [
+        'Age must be a number',
+        'Age must be between 10-20',
+    ];
+
+    Route::get('api-invalid', function () use ($messages) {
+        return ApiResponse::invalid('age', $messages)
+            ->statusCode(Response::HTTP_UNPROCESSABLE_ENTITY);
+    });
+
+    getJson('api-invalid')
+        ->dump()
+        ->assertStatus(Response::HTTP_UNPROCESSABLE_ENTITY)
+        ->assertJsonPath('success', false)
+        ->assertJsonPath('title', __('api-response::trans.validation_error'))
+        ->assertJsonPath('message', __('api-response::trans.given_data_was_invalid'))
+        ->assertJsonPath('data', [])
+        ->assertJsonPath('errors', ['age' => $messages]);
+});
+
 it('can handle data of type ResourceCollection|JsonResource|Collection', function () {
     //
     Route::get('r1', function () {