Gitter\Resources\Users

Complexity

Total Complexity

10

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	current()	0	14	3
A	currentUserId()	0	4	1
A	rooms()	0	7	1
A	unreadItems()	0	7	1
A	markAsRead()	0	8	1
A	orgs()	0	7	1
A	repos()	0	7	1
A	channels()	0	7	1

<?php
/**
 * This file is part of GitterApi package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Gitter\Resources;

use Gitter\Route;

/**
 * User schema
 *  - id:               Gitter User ID.
 *  - username:         Gitter/GitHub username.
 *  - displayName:      Gitter/GitHub user real name.
 *  - url:              Path to the user on Gitter.
 *  - avatarUrlSmall:   User avatar URI (small).
 *  - avatarUrlMedium:  User avatar URI (medium).
 *
 * @package Gitter\Resources
 */
class Users extends AbstractResource
{
    /**
     * @var array|null
     */
    private $currentUser;

    /**
     * Returns the current user logged in.
     *
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function current(): array
    {
        if ($this->currentUser === null) {
            $users = $this->fetch(Route::get('user'));

            if (isset($users[0])) {
                $this->currentUser = $users[0];
            } else {
                throw new \RuntimeException('Can not fetch current user');
            }
        }

        return $this->currentUser;
    }

    /**
     * @return string
     * @throws \Throwable
     * @throws \RuntimeException
     * @throws \Exception
     * @throws \InvalidArgumentException
     */
    public function currentUserId(): string
    {
        return (string)($this->current()['id'] ?? null);
    }

    /**
     * List of Rooms the user is part of.
     *
     * @param string|null $userId User id
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function rooms(string $userId = null): array
    {
        return $this->fetch(
            Route::get('user/{userId}/rooms')
                ->with('userId', $userId ?? $this->currentUserId())
        );
    }

    /**
     * You can retrieve unread items and mentions using the following endpoint.
     *
     * @param string $roomId
     * @param string|null $userId
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function unreadItems(string $roomId, string $userId = null): array
    {
        return $this->fetch(
            Route::get('user/{userId}/rooms/{roomId}/unreadItems')
                ->withMany(['userId' => $userId ?? $this->currentUserId(), 'roomId' => $roomId])
        );
    }

    /**
     * There is an additional endpoint nested under rooms that you can use to mark chat messages as read
     *
     * @param string $roomId
     * @param array $messageIds
     * @param string|null $userId
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function markAsRead(string $roomId, array $messageIds, string $userId = null): array
    {
        return $this->fetch(
            Route::post('user/{userId}/rooms/{roomId}/unreadItems')
                ->withMany(['userId' => $userId ?? $this->currentUserId(), 'roomId' => $roomId])
                ->withBody('chat', $messageIds)
        );
    }

    /**
     * List of the user's GitHub Organisations and their respective Room if available.
     *
     * @param string|null $userId
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function orgs(string $userId = null): array
    {
        return $this->fetch(
            Route::get('user/{userId}/orgs')
                ->with('userId', $userId ?? $this->currentUserId())
        );
    }

    /**
     * List of the user's GitHub Repositories and their respective Room if available.
     *
     * Note: It'll return private repositories if the current user has granted Gitter privileges to access them.
     *
     * @param string|null $userId
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function repos(string $userId = null): array
    {
        return $this->fetch(
            Route::get('user/{userId}/repos')
                ->with('userId', $userId ?? $this->currentUserId())
        );
    }

    /**
     * List of Gitter channels nested under the current user.
     *
     * @param string|null $userId
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Throwable
     * @throws \Exception
     */
    public function channels(string $userId = null): array
    {
        return $this->fetch(
            Route::get('user/{userId}/channels')
                ->with('userId', $userId ?? $this->currentUserId())
        );
    }
}