Client::createColumn() - Code Metrics - Inspection of "Added the optional parameter title to the listProj..." - proposal-page/sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3497fb...435ff5 )

by Gianluca

created 2019-05-06 20:46 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, $title = null)
    {
        $query = [
            'page' => $page,
            'itemsPerPage' => $itemsPerPage
        ];

        if ($title) {
            $query['title'] = $title;
        }

        return $this->request('GET', '/projects', [], $query);
    }

    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, $title = null)
74			{
75			$query = [
76			'page' => $page,
77			'itemsPerPage' => $itemsPerPage
78			];
79
80			if ($title) {
81			$query['title'] = $title;
82			}
83
84			return $this->request('GET', '/projects', [], $query);
85			}
86
87			public function listProject($projectId)
88			{
89			return $this->request('GET', "/projects/{$projectId}");
90			}
91
92			public function updateProject($projectId, array $params)
93			{
94			return $this->request('PUT', "/projects/{$projectId}", $params);
95			}
96
97			public function deleteProject($projectId)
98			{
99			return $this->request('DELETE', "/projects/{$projectId}");
100			}
101
102			public function cloneProject($projectId)
103			{
104			return $this->request('POST', "/projects/{$projectId}/clone");
105			}
106
107			public function setProjectPassword($projectId, string $password)
108			{
109			return $this->request('POST', "/projects/{$projectId}/password", ['password' => $password]);
110			}
111
112			public function publishProject($projectId)
113			{
114			return $this->request('POST', "/projects/{$projectId}/publish");
115			}
116
117			public function secureProject($projectId)
118			{
119			return $this->request('POST', "/projects/{$projectId}/secure");
120			}
121
122			public function generateProjectCover($projectId)
123			{
124			return $this->request('GET', "/projects/{$projectId}/screenshot");
125			}
126
127			public function viewProjectAndNotify($projectId)
128			{
129			return $this->request('PUT', "/projects/{$projectId}/view-and-notify");
130			}
131
132			// Blocks
133			public function createBlock($projectId, array $params)
134			{
135			return $this->request('POST', "/projects/{$projectId}/blocks", $params);
136			}
137
138			public function listBlocks($projectId)
139			{
140			return $this->request('GET', "/projects/{$projectId}/blocks");
141			}
142
143			public function listBlock($projectId, $blockId)
144			{
145			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}");
146			}
147
148			public function updateBlock($projectId, $blockId, array $params)
149			{
150			return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}", $params);
151			}
152
153			public function moveBlockForward($projectId, $blockId)
154			{
155			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/forward");
156			}
157
158			public function moveBlockBackward($projectId, $blockId)
159			{
160			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/backward");
161			}
162
163			public function cloneBlock($projectId, $blockId, string $position = '')
164			{
165			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/clone/{$position}");
166			}
167
168			public function deleteBlock($projectId, $blockId)
169			{
170			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}");
171			}
172
173			// Rows
174			public function createRow($projectId, $blockId, array $params)
175			{
176			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows", $params);
177			}
178
179			public function listRows($projectId, $blockId)
180			{
181			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows");
182			}
183
184			public function listRow($projectId, $blockId, $rowId)
185			{
186			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}");
187			}
188
189			public function updateRow($projectId, $blockId, $rowId, $params)
190			{
191			return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}", $params);
192			}
193
194			public function cloneRow($projectId, $blockId, $rowId, string $position = '')
195			{
196			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/clone/${position}");
197			}
198
199			public function deleteRow($projectId, $blockId, $rowId)
200			{
201			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}");
202			}
203
204			// Columns
205			public function createColumn($projectId, $blockId, $rowId, array $params)
206			{
207			return $this->request('POST', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns", $params);
208			}
209
210			public function listColumns($projectId, $blockId, $rowId)
211			{
212			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns");
213			}
214
215			public function listColumn($projectId, $blockId, $rowId, $columnId)
216			{
217			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}");
218			}
219
220			public function updateColumn($projectId, $blockId, $rowId, $columnId, array $params)
221			{
222			return $this->request('PUT', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}", $params);
223			}
224
225			public function deleteColumn($projectId, $blockId, $rowId, $columnId)
226			{
227			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}");
228			}
229
230			// Contents
231			public function createContent($projectId, $blockId, $rowId, $columnId, array $params)
232			{
233			return $this->request(
234			'POST',
235			"/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents",
236			$params
237			);
238			}
239
240			public function listContents($projectId, $blockId, $rowId, $columnId)
241			{
242			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents");
243			}
244
245			public function listContent($projectId, $blockId, $rowId, $columnId, $contentId)
246			{
247			return $this->request('GET', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}");
248			}
249
250			public function updateContent($projectId, $blockId, $rowId, $columnId, $contentId, array $params)
251			{
252			return $this->request(
253			'PUT',
254			"/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}",
255			$params
256			);
257			}
258
259			public function deleteContent($projectId, $blockId, $rowId, $columnId, $contentId)
260			{
261			return $this->request('DELETE', "/projects/{$projectId}/blocks/{$blockId}/rows/{$rowId}/columns/{$columnId}/contents/{$contentId}");
262			}
263
264			// Getters / Setters
265			public function getApiUrl()
266			{
267			return $this->apiUrl;
268			}
269
270			public function setApiUrl(string $apiUrl)
271			{
272			$this->apiUrl = $apiUrl;
273
274			return $this;
275			}
276
277			public function getToken()
278			{
279			return $this->token;
280			}
281
282			public function setToken(string $token)
283			{
284			$this->token = $token;
285
286			return $this;
287			}
288
289			/**
290			* @param string $method
291			* @param string $path
292			* @param array $params
293			* @param array $queryStringParams
294			* @return mixed\|ResponseInterface
295			* @throws FailedActionException
296			* @throws NotFoundException
297			* @throws ValidationException
298			* @throws \GuzzleHttp\Exception\GuzzleException
299			*/
300			private function request(string $method, string $path, array $params = [], array $queryStringParams = [])
301			{
302			$response = $this->httpClient->request($method, $path, [
303			'json' => $params,
304			'query' => $queryStringParams,
305			'headers' => $this->getRequestHeaders()
306			]);
307
308			if (! $this->isSuccessfulResponse($response)) {
309			$this->handleRequestError($response);
310			}
311
312			$responseBody = (string) $response->getBody();
313			$response->json = json_decode($responseBody, true) ?: $responseBody;
314
315			return $response;
316			}
317
318			/**
319			* @return array
320			*/
321			private function getRequestHeaders()
322			{
323			if (!$this->token) {
324			return [
325			'Accept' => 'application/json',
326			'Content-Type' => 'application/json',
327			];
328			}
329
330			return [
331			'Authorization' => "Bearer {$this->token}",
332			'Accept' => 'application/json',
333			'Content-Type' => 'application/json',
334			];
335			}
336
337			private function isSuccessfulResponse($response)
338			{
339			if (! $response) {
340			return false;
341			}
342
343			return (int) substr($response->getStatusCode(), 0, 1) === 2;
344			}
345
346			/**
347			* @param ResponseInterface $response
348			* @throws FailedActionException
349			* @throws NotFoundException
350			* @throws ValidationException
351			* @throws Exception
352			*/
353			private function handleRequestError(ResponseInterface $response)
354			{
355			if ($response->getStatusCode() === 422) {
356			throw new ValidationException(json_decode((string) $response->getBody(), true));
357			}
358
359			if ($response->getStatusCode() === 404) {
360			throw new NotFoundException();
361			}
362
363			if ($response->getStatusCode() === 400) {
364			throw new FailedActionException((string) $response->getBody());
365			}
366
367			throw new Exception((string) $response->getBody());
368			}
369			}
370

proposal-page / sdk-php

Push — master ( 3497fb...435ff5 )

Client::createColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like