HttpLoader::applyCurlOptions() - Code Metrics - Inspection of "nonfuncitonal commit" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/EVO-8289_proxy_bundle_... ( 5c5976 )

by Bastian

created 2016-12-07 15:03 UTC

HttpLoader::applyCurlOptions() A

↳ Parent: HttpLoader

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	4
Ratio	44.44 %

Code Coverage

Tests	6
CRAP Score	2.0625

Importance

Changes

Metric	Value
dl	4
loc	9
ccs	6
cts	8
cp	0.75
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	1
crap	2.0625

<?php
/**
 * HttpLoader
 */

namespace Graviton\ProxyBundle\Definition\Loader;

use Graviton\ProxyBundle\Definition\ApiDefinition;
use Graviton\ProxyBundle\Definition\Loader\DispersalStrategy\DispersalStrategyInterface;
use Doctrine\Common\Cache\CacheProvider;
use Guzzle\Http\Client;
use Guzzle\Http\Message\RequestInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Validator\Constraints\Url;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * load a file over http and process the data
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class HttpLoader implements LoaderInterface
{
    /**
     * @var ValidatorInterface
     */
    private $validator;

    /**
     * @var Client
     */
    private $client;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var DispersalStrategyInterface
     */
    private $strategy;

    /**
     * doctrine cache
     *
     * @var CacheProvider
     */
    private $cache;

    /**
     * doctrine cache lifetime
     *
     * @var int
     */
    private $cacheLifetime;

    /**
     * @var array curl options to apply on each request
     */
    private $curlOptions = [];

    /**
     * @var array
     */
    private $options = [
        'storeKey' => 'httpLoader',
    ];

    /**
     * constructor
     *
     * @param ValidatorInterface $validator validator
     * @param Client             $client    http client
     * @param LoggerInterface    $logger    Logger
     */
    public function __construct(ValidatorInterface $validator, Client $client, LoggerInterface $logger)
    {
        $this->validator = $validator;
        $this->client = $client;
        $this->logger = $logger;
    }

    /**
     * @inheritDoc
     *
     * @param DispersalStrategyInterface $strategy dispersal strategy
     *
     * @return void
     */
    public function setDispersalStrategy(DispersalStrategyInterface $strategy)
    {
        $this->strategy = $strategy;
    }

    /**
     * @inheritDoc
     *
     * @param CacheProvider $cache          doctrine cache provider
     * @param string        $cacheNamespace cache namespace
     * @param int           $cacheLifetime  cache lifetime
     *
     * @return void
     */
    public function setCache(CacheProvider $cache, $cacheNamespace, $cacheLifetime)
    {
        $this->cache = $cache;
        $this->cache->setNamespace($cacheNamespace);
        $this->cacheLifetime = $cacheLifetime;
    }

    /**
     * set curl options
     *
     * @param array $curlOptions the curl options
     *
     * @return void
     */
    public function setCurlOptions(array $curlOptions)
    {
        $this->curlOptions = $curlOptions;
    }

    /**
     * @inheritDoc
     *
     * @param array $options cache strategy
     *
     * @return void
     */
    public function setOptions($options)
    {
        if (!empty($options['prefix'])) {
            $options['storeKey'] = $options['prefix'];
            unset($options['prefix']);
        }

        $this->options = array_merge($this->options, $options);
    }

    /**
     * check if the url is valid
     *
     * @param string $url url
     *
     * @return boolean
     */
    public function supports($url)
    {
        $error = $this->validator->validate($url, [new Url()]);

        return 0 === count($error);
    }

    /**
     * Applies the specified curl option on a request
     *
     * @param RequestInterface $request request
     *
     * @return void
     */
    protected function applyCurlOptions($request)
    {
        $curl = $request->getCurlOptions();
        foreach ($this->curlOptions as $option => $value) {

            $option = 'CURLOPT_'.strtoupper($option);
            $curl->set(constant($option), $value);
        }
        $curl->set(constant('CURLOPT_CAINFO'), __DIR__.'/../../Resources/cert/cacert.pem');
    }

    /**
     * @inheritDoc
     *
     * @param string $input url
     *
     * @return ApiDefinition
     */
    public function load($input)
    {
        $retVal = new ApiDefinition();
        if (isset($this->strategy)) {
            $request = $this->client->get($input);
            $this->applyCurlOptions($request);
            if (isset($this->cache) && $this->cache->contains($this->options['storeKey'])) {
                $content = $this->cache->fetch($this->options['storeKey']);

                if (empty($content)) {
                    $content = $this->fetchFile($request);
                }
            } else {
                //$content = $this->fetchFile($request);
                $content = file_get_contents('/Users/taafeba2/development/swisscom/graviton-api-zgkb-bap/vendor/graviton/graviton/app/cache/swagger.json');
            }

            // store current host (name or ip) serving the API. This MUST be the host only and does not include the
            // scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the
            // documentation is to be used (including the port)
            $fallbackHost = array();
            $fallbackHost['host'] = sprintf(
                '%s://%s:%d',
                $request->getScheme(),
                $request->getHost(),
                $request->getPort()
            );
            if ($this->strategy->supports($content)) {
                $retVal = $this->strategy->process($content, $fallbackHost);
            }
        }

        return $retVal;
    }

    /**
     * fetch file from remote destination
     *
     * @param RequestInterface $request request
     *
     * @return string
     */
    private function fetchFile(RequestInterface $request)
    {
        $content = "{}";
        try {
            $response = $request->send();
            $content = $response->getBody(true);
            if (isset($this->cache)) {
                $this->cache->save($this->options['storeKey'], $content, $this->cacheLifetime);
            }
        } catch (\Guzzle\Http\Exception\HttpException $e) {
            $this->logger->info(
                "Unable to fetch File!",
                [
                    "message" => $e->getMessage(),
                    "url" => $request->getUrl(),
                    "code" => (!empty($request->getResponse())? $request->getResponse()->getStatusCode() : 500)
                ]
            );
        }

        return $content;
    }
}


1			<?php
2			/**
3			* HttpLoader
4			*/
5
6			namespace Graviton\ProxyBundle\Definition\Loader;
7
8			use Graviton\ProxyBundle\Definition\ApiDefinition;
9			use Graviton\ProxyBundle\Definition\Loader\DispersalStrategy\DispersalStrategyInterface;
10			use Doctrine\Common\Cache\CacheProvider;
11			use Guzzle\Http\Client;
12			use Guzzle\Http\Message\RequestInterface;
13			use Psr\Log\LoggerInterface;
14			use Symfony\Component\HttpFoundation\Response;
15			use Symfony\Component\Validator\Constraints\Url;
16			use Symfony\Component\Validator\Validator\ValidatorInterface;
17
18			/**
19			* load a file over http and process the data
20			*
21			* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
22			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
23			* @link http://swisscom.ch
24			*/
25			class HttpLoader implements LoaderInterface
26			{
27			/**
28			* @var ValidatorInterface
29			*/
30			private $validator;
31
32			/**
33			* @var Client
34			*/
35			private $client;
36
37			/**
38			* @var LoggerInterface
39			*/
40			private $logger;
41
42			/**
43			* @var DispersalStrategyInterface
44			*/
45			private $strategy;
46
47			/**
48			* doctrine cache
49			*
50			* @var CacheProvider
51			*/
52			private $cache;
53
54			/**
55			* doctrine cache lifetime
56			*
57			* @var int
58			*/
59			private $cacheLifetime;
60
61			/**
62			* @var array curl options to apply on each request
63			*/
64			private $curlOptions = [];
65
66			/**
67			* @var array
68			*/
69			private $options = [
70			'storeKey' => 'httpLoader',
71			];
72
73			/**
74			* constructor
75			*
76			* @param ValidatorInterface $validator validator
77			* @param Client $client http client
78			* @param LoggerInterface $logger Logger
79			*/
80	8		public function __construct(ValidatorInterface $validator, Client $client, LoggerInterface $logger)
81			{
82	8		$this->validator = $validator;
83	8		$this->client = $client;
84	8		$this->logger = $logger;
85	8		}
86
87			/**
88			* @inheritDoc
89			*
90			* @param DispersalStrategyInterface $strategy dispersal strategy
91			*
92			* @return void
93			*/
94	6		public function setDispersalStrategy(DispersalStrategyInterface $strategy)
95			{
96	6		$this->strategy = $strategy;
97	6		}
98
99			/**
100			* @inheritDoc
101			*
102			* @param CacheProvider $cache doctrine cache provider
103			* @param string $cacheNamespace cache namespace
104			* @param int $cacheLifetime cache lifetime
105			*
106			* @return void
107			*/
108	2		public function setCache(CacheProvider $cache, $cacheNamespace, $cacheLifetime)
109			{
110	2		$this->cache = $cache;
111	2		$this->cache->setNamespace($cacheNamespace);
112	2		$this->cacheLifetime = $cacheLifetime;
113	2		}
114
115			/**
116			* set curl options
117			*
118			* @param array $curlOptions the curl options
119			*
120			* @return void
121			*/
122			public function setCurlOptions(array $curlOptions)
123			{
124			$this->curlOptions = $curlOptions;
125			}
126
127			/**
128			* @inheritDoc
129			*
130			* @param array $options cache strategy
131			*
132			* @return void
133			*/
134	2		public function setOptions($options)
135			{
136	2		if (!empty($options['prefix'])) {
137	2		$options['storeKey'] = $options['prefix'];
138	2		unset($options['prefix']);
139	1		}
140
141	2		$this->options = array_merge($this->options, $options);
142	2		}
143
144			/**
145			* check if the url is valid
146			*
147			* @param string $url url
148			*
149			* @return boolean
150			*/
151	2		public function supports($url)
152			{
153	2		$error = $this->validator->validate($url, [new Url()]);
154
155	2		return 0 === count($error);
156			}
157
158			/**
159			* Applies the specified curl option on a request
160			*
161			* @param RequestInterface $request request
162			*
163			* @return void
164			*/
165	6		protected function applyCurlOptions($request)
166			{
167	6		$curl = $request->getCurlOptions();
168	6	View Code Duplication	foreach ($this->curlOptions as $option => $value) {
			0 ignored issues – show Duplication introduced 2016-12-07 15:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
169			$option = 'CURLOPT_'.strtoupper($option);
170			$curl->set(constant($option), $value);
171	3		}
172	6		$curl->set(constant('CURLOPT_CAINFO'), __DIR__.'/../../Resources/cert/cacert.pem');
173	6		}
174
175			/**
176			* @inheritDoc
177			*
178			* @param string $input url
179			*
180			* @return ApiDefinition
181			*/
182	6		public function load($input)
183			{
184	6		$retVal = new ApiDefinition();
185	6		if (isset($this->strategy)) {
186	6		$request = $this->client->get($input);
187	6		$this->applyCurlOptions($request);
188	6		if (isset($this->cache) && $this->cache->contains($this->options['storeKey'])) {
189	2		$content = $this->cache->fetch($this->options['storeKey']);
190
191	2		if (empty($content)) {
192	1		$content = $this->fetchFile($request);
193			}
194	1		} else {
195			//$content = $this->fetchFile($request);
196	4		$content = file_get_contents('/Users/taafeba2/development/swisscom/graviton-api-zgkb-bap/vendor/graviton/graviton/app/cache/swagger.json');
197			}
198
199			// store current host (name or ip) serving the API. This MUST be the host only and does not include the
200			// scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the
201			// documentation is to be used (including the port)
202	6		$fallbackHost = array();
203	6		$fallbackHost['host'] = sprintf(
204	6		'%s://%s:%d',
205	6		$request->getScheme(),
206	6		$request->getHost(),
207	6		$request->getPort()
208	3		);
209	6		if ($this->strategy->supports($content)) {
210	4		$retVal = $this->strategy->process($content, $fallbackHost);
211	2		}
212	3		}
213
214	6		return $retVal;
215			}
216
217			/**
218			* fetch file from remote destination
219			*
220			* @param RequestInterface $request request
221			*
222			* @return string
223			*/
224			private function fetchFile(RequestInterface $request)
225			{
226			$content = "{}";
227			try {
228			$response = $request->send();
229			$content = $response->getBody(true);
230			if (isset($this->cache)) {
231			$this->cache->save($this->options['storeKey'], $content, $this->cacheLifetime);
232			}
233			} catch (\Guzzle\Http\Exception\HttpException $e) {
234			$this->logger->info(
235			"Unable to fetch File!",
236			[
237			"message" => $e->getMessage(),
238			"url" => $request->getUrl(),
239			"code" => (!empty($request->getResponse())? $request->getResponse()->getStatusCode() : 500)
240			]
241			);
242			}
243
244			return $content;
245			}
246			}
247

libgraviton / graviton

Push — feature/EVO-8289_proxy_bundle_... ( 5c5976 )

HttpLoader::applyCurlOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like