Feature/improve (#2)

Author: yoanm

src/DependencyInjection/JsonRpcHttpServerOpenAPIDocExtension.php

@@ -0,0 +1,53 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+
+/**
+ * Class JsonRpcHttpServerOpenAPIDocExtension
+ */
+class JsonRpcHttpServerOpenAPIDocExtension implements ExtensionInterface
+{
+    // Extension identifier (used in configuration for instance)
+    const EXTENSION_IDENTIFIER = 'json_rpc_http_server_open_api_doc';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $loader = new YamlFileLoader(
+            $container,
+            new FileLocator(__DIR__.'/../Resources/config')
+        );
+        $loader->load('services.sdk.yaml');
+        $loader->load('services.public.yaml');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getNamespace()
+    {
+        return 'http://example.org/schema/dic/'.$this->getAlias();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getXsdValidationBasePath()
+    {
+        return '';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAlias()
+    {
+        return self::EXTENSION_IDENTIFIER;
+    }
+}

src/Event/OpenAPIDocCreatedEvent.php

@@ -0,0 +1,56 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\Event;
+
+use Yoanm\JsonRpcServerDoc\Model\HttpServerDoc;
+use Yoanm\SymfonyJsonRpcHttpServerDoc\Event\DocEvent;
+
+/**
+ * Class OpenAPIDocCreatedEvent
+ */
+class OpenAPIDocCreatedEvent extends DocEvent
+{
+    const EVENT_NAME = 'json_rpc_http_server_openapi_doc.array_created';
+
+    /** @var array */
+    private $openAPIDoc;
+    /** @var HttpServerDoc|null */
+    private $serverDoc;
+
+    /**
+     * @param array                     $openAPIDoc
+     * @param HttpServerDoc|null $serverDoc
+     */
+    public function __construct(array $openAPIDoc, HttpServerDoc $serverDoc = null)
+    {
+        $this->openAPIDoc = $openAPIDoc;
+        $this->serverDoc = $serverDoc;
+    }
+
+    /**
+     * @return HttpServerDoc
+     */
+    public function getOpenAPIDoc()
+    {
+        return $this->openAPIDoc;
+    }
+
+    /**
+     * @return HttpServerDoc|null
+     */
+    public function getServerDoc()
+    {
+        return $this->serverDoc;
+    }
+
+    /**
+     * @param array $openAPIDoc
+     *
+     * @return OpenAPIDocCreatedEvent
+     */
+    public function setOpenAPIDoc(array $openAPIDoc)
+    {
+        $this->openAPIDoc = $openAPIDoc;
+
+        return $this;
+    }
+}

src/JsonRpcHttpServerOpenAPIDocBundle.php

@@ -0,0 +1,11 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/**
+ * Class JsonRpcHttpServerOpenAPIDocBundle
+ */
+class JsonRpcHttpServerOpenAPIDocBundle extends Bundle
+{
+}

src/Provider/DocProvider.php

@@ -0,0 +1,62 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\Provider;
+
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\DocNormalizer;
+use Yoanm\JsonRpcServerDoc\Model\HttpServerDoc;
+use Yoanm\SymfonyJsonRpcHttpServerDoc\Creator\HttpServerDocCreator;
+use Yoanm\SymfonyJsonRpcHttpServerDoc\Provider\DocProviderInterface;
+use Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\Event\OpenAPIDocCreatedEvent;
+
+/**
+ * Class DocProvider
+ */
+class DocProvider implements DocProviderInterface
+{
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+    /** @var HttpServerDocCreator */
+    private $HttpServerDocCreator;
+    /** @var DocNormalizer */
+    private $docNormalizer;
+
+    /**
+     * @param EventDispatcherInterface $dispatcher
+     * @param HttpServerDocCreator         $HttpServerDocCreator
+     * @param DocNormalizer     $docNormalizer
+     */
+    public function __construct(
+        EventDispatcherInterface $dispatcher,
+        HttpServerDocCreator $HttpServerDocCreator,
+        DocNormalizer $docNormalizer
+    ) {
+        $this->dispatcher = $dispatcher;
+        $this->HttpServerDocCreator = $HttpServerDocCreator;
+        $this->docNormalizer = $docNormalizer;
+    }
+
+    /**
+     * @param string|null $host
+     *
+     * @return array
+     */
+    public function getDoc($host = null)
+    {
+        $rawDoc = $this->HttpServerDocCreator->create($host);
+
+        $openApiDoc = $this->docNormalizer->normalize($rawDoc);
+
+        $event = new OpenAPIDocCreatedEvent($openApiDoc, $rawDoc);
+        $this->dispatcher->dispatch($event::EVENT_NAME, $event);
+
+        return $event->getOpenAPIDoc();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($filename, $host = null)
+    {
+        return 'openapi.json' === $filename;
+    }
+}

src/Resources/config/services.public.yaml

@@ -0,0 +1,12 @@
+services:
+  _defaults:
+    public: true
+
+  json_rpc_http_server_open_api_doc.provider:
+    class: Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\Provider\DocProvider
+    arguments:
+      - '@event_dispatcher'
+      - '@json_rpc_http_server_doc.creator.http_server'
+      - '@json_rpc_http_server_open_api_doc_sdk.normalizer.doc'
+    tags: ['json_rpc_server_doc.doc_provider']
+

src/Resources/config/services.sdk.yaml

@@ -0,0 +1,58 @@
+services:
+  _defaults:
+    public: true
+
+
+  # Def resolver
+  json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Resolver\DefinitionRefResolver
+
+
+  # Normalizer
+  json_rpc_http_server_open_api_doc_sdk.normalizer.doc:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\DocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.request_doc'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.response'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.external_schema_list'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.operation'
+
+  ## Components
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.schema_type:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\SchemaTypeNormalizer
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.parameter_doc:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\TypeDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.schema_type'
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.shape:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\ShapeNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref'
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.error:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\ErrorDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.parameter_doc'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.external_schema_list:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\ExternalSchemaListDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.parameter_doc'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.error'
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.request_doc:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\RequestDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.response:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\ResponseDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_open_api_doc_sdk.normalizer.component.operation:
+    class: Yoanm\JsonRpcHttpServerOpenAPIDoc\Normalizer\Component\OperationDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_open_api_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.request_doc'
+     - '@json_rpc_http_server_open_api_doc_sdk.normalizer.component.response'

tests/Common/DependencyInjection/AbstractTestClass.php

@@ -0,0 +1,91 @@
+<?php
+namespace Tests\Common\DependencyInjection;
+
+use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
+use Symfony\Component\DependencyInjection\Definition;
+use Yoanm\JsonRpcServer\Domain\Model\MethodResolverInterface;
+use Yoanm\SymfonyJsonRpcHttpServer\DependencyInjection\JsonRpcHttpServerExtension;
+
+abstract class AbstractTestClass extends AbstractExtensionTestCase
+{
+    // Public services
+    const EXPECTED_ENDPOINT_SERVICE_ID = 'json_rpc_http_server.endpoint';
+    const EXPECTED_SERVICE_NAME_RESOLVER_SERVICE_ID = 'json_rpc_http_server.resolver.service_name';
+
+    // Public tags
+    const EXPECTED_METHOD_RESOLVER_TAG = 'json_rpc_http_server.method_resolver';
+    const EXPECTED_JSONRPC_METHOD_TAG = 'json_rpc_http_server.jsonrpc_method';
+
+    const EXPECTED_JSONRPC_METHOD_TAG_METHOD_NAME_KEY = 'method';
+
+    const EXPECTED_METHOD_MANAGER_SERVICE_ID = 'json_rpc_http_server.sdk.app.manager.method';
+    const EXPECTED_METHOD_RESOLVER_STUB_SERVICE_ID = 'json_rpc_http_server.infra.resolver.method';
+
+    const EXPECTED_HTTP_ENDPOINT_PATH_CONTAINER_PARAM = 'json_rpc_http_server.http_endpoint_path';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getContainerExtensions()
+    {
+        return [
+            new JsonRpcHttpServerExtension()
+        ];
+    }
+
+    protected function load(array $configurationValues = [])
+    {
+        parent::load($configurationValues);
+
+        // And then compile container to have correct injection
+        $this->compile();
+    }
+
+
+    protected function assertEndpointIsUsable()
+    {
+        // Retrieving this service will imply to load all related dependencies
+        // Any binding issues will be raised
+        $this->assertNotNull($this->container->get(self::EXPECTED_ENDPOINT_SERVICE_ID));
+    }
+
+    /**
+     * @param $jsonRpcMethodServiceId
+     */
+    protected function assertJsonRpcMethodServiceIsAvailable($jsonRpcMethodServiceId)
+    {
+        $this->assertNotNull($this->container->get($jsonRpcMethodServiceId));
+    }
+
+    /**
+     * @return Definition
+     */
+    protected function createJsonRpcMethodDefinition()
+    {
+        return (new Definition(\stdClass::class))
+            ->setPrivate(false);
+    }
+
+    /**
+     * @param Definition $definition
+     * @param string     $methodName
+     */
+    protected function addJsonRpcMethodTag(Definition $definition, $methodName)
+    {
+        $definition->addTag(
+            self::EXPECTED_JSONRPC_METHOD_TAG,
+            [self::EXPECTED_JSONRPC_METHOD_TAG_METHOD_NAME_KEY => $methodName]
+        );
+    }
+
+    /**
+     * @return Definition
+     */
+    protected function createCustomMethodResolverDefinition()
+    {
+        $customResolverService = new Definition($this->prophesize(MethodResolverInterface::class)->reveal());
+        $customResolverService->addTag(self::EXPECTED_METHOD_RESOLVER_TAG);
+
+        return $customResolverService;
+    }
+}