ApiConsoleControl::getTemplateFilePath() - Code Metrics - Inspection of "Merge pull request #94 from tomaj/custom-renderer-..." - tomaj/nette-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f52833...7c6110 )

by Tomas

created 2021-04-20 13:23 UTC

ApiConsoleControl::getTemplateFilePath() A

↳ Parent: ApiConsoleControl

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	6

<?php

declare(strict_types=1);

namespace Tomaj\NetteApi\Component;

use Nette\Application\UI\Control;
use Nette\Application\UI\Form;
use Nette\Bridges\ApplicationLatte\Template;
use Nette\Forms\IFormRenderer;
use Nette\Http\IRequest;
use Nette\Utils\ArrayHash;
use Nette\Utils\Html;
use Tomaj\Form\Renderer\BootstrapVerticalRenderer;
use Tomaj\NetteApi\Authorization\ApiAuthorizationInterface;
use Tomaj\NetteApi\Authorization\BasicAuthentication;
use Tomaj\NetteApi\Authorization\BearerTokenAuthorization;
use Tomaj\NetteApi\Authorization\CookieApiKeyAuthentication;
use Tomaj\NetteApi\Authorization\HeaderApiKeyAuthentication;
use Tomaj\NetteApi\Authorization\NoAuthorization;
use Tomaj\NetteApi\Authorization\QueryApiKeyAuthentication;
use Tomaj\NetteApi\EndpointInterface;
use Tomaj\NetteApi\Handlers\ApiHandlerInterface;
use Tomaj\NetteApi\Link\ApiLink;
use Tomaj\NetteApi\Misc\ConsoleRequest;

class ApiConsoleControl extends Control
{
    private $request;

    private $endpoint;

    private $handler;

    private $authorization;

    private $apiLink;

    private $formRenderer;

    private $templateFilePath;

    public function __construct(IRequest $request, EndpointInterface $endpoint, ApiHandlerInterface $handler, ApiAuthorizationInterface $authorization, ApiLink $apiLink = null)
    {
        $this->request = $request;
        $this->endpoint = $endpoint;
        $this->handler = $handler;
        $this->authorization = $authorization;
        $this->apiLink = $apiLink;
    }

    public function render(): void
    {
        /** @var Template $template */
        $template = $this->getTemplate();
        $template->setFile($this->getTemplateFilePath());
        $template->add('handler', $this->handler);
        $template->render();
    }

    protected function createComponentConsoleForm(): Form
    {
        $form = new Form();

        $defaults = [];

        $form->setRenderer($this->getFormRenderer());

        if ($this->apiLink) {
            $url = $this->apiLink->link($this->endpoint);
        } else {
            $uri = $this->request->getUrl();
            $scheme = $uri->scheme;
            if (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
                $scheme = $_SERVER['HTTP_X_FORWARDED_PROTO'];
            }
            $port = '';
            if ($uri->scheme === 'http' && $uri->port !== 80) {
                $port = ':' . $uri->port;
            }
            $url = $scheme . '://' . $uri->host . $port . '/api/' . $this->endpoint->getUrl();
        }

        $form->addText('api_url', 'Api Url');
        $defaults['api_url'] = $url;

        $form->addText('api_method', 'Method');
        $defaults['api_method'] = $this->endpoint->getMethod();

        if ($this->authorization instanceof BearerTokenAuthorization) {
            $form->addText('token', 'Token')
                ->setHtmlAttribute('placeholder', 'Enter token');
        } elseif ($this->authorization instanceof BasicAuthentication) {
            $form->addText('basic_authentication_username', 'Username')
                ->setHtmlAttribute('placeholder', 'Enter basic authentication username');
            $form->addText('basic_authentication_password', 'Password')
                ->setHtmlAttribute('placeholder', 'Enter basic authentication password');
        } elseif ($this->authorization instanceof QueryApiKeyAuthentication) {
            $form->addText($this->authorization->getQueryParamName(), 'API key')
                ->setHtmlAttribute('placeholder', 'Enter API key');
        } elseif ($this->authorization instanceof HeaderApiKeyAuthentication) {
            $form->addText('header_api_key', 'API key')
                ->setHtmlAttribute('placeholder', 'Enter API key');
        } elseif ($this->authorization instanceof CookieApiKeyAuthentication) {
            $form->addText('cookie_api_key', 'API key')
                ->setHtmlAttribute('placeholder', 'Enter API key');
        } elseif ($this->authorization instanceof NoAuthorization) {
            $form->addText('authorization', 'Authorization')
                ->setDisabled(true);
            $defaults['authorization'] = 'No authorization - global access';
        }

        $form->addCheckbox('send_session_id', 'Send session id cookie');

        $form->addTextArea('custom_headers', 'Custom headers')
            ->setOption('description', Html::el()->setHtml('Each header on new line. For example: <code>User-agent: Mozilla/5.0</code>'));

        $form->addText('timeout', 'Timeout')
            ->setDefaultValue(30);

        $params = $this->handler->params();
        foreach ($params as $param) {
            $param->updateConsoleForm($form);
        }

        $form->addSubmit('send', 'Try api')
            ->getControlPrototype()
            ->setName('button')
            ->setHtml('<i class="fa fa-cloud-upload"></i> Try api');

        $form->setDefaults($defaults);

        $form->onSuccess[] = array($this, 'formSucceeded');
        return $form;
    }

    public function formSucceeded(Form $form, ArrayHash $values): void
    {
        $url = $values['api_url'];

        $token = null;
        if (isset($values['token'])) {
            $token = $values['token'];
            unset($values['token']);
        }

        $method = $values['api_method'];
        unset($values['api_method']);

        $additionalValues = [];
        if (isset($values['send_session_id']) && $values['send_session_id']) {
            $additionalValues['cookieFields'][session_name()] = session_id();
            session_write_close();
        }

        if (isset($values['custom_headers']) && $values['custom_headers']) {
            $additionalValues['headers'] = array_filter(array_map('trim', explode("\n", $values['custom_headers'])));
        }

        $additionalValues['timeout'] = $values['timeout'];

        if ($this->authorization instanceof QueryApiKeyAuthentication) {
            $queryParamName = $this->authorization->getQueryParamName();
            $additionalValues['getFields'][$queryParamName] = $values[$queryParamName] ?? null;
        } elseif ($this->authorization instanceof HeaderApiKeyAuthentication) {
            $headerName = $this->authorization->getHeaderName();
            $additionalValues['headers'][] = $headerName . ':' . $values['header_api_key'] ?? null;
        } elseif ($this->authorization instanceof CookieApiKeyAuthentication) {
            $cookieName = $this->authorization->getCookieName();
            $additionalValues['cookieFields'][$cookieName] = $values['cookie_api_key'] ?? null;
        }

        $consoleRequest = new ConsoleRequest($this->handler, $this->endpoint, $this->apiLink);
        $result = $consoleRequest->makeRequest($url, $method, (array) $values, $additionalValues, $token);

        /** @var Template $template */
        $template = $this->getTemplate();
        $template->add('response', $result);

        if ($this->getPresenter()->isAjax()) {
            $this->getPresenter()->redrawControl();
        }
    }

    public function setFormRenderer(IFormRenderer $formRenderer): void
    {
        $this->formRenderer = $formRenderer;
    }

    private function getFormRenderer(): IFormRenderer
    {
        return $this->formRenderer ?: new BootstrapVerticalRenderer();
    }

    public function setTemplateFilePath(string $templateFilePath): void
    {
        $this->templateFilePath = $templateFilePath;
    }

    private function getTemplateFilePath(): string
    {
        return $this->templateFilePath ?: __DIR__ . '/console.latte';
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Tomaj\NetteApi\Component;
6
7			use Nette\Application\UI\Control;
8			use Nette\Application\UI\Form;
9			use Nette\Bridges\ApplicationLatte\Template;
10			use Nette\Forms\IFormRenderer;
11			use Nette\Http\IRequest;
12			use Nette\Utils\ArrayHash;
13			use Nette\Utils\Html;
14			use Tomaj\Form\Renderer\BootstrapVerticalRenderer;
15			use Tomaj\NetteApi\Authorization\ApiAuthorizationInterface;
16			use Tomaj\NetteApi\Authorization\BasicAuthentication;
17			use Tomaj\NetteApi\Authorization\BearerTokenAuthorization;
18			use Tomaj\NetteApi\Authorization\CookieApiKeyAuthentication;
19			use Tomaj\NetteApi\Authorization\HeaderApiKeyAuthentication;
20			use Tomaj\NetteApi\Authorization\NoAuthorization;
21			use Tomaj\NetteApi\Authorization\QueryApiKeyAuthentication;
22			use Tomaj\NetteApi\EndpointInterface;
23			use Tomaj\NetteApi\Handlers\ApiHandlerInterface;
24			use Tomaj\NetteApi\Link\ApiLink;
25			use Tomaj\NetteApi\Misc\ConsoleRequest;
26
27			class ApiConsoleControl extends Control
28			{
29			private $request;
30
31			private $endpoint;
32
33			private $handler;
34
35			private $authorization;
36
37			private $apiLink;
38
39			private $formRenderer;
40
41			private $templateFilePath;
42
43			public function __construct(IRequest $request, EndpointInterface $endpoint, ApiHandlerInterface $handler, ApiAuthorizationInterface $authorization, ApiLink $apiLink = null)
44			{
45			$this->request = $request;
46			$this->endpoint = $endpoint;
47			$this->handler = $handler;
48			$this->authorization = $authorization;
49			$this->apiLink = $apiLink;
50			}
51
52			public function render(): void
53			{
54			/** @var Template $template */
55			$template = $this->getTemplate();
56			$template->setFile($this->getTemplateFilePath());
57			$template->add('handler', $this->handler);
58			$template->render();
59			}
60
61			protected function createComponentConsoleForm(): Form
62			{
63			$form = new Form();
64
65			$defaults = [];
66
67			$form->setRenderer($this->getFormRenderer());
68
69			if ($this->apiLink) {
70			$url = $this->apiLink->link($this->endpoint);
71			} else {
72			$uri = $this->request->getUrl();
73			$scheme = $uri->scheme;
74			if (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
75			$scheme = $_SERVER['HTTP_X_FORWARDED_PROTO'];
76			}
77			$port = '';
78			if ($uri->scheme === 'http' && $uri->port !== 80) {
79			$port = ':' . $uri->port;
80			}
81			$url = $scheme . '://' . $uri->host . $port . '/api/' . $this->endpoint->getUrl();
82			}
83
84			$form->addText('api_url', 'Api Url');
85			$defaults['api_url'] = $url;
86
87			$form->addText('api_method', 'Method');
88			$defaults['api_method'] = $this->endpoint->getMethod();
89
90			if ($this->authorization instanceof BearerTokenAuthorization) {
91			$form->addText('token', 'Token')
92			->setHtmlAttribute('placeholder', 'Enter token');
93			} elseif ($this->authorization instanceof BasicAuthentication) {
94			$form->addText('basic_authentication_username', 'Username')
95			->setHtmlAttribute('placeholder', 'Enter basic authentication username');
96			$form->addText('basic_authentication_password', 'Password')
97			->setHtmlAttribute('placeholder', 'Enter basic authentication password');
98			} elseif ($this->authorization instanceof QueryApiKeyAuthentication) {
99			$form->addText($this->authorization->getQueryParamName(), 'API key')
100			->setHtmlAttribute('placeholder', 'Enter API key');
101			} elseif ($this->authorization instanceof HeaderApiKeyAuthentication) {
102			$form->addText('header_api_key', 'API key')
103			->setHtmlAttribute('placeholder', 'Enter API key');
104			} elseif ($this->authorization instanceof CookieApiKeyAuthentication) {
105			$form->addText('cookie_api_key', 'API key')
106			->setHtmlAttribute('placeholder', 'Enter API key');
107			} elseif ($this->authorization instanceof NoAuthorization) {
108			$form->addText('authorization', 'Authorization')
109			->setDisabled(true);
110			$defaults['authorization'] = 'No authorization - global access';
111			}
112
113			$form->addCheckbox('send_session_id', 'Send session id cookie');
114
115			$form->addTextArea('custom_headers', 'Custom headers')
116			->setOption('description', Html::el()->setHtml('Each header on new line. For example: <code>User-agent: Mozilla/5.0</code>'));
117
118			$form->addText('timeout', 'Timeout')
119			->setDefaultValue(30);
120
121			$params = $this->handler->params();
122			foreach ($params as $param) {
123			$param->updateConsoleForm($form);
124			}
125
126			$form->addSubmit('send', 'Try api')
127			->getControlPrototype()
128			->setName('button')
129			->setHtml('<i class="fa fa-cloud-upload"></i> Try api');
130
131			$form->setDefaults($defaults);
132
133			$form->onSuccess[] = array($this, 'formSucceeded');
134			return $form;
135			}
136
137			public function formSucceeded(Form $form, ArrayHash $values): void
138			{
139			$url = $values['api_url'];
140
141			$token = null;
142			if (isset($values['token'])) {
143			$token = $values['token'];
144			unset($values['token']);
145			}
146
147			$method = $values['api_method'];
148			unset($values['api_method']);
149
150			$additionalValues = [];
151			if (isset($values['send_session_id']) && $values['send_session_id']) {
152			$additionalValues['cookieFields'][session_name()] = session_id();
153			session_write_close();
154			}
155
156			if (isset($values['custom_headers']) && $values['custom_headers']) {
157			$additionalValues['headers'] = array_filter(array_map('trim', explode("\n", $values['custom_headers'])));
158			}
159
160			$additionalValues['timeout'] = $values['timeout'];
161
162			if ($this->authorization instanceof QueryApiKeyAuthentication) {
163			$queryParamName = $this->authorization->getQueryParamName();
164			$additionalValues['getFields'][$queryParamName] = $values[$queryParamName] ?? null;
165			} elseif ($this->authorization instanceof HeaderApiKeyAuthentication) {
166			$headerName = $this->authorization->getHeaderName();
167			$additionalValues['headers'][] = $headerName . ':' . $values['header_api_key'] ?? null;
168			} elseif ($this->authorization instanceof CookieApiKeyAuthentication) {
169			$cookieName = $this->authorization->getCookieName();
170			$additionalValues['cookieFields'][$cookieName] = $values['cookie_api_key'] ?? null;
171			}
172
173			$consoleRequest = new ConsoleRequest($this->handler, $this->endpoint, $this->apiLink);
174			$result = $consoleRequest->makeRequest($url, $method, (array) $values, $additionalValues, $token);
175
176			/** @var Template $template */
177			$template = $this->getTemplate();
178			$template->add('response', $result);
179
180			if ($this->getPresenter()->isAjax()) {
181			$this->getPresenter()->redrawControl();
182			}
183			}
184
185			public function setFormRenderer(IFormRenderer $formRenderer): void
186			{
187			$this->formRenderer = $formRenderer;
188			}
189
190			private function getFormRenderer(): IFormRenderer
191			{
192			return $this->formRenderer ?: new BootstrapVerticalRenderer();
193			}
194
195			public function setTemplateFilePath(string $templateFilePath): void
196			{
197			$this->templateFilePath = $templateFilePath;
198			}
199
200			private function getTemplateFilePath(): string
201			{
202			return $this->templateFilePath ?: __DIR__ . '/console.latte';
203			}
204			}
205

tomaj / nette-api

Push — master ( f52833...7c6110 )

ApiConsoleControl::getTemplateFilePath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like