ZanySoft\LaravelSerpApi\Lib\RestClient

Complexity

Total Complexity

61

Size/Duplication

Total Lines	403
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	patch()	0	3	1
B	parse_response()	0	32	9
F	execute()	0	91	21
A	put()	0	3	1
A	key()	0	3	1
A	post()	0	3	1
A	head()	0	3	1
A	valid()	0	4	2
A	get()	0	3	1
A	register_decoder()	0	5	1
A	offsetUnset()	0	3	1
A	next()	0	3	1
A	__construct()	0	24	2
A	get_response_format()	0	22	5
A	current()	0	3	1
A	offsetExists()	0	6	2
A	offsetGet()	0	9	3
A	rewind()	0	5	1
A	delete()	0	3	1
A	decode_response()	0	16	3
A	set_option()	0	3	1
A	offsetSet()	0	3	1

<?php

declare(strict_types=1);

namespace ZanySoft\LaravelSerpApi\Lib;

use ZanySoft\LaravelSerpApi\Exceptions\RestClientException;

/**
 * PHP REST Client
 */
class RestClient implements \Iterator, \ArrayAccess
{
    public $options;
    public $handle; // cURL resource handle.
    public $url;

    // Populated after execution:
    public $response; // Response body.
    public $headers; // Parsed reponse header object.
    public $info; // Response info object.
    public $error; // Response error string.
    public $response_status_lines; // indexed array of raw HTTP response status lines.

    // Populated as-needed.
    public $decoded_response; // Decoded response body.

    public function __construct($options = [])
    {
        $default_options = [
            'headers' => [],
            'parameters' => [],
            'curl_options' => [],
            'build_indexed_queries' => false,
            'user_agent' => "PHP RestClient/0.1.8",
            'base_url' => null,
            'format' => null,
            'format_regex' => "/(\w+)\/(\w+)(;[.+])?/",
            'decoders' => [
                'json' => 'json_decode',
                'php' => 'unserialize'
            ],
            'username' => null,
            'password' => null
        ];

        $this->options = array_merge($default_options, $options);
        if (array_key_exists('decoders', $options)) {
            $this->options['decoders'] = array_merge(
                $default_options['decoders'],
                $options['decoders']
            );
        }
    }

    /**
     * @param $key
     * @param $value
     * @return void
     */
    public function set_option($key, $value)
    {
        $this->options[$key] = $value;
    }

    /**
     * @param $format
     * @param $method
     * @return void
     */
    public function register_decoder($format, $method)
    {
        // Decoder callbacks must adhere to the following pattern:
        // array my_decoder(string $data)
        $this->options['decoders'][$format] = $method;
    }

    // Iterable methods:

    /**
     * @return false|mixed|void
     * @throws RestClientException
     */
    public function rewind()
    {
        $this->decode_response();

        return reset($this->decoded_response);
    }

    /**
     * @return false|mixed
     */
    public function current()
    {
        return current($this->decoded_response);
    }

    /**
     * @return int|mixed|string|null
     */
    public function key()
    {
        return key($this->decoded_response);
    }

    /**
     * @return false|mixed|void
     */
    public function next()
    {
        return next($this->decoded_response);
    }

    /**
     * @return bool
     */
    public function valid()
    {
        return is_array($this->decoded_response)
            && (key($this->decoded_response) !== null);
    }

    // ArrayAccess methods:

    /**
     * @param $key
     * @return bool
     * @throws RestClientException
     */
    public function offsetExists($key)
    {
        $this->decode_response();

        return is_array($this->decoded_response) ?
            isset($this->decoded_response[$key]) : isset($this->decoded_response->{$key});
    }

    public function offsetGet($key)
    {
        $this->decode_response();
        if (!$this->offsetExists($key)) {
            return null;
        }

        return is_array($this->decoded_response) ?
            $this->decoded_response[$key] : $this->decoded_response->{$key};
    }

    public function offsetSet($key, $value)
    {
        throw new RestClientException("Decoded response data is immutable.");
    }

    public function offsetUnset($key)
    {
        throw new RestClientException("Decoded response data is immutable.");
    }

    // Request methods:

    /**
     * @param $url
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function get($url, $parameters = [], $headers = [])
    {
        return $this->execute($url, 'GET', $parameters, $headers);
    }

    /**
     * @param $url
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function post($url, $parameters = [], $headers = [])
    {
        return $this->execute($url, 'POST', $parameters, $headers);
    }

    /**
     * @param $url
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function put($url, $parameters = [], $headers = [])
    {
        return $this->execute($url, 'PUT', $parameters, $headers);
    }

    /**
     * @param $url
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function patch($url, $parameters = [], $headers = [])
    {
        return $this->execute($url, 'PATCH', $parameters, $headers);
    }

    /**
     * @param $url
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function delete($url, $parameters = [], $headers = [])
    {
        return $this->execute($url, 'DELETE', $parameters, $headers);
    }

    /**
     * @param $url
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function head($url, $parameters = [], $headers = [])
    {
        return $this->execute($url, 'HEAD', $parameters, $headers);
    }

    /**
     * @param $url
     * @param $method
     * @param $parameters
     * @param $headers
     * @return $this|RestClient
     */
    public function execute($url, $method = 'GET', $parameters = [], $headers = [])
    {
        $client = clone $this;
        $client->url = $url;
        $client->handle = curl_init();
        $curlopt = [
            CURLOPT_HEADER => true,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_USERAGENT => $client->options['user_agent'],
        ];

        if ($client->options['username'] && $client->options['password']) {
            $curlopt[CURLOPT_USERPWD] = sprintf(
                "%s:%s",
                $client->options['username'],
                $client->options['password']
            );
        }

        if (count($client->options['headers']) || count($headers)) {
            $curlopt[CURLOPT_HTTPHEADER] = [];
            $headers = array_merge($client->options['headers'], $headers);
            foreach ($headers as $key => $values) {
                foreach (is_array($values) ? $values : [$values] as $value) {
                    $curlopt[CURLOPT_HTTPHEADER][] = sprintf("%s:%s", $key, $value);
                }
            }
        }

        if ($client->options['format']) {
            $client->url .= '.' . $client->options['format'];
        }

        // Allow passing parameters as a pre-encoded string (or something that
        // allows casting to a string). Parameters passed as strings will not be
        // merged with parameters specified in the default options.
        if (is_array($parameters)) {
            $parameters = array_merge($client->options['parameters'], $parameters);
            $parameters_string = http_build_query($parameters);

            // http_build_query automatically adds an array index to repeated
            // parameters which is not desirable on most systems. This hack
            // reverts "key[0]=foo&key[1]=bar" to "key[]=foo&key[]=bar"
            if (!$client->options['build_indexed_queries']) {
                $parameters_string = preg_replace(
                    "/%5B[0-9]+%5D=/simU",
                    "%5B%5D=",
                    $parameters_string
                );
            }
        } else {
            $parameters_string = (string)$parameters;
        }

        if (strtoupper($method) == 'POST') {
            $curlopt[CURLOPT_POST] = true;
            $curlopt[CURLOPT_POSTFIELDS] = $parameters_string;
        } elseif (strtoupper($method) != 'GET') {
            $curlopt[CURLOPT_CUSTOMREQUEST] = strtoupper($method);
            $curlopt[CURLOPT_POSTFIELDS] = $parameters_string;
        } elseif ($parameters_string) {
            $client->url .= strpos($client->url, '?') ? '&' : '?';
            $client->url .= $parameters_string;
        }

        if ($client->options['base_url']) {
            if ($client->url[0] != '/' && substr($client->options['base_url'], -1) != '/') {
                $client->url = '/' . $client->url;
            }
            $client->url = $client->options['base_url'] . $client->url;
        }
        $curlopt[CURLOPT_URL] = $client->url;

        if ($client->options['curl_options']) {
            // array_merge would reset our numeric keys.
            foreach ($client->options['curl_options'] as $key => $value) {
                $curlopt[$key] = $value;
            }
        }
        curl_setopt_array($client->handle, $curlopt);

        $response = curl_exec($client->handle);
        if ($response !== false) {
            $client->parse_response($response);
        }
        $client->info = (object)curl_getinfo($client->handle);
        $client->error = curl_error($client->handle);

        curl_close($client->handle);

        return $client;
    }

    /**
     * @param $response
     * @return void
     */
    public function parse_response($response)
    {
        $headers = [];
        $this->response_status_lines = [];
        $line = strtok($response, "\n");
        do {
            if (strlen(trim($line)) == 0) {
                // Since we tokenize on \n, use the remaining \r to detect empty lines.
                if (count($headers) > 0) {
                    break;
                } // Must be the newline after headers, move on to response body
            } elseif (strpos($line, 'HTTP') === 0) {
                // One or more HTTP status lines
                $this->response_status_lines[] = trim($line);
            } else {
                // Has to be a header
                list($key, $value) = explode(':', $line, 2);
                $key = strtolower(trim(str_replace('-', '_', $key)));
                $value = trim($value);

                if (isset($headers[$key]) && empty($headers[$key])) {
                    $headers[$key] = $value;
                } elseif (isset($headers[$key]) && is_array($headers[$key])) {
                    $headers[$key][] = $value;
                } else {
                    $headers[$key] = [$headers[$key], $value];
                }
            }
        } while ($line = strtok("\n"));

        $this->headers = (object)$headers;
        $this->response = strtok("");
    }

    /**
     * @return string
     * @throws RestClientException
     */
    public function get_response_format()
    {
        $this->decode_response();

        if (!$this->response) {
            throw new RestClientException("A response must exist before it can be decoded.");
        }

        // User-defined format.
        if (!empty($this->options['format'])) {
            return $this->options['format'];
        }

        // Extract format from response content-type header.
        if (!empty($this->headers->content_type)) {
            if (preg_match($this->options['format_regex'], $this->headers->content_type, $matches)) {
                return $matches[2];
            }
        }

        throw new RestClientException(
            "Response format could not be determined."
        );
    }

    /**
     * @return mixed
     * @throws RestClientException
     */
    public function decode_response()
    {
        if (empty($this->decoded_response)) {
            $format = $this->get_response_format();
            if (!array_key_exists($format, $this->options['decoders'])) {
                throw new RestClientException("'${format}' is not a supported " .
                    "format, register a decoder to handle this response.");
            }

            $this->decoded_response = call_user_func(
                $this->options['decoders'][$format],
                $this->response
            );
        }

        return $this->decoded_response;
    }
}