HttpTrait::exec() - Code Metrics - Inspection of "naming fix" - EvilFreelancer/rezdy-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9cfcfd...a0da2a )

by Mr

created 2019-10-17 05:17 UTC

HttpTrait::exec() A

↳ Parent: HttpTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace Rezdy;

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

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

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

    /**
     * Request executor with timeout and repeat tries
     *
     * @param string $type   Request method
     * @param string $url    endpoint url
     * @param mixed  $params List of parameters
     *
     * @return null|\Psr\Http\Message\ResponseInterface
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \ErrorException
     */
    private function repeatRequest($type, $url, $params): ?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->get('base_uri') . $url);
            } else {
                // Execute the request to server
                $result = $this->client->request($type, $this->config->get('base_uri') . $url, [RequestOptions::FORM_PARAMS => $params->toArray()]);
            }

            // 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 \Rezdy\Exceptions\EmptyResults
     */
    public function exec()
    {
        return $this->doRequest($this->type, $this->endpoint, $this->params);
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 \Rezdy\Exceptions\EmptyResults
     */
    public function raw(): ?ResponseInterface
    {
        return $this->doRequest($this->type, $this->endpoint, $this->params, true);
    }

    /**
     * Make the request and analyze the result
     *
     * @param string $type     Request method
     * @param string $endpoint Api request endpoint
     * @param mixed  $params   List of parameters
     * @param bool   $raw      Return data in raw format
     *
     * @return null|object|ResponseInterface Array with data, RAW response or NULL if error
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \ErrorException
     * @throws \Rezdy\Exceptions\EmptyResults
     */
    private function doRequest($type, $endpoint, $params = null, bool $raw = 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);

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

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

}


1			<?php
2
3			namespace Rezdy;
4
5			use ErrorException;
6			use GuzzleHttp\RequestOptions;
7			use Psr\Http\Message\ResponseInterface;
8			use Rezdy\Exceptions\EmptyResults;
9
10			/**
11			* @author Paul Rock <[email protected]>
12			* @link https://drteam.rocks
13			* @license MIT
14			* @package Rezdy
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 \Rezdy\Config
29			*/
30			protected $config;
31
32			/**
33			* Request executor with timeout and repeat tries
34			*
35			* @param string $type Request method
36			* @param string $url endpoint url
37			* @param mixed $params List of parameters
38			*
39			* @return null\|\Psr\Http\Message\ResponseInterface
40			* @throws \GuzzleHttp\Exception\GuzzleException
41			* @throws \ErrorException
42			*/
43			private function repeatRequest($type, $url, $params): ?ResponseInterface
44			{
45			$type = strtoupper($type);
46
47			for ($i = 1; $i < $this->config->get('tries'); $i++) {
48
49			if ($params === null) {
50			// Execute the request to server
51			$result = $this->client->request($type, $this->config->get('base_uri') . $url);
52			} else {
53			// Execute the request to server
54			$result = $this->client->request($type, $this->config->get('base_uri') . $url, [RequestOptions::FORM_PARAMS => $params->toArray()]);
55			}
56
57			// Check the code status
58			$code = $result->getStatusCode();
59			$reason = $result->getReasonPhrase();
60
61			// If success response from server
62			if ($code === 200 \|\| $code === 201) {
63			return $result;
64			}
65
66			// If not "too many requests", then probably some bug on remote or our side
67			if ($code !== 429) {
68			throw new ErrorException($code . ' ' . $reason);
69			}
70
71			// Waiting in seconds
72			sleep($this->config->get('seconds'));
73			}
74
75			// Return false if loop is done but no answer from server
76			return null;
77			}
78
79			/**
80			* Execute request and return response
81			*
82			* @return null\|object Array with data or NULL if error
83			* @throws \GuzzleHttp\Exception\GuzzleException
84			* @throws \ErrorException
85			* @throws \Rezdy\Exceptions\EmptyResults
86			*/
87			public function exec()
88			{
89			return $this->doRequest($this->type, $this->endpoint, $this->params);
			0 ignored issues – show Bug introduced 2019-10-16 15:08 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-16 15:08 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-16 15:08 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...
90			}
91
92			/**
93			* Execute query and return RAW response from remote API
94			*
95			* @return null\|\Psr\Http\Message\ResponseInterface RAW response or NULL if error
96			* @throws \GuzzleHttp\Exception\GuzzleException
97			* @throws \ErrorException
98			* @throws \Rezdy\Exceptions\EmptyResults
99			*/
100			public function raw(): ?ResponseInterface
101			{
102			return $this->doRequest($this->type, $this->endpoint, $this->params, true);
103			}
104
105			/**
106			* Make the request and analyze the result
107			*
108			* @param string $type Request method
109			* @param string $endpoint Api request endpoint
110			* @param mixed $params List of parameters
111			* @param bool $raw Return data in raw format
112			*
113			* @return null\|object\|ResponseInterface Array with data, RAW response or NULL if error
114			* @throws \GuzzleHttp\Exception\GuzzleException
115			* @throws \ErrorException
116			* @throws \Rezdy\Exceptions\EmptyResults
117			*/
118			private function doRequest($type, $endpoint, $params = null, bool $raw = false)
119			{
120			// Null by default
121			$response = null;
			0 ignored issues – show Unused Code introduced 2019-10-16 15:08 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...
122
123			// Execute the request to server
124			$result = $this->repeatRequest($type, $endpoint, $params);
125
126			if (null === $result) {
127			throw new EmptyResults('Empty results returned from Rezdy API');
128			}
129
130			// Return RAW result if required
131			return $raw ? $result : json_decode($result->getBody(), false);
132			}
133
134			}
135

EvilFreelancer / rezdy-api-php

Push — master ( 9cfcfd...a0da2a )

HttpTrait::exec() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like