seregazhuk\PinterestBot\Api\Providers\Provider

Complexity

Total Complexity

13

Size/Duplication

Total Lines	155
Duplicated Lines	10.32 %

Coupling/Cohesion

Components	3
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	execPostRequest()	0	9	2
A	execGetRequest()	8	8	1
A	execGetRequestWithPagination()	8	8	1
A	execute()	0	8	1
A	getEntityIdName()	0	4	2
A	getPaginatedData()	0	4	1
A	checkMethodRequiresLogin()	0	4	1
A	isLoggedIn()	0	4	1
A	visitPage()	0	4	1
A	processResult()	0	4	1

<?php

namespace seregazhuk\PinterestBot\Api\Providers;

use seregazhuk\PinterestBot\Api\Request;
use seregazhuk\PinterestBot\Api\Response;

/**
 * Class Provider.
 * @property string entityIdName
 */
abstract class Provider
{
    /**
     * List of methods that require logged status.
     *
     * @var array
     */
    protected $loginRequiredFor = [];

    /**
     * Instance of the API Request.
     *
     * @var Request
     */
    protected $request;

    /**
     * @var Response
     */
    protected $response;

    /**
     * @param Request $request
     * @param Response $response
     */
    public function __construct(Request $request, Response $response)
    {
        $this->request = $request;
        $this->response = $response;
    }

    /**
     * Executes a POST request to Pinterest API.
     *
     * @param array $requestOptions
     * @param string $resourceUrl
     * @param bool $returnResponse
     *
     * @return Response|bool
     */
    protected function execPostRequest($requestOptions, $resourceUrl, $returnResponse = false)
    {
        $postString = Request::createQuery($requestOptions);

        $this->execute($resourceUrl, $postString);

        return $returnResponse ? $this->response : $this->response->isOk();

    }

    /**
     * Executes a GET request to Pinterest API.
     *
     * @param array $requestOptions
     * @param string $resourceUrl
     * @return array|bool
     */
    protected function execGetRequest(array $requestOptions = [], $resourceUrl = '')

This method seems to be duplicated in your project.

    {
        $query = Request::createQuery($requestOptions);

        $this->execute($resourceUrl . "?{$query}");

        return $this->response->getResponseData();
    }

    /**
     * Executes a GET request to Pinterest API with pagination.
     *
     * @param array $requestOptions
     * @param string $resourceUrl
     * @param array $bookmarks
     * @return Response
     */
    protected function execGetRequestWithPagination(array $requestOptions, $resourceUrl, $bookmarks = [])

This method seems to be duplicated in your project.

    {
        $query = Request::createQuery($requestOptions, $bookmarks);

        $this->execute($resourceUrl . "?{$query}");

        return $this->response;
    }

    /**
     * @param $url
     * @param string $postString
     * @return $this
     */
    protected function execute($url, $postString = "")
    {
        $result = $this->request->exec($url, $postString);

        $this->processResult($result);

        return $this;
    }

    /**
     * @return string
     */
    public function getEntityIdName()
    {
        return property_exists($this, 'entityIdName') ? $this->entityIdName : '';
    }

    /**
     * Executes pagination GET request.
     *
     * @param array $data
     * @param string $url
     * @param array $bookmarks
     * @return Response
     */
    public function getPaginatedData(array $data, $url, $bookmarks = [])
    {
        return $this->execGetRequestWithPagination($data, $url, $bookmarks);
    }

    /**
     * @param string $method
     *
     * @return bool
     */
    public function checkMethodRequiresLogin($method)
    {
        return in_array($method, $this->loginRequiredFor);
    }

    /**
     * @return bool
     */
    public function isLoggedIn()
    {
        return $this->request->isLoggedIn();
    }

    /**
     * Simply makes GET request to some url.
     * @param string $url
     * @return array|bool
     */
    public function visitPage($url = '')
    {
        return $this->execGetRequest([], $url);
    }

    /**
     * @param string $res
     * @return Response
     */
    protected function processResult($res)
    {
        return $this->response->fill(json_decode($res, true));
    }
}