ProposalPage\Sdk\Client

Complexity

Total Complexity

57

Size/Duplication

Total Lines	350
Duplicated Lines	0 %

Importance

Changes

0

48 Methods

Rating	Name	Duplication	Size	Complexity
A	secureProject()	0	3	1
A	createContent()	0	6	1
A	deleteColumn()	0	3	1
A	__construct()	0	10	2
A	updateProject()	0	3	1
A	listProject()	0	3	1
A	authMe()	0	3	1
A	setProjectPassword()	0	3	1
A	listRow()	0	3	1
A	createBlock()	0	3	1
A	getToken()	0	3	1
A	authenticate()	0	12	2
A	cloneRow()	0	3	1
A	getApiUrl()	0	3	1
A	moveBlockBackward()	0	3	1
A	request()	0	16	3
A	setApiUrl()	0	5	1
A	listColumn()	0	3	1
A	listProjects()	0	5	1
A	deleteProject()	0	3	1
A	listRows()	0	3	1
A	updateRow()	0	3	1
A	viewProjectAndNotify()	0	3	1
A	createProjectFromTemplate()	0	3	1
A	listBlocks()	0	3	1
A	deleteContent()	0	3	1
A	listTemplates()	0	5	1
A	createProject()	0	3	1
A	updateColumn()	0	3	1
A	publishProject()	0	3	1
A	createRow()	0	3	1
A	setToken()	0	5	1
A	listContents()	0	3	1
A	createColumn()	0	3	1
A	moveBlockForward()	0	3	1
A	getRequestHeaders()	0	13	2
A	listContent()	0	3	1
A	updateContent()	0	6	1
A	listColumns()	0	3	1
A	isSuccessfulResponse()	0	7	2
A	deleteBlock()	0	3	1
A	cloneBlock()	0	3	1
A	generateProjectCover()	0	3	1
A	handleRequestError()	0	15	4
A	updateBlock()	0	3	1
A	listBlock()	0	3	1
A	deleteRow()	0	3	1
A	cloneProject()	0	3	1

<?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(ResponseInterface $response)
    {
        if (! $response) {

$response is of type Psr\Http\Message\ResponseInterface, thus it always evaluated to true.

            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());
    }
}