seregazhuk\PinterestBot\Api\Traits\Followable

Complexity

Total Complexity

10

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	5
Bugs	2	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	follow()	0	4	1
A	unFollow()	0	4	1
A	followCall()	0	9	1
A	followMethodCall()	0	4	1
A	createFollowRequestQuery()	0	18	2
A	getFollowUrl()	0	4	2
A	getUnFollowUrl()	0	4	2

<?php

namespace seregazhuk\PinterestBot\Api\Traits;

use seregazhuk\PinterestBot\Helpers\UrlHelper;

/**
 * Trait Followable
 * @package seregazhuk\PinterestBot\Api\Traits
 *
 * @property string $followUrl
 * @property string $unFollowUrl
 */
trait Followable
{
    use HandlesRequestAndResponse, HasEntityIdName;

    /**
     * Follow user by user_id.
     *
     * @param $entityId
     *
     * @return bool
     */
    public function follow($entityId)
    {
        return $this->followCall($entityId, $this->getFollowUrl());
    }

    /**
     * UnFollow user by user_id.
     *
     * @param $entityId
     *
     * @return bool
     */
    public function unFollow($entityId)
    {
        return $this->followCall($entityId, $this->getUnFollowUrl());
    }

    /**
     * Make api call for follow/unFollow a entity (user/board).
     *
     * @param int    $entityId
     * @param string $resourceUrl
     *
     * @return bool
     */
    protected function followCall($entityId, $resourceUrl)
    {
        $response = $this
            ->followMethodCall(
                $entityId, $resourceUrl
            );

        return !$this->getResponse()->hasErrors($response);
    }

    /**
     * Executes api call for follow/unfollow user.
     *
     * @param int    $entityId
     * @param string $entityName

There is no parameter named $entityName. Was it maybe removed?

     * @param string $url
     *
     * @return array
     */
    public function followMethodCall($entityId, $url)
    {
        return $this->getRequest()->exec($url, $this->createFollowRequestQuery($entityId));
    }

    public function createFollowRequestQuery($entityId)
    {
        $entityName = $this->getEntityIdName();

        $dataJson = [
            'options' => [
                $entityName => (string)$entityId,
            ],
            'context' => [],
        ];

        if ($entityName == 'interest_id') {
            $dataJson['options']['interest_list'] = 'favorited';
        }

        $post = ['data' => json_encode($dataJson, JSON_FORCE_OBJECT)];
        return UrlHelper::buildRequestString($post);
    }

    /**
     * @return string
     */
    protected function getFollowUrl()
    {
        return property_exists($this, 'followUrl') ? $this->followUrl : '';
    }

    /**
     * @return string
     */
    protected function getUnFollowUrl()
    {
        return property_exists($this, 'followUrl') ? $this->unFollowUrl : '';
    }
}