Client::getRequestQueryString() - Code Metrics - Inspection of "Added the optional parameters page (default = 1) a..." - proposal-page/sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( f7c390...b0d8e7 )

by Gianluca

created 2019-04-30 12:05 UTC

Client::getRequestQueryString() A

↳ Parent: Client

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace ProposalPage\Sdk;

use Appstract\LushHttp\Lush;
use Appstract\LushHttp\Response\LushResponse;
use function BenTools\QueryString\query_string;

class Client
{
    private $apiUrl = 'https://api.proposalpage.com';

    private $token = null;

    private $httpClient;

    public function __construct(string $apiUrl = '')
    {
        if ($apiUrl) {
            $this->apiUrl = $apiUrl;
        }

        $this->httpClient = new Lush();
    }

    // Auth
    public function authenticate(string $username, string $password, bool $setToken = true)
    {
        $response = $this->request('POST', '/accounts/auth/token', [
            'username' => $username,
            'password' => $password
        ]);

        if ($setToken) {
            $this->token = $response->token;
        }

        return $response;
    }

    public function authMe()
    {
        return $this->request('GET', '/accounts/auth/me');
    }

    // Templates
    public function listTemplates()
    {
        return $this->request('GET', '/projects/templates');
    }

    // Projects
    public function createProject(array $params)
    {
        return $this->request('POST', '/projects', $params);
    }

    public function createProjectFromTemplate(string $templateId)
    {
        return $this->request('POST', "/projects/${templateId}/copy");
    }

    public function listProjects($page = 1, $itemsPerPage = 6)
    {
        return $this->request('GET', '/projects', [], [
            'page' => $page,
            'itemsPerPage' => $itemsPerPage
        ]);
    }

    public function listProject($projectId)
    {
        return $this->request('GET', "/projects/{$projectId}");
    }

    public function updateProject($projectId, array $params)
    {
        return $this->request('PUT', "/projects/{$projectId}", $params);
    }

    public function deleteProject($projectId)
    {
        return $this->request('DELETE', "/projects/{$projectId}");
    }

    public function cloneProject($projectId)
    {
        return $this->request('POST', "/projects/{$projectId}/clone");
    }

    public function setProjectPassword($projectId, string $password)
    {
        return $this->request('POST', "/projects/{$projectId}/password", ['password' => $password]);
    }

    public function publishProject($projectId)
    {
        return $this->request('POST', "/projects/{$projectId}/publish");
    }

    public function secureProject($projectId)
    {
        return $this->request('POST', "/projects/{$projectId}/secure");
    }

    public function generateProjectCover($projectId)
    {
        return $this->request('GET', "/projects/{$projectId}/screenshot");
    }

    public function viewProjectAndNotify($projectId)
    {
        return $this->request('PUT', "/projects/{$projectId}/view-and-notify");
    }

    // Blocks
    public function createBlock($projectId, array $params)
    {
        return $this->request('POST', "/projects/{$projectId}/blocks", $params);
    }

    public function listBlocks($projectId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks");
    }

    public function listBlock($projectId, $blockId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}");
    }

    public function updateBlock($projectId, $blockId, array $params)
    {
        return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}", $params);
    }

    public function moveBlockForward($projectId, $blockId)
    {
        return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/forward");
    }

    public function moveBlockBackward($projectId, $blockId)
    {
        return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/backward");
    }

    public function cloneBlock($projectId, $blockId, string $position = '')
    {
        return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/clone/{$position}");
    }

    public function deleteBlock($projectId, $blockId)
    {
        return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}");
    }

    // Rows
    public function createRow($projectId, $blockId, array $params)
    {
        return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows", $params);
    }

    public function listRows($projectId, $blockId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows");
    }

    public function listRow($projectId, $blockId, $rowId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}");
    }

    public function updateRow($projectId, $blockId, $rowId, $params)
    {
        return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}", $params);
    }

    public function cloneRow($projectId, $blockId, $rowId, string $position = '')
    {
        return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/clone/${position}");
    }

    public function deleteRow($projectId, $blockId, $rowId)
    {
        return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}");
    }

    // Columns
    public function createColumn($projectId, $blockId, $rowId, array $params)
    {
        return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns", $params);
    }

    public function listColumns($projectId, $blockId, $rowId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns");
    }

    public function listColumn($projectId, $blockId, $rowId, $columnId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}");
    }

    public function updateColumn($projectId, $blockId, $rowId, $columnId, array $params)
    {
        return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}", $params);
    }

    public function deleteColumn($projectId, $blockId, $rowId, $columnId)
    {
        return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}");
    }

    // Contents
    public function createContent($projectId, $blockId, $rowId, $columnId, array $params)
    {
        return $this->request(
            'POST',
            "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents",
            $params
        );
    }

    public function listContents($projectId, $blockId, $rowId, $columnId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents");
    }

    public function listContent($projectId, $blockId, $rowId, $columnId, $contentId)
    {
        return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}");
    }

    public function updateContent($projectId, $blockId, $rowId, $columnId, $contentId, array $params)
    {
        return $this->request(
            'PUT',
            "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}",
            $params
        );
    }

    public function deleteContent($projectId, $blockId, $rowId, $columnId, $contentId)
    {
        return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}");
    }

    // Getters / Setters
    public function getApiUrl()
    {
        return $this->apiUrl;
    }

    public function setApiUrl(string $apiUrl)
    {
        $this->apiUrl = $apiUrl;

        return $this;
    }

    public function getToken()
    {
        return $this->token;
    }

    public function setToken(string $token)
    {
        $this->token = $token;

        return $this;
    }

    /**
     * @param string $method
     * @param string $path
     * @param array $params
     * @param array $queryStringParams
     * @return LushResponse
     */
    private function request(string $method, string $path, array $params = [], array $queryStringParams = [])
    {
        return $this->httpClient
                ->url($this->getRequestUri($path, $queryStringParams), $params)
                ->headers($this->getRequestHeaders())
                ->$method();
    }

    /**
     * @return array
     */
    private function getRequestHeaders()
    {
        if (!$this->token) {
            return [];
        }

        return [
            'Authorization' => "Bearer {$this->token}"
        ];
    }

    /**
     * @param array $params
     * @return string
     */
    private function getRequestQueryString(array $params = [])
    {
        if (count($params) === 0) {
            return "";
        }

        $queryString = query_string($params);

        return "?" . urldecode((string) $queryString);
    }

    private function getRequestUri(string $path, array $queryStringParams = [])
    {
        $queryString = $this->getRequestQueryString($queryStringParams);

        return "{$this->apiUrl}{$path}{$queryString}";
    }
}


1			<?php
2
3			namespace ProposalPage\Sdk;
4
5			use Appstract\LushHttp\Lush;
6			use Appstract\LushHttp\Response\LushResponse;
7			use function BenTools\QueryString\query_string;
8
9			class Client
10			{
11			private $apiUrl = 'https://api.proposalpage.com';
12
13			private $token = null;
14
15			private $httpClient;
16
17			public function __construct(string $apiUrl = '')
18			{
19			if ($apiUrl) {
20			$this->apiUrl = $apiUrl;
21			}
22
23			$this->httpClient = new Lush();
24			}
25
26			// Auth
27			public function authenticate(string $username, string $password, bool $setToken = true)
28			{
29			$response = $this->request('POST', '/accounts/auth/token', [
30			'username' => $username,
31			'password' => $password
32			]);
33
34			if ($setToken) {
35			$this->token = $response->token;
36			}
37
38			return $response;
39			}
40
41			public function authMe()
42			{
43			return $this->request('GET', '/accounts/auth/me');
44			}
45
46			// Templates
47			public function listTemplates()
48			{
49			return $this->request('GET', '/projects/templates');
50			}
51
52			// Projects
53			public function createProject(array $params)
54			{
55			return $this->request('POST', '/projects', $params);
56			}
57
58			public function createProjectFromTemplate(string $templateId)
59			{
60			return $this->request('POST', "/projects/${templateId}/copy");
61			}
62
63			public function listProjects($page = 1, $itemsPerPage = 6)
64			{
65			return $this->request('GET', '/projects', [], [
66			'page' => $page,
67			'itemsPerPage' => $itemsPerPage
68			]);
69			}
70
71			public function listProject($projectId)
72			{
73			return $this->request('GET', "/projects/{$projectId}");
74			}
75
76			public function updateProject($projectId, array $params)
77			{
78			return $this->request('PUT', "/projects/{$projectId}", $params);
79			}
80
81			public function deleteProject($projectId)
82			{
83			return $this->request('DELETE', "/projects/{$projectId}");
84			}
85
86			public function cloneProject($projectId)
87			{
88			return $this->request('POST', "/projects/{$projectId}/clone");
89			}
90
91			public function setProjectPassword($projectId, string $password)
92			{
93			return $this->request('POST', "/projects/{$projectId}/password", ['password' => $password]);
94			}
95
96			public function publishProject($projectId)
97			{
98			return $this->request('POST', "/projects/{$projectId}/publish");
99			}
100
101			public function secureProject($projectId)
102			{
103			return $this->request('POST', "/projects/{$projectId}/secure");
104			}
105
106			public function generateProjectCover($projectId)
107			{
108			return $this->request('GET', "/projects/{$projectId}/screenshot");
109			}
110
111			public function viewProjectAndNotify($projectId)
112			{
113			return $this->request('PUT', "/projects/{$projectId}/view-and-notify");
114			}
115
116			// Blocks
117			public function createBlock($projectId, array $params)
118			{
119			return $this->request('POST', "/projects/{$projectId}/blocks", $params);
120			}
121
122			public function listBlocks($projectId)
123			{
124			return $this->request('GET', "/projects/{$projectId}/blocks");
125			}
126
127			public function listBlock($projectId, $blockId)
128			{
129			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}");
130			}
131
132			public function updateBlock($projectId, $blockId, array $params)
133			{
134			return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}", $params);
135			}
136
137			public function moveBlockForward($projectId, $blockId)
138			{
139			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/forward");
140			}
141
142			public function moveBlockBackward($projectId, $blockId)
143			{
144			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/backward");
145			}
146
147			public function cloneBlock($projectId, $blockId, string $position = '')
148			{
149			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/clone/{$position}");
150			}
151
152			public function deleteBlock($projectId, $blockId)
153			{
154			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}");
155			}
156
157			// Rows
158			public function createRow($projectId, $blockId, array $params)
159			{
160			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows", $params);
161			}
162
163			public function listRows($projectId, $blockId)
164			{
165			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows");
166			}
167
168			public function listRow($projectId, $blockId, $rowId)
169			{
170			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}");
171			}
172
173			public function updateRow($projectId, $blockId, $rowId, $params)
174			{
175			return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}", $params);
176			}
177
178			public function cloneRow($projectId, $blockId, $rowId, string $position = '')
179			{
180			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/clone/${position}");
181			}
182
183			public function deleteRow($projectId, $blockId, $rowId)
184			{
185			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}");
186			}
187
188			// Columns
189			public function createColumn($projectId, $blockId, $rowId, array $params)
190			{
191			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns", $params);
192			}
193
194			public function listColumns($projectId, $blockId, $rowId)
195			{
196			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns");
197			}
198
199			public function listColumn($projectId, $blockId, $rowId, $columnId)
200			{
201			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}");
202			}
203
204			public function updateColumn($projectId, $blockId, $rowId, $columnId, array $params)
205			{
206			return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}", $params);
207			}
208
209			public function deleteColumn($projectId, $blockId, $rowId, $columnId)
210			{
211			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}");
212			}
213
214			// Contents
215			public function createContent($projectId, $blockId, $rowId, $columnId, array $params)
216			{
217			return $this->request(
218			'POST',
219			"/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents",
220			$params
221			);
222			}
223
224			public function listContents($projectId, $blockId, $rowId, $columnId)
225			{
226			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents");
227			}
228
229			public function listContent($projectId, $blockId, $rowId, $columnId, $contentId)
230			{
231			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}");
232			}
233
234			public function updateContent($projectId, $blockId, $rowId, $columnId, $contentId, array $params)
235			{
236			return $this->request(
237			'PUT',
238			"/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}",
239			$params
240			);
241			}
242
243			public function deleteContent($projectId, $blockId, $rowId, $columnId, $contentId)
244			{
245			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}");
246			}
247
248			// Getters / Setters
249			public function getApiUrl()
250			{
251			return $this->apiUrl;
252			}
253
254			public function setApiUrl(string $apiUrl)
255			{
256			$this->apiUrl = $apiUrl;
257
258			return $this;
259			}
260
261			public function getToken()
262			{
263			return $this->token;
264			}
265
266			public function setToken(string $token)
267			{
268			$this->token = $token;
269
270			return $this;
271			}
272
273			/**
274			* @param string $method
275			* @param string $path
276			* @param array $params
277			* @param array $queryStringParams
278			* @return LushResponse
279			*/
280			private function request(string $method, string $path, array $params = [], array $queryStringParams = [])
281			{
282			return $this->httpClient
283			->url($this->getRequestUri($path, $queryStringParams), $params)
284			->headers($this->getRequestHeaders())
285			->$method();
286			}
287
288			/**
289			* @return array
290			*/
291			private function getRequestHeaders()
292			{
293			if (!$this->token) {
294			return [];
295			}
296
297			return [
298			'Authorization' => "Bearer {$this->token}"
299			];
300			}
301
302			/**
303			* @param array $params
304			* @return string
305			*/
306			private function getRequestQueryString(array $params = [])
307			{
308			if (count($params) === 0) {
309			return "";
310			}
311
312			$queryString = query_string($params);
313
314			return "?" . urldecode((string) $queryString);
315			}
316
317			private function getRequestUri(string $path, array $queryStringParams = [])
318			{
319			$queryString = $this->getRequestQueryString($queryStringParams);
320
321			return "{$this->apiUrl}{$path}{$queryString}";
322			}
323			}
324

proposal-page / sdk-php

Push — master ( f7c390...b0d8e7 )

Client::getRequestQueryString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like