Transport::findQuotes() - Code Metrics - Inspection of "Finish the period tracking." - jeancsil/flight-spy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a62229...4b3a11 )

by Jean

created 2017-01-14 17:53 UTC

Transport::findQuotes() A

↳ Parent: Transport

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	0
cts	3
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	2
crap	6

<?php
/**
 * @author Jean Silva <[email protected]>
 * @license MIT
 */
namespace Jeancsil\FlightSpy\Api\Http;

use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\BadResponseException;
use Jeancsil\FlightSpy\Api\DataTransfer\SessionParameters;
use Psr\Log\LoggerAwareTrait;

class Transport
{
    use LoggerAwareTrait;

    const LIVE_PRICING = '/apiservices/pricing/v1.0';

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

    /**
     * @var string
     */
    private $pollUrl;

    /**
     * @param ClientInterface $client
     */
    public function __construct(ClientInterface $client)
    {
        $this->client = $client;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * @param SessionParameters $parameters
     * @param bool $newSession
     * @return array
     */
    public function findQuotes(SessionParameters $parameters, $newSession)
    {
        if ($newSession) {
            $this->createSession($parameters);
        }

        return $this->poll();
    }

    /**
     * @param SessionParameters $parameters
     * @throws \Exception
     */
    private function createSession(SessionParameters $parameters)
    {
        try {
            $parametersArray = $parameters->toArray();

            $request = $this
                ->client
                ->post(static::LIVE_PRICING, ['form_params' => $parametersArray]);

            if (!isset($request->getHeaders()['Location'][0])) {
                throw new \Exception('Location not found for the poll');
            }

            $this->setPollUrl($request->getHeaders()['Location'][0], $parametersArray['apiKey']);
            sleep(1);
        } catch (BadResponseException $e) {
            $this->logger->error(
                sprintf(
                    "[Transport::createSession]\nStatusCode: %d\nBody: %s",
                    $e->getResponse()->getStatusCode(),
                    $e->getResponse()->getBody()
                )
            );

            throw $e;
        }
    }

    /**
     * @return array
     */
    private function poll()
    {
        try {
            $request = $this
                ->client
                ->get($this->pollUrl);

            return \GuzzleHttp\json_decode($request->getBody()->getContents());
        } catch (BadResponseException $e) {
            $this->logger->error(
                sprintf(
                    "[Transport::pool]\nStatusCode: %d\nBody: %s",
                    $e->getResponse()->getStatusCode(),
                    $e->getResponse()->getBody()
                )
            );
        }
    }

    /**
     * @param string $url
     * @param string $apiKey
     */
    private function setPollUrl($url, $apiKey)
    {
        $this->pollUrl = "$url?apiKey=$apiKey&sorttype=price&sortorder=desc";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        $this->logger->debug("Pool url is: $this->pollUrl");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }
}


1			<?php
2			/**
3			* @author Jean Silva <[email protected]>
4			* @license MIT
5			*/
6			namespace Jeancsil\FlightSpy\Api\Http;
7
8			use GuzzleHttp\ClientInterface;
9			use GuzzleHttp\Exception\BadResponseException;
10			use Jeancsil\FlightSpy\Api\DataTransfer\SessionParameters;
11			use Psr\Log\LoggerAwareTrait;
12
13			class Transport
14			{
15			use LoggerAwareTrait;
16
17			const LIVE_PRICING = '/apiservices/pricing/v1.0';
18
19			/**
20			* @var \GuzzleHttp\Client
21			*/
22			private $client;
23
24			/**
25			* @var string
26			*/
27			private $pollUrl;
28
29			/**
30			* @param ClientInterface $client
31			*/
32			public function __construct(ClientInterface $client)
33			{
34			$this->client = $client;
			0 ignored issues – show Documentation Bug introduced 2016-10-03 12:13 UTC by Report Bug Copy Issue Report `$client` is of type `object<GuzzleHttp\ClientInterface>`, but the property `$client` was declared to be of type `object<GuzzleHttp\Client>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` 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 given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
35			}
36
37			/**
38			* @param SessionParameters $parameters
39			* @param bool $newSession
40			* @return array
41			*/
42			public function findQuotes(SessionParameters $parameters, $newSession)
43			{
44			if ($newSession) {
45			$this->createSession($parameters);
46			}
47
48			return $this->poll();
49			}
50
51			/**
52			* @param SessionParameters $parameters
53			* @throws \Exception
54			*/
55			private function createSession(SessionParameters $parameters)
56			{
57			try {
58			$parametersArray = $parameters->toArray();
59
60			$request = $this
61			->client
62			->post(static::LIVE_PRICING, ['form_params' => $parametersArray]);
63
64			if (!isset($request->getHeaders()['Location'][0])) {
65			throw new \Exception('Location not found for the poll');
66			}
67
68			$this->setPollUrl($request->getHeaders()['Location'][0], $parametersArray['apiKey']);
69			sleep(1);
70			} catch (BadResponseException $e) {
71			$this->logger->error(
72			sprintf(
73			"[Transport::createSession]\nStatusCode: %d\nBody: %s",
74			$e->getResponse()->getStatusCode(),
75			$e->getResponse()->getBody()
76			)
77			);
78
79			throw $e;
80			}
81			}
82
83			/**
84			* @return array
85			*/
86			private function poll()
87			{
88			try {
89			$request = $this
90			->client
91			->get($this->pollUrl);
92
93			return \GuzzleHttp\json_decode($request->getBody()->getContents());
94			} catch (BadResponseException $e) {
95			$this->logger->error(
96			sprintf(
97			"[Transport::pool]\nStatusCode: %d\nBody: %s",
98			$e->getResponse()->getStatusCode(),
99			$e->getResponse()->getBody()
100			)
101			);
102			}
103			}
104
105			/**
106			* @param string $url
107			* @param string $apiKey
108			*/
109			private function setPollUrl($url, $apiKey)
110			{
111			$this->pollUrl = "$url?apiKey=$apiKey&sorttype=price&sortorder=desc";
			0 ignored issues – show Coding Style Best Practice introduced 2016-10-03 13:03 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$url` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history... Coding Style Best Practice introduced 2016-10-03 13:03 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$apiKey` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
112			$this->logger->debug("Pool url is: $this->pollUrl");
			0 ignored issues – show Coding Style Best Practice introduced 2017-01-14 17:55 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$this` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
113			}
114			}
115

jeancsil / flight-spy

Push — master ( a62229...4b3a11 )

Transport::findQuotes() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like