SwaggerUiAction::getContext() - Code Metrics - Inspection of "[WIP] Allow oauth2 implicit flow in swagger ui." - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.2 (#1960)

unknown

created 2018-05-22 13:03 UTC

SwaggerUiAction::getContext() C

↳ Parent: SwaggerUiAction

Complexity

Conditions	7
Paths	10

Size

Total Lines	51
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	51
rs	6.9743
c	0
b	0
f	0
cc	7
eloc	35
nc	10
nop	2

How to fix Long Method

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Action;

use ApiPlatform\Core\Documentation\Documentation;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use Symfony\Component\Asset\Packages;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Displays the documentation in Swagger UI.
 *
 * @author Kévin Dunglas <[email protected]>
 */
final class SwaggerUiAction
{
    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $normalizer;
    private $twig;
    private $urlGenerator;
    private $assetPackages;
    private $title;
    private $description;
    private $version;
    private $formats;
    private $oauthEnabled;
    private $oauthClientId;
    private $oauthClientSecret;
    private $oauthType;
    private $oauthFlow;
    private $oauthTokenUrl;
    private $oauthAuthorizationUrl;
    private $oauthRedirectUrl;
    private $oauthScopes;

    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, \Twig_Environment $twig, UrlGeneratorInterface $urlGenerator, Packages $assetPackages, string $title = '', string $description = '', string $version = '', array $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthRedirectUrl = NULL, $oauthScopes = [])
    {
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->normalizer = $normalizer;
        $this->twig = $twig;
        $this->urlGenerator = $urlGenerator;
        $this->assetPackages = $assetPackages;
        $this->title = $title;
        $this->description = $description;
        $this->version = $version;
        $this->formats = $formats;
        $this->oauthEnabled = $oauthEnabled;
        $this->oauthClientId = $oauthClientId;
        $this->oauthClientSecret = $oauthClientSecret;
        $this->oauthType = $oauthType;
        $this->oauthFlow = $oauthFlow;
        $this->oauthTokenUrl = $oauthTokenUrl;
        $this->oauthAuthorizationUrl = $oauthAuthorizationUrl;
        $this->oauthRedirectUrl = $oauthRedirectUrl;
        $this->oauthScopes = $oauthScopes;
    }

    public function __invoke(Request $request)
    {
        $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);

        return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $this->getContext($request, $documentation)));
    }

    /**
     * Gets the base Twig context.
     *
     * @param Request $request
     *
     * @return array
     */
    private function getContext(Request $request, Documentation $documentation): array
    {
        $context = [
            'title' => $this->title,
            'description' => $this->description,
            'formats' => $this->formats,
        ];

        $swaggerData = [
            'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
            'spec' => $this->normalizer->normalize($documentation, 'json', ['base_url' => $request->getBaseUrl()]),
        ];

        if (!$this->oauthRedirectUrl) {
            $this->oauthRedirectUrl = $request->getScheme() . '://' .
                $request->getHttpHost() .
                $request->getBasePath() .
                $this->assetPackages->getUrl('bundles/apiplatform/swagger-ui/oauth2-redirect.html');
        }

        $swaggerData['oauth'] = [
            'enabled' => $this->oauthEnabled,
            'clientId' => $this->oauthClientId,
            'clientSecret' => $this->oauthClientSecret,
            'type' => $this->oauthType,
            'flow' => $this->oauthFlow,
            'tokenUrl' => $this->oauthTokenUrl,
            'authorizationUrl' => $this->oauthAuthorizationUrl,
            'redirectUrl' => $this->oauthRedirectUrl,
            'scopes' => $this->oauthScopes,
        ];

        if ($request->isMethodSafe(false) && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {
            $swaggerData['id'] = $request->attributes->get('id');
            $swaggerData['queryParameters'] = $request->query->all();

            $metadata = $this->resourceMetadataFactory->create($resourceClass);
            $swaggerData['shortName'] = $metadata->getShortName();

            if (null !== $collectionOperationName = $request->attributes->get('_api_collection_operation_name')) {
                $swaggerData['operationId'] = sprintf('%s%sCollection', $collectionOperationName, $swaggerData['shortName']);
            } elseif (null !== $itemOperationName = $request->attributes->get('_api_item_operation_name')) {
                $swaggerData['operationId'] = sprintf('%s%sItem', $itemOperationName, $swaggerData['shortName']);
            } elseif (null !== $subresourceOperationContext = $request->attributes->get('_api_subresource_context')) {
                $swaggerData['operationId'] = $subresourceOperationContext['operationId'];
            }

            list($swaggerData['path'], $swaggerData['method']) = $this->getPathAndMethod($swaggerData);
        }

        return $context + ['swagger_data' => $swaggerData];
    }

    private function getPathAndMethod(array $swaggerData): array
    {
        foreach ($swaggerData['spec']['paths'] as $path => $operations) {
            foreach ($operations as $method => $operation) {
                if ($operation['operationId'] === $swaggerData['operationId']) {
                    return [$path, $method];
                }
            }
        }

        throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));
    }
}


1			<?php
2
3			/*
4			* This file is part of the API Platform project.
5			*
6			* (c) Kévin Dunglas <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Action;
15
16			use ApiPlatform\Core\Documentation\Documentation;
17			use ApiPlatform\Core\Exception\RuntimeException;
18			use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
19			use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
20			use Symfony\Component\Asset\Packages;
21			use Symfony\Component\HttpFoundation\Request;
22			use Symfony\Component\HttpFoundation\Response;
23			use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
24			use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
25
26			/**
27			* Displays the documentation in Swagger UI.
28			*
29			* @author Kévin Dunglas <[email protected]>
30			*/
31			final class SwaggerUiAction
32			{
33			private $resourceNameCollectionFactory;
34			private $resourceMetadataFactory;
35			private $normalizer;
36			private $twig;
37			private $urlGenerator;
38			private $assetPackages;
39			private $title;
40			private $description;
41			private $version;
42			private $formats;
43			private $oauthEnabled;
44			private $oauthClientId;
45			private $oauthClientSecret;
46			private $oauthType;
47			private $oauthFlow;
48			private $oauthTokenUrl;
49			private $oauthAuthorizationUrl;
50			private $oauthRedirectUrl;
51			private $oauthScopes;
52
53			public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, \Twig_Environment $twig, UrlGeneratorInterface $urlGenerator, Packages $assetPackages, string $title = '', string $description = '', string $version = '', array $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthRedirectUrl = NULL, $oauthScopes = [])
54			{
55			$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
56			$this->resourceMetadataFactory = $resourceMetadataFactory;
57			$this->normalizer = $normalizer;
58			$this->twig = $twig;
59			$this->urlGenerator = $urlGenerator;
60			$this->assetPackages = $assetPackages;
61			$this->title = $title;
62			$this->description = $description;
63			$this->version = $version;
64			$this->formats = $formats;
65			$this->oauthEnabled = $oauthEnabled;
66			$this->oauthClientId = $oauthClientId;
67			$this->oauthClientSecret = $oauthClientSecret;
68			$this->oauthType = $oauthType;
69			$this->oauthFlow = $oauthFlow;
70			$this->oauthTokenUrl = $oauthTokenUrl;
71			$this->oauthAuthorizationUrl = $oauthAuthorizationUrl;
72			$this->oauthRedirectUrl = $oauthRedirectUrl;
73			$this->oauthScopes = $oauthScopes;
74			}
75
76			public function __invoke(Request $request)
77			{
78			$documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);
79
80			return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $this->getContext($request, $documentation)));
81			}
82
83			/**
84			* Gets the base Twig context.
85			*
86			* @param Request $request
87			*
88			* @return array
89			*/
90			private function getContext(Request $request, Documentation $documentation): array
91			{
92			$context = [
93			'title' => $this->title,
94			'description' => $this->description,
95			'formats' => $this->formats,
96			];
97
98			$swaggerData = [
99			'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
100			'spec' => $this->normalizer->normalize($documentation, 'json', ['base_url' => $request->getBaseUrl()]),
101			];
102
103			if (!$this->oauthRedirectUrl) {
104			$this->oauthRedirectUrl = $request->getScheme() . '://' .
105			$request->getHttpHost() .
106			$request->getBasePath() .
107			$this->assetPackages->getUrl('bundles/apiplatform/swagger-ui/oauth2-redirect.html');
108			}
109
110			$swaggerData['oauth'] = [
111			'enabled' => $this->oauthEnabled,
112			'clientId' => $this->oauthClientId,
113			'clientSecret' => $this->oauthClientSecret,
114			'type' => $this->oauthType,
115			'flow' => $this->oauthFlow,
116			'tokenUrl' => $this->oauthTokenUrl,
117			'authorizationUrl' => $this->oauthAuthorizationUrl,
118			'redirectUrl' => $this->oauthRedirectUrl,
119			'scopes' => $this->oauthScopes,
120			];
121
122			if ($request->isMethodSafe(false) && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {
123			$swaggerData['id'] = $request->attributes->get('id');
124			$swaggerData['queryParameters'] = $request->query->all();
125
126			$metadata = $this->resourceMetadataFactory->create($resourceClass);
127			$swaggerData['shortName'] = $metadata->getShortName();
128
129			if (null !== $collectionOperationName = $request->attributes->get('_api_collection_operation_name')) {
130			$swaggerData['operationId'] = sprintf('%s%sCollection', $collectionOperationName, $swaggerData['shortName']);
131			} elseif (null !== $itemOperationName = $request->attributes->get('_api_item_operation_name')) {
132			$swaggerData['operationId'] = sprintf('%s%sItem', $itemOperationName, $swaggerData['shortName']);
133			} elseif (null !== $subresourceOperationContext = $request->attributes->get('_api_subresource_context')) {
134			$swaggerData['operationId'] = $subresourceOperationContext['operationId'];
135			}
136
137			list($swaggerData['path'], $swaggerData['method']) = $this->getPathAndMethod($swaggerData);
138			}
139
140			return $context + ['swagger_data' => $swaggerData];
141			}
142
143			private function getPathAndMethod(array $swaggerData): array
144			{
145			foreach ($swaggerData['spec']['paths'] as $path => $operations) {
146			foreach ($operations as $method => $operation) {
147			if ($operation['operationId'] === $swaggerData['operationId']) {
148			return [$path, $method];
149			}
150			}
151			}
152
153			throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));
154			}
155			}
156

api-platform / core

Pull Request — 2.2 (#1960)

SwaggerUiAction::getContext() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like