DistanceMatrixService::getDefaultQueryParams() - Code Metrics - Inspection of "Merge pull request #3 from ARCANEDEV/patch-refacto..." - ARCANEDEV/GeoLocation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 44eb79...c2add9 )

by ARCANEDEV

created 2017-05-24 15:20 UTC

DistanceMatrixService::getDefaultQueryParams() A

↳ Parent: DistanceMatrixService

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\GeoLocation\Google\DistanceMatrix;

use Arcanedev\GeoLocation\Contracts\Entities\Position;
use Arcanedev\GeoLocation\Google\AbstractWebService;
use GuzzleHttp\ClientInterface;
use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;

/**
 * Class     DistanceMatrixService
 *
 * @package  Arcanedev\GeoLocation\Google\DistanceMatrix
 * @author   ARCANEDEV <[email protected]>
 *
 * @link     https://developers.google.com/maps/documentation/distance-matrix/intro
 */
class DistanceMatrixService extends AbstractWebService
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    const BASE_URL = 'https://maps.googleapis.com/maps/api/distancematrix/json';

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var string */
    protected $language = 'en';

    /** @var string */
    protected $mode = 'driving';

    /** @var string */
    protected $units = 'metric';

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * GoogleDistanceMatrix constructor.
     *
     * @param  \GuzzleHttp\ClientInterface  $client
     */
    public function __construct(ClientInterface $client)
    {
        parent::__construct($client);

        $this->setKey(getenv('GOOGLE_MAPS_DISTANCE_MATRIX_KEY'));
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the language.
     *
     * @param  string  $language
     *
     * @return self
     */
    public function setLanguage($language)
    {
        $this->language = $language;

        return $this;
    }

    /**
     * Set the mode of transport.
     *
     * @param  string  $mode
     *
     * @return self
     */
    public function setMode($mode)
    {
        $this->mode = $this->checkMode($mode);

        return $this;
    }

    /**
     * Set the unit system.
     *
     * @param  string  $units
     *
     * @return self
     */
    public function setUnits($units)
    {
        $this->units = $this->checkUnits($units);

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Calculate the distance.
     *
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Position  $start
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Position  $end
     * @param  array                                               $options
     *
     * @return \Arcanedev\GeoLocation\Google\DistanceMatrix\DistanceMatrixResponse
     */
    public function calculate(Position $start, Position $end, array $options = [])
    {
        $url = static::BASE_URL.'?'.$this->prepareQuery([
            'origins'      => $this->parsePosition($start),
            'destinations' => $this->parsePosition($end),
        ]);

        return $this->get($url, $options);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the default query params.
     *
     * @return array
     */
    protected function getDefaultQueryParams()
    {
        return [
            'mode'         => $this->mode,
            'language'     => $this->language,
            'units'        => $this->units,
            'key'          => $this->key,
        ];
    }

    /**
     * Prepare the response.
     *
     * @param  \Psr\Http\Message\ResponseInterface  $response
     *
     * @return \Arcanedev\GeoLocation\Google\DistanceMatrix\DistanceMatrixResponse
     */
    protected function prepareResponse(ResponseInterface $response)
    {
        return new DistanceMatrixResponse(
            json_decode($response->getBody(), true)
        );
    }

    /**
     * Check the mode of transport.
     *
     * @param  string  $mode
     *
     * @return string
     */
    private function checkMode($mode)
    {
        $mode = strtolower($mode);

        if ( ! in_array($mode, ['driving', 'walking', 'bicycling', 'transit'])) {
            throw new InvalidArgumentException(
                "The given mode of transport [{$mode}] is invalid. Please check the supported travel modes: ".
                "https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes"
            );
        }

        return $mode;
    }

    /**
     * Check the unit system.
     *
     * @param  string  $units
     *
     * @return string
     */
    private function checkUnits($units)
    {
        $units = strtolower($units);

        if ( ! in_array($units, ['metric', 'imperial'])) {
            throw new InvalidArgumentException(
                "The given unit system [{$units}] is invalid. Please check the supported units: ".
                "https://developers.google.com/maps/documentation/distance-matrix/intro#unit_systems"
            );
        }

        return $units;
    }
}


1		<?php namespace Arcanedev\GeoLocation\Google\DistanceMatrix;
2
3		use Arcanedev\GeoLocation\Contracts\Entities\Position;
4		use Arcanedev\GeoLocation\Google\AbstractWebService;
5		use GuzzleHttp\ClientInterface;
6		use InvalidArgumentException;
7		use Psr\Http\Message\ResponseInterface;
8
9		/**
10		* Class DistanceMatrixService
11		*
12		* @package Arcanedev\GeoLocation\Google\DistanceMatrix
13		* @author ARCANEDEV <[email protected]>
14		*
15		* @link https://developers.google.com/maps/documentation/distance-matrix/intro
16		*/
17		class DistanceMatrixService extends AbstractWebService
18		{
19		/* -----------------------------------------------------------------
20		\| Constants
21		\| -----------------------------------------------------------------
22		*/
23
24		const BASE_URL = 'https://maps.googleapis.com/maps/api/distancematrix/json';
25
26		/* -----------------------------------------------------------------
27		\| Properties
28		\| -----------------------------------------------------------------
29		*/
30
31		/** @var string */
32		protected $language = 'en';
33
34		/** @var string */
35		protected $mode = 'driving';
36
37		/** @var string */
38		protected $units = 'metric';
39
40		/* -----------------------------------------------------------------
41		\| Constructor
42		\| -----------------------------------------------------------------
43		*/
44
45		/**
46		* GoogleDistanceMatrix constructor.
47		*
48		* @param \GuzzleHttp\ClientInterface $client
49		*/
50	21	public function __construct(ClientInterface $client)
51		{
52	21	parent::__construct($client);
53
54	21	$this->setKey(getenv('GOOGLE_MAPS_DISTANCE_MATRIX_KEY'));
55	21	}
56
57		/* -----------------------------------------------------------------
58		\| Getters & Setters
59		\| -----------------------------------------------------------------
60		*/
61
62		/**
63		* Set the language.
64		*
65		* @param string $language
66		*
67		* @return self
68		*/
69	3	public function setLanguage($language)
70		{
71	3	$this->language = $language;
72
73	3	return $this;
74		}
75
76		/**
77		* Set the mode of transport.
78		*
79		* @param string $mode
80		*
81		* @return self
82		*/
83	6	public function setMode($mode)
84		{
85	6	$this->mode = $this->checkMode($mode);
86
87	3	return $this;
88		}
89
90		/**
91		* Set the unit system.
92		*
93		* @param string $units
94		*
95		* @return self
96		*/
97	6	public function setUnits($units)
98		{
99	6	$this->units = $this->checkUnits($units);
100
101	3	return $this;
102		}
103
104		/* -----------------------------------------------------------------
105		\| Main Methods
106		\| -----------------------------------------------------------------
107		*/
108
109		/**
110		* Calculate the distance.
111		*
112		* @param \Arcanedev\GeoLocation\Contracts\Entities\Position $start
113		* @param \Arcanedev\GeoLocation\Contracts\Entities\Position $end
114		* @param array $options
115		*
116		* @return \Arcanedev\GeoLocation\Google\DistanceMatrix\DistanceMatrixResponse
117		*/
118	12	public function calculate(Position $start, Position $end, array $options = [])
119		{
120	12	$url = static::BASE_URL.'?'.$this->prepareQuery([
121	12	'origins' => $this->parsePosition($start),
122	12	'destinations' => $this->parsePosition($end),
123	4	]);
124
125	12	return $this->get($url, $options);
126		}
127
128		/* -----------------------------------------------------------------
129		\| Other Methods
130		\| -----------------------------------------------------------------
131		*/
132
133		/**
134		* Get the default query params.
135		*
136		* @return array
137		*/
138	12	protected function getDefaultQueryParams()
139		{
140		return [
141	12	'mode' => $this->mode,
142	12	'language' => $this->language,
143	12	'units' => $this->units,
144	12	'key' => $this->key,
145	4	];
146		}
147
148		/**
149		* Prepare the response.
150		*
151		* @param \Psr\Http\Message\ResponseInterface $response
152		*
153		* @return \Arcanedev\GeoLocation\Google\DistanceMatrix\DistanceMatrixResponse
154		*/
155	12	protected function prepareResponse(ResponseInterface $response)
156		{
157	12	return new DistanceMatrixResponse(
158	12	json_decode($response->getBody(), true)
159	4	);
160		}
161
162		/**
163		* Check the mode of transport.
164		*
165		* @param string $mode
166		*
167		* @return string
168		*/
169	6	private function checkMode($mode)
170		{
171	6	$mode = strtolower($mode);
172
173	6	if ( ! in_array($mode, ['driving', 'walking', 'bicycling', 'transit'])) {
174	3	throw new InvalidArgumentException(
175	3	"The given mode of transport [{$mode}] is invalid. Please check the supported travel modes: ".
176	2	"https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes"
177	1	);
178		}
179
180	3	return $mode;
181		}
182
183		/**
184		* Check the unit system.
185		*
186		* @param string $units
187		*
188		* @return string
189		*/
190	6	private function checkUnits($units)
191		{
192	6	$units = strtolower($units);
193
194	6	if ( ! in_array($units, ['metric', 'imperial'])) {
195	3	throw new InvalidArgumentException(
196	3	"The given unit system [{$units}] is invalid. Please check the supported units: ".
197	2	"https://developers.google.com/maps/documentation/distance-matrix/intro#unit_systems"
198	1	);
199		}
200
201	3	return $units;
202		}
203		}
204

ARCANEDEV / GeoLocation

Push — master ( 44eb79...c2add9 )

DistanceMatrixService::getDefaultQueryParams() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like