Update tests, update CHANGELOG

Author: Art4

CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+
+### Added
+
+- New method `Utils\Helper::parseResponseBody()` to parse a JSON API response body
+- New method `Utils\Helper::isValidResponseBody()` to validate a JSON API response body
+- New method `Utils\Helper::isValidRequestBody()` to validate a JSON API request body with optional item id
+
+### Deprecated
+
+- `Utils\Helper::parse()` will be removed in v1.0, use `Utils\Helper::parseResponseBody()` instead
+- `Utils\Helper::isValid()` will be removed in v1.0, use `Utils\Helper::isValidResponseBody()` instead
+
 ## [0.8.1] - 2017-06-01
 
 ### Fixed

composer.json

@@ -3,20 +3,20 @@
     "type": "library",
     "description": "JSON API client",
     "homepage": "https://github.com/Art4/json-api-client",
-    "keywords": ["json", "api", "json-api", "client", "reader", "validator"],
-    "license": "GPL2",
+    "keywords": ["json", "api", "json-api", "client", "reader", "validator", "parser"],
+    "license": "GPL3",
     "authors": [
         {
             "name": "Artur Weigandt",
             "email": "art4@wlabs.de",
-            "homepage": "http://wlabs.de"
+            "homepage": "https://wlabs.de"
         }
     ],
     "require": {
         "php": "^5.5 || ^7.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8.35 || ^6.0"
+        "phpunit/phpunit": "^4.8.35 || ^5.4.3 || ^6.0"
     },
     "autoload": {
         "psr-4": {
@@ -27,5 +27,11 @@
         "psr-4": {
             "Art4\\JsonApiClient\\Tests\\": "tests"
         }
+    },
+    "config": {
+        "//platform": {
+            "php": "5.5"
+        },
+        "sort-packages": true
     }
 }

tests/Integration/DotNotationTest.php

@@ -32,7 +32,7 @@ class DotNotationTest extends \Art4\JsonApiClient\Tests\Fixtures\TestCase
 	public function testCompleteResourceObjectWithMultipleRelationships()
 	{
 		$string = $this->getJsonString('04_complete_document_with_multiple_relationships.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 
@@ -197,7 +197,7 @@ public function testCompleteResourceObjectWithMultipleRelationships()
 	public function testGetNotExistentValueThrowsException()
 	{
 		$string = $this->getJsonString('05_simple_meta_object.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		// Test 3 segments, segment 2 don't exists
 		$this->assertFalse($document->has('meta.foobar.zap'));

tests/Integration/ErrorParsingTest.php

@@ -32,7 +32,7 @@ class ErrorParsingTest extends \Art4\JsonApiClient\Tests\Fixtures\TestCase
 	public function testParseErrors()
 	{
 		$string = $this->getJsonString('09_errors.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertTrue($document->has('errors'));
@@ -107,7 +107,7 @@ public function testParseErrors()
 	public function testParseErrorWithLinks()
 	{
 		$string = $this->getJsonString('10_error_with_links.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertTrue($document->has('errors'));

tests/Integration/ParsingTest.php

@@ -32,7 +32,7 @@ class ParsingTest extends \Art4\JsonApiClient\Tests\Fixtures\TestCase
 	public function testParseSimpleResource()
 	{
 		$string = $this->getJsonString('01_simple_resource.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));
@@ -63,7 +63,7 @@ public function testParseSimpleResource()
 	public function testParseSimpleResourceIdentifier()
 	{
 		$string = $this->getJsonString('02_simple_resource_identifier.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));
@@ -90,7 +90,7 @@ public function testParseSimpleResourceIdentifier()
 	public function testParseResourceObject()
 	{
 		$string = $this->getJsonString('03_resource_object.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));
@@ -161,7 +161,7 @@ public function testParseResourceObject()
 	public function testParseCompleteResourceObjectWithMultipleRelationships()
 	{
 		$string = $this->getJsonString('04_complete_document_with_multiple_relationships.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));
@@ -339,7 +339,7 @@ public function testParseCompleteResourceObjectWithMultipleRelationships()
 	public function testParsePaginationExample()
 	{
 		$string = $this->getJsonString('06_pagination_example.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertTrue($document->has('data'));
@@ -396,7 +396,7 @@ public function testParsePaginationExample()
 	public function testParseRelationshipExample()
 	{
 		$string = $this->getJsonString('07_relationship_example_without_data.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertTrue($document->has('data'));
@@ -465,7 +465,7 @@ public function testParseRelationshipExample()
 	public function testParseObjectLinksExample()
 	{
 		$string = $this->getJsonString('08_object_links.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertTrue($document->has('links'));
@@ -511,7 +511,7 @@ public function testParseObjectLinksExample()
 	public function testParseResourceIdentifierWithMeta()
 	{
 		$string = $this->getJsonString('11_resource_identifier_with_meta.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));
@@ -540,7 +540,7 @@ public function testParseResourceIdentifierWithMeta()
 	public function testParseNullResource()
 	{
 		$string = $this->getJsonString('12_null_resource.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));
@@ -564,7 +564,7 @@ public function testParseNullResource()
 	public function testParseResourceIdentifierCollectionWithMeta()
 	{
 		$string = $this->getJsonString('13_collection_with_resource_identifier_with_meta.json');
-		$document = Helper::parse($string);
+		$document = Helper::parseResponseBody($string);
 
 		$this->assertInstanceOf('Art4\JsonApiClient\Document', $document);
 		$this->assertFalse($document->has('errors'));

tests/Unit/Utils/HelperTest.php

@@ -161,7 +161,7 @@ public function testParseWithValidJsonapiReturnsDocument()
 	{
 		$jsonapi = '{"meta":{}}';
 
-		$this->assertInstanceOf('Art4\JsonApiClient\Document', Helper::parse($jsonapi));
+		$this->assertInstanceOf('Art4\JsonApiClient\Document', Helper::parseResponseBody($jsonapi));
 	}
 
 	/**
@@ -173,7 +173,7 @@ public function testParseWithInvalidJsonapiThrowsException()
 	{
 		$invalid_jsonapi = '["This is valid JSON", "but invalid JSON API"]';
 
-		$output = Helper::parse($invalid_jsonapi);
+		$output = Helper::parseResponseBody($invalid_jsonapi);
 	}
 
 	/**
@@ -185,7 +185,7 @@ public function testParseWithInvalidJsonThrowsException()
 	{
 		$invalid_json = 'invalid_json_string';
 
-		$output = Helper::parse($invalid_json);
+		$output = Helper::parseResponseBody($invalid_json);
 	}
 
 	/**