FlexyProject\GitHub\Receiver\Activity\Starring

Complexity

Total Complexity

9

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	listStargazers()	0	5	1
A	listRepositories()	0	11	2
A	checkYouAreStarringRepository()	0	12	2
A	starRepository()	0	12	2
A	unStarRepository()	0	12	2

<?php
namespace FlexyProject\GitHub\Receiver\Activity;

use FlexyProject\GitHub\AbstractApi;
use Symfony\Component\HttpFoundation\Request;

/**
 * The Starring API class provide a feature that lets users bookmark repositories.
 *
 * @link    https://developer.github.com/v3/activity/starring/
 * @package GitHub\Receiver\Activity
 */
class Starring extends AbstractActivity
{

    /**
     * List Stargazers
     *
     * @link https://developer.github.com/v3/activity/starring/#list-stargazers
     * @return array
     */
    public function listStargazers(): array
    {
        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/stargazers',
            $this->getActivity()->getOwner(), $this->getActivity()->getRepo()));
    }

    /**
     * List repositories being starred
     *
     * @link https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
     *
     * @param string $sort
     * @param string $direction
     * @param string $username
     *
     * @return array
     */
    public function listRepositories(string $sort = AbstractApi::SORT_CREATED,
                                     string $direction = AbstractApi::DIRECTION_DESC, string $username = null): array
    {
        if (null !== $username) {
            return $this->getApi()->request($this->getApi()->sprintf('/users/:username/starred?:args', $username,
                http_build_query(['sort' => $sort, 'direction' => $direction])));
        }

        return $this->getApi()->request($this->getApi()->sprintf('/user/starred?:args',
            http_build_query(['sort' => $sort, 'direction' => $direction])));
    }

    /**
     * Check if you are starring a repository
     *
     * @link https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
     * @return bool
     */
    public function checkYouAreStarringRepository(): bool
    {
        $this->getApi()->request($this->getApi()
                                      ->sprintf('/user/starred/:owner/:repo', $this->getActivity()->getOwner(),
                                          $this->getActivity()->getRepo()));

        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
            return true;
        }

        return false;
    }

    /**
     * Star a repository
     *
     * @link https://developer.github.com/v3/activity/starring/#star-a-repository
     * @return bool
     */
    public function starRepository(): bool
    {
        $this->getApi()->request($this->getApi()
                                      ->sprintf('/user/starred/:owner/:repo', $this->getActivity()->getOwner(),
                                          $this->getActivity()->getRepo()), Request::METHOD_PUT);

        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
            return true;
        }

        return false;
    }

    /**
     * Unstar a repository
     *
     * @link https://developer.github.com/v3/activity/starring/#unstar-a-repository
     * @return bool
     */
    public function unStarRepository(): bool
    {
        $this->getApi()->request($this->getApi()
                                      ->sprintf('/user/starred/:owner/:repo', $this->getActivity()->getOwner(),
                                          $this->getActivity()->getRepo()), Request::METHOD_DELETE);

        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
            return true;
        }

        return false;
    }
}