TwitchSDK::status() - Code Metrics - Inspection of "Added client-id header to all requests." - jofner/Twitch-SDK - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — develop (#9)

unknown
created 2016-05-28 02:44 UTC
TwitchSDK::status() A

↳ Parent: TwitchSDK
Complexity

Conditions	3
Paths	3
Size

Total Lines	14
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
c	1
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	3
eloc	8
nc	3
nop	1
<?php

namespace jofner\SDK\TwitchTV;

use jofner\SDK\TwitchTV\Methods;

/**
 * TwitchTV API SDK for PHP
 *
 * PHP SDK for interacting with the TwitchTV API
 *
 * @author Josef Ohnheiser <[email protected]>
 * @license https://github.com/jofner/Twitch-SDK/blob/master/LICENSE.md MIT
 * @homepage https://github.com/jofner/Twitch-SDK
 */
class TwitchSDK
{
    /** @var array */
    private $config = array();

    /** @var TwitchRequest */
    protected $request;

    /** @var Helper */
    protected $helper;

    /**
     * TwitchSDK constructor
     * @param array $config
     * @throws TwitchException
     */
    public function __construct(array $config = array())
    {
        if (!in_array('curl', get_loaded_extensions(), true)) {
            throw new TwitchException('cURL extension is not installed and is required');
        }

        $this->setConfig($config);

        $this->request = new TwitchRequest($config);
        $this->helper = new Helper;
    }

    /**
     * config setter
     * @param array $config
     * @return TwitchSDK
     * @throws TwitchException
     */
    public function setConfig(array $config)
    {
        if ($this->configValidate($config) === true) {
            $this->config = $config;
        } else {
            throw new TwitchException('Wrong Twitch API config parameters');
        }

        return $this;
    }

    /**
     * Check if config is set
     * @throws TwitchException
     */
    private function checkConfig()
    {
        if (count($this->config) === 0) {
            $this->configException();
        }
    }

    /**
     * Get value from config
     * @param string $key
     * @return mixed
     * @throws TwitchException
     */
    private function getConfigParam($key)
    {
        if (!array_key_exists($key, $this->config)) {
            throw new TwitchException('Missing configuration parameter');
        }

        return $this->config[$key];
    }

    /**
     * Basic information about the API and authentication status
     * @param null $token
     * @return \stdClass
     * @throws TwitchException
     */
    public function status($token = null)
    {
        $auth = null;

        if ($token !== null) {
            if (count($this->config) === 0) {
                $this->configException();
            } else {
                $auth = $this->helper->buildQueryString(array('oauth_token' => $token));
            }
        }

        return $this->request->request($auth);
    }

    /**
     * Get the specified user
     * @param $username
     * @return \stdClass
     * @throws TwitchException
     */
    public function userGet($username)
    {
        $user = new Methods\User($this->request);

        return $user->getUser($username);
    }

    /**
     * Get a user's list of followed channels
     * @param string $user
     * @param integer $limit
     * @param integer $offset
     * @param string $direction
     * @param string $sortby
     * @return \stdClass
     * @throws TwitchException
     */
    public function userFollowChannels($user, $limit = null, $offset = null, $direction = null, $sortby = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
            'direction' => $direction,
            'sortby' => $sortby,
        ));

        $follow = new Methods\Follow($this->request);

        return $follow->userFollowChannels($user, $queryString);
    }

    /**
     * Get the status of a follow relationship
     * @param string $user
     * @param string $channel
     * @return \stdClass
     * @throws TwitchException
     */
    public function userFollowRelationship($user, $channel)
    {
        $follow = new Methods\Follow($this->request);

        return $follow->userIsFollowingChannel($user, $channel);
    }

    /**
     * Set user to follow given channel
     *  - requires scope 'user_follows_edit'
     * @param string $user
     * @param string $channel
     * @param string $userToken
     * @param bool $notifications
     * @return \stdClass
     * @throws TwitchException
     */
    public function authUserFollowChannel($user, $channel, $userToken, $notifications = false)
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'oauth_token' => $userToken,
            'notifications' => $notifications,
        ));

        $follow = new Methods\Follow($this->request);

        return $follow->followChannel($user, $channel, $queryString);
    }

    /**
     * Set user to unfollow given channel
     *  - requires scope 'user_follows_edit'
     * @param string $user
     * @param string $channel
     * @param string $userToken
     * @return \stdClass
     * @throws TwitchException
     */
    public function authUserUnfollowChannel($user, $channel, $userToken)
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'oauth_token' => $userToken,
        ));

        $follow = new Methods\Follow($this->request);

        return $follow->unfollowChannel($user, $channel, $queryString);
    }

    /**
     * Get the specified channel
     * @param string $channelName
     * @return \stdClass
     * @throws TwitchException
     */
    public function channelGet($channelName)
    {
        $channel = new Methods\Channel($this->request);

        return $channel->getChannels($channelName);
    }

    /**
     * Return team list for specified channel
     * @param string $channelName
     * @return \stdClass
     * @throws TwitchException
     */
    public function channelTeamsGet($channelName)
    {
        $channel = new Methods\Channel($this->request);

        return $channel->getTeams($channelName);
    }

    /**
     * Search channels
     * @param string $query
     * @param integer $limit
     * @param integer $offset
     * @return \stdClass
     * @throws TwitchException
     */
    public function channelSearch($query, $limit = null, $offset = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'query' => $query,
            'limit' => $limit,
            'offset' => $offset,
        ));

        $search = new Methods\Search($this->request);

        return $search->channels($queryString);
    }

    /**
     * Get the specified team
     * @param $teamName
     * @return \stdClass
     * @throws TwitchException
     */
    public function teamGet($teamName)
    {
        $team = new Methods\Team($this->request);

        return $team->getTeam($teamName);
    }

    /**
     * Returns a list of active teams
     * @param integer $limit
     * @param integer $offset
     * @return \stdClass
     * @throws TwitchException
     */
    public function teamList($limit = null, $offset = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
        ));

        $team = new Methods\Team($this->request);

        return $team->getTeams($queryString);
    }

    /**
     * Get all team members
     * @param $teamName
     * @return mixed
     * @throws TwitchException
     */
    public function teamMembersAll($teamName)
    {
        return $this->request->teamRequest($teamName . '/all_channels')->channels;
    }

    /**
     * Returns an array of users who follow the specified channel
     * @param string $channelName
     * @param integer $limit
     * @param integer $offset
     * @param string $cursor
     * @param string $direction
     * @return \stdClass
     * @throws TwitchException
     */
    public function channelFollows($channelName, $limit = null, $offset = null, $cursor = null, $direction = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
            'cursor' => $cursor,
            'direction' => $direction,
        ));

        $follow = new Methods\Follow($this->request);

        return $follow->getChannelFollows($channelName, $queryString);
    }

    /**
     * Get the specified channel's stream
     * @param $channel
     * @return \stdClass
     * @throws TwitchException
     */
    public function streamGet($channel)
    {
        $stream = new Methods\Stream($this->request);

        return $stream->getStream($channel);
    }

    /**
     * Search live streams
     * @param string $query
     * @param null $limit
     * @param null $offset
     * @param null $hls
     * @return \stdClass
     * @throws TwitchException
     */
    public function streamSearch($query, $limit = null, $offset = null, $hls = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'query' => $query,
            'limit' => $limit,
            'offset' => $offset,
            'hls' => $hls,
        ));

        $search = new Methods\Search($this->request);

        return $search->streams($queryString);
    }

    /**
     * Summarize streams
     * @param null $game
     * @param array|null $channels
     * @param null $hls
     * @return \stdClass
     * @throws TwitchException
     */
    public function streamsSummarize($game = null, array $channels = null, $hls = null)
    {
        if (!empty($channels)) {
            $channels = implode(',', $channels);
        }

        $queryString = $this->helper->buildQueryString(array(
            'game' => $game,
            'channel' => $channels,
            'hls' => $hls,
        ));

        $stream = new Methods\Stream($this->request);

        return $stream->getSummary($queryString);
    }

    /**
     * Get featured streams
     * @param null $limit
     * @param null $offset
     * @param null $hls
     * @return \stdClass
     * @throws TwitchException
     */
    public function streamsFeatured($limit = null, $offset = null, $hls = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
            'hls' => $hls,
        ));

        $stream = new Methods\Stream($this->request);

        return $stream->getFeatured($queryString);
    }

    /**
     * Get video
     * @param string $videoId
     * @return \stdClass
     * @throws TwitchException
     */
    public function videoGet($videoId)
    {
        $video = new Methods\Video($this->request);

        return $video->getVideo($videoId);
    }

    /**
     * Returns top videos
     * @param integer $limit
     * @param integer $offset
     * @param string $game
     * @param string $period
     * @return \stdClass
     * @throws TwitchException
     */
    public function videosTop($limit = null, $offset = null, $game = null, $period = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
            'game' => $game,
            'period' => $period,
        ));

        $video = new Methods\Video($this->request);

        return $video->getTop($queryString);
    }

    /**
     * Get videos for a channel
     * @param $channel
     * @param null $limit
     * @param null $offset
     * @param bool $broadcasts
     * @param bool $hls
     * @return \stdClass
     * @throws TwitchException
     */
    public function videosByChannel($channel, $limit = null, $offset = null, $broadcasts = null, $hls = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
            'broadcasts' => $broadcasts,
            'hls' => $hls,
        ));

        $video = new Methods\Video($this->request);

        return $video->getChannelVideos($channel, $queryString);
    }

    /**
     * Returns a links object to all other chat endpoints
     * @param string $channelName
     * @return \stdClass
     * @throws TwitchException
     */
    public function chatGet($channelName)
    {
        $chat = new Methods\Chat($this->request);

        return $chat->getChat($channelName);
    }

    /**
     * Get a chat's emoticons
     * @return \stdClass
     * @throws TwitchException
     */
    public function chatEmoticons()
    {
        $chat = new Methods\Chat($this->request);

        return $chat->getEmoticons();
    }

    /**
     * Returns a list of emoticons
     * @param string $emoteset
     * @return \stdClass
     * @throws TwitchException
     */
    public function chatEmoticonsImages($emoteset = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'emotesets' => $emoteset,
        ));

        $chat = new Methods\Chat($this->request);

        return $chat->getEmoticonImages($queryString);
    }

    /**
     * Returns a list of chat badges
     * @param string $channelName
     * @return \stdClass
     * @throws TwitchException
     */
    public function chatBadges($channelName)
    {
        $chat = new Methods\Chat($this->request);

        return $chat->getBadges($channelName);
    }

    /**
     * Get top games
     * @param integer $limit
     * @param integer $offset
     * @return \stdClass
     * @throws TwitchException
     */
    public function gamesTop($limit = null, $offset = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'limit' => $limit,
            'offset' => $offset,
        ));

        $game = new Methods\Game($this->request);

        return $game->getTop($queryString);
    }

    /**
     * Search games
     * @param string $query
     * @param null $type
     * @param null $live
     * @return \stdClass
     * @throws TwitchException
     */
    public function gameSearch($query, $type = null, $live = null)
    {
        $queryString = $this->helper->buildQueryString(array(
            'query' => $query,
            'type' => $type,
            'live' => $live,
        ));

        $search = new Methods\Search($this->request);

        return $search->games($queryString);
    }

    /**
     * Get HTML code for stream embedding
     * @param $channel
     * @param int $width
     * @param int $height
     * @param int $volume
     * @return string
     * @deprecated Will be replaced with Embed method
     */
    public function embedStream($channel, $width = 620, $height = 378, $volume = 25)
    {
        return '<object type="application/x-shockwave-flash"
                height="' . $height . '"
                width="' . $width . '"
                id="live_embed_player_flash"
                data="http://www.twitch.tv/widgets/live_embed_player.swf?channel=' . $channel . '"
                bgcolor="#000000">
                <param  name="allowFullScreen"
                    value="true" />
                <param  name="allowScriptAccess"
                    value="always" />
                <param  name="allowNetworking"
                    value="all" />
                <param  name="movie"
                    value="http://www.twitch.tv/widgets/live_embed_player.swf" />
                <param  name="flashvars"
                    value="hostname=www.twitch.tv&channel=' . $channel . '&auto_play=true&start_volume=' . $volume . '" />
                </object>';
    }

    /**
     * Get HTML code for video embedding
     * @param $channel
     * @param $chapterid
     * @param int $width
     * @param int $height
     * @param int $volume
     * @return string
     * @deprecated Will be replaced with Embed method
     */
    public function embedVideo($channel, $chapterid, $width = 400, $height = 300, $volume = 25)
    {
        return '<object bgcolor="#000000"
                    data="http://www.twitch.tv/widgets/archive_embed_player.swf"
                    width="' . $width . '"
                    height="' . $height . '"
                    id="clip_embed_player_flash"
                    type="application/x-shockwave-flash">
                <param  name="movie"
                    value="http://www.twitch.tv/widgets/archive_embed_player.swf" />
                <param  name="allowScriptAccess"
                    value="always" />
                <param  name="allowNetworking"
                    value="all" />
                <param name="allowFullScreen"
                    value="true" />
                <param  name="flashvars"
                    value="channel=' . $channel . '&start_volume=' . $volume . '&auto_play=false&chapter_id=' . $chapterid . '" />
                </object>';
    }

    /**
     * Get HTML code for chat embedding
     * @param $channel
     * @param int $width
     * @param int $height
     * @return string
     * @deprecated Will be replaced with Embed method
     */
    public function embedChat($channel, $width = 400, $height = 300)
    {
        return '<iframe frameborder="0"
                    scrolling="no"
                    id="chat_embed"
                    src="http://twitch.tv/chat/embed?channel=' . $channel . '&amp;popout_chat=true"
                    height="' . $height . '"
                    width="' . $width . '">
                </iframe>';
    }

    /**
     * Get login URL for authentication
     * @param string $scope Specify which permissions your app requires (space separated list)
     * @return \stdClass
     * @throws TwitchException
     */
    public function authLoginURL($scope)
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'response_type' => 'code',
            'client_id' => $this->getConfigParam('client_id'),
            'redirect_uri' => $this->getConfigParam('redirect_uri'),
            'scope' => $scope,
        ));

        $auth = new Methods\Auth($this->request);

        return $auth->getLoginURL($queryString);
    }

    /**
     * Get authentication access token
     * @param string $code returned after app authorization by user
     * @return \stdClass
     * @throws TwitchException
     */
    public function authAccessTokenGet($code)
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'client_id' => $this->getConfigParam('client_id'),
            'client_secret' => $this->getConfigParam('client_secret'),
            'grant_type' => 'authorization_code',
            'redirect_uri' => $this->getConfigParam('redirect_uri'),
            'code' => $code,
        ));

        $auth = new Methods\Auth($this->request);

        return $auth->getAccessToken($queryString);
    }

    /**
     * Get the authenticated user
     *  - requires scope 'user_read'
     * @param string
     * @return \stdClass
     * @throws TwitchException
     */
    public function authUserGet($token)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $user = new Methods\User($this->request);

        return $user->getUserAuth($queryString);
    }

    /**
     * Returns a list of blocks
     *  - required scope 'user_blocks_read'
     * @param string $token
     * @param string $user
     * @param integer $limit
     * @param integer $offset
     * @return \stdClass
     * @throws TwitchException
     */
    public function authUserBlocks($token, $user, $limit = null, $offset = null)
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'oauth_token' => $token,
            'client_id' => $this->getConfigParam('client_id'),
            'limit' => $limit,
            'offset' => $offset,
        ));

        $block = new Methods\Block($this->request);

        return $block->getBlocks($user, $queryString);
    }

    /**
     * Adds $target to $user block list
     *  - requires scope 'user_blocks_edit'
     * @param string $token
     * @param string $user
     * @param string $target
     * @return \stdClass
     * @throws TwitchException
     */
    public function authBlockTarget($token, $user, $target)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $block = new Methods\Block($this->request);

        return $block->blockTarget($user, $target, $queryString);
    }

    /**
     * Removes $target from $user block list
     *  - requires scope 'user_blocks_edit'
     * @param string $token
     * @param string $user
     * @param string $target
     * @return \stdClass
     * @throws TwitchException
     */
    public function authRemoveTarget($token, $user, $target)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $block = new Methods\Block($this->request);

        return $block->removeTarget($user, $target, $queryString);
    }

    /**
     * Get the authenticated channel
     *  - requires scope 'channel_read'
     * @param string
     * @return \stdClass
     * @throws TwitchException
     */
    public function authChannelGet($token)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $channels = new Methods\Channel($this->request);

        return $channels->getChannel($queryString);
    }

    /**
     * Update channel's status or game
     *  - requires scope 'channel_editor'
     * @param $token
     * @param string $channelName
     * @param string $status
     * @param string $game
     * @param integer $delay
     * @return \stdClass
     * @throws TwitchException
     */
    public function authChannelSet($token, $channelName, $status = null, $game = null, $delay = null)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);

        $data = $this->helper->buildQueryString(array(
            'channel[status]' => $status,
            'channel[game]' => $game,
            'channel[delay]' => $delay,
        ));

        $channel = new Methods\Channel($this->request);

        return $channel->setChannel($channelName, $queryString, $data);
    }

    /**
     * Resets channel's stream key
     *  - requires scope 'channel_stream'
     * @param string $token
     * @param string $channelName
     * @return \stdClass
     * @throws TwitchException
     */
    public function authChannelResetKey($token, $channelName)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $channel = new Methods\Channel($this->request);

        return $channel->resetStreamKey($channelName, $queryString);
    }

    /**
     * Returns an array of users who are editors of specified channel
     *  - requires scope 'channel_read'
     * @param string
     * @param string
     * @return \stdClass
     * @throws TwitchException
     */
    public function authChannelEditors($token, $channel)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $channels = new Methods\Channel($this->request);

        return $channels->getEditors($channel, $queryString);
    }

    /**
     * Returns an array of subscriptions who are subscribed to specified channel
     *  - requires scope 'channel_subscriptions'
     * @param string $token - user's access token
     * @param string $channel
     * @param integer $limit - can be up to 100
     * @param integer $offset
     * @param string $direction can be DESC|ASC, if DESC - lasts will be showed first
     * @return \stdClass
     * @throws TwitchException
     */
    public function authChannelSubscriptions($token, $channel, $limit = 25, $offset = 0, $direction = 'DESC')
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'oauth_token' => $token,
            'client_id' => $this->getConfigParam('client_id'),
            'direction' => $direction,
            'limit' => $limit,
            'offset' => $offset
        ));

        $subscription = new Methods\Subscription($this->request);

        return $subscription->getSubscriptions($channel, $queryString);
    }

    /**
     * Returns user object if that user is subscribed
     *  - requires scope 'channel_check_subscription' for channel
     * @param string $token
     * @param string $channel
     * @param string $user
     * @return \stdClass
     * @throws TwitchException
     */
    public function authSubscribedUser($token, $channel, $user)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $subscription = new Methods\Subscription($this->request);

        return $subscription->getSubscribedUser($channel, $user, $queryString);
    }

    /**
     * Returns a channel object that user subscribes to
     *  - requires scope 'user_subscriptions' for user
     * @param string $token
     * @param string $user
     * @param string $channel
     * @return \stdClass
     * @throws TwitchException
     */
    public function authSubscribedToChannel($token, $user, $channel)
    {
        $this->checkConfig();
        $queryString = $this->getAuthString($token);
        $subscription = new Methods\Subscription($this->request);

        return $subscription->getSubscribedToChannel($user, $channel, $queryString);
    }

    /**
     * List the live streams that the authenticated user is following
     *  - requires scope 'user_read'
     * @param string
     * @param integer $limit
     * @param integer $offset
     * @param bool $hls
     * @return \stdClass
     * @throws TwitchException
     */
    public function authStreamsFollowed($token, $limit = 25, $offset = 0, $hls = null)
    {
        $this->checkConfig();

        $queryString = $this->helper->buildQueryString(array(
            'oauth_token' => $token,
            'client_id' => $this->getConfigParam('client_id'),
            'limit' => $limit,
            'offset' => $offset,
            'hls' => $hls,
        ));

        $user = new Methods\User($this->request);

        return $user->getFollowedStreams($queryString);
    }

    /**
     * Get streams helper
     * @param null $game
     * @param string|null $channels
     * @param null $limit
     * @param null $offset
     * @param null $embeddable
     * @param null $hls
     * @return \stdClass
     * @throws TwitchException
     */
    public function getStreams($game = null, $channels = null, $limit = null, $offset = null, $embeddable = null, $hls = null)
    {
        $params = array(
            'game' => $game,
            'channel' => !empty($channels) ? $channels : null,
            'limit' => $limit,
            'offset' => $offset,
            'embeddable' => $embeddable,
            'hls' => $hls,
        );

        $queryString = $this->helper->buildQueryString($params);
        $stream = new Methods\Stream($this->request);

        return $stream->getStreams($queryString);
    }

    /**
     * Validate parameters for authentication
     * @param array
     * @return boolean
     */
    private function configValidate($config)
    {
        $check = array('client_id', 'client_secret', 'redirect_uri');

        foreach ($check AS $val) {
            if (!array_key_exists($val, $config) ||
                (empty($config[$val]) ||
                    !is_string($config[$val]))
            ) {
                return false;
            }
        }

        return true;
    }

    /**
     * Returns string for auth
     * @param string $token
     * @return null|string
     * @throws TwitchException
     */
    private function getAuthString($token)
    {
        return $this->helper->buildQueryString(array(
            'oauth_token' => $token,
            'client_id' => $this->getConfigParam('client_id'),
        ));
    }

    /**
     * Configuration exception
     * @throws TwitchException
     */
    private function configException()
    {
        throw new TwitchException('Cannot call authenticate functions without valid API configuration');
    }
}

jofner / Twitch-SDK

Pull Request — develop (#9)

TwitchSDK::status() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
