Merge pull request #93 from MarcinOrlowski/dev

Release 6.2.0

Author: MarcinOrlowski

.scrutinizer.yml

@@ -0,0 +1,33 @@
+##################################################################################
+#
+# Laravel API Response Builder Scrutinizer-CI config file
+#
+# @package   MarcinOrlowski\ResponseBuilder
+#
+# @author    Marcin Orlowski <mail (#) marcinorlowski (.) com>
+# @copyright 2016-2019 Marcin Orlowski
+# @license   http://www.opensource.org/licenses/mit-license.php MIT
+# @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
+#
+##################################################################################
+
+filter:
+  excluded_paths: [tests/*]
+checks:
+  php:
+    code_rating: true
+#    remove_extra_empty_lines: true
+    remove_php_closing_tag: true
+    remove_trailing_whitespace: true
+    fix_use_statements:
+      remove_unused: true
+      preserve_multiple: false
+      preserve_blanklines: true
+      order_alphabetically: true
+    fix_php_opening_tag: true
+    fix_linefeed: true
+    fix_line_ending: true
+#    fix_identation_4spaces: true
+#    fix_doc_comments: true
+tools:
+  external_code_coverage: true

.travis.yml

@@ -23,31 +23,35 @@ php:
 
 env:
   - LARAVEL_VERSION="6.0"
+  - LARAVEL_VERSION="6.2"
 
-matrix:
-  exclude:
-    - php: 7.1
-      env: LARAVEL_VERSION="6.0"
+#matrix:
+#  exclude:
+#    - php: 7.1
+#      env: LARAVEL_VERSION="6.0"
 
 cache:
   directories:
     - ${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
+  # - 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.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"
 
 script:
   - vendor/bin/phpunit --configuration phpunit.xml --coverage-clover /tmp/coverage.xml
 
 after_success:
-#   IF coverage file is generated then upload it to Codacy
-  - if [ -f /tmp/coverage.xml ] ; then vendor/bin/codacycoverage clover /tmp/coverage.xml ; fi
-
+  # If coverage file is generated then upload it to Codacy (requires CODACY_PROJECT_TOKEN= env var set).
+  - [[ -f /tmp/coverage.xml ]] && then vendor/bin/codacycoverage clover /tmp/coverage.xml
+  # Scrunitizer-CI
+  - [[ -f /tmp/coverage.xml ]] && { 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 }

CHANGES.md

@@ -1,20 +1,29 @@
-![REST API Response Builder for Laravel](docs/logo.png)
+![REST API Response Builder for Laravel](docs/img/logo.png)
 
 # REST API Response Builder for Laravel #
 
 See [compatibility docs](docs/compatibility.md) for details about backward compatibility!
 
 ## CHANGE LOG ##
 
+* 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 unit tests for translation files.
+
 * 6.1.2 (2019-10-02)
    * Corrected ServiceProvider used for tests.
 
 * 6.1.1 (2019-10-02)
    * Fixed `ResponseBuilderServiceProvider` using unreferenced `Arr` class method (reported by yassir3wad).
-
+   
 * 6.1.0 (2019-09-28)
    * **BACKWARD INCOMPATIBLE CHANGES** ([more info](docs/compatibility.md))
-   * Created new library logo (see `artwork/` folder)
+   * Created new library logo (see [artwork/](artwork/) folder).
    * Added more unit tests to improve coverage.
    * Updated documentation.
    * Worked arround Laravel's config merger wnot working properly with multi-dimensional config arrays.
@@ -24,13 +33,13 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 * 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).
+   * Requires Laravel 6.0+ and PHP 7.2+ (see [docs](docs/legacy.md) 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.
+   * Reserved codes reduced to 19 (from former 63).
    * Added type hints to all method arguments and return values
-   * `ExceptionHandler` returns Exception-type related HTTP codes now as per configuration.
+   * `ExceptionHandler` responses use exception specific HTTP code.
    * Fixed `ResponseBuilder::errorWithMessageAndData()` not passing data properly.
-   * Fixed exception message of `ApiCodesHelpers::getMaxCode()`.
+   * Fixed exception message thrown by `ApiCodesHelpers::getMaxCode()`.
    * Corrected test cases list in `testSuccess_DataAndHttpCode()`.
    * Fixed error code fallback in `testRender_HttpException()` test.
    * Fixed `testError_DebugTrace()` not containing any asserts.
@@ -85,7 +94,7 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
    * Fixed `version` in `composer.json` file
 
 * v4.1.0 (2017-09-09)
-   * [RB-70] Added support for Laravel 5.5's auto-discovery feature
+   * `[RB-70]` Added support for Laravel 5.5's auto-discovery feature
 
 * v4.0.2 (2017-04-13)
    * Enforced HTTP code for error messages fits 400-499 range
@@ -94,68 +103,68 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 * 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
+   * `[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 INCOMPATIBLE CHANGES** ([more info](docs/compatibility.md))
-   * [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`
+   * `[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
+   * `[RB-35]` ExceptionHandlerHelper is now covered by tests
 
 * v3.2.1 (2017-04-06)
-   * [RB-49] Fixed `artisan vendor:publish` not publishing config file correctly
+   * `[RB-49] Fixed `artisan vendor:publish` not publishing config file correctly
 
 * v3.2.0 (2017-03-02)
-   * [RB-42] Default value of `encoding_options` include `JSON_UNESCAPED_UNICODE` to prevent unicode escaping
-   * [RB-41] Updated documentation
+   * `[RB-42] Default value of `encoding_options` include `JSON_UNESCAPED_UNICODE` to prevent unicode escaping
+   * `[RB-41]` Updated documentation
 
 * v3.1.0 (2017-02-28)
-   * [RB-38] Added `encoding_options` to control data-to-json conversion.
-   * [RB-38] Added optional encoding options args to all methods accepting `data` argument
-   * [RB-34] Added option to control ExceptionHandler behavior on debug builds
+   * `[RB-38] Added `encoding_options` to control data-to-json conversion.
+   * `[RB-38] Added optional encoding options args to all methods accepting `data` argument
+   * `[RB-34]` Added option to control ExceptionHandler behavior on debug builds
    * ExceptionHandler's debug is now added as `debug` node to make it more clear where it comes from
 
 * v3.0.3 (2017-02-24)
    * No changes. v3.0.2 was incorrectly released
 
 * v3.0.2 (2017-02-24)
-   * [RB-31] Fixed incorrect exception message thrown in case of incomplete `classes` config mapping (@dragonfire1119)
+   * `[RB-31] Fixed incorrect exception message thrown in case of incomplete `classes` config mapping (@dragonfire1119)
 
 * v3.0.1 (2017-02-23)
    * Updated `composer.json` to list `laravel/framework` among requirements
 
 * v3.0.0 (2017-02-23)
    * **BACKWARD INCOMPATIBLE CHANGES** ([more info](docs/compatibility.md))
-   * [RB-17] `success()` now allows to return API code as well
+   * `[RB-17] `success()` now allows to return API code as well
    * Corrected default config file containing faulty and unneeded `use` entries
-   * [RB-20] Renamed ErrorCode class to ApiCodeBase
+   * `[RB-20]` Renamed ErrorCode class to ApiCodeBase
    * ApiCodeBase's `getMinCode()` and `getMaxCode()` are now `public`
    * Improved error messages to be even more informative
    * All exceptions thrown due to misconfiguration have `CONFIG: ` message prefix now
    * Renamed `error_code` param to `api_code` in all the method signatures
    * `:api_code` is now code placeholder in strings (`:error_code` is no longer supported)
    * Default HTTP codes are now declared as constants `DEFAULT_HTTP_CODE_xxx` if you need to know them
    * `ApiCodeBase::getMap()` now ensures `map` config entry of expected `array` type
-   * [RB-26] Added `successWithCode()` method
+   * `[RB-26]` Added `successWithCode()` method
 
 * v2.2.1 (2017-02-20)
    * Documentation split into separate files
 
 * v2.2.0 (2017-02-20)
-   * [RB-5] Fixed error code range not being checked when used with custom message strings
+   * `[RB-5]` Fixed error code range not being checked when used with custom message strings
    * `successWithHttpCode()`, `errorWithDataAndHttpCode()`, `errorWithHttpCode()` throws exception if `http_code` is `null`
    * `http_code` can be handed as null to all other methods and it will be replaced by default codes
    * `classes` mapping now features `method` field to specify method name to call for automatic object conversion
-   * [RB-10] When `$data` is an `array`, all elements mapped via "classes" config will be converted recursively
-   * [RB-3] Unit tests are now part of the package
+   * `[RB-10] When `$data` is an `array`, all elements mapped via "classes" config will be converted recursively
+   * `[RB-3]` Unit tests are now part of the package
 
 * v2.1.2 (2016-08-24)
    * Fixed exception code handling in ExceptionHandlerHelper (reported by Adrian Chen @absszero)

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+ Please report any issue spotted using [GitHub's project tracker](https://github.com/MarcinOrlowski/laravel-api-response-builder/issues).
+
+ If you'd like to contribute to the this project, please [open new ticket](https://github.com/MarcinOrlowski/laravel-api-response-builder/issues)
+ **before doing any work**. This will help us save your time in case I'd not be accept PR either completely or in proposed form.
+ But if all is good and clear then follow common routine:
+
+ * fork the project,
+ * create new branch,
+ * do your changes,
+ * add tests covering your changes,
+ * ensure **ALL** tests pass,
+ * send pull request,
+ * glory.

LICENSE.md

@@ -0,0 +1,15 @@
+MIT License
+
+Copyright (c) 2016-2019 Marcin Orlowski <mail (#) marcinorlowski (.) com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation 
+files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the 
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.