Merge pull request #68 from MarcinOrlowski/dev

Release 4.0.1

Author: MarcinOrlowski

CHANGES.md

@@ -4,14 +4,20 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 ## CHANGE LOG ##
 
+* v4.0.1 (2017-04-10)
+   * TestingHelpers trait's `validateResponseStructure()` method is now public
+   * [RB-64] Fixed Exception Handler generated HTTP code being out of allowed range in some cases
+   * [RB-65] Exception Handler Helper now deals with messages using non-UTF8 or broken encoding 
+   * Exception Handler's trace data is now properly placed into `trace` leaf
+
 * v4.0.0 (2017-04-10)
    * **BACKWARD INCOMPATIBILE CHANGES**
    * [RB-59] Added option to remap response JSON keys to user provided values
    * [RB-54] Debug data no longer pollutes `data` leaf. Instead, it adds `debug` dictionary to root data structure.
    * [RB-37] Added support for Laravel 5.3+ `unauthenticated()` in Exception Handler. See new config keys defails
    * [RB-47] Exception Handler now supports `FormRequests` and returns all messages in `ResponseBuilder::KEY_MESSAGES`
    * Uncaught `HttpResponse::HTTP_UNAUTHORIZED` exception is now handled same way `authentication_exception` is
-   * [RB=56] Added configurable key for debug trace added to returned JSON response (if enabled)
+   * [RB-56] Added configurable key for debug trace added to returned JSON response (if enabled)
    * Added traits to help testing your config and ApiCodes with ease. See `Unit Testing your ApiCodes` docs for details 
    * `ApiCodeBase` class is now named `BaseApiCodes`
    * [RB-35] ExceptionHandlerHelper is now covered by tests

README.md

@@ -49,7 +49,7 @@ then then feel free to donate to the project. Send some Bitcoins (BTC) to `1Lbfb
  * API chaining/cascading support,
  * Includes traits to help [unit testing your API code](docs/testing.md),
  * Provides own [exception handler helper](docs/exceptions.md) to ensure your API stays consumable even in case of unexpected,
- * No extra dependencies.
+ * No extra mandatory dependencies.
 
 ----
 

composer.json

@@ -2,7 +2,7 @@
   "name": "marcin-orlowski/laravel-api-response-builder",
   "description": "Helps building nice, normalized and easy to consume REST API responses.",
   "homepage": "https://github.com/MarcinOrlowski/laravel-api-response-builder",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "keywords": [
     "laravel",
     "json",

docs/docs.md

@@ -366,13 +366,15 @@ to handle them yourself by calling `Lang::get()` manually first and pass the res
 
 ## Requirements ##
 
-There're no special requirements. Once you fulfill Laravel's requirements you are all good. Minimum
-versions `ResponseBuilder` is tested against are:
+Minimum requirements:
 
-  * PHP 5.5+
-  * Laravel 5.1.45+
+  * PHP 5.5
+  * Laravel 5.1.45
 
-all newer versions of PHP and Laravel are also supported out of the box.
+The following PHP extensions are optional but strongly recommended: 
+
+   * iconv
+   * mb_string
 
 ----
 

src/ExceptionHandlerHelper.php

@@ -116,10 +116,10 @@ protected static function error(Exception $exception, $exception_type,
 			}
 
 			// can it be considered valid HTTP error code?
-			if ($http_code < 400) {
+			if (($http_code < 400) || ($http_code > 499)) {
 				$http_code = 0;
 			}
-		} elseif ($http_code < 400) {
+		} elseif (($http_code < 400) || ($http_code > 499)) {
 			$http_code = 0;
 		}
 
@@ -128,12 +128,14 @@ protected static function error(Exception $exception, $exception_type,
 			$http_code = $default_http_code;
 		}
 
-		$debug_data = null;
-		if (Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_ENABLED, true)) {
-			$debug_data = [
-				ResponseBuilder::KEY_CLASS => get_class($exception),
-				ResponseBuilder::KEY_FILE  => $exception->getFile(),
-				ResponseBuilder::KEY_LINE  => $exception->getLine(),
+		$trace_data = null;
+		if (Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_ENABLED, false)) {
+			$trace_data = [
+				Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_KEY, ResponseBuilder::KEY_TRACE) => [
+					ResponseBuilder::KEY_CLASS => get_class($exception),
+					ResponseBuilder::KEY_FILE  => $exception->getFile(),
+					ResponseBuilder::KEY_LINE  => $exception->getLine(),
+				],
 			];
 		}
 
@@ -166,6 +168,18 @@ protected static function error(Exception $exception, $exception_type,
 		// let's build error message
 		$error_message = '';
 		$ex_message = trim($exception->getMessage());
+
+		// ensure we won't fail due to exception incorect encoding
+		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'));
+			}
+		}
+
 		if (Config::get('response_builder.exception_handler.use_exception_message_first', true)) {
 			if ($ex_message === '') {
 				$ex_message = get_class($exception);
@@ -182,7 +196,7 @@ protected static function error(Exception $exception, $exception_type,
 			]);
 		}
 
-		return ResponseBuilder::errorWithMessageAndDataAndDebug($api_code, $error_message, $data, $http_code, null, $debug_data);
+		return ResponseBuilder::errorWithMessageAndDataAndDebug($api_code, $error_message, $data, $http_code, null, $trace_data);
 	}
 
 }

tests/Traits/TestingHelpers.php

@@ -238,7 +238,7 @@ private function getResponseObjectRaw($expected_api_code, $expected_http_code, $
 	 *
 	 * @return void
 	 */
-	protected function validateResponseStructure($json_object, array $extra_keys = [])
+	public function validateResponseStructure($json_object, array $extra_keys = [])
 	{
 		$this->assertTrue(is_object($json_object));