FactomConnector::callEndpoint() - Code Metrics - Inspection of "guzzle it up" - adrianmejias/factom-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 78a457...8e39f9 )

by Adrian

created 2017-09-21 22:33 UTC

FactomConnector::callEndpoint() C

↳ Parent: FactomConnector

Complexity

Conditions	10
Paths	25

Size

Total Lines	78
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	78
rs	5.6321
c	0
b	0
f	0
cc	10
eloc	37
nc	25
nop	4

How to fix Long Method Complexity

<?php

namespace AdrianMejias\FactomApi;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\Request;

use AdrianMejias\FactomApi\Exceptions\InvalidFactomApiConfig;

class FactomConnector
{
    /**
     * The JSON RPC spec that the API uses.
     *
     * @var string
     */
    const JSON_RPC = '2.0';
    
    /**
     * The "ID" param provided in all requests to the API.
     *
     * @var integer
     */
    const REQUEST_ID = 0;

    /**
     * The header content type in all requests to the API.
     *
     * @var string
     */
    const HEADER_CONTENT_TYPE = 'text/plain';
    
    /**
     * The header accept in all requests to the API.
     *
     * @var string
     */
    const HEADER_ACCEPT = 'application/json';
    
    /**
     * The generic error if cannot load server properly.
     *
     * @var string
     */
    const BLANK_PAGE_ERROR = 'Page not found';

    /**
     * The client instance.
     *
     * @var null|GuzzleHttp\Client
     */
    protected $client = null;

    /**
     * The URL for all API requests.
     *
     * @var null|string
     */
    protected $url = 'http://localhost:8088/v2';

    /**
     * Make secure URL requests.
     *
     * @var null|bool
     */
    protected $ssl = false;

    /**
     * Path to the certificate file for using factomd over TLS.
     *
     * @var null
     */
    protected $certifcate = null;

    /**
     * The provided username for interacting with factomd
     * Optional.
     *
     * @var null
     */
    protected $username = null;

    /**
     * The provided password for interacting with factomd
     * Optional.
     *
     * @var null
     */
    protected $password = null;

    public function __construct(string $url, bool $ssl = false, string $certificate = null, string $username = null, string $password = null)
    {
        $this->url = $url;
        $this->ssl = $ssl;
        $this->certificate = $certificate;

        $this->username = $username;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->password = $password;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        if (! function_exists('curl_init')) {
            throw InvalidFactomApiConfig::noCurlFound();
        } elseif (empty($this->url)) {
            throw InvalidFactomApiConfig::noUrlDefined();
        } elseif (empty($this->certificate) && $this->ssl) {

            throw InvalidFactomApiConfig::noCertificateDefined();
        } elseif (! empty($this->certificate) && $this->ssl) {

            if (preg_match('/^(https:\/\/)/i', $this->url)) {
                throw InvalidFactomApiConfig::noSecureUrlDefined();
            } elseif (! file_exists($this->certificate)) {

                throw InvalidFactomApiConfig::noCertificateExists();
            }
        } elseif (! empty($this->username) && empty($this->password)) {
            throw InvalidFactomApiConfig::noUsernameDefined();
        } elseif (empty($this->username) && ! empty($this->password)) {
            throw InvalidFactomApiConfig::noPasswordDefined();
        }

        if (! $this->ssl) {
            $this->certificate = null;

        }

        $this->client = new Client([

            'base_uri' => rtrim($this->url, '/').'/',
            'timeout' => 10,
            'http_errors' => false,
            'debug' => false,
        ]);
    }

    /**
     * Call the requested endpoint.
     *
     * @param string $actionName
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array $params
     * @param array $extraOptions
     *
     * @return object|string
     *
     * @throws Exception When a Guzzle error occurs
     */
    public function callEndpoint(string $action, string $method, array $params = [], array $extraOptions = [])
    {
        // Check our method...
        if (! in_array(strtoupper($method), ['GET', 'POST'])) {
            throw InvalidFactomApiConfig::invalidMethodCalled();
        }

        $options = [
            'headers' => [
                'Content-Type' => self::HEADER_CONTENT_TYPE,
                'Accept' => self::HEADER_ACCEPT,
            ],
            // 'verify' => false,

            'json' => [
                'jsonrpc' => self::JSON_RPC,
                'id' => self::REQUEST_ID,
                'method' => strtolower($action),
                'params' => $params,
            ],
        ] + $extraOptions;

        // Append certificate verification
        // if ($this->ssl) {

            // $options['verify'] = $this->certificate;

            // $options['cert'] = [

            //     'cert' => [

            //         $this->certificate,
            //         $this->password
            //     ],
            // ];
        // }

        // Append authentication to params
        if (! empty($this->username) && ! empty($this->password)) {
            $options['auth'] = [
                'username' => $this->username,
                'password' => $this->password,
            ];
        }

        $response = null;
        $error = null;

        // Make the call to factom server
        try {
            $response = $this->client->{strtolower($method)}($this->url, $options);
        } catch(RequestException $e) {
            $error = $e->getMessage();
        }

        if (!empty($error)) {
            throw InvalidFactomApiConfig::invalidApiResponse($error, $action);
        }

        $status_code = $response->getStatusCode();
        $reason_phrase = $response->getReasonPhrase();
        $body = (string) $response->getBody()->getContents();

        // Check for empty body
        if (empty($body)) {
            throw InvalidFactomApiConfig::emptyApiResponse($action);
        } elseif ($status_code != 200) {
            throw InvalidFactomApiConfig::invalidApiResponse($reason_phrase, $action);
        }

        // return Json
        if ($json_body = json_decode($body)) {
            // Check for empty result
            if (empty($json_body->result)) {
                throw InvalidFactomApiConfig::emptyApiResponse($action);
            }

            return $json_body->result;
        }

        // return Response
        return $body;
    }
}


1			<?php
2
3			namespace AdrianMejias\FactomApi;
4
5			use GuzzleHttp\Client;
6			use GuzzleHttp\Exception\RequestException;
7			use GuzzleHttp\Psr7\Request;
8
9			use AdrianMejias\FactomApi\Exceptions\InvalidFactomApiConfig;
10
11			class FactomConnector
12			{
13			/**
14			* The JSON RPC spec that the API uses.
15			*
16			* @var string
17			*/
18			const JSON_RPC = '2.0';
19
20			/**
21			* The "ID" param provided in all requests to the API.
22			*
23			* @var integer
24			*/
25			const REQUEST_ID = 0;
26
27			/**
28			* The header content type in all requests to the API.
29			*
30			* @var string
31			*/
32			const HEADER_CONTENT_TYPE = 'text/plain';
33
34			/**
35			* The header accept in all requests to the API.
36			*
37			* @var string
38			*/
39			const HEADER_ACCEPT = 'application/json';
40
41			/**
42			* The generic error if cannot load server properly.
43			*
44			* @var string
45			*/
46			const BLANK_PAGE_ERROR = 'Page not found';
47
48			/**
49			* The client instance.
50			*
51			* @var null\|GuzzleHttp\Client
52			*/
53			protected $client = null;
54
55			/**
56			* The URL for all API requests.
57			*
58			* @var null\|string
59			*/
60			protected $url = 'http://localhost:8088/v2';
61
62			/**
63			* Make secure URL requests.
64			*
65			* @var null\|bool
66			*/
67			protected $ssl = false;
68
69			/**
70			* Path to the certificate file for using factomd over TLS.
71			*
72			* @var null
73			*/
74			protected $certifcate = null;
75
76			/**
77			* The provided username for interacting with factomd
78			* Optional.
79			*
80			* @var null
81			*/
82			protected $username = null;
83
84			/**
85			* The provided password for interacting with factomd
86			* Optional.
87			*
88			* @var null
89			*/
90			protected $password = null;
91
92			public function __construct(string $url, bool $ssl = false, string $certificate = null, string $username = null, string $password = null)
93			{
94			$this->url = $url;
95			$this->ssl = $ssl;
96			$this->certificate = $certificate;
			0 ignored issues – show Bug introduced 2017-09-20 17:59 UTC by Report Bug Copy Issue Report The property `certificate` does not seem to exist. Did you mean `certifcate`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
97			$this->username = $username;
			0 ignored issues – show Documentation Bug introduced 2017-09-20 17:59 UTC by Report Bug Copy Issue Report It seems like `$username` can also be of type `string`. However, the property `$username` is declared as type `null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
98			$this->password = $password;
			0 ignored issues – show Documentation Bug introduced 2017-09-20 17:59 UTC by Report Bug Copy Issue Report It seems like `$password` can also be of type `string`. However, the property `$password` is declared as type `null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
99
100			if (! function_exists('curl_init')) {
101			throw InvalidFactomApiConfig::noCurlFound();
102			} elseif (empty($this->url)) {
103			throw InvalidFactomApiConfig::noUrlDefined();
104			} elseif (empty($this->certificate) && $this->ssl) {
			0 ignored issues – show Bug introduced 2017-09-20 17:59 UTC by Report Bug Copy Issue Report The property `certificate` does not seem to exist. Did you mean `certifcate`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
105			throw InvalidFactomApiConfig::noCertificateDefined();
106			} elseif (! empty($this->certificate) && $this->ssl) {
			0 ignored issues – show Bug introduced 2017-09-20 17:59 UTC by Report Bug Copy Issue Report The property `certificate` does not seem to exist. Did you mean `certifcate`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
107			if (preg_match('/^(https:\/\/)/i', $this->url)) {
108			throw InvalidFactomApiConfig::noSecureUrlDefined();
109			} elseif (! file_exists($this->certificate)) {
			0 ignored issues – show Bug introduced 2017-09-20 17:59 UTC by Report Bug Copy Issue Report The property `certificate` does not seem to exist. Did you mean `certifcate`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
110			throw InvalidFactomApiConfig::noCertificateExists();
111			}
112			} elseif (! empty($this->username) && empty($this->password)) {
113			throw InvalidFactomApiConfig::noUsernameDefined();
114			} elseif (empty($this->username) && ! empty($this->password)) {
115			throw InvalidFactomApiConfig::noPasswordDefined();
116			}
117
118			if (! $this->ssl) {
119			$this->certificate = null;
			0 ignored issues – show Bug introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report The property `certificate` does not seem to exist. Did you mean `certifcate`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
120			}
121
122			$this->client = new Client([
			0 ignored issues – show Documentation Bug introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report It seems like `new \GuzzleHttp\Client(a...lse, 'debug' => false))` of type `object<GuzzleHttp\Client>` is incompatible with the declared type `null\|object<AdrianMejias...mApi\GuzzleHttp\Client>` of property `$client`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
123			'base_uri' => rtrim($this->url, '/').'/',
124			'timeout' => 10,
125			'http_errors' => false,
126			'debug' => false,
127			]);
128			}
129
130			/**
131			* Call the requested endpoint.
132			*
133			* @param string $actionName
			0 ignored issues – show Documentation introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report There is no parameter named `$actionName`. Did you maybe mean `$action`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
134			* @param array $params
135			* @param array $extraOptions
136			*
137			* @return object\|string
138			*
139			* @throws Exception When a Guzzle error occurs
140			*/
141			public function callEndpoint(string $action, string $method, array $params = [], array $extraOptions = [])
142			{
143			// Check our method...
144			if (! in_array(strtoupper($method), ['GET', 'POST'])) {
145			throw InvalidFactomApiConfig::invalidMethodCalled();
146			}
147
148			$options = [
149			'headers' => [
150			'Content-Type' => self::HEADER_CONTENT_TYPE,
151			'Accept' => self::HEADER_ACCEPT,
152			],
153			// 'verify' => false,
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
154			'json' => [
155			'jsonrpc' => self::JSON_RPC,
156			'id' => self::REQUEST_ID,
157			'method' => strtolower($action),
158			'params' => $params,
159			],
160			] + $extraOptions;
161
162			// Append certificate verification
163			// if ($this->ssl) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
164			// $options['verify'] = $this->certificate;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
165			// $options['cert'] = [
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
166			// 'cert' => [
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-21 22:36 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
167			// $this->certificate,
168			// $this->password
169			// ],
170			// ];
171			// }
172
173			// Append authentication to params
174			if (! empty($this->username) && ! empty($this->password)) {
175			$options['auth'] = [
176			'username' => $this->username,
177			'password' => $this->password,
178			];
179			}
180
181			$response = null;
182			$error = null;
183
184			// Make the call to factom server
185			try {
186			$response = $this->client->{strtolower($method)}($this->url, $options);
187			} catch(RequestException $e) {
188			$error = $e->getMessage();
189			}
190
191			if (!empty($error)) {
192			throw InvalidFactomApiConfig::invalidApiResponse($error, $action);
193			}
194
195			$status_code = $response->getStatusCode();
196			$reason_phrase = $response->getReasonPhrase();
197			$body = (string) $response->getBody()->getContents();
198
199			// Check for empty body
200			if (empty($body)) {
201			throw InvalidFactomApiConfig::emptyApiResponse($action);
202			} elseif ($status_code != 200) {
203			throw InvalidFactomApiConfig::invalidApiResponse($reason_phrase, $action);
204			}
205
206			// return Json
207			if ($json_body = json_decode($body)) {
208			// Check for empty result
209			if (empty($json_body->result)) {
210			throw InvalidFactomApiConfig::emptyApiResponse($action);
211			}
212
213			return $json_body->result;
214			}
215
216			// return Response
217			return $body;
218			}
219			}
220

adrianmejias / factom-api

Push — master ( 78a457...8e39f9 )

FactomConnector::callEndpoint() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like