ApiHttpProvider => ApiHttpServiceProvider

Author: dominikzogg

README.md

@@ -14,9 +14,9 @@ A simple http handler implementation for API.
 ## Requirements
 
  * php: ^7.2
- * chubbyphp/chubbyphp-deserialization: ^2.14
- * chubbyphp/chubbyphp-negotiation: ^1.4
- * chubbyphp/chubbyphp-serialization: ^2.11
+ * chubbyphp/chubbyphp-deserialization: ^2.15
+ * chubbyphp/chubbyphp-negotiation: ^1.5
+ * chubbyphp/chubbyphp-serialization: ^2.12
  * psr/http-factory: ^1.0.1
  * psr/http-message: ^1.0.1
  * psr/http-server-middleware: ^1.0.1
@@ -26,7 +26,7 @@ A simple http handler implementation for API.
 Through [Composer](http://getcomposer.org) as [chubbyphp/chubbyphp-api-http][1].
 
 ```sh
-composer require chubbyphp/chubbyphp-api-http "^3.2"
+composer require chubbyphp/chubbyphp-api-http "^3.3"
 ```
 
 ## Usage
@@ -35,7 +35,7 @@ composer require chubbyphp/chubbyphp-api-http "^3.2"
  * [RequestManager][3]
  * [ResponseManager][4]
  * [AcceptAndContentTypeMiddleware][5]
- * [ApiHttpProvider][6]
+ * [ApiHttpServiceProvider][6]
  * [ApiProblemMapping (example)][7]
 
 ## Copyright
@@ -47,5 +47,5 @@ Dominik Zogg 2019
 [3]: doc/Manager/RequestManager.md
 [4]: doc/Manager/ResponseManager.md
 [5]: doc/Middleware/AcceptAndContentTypeMiddleware.md
-[6]: doc/Provider/ApiHttpProvider.md
+[6]: doc/ServiceProvider/ApiHttpServiceProvider.md
 [7]: doc/Serialization/ApiProblemMapping.md

composer.json

@@ -11,9 +11,9 @@
     ],
     "require": {
         "php": "^7.2",
-        "chubbyphp/chubbyphp-deserialization": "^2.14",
-        "chubbyphp/chubbyphp-negotiation": "^1.4",
-        "chubbyphp/chubbyphp-serialization": "^2.11",
+        "chubbyphp/chubbyphp-deserialization": "^2.15",
+        "chubbyphp/chubbyphp-negotiation": "^1.5",
+        "chubbyphp/chubbyphp-serialization": "^2.12",
         "psr/http-factory": "^1.0.1",
         "psr/http-message": "^1.0.1",
         "psr/http-server-middleware": "^1.0.1"
@@ -42,7 +42,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.2-dev"
+            "dev-master": "3.3-dev"
         }
     },
     "scripts": {
@@ -59,7 +59,7 @@
         ],
         "test:cs": "mkdir -p build && vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation --cache-file=build/phpcs.cache",
         "test:infection": "vendor/bin/infection --threads=$(nproc) --min-msi=100 --verbose --coverage=build/phpunit",
-        "test:insights": "mkdir -p build && bash -c 'vendor/bin/phpinsights analyse -v --no-interaction --min-quality=92 --disable-security-check | tee build/phpinsights.log; if [ ${PIPESTATUS[0]} -ne \"0\" ]; then exit 1; fi'",
+        "test:insights": "mkdir -p build && bash -c 'vendor/bin/phpinsights analyse -v --no-interaction --min-quality=94 --disable-security-check | tee build/phpinsights.log; if [ ${PIPESTATUS[0]} -ne \"0\" ]; then exit 1; fi'",
         "test:integration": "vendor/bin/phpunit --testsuite=Integration --cache-result-file=build/phpunit/phpunit.result.cache",
         "test:lint": "mkdir -p build && find src tests -name '*.php' -print0 | xargs -0 -n1 -P$(nproc) php -l | tee build/phplint.log",
         "test:loc": "mkdir -p build && vendor/bin/phploc src --verbose | tee build/phploc.log",

doc/Provider/ApiHttpProvider.md

@@ -0,0 +1,22 @@
+# ApiHttpServiceProvider
+
+```php
+<?php
+
+use Chubbyphp\ApiHttp\ServiceProvider\ApiHttpServiceProvider;
+use Chubbyphp\Deserialization\ServiceProvider\DeserializationServiceProvider;
+use Chubbyphp\Serialization\ServiceProvider\SerializationServiceProvider;
+use Pimple\Container;
+
+$container = new Container();
+$container->register(new DeserializationServiceProvider());
+$container->register(new SerializationServiceProvider());
+$container->register(new ApiHttpServiceProvider());
+
+$container['api-http.request.manager']->getDataFromRequestQuery(...);
+
+$container['api-http.response.manager']->create(...);
+
+$container['api-http.response.factory']->createResponse(...);
+// must be defined, implement the ResponseFactoryInterface
+```

doc/ServiceProvider/ApiHttpServiceProvider.md

@@ -2,31 +2,6 @@
 
 declare(strict_types=1);
 
-namespace Chubbyphp\ApiHttp\Provider;
+use Chubbyphp\ApiHttp\ServiceProvider\ApiHttpServiceProvider;
 
-use Chubbyphp\ApiHttp\Manager\RequestManager;
-use Chubbyphp\ApiHttp\Manager\ResponseManager;
-use Pimple\Container;
-use Pimple\ServiceProviderInterface;
-
-final class ApiHttpProvider implements ServiceProviderInterface
-{
-    public function register(Container $container): void
-    {
-        $container['api-http.request.manager'] = static function () use ($container) {
-            return new RequestManager($container['deserializer']);
-        };
-
-        $container['api-http.response.manager'] = static function () use ($container) {
-            return new ResponseManager(
-                $container['deserializer'],
-                $container['api-http.response.factory'],
-                $container['serializer']
-            );
-        };
-
-        $container['api-http.response.factory'] = static function (): void {
-            throw new \RuntimeException('Missing response factory, define service "api-http.response.factory"');
-        };
-    }
-}
+class_alias(ApiHttpServiceProvider::class, 'Chubbyphp\ApiHttp\Provider\ApiHttpProvider');

src/Provider/ApiHttpProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Chubbyphp\ApiHttp\ServiceProvider;
+
+use Chubbyphp\ApiHttp\Manager\RequestManager;
+use Chubbyphp\ApiHttp\Manager\ResponseManager;
+use Pimple\Container;
+use Pimple\ServiceProviderInterface;
+
+final class ApiHttpServiceProvider implements ServiceProviderInterface
+{
+    public function register(Container $container): void
+    {
+        $container['api-http.request.manager'] = static function () use ($container) {
+            return new RequestManager($container['deserializer']);
+        };
+
+        $container['api-http.response.manager'] = static function () use ($container) {
+            return new ResponseManager(
+                $container['deserializer'],
+                $container['api-http.response.factory'],
+                $container['serializer']
+            );
+        };
+
+        $container['api-http.response.factory'] = static function (): void {
+            throw new \RuntimeException('Missing response factory, define service "api-http.response.factory"');
+        };
+    }
+}

src/ServiceProvider/ApiHttpServiceProvider.php

@@ -25,21 +25,24 @@ final class ApiHttpProviderTest extends TestCase
 
     public function testRegister(): void
     {
+        /** @var ResponseFactoryInterface $responseFactory */
+        $responseFactory = $this->getMockByCalls(ResponseFactoryInterface::class);
+
         $container = new Container();
         $container->register(new ApiHttpProvider());
         $container->register(new DeserializationProvider());
         $container->register(new SerializationProvider());
 
-        $container['api-http.response.factory'] = function () {
-            return $this->getMockByCalls(ResponseFactoryInterface::class);
+        $container['api-http.response.factory'] = function () use ($responseFactory) {
+            return $responseFactory;
         };
 
         self::assertTrue(isset($container['api-http.response.manager']));
         self::assertTrue(isset($container['api-http.response.factory']));
 
         self::assertInstanceOf(RequestManager::class, $container['api-http.request.manager']);
         self::assertInstanceOf(ResponseManager::class, $container['api-http.response.manager']);
-        self::assertInstanceOf(ResponseFactoryInterface::class, $container['api-http.response.factory']);
+        self::assertSame($responseFactory, $container['api-http.response.factory']);
     }
 
     public function testFactoryExpectException(): void

tests/Unit/Provider/ApiHttpProviderTest.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Chubbyphp\Tests\ApiHttp\Unit\ServiceProvider;
+
+use Chubbyphp\ApiHttp\Manager\RequestManager;
+use Chubbyphp\ApiHttp\Manager\ResponseManager;
+use Chubbyphp\ApiHttp\ServiceProvider\ApiHttpServiceProvider;
+use Chubbyphp\Deserialization\ServiceProvider\DeserializationServiceProvider;
+use Chubbyphp\Mock\MockByCallsTrait;
+use Chubbyphp\Serialization\ServiceProvider\SerializationServiceProvider;
+use PHPUnit\Framework\TestCase;
+use Pimple\Container;
+use Psr\Http\Message\ResponseFactoryInterface;
+
+/**
+ * @covers \Chubbyphp\ApiHttp\ServiceProvider\ApiHttpServiceProvider
+ *
+ * @internal
+ */
+final class ApiHttpServiceProviderTest extends TestCase
+{
+    use MockByCallsTrait;
+
+    public function testRegister(): void
+    {
+        /** @var ResponseFactoryInterface $responseFactory */
+        $responseFactory = $this->getMockByCalls(ResponseFactoryInterface::class);
+
+        $container = new Container();
+        $container->register(new ApiHttpServiceProvider());
+        $container->register(new DeserializationServiceProvider());
+        $container->register(new SerializationServiceProvider());
+
+        $container['api-http.response.factory'] = function () use ($responseFactory) {
+            return $responseFactory;
+        };
+
+        self::assertTrue(isset($container['api-http.response.manager']));
+        self::assertTrue(isset($container['api-http.response.factory']));
+
+        self::assertInstanceOf(RequestManager::class, $container['api-http.request.manager']);
+        self::assertInstanceOf(ResponseManager::class, $container['api-http.response.manager']);
+        self::assertSame($responseFactory, $container['api-http.response.factory']);
+    }
+
+    public function testFactoryExpectException(): void
+    {
+        self::expectException(\RuntimeException::class);
+        self::expectExceptionMessage('Missing response factory, define service "api-http.response.factory"');
+
+        $container = new Container();
+        $container->register(new ApiHttpServiceProvider());
+
+        $container['api-http.response.factory'];
+    }
+}