johnnymast / redbox-twitch

src/Resource/ResourceAbstract.php

<?php
namespace Redbox\Twitch\Resource;
use Redbox\Twitch\Exception;
use Redbox\Twitch\Transport\HttpRequest;
use Redbox\Twitch;

class ResourceAbstract
{
    /**
     * @var array
     */
    private $methods;

    /**
     * @var Twitch\Client
     */
    private $client;

    /**
     * @var string
     */
    private $resource_name;

    /**
     * @var array
     */
    private $url_parts = array();


    /**
     * ResourceAbstract constructor.
     *
     * @param Twitch\Client $client
     * @param string $resource_name
     * @param array $declaration
     */
    public function __construct(Twitch\Client $client, $resource_name = "", $declaration = [])
    {
        $this->client        = $client;
        $this->resource_name = $resource_name;
        $this->methods       = isset($declaration['methods']) ? $declaration['methods'] : [];

        // If this line gives errros .. Comment it out because somewhere in the resource it self is an error.
      //  $client->registerResource($this->resource_name, $this);
        // Todo validate resources
    }

    /**
     * Validate arguments given for a 'virtual' method.
     *
     * @param string $method_name
     * @param array $args
     * @return bool
     * @throws Exception\RuntimeException
     */
    private function validate_arguments($method_name = '', $args = array())
    {
        if (isset($this->methods[$method_name]) === true) {
            $method = $this->methods[$method_name];
            if (isset($method['parameters']) === true and is_array($method['parameters']) === true) {
                $parameters = $method['parameters'];
                foreach ($parameters as $name => $options) {
                    switch ($options['type']) {
                        case 'integer':
                            // todo implment default value as seen in team

                            // Required
                            if (isset($options['required']) === true and $options['required'] === true and isset($args[$name]) === false)
                                throw new Exception\RuntimeException($this->resource_name.' requires parameter '.$name.' to be given for method '.$method_name);

                            // Min
                            if (isset($options['min']) === true and (isset($args[$name]) === true and $args[$name] < $options['min']))
                                throw new Exception\RuntimeException($this->resource_name . ' requires parameter ' . $name . ' to have a minimum value of ' . $options['min'] . ' for method ' . $method_name);

                            // Min
                            if (isset($options['max']) === true and (isset($args[$name]) === true and $args[$name] > $options['max']))
                                throw new Exception\RuntimeException($this->resource_name . ' requires parameter ' . $name . ' to have a maximum value of ' . $options['min'] . ' for method ' . $method_name);


                            break;
                        case 'string':

                            // Required
                            if (isset($options['required']) === true and $options['required'] === true and isset($args[$name]) === false)
                                throw new Exception\RuntimeException($this->resource_name . ' requires parameter ' . $name . ' to be given for method ' . $method_name);

                            // todo add validator for restricted_value

                            // Url Part
                            if (isset($options['url_part']) === true and $options['url_part'] === true and isset($args[$name]) === false) {
                                throw new Exception\RuntimeException($this->resource_name . ' requires parameter ' . $name . ' to be given for method ' . $method_name);
                            } else if (isset($options['url_part']) === true and $options['url_part'] == true and isset($args[$name]) === true) {
                                $this->url_parts[$method_name][':' . $name] = array('name' => $name, 'value' => $args[$name]);
                            }
                            break;
                    }
                }
            }
        }
        return true;
    }

    /**
     * Call and process the 'virtual' method as defined in Client.php
     *
     * @param string $method
     * @param array $arguments
     * @param array $body
     * @return mixed
     * @throws Exception\AuthorizationRequiredException
     * @throws Exception\RuntimeException
     */
    public function call($method, $arguments = array(), $body = array())
    {
        if ($this->validate_arguments($method, $arguments) === true)
        {

            $headers = array();
            $headers['Accept']    = 'application/vnd.twitchtv.v3+json';
            $headers['Client-ID'] = $this->client->getClientId();

            if (isset($this->methods[$method]['requiresAuth']) === true) {
                if ($this->methods[$method]['requiresAuth'] === true && !$this->client->getAccessToken()) {
                    throw new Exception\AuthorizationRequiredException('Method: '.$method.' requires authorization. Did you forget to use setAccessToken() ?');
                }
            }

            if (isset($this->methods[$method]['requireScope']) == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

                /* Should the be an auth exception ? */
                throw new Exception\AuthorizationRequiredException('Method: '.$method.' did not set define any scope.');
            } else {
                $client_scope = $this->getClient()->getScope();
                $required_scope = $this->methods[$method]['requireScope'];
                foreach($required_scope as $scope) {
                    if (in_array($scope, $client_scope) == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

                        throw new Exception\AuthorizationRequiredException('Method: '.$method.' requires scope: '.$scope.' to be set.');
                    }
                }

            }

            if ($this->client->getAccessToken())
                $headers['Authorization'] = 'OAuth ' . $this->client->getAccessToken();


            if (isset($this->url_parts[$method]) === true and is_array($this->url_parts[$method]) === true) {
                if (count($this->url_parts[$method]) > 0) {
                    foreach ($this->url_parts[$method] as $key => $url_part) {
                        $this->methods[$method]['path'] = str_replace($key, $url_part['value'], $this->methods[$method]['path']);
                        unset($arguments[$url_part['name']]);
                    }
                }
            }

            $url = '/'.$this->methods[$method]['path'];

            $count = 0;
            while ($value = current($arguments)) {
                $url .= (($count > 0) ? '&' : '?').key($arguments).'='.urlencode($value);
                next($arguments);
                $count++;
            }

            $request = new HttpRequest(
                $url,
                $this->methods[$method]['httpMethod'],
                $headers,
                $body
            );

            $response = $this->client->getTransport()->sendRequest(
                $request
            );

            return $response;
        }
    }

    /**
     * @return Client
     */
    public function getClient() {
        return $this->client;
    }

    /**
     * @return string
     */
    public function getResourceName() {
        return $this->resource_name;
    }

    /**
     * @return array
     */
    public function getMethods() {
        return $this->methods;
    }

}