CelcatWebAPI::query() - Code Metrics - Inspection of "Extract client creation within query method of Cel..." - neilherbertuk/celcatwebapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d00643...6a07a3 )

by Neil

created 2018-11-23 15:46 UTC

CelcatWebAPI::query() B

↳ Parent: CelcatWebAPI

Complexity

Conditions	9
Paths	50

Size

Total Lines	51
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	32
dl	0
loc	51
rs	8.0555
c	0
b	0
f	0
cc	9
nc	50
nop	3

How to fix Long Method

<?php

namespace neilherbertuk\celcatwebapi;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use Illuminate\Config\Repository as Config;

use neilherbertuk\celcatwebapi\Classes\RequestBuilder;
use neilherbertuk\celcatwebapi\Classes\Log;
use neilherbertuk\celcatwebapi\Traits\ResourcesTrait;

class CelcatWebAPI
{
    use ResourcesTrait;

    /**
     * @var
     */
    private $config;

    /**
     * @var
     */
    public $logs;

    /**
     * CelcatWebAPI constructor.
     * @param $config
     */
    public function __construct(Config $config)
    {
        $this->setConfiguration($config);
    }

    /**
     * @param Config $config
     */
    private function setConfiguration(Config $config)
    {
        if ($config->has('celcat')) {
            $this->config['ServerAddress'] = $config->get('celcat.ServerAddress');
            $this->config['APICode'] = $config->get('celcat.APICode') ?: $this->throwRunTimeException('No API Code Provided');
            $this->config['VerifySSL'] = $config->get('celcat.VerifySSL');
            $this->config['PEM'] = $config->get('celcat.PEM');
            $this->config['DEBUG'] = $config->get('celcat.DEBUG') ?: false;
            $this->config['PROXY'] = $config->get('celcat.PROXY') ?: null;
        } else {
            $this->throwRunTimeException('No config found');
        }
    }

    /**
     * @param $exceptionMessage
     */
    private function throwRunTimeException($exceptionMessage)
    {
        throw new \RuntimeException($exceptionMessage);
    }

    /**
     * Perform an API Query from the Celcat Web API
     *
     * @param $name
     * @param string $requestMethod
     * @param array $parameters
     * @return mixed
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    private function query($name, $requestMethod = 'GET', $parameters = [])
    {
        $this->log()->info("Starting to perform query - resource: {$name} method: {$requestMethod}".(empty($parameters ?: " parameters: ".implode($parameters))));

        $client = $this->buildClient();
        $options = $this->buildRequest($requestMethod)->options($parameters);
        $url = $this->buildRequest()->URL($name);

        try {
            $request = $client->request($requestMethod, $url, $options);
            $header = $request->getHeaders();
            if ($request->getStatusCode() >= 200 and $request->getStatusCode() <= 299) {

                $this->log()->info('Received '.$request->getStatusCode());

                // Build object to return
                $result = [];

                // Include pagination details
                if ($header['Pagination'] !== null) {
                    $result['pagination'] = json_decode($header['Pagination'][0], true);
                }

                if (!empty($parameters)) {
                    $result['parameters'] = $parameters;
                }
                $result['data'] = json_decode($request->getBody()->getContents(), true);

                return $result;
            } else {
                // TODO - Error Handling
                $this->log()->error('An error occurred, received a '.$request->getStatusCode());
                $this->log()->transferLogs();
                $this->throwRunTimeException('An error occurred, received a '.$request->getStatusCode());
                return null;
            }
        }
        catch (\Exception $exception) {
            if ($exception instanceof ClientException) {
                if ($exception->getCode() == 404) {
                    $this->log()->info('Received '.$exception->getCode());
                    $result['error']['code'] = 404;
                    $result['error']['message'] = "No Results Found";
                    return $result;
                }
            }
            // TODO - Error Handling
            $this->log()->error('An error occurred, received a '.$exception->getCode().' '.$exception->getMessage());
            $this->log()->transferLogs();
            $this->throwRunTimeException('An error occurred, received a '.$exception->getCode());
            return null;
        }
    }

    /**
     * Build HTTP Client and add proxy config if required
     *
     * @return Client
     */
    private function buildClient()
    {
        if ($this->config['PROXY']) {
            $client = new Client(['proxy' => $this->config['PROXY']]);
            if (!empty($this->config['PROXY']['no'])) {
                putenv('no_proxy=' . implode(' ,', $this->config['PROXY']['no']));
            }

            return $client;
        }
        return new Client();
    }

    /**
     * Returns RequestBuilder instance - used to build an api request
     *
     * @param string $requestMethod
     * @return RequestBuilder
     */
    private function buildRequest($requestMethod = 'GET') {
        return new RequestBuilder($requestMethod, $this->config);
    }

    /**
     * Performs a get request to the Celcat Web API
     *
     * @param $name
     * @param array $parameters
     * @return mixed
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function get($name, $parameters = [])
    {
        return $this->query($name, 'GET', $parameters);
    }

    /**
     * Returns a log instance
     *
     * @return Log
     */
    public function log() {
        return new Log($this);
    }

}

1			<?php
2
3			namespace neilherbertuk\celcatwebapi;
4
5			use GuzzleHttp\Client;
6			use GuzzleHttp\Exception\ClientException;
7			use Illuminate\Config\Repository as Config;
8
9			use neilherbertuk\celcatwebapi\Classes\RequestBuilder;
10			use neilherbertuk\celcatwebapi\Classes\Log;
11			use neilherbertuk\celcatwebapi\Traits\ResourcesTrait;
12
13			class CelcatWebAPI
14			{
15			use ResourcesTrait;
16
17			/**
18			* @var
19			*/
20			private $config;
21
22			/**
23			* @var
24			*/
25			public $logs;
26
27			/**
28			* CelcatWebAPI constructor.
29			* @param $config
30			*/
31			public function __construct(Config $config)
32			{
33			$this->setConfiguration($config);
34			}
35
36			/**
37			* @param Config $config
38			*/
39			private function setConfiguration(Config $config)
40			{
41			if ($config->has('celcat')) {
42			$this->config['ServerAddress'] = $config->get('celcat.ServerAddress');
43			$this->config['APICode'] = $config->get('celcat.APICode') ?: $this->throwRunTimeException('No API Code Provided');
44			$this->config['VerifySSL'] = $config->get('celcat.VerifySSL');
45			$this->config['PEM'] = $config->get('celcat.PEM');
46			$this->config['DEBUG'] = $config->get('celcat.DEBUG') ?: false;
47			$this->config['PROXY'] = $config->get('celcat.PROXY') ?: null;
48			} else {
49			$this->throwRunTimeException('No config found');
50			}
51			}
52
53			/**
54			* @param $exceptionMessage
55			*/
56			private function throwRunTimeException($exceptionMessage)
57			{
58			throw new \RuntimeException($exceptionMessage);
59			}
60
61			/**
62			* Perform an API Query from the Celcat Web API
63			*
64			* @param $name
65			* @param string $requestMethod
66			* @param array $parameters
67			* @return mixed
68			* @throws \GuzzleHttp\Exception\GuzzleException
69			*/
70			private function query($name, $requestMethod = 'GET', $parameters = [])
71			{
72			$this->log()->info("Starting to perform query - resource: {$name} method: {$requestMethod}".(empty($parameters ?: " parameters: ".implode($parameters))));
73
74			$client = $this->buildClient();
75			$options = $this->buildRequest($requestMethod)->options($parameters);
76			$url = $this->buildRequest()->URL($name);
77
78			try {
79			$request = $client->request($requestMethod, $url, $options);
80			$header = $request->getHeaders();
81			if ($request->getStatusCode() >= 200 and $request->getStatusCode() <= 299) {
82
83			$this->log()->info('Received '.$request->getStatusCode());
84
85			// Build object to return
86			$result = [];
87
88			// Include pagination details
89			if ($header['Pagination'] !== null) {
90			$result['pagination'] = json_decode($header['Pagination'][0], true);
91			}
92
93			if (!empty($parameters)) {
94			$result['parameters'] = $parameters;
95			}
96			$result['data'] = json_decode($request->getBody()->getContents(), true);
97
98			return $result;
99			} else {
100			// TODO - Error Handling
101			$this->log()->error('An error occurred, received a '.$request->getStatusCode());
102			$this->log()->transferLogs();
103			$this->throwRunTimeException('An error occurred, received a '.$request->getStatusCode());
104			return null;
105			}
106			}
107			catch (\Exception $exception) {
108			if ($exception instanceof ClientException) {
109			if ($exception->getCode() == 404) {
110			$this->log()->info('Received '.$exception->getCode());
111			$result['error']['code'] = 404;
112			$result['error']['message'] = "No Results Found";
113			return $result;
114			}
115			}
116			// TODO - Error Handling
117			$this->log()->error('An error occurred, received a '.$exception->getCode().' '.$exception->getMessage());
118			$this->log()->transferLogs();
119			$this->throwRunTimeException('An error occurred, received a '.$exception->getCode());
120			return null;
121			}
122			}
123
124			/**
125			* Build HTTP Client and add proxy config if required
126			*
127			* @return Client
128			*/
129			private function buildClient()
130			{
131			if ($this->config['PROXY']) {
132			$client = new Client(['proxy' => $this->config['PROXY']]);
133			if (!empty($this->config['PROXY']['no'])) {
134			putenv('no_proxy=' . implode(' ,', $this->config['PROXY']['no']));
135			}
136
137			return $client;
138			}
139			return new Client();
140			}
141
142			/**
143			* Returns RequestBuilder instance - used to build an api request
144			*
145			* @param string $requestMethod
146			* @return RequestBuilder
147			*/
148			private function buildRequest($requestMethod = 'GET') {
149			return new RequestBuilder($requestMethod, $this->config);
150			}
151
152			/**
153			* Performs a get request to the Celcat Web API
154			*
155			* @param $name
156			* @param array $parameters
157			* @return mixed
158			* @throws \GuzzleHttp\Exception\GuzzleException
159			*/
160			public function get($name, $parameters = [])
161			{
162			return $this->query($name, 'GET', $parameters);
163			}
164
165			/**
166			* Returns a log instance
167			*
168			* @return Log
169			*/
170			public function log() {
171			return new Log($this);
172			}
173
174			}

neilherbertuk / celcatwebapi

Push — master ( d00643...6a07a3 )

CelcatWebAPI::query() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like