HttpTrait::doRequest() - Code Metrics - EvilFreelancer/pihole-api-php - Measure and Improve Code Quality continuously with Scrutinizer

HttpTrait::doRequest() A
last analyzed 2020-02-29 19:26 UTC

↳ Parent: HttpTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	0
cts	9
cp	0
rs	9.7666
c	0
b	0
f	0
cc	3
nc	3
nop	5
crap	12

<?php

namespace PiHole;

use ErrorException;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\ResponseInterface;
use PiHole\Exceptions\EmptyResults;

/**
 * @author  Paul Rock <[email protected]>
 * @link    https://drteam.rocks
 * @license MIT
 * @package PiHole
 */
trait HttpTrait
{
    /**
     * Initial state of some variables
     *
     * @var \GuzzleHttp\Client
     */
    private $client;

    /**
     * Object of main config
     *
     * @var \PiHole\Config
     */
    protected $config;

    /**
     * Request executor with timeout and repeat tries
     *
     * @param string     $type     Request method
     * @param array      $params   List of parameters
     * @param array|null $endpoint endpoint url
     * @param bool       $auth
     *
     * @return null|\Psr\Http\Message\ResponseInterface
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \ErrorException
     */
    private function repeatRequest(string $type, array $endpoint = null, array $params = null, bool $auth = false): ?ResponseInterface
    {
        $type = strtoupper($type);

        for ($i = 1; $i < $this->config->get('tries'); $i++) {

            if ($params === null) {
                // Execute the request to server
                $result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth));
            } else {
                // Execute the request to server
                $result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth), [RequestOptions::FORM_PARAMS => $params]);
            }

            // Check the code status
            $code   = $result->getStatusCode();
            $reason = $result->getReasonPhrase();

            // If success response from server
            if ($code === 200 || $code === 201) {
                return $result;
            }

            // If not "too many requests", then probably some bug on remote or our side
            if ($code !== 429) {
                throw new ErrorException($code . ' ' . $reason);
            }

            // Waiting in seconds
            sleep($this->config->get('seconds'));
        }

        // Return false if loop is done but no answer from server
        return null;
    }

    /**
     * Execute request and return response
     *
     * @return null|object Array with data or NULL if error
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \ErrorException
     * @throws \PiHole\Exceptions\EmptyResults
     */
    public function exec()
    {
        return $this->doRequest($this->type, $this->endpoint, $this->params, false, $this->auth);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Execute query and return RAW response from remote API
     *
     * @return null|\Psr\Http\Message\ResponseInterface RAW response or NULL if error
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \ErrorException
     * @throws \PiHole\Exceptions\EmptyResults
     */
    public function raw(): ?ResponseInterface
    {
        return $this->doRequest($this->type, $this->endpoint, $this->params, true, $this->auth);
    }

    /**
     * Make the request and analyze the result
     *
     * @param string $type     Request method
     * @param array  $endpoint Api request endpoint
     * @param array  $params   List of parameters
     * @param bool   $raw      Return data in raw format
     * @param bool   $auth
     *
     * @return null|object|ResponseInterface Array with data, RAW response or NULL if error
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \ErrorException
     * @throws \PiHole\Exceptions\EmptyResults
     */
    private function doRequest(string $type, array $endpoint = null, array $params = null, bool $raw = false, bool $auth = false)
    {
        // Null by default
        $response = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Execute the request to server
        $result = $this->repeatRequest($type, $endpoint, $params, $auth);

        if (null === $result) {
            throw new EmptyResults('Empty results returned from Pi-Hole API');
        }

        // Return RAW result if required
        return $raw ? $result : json_decode($result->getBody(), false);
    }

}


1			<?php
2
3			namespace PiHole;
4
5			use ErrorException;
6			use GuzzleHttp\RequestOptions;
7			use Psr\Http\Message\ResponseInterface;
8			use PiHole\Exceptions\EmptyResults;
9
10			/**
11			* @author Paul Rock <[email protected]>
12			* @link https://drteam.rocks
13			* @license MIT
14			* @package PiHole
15			*/
16			trait HttpTrait
17			{
18			/**
19			* Initial state of some variables
20			*
21			* @var \GuzzleHttp\Client
22			*/
23			private $client;
24
25			/**
26			* Object of main config
27			*
28			* @var \PiHole\Config
29			*/
30			protected $config;
31
32			/**
33			* Request executor with timeout and repeat tries
34			*
35			* @param string $type Request method
36			* @param array $params List of parameters
37			* @param array\|null $endpoint endpoint url
38			* @param bool $auth
39			*
40			* @return null\|\Psr\Http\Message\ResponseInterface
41			* @throws \GuzzleHttp\Exception\GuzzleException
42			* @throws \ErrorException
43			*/
44			private function repeatRequest(string $type, array $endpoint = null, array $params = null, bool $auth = false): ?ResponseInterface
45			{
46			$type = strtoupper($type);
47
48			for ($i = 1; $i < $this->config->get('tries'); $i++) {
49
50			if ($params === null) {
51			// Execute the request to server
52			$result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth));
53			} else {
54			// Execute the request to server
55			$result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth), [RequestOptions::FORM_PARAMS => $params]);
56			}
57
58			// Check the code status
59			$code = $result->getStatusCode();
60			$reason = $result->getReasonPhrase();
61
62			// If success response from server
63			if ($code === 200 \|\| $code === 201) {
64			return $result;
65			}
66
67			// If not "too many requests", then probably some bug on remote or our side
68			if ($code !== 429) {
69			throw new ErrorException($code . ' ' . $reason);
70			}
71
72			// Waiting in seconds
73			sleep($this->config->get('seconds'));
74			}
75
76			// Return false if loop is done but no answer from server
77			return null;
78			}
79
80			/**
81			* Execute request and return response
82			*
83			* @return null\|object Array with data or NULL if error
84			* @throws \GuzzleHttp\Exception\GuzzleException
85			* @throws \ErrorException
86			* @throws \PiHole\Exceptions\EmptyResults
87			*/
88			public function exec()
89			{
90			return $this->doRequest($this->type, $this->endpoint, $this->params, false, $this->auth);
			0 ignored issues – show Bug introduced 2019-10-23 21:35 UTC by Report Bug Copy Issue Report The property `type` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-10-23 21:35 UTC by Report Bug Copy Issue Report The property `endpoint` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-10-23 21:35 UTC by Report Bug Copy Issue Report The property `params` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-10-23 21:35 UTC by Report Bug Copy Issue Report The property `auth` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
91			}
92
93			/**
94			* Execute query and return RAW response from remote API
95			*
96			* @return null\|\Psr\Http\Message\ResponseInterface RAW response or NULL if error
97			* @throws \GuzzleHttp\Exception\GuzzleException
98			* @throws \ErrorException
99			* @throws \PiHole\Exceptions\EmptyResults
100			*/
101			public function raw(): ?ResponseInterface
102			{
103			return $this->doRequest($this->type, $this->endpoint, $this->params, true, $this->auth);
104			}
105
106			/**
107			* Make the request and analyze the result
108			*
109			* @param string $type Request method
110			* @param array $endpoint Api request endpoint
111			* @param array $params List of parameters
112			* @param bool $raw Return data in raw format
113			* @param bool $auth
114			*
115			* @return null\|object\|ResponseInterface Array with data, RAW response or NULL if error
116			* @throws \GuzzleHttp\Exception\GuzzleException
117			* @throws \ErrorException
118			* @throws \PiHole\Exceptions\EmptyResults
119			*/
120			private function doRequest(string $type, array $endpoint = null, array $params = null, bool $raw = false, bool $auth = false)
121			{
122			// Null by default
123			$response = null;
			0 ignored issues – show Unused Code introduced 2019-10-23 21:35 UTC by Report Bug Copy Issue Report `$response` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
124
125			// Execute the request to server
126			$result = $this->repeatRequest($type, $endpoint, $params, $auth);
127
128			if (null === $result) {
129			throw new EmptyResults('Empty results returned from Pi-Hole API');
130			}
131
132			// Return RAW result if required
133			return $raw ? $result : json_decode($result->getBody(), false);
134			}
135
136			}
137

EvilFreelancer / pihole-api-php

HttpTrait::doRequest() A last analyzed 2020-02-29 19:26 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

HttpTrait::doRequest() A
last analyzed 2020-02-29 19:26 UTC