Cornford\Packtpublr\PacktpublrBase

Complexity

Total Complexity

41

Size/Duplication

Total Lines	413
Duplicated Lines	3.39 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
C	__construct()	6	30	8
A	createRequest()	0	17	4
C	sendRequest()	8	37	7
B	parseResponse()	0	23	5
A	getHttpClient()	0	4	1
A	setHttpClient()	0	4	1
A	getCookieSubscriber()	0	4	1
A	setCookieSubscriber()	0	6	1
A	getConsoleOutput()	0	4	1
A	setConsoleOutput()	0	4	1
A	line()	0	4	1
A	info()	0	4	1
A	success()	0	4	1
A	warning()	0	4	1
A	error()	0	4	1
A	getResponseBody()	0	4	1
A	setResponseBody()	0	4	1
A	getResponseCode()	0	4	1
A	setResponseCode()	0	4	1
A	getResponseHeaders()	0	4	1
A	setResponseHeaders()	0	4	1

<?php namespace Cornford\Packtpublr;

use Cornford\Packtpublr\Contracts\RequestableInterface;
use Cornford\Packtpublr\Contracts\OutputableInterface;
use Cornford\Packtpublr\Exceptions\PacktpublrArgumentException;
use Cornford\Packtpublr\Exceptions\PacktpublrRequestException;
use Exception;
use GuzzleHttp\Client;
use GuzzleHttp\Cookie\CookieJar;
use GuzzleHttp\Message\ResponseInterface;
use GuzzleHttp\Subscriber\Cookie;
use Symfony\Component\Console\Output\ConsoleOutput;

abstract class PacktpublrBase implements RequestableInterface, OutputableInterface
{

    const REQUEST_TIMEOUT = 15;

    const REQUEST_METHOD_GET = 0;
    const REQUEST_METHOD_POST = 1;

    const REQUEST_CONTENT_PLAIN = 0;
    const REQUEST_CONTENT_XML = 1;
    const REQUEST_CONTENT_JSON = 2;

    const RESPONSE_CODE_OK = 200;

    /**
     * Guzzle Http client.
     *
     * @var Client
     */
    protected $httpClient;

    /**
     * Guzzle cookie subscriber.
     *
     * @var Cookie
     */
    protected $cookieSubscriber;

    /**
     * Symfony console output.
     *
     * @var ConsoleOutput
     */
    protected $consoleOutput;

    /**
     * The request type.
     *
     * @var integer
     */
    protected $requestType = self::REQUEST_CONTENT_PLAIN;

    /**
     * The base URL.
     *
     * @var string
     */
    protected $baseUrl;

    /**
     * Response body.
     *
     * @var string|object
     */
    protected $responseBody;

    /**
     * Response code.
     *
     * @var integer
     */
    protected $responseCode;

    /**
     * Response headers.
     *
     * @var array
     */
    protected $responseHeaders;

    /**
     * Construct Packtpublr
     *
     * @param array $options
     *
     * @throws PacktpublrArgumentException
     */
    public function __construct(array $options = [])
    {
        if (empty($options)) {
            throw new PacktpublrArgumentException('Packtpublr requires both email and password as arguments.');
        }

        if (!isset($options['email']) || isset($options['email']) && !is_string($options['email'])) {
            throw new PacktpublrArgumentException('Packtpublr email address is required.');
        }

        if (!isset($options['password']) || isset($options['password']) && !is_string($options['password'])) {
            throw new PacktpublrArgumentException('Packtpublr password is required.');
        }

        $this->email = $options['email'];
        $this->password = $options['password'];

        $this->httpClient = new Client([
            'base_url' => $this->baseUrl,
            'defaults' => [
                'connect_timeout' => self::REQUEST_TIMEOUT,
                'timeout' => self::REQUEST_TIMEOUT
            ]
        ]);

        $this->cookieSubscriber = new Cookie(new CookieJar());
        $this->httpClient->getEmitter()->attach($this->cookieSubscriber);

        $this->consoleOutput = new ConsoleOutput();
    }

    /**
     * Create request.
     *
     * @param string  $url
     * @param array   $parameters
     * @param integer $requestMethod
     * @param integer $requestContent
     *
     * @throws PacktpublrRequestException
     *
     * @return boolean
     */
    protected function createRequest(
        $url,
        array $parameters = [],
        $requestMethod = self::REQUEST_METHOD_GET,
        $requestContent = self::REQUEST_CONTENT_PLAIN
    ) {
        try {
            if ($requestMethod === self::REQUEST_METHOD_GET) {
                $url = isset($parameters['url']) ? str_replace(array_keys($parameters['url']), $parameters['url'], $url) : $url;
                unset($parameters['url']);
            }

            return $this->sendRequest($url, $parameters, $requestMethod, $requestContent);
        } catch (Exception $exception) {
            throw new PacktpublrRequestException('An error occurred during the request.');
        }
    }

    /**
     * Send request.
     *
     * @param string  $url
     * @param array   $parameters
     * @param integer $requestMethod
     * @param integer $requestContent
     *
     * @return boolean
     */
    protected function sendRequest(
        $url,
        array $parameters = [],
        $requestMethod = self::REQUEST_METHOD_GET,
        $requestContent = self::REQUEST_CONTENT_PLAIN
    ) {
        $request = null;

$request is not used, you could remove the assignment.

        switch ($requestMethod) {
            case self::REQUEST_METHOD_POST:
                switch ($requestContent) {
                    case self::REQUEST_CONTENT_XML:
                        $request = $this->getHttpClient()
                            ->post($url, ['headers' => ['content-type' => 'application/xml'], 'body' => $parameters]);
                        break;
                    case self::REQUEST_CONTENT_JSON:
                        $request = $this->getHttpClient()
                            ->post($url, ['headers' => ['content-type' => 'application/json'], 'body' => $parameters]);
                        break;
                    case self::REQUEST_CONTENT_PLAIN:
                    default:
                    $request = $this->getHttpClient()
                        ->post($url, ['body' => $parameters]);
                }
                break;
            case self::REQUEST_METHOD_GET:
            default:
                $request = $this->getHttpClient()
                    ->get($url);
        }

        if ($request === null) {
            return false;
        }

        return $this->parseResponse($request, $requestContent);
    }

    /**
     * Parse response.
     *
     * @param ResponseInterface $response
     * @param integer           $requestContent
     *
     * @return boolean
     */
    protected function parseResponse(ResponseInterface $response, $requestContent = self::REQUEST_CONTENT_PLAIN)
    {
        $this->setResponseCode((integer) $response->getStatusCode());
        $this->setResponseHeaders((array) $response->getHeaders());

        switch ($requestContent) {
            case self::REQUEST_CONTENT_XML:
                $this->setResponseBody($response->xml());
                break;
            case self::REQUEST_CONTENT_JSON:
                $this->setResponseBody($response->json());
                break;
            case self::REQUEST_CONTENT_PLAIN:
            default:
                $this->setResponseBody($response->getBody()->__toString());
        }

        if ($this->getResponseCode() !== self::RESPONSE_CODE_OK) {
            return false;
        }

        return true;
    }

    /**
     * Get Http client.
     *
     * @return Client
     */
    public function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * Set Http client.
     *
     * @param Client $client
     *
     * @return void
     */
    public function setHttpClient(Client $client)
    {
        $this->httpClient = $client;
    }

    /**
     * Get cookie subscriber
     *
     * @return Cookie
     */
    public function getCookieSubscriber()
    {
        return $this->cookieSubscriber;
    }

    /**
     * Set cookie subscriber.
     *
     * @param Cookie $cookieSubscriber
     *
     * @return void
     */
    public function setCookieSubscriber(Cookie $cookieSubscriber)
    {
        $this->getHttpClient()->getEmitter()->detach($this->cookieSubscriber);
        $this->cookieSubscriber = $cookieSubscriber;
        $this->getHttpClient()->getEmitter()->attach($this->cookieSubscriber);
    }

    /**
     * Get console output.
     *
     * @return ConsoleOutput
     */
    public function getConsoleOutput()
    {
        return $this->consoleOutput;
    }

    /**
     * Set console output.
     *
     * @param ConsoleOutput $consoleOutput
     *
     * @return void
     */
    public function setConsoleOutput(ConsoleOutput $consoleOutput)
    {
        $this->consoleOutput = $consoleOutput;
    }

    /**
     * Write a string as standard output.
     *
     * @param string $string
     *
     * @return void
     */
    public function line($string)
    {
        $this->consoleOutput->writeln($string);
    }

    /**
     * Write a string as information output.
     *
     * @param string $string
     * 
     * @return void
     */
    public function info($string)
    {
        $this->consoleOutput->writeln("<fg=cyan>$string</>");
    }

    /**
     * Write a string as success output.
     *
     * @param string $string
     *
     * @return void
     */
    public function success($string)
    {
        $this->consoleOutput->writeln("<fg=green>$string</>");
    }

    /**
     * Write a string as warning output.
     *
     * @param string $string
     * 
     * @return void
     */
    public function warning($string)
    {
        $this->consoleOutput->writeln("<fg=yellow>$string</>");
    }

    /**
     * Write a string as error output.
     *
     * @param string $string
     * 
     * @return void
     */
    public function error($string)
    {
        $this->consoleOutput->writeln("<fg=red>$string</>");
    }

    /**
     * Get response body.
     *
     * @return string|object
     */
    public function getResponseBody()
    {
        return $this->responseBody;
    }

    /**
     * Set response code.
     *
     * @param string|object $body
     *
     * @return void
     */
    protected function setResponseBody($body)
    {
        $this->responseBody = $body;
    }

    /**
     * Get response code.
     *
     * @return integer
     */
    public function getResponseCode()
    {
        return $this->responseCode;
    }

    /**
     * Set response code.
     *
     * @param integer $code
     *
     * @return void
     */
    protected function setResponseCode($code)
    {
        $this->responseCode = $code;
    }

    /**
     * Get response headers.
     *
     * @return array
     */
    public function getResponseHeaders()
    {
        return $this->responseHeaders;
    }

    /**
     * Set response headers.
     *
     * @param array $headers
     *
     * @return void
     */
    protected function setResponseHeaders($headers)
    {
        $this->responseHeaders = $headers;
    }

}