CollectionWriter::getResponseAccessTokenKey() - Code Metrics - Inspection of "New features for the Postman collections generatio..." - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#457)

unknown

created 2019-02-02 23:04 UTC

CollectionWriter::getResponseAccessTokenKey() A

↳ Parent: CollectionWriter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Mpociot\ApiDoc\Postman;

use Ramsey\Uuid\Uuid;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\URL;

class CollectionWriter
{
    /**
     * @var Collection
     */
    private $routeGroups;

    private $usePostmanEnvironment;

    private $addResponseExample;

    /**
     * CollectionWriter constructor.
     *
     * @param Collection $routeGroups
     */
    public function __construct(Collection $routeGroups)
    {
        $this->routeGroups = $routeGroups;
        $this->usePostmanEnvironment = (bool) $this->getPostmanEnvironment();
        $this->addResponseExample = config('apidoc.postman.add_response_example', false);
    }

    protected function getPostmanEnvironment()
    {
        return config('apidoc.postman.environment');
    }

    /**
     * @param $route
     *
     * @return string
     */
    function getRouteUri($route): string

    {
        if ($this->usePostmanEnvironment) {
            $baseUrl = config('apidoc.postman.environment.variables.baseUrl');
            if ($baseUrl) {
                return '{{' . $baseUrl . '}}' . '/' . $route['uri'];
            } else {
                return url($route['uri']);
            }
        }

        return url($route['uri']);
    }

    /**
     * Returns Auth response object key with access token string.
     *
     * @return string
     */
    protected function getResponseAccessTokenKey(): string
    {
        return config('apidoc.postman.environment.auth_response_access_token_key', 'data');
    }

    /**
     * Returns Auth response object key with refresh token string
     *
     * @return string
     */
    protected function getResponseRefreshTokenKey(): string
    {
        return config('apidoc.postman.environment.auth_response_refresh_token_key', 'data');
    }

    protected function getAccessTokenVariable(): string
    {
        return config('apidoc.postman.environment.variables.accessToken', '');
    }

    protected function getRefreshTokenVariable(): string
    {
        return config('apidoc.postman.environment.variables.refreshToken', '');
    }

    /**
     * @return array
     */
    protected function getExcludingHeaders()
    {
        return config('apidoc.postman.excluded_headers', []);
    }

    protected function getRequest($route, $mode)
    {
        return [
            'auth' => $route['authenticated'] ? [
                'type' => 'bearer',
                'bearer' => [
                    'token' => '{{'.$this->getAccessTokenVariable().'}}',
                ],
            ] : false,
            'url' => $this->getRouteUri($route),
            'method' => $route['methods'][0],
            'header' => collect($route['headers'])->map(function ($header, $key) use ($route) {
                if (in_array($key, $this->getExcludingHeaders())) {
                    return;
                }

                return [
                    'key' => $key,
                    'name' => $key,
                    'type' => 'text',
                    'value' => $header,
                ];
            })->filter()->values()->toArray(),
            'body' => [
                'mode' => $mode,
                $mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
                    return [
                        'key' => $key,
                        'value' => isset($parameter['value']) ? ($parameter['type'] === 'boolean' ? (string) $parameter['value'] : $parameter['value']) : '',
                        'description' => implode(' | ', [($parameter['required'] ? 'required' : 'optional'), $parameter['type'], $parameter['description']]),
                        'type' => 'text',
                        'enabled' => true,
                    ];
                })->values()->toArray(),
            ],
            'description' => $route['description'],
        ];
    }

    public function getCollection()
    {
        URL::forceRootUrl(config('app.url'));

        $collection = [
            'variables' => [],
            'info' => [
                'name' => config('apidoc.postman.name') ?: config('app.name').' API',
                '_postman_id' => Uuid::uuid4()->toString(),
                'description' => config('apidoc.postman.description') ?: '',
                'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
            ],
            'item' => $this->routeGroups->map(function ($routes, $group) {
                list($groupName, $groupDescription) = explode("\n\n", $group);
                return [
                    'name' => $groupName,
                    'description' => $groupDescription,
                    'item' => $routes->map(function ($route) {
                        $mode = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata';

                        return [
                            'name' => $route['title'] != '' ? $route['title'] : $this->getRouteUri($route),
                            'event' => [[
                                'listen' => 'test',
                                'script' => $this->usePostmanEnvironment ? [
                                    'id' => Uuid::uuid4()->toString(),
                                    'exec' => [
                                        'var response = JSON.parse(responseBody);',
                                        'tests["Successful request"] = responseCode.code === 200;',
                                        'if (response.'.$this->getResponseAccessTokenKey().') { postman.setEnvironmentVariable("'.$this->getAccessTokenVariable().'", response.'.$this->getResponseAccessTokenKey().'); }',
                                        'if (response.'.$this->getResponseRefreshTokenKey().') { postman.setEnvironmentVariable("'.$this->getRefreshTokenVariable().'", response.'.$this->getResponseRefreshTokenKey().'); }',
                                    ],
                                    'type' => 'text/javascript',
                                ] : [],
                            ]],
                            'request' => $this->getRequest($route, $mode),
                            'response' => $this->addResponseExample ? [
                                [
                                    'name' => $route['title'] != '' ? $route['title'] : $this->getRouteUri($route),
                                    'originalRequest' => $this->getRequest($route, $mode),
                                    'status' => $route['response'][0]['statusText'],
                                    'code' => $route['response'][0]['status'],
                                    '_postman_previewlanguage' => 'json',
                                    'header' => collect($route['response'][0]['headers'])->map(function ($header, $key) use ($route) {
                                        return [
                                            'key' => $key,
                                            'name' => $key,
                                            'type' => 'text',
                                            'value' => $header,
                                        ];
                                    })->values()->toArray(),
                                    'body' => json_encode(json_decode($route['response'][0]['content']), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE),
                                ],
                            ] : [],
                        ];
                    })->toArray(),
                ];
            })->values()->toArray(),
        ];

        return json_encode($collection);
    }
}


1			<?php
2
3			namespace Mpociot\ApiDoc\Postman;
4
5			use Ramsey\Uuid\Uuid;
6			use Illuminate\Support\Collection;
7			use Illuminate\Support\Facades\URL;
8
9			class CollectionWriter
10			{
11			/**
12			* @var Collection
13			*/
14			private $routeGroups;
15
16			private $usePostmanEnvironment;
17
18			private $addResponseExample;
19
20			/**
21			* CollectionWriter constructor.
22			*
23			* @param Collection $routeGroups
24			*/
25			public function __construct(Collection $routeGroups)
26			{
27			$this->routeGroups = $routeGroups;
28			$this->usePostmanEnvironment = (bool) $this->getPostmanEnvironment();
29			$this->addResponseExample = config('apidoc.postman.add_response_example', false);
30			}
31
32			protected function getPostmanEnvironment()
33			{
34			return config('apidoc.postman.environment');
35			}
36
37			/**
38			* @param $route
39			*
40			* @return string
41			*/
42			function getRouteUri($route): string
			0 ignored issues – show Best Practice introduced 2019-02-02 23:00 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
43			{
44			if ($this->usePostmanEnvironment) {
45			$baseUrl = config('apidoc.postman.environment.variables.baseUrl');
46			if ($baseUrl) {
47			return '{{' . $baseUrl . '}}' . '/' . $route['uri'];
48			} else {
49			return url($route['uri']);
50			}
51			}
52
53			return url($route['uri']);
54			}
55
56			/**
57			* Returns Auth response object key with access token string.
58			*
59			* @return string
60			*/
61			protected function getResponseAccessTokenKey(): string
62			{
63			return config('apidoc.postman.environment.auth_response_access_token_key', 'data');
64			}
65
66			/**
67			* Returns Auth response object key with refresh token string
68			*
69			* @return string
70			*/
71			protected function getResponseRefreshTokenKey(): string
72			{
73			return config('apidoc.postman.environment.auth_response_refresh_token_key', 'data');
74			}
75
76			protected function getAccessTokenVariable(): string
77			{
78			return config('apidoc.postman.environment.variables.accessToken', '');
79			}
80
81			protected function getRefreshTokenVariable(): string
82			{
83			return config('apidoc.postman.environment.variables.refreshToken', '');
84			}
85
86			/**
87			* @return array
88			*/
89			protected function getExcludingHeaders()
90			{
91			return config('apidoc.postman.excluded_headers', []);
92			}
93
94			protected function getRequest($route, $mode)
95			{
96			return [
97			'auth' => $route['authenticated'] ? [
98			'type' => 'bearer',
99			'bearer' => [
100			'token' => '{{'.$this->getAccessTokenVariable().'}}',
101			],
102			] : false,
103			'url' => $this->getRouteUri($route),
104			'method' => $route['methods'][0],
105			'header' => collect($route['headers'])->map(function ($header, $key) use ($route) {
106			if (in_array($key, $this->getExcludingHeaders())) {
107			return;
108			}
109
110			return [
111			'key' => $key,
112			'name' => $key,
113			'type' => 'text',
114			'value' => $header,
115			];
116			})->filter()->values()->toArray(),
117			'body' => [
118			'mode' => $mode,
119			$mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
120			return [
121			'key' => $key,
122			'value' => isset($parameter['value']) ? ($parameter['type'] === 'boolean' ? (string) $parameter['value'] : $parameter['value']) : '',
123			'description' => implode(' \| ', [($parameter['required'] ? 'required' : 'optional'), $parameter['type'], $parameter['description']]),
124			'type' => 'text',
125			'enabled' => true,
126			];
127			})->values()->toArray(),
128			],
129			'description' => $route['description'],
130			];
131			}
132
133			public function getCollection()
134			{
135			URL::forceRootUrl(config('app.url'));
136
137			$collection = [
138			'variables' => [],
139			'info' => [
140			'name' => config('apidoc.postman.name') ?: config('app.name').' API',
141			'_postman_id' => Uuid::uuid4()->toString(),
142			'description' => config('apidoc.postman.description') ?: '',
143			'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
144			],
145			'item' => $this->routeGroups->map(function ($routes, $group) {
146			list($groupName, $groupDescription) = explode("\n\n", $group);
147			return [
148			'name' => $groupName,
149			'description' => $groupDescription,
150			'item' => $routes->map(function ($route) {
151			$mode = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata';
152
153			return [
154			'name' => $route['title'] != '' ? $route['title'] : $this->getRouteUri($route),
155			'event' => [[
156			'listen' => 'test',
157			'script' => $this->usePostmanEnvironment ? [
158			'id' => Uuid::uuid4()->toString(),
159			'exec' => [
160			'var response = JSON.parse(responseBody);',
161			'tests["Successful request"] = responseCode.code === 200;',
162			'if (response.'.$this->getResponseAccessTokenKey().') { postman.setEnvironmentVariable("'.$this->getAccessTokenVariable().'", response.'.$this->getResponseAccessTokenKey().'); }',
163			'if (response.'.$this->getResponseRefreshTokenKey().') { postman.setEnvironmentVariable("'.$this->getRefreshTokenVariable().'", response.'.$this->getResponseRefreshTokenKey().'); }',
164			],
165			'type' => 'text/javascript',
166			] : [],
167			]],
168			'request' => $this->getRequest($route, $mode),
169			'response' => $this->addResponseExample ? [
170			[
171			'name' => $route['title'] != '' ? $route['title'] : $this->getRouteUri($route),
172			'originalRequest' => $this->getRequest($route, $mode),
173			'status' => $route['response'][0]['statusText'],
174			'code' => $route['response'][0]['status'],
175			'_postman_previewlanguage' => 'json',
176			'header' => collect($route['response'][0]['headers'])->map(function ($header, $key) use ($route) {
177			return [
178			'key' => $key,
179			'name' => $key,
180			'type' => 'text',
181			'value' => $header,
182			];
183			})->values()->toArray(),
184			'body' => json_encode(json_decode($route['response'][0]['content']), JSON_PRETTY_PRINT \| JSON_UNESCAPED_UNICODE),
185			],
186			] : [],
187			];
188			})->toArray(),
189			];
190			})->values()->toArray(),
191			];
192
193			return json_encode($collection);
194			}
195			}
196

mpociot / laravel-apidoc-generator

Pull Request — master (#457)

CollectionWriter::getResponseAccessTokenKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like