Client::createColumn() - Code Metrics - Inspection of "replace-lush-with-guzzle" - proposal-page/sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1)

by Gianluca

created 2019-05-03 20:35 UTC

Client::createColumn() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace ProposalPage\Sdk;

use Exception;
use GuzzleHttp\Client as HttpClient;
use ProposalPage\Sdk\Exception\FailedActionException;
use ProposalPage\Sdk\Exception\NotFoundException;
use ProposalPage\Sdk\Exception\ValidationException;
use Psr\Http\Message\ResponseInterface;

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 HttpClient([
            'base_uri' => $this->getApiUrl(),
            'http_errors' => false,
            'timeout' => 30.0
        ]);
    }

    // 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->json['token'];
        }

        return $response;
    }

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

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

    // 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 mixed|ResponseInterface
     * @throws FailedActionException
     * @throws NotFoundException
     * @throws ValidationException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    private function request(string $method, string $path, array $params = [], array $queryStringParams = [])
    {
        $response = $this->httpClient->request($method, $path, [
            'json' => $params,
            'query' => $queryStringParams,
            'headers' => $this->getRequestHeaders()
        ]);

        if (! $this->isSuccessfulResponse($response)) {
            $this->handleRequestError($response);
        }

        $responseBody = (string) $response->getBody();
        $response->json = json_decode($responseBody, true) ?: $responseBody;

        return $response;
    }

    /**
     * @return array
     */
    private function getRequestHeaders()
    {
        if (!$this->token) {
            return [
                'Accept' => 'application/json',
                'Content-Type' => 'application/json',
            ];
        }

        return [
            'Authorization' => "Bearer {$this->token}",
            'Accept' => 'application/json',
            'Content-Type' => 'application/json',
        ];
    }

    private function isSuccessfulResponse($response)
    {
        if (! $response) {
            return false;
        }

        return (int) substr($response->getStatusCode(), 0, 1) === 2;
    }

    /**
     * @param ResponseInterface $response
     * @throws FailedActionException
     * @throws NotFoundException
     * @throws ValidationException
     * @throws Exception
     */
    private function handleRequestError(ResponseInterface $response)
    {
        if ($response->getStatusCode() === 422) {
            throw new ValidationException(json_decode((string) $response->getBody(), true));
        }

        if ($response->getStatusCode() === 404) {
            throw new NotFoundException();
        }

        if ($response->getStatusCode() === 400) {
            throw new FailedActionException((string) $response->getBody());
        }

        throw new Exception((string) $response->getBody());
    }
}


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

proposal-page / sdk-php

Pull Request — master (#1)

Client::createColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like