Close #178

Author: neomerx

.travis.yml

@@ -1,12 +1,12 @@
 language: php
 php:
-- 5.5
 - 5.6
-- hhvm
 - 7
 - 7.1
 matrix:
   include:
+    - php: hhvm
+      dist: trusty
     - php: 5.5
       script:
       - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover

README.md

@@ -33,7 +33,7 @@ High code quality and **100% test coverage** with **250+ tests**. Production rea
 
 ## Full-stack Integration
 
-This package is framework agnostic and if you are looking for practical usage sample you might be interested in Quick start JSON API server application [Limoncello Flute](https://github.com/neomerx/limoncello-flute).
+This package is framework agnostic and if you are looking for practical usage sample you might be interested in Quick start JSON API server application [Limoncello App](https://github.com/limoncello-php/app).
 
 The server supports
 - CRUD operations for a few sample data models and Users.
@@ -42,7 +42,7 @@ The server supports
 - Support for such JSON API features as resource inclusion, pagination and etc.
 
 <p align="center">
-<a href="https://github.com/neomerx/limoncello-flute" target="_blank"><img src="https://github.com/neomerx/limoncello-flute/blob/master/resources/img/screen-shot.png" alt="Demo app screen-shot" title="Limoncello Flute" align="middle" width="330" height="252" /></a>
+<a href="https://github.com/limoncello-php/app" target="_blank"><img src="https://github.com/limoncello-php/app/raw/master/resources/img/screen-shot.png" alt="Demo app screen-shot" title="Limoncello App" align="middle" width="330" height="252" /></a>
 </p>
 
 ## Sample usage
@@ -107,7 +107,7 @@ The second ```EncoderOptions``` parameter ```http://example.com/api/v1``` is a U
 
 ## Questions?
 
-Do not hesitate to contact us on [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/neomerx/json-api) or post an [issue](https://github.com/neomerx/json-api/issues).
+Do not hesitate to check [issues](https://github.com/neomerx/json-api/issues) or post a new one.
 
 ## Need help?
 

composer.json

@@ -48,6 +48,7 @@
   "scripts": {
     "test": ["@test-unit", "@test-cs", "@test-md"],
     "test-unit": "./vendor/phpunit/phpunit/phpunit --coverage-text",
+    "test-unit-with-coverage": "phpdbg -qrr ./vendor/bin/phpunit --coverage-text",
     "test-cs": "./vendor/bin/phpcs -p -s --standard=PSR2 ./src ./tests",
     "test-md": "./vendor/bin/phpmd ./src text codesize,controversial,cleancode,design,unusedcode,naming",
 

sample/composer.json

@@ -13,14 +13,7 @@
             "Neomerx\\Samples\\JsonApi\\": "./"
         }
     },
-    "minimum-stability": "dev",
-    "repositories": [
-        {
-            "type": "vcs",
-            "url": "https://github.com/neomerx/json-api"
-        }
-    ],
     "require": {
-        "neomerx/json-api": "^0.8.8"
+        "neomerx/json-api": "dev-develop"
     }
 }

src/Contracts/Encoder/EncoderInterface.php

@@ -69,6 +69,8 @@ public function withJsonApiVersion($meta = null);
      * @see http://jsonapi.org/format/#fetching-relationships
      *
      * @return EncoderInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function withRelationshipSelfLink($resource, $relationshipName, $meta = null, $treatAsHref = false);
 
@@ -83,6 +85,8 @@ public function withRelationshipSelfLink($resource, $relationshipName, $meta = n
      * @see http://jsonapi.org/format/#fetching-relationships
      *
      * @return EncoderInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function withRelationshipRelatedLink($resource, $relationshipName, $meta = null, $treatAsHref = false);
 

src/Contracts/Http/Headers/HeaderParametersInterface.php

@@ -29,9 +29,9 @@ interface HeaderParametersInterface
     public function getMethod();
 
     /**
-     * Get get 'Content-Type' header.
+     * Get get 'Content-Type' header if request has body and `null` otherwise.
      *
-     * @return HeaderInterface
+     * @return HeaderInterface|null
      */
     public function getContentTypeHeader();
 

src/Contracts/Http/Headers/HeaderParametersParserInterface.php

@@ -27,8 +27,11 @@ interface HeaderParametersParserInterface
      * Parse input parameters from request.
      *
      * @param ServerRequestInterface $request
+     * @param bool                   $checkContentType
      *
      * @return HeaderParametersInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
-    public function parse(ServerRequestInterface $request);
+    public function parse(ServerRequestInterface $request, $checkContentType = true);
 }

src/Contracts/Http/HttpFactoryInterface.php

@@ -88,6 +88,14 @@ public function createQueryParameters(
      */
     public function createHeaderParameters($method, AcceptHeaderInterface $accept, HeaderInterface $contentType);
 
+    /**
+     * @param string                $method
+     * @param AcceptHeaderInterface $accept
+     *
+     * @return HeaderParametersInterface
+     */
+    public function createNoContentHeaderParameters($method, AcceptHeaderInterface $accept);
+
     /**
      * Create parameters parser.
      *
@@ -171,6 +179,8 @@ public function createHeadersChecker(CodecMatcherInterface $codecMatcher);
      * @param array|null $filteringParameters
      *
      * @return QueryCheckerInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function createQueryChecker(
         $allowUnrecognized = false,

src/Contracts/Schema/SchemaFactoryInterface.php

@@ -70,6 +70,8 @@ public function createResourceObject(
      * @param bool                                                          $isRoot
      *
      * @return RelationshipObjectInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function createRelationshipObject($name, $data, $links, $meta, $isShowData, $isRoot);
 
@@ -81,6 +83,8 @@ public function createRelationshipObject($name, $data, $links, $meta, $isShowDat
      * @param bool              $treatAsHref If $subHref is a full URL and must not be concatenated with other URLs.
      *
      * @return LinkInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function createLink($subHref, $meta = null, $treatAsHref = false);
 

src/Contracts/Schema/SchemaProviderInterface.php

@@ -67,6 +67,8 @@ public function getSelfSubLink($resource);
      * @param bool       $treatAsHref
      *
      * @return LinkInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function getRelationshipSelfLink($resource, $name, $meta = null, $treatAsHref = false);
 
@@ -79,6 +81,8 @@ public function getRelationshipSelfLink($resource, $name, $meta = null, $treatAs
      * @param bool       $treatAsHref
      *
      * @return LinkInterface
+     *
+     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
     public function getRelationshipRelatedLink($resource, $name, $meta = null, $treatAsHref = false);