Fix message translation

Author: kennedy-osaze

README.md

@@ -424,8 +424,8 @@ return ApiResponse::create(400, 'error_code.error_code_name:status=FAILED');
 
 {
     "success": false,
-    "message": "Just a failed error message",
-    "error_code_name": "Example error message with status FAILED"
+    "message": "Example error message with status FAILED",
+    "error_code": "error_code_name"
 }
 
 ```

resources/lang/en/errors.php

@@ -16,7 +16,7 @@
     |--------------------------------------------------------------------------
     */
 
-    'example_code' => 'An example success message',
+    'example_code' => 'An example error message',
     'validation_failed' => 'Validation Failed.',
 
     /*

src/ApiResponse.php

@@ -10,7 +10,6 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\Lang;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Conditionable;
 use InvalidArgumentException;
@@ -142,7 +141,7 @@ protected function getTranslatedMessageMeta(string $message, array &$data, bool
             return [];
         }
 
-        $translationPrefix = Lang::has($message) ? null : 'api-response::'.config("api-response.translation.{$fileKey}");
+        $translationPrefix = $this->isTranslationKey($message) ? null : 'api-response::'.config("api-response.translation.{$fileKey}");
 
         $translated = $this->extractTranslationDataFromResponsePayload($data, $message, $translationPrefix);
 

src/Concerns/ConvertsExceptionToApiResponse.php

@@ -8,6 +8,7 @@
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Illuminate\Validation\UnauthorizedException;
 use Illuminate\Validation\ValidationException;
@@ -83,6 +84,18 @@ protected function convertHttpExceptionToJsonResponse(HttpExceptionInterface $ex
         return ApiResponse::create($statusCode, $message, $data, $headers);
     }
 
+    protected function convertExceptionToArray(Throwable $e)
+    {
+        return config('app.debug') ? [
+            'message' => $e->getMessage(),
+            'code' => $e->getCode(),
+            'exception' => get_class($e),
+            'file' => $e->getFile(),
+            'line' => $e->getLine(),
+            'trace' => collect($e->getTrace())->map(fn ($trace) => Arr::except($trace, ['args']))->all(),
+        ] : [];
+    }
+
     protected function shouldRenderHtmlOnException(): bool
     {
         return (bool) config('api-response.render_html_on_exception');

src/Concerns/Translatable.php

@@ -3,6 +3,7 @@
 namespace KennedyOsaze\LaravelApiResponse\Concerns;
 
 use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Lang;
 use Illuminate\Support\Str;
 
 trait Translatable
@@ -89,4 +90,24 @@ public function getTranslatedStringArray(string $message, array $attributes = []
 
         return ['key' => $key, 'message' => $message];
     }
+
+    /**
+     * Determine if a translation exists.
+     *
+     * @param string $key
+     *
+     * @return bool
+     */
+    public function isTranslationKey(string $key): bool
+    {
+        if (Lang::has($key)) {
+            return true;
+        }
+
+        if (count($parts = explode('::', $key)) === 1) {
+            return Lang::has($parts[0]);
+        }
+
+        return Lang::has($parts[0].'::'.Str::before($parts[1], ':'));
+    }
 }

tests/ExceptionsHandlerTest.php

@@ -105,7 +105,7 @@ public function testUnpreparedExceptionReturnsMinimalResponseWhenDebugModeIsDisa
         $response = $this->handler->renderApiResponse($exception, $this->app->request);
 
         $this->assertSame(500, $response->status());
-        collect(['message', 'exception', 'file', 'line', 'trace'])->each(fn ($key) =>
+        collect(['message', 'code', 'exception', 'file', 'line', 'trace'])->each(fn ($key) =>
             $this->assertArrayHasKey($key, $response->getData(true)['error'])
         );
     }
@@ -121,6 +121,15 @@ public function testExceptionReturnsViewWhenReturnHtmlIsEnabledOnException()
         $this->assertStringContainsString('<!DOCTYPE html>', $response->getContent());
     }
 
+    public function testHttpExceptionWithTranslationMessageReturnsCorrectResponseData()
+    {
+        $exception = new HttpException(400, 'api-response::errors.example_code');
+        $response = $this->handler->renderApiResponse($exception, $this->app->request);
+
+        $this->assertSame(400, $response->status());
+        $this->assertSame(__('api-response::errors.example_code'), $response->getData(true)['message']);
+    }
+
     /**
      * @dataProvider getHttpResponseExceptionProvider
      */

tests/TranslatableTraitTest.php

@@ -82,4 +82,24 @@ public function getTranslationProvider()
             ['example_code', ['status' => 'dummy'], 'success', ['key' => 'example_code', 'message' => 'Example success message, dummy']],
         ];
     }
+
+    /**
+     * @dataProvider getIsTranslationKeyProvider
+     */
+    public function testIsTranslationKeyReturnsOutputCorrectly($input, $output)
+    {
+        $result = $this->class->isTranslationKey($input);
+
+        $this->assertSame($output, $result);
+    }
+
+    public function getIsTranslationKeyProvider()
+    {
+        return [
+            ['', false],
+            ['dummy message', false],
+            ['api-response::errors.example_code', true],
+            ['api-response::errors.error_code.error_code_name', true],
+        ];
+    }
 }