AbstractDistanceMatrixQuery::setLanguage() - Code Metrics - Inspection of "Generalized language support across provider and f..." - DamienHarper/NavigationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4b5c0b...5361e0 )

by Damien

created 2019-08-14 12:36 UTC

AbstractDistanceMatrixQuery::setLanguage() A

↳ Parent: AbstractDistanceMatrixQuery

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
rs	10
c	0
b	0
f	0

<?php

namespace DH\NavigationBundle\Contract\DistanceMatrix;

use DH\NavigationBundle\Exception\DestinationException;
use DH\NavigationBundle\Exception\OriginException;
use DH\NavigationBundle\Exception\ResponseException;
use DH\NavigationBundle\Provider\ProviderInterface;
use Psr\Http\Message\ResponseInterface;

abstract class AbstractDistanceMatrixQuery implements DistanceMatrixQueryInterface
{
    /**
     * @var ProviderInterface
     */
    private $provider;

    /**
     * @var array
     */
    protected $origins;

    /**
     * @var array
     */
    protected $destinations;

    /**
     * @var \DateTime
     */
    private $departure_time;

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

    /**
     * DistanceMatrixQuery constructor.
     *
     * @param ProviderInterface $provider
     */
    public function __construct(ProviderInterface $provider)
    {
        $this->provider = $provider;
    }

    public function getProvider(): ProviderInterface
    {
        return $this->provider;
    }

    /**
     * @return ?\DateTime
     */
    public function getDepartureTime(): ?\DateTime
    {
        return $this->departure_time;
    }

    /**
     * @param \DateTime $departureTime
     *
     * @return DistanceMatrixQueryInterface
     */
    public function setDepartureTime(\DateTime $departureTime): DistanceMatrixQueryInterface
    {
        $this->departure_time = $departureTime;

        return $this;
    }

    /**
     * @param string $origin
     *
     * @return DistanceMatrixQueryInterface
     */
    public function addOrigin($origin): DistanceMatrixQueryInterface
    {
        $this->origins[] = $origin;

        return $this;
    }

    /**
     * @return ?array
     */
    public function getOrigins(): ?array
    {
        return $this->origins;
    }

    /**
     * @param string $destination
     *
     * @return DistanceMatrixQueryInterface
     */
    public function addDestination($destination): DistanceMatrixQueryInterface
    {
        $this->destinations[] = $destination;

        return $this;
    }

    /**
     * @return ?array
     */
    public function getDestinations(): ?array
    {
        return $this->destinations;
    }

    /**
     * @param string $language
     *
     * @return DistanceMatrixQueryInterface
     */
    public function setLanguage(string $language): DistanceMatrixQueryInterface
    {
        $this->language = $language;

        return $this;
    }

    /**
     * @return string
     */
    public function getLanguage(): string
    {
        return $this->language ?? 'en-US';
    }

    /**
     * @throws DestinationException
     * @throws OriginException
     * @throws ResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return DistanceMatrixResponseInterface
     */
    public function execute(): DistanceMatrixResponseInterface
    {
        $this->validateRequest();
        $request = $this->buildRequest();
        $rawResponse = $this->request('GET', $request);
        $response = $this->buildResponse($rawResponse);
        $this->validateResponse($response);

        return $response;
    }

    /**
     * @return string
     */
    abstract protected function buildRequest(): string;

    /**
     * @param ResponseInterface $response
     *
     * @return DistanceMatrixResponseInterface
     */
    abstract protected function buildResponse(ResponseInterface $response): DistanceMatrixResponseInterface;

    /**
     * @param string $method
     * @param string $url
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return ResponseInterface
     */
    private function request(string $method, string $url): ResponseInterface
    {
        $client = $this->getProvider()->getClient();
        $response = $client->request($method, $url);

        if (200 !== $response->getStatusCode()) {
            throw new \Exception('Response with status code '.$response->getStatusCode());
        }

        return $response;
    }

    /**
     * @param DistanceMatrixResponseInterface $response
     *
     * @throws ResponseException
     */
    private function validateResponse(DistanceMatrixResponseInterface $response): void
    {
        switch ($response->getStatus()) {
            case DistanceMatrixResponseInterface::RESPONSE_STATUS_OK:
                break;
            case DistanceMatrixResponseInterface::RESPONSE_STATUS_INVALID_REQUEST:
                throw new ResponseException('Invalid request.', 1);

                break;
            case DistanceMatrixResponseInterface::RESPONSE_STATUS_MAX_ELEMENTS_EXCEEDED:
                throw new ResponseException('The product of the origin and destination exceeds the limit per request.', 2);

                break;
            case DistanceMatrixResponseInterface::RESPONSE_STATUS_OVER_QUERY_LIMIT:
                throw new ResponseException('The service has received too many requests from your application in the allowed time range.', 3);

                break;
            case DistanceMatrixResponseInterface::RESPONSE_STATUS_REQUEST_DENIED:
                throw new ResponseException('The service denied the use of the Distance Matrix API service by your application.', 4);

                break;
            case DistanceMatrixResponseInterface::RESPONSE_STATUS_UNKNOWN_ERROR:
                throw new ResponseException('Unknown error.', 5);

                break;
            default:
                throw new ResponseException(sprintf('Unknown status code: %s', $response->getStatus()), 6);

                break;
        }
    }

    /**
     * @throws DestinationException
     * @throws OriginException
     */
    private function validateRequest(): void
    {
        if (empty($this->getOrigins())) {
            throw new OriginException('Origin must be set.');
        }
        if (empty($this->getDestinations())) {
            throw new DestinationException('Destination must be set.');
        }
    }
}


1			<?php
2
3			namespace DH\NavigationBundle\Contract\DistanceMatrix;
4
5			use DH\NavigationBundle\Exception\DestinationException;
6			use DH\NavigationBundle\Exception\OriginException;
7			use DH\NavigationBundle\Exception\ResponseException;
8			use DH\NavigationBundle\Provider\ProviderInterface;
9			use Psr\Http\Message\ResponseInterface;
10
11			abstract class AbstractDistanceMatrixQuery implements DistanceMatrixQueryInterface
12			{
13			/**
14			* @var ProviderInterface
15			*/
16			private $provider;
17
18			/**
19			* @var array
20			*/
21			protected $origins;
22
23			/**
24			* @var array
25			*/
26			protected $destinations;
27
28			/**
29			* @var \DateTime
30			*/
31			private $departure_time;
32
33			/**
34			* @var string
35			*/
36			private $language;
37
38			/**
39			* DistanceMatrixQuery constructor.
40			*
41			* @param ProviderInterface $provider
42			*/
43			public function __construct(ProviderInterface $provider)
44			{
45			$this->provider = $provider;
46			}
47
48			public function getProvider(): ProviderInterface
49			{
50			return $this->provider;
51			}
52
53			/**
54			* @return ?\DateTime
55			*/
56			public function getDepartureTime(): ?\DateTime
57			{
58			return $this->departure_time;
59			}
60
61			/**
62			* @param \DateTime $departureTime
63			*
64			* @return DistanceMatrixQueryInterface
65			*/
66			public function setDepartureTime(\DateTime $departureTime): DistanceMatrixQueryInterface
67			{
68			$this->departure_time = $departureTime;
69
70			return $this;
71			}
72
73			/**
74			* @param string $origin
75			*
76			* @return DistanceMatrixQueryInterface
77			*/
78			public function addOrigin($origin): DistanceMatrixQueryInterface
79			{
80			$this->origins[] = $origin;
81
82			return $this;
83			}
84
85			/**
86			* @return ?array
87			*/
88			public function getOrigins(): ?array
89			{
90			return $this->origins;
91			}
92
93			/**
94			* @param string $destination
95			*
96			* @return DistanceMatrixQueryInterface
97			*/
98			public function addDestination($destination): DistanceMatrixQueryInterface
99			{
100			$this->destinations[] = $destination;
101
102			return $this;
103			}
104
105			/**
106			* @return ?array
107			*/
108			public function getDestinations(): ?array
109			{
110			return $this->destinations;
111			}
112
113			/**
114			* @param string $language
115			*
116			* @return DistanceMatrixQueryInterface
117			*/
118			public function setLanguage(string $language): DistanceMatrixQueryInterface
119			{
120			$this->language = $language;
121
122			return $this;
123			}
124
125			/**
126			* @return string
127			*/
128			public function getLanguage(): string
129			{
130			return $this->language ?? 'en-US';
131			}
132
133			/**
134			* @throws DestinationException
135			* @throws OriginException
136			* @throws ResponseException
137			* @throws \GuzzleHttp\Exception\GuzzleException
138			*
139			* @return DistanceMatrixResponseInterface
140			*/
141			public function execute(): DistanceMatrixResponseInterface
142			{
143			$this->validateRequest();
144			$request = $this->buildRequest();
145			$rawResponse = $this->request('GET', $request);
146			$response = $this->buildResponse($rawResponse);
147			$this->validateResponse($response);
148
149			return $response;
150			}
151
152			/**
153			* @return string
154			*/
155			abstract protected function buildRequest(): string;
156
157			/**
158			* @param ResponseInterface $response
159			*
160			* @return DistanceMatrixResponseInterface
161			*/
162			abstract protected function buildResponse(ResponseInterface $response): DistanceMatrixResponseInterface;
163
164			/**
165			* @param string $method
166			* @param string $url
167			*
168			* @throws \GuzzleHttp\Exception\GuzzleException
169			*
170			* @return ResponseInterface
171			*/
172			private function request(string $method, string $url): ResponseInterface
173			{
174			$client = $this->getProvider()->getClient();
175			$response = $client->request($method, $url);
176
177			if (200 !== $response->getStatusCode()) {
178			throw new \Exception('Response with status code '.$response->getStatusCode());
179			}
180
181			return $response;
182			}
183
184			/**
185			* @param DistanceMatrixResponseInterface $response
186			*
187			* @throws ResponseException
188			*/
189			private function validateResponse(DistanceMatrixResponseInterface $response): void
190			{
191			switch ($response->getStatus()) {
192			case DistanceMatrixResponseInterface::RESPONSE_STATUS_OK:
193			break;
194			case DistanceMatrixResponseInterface::RESPONSE_STATUS_INVALID_REQUEST:
195			throw new ResponseException('Invalid request.', 1);
196
197			break;
198			case DistanceMatrixResponseInterface::RESPONSE_STATUS_MAX_ELEMENTS_EXCEEDED:
199			throw new ResponseException('The product of the origin and destination exceeds the limit per request.', 2);
200
201			break;
202			case DistanceMatrixResponseInterface::RESPONSE_STATUS_OVER_QUERY_LIMIT:
203			throw new ResponseException('The service has received too many requests from your application in the allowed time range.', 3);
204
205			break;
206			case DistanceMatrixResponseInterface::RESPONSE_STATUS_REQUEST_DENIED:
207			throw new ResponseException('The service denied the use of the Distance Matrix API service by your application.', 4);
208
209			break;
210			case DistanceMatrixResponseInterface::RESPONSE_STATUS_UNKNOWN_ERROR:
211			throw new ResponseException('Unknown error.', 5);
212
213			break;
214			default:
215			throw new ResponseException(sprintf('Unknown status code: %s', $response->getStatus()), 6);
216
217			break;
218			}
219			}
220
221			/**
222			* @throws DestinationException
223			* @throws OriginException
224			*/
225			private function validateRequest(): void
226			{
227			if (empty($this->getOrigins())) {
228			throw new OriginException('Origin must be set.');
229			}
230			if (empty($this->getDestinations())) {
231			throw new DestinationException('Destination must be set.');
232			}
233			}
234			}
235

DamienHarper / NavigationBundle

Push — master ( 4b5c0b...5361e0 )

AbstractDistanceMatrixQuery::setLanguage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like