codeclimate/php-test-reporter

View on GitHub
src/TestReporter/ApiClient.php

Summary

Maintainability
A
2 hrs
Test Coverage
<?php
namespace CodeClimate\PhpTestReporter\TestReporter;

use CodeClimate\PhpTestReporter\Constants\Version;

class ApiClient
{
    /**
     * @var string
     */
    protected $apiHost = "https://codeclimate.com";

    /**
     * Init the API client and set the hostname
     */
    public function __construct()
    {
        if (isset($_SERVER["CODECLIMATE_API_HOST"])) {
            $this->apiHost = $_SERVER["CODECLIMATE_API_HOST"];
        }
    }

    /**
     * Send the given JSON as a request to the CodeClimate Server
     *
     * @param Entity\JsonFile $json JSON data
     *
     * @return \stdClass Response object with (code, message, headers & body properties)
     */
    public function send(Entity\JsonFile $json)
    {
        $response = new \stdClass;
        $payload  = (string)$json;
        $options  = array(
            'http' => array(
                'method'  => 'POST',
                'header'  => array(
                    'Host: ' . parse_url($this->apiHost, PHP_URL_HOST),
                    'Content-Type: application/json',
                    'User-Agent: Code Climate (PHP Test Reporter v' . Version::VERSION . ')',
                    'Content-Length: ' . strlen($payload),
                ),
                'content' => $payload,
                "timeout" => 10,
            ),
        );
        $context  = stream_context_create($options);
        $url      = $this->apiHost . '/test_reports';

        if ($stream = @fopen($url, 'r', false, $context)) {
            $meta        = stream_get_meta_data($stream);
            $rawResponse = implode("\r\n", $meta['wrapper_data']) . "\r\n\r\n" . stream_get_contents($stream);
            fclose($stream);

            if (!empty($rawResponse)) {
                $response = $this->buildResponse($response, $rawResponse);
            }
        } else {
            $response = $this->sendWithCurl($url, $payload);
        }

        return $response;
    }

    /**
     * Send the given JSON as a request to the CodeClimate Server using cURL.
     * Added as a backup if PHP Streams method fails (e.g. if allow_url_fopen is disabled).
     *
     * @param string $url     The API end-point URL
     * @param string $payload The request payload as a JSON-encoded string
     *
     * @return \stdClass Response object with (code, message, headers & body properties)
     */
    private function sendWithCurl($url, $payload)
    {
        $response = new \stdClass;
        $curl     = curl_init($url);
        curl_setopt($curl, CURLOPT_HEADER, true);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
        curl_setopt(
            $curl,
            CURLOPT_HTTPHEADER,
            array(
                'Host: ' . parse_url($this->apiHost, PHP_URL_HOST),
                'Content-Type: application/json',
                'User-Agent: Code Climate (PHP Test Reporter v' . Version::VERSION . ')',
                'Content-Length: ' . strlen($payload),
            )
        );
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
        $rawResponse = curl_exec($curl);

        $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
        if (!empty($rawResponse)) {
            $response = $this->buildResponse($response, $rawResponse);
        } else {
            $error = error_get_last();
            preg_match('/(\d{3})/', $error['message'], $match);

            $errorCode = 500;

            if (isset($match[1])) {
                $errorCode = $match[1];
            } elseif ($status) {
                $errorCode = $status;
            }

            $response->code    = $errorCode;
            $response->message = $error['message'];
            $response->headers = array( );
            $response->body    = null;
        }

        return $response;
    }

    /**
     * Build the response object from the HTTP results
     *
     * @param \stdClass $response Standard object
     * @param string    $body     HTTP response contents
     *
     * @return \stdClass Populated class object
     */
    private function buildResponse($response, $body)
    {
        list($response->headers, $response->body) = explode("\r\n\r\n", $body, 2);
        $response->headers = explode("\r\n", $response->headers);
        list(, $response->code, $response->message) = explode(' ', $response->headers[0], 3);

        return $response;
    }
}