Merge branch 'hotfix/6'

Close #6
Close #7

Author: weierophinney

.travis.yml

@@ -20,10 +20,22 @@ matrix:
     - php: 7.1
       env:
         - DEPS=locked
+        - CS_CHECK=true
         - TEST_COVERAGE=true
     - php: 7.1
       env:
         - DEPS=latest
+    - php: nightly
+      env:
+        - DEPS=lowest
+    - php: nightly
+      env:
+        - DEPS=locked
+    - php: nightly
+      env:
+        - DEPS=latest
+  allow_failures:
+    - php: nightly
 
 before_install:
   - if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
@@ -39,7 +51,6 @@ install:
 script:
   - if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi
   - if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi
-  - if [[ $CS_CHECK == 'true' ]]; then composer license-check ; fi
 
 after_script:
   - if [[ $TEST_COVERAGE == 'true' ]]; then composer upload-coverage ; fi

CHANGELOG.md

@@ -2,6 +2,35 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 0.3.0 - 2017-07-31
+
+### Added
+
+- [#7](https://github.com/weierophinney/problem-details/pull/7) adds an explicit
+  dependency on ext/json.
+
+### Changed
+
+- [#7](https://github.com/weierophinney/problem-details/pull/7) updates each
+  of the following to place them under the new `ProblemDetails\Exception`
+  namespace:
+  - `CommonProblemDetailsException`
+  - `InvalidResponseBodyException`
+  - `MissingResponseException`
+  - `ProblemDetailsException`
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 0.2.1 - 2017-06-13
 
 ### Added

CONTRIBUTING.md

@@ -19,7 +19,7 @@ To run tests:
 
   ```console
   $ git clone git://github.com/weierophinney/problem-details.git
-  $ cd zend-expressive
+  $ cd problem-details
   ```
 
 - Install dependencies via composer:
@@ -75,14 +75,14 @@ pull your work into the master repository. We recommend using
 
    ```console
    $ git clone git://github.com/weierophinney/problem-details.git
-   $ cd zend-expressive
+   $ cd problem-details
    ```
 
 4. Add a remote to your fork; substitute your GitHub username in the command
    below.
 
    ```console
-   $ git remote add {username} [email protected]:{username}/zend-expressive.git
+   $ git remote add {username} [email protected]:{username}/problem-details.git
    $ git fetch {username}
    ```
 
@@ -145,7 +145,7 @@ Delta compression using up to 2 threads.
 Compression objects: 100% (18/18), done.
 Writing objects: 100% (20/20), 8.19KiB, done.
 Total 20 (delta 12), reused 0 (delta 0)
-To ssh://[email protected]/{username}/zend-expressive.git
+To ssh://[email protected]/{username}/problem-details.git
    b5583aa..4f51698  HEAD -> master
 ```
 

composer.json

@@ -7,6 +7,7 @@
         "sort-packages": true
     },
     "require": {
+        "ext-json": "*",
         "fig/http-message-util": "^1.1.2",
         "http-interop/http-middleware": "^0.4.1",
         "php": "^7.1",

composer.lock

@@ -7,7 +7,7 @@ details.
 To facilitate this, we provide an interface, `ProblemDetailsException`:
 
 ```php
-namespace ProblemDetails;
+namespace ProblemDetails\Exception;
 
 use JsonSerializable;
 
@@ -50,8 +50,8 @@ transaction problem details, you might do so as follows:
 
 ```php
 use DomainException;
-use ProblemDetails\CommonProblemDetailsException;
-use ProblemDetails\ProblemDetailsException;
+use ProblemDetails\Exception\CommonProblemDetailsException;
+use ProblemDetails\Exception\ProblemDetailsException;
 
 class TransactionException extends DomainException implements ProblemDetailsException
 {
@@ -96,7 +96,7 @@ And it might result in the following:
     "title": "You have insufficient funds to complete the transaction.",
     "detail": "Your transaction required 5.63, but you only have 1.37 in your account",
     "account": "https://example.com/api/accounts/12345",
-    "balance": 1.37,
+    "balance": 1.37
 }
 ```
 

doc/book/exception.md

@@ -19,7 +19,8 @@ This middleware does the following:
   throwing any errors handled as `ErrorException` instances.
 - Wraps a call to the `$delegate` in a `try`/`catch` block; if nothing is
   caught, and a response is returned, it returns the response immediately. If a
-  response is _not_ returned, it raises a `ProblemDetails\MissingResponseException`.
+  response is _not_ returned, it raises a
+  `ProblemDetails\Exception\MissingResponseException`.
 - For all caught throwables, it passes the throwable to
   `ProblemDetailsResponseFactory::createResponseFromThrowable()` to generate a
   Problem Details response.

doc/book/middleware.md

@@ -155,11 +155,11 @@ as the HTTP status if it falls in the 400 or 500 range (500 will be used
 otherwise).
 
 You can also create custom exceptions that provide details for the factory to
-consume by implementing `ProblemDetails\ProblemDetailsException`, which defines
-the following:
+consume by implementing `ProblemDetails\Exception\ProblemDetailsException`,
+which defines the following:
 
 ```php
-namespace ProblemDetails;
+namespace ProblemDetails\Exception;
 
 use JsonSerializable;
 
@@ -211,8 +211,8 @@ By composing this trait, you can easily define custom exception types:
 namespace Api;
 
 use DomainException as PhpDomainException;
-use ProblemDetails\CommonProblemDetailsException;
-use ProblemDetails\ProblemDetailsException;
+use ProblemDetails\Exception\CommonProblemDetailsException;
+use ProblemDetails\Exception\ProblemDetailsException;
 
 class DomainException extends PhpDomainException implements ProblemDetailsException
 {
@@ -249,8 +249,8 @@ a `ProblemDetailsResponseFactory`, and does the following:
 - Otherwise, it creates a PHP error handler that converts PHP errors to
   `ErrorException` instances, and then wraps processing of the delegate in a
   try/catch block. If the delegate does not return a `ResponseInterface`, a
-  `ProblemDetails\MissingResponseException` is raised; otherwise, the response
-  is returned.
+  `ProblemDetails\Exception\MissingResponseException` is raised; otherwise, the
+  response is returned.
 - Any throwable or exception caught is passed to the
   `ProblemDetailsResponseFactory::createResponseFromThrowable()` method, and the
   response generated is returned.

doc/book/quick-start.md

@@ -3,33 +3,26 @@
 namespace ProblemDetails;
 
 /**
- * The configuration provider for the ProblemDetails module
+ * Configuration provider for the package.
  *
  * @see https://docs.zendframework.com/zend-component-installer/
  */
 class ConfigProvider
 {
     /**
-     * Returns the configuration array
-     *
-     * To add a bit of a structure, each section is defined in a separate
-     * method which returns an array with its configuration.
-     *
-     * @return array
+     * Returns the configuration array.
      */
-    public function __invoke()
+    public function __invoke() : array
     {
         return [
             'dependencies' => $this->getDependencies(),
         ];
     }
 
     /**
-     * Returns the container dependencies
-     *
-     * @return array
+     * Returns the container dependencies.
      */
-    public function getDependencies()
+    public function getDependencies() : array
     {
         return [
             'factories'  => [

src/ConfigProvider.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace ProblemDetails;
+namespace ProblemDetails\Exception;
 
 /**
  * Common functionality for ProblemDetailsException implementations.
@@ -66,11 +66,11 @@ public function getAdditionalData() : array
     }
 
     /**
-    * Serialize the exception to an array of problem details.
-    *
-    * Likely useful for the JsonSerializable implementation, but also
-    * for cases where the XML variant is desired.
-    */
+     * Serialize the exception to an array of problem details.
+     *
+     * Likely useful for the JsonSerializable implementation, but also
+     * for cases where the XML variant is desired.
+     */
     public function toArray() : array
     {
         $problem = [
@@ -80,13 +80,18 @@ public function toArray() : array
             'type'   => $this->type,
         ];
 
-        if (! empty($this->additional)) {
+        if ($this->additional) {
             $problem = array_merge($this->additional, $problem);
         }
 
         return $problem;
     }
 
+    /**
+     * Allow serialization via json_encode().
+     *
+     * @return array
+     */
     public function jsonSerialize()
     {
         return $this->toArray();