seregazhuk\PinterestBot\Api\Providers\Pinners

Complexity

Total Complexity

12

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	info()	0	4	1
A	following()	0	10	2
A	followingPeople()	0	4	1
A	followingBoards()	0	4	1
A	followingInterests()	0	4	1
A	pins()	0	6	1
A	likes()	0	6	1
A	block()	0	9	2
A	blockById()	0	6	1
A	paginate()	0	9	1

<?php

namespace seregazhuk\PinterestBot\Api\Providers;

use Iterator;
use seregazhuk\PinterestBot\Api\Response;
use seregazhuk\PinterestBot\Helpers\UrlBuilder;
use seregazhuk\PinterestBot\Api\Traits\Followable;
use seregazhuk\PinterestBot\Api\Traits\Searchable;
use seregazhuk\PinterestBot\Exceptions\WrongFollowingType;

class Pinners extends Provider
{
    use Searchable, Followable;

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

    protected $searchScope  = 'people';
    protected $entityIdName = 'user_id';
    protected $followersFor = 'username';

    protected $followUrl    = UrlBuilder::RESOURCE_FOLLOW_USER;
    protected $unFollowUrl  = UrlBuilder::RESOURCE_UNFOLLOW_USER;
    protected $followersUrl = UrlBuilder::RESOURCE_USER_FOLLOWERS;
    
    /**
     * Get user info.
     * If username param is not specified, will
     * return info for logged user.
     *
     * @param string $username
     *
     * @return array
     */
    public function info($username)
    {
        return $this->execGetRequest(['username' => $username], UrlBuilder::RESOURCE_USER_INFO);
    }

    /**
     * Get following info for pinner.
     *
     * @param string $username
     * @param string $type
     * @param int $limit
     * @return Iterator
     * @throws WrongFollowingType
     */
    public function following($username, $type = UrlBuilder::FOLLOWING_PEOPLE, $limit = 0)
    {
        $followingUrl = UrlBuilder::getFollowingUrlByType($type);

        if(empty($followingUrl)) {
            throw new WrongFollowingType("No following results for $type");
        }

        return $this->paginate($username, $followingUrl, $limit);
    }

    /**
     * @codeCoverageIgnore
     * Get following people for pinner.
     *
     * @param string $username
     * @param int $limit
     * @return Iterator
     */
    public function followingPeople($username, $limit = 0)
    {
        return $this->following($username, UrlBuilder::FOLLOWING_PEOPLE, $limit);
    }

    /**
     * @codeCoverageIgnore
     * Get following boards for pinner.
     *
     * @param string $username
     * @param int $limit
     * @return Iterator
     */
    public function followingBoards($username, $limit = 0)
    {
        return $this->following($username, UrlBuilder::FOLLOWING_BOARDS, $limit);
    }

    /**
     * @codeCoverageIgnore
     * Get following interests for pinner.
     *
     * @param string $username
     * @param int $limit
     * @return Iterator
     * @throws WrongFollowingType
     */
    public function followingInterests($username, $limit = 0)
    {
        return $this->following($username, UrlBuilder::FOLLOWING_INTERESTS, $limit);
    }

    /**
     * Get pinner pins.
     *
     * @param string $username
     * @param int $limit
     *
     * @return Iterator
     */
    public function pins($username, $limit = 0)
    {
        return $this->paginate(
            $username, UrlBuilder::RESOURCE_USER_PINS, $limit
        );
    }

    /**
     * Get pins that user likes.
     *
     * @param string $username
     * @param int $limit
     * @return Iterator
     */
    public function likes($username, $limit = 0)
    {
        return $this->paginate(
            $username, UrlBuilder::RESOURCE_USER_LIKES, $limit
        );
    }

    /**
     * @param string $username
     * @return bool|Response
     */
    public function block($username)
    {
        // Retrieve profile data to get user id
        $profile = $this->info($username);

        if(empty($profile)) return false;

        return $this->blockById($profile['id']);
    }

    /**
     * @param int $userId
     * @return bool|Response
     */
    public function blockById($userId)
    {
        $data = ['blocked_user_id' => $userId];

        return $this->execPostRequest($data, UrlBuilder::RESOURCE_BLOCK_USER);
    }

    /**
     * @param string $username
     * @param string $url
     * @param int $limit
     *
     * @return Iterator
     */
    protected function paginate($username, $url, $limit)
    {
        $params = [
            'data' => ['username' => $username],
            'url'  => $url,
        ];

        return $this->getPaginatedResponse($params, $limit);
    }
}