seregazhuk\PinterestBot\Api\Providers\Pinners

Complexity

Total Complexity

16

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	10

Importance

Changes	19
Bugs	4	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	info()	0	7	2
A	followers()	0	6	1
A	following()	0	6	1
A	pins()	0	6	1
A	login()	0	20	3
A	checkCredentials()	0	6	3
A	getScope()	0	4	1
A	getEntityIdName()	0	4	1
A	getFollowUrl()	0	4	1
A	getUnfFollowUrl()	0	4	1
A	getPaginatedData()	0	10	1

<?php

namespace seregazhuk\PinterestBot\Api\Providers;

use Iterator;
use LogicException;
use seregazhuk\PinterestBot\Api\Request;
use seregazhuk\PinterestBot\Exceptions\AuthException;
use seregazhuk\PinterestBot\Helpers\Pagination;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\FollowersTrait;
use seregazhuk\PinterestBot\Helpers\UrlHelper;
use seregazhuk\PinterestBot\Helpers\Requests\PinnerHelper;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\SearchTrait;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\FollowTrait;

class Pinners extends Provider
{
    use SearchTrait, FollowTrait, FollowersTrait;

    protected $loginRequired = [
        'follow',
        'unFollow'
    ];

    /**
     * Get user info.
     * If username param is not specified, will
     * return info for logged user
     *
     * @param string $username
     * @return null|array
     */
    public function info($username)
    {
        $res = $this->getPaginatedData($username, UrlHelper::RESOURCE_USER_INFO, "/$username/", 1);
        $res = iterator_to_array($res);

        return ! empty($res) ? $res[0] : null;
    }

    /**
     * Get pinner followers
     *
     * @param string $username
     * @param int $batchesLimit
     * @return Iterator
     */
    public function followers($username, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $username, UrlHelper::RESOURCE_USER_FOLLOWERS, "/$username/followers/", $batchesLimit
        );
    }

    /**
     * Get pinner following other pinners
     *
     * @param string $username
     * @param int $batchesLimit
     * @return Iterator
     */
    public function following($username, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $username, UrlHelper::RESOURCE_USER_FOLLOWING, "/$username/following/", $batchesLimit
        );
    }

    /**
     * Get pinner pins
     *
     * @param string $username
     * @param int $batchesLimit
     * @return Iterator
     */
    public function pins($username, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $username, UrlHelper::RESOURCE_USER_PINS, "/$username/$username/", $batchesLimit
        );
    }

    /**
     * Login as pinner
     *
     * @param string $username
     * @param string $password
     * @return bool
     * @throws AuthException
     */
    public function login($username, $password)
    {
        if ($this->request->isLoggedIn()) {
            return true;
        }

        $this->checkCredentials($username, $password);

        $post = PinnerHelper::createLoginRequest($username, $password);
        $postString = UrlHelper::buildRequestString($post);
        $this->request->clearToken();

        $response = $this->request->exec(UrlHelper::RESOURCE_LOGIN, $postString);
        $result = $this->response->checkErrorInResponse($response);
        if ( ! $result) {
            throw new AuthException($this->response->getLastError()['message']);
        }
        $this->request->setLoggedIn();
        return $result;
    }

    /**
     * Validates password and login
     *
     * @param string $username
     * @param string $password
     */
    protected function checkCredentials($username, $password)
    {
        if ( ! $username || ! $password) {
            throw new LogicException('You must set username and password to login.');
        }
    }

    /**
     * Search scope
     *
     * @return string
     */
    protected function getScope()
    {
        return 'people';
    }

    protected function getEntityIdName()
    {
        return Request::PINNER_ENTITY_ID;
    }

    /**
     * Follow resource
     *
     * @return string
     */
    protected function getFollowUrl()
    {
        return UrlHelper::RESOURCE_FOLLOW_USER;
    }

    /**
     * UnFollow resource
     * @return string
     */
    protected function getUnfFollowUrl()
    {
        return UrlHelper::RESOURCE_UNFOLLOW_USER;
    }

    /**
     * Wrapper over Pagination::getPaginatedData for 
     * high-level functions, such as 'following', 'pins' and others.
     *
     * @param string $username
     * @param string $url
     * @param string $sourceUrl
     * @param integer $batchesLimit
     * @return Iterator
     */
    protected function getPaginatedData($username, $url, $sourceUrl, $batchesLimit)
    {
        $data = [
            ['username' => $username],
            $url,
            $sourceUrl
        ];

        return Pagination::getPaginatedData([$this, 'getData'], $data, $batchesLimit);
    }
}