Merge pull request #6 from Landerstraeten/add-bad-request-problem

Add Bad Request problem

Author: veewee

.travis.yml

@@ -1,44 +1,27 @@
 language: php
 
-env:
-    global:
-        - DEFAULT_COMPOSER_FLAGS="--optimize-autoloader --no-interaction --no-progress"
-        - COMPOSER_FLAGS=""
-
-before_install:
-    - alias composer=composer\ --no-interaction && composer selfupdate
+php:
+  - 7.2
+  - 7.3
+  - 7.4
+  - nightly
 
 cache:
   directories:
-    - .composer/cache
+    - ~/.cache/composer
 
 matrix:
   fast_finish: true
   allow_failures:
     - php: nightly
 
-jobs:
-    include:
-        - &STANDARD_TEST_JOB
-            stage: Test
-            php: 7.2
-            install:
-                - travis_retry composer update $DEFAULT_COMPOSER_FLAGS $COMPOSER_FLAGS
-                - composer info -D | sort
-            script:
-                - vendor/bin/grumphp run
-        -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: 7.2
-            env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
-        -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: nightly
-            env: COMPOSER_FLAGS="--ignore-platform-reqs" PHP_CS_FIXER_IGNORE_ENV=1 PHP_CS_FIXER_FUTURE_MODE=1
-            script:
-                - vendor/bin/grumphp run
+before_install:
+  - phpenv config-rm xdebug.ini
+  - alias composer=composer\ --no-interaction && composer selfupdate
+  - composer global require hirak/prestissimo
+
+install:
+  - travis_retry composer update --no-progress --profile --no-scripts --no-suggest $DEPENDENCIES
 
-    allow_failures:
-        - php: nightly
+script:
+  - vendor/bin/grumphp run

README.md

@@ -40,6 +40,7 @@ throw new ApiProblemException(
 - [NotFoundProblem](#notfoundproblem)
 - [UnauthorizedProblem](#unauthorizedproblem)
 - [ValidationApiProblem](#validationapiproblem)
+- [BadRequestProblem](#badrequestproblem)
 
 #### ExceptionApiProblem
 
@@ -188,10 +189,27 @@ new ValidationApiProblem(new ConstraintViolationList([
 }
 ````
 
+#### BadRequestProblem
+
+```php
+use Phpro\ApiProblem\Http\BadRequestProblem;
+
+new BadRequestProblem('Bad request. Bad!.');
+```
+
+```json
+{
+    "status": 400,
+    "type": "http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html",
+    "title": "Bad Request",
+    "detail": "Bad request. Bad!"
+}
+````
+
 
 ### Creating your own problem
 
-Creating problem sounds scarry right!?
+Creating problem sounds scary right!?
 Since the RFC is very loose, we made the interface as easy as possible:
 
 ```php
@@ -238,7 +256,7 @@ class MyProblem implements DebuggableApiProblemInterface
         return [
             'type' => 'about:blank',
             'status' => '99',
-            'title' => 'Got 99 problems but a glitch aint one!',
+            'title' => 'Got 99 problems but a glitch ain\'t one!',
         ];
     }
 

composer.json

@@ -4,9 +4,9 @@
     "type": "library",
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.12",
-        "phpro/grumphp": "^0.14.1",
-        "phpspec/phpspec": "^4.3",
-        "symfony/validator": "^4.1",
+        "phpro/grumphp": "^0.17",
+        "phpspec/phpspec": "^6.0",
+        "symfony/validator": "^4.4",
         "sebastian/comparator": "^1.2.4"
     },
     "license": "MIT",

spec/Http/BadRequestProblemSpec.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\Phpro\ApiProblem\Http;
+
+use Phpro\ApiProblem\Http\BadRequestProblem;
+use Phpro\ApiProblem\Http\HttpApiProblem;
+use PhpSpec\ObjectBehavior;
+
+class BadRequestProblemSpec extends ObjectBehavior
+{
+    public function let(): void
+    {
+        $this->beConstructedWith('a reason');
+    }
+
+    public function it_is_initializable(): void
+    {
+        $this->shouldHaveType(BadRequestProblem::class);
+    }
+
+    public function it_is_an_http_api_problem(): void
+    {
+        $this->shouldHaveType(HttpApiProblem::class);
+    }
+
+    public function it_can_parse_to_array(): void
+    {
+        $this->toArray()->shouldBe([
+            'status' => 400,
+            'type' => HttpApiProblem::TYPE_HTTP_RFC,
+            'title' => HttpApiProblem::getTitleForStatusCode(400),
+            'detail' => 'a reason',
+        ]);
+    }
+}

src/Http/BadRequestProblem.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phpro\ApiProblem\Http;
+
+class BadRequestProblem extends HttpApiProblem
+{
+    public function __construct(string $detail)
+    {
+        parent::__construct(400, [
+            'detail' => $detail,
+        ]);
+    }
+}