Merge pull request #89 from MarcinOrlowski/dev

Release 6.0.0

Author: MarcinOrlowski

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 vendor/
 composer.lock
+.phpunit.result.cache

.travis.yml

@@ -18,61 +18,14 @@ language: php
 dist: trusty
 
 php:
-  - 5.5
-  - 5.6
-  - 7.0
-  - 7.1
   - 7.2
   - 7.3
 
 env:
-  - LARAVEL_VERSION="5.1"
-  - LARAVEL_VERSION="5.2"
-  - LARAVEL_VERSION="5.3"
-  - LARAVEL_VERSION="5.4"
-  - LARAVEL_VERSION="5.5"
-  - LARAVEL_VERSION="5.6"
-  - LARAVEL_VERSION="5.7"
-  - LARAVEL_VERSION="5.8"
   - LARAVEL_VERSION="6.0"
 
 matrix:
   exclude:
-    - php: 5.5
-      env: LARAVEL_VERSION="5.3"
-    - php: 5.5
-      env: LARAVEL_VERSION="5.4"
-    - php: 5.5
-      env: LARAVEL_VERSION="5.5"
-    - php: 5.5
-      env: LARAVEL_VERSION="5.6"
-    - php: 5.5
-      env: LARAVEL_VERSION="5.7"
-    - php: 5.5
-      env: LARAVEL_VERSION="5.8"
-    - php: 5.5
-      env: LARAVEL_VERSION="6.0"
-
-    - php: 5.6
-      env: LARAVEL_VERSION="5.5"
-    - php: 5.6
-      env: LARAVEL_VERSION="5.6"
-    - php: 5.6
-      env: LARAVEL_VERSION="5.7"
-    - php: 5.6
-      env: LARAVEL_VERSION="5.8"
-    - php: 5.6
-      env: LARAVEL_VERSION="6.0"
-
-    - php: 7.0
-      env: LARAVEL_VERSION="5.6"
-    - php: 7.0
-      env: LARAVEL_VERSION="5.7"
-    - php: 7.0
-      env: LARAVEL_VERSION="5.8"
-    - php: 7.0
-      env: LARAVEL_VERSION="6.0"
-
     - php: 7.1
       env: LARAVEL_VERSION="6.0"
 
@@ -88,7 +41,6 @@ before_script:
   - 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} == 5.8 ]; then sed -i 's/): void/)/' vendor/orchestra/testbench-core/src/TestCase.php ; fi"
   - "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"
 

CHANGES.md

@@ -6,6 +6,40 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 ## CHANGE LOG ##
 
+* v6.0.0 (2019-09-20)
+   * **BACKWARD INCOMPATIBLE CHANGES** ([more info](docs/compatibility.md))
+   * Requires Laravel 6.0+ and PHP 7.2+ (see docs for legacy support hints).
+   * All API codes are now withing defined code range, incl. built-in codes.
+   * Reserved code range lowered from former 63 down to 19.
+   * Added type hints to all method arguments and return values
+   * `ExceptionHandler` returns Exception-type related HTTP codes now as per configuration.
+   * Fixed `ResponseBuilder::errorWithMessageAndData()` not passing data properly.
+   * Fixed exception message of `ApiCodesHelpers::getMaxCode()`.
+   * Corrected test cases list in `testSuccess_DataAndHttpCode()`.
+   * Fixed error code fallback in `testRender_HttpException()` test.
+   * Fixed `testError_DebugTrace()` not containing any asserts.
+   * Reformatted code to not exceed 132 columns, for better on-line readability.
+   * `ResponseBuilder::errorWithDataAndHttpCode()` accepts now `null` as http code.
+   * `ResponseBuilder::errorWithHttpCode()` accepts now `null` as http code.
+   * Fixed `ExceptionHandlerHelper` replacing HTTP codes above 499 with 400.
+   * Changed default built-in message for `HTTP_NOT_FOUND` error.
+   * `ExceptionHandler` now falls back to `EX_UNCAUGHT_EXCEPTION` for all the cases.
+   * Simplified `ExceptionHandlerHelperTest::testRender_HttpException()` test.
+   * Removed `exception_handler.use_exception_message_first` feature.
+   * Removed `ResponseBuilder::DEFAULT_API_CODE_OK` constant.
+   * Removed `getReservedMinCode()`, `getReservedMinCode()`, `getReservedMessageKey()` methods.
+   * Removed internal API code constants. Use corresponding methods to get proprt code value.
+   * Reimplemented Laravel config merger to support multi-dimensional configuration arrays too.
+   * Removed `response_key_map` configuration option. 
+   * You can now return HTTP codes from 5xx range with all error responses. 
+
+* v5.0.0
+   * Skipped to catch up with Laravel version numeration.
+
+* v4.1.9 (2019-08-08)
+   * Fixed `ApiCodesHelpers::getMaxCode()` exception message
+   * Fixed `ResponseBuilder::errorWithMessageAndData()` not passing args properly
+
 * v4.1.8 (2019-08-07)
    * Added Laravel 6 to testing setup
 

README.md

@@ -70,9 +70,8 @@
 
  * Easy to use,
  * [Stable and production ready](https://travis-ci.org/MarcinOrlowski/laravel-api-response-builder),
- * Laravel 5.1 to 6.0 compatible,
- * Supports Laravel [auto-discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518) (5.5 and up),
- * Works on PHP 5.5, 5.6, 7.0, 7.1, 7.2 and 7.3,
+ * Laravel 6.0 compatible (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,
  * Automatic object conversion with custom mapping,

composer.json

@@ -2,14 +2,18 @@
   "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": "4.1.7",
+  "version": "6.0.0",
   "keywords": [
     "laravel",
     "json",
     "api",
     "builder",
     "rest",
-    "helper"
+    "helper",
+    "php7",
+    "mobile",
+    "android",
+    "ios"
   ],
   "license": "MIT",
   "authors": [
@@ -23,15 +27,15 @@
     "issues": "https://github.com/MarcinOrlowski/laravel-api-response-builder/issues"
   },
   "extra": {
-	"laravel": {
-        "providers": [
-			"MarcinOrlowski\\ResponseBuilder\\ResponseBuilderServiceProvider"
-		]
-	}
+    "laravel": {
+      "providers": [
+        "MarcinOrlowski\\ResponseBuilder\\ResponseBuilderServiceProvider"
+      ]
+    }
   },
   "require": {
-    "php": ">=5.5.9",
-    "laravel/framework": "^5.1"
+    "php": ">=7.2.0",
+    "laravel/framework": "^6.0"
   },
   "autoload": {
     "classmap": [
@@ -42,10 +46,10 @@
   },
   "require-dev": {
     "marcin-orlowski/coding-standard": "^1.1",
-    "phpunit/phpunit": "^4.8",
-    "phpunit/php-code-coverage": "^2.2.4",
-    "mockery/mockery": "^0.9.8",
-    "orchestra/testbench": "^3.1",
+    "orchestra/testbench": "^4.0",
+    "laravel/framework": "^6.0",
+    "phpunit/phpunit": "^8.0",
+    "phpunit/php-code-coverage": "^7.0",
     "codacy/coverage": "^1.0"
   }
 }