Merge pull request #94 from MarcinOrlowski/dev

Release v6.2.1

Author: MarcinOrlowski

.gitignore

@@ -2,3 +2,4 @@
 vendor/
 composer.lock
 .phpunit.result.cache
+.php_cs.cache

.travis.yml

@@ -24,6 +24,7 @@ php:
 env:
   - LARAVEL_VERSION="6.0"
   - LARAVEL_VERSION="6.2"
+  - LARAVEL_VERSION="6.3"
 
 #matrix:
 #  exclude:
@@ -35,17 +36,14 @@ cache:
     - ${HOME}/.composer/cache/files
 
 before_script:
-  # Some PHP versions does not feature xdebug so we need to disable the coverage
-  # - if [ ${TRAVIS_PHP_VERSION} != 7.2 && ${TRAVIS_PHP_VERSION} != 7.3 ]; then phpenv config-rm xdebug.ini ; fi
   - cp -f "travis/composer-${LARAVEL_VERSION}.json" composer.json
   - FLAGS="--prefer-dist"
   - composer install "${FLAGS}"
-  # We need to tweak signature so setUp() and tearDown() and strip ": void" otherwise PHP will fail complaining
-  # This affects Laravel 5.8+ as they pull recent Orchestra that features method signature changes.
-  - "if [[ ${LARAVEL_VERSION} == 6.0 ]]; then sed -i 's/): void/)/' vendor/orchestra/testbench-core/src/TestCase.php ; fi"
-  - "if [[ ${LARAVEL_VERSION} == 6.0 ]]; then sed -i 's/): void/)/' vendor/phpunit/phpunit/src/Framework/TestCase.php ; fi"
-  - "if [[ ${LARAVEL_VERSION} == 6.2 ]]; then sed -i 's/): void/)/' vendor/orchestra/testbench-core/src/TestCase.php ; fi"
-  - "if [[ ${LARAVEL_VERSION} == 6.2 ]]; then sed -i 's/): void/)/' vendor/phpunit/phpunit/src/Framework/TestCase.php ; fi"
+  # We need to tweak signature of setUp() and tearDown() methods and strip ": void" otherwise PHP will
+  # fail complaining. This affects Laravel 5.8+ and 6.x (up to 6.3 for now) as they pull recent Orchestra
+  # that features method signature changes.
+  - "sed -i 's/): void/)/' vendor/orchestra/testbench-core/src/TestCase.php"
+  - "sed -i 's/): void/)/' vendor/phpunit/phpunit/src/Framework/TestCase.php"
 
 script:
   - vendor/bin/phpunit --configuration phpunit.xml --coverage-clover /tmp/coverage.xml
@@ -55,4 +53,3 @@ after_success:
   - if [[ -f /tmp/coverage.xml ]]; then vendor/bin/codacycoverage clover /tmp/coverage.xml ; fi
   # Scrunitizer-CI
   - if [[ -f /tmp/coverage.xml ]]; then wget --output-document=/tmp/ocular.phar https://scrutinizer-ci.com/ocular.phar && php /tmp/ocular.phar code-coverage:upload --format=php-clover /tmp/coverage.xml ; fi
-

CHANGES.md

@@ -6,13 +6,18 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 ## CHANGE LOG ##
 
+* 6.2.1 (2019-10-21)
+   * Added Laravel 6.3 to Travis-CI unit tests.
+   * Splitted tests into separate folders per class tested.
+   * ExceptionHandler no longer tries to enforce UTF-8 on exception message. 
+
 * 6.2.0 (2019-10-19)
    * Changed how auto-converter checks for supported classes (see [Data Conversion](docs/docs.md#data-conversion))
    * Data conversion now supports [JsonResource](https://laravel.com/docs/6.0/eloquent-resources) data class.
    * Added unit test for `ResponseBuilderServiceProvider::mergeConfg()`.
    * Moved data conversion code to separate `Converter` class.
    * Added `LICENSE.md` file.
-   * Added Laravel 6.2 to Travis tests.
+   * Added Laravel 6.2 to Travis-CI unit tests.
    * Added unit tests for translation files.
 
 * 6.1.2 (2019-10-02)

README.md

@@ -97,7 +97,7 @@
 
  * Easy to use,
  * [Stable and production ready](https://travis-ci.org/MarcinOrlowski/laravel-api-response-builder),
- * Laravel compatibility: v6.0, v6.2 (see [legacy support](docs/legacy.md) for support for older versions),
+ * Laravel compatibility: v6.x (see [legacy support](docs/legacy.md) for support for older versions),
  * Supports Laravel [auto-discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518),
  * Configurable (with ready-to-use defaults),
  * Localization support,

composer.json

@@ -2,7 +2,7 @@
   "name": "marcin-orlowski/laravel-api-response-builder",
   "description": "Helps building nice, normalized and easy to consume Laravel REST API.",
   "homepage": "https://github.com/MarcinOrlowski/laravel-api-response-builder",
-  "version": "6.2.0",
+  "version": "6.2.1",
   "keywords": [
     "laravel",
     "json",
@@ -45,11 +45,12 @@
     ]
   },
   "require-dev": {
-    "marcin-orlowski/coding-standard": "^1.1",
+    "marcin-orlowski/coding-standard": "^1.3",
     "orchestra/testbench": "^4.0",
     "laravel/framework": "^6.0",
     "phpunit/phpunit": "^8.0",
     "phpunit/php-code-coverage": "^7.0",
-    "codacy/coverage": "^1.0"
+    "codacy/coverage": "^1.0",
+    "friendsofphp/php-cs-fixer": "^2.15"
   }
 }

config/response_builder.php

@@ -73,27 +73,27 @@
 		'exception' => [
 //			'http_not_found' => [
 //				'code'      => \App\ApiCodes::HTTP_NOT_FOUND(),
-//				'http_code' => Symfony\Component\HttpFoundation\Response\::HTTP_BAD_REQUEST,
+//				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST,
 //			],
 //			'http_service_unavailable' => [
 //				'code'      => \App\ApiCodes::HTTP_SERVICE_UNAVAILABLE(),
-//				'http_code' => Symfony\Component\HttpFoundation\Response\::HTTP_BAD_REQUEST,
+//				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST,
 //			],
 //			'http_exception' => [
 //				'code'      => \App\ApiCodes::HTTP_EXCEPTION(),
-//				'http_code' => Symfony\Component\HttpFoundation\Response\::HTTP_BAD_REQUEST,
+//				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST,
 //			],
 //			'uncaught_exception' => [
 //				'code'      => \App\ApiCodes::UNCAUGHT_EXCEPTION(),
-//				'http_code' => Symfony\Component\HttpFoundation\Response\::HTTP_INTERNAL_SERVER_ERROR,
+//				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_INTERNAL_SERVER_ERROR,
 //			],
 //			'authentication_exception' => [
 //				'code'      => \App\ApiCodes::AUTHENTICATION_EXCEPTION(),
-//				'http_code' => Symfony\Component\HttpFoundation\Response\::HTTP_UNAUTHORIZED,
+//				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_UNAUTHORIZED,
 //			],
 //			'validation_exception' => [
 //				'code'      => \App\ApiCodes::VALIDATION_EXCEPTION(),
-//				'http_code' => Symfony\Component\HttpFoundation\Response\::HTTP_UNPROCESSABLE_ENTITY,
+//				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_UNPROCESSABLE_ENTITY,
 //			],
 		],
 	],

src/ApiCodesHelpers.php

@@ -115,7 +115,14 @@ public static function getCodeMessageKey($api_code): ?string
 		return $map[ $api_code ] ?? null;
 	}
 
-	public static function isCodeValid($code): bool
+	/**
+	 * Checks if given API $code can be used in current configuration.
+	 *
+	 * @param int $code API code to validate
+	 *
+	 * @return bool
+	 */
+	public static function isCodeValid(int $code): bool
 	{
 		return ($code === 0) || (($code >= static::getMinCode()) && ($code <= static::getMaxCode()));
 	}
@@ -126,6 +133,8 @@ public static function isCodeValid($code): bool
 	 * @param int $internal_code
 	 *
 	 * @return int
+	 *
+	 * @throws \InvalidArgumentException
 	 */
 	protected static function getCodeForInternalOffset(int $internal_code): int
 	{

src/Converter.php

@@ -23,12 +23,14 @@
 class Converter
 {
 	/**
-	 * @var array|null
+	 * @var array
 	 */
 	protected $classes;
 
 	/**
 	 * Converter constructor.
+	 *
+	 * @throws \RuntimeException
 	 */
 	public function __construct()
 	{
@@ -44,23 +46,24 @@ public function __construct()
 	/**
 	 * Returns local copy of configuration mapping for the classes.
 	 *
-	 * @return array|null
+	 * @return array
 	 */
-	public function getClasses(): ?array
+	public function getClasses(): array
 	{
 		return $this->classes;
 	}
 
 	/**
 	 * Checks if we have "classes" mapping configured for $data object class.
 	 * Returns @true if there's valid config for this class.
+	 * Throws \RuntimeException if there's no config "classes" mapping entryfor this object configured.
+	 * Throws \InvalidArgumentException if No data conversion mapping configured for given class.
 	 *
 	 * @param object $data Object to check mapping for.
 	 *
 	 * @return array
 	 *
-	 * @throws \RuntimeException if there's no config "classes" mapping entry
-	 *                           for this object configured.
+	 * @throws \InvalidArgumentException
 	 */
 	protected function getClassMappingConfigOrThrow(object $data): array
 	{
@@ -90,9 +93,11 @@ protected function getClassMappingConfigOrThrow(object $data): array
 	/**
 	 * We need to prepare source data
 	 *
-	 * @param null $data
+	 * @param object|array|null $data
 	 *
 	 * @return array|null
+	 *
+	 * @throws \InvalidArgumentException
 	 */
 	public function convert($data = null): ?array
 	{
@@ -118,6 +123,8 @@ public function convert($data = null): ?array
 	 * @param array $data array to recursively convert known elements of
 	 *
 	 * @return array
+	 *
+	 * @throws \RuntimeException
 	 */
 	protected function convertArray(array $data): array
 	{

src/ExceptionHandlerHelper.php

@@ -101,24 +101,26 @@ protected function unauthenticated(/** @scrutinizer ignore-unused */ $request, A
 	/**
 	 * Process singe error and produce valid API response
 	 *
-	 * @param Exception $exception         Exception to be processed
-	 * @param string    $exception_type    Category of the exception
-	 * @param integer   $default_api_code  API code to return
-	 * @param integer   $default_http_code HTTP code to return
+	 * @param Exception $exception            Exception to be processed
+	 * @param string    $exception_config_key Category of the exception
+	 * @param integer   $fallback_api_code    API code to return
+	 * @param integer   $fallback_http_code   HTTP code to return
 	 *
 	 * @return HttpResponse
 	 */
-	protected static function error(Exception $exception, $exception_type, $default_api_code,
-	                                $default_http_code = ResponseBuilder::DEFAULT_HTTP_CODE_ERROR): HttpResponse
+	protected static function error(Exception $exception, $exception_config_key, $fallback_api_code,
+	                                $fallback_http_code = ResponseBuilder::DEFAULT_HTTP_CODE_ERROR): HttpResponse
 	{
 		// common prefix for config key
-		$base_config = 'response_builder.exception_handler.exception';
+		$base_config_key = sprintf('%s.exception', ResponseBuilder::CONF_EXCEPTION_HANDLER_KEY);
 
-		$api_code = Config::get("{$base_config}.{$exception_type}.code", $default_api_code);
-		$http_code = Config::get("{$base_config}.{$exception_type}.http_code", $default_http_code);
+		// get API and HTTP codes from exception handler config or use fallback values if no such
+		// config fields are set.
+		$api_code = Config::get("{$base_config_key}.{$exception_config_key}.code", $fallback_api_code);
+		$http_code = Config::get("{$base_config_key}.{$exception_config_key}.http_code", $fallback_http_code);
 
 		// check if we now have valid HTTP error code for this case or need to make one up.
-		if ($http_code === 0) {
+		if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
 			// no code, let's try to get the exception status
 			$http_code = ($exception instanceof \Symfony\Component\HttpKernel\Exception\HttpException)
 				? $exception->getStatusCode()
@@ -127,7 +129,7 @@ protected static function error(Exception $exception, $exception_type, $default_
 
 		// can it be considered valid HTTP error code?
 		if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
-			$http_code = $default_http_code;
+			$http_code = $fallback_http_code;
 		}
 
 		// let's figure out what event we are handling now
@@ -141,55 +143,30 @@ protected static function error(Exception $exception, $exception_type, $default_
 		];
 		$base_api_code = BaseApiCodes::NO_ERROR_MESSAGE();
 		foreach ($known_codes as $item_config_key => $item_api_code) {
-			if ($api_code === Config::get("{$base_config}.{$item_config_key}.code", $item_api_code)) {
+			if ($api_code === Config::get("{$base_config_key}.{$item_config_key}.code", $item_api_code)) {
 				$base_api_code = $api_code;
 				break;
 			}
 		}
 
 		/** @var array|null $data Optional payload to return */
 		$data = null;
-		if ($api_code === Config::get("{$base_config}.validation_exception.code", BaseApiCodes::EX_VALIDATION_EXCEPTION())) {
+		if ($api_code === Config::get("{$base_config_key}.validation_exception.code", BaseApiCodes::EX_VALIDATION_EXCEPTION())) {
 			/** @var ValidationException $exception */
 			$data = [ResponseBuilder::KEY_MESSAGES => $exception->validator->errors()->messages()];
 		}
 
 		$key = BaseApiCodes::getCodeMessageKey($api_code) ?? BaseApiCodes::getCodeMessageKey($base_api_code);
 
 		// let's build error error_message
-		$ex_message = trim($exception->getMessage());
-
-		// ensure we won't fail due to exception incorect encoding
-		// TODO(orlowski): Is this really needed?
-		if (!mb_check_encoding($ex_message, 'UTF-8')) {
-			// let's check there's iconv and mb_string available
-			if (function_exists('iconv') && function_exists('mb_detec_encoding')) {
-				$ex_message = iconv(mb_detect_encoding($ex_message, mb_detect_order(), true), 'UTF-8', $ex_message);
-			} else {
-				// lame fallback, in case there's no iconv/mb_string installed
-				$ex_message = htmlspecialchars_decode(htmlspecialchars($ex_message, ENT_SUBSTITUTE, 'UTF-8'));
-			}
-		}
-
-		/** @var string $error_message final error error_message */
-		$error_message = $ex_message;
-		$ex_message = get_class($exception);
-
-		if ($ex_message === '') {
-			$error_message = Lang::get($key, [
-				'api_code'      => $api_code,
-				'error_message' => $ex_message,
-				'message'       => get_class($exception),
-			]);
-		}
+		$error_message = $exception->getMessage();
 
 		// if we do not have any error_message in the hand yet, we need to fall back to built-in string configured
 		// for this particular exception.
 		if ($error_message === '') {
 			$error_message = Lang::get($key, [
-				'api_code'      => $api_code,
-				'error_message' => $ex_message,
-				'message'       => get_class($exception),
+				'api_code' => $api_code,
+				'message'  => get_class($exception),
 			]);
 		}
 

src/ResponseBuilder.php

@@ -56,6 +56,7 @@ class ResponseBuilder
 	public const CONF_KEY_MIN_CODE               = 'response_builder.min_code';
 	public const CONF_KEY_MAX_CODE               = 'response_builder.max_code';
 	public const CONF_KEY_RESPONSE_KEY_MAP       = 'response_builder.map';
+	public const CONF_EXCEPTION_HANDLER_KEY      = 'response_builder.exception_handler';
 
 	/**
 	 * Default keys to be used by exception handler while adding debug information