Merge pull request #96 from MarcinOrlowski/dev

Release v6.2.2

Author: MarcinOrlowski

.scrutinizer.yml

@@ -4,7 +4,7 @@
 #
 # @package   MarcinOrlowski\ResponseBuilder
 #
-# @author    Marcin Orlowski <mail (#) marcinorlowski (.) com>
+# @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
@@ -16,7 +16,6 @@ filter:
 checks:
   php:
     code_rating: true
-#    remove_extra_empty_lines: true
     remove_php_closing_tag: true
     remove_trailing_whitespace: true
     fix_use_statements:
@@ -27,7 +26,5 @@ checks:
     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

@@ -4,7 +4,7 @@
 #
 # @package   MarcinOrlowski\ResponseBuilder
 #
-# @author    Marcin Orlowski <mail (#) marcinorlowski (.) com>
+# @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
@@ -13,13 +13,10 @@
 
 language: php
 
-# Enforcing Ubuntu Trusty to keep PHP 5.5 support
-# https://blog.travis-ci.com/2019-04-15-xenial-default-build-environment
-dist: trusty
-
 php:
   - 7.2
   - 7.3
+  - 7.4snapshot
 
 env:
   - LARAVEL_VERSION="6.0"
@@ -37,11 +34,10 @@ cache:
 
 before_script:
   - cp -f "travis/composer-${LARAVEL_VERSION}.json" composer.json
-  - FLAGS="--prefer-dist"
-  - composer install "${FLAGS}"
-  # 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.
+  - composer install --prefer-dist
+  # Need to tweak signature of setUp() and tearDown() methods and strip the ": void" from it, otherwise tests
+  # run will fail due to signature mismatch. This affects Laravel 5.8+ and 6.x as they pull recent Orchestra
+  # version that features methods' signature change.
   - "sed -i 's/): void/)/' vendor/orchestra/testbench-core/src/TestCase.php"
   - "sed -i 's/): void/)/' vendor/phpunit/phpunit/src/Framework/TestCase.php"
 
@@ -50,6 +46,6 @@ script:
 
 after_success:
   # If coverage file is generated then upload it to Codacy (requires CODACY_PROJECT_TOKEN= env var set).
-  - 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
+  - vendor/bin/codacycoverage clover /tmp/coverage.xml
+  # Scrutinizer-CI
+  - 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

@@ -6,10 +6,14 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 ## CHANGE LOG ##
 
+* 6.2.2 (2019-10-22)
+   * Squashed multiple typographic errors in documentation.
+
 * 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. 
+   * Split tests into separate folders per class tested.
+   * ExceptionHandler no longer tries to enforce UTF-8 on exception message.
+   * Added PHP 7.4-snapshot to unit tests. 
 
 * 6.2.0 (2019-10-19)
    * Changed how auto-converter checks for supported classes (see [Data Conversion](docs/docs.md#data-conversion))
@@ -31,9 +35,9 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
    * 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.
+   * Worked around Laravel's config merger not working properly with multi-dimensional config arrays.
    * Corrected ApiCodesTests trait failing on some methods.
-   * Included ApiCodesTest trait in base tests to avoid desync in future releases.
+   * Included ApiCodesTest trait in base tests to avoid de-sync in future releases.
    * Removed custom response keys mapping feature.
 
 * v6.0.0 (2019-09-20)
@@ -58,7 +62,7 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
    * 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.
+   * Removed internal API code constants. Use corresponding methods to get proper 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. 
@@ -116,7 +120,7 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
    * **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-37]` Added support for Laravel 5.3+ `unauthenticated()` in Exception Handler. See new config keys defaults
    * `[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)

README.md

@@ -10,7 +10,7 @@
 [![Monthly Downloads](https://poser.pugx.org/marcin-orlowski/laravel-api-response-builder/d/monthly)](https://packagist.org/packages/marcin-orlowski/laravel-api-response-builder)
 [![License](https://poser.pugx.org/marcin-orlowski/laravel-api-response-builder/license)](https://packagist.org/packages/marcin-orlowski/laravel-api-response-builder)
 
-[![SensioLabsInsight](https://insight.sensiolabs.com/projects/5c5f4dc1-41d5-49f9-b4ba-6268aa3fea00/big.png)](https://insight.sensiolabs.com/projects/5c5f4dc1-41d5-49f9-b4ba-6268aa3fea00)
+[![SensioLabs Insight](https://insight.sensiolabs.com/projects/5c5f4dc1-41d5-49f9-b4ba-6268aa3fea00/big.png)](https://insight.sensiolabs.com/projects/5c5f4dc1-41d5-49f9-b4ba-6268aa3fea00)
 
 [![Latest Unstable Version](https://poser.pugx.org/marcin-orlowski/laravel-api-response-builder/v/unstable)](https://packagist.org/packages/marcin-orlowski/laravel-api-response-builder)
 [![Build Status](https://travis-ci.org/MarcinOrlowski/laravel-api-response-builder.svg?branch=dev)](https://travis-ci.org/MarcinOrlowski/laravel-api-response-builder)
@@ -19,7 +19,7 @@
 
 ## Table of contents ##
 
- * [Intriduction](#introduction)
+ * [Introduction](#introduction)
  * [Why should I use it?](#benefits)
  * [Usage examples](#usage-examples)
  * [Features](#features)
@@ -36,16 +36,16 @@
 
 ## Introduction ##
 
- `ResponseBuilder` is [Laravel](https://laravel.com/)'s helper designed to simplify building  nice, normalized and standarized
- and easy to consume REST API JSON responses.
+ `ResponseBuilder` is [Laravel](https://laravel.com/)'s helper designed to build nice, normalized and easy to consume REST API 
+ JSON responses.
 
 ## Benefits ##
 
- `ResponseBuilder` is written for REST API developers by REST API developer and is based on my long lasting experiencde on both
+ `ResponseBuilder` is written for REST API developers by REST API developer and is based on my long lasting experience on both
  "sides" (API dev and API consumer) of variety of REST APIs. Lightweight, with simple to use public methods, covering multiple 
  potential use-cases, on-the-fly data conversion, localization support, automatic error message building, support
- for chainged APIs and (hopefuly) exhaustive documentation. But that's not all! The JSON structure produced by `ResponseBuilder` 
- is desinged with **users of your API** in mind, which helps them easily deal with your API with ease. They get simple, well
+ for chained APIs and (hopefully) exhaustive documentation. But that's not all! The JSON structure produced by `ResponseBuilder` 
+ is designed with **users of your API** in mind, which helps them easily deal with your API with ease. They get simple, well
  defined and predictable JSON structure responses with all the fields needed to consume it without any unnecessary a hassle nor 
  other trickery. 
 
@@ -97,13 +97,13 @@
 
  * Easy to use,
  * [Stable and production ready](https://travis-ci.org/MarcinOrlowski/laravel-api-response-builder),
- * Laravel compatibility: v6.x (see [legacy support](docs/legacy.md) for support for older versions),
+ * Laravel compatibility: v6.x (see [legacy support](docs/legacy.md) if you use older Laravel version),
  * 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,
  * API chaining/cascading support,
- * Includes traits to help [unit testing your API code](docs/testing.md),
+ * Includes traits to help [unit test 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.
 

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.1",
+  "version": "6.2.2",
   "keywords": [
     "laravel",
     "json",

config/response_builder.php

@@ -5,7 +5,7 @@
  *
  * See docs/config.md for detailed documentation
  *
- * @author    Marcin Orlowski <mail (#) marcinorlowski (.) com>
+ * @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
@@ -57,7 +57,7 @@
 
 	/*
 	|-----------------------------------------------------------------------------------------------------------
-	| data-to-json encodong options
+	| data-to-json encoding options
 	|-----------------------------------------------------------------------------------------------------------
 	|
 	*/

docs/compatibility.md

@@ -27,7 +27,7 @@
  need to get the value of built in code, use  what's the value You can still have If you need to get the value of
  built-in code you need to use replacement methods. These are named the same way as the constants, so if you want to get code 
  of `ApiCodes::OK` you need to call `ApiCodes::OK()` (or directly, `BaseApiCodes::OK()`). See `BaseApiCodes` class for all
- available public functions. Additionally, first 20 codes (0 to 19 incluside) of your code range is reserved for built-in codes, 
+ available public functions. Additionally, first 20 codes (0 to 19 inclusive) of your code range is reserved for built-in codes, 
  which means that if you define your code range to be `100`-`199` then you cannot use codes `100` to `119` for own purposes.
  The first code you can assign to own API code is `120`. 
  * `[Low]` Removed `exception_handler.use_exception_message_first` feature.
@@ -62,7 +62,7 @@
  * ApiCodeBase's `getErrorCodeConstants()` is now `getApiCodeConstants()`
  * ApiCodeBase's `getMapping()` is now `getCodeMessageKey()`
  * ApiCodeBase's `getBaseMapping()` is now `getReservedCodeMessageKey()`
- * Internal constants for `ExeceptionHandlerHelper` supported exceptions are now prefixed with `EX_` (i.e. `HTTP_NOT_FOUND`
+ * Internal constants for `ExceptionHandlerHelper` supported exceptions are now prefixed with `EX_` (i.e. `HTTP_NOT_FOUND`
  is now `EX_HTTP_NOT_FOUND`)
 
 

docs/config.md

@@ -6,7 +6,7 @@
 
     php artisan vendor:publish
 
- If you are fine with the defaults, this step can safely be ommited. You can also remove published `config/response_builder.php`
+ If you are fine with the defaults, this step can safely be omitted. You can also remove published `config/response_builder.php`
  file if exists.
 
 # Configuration options #
@@ -38,7 +38,7 @@ The entry key is a class name to check passed `data` object against, and configu
 Where `method` is a name of the method to that `ResponseBuilder` should call on the object to obtain array representation of its 
 internal state, while `key` is a string that will be used as the JSON response as key to array representation.
 
-**NOTE:** order or entries matters as matching is done in order of appearance and is done using PHP's `instanceof`. 
+**NOTE:** order or entries matters as matching is done in order of appearance and is done using PHP `instanceof`. 
 So if you have class `A` and `B` that extends `A` and you want different handling for `B` than you have set for `A` 
 then `B` related configuration must be put first.
 

docs/docs.md

@@ -2,8 +2,8 @@
 
 # REST API Response Builder for Laravel #
 
- `ResponseBuilder` is [Laravel](https://laravel.com/)'s helper designed to simplify building
- nice, normalized and easy to consume REST API responses.
+ `ResponseBuilder` is [Laravel](https://laravel.com/)'s helper designed to build
+ nice, normalized and easy to consume REST API JSON responses.
 
 ## Table of contents ##
 
@@ -26,10 +26,10 @@
 ## Response structure ##
 
  Predictability, simplicity and no special-case is the key of the `ResponseBuilder` design. I wanted to make my life easier not
- only when I develop the API itself, but also when I'd try to use it i.e. in mobile applicationsm, therefore response created with
- this package **guarantees** consisten JSON structure.
+ only when I develop the API itself, but also when I'd try to use it i.e. in mobile applications, therefore all responses created
+ by this package **guarantee** consistent JSON structure by design.
 
- Default response will always contains at least the following elements:
+ By default response always contain at least the following elements:
 
 ```json
 {
@@ -49,7 +49,7 @@
   * `message` (**string**) human readable message that is ready to display and explains human readable explanation of the `code` value,
   * `data` (**object**|**array**|**null**) if you return any additional data with your reply, it would end here. If no extra data is needed, that key still be present in the response with `null` value.
 
- **NOTE:** If you need to return other/different elements in the aboive structure (not in your `data`), see [Manipulating Response Object](#manipulating-response-object) chapter for detailed information about how to achieve this.
+ **NOTE:** If you need to return other/different elements in the above structure (not in your `data`), see [Manipulating Response Object](#manipulating-response-object) chapter for detailed information about how to achieve this.
 
 ----
 
@@ -237,7 +237,7 @@ return ResponseBuilder::errorWithMessage(ApiCodeBase::SOMETHING_WENT_WRONG, $msg
  API invocations in the way that in case of problems (and cascading failure) I still would able to tell which one failed first. 
  For example our API client app calls method of publicly exposed API "A". That API "A" internally calls method of completely
  different and separate API "B". Under the hood API "B" delegates some work and talks to API "C". When something go wrong and
- "C"'s metod fail, client shall see "C"'s error code and error message, not the "A"'s. To acheive this each API you chain return
+ "C"'s method fail, client shall see "C"'s error code and error message, not the "A"'s. To achieve this each API you chain return
  unique error codes and the values are unique per whole chain To support that `ResponseBuilder` features code ranges, allowing 
  you to configure `min_code` and `max_code` you want to be allowed to use in given API. `ResponseBuilder` will ensure no values not
  from that range is ever returned, so to make the whole chain "clear", you only need to properly assign non-overlapping ranges to 
@@ -389,8 +389,8 @@ return ResponseBuilder::success($flights);
 ],
 ```
 
- The above confgures two classes (`Model` and `Collection`). Whenver object of that class is spotted, method specified in `method` 
- key would be called on that obhject and data that method returns will be returned in JSON object using key specidied in `key`.
+ The above configures two classes (`Model` and `Collection`). Whenever object of that class is spotted, method specified in `method` 
+ key would be called on that object and data that method returns will be returned in JSON object using key specified in `key`.
 
  So in above example, if we get `Collection`, then `ResponseBuilder` would call `toArray()` on it, and result data would
  be added in returned JSON in `items` object.
@@ -649,5 +649,5 @@ MarcinOrlowski\ResponseBuilder\BaseApiCodes::NO_ERROR_MESSAGE() => 'my_messages.
 
 ## License ##
 
- * Written and copyrighted &copy;2016-2019 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
+ * Written and copyrighted &copy;2016-2019 by Marcin Orlowski <mail (#) marcinOrlowski (.) com>
  * ResponseBuilder is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

src/ApiCodesHelpers.php

@@ -8,7 +8,7 @@
  *
  * @package   MarcinOrlowski\ResponseBuilder
  *
- * @author    Marcin Orlowski <mail (#) marcinorlowski (.) com>
+ * @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