Teazee\Provider\GoogleMaps

Complexity

Total Complexity

7

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getName()	0	4	1
A	find()	0	14	4
A	buildUri()	0	13	1

<?php

/**
 * This file is part of the Teazee package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */
namespace Teazee\Provider;

use Http\Client\HttpClient;
use Http\Message\MessageFactory;
use RuntimeException;
use Teazee\ZoneInfo;

/**
 * @author Michael Crumm <mike@crumm.net>
 */
class GoogleMaps extends AbstractHttpProvider
{
    const ENDPOINT = 'https://maps.googleapis.com/maps/api/timezone/json';

    /**
     * @var array
     */
    private $errorStatus = [
        'INVALID_REQUEST',
        'OVER_QUERY_LIMIT',
        'REQUEST_DENIED',
        'UNKNOWN_ERROR',
        'ZERO_RESULTS',
    ];

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

    /**
     * Google constructor.
     *
     * @param string         $apiKey
     * @param HttpClient     $client
     * @param MessageFactory $messageFactory
     */
    public function __construct($apiKey = null, HttpClient $client = null, MessageFactory $messageFactory = null)
    {
        $this->apiKey = $apiKey;

        parent::__construct($client, $messageFactory);
    }

    /**
     * Returns the name of this provider.
     *
     * @return string
     */
    public function getName()
    {
        return 'google_maps';
    }

    /**
     * Returns ZoneInfo for the specified location and timestamp.
     *
     * @param string|float $lat       Coordinate latitude.
     * @param string|float $lng       Coordinate longitude.
     * @param int          $timestamp UNIX timestamp used to determine Daylight Savings Time.
     *
     * @throws RuntimeException
     *
     * @return ZoneInfo
     */
    public function find($lat, $lng, $timestamp = null)
    {
        // Google Maps TimeZone API requires a timestamp.
        $timestamp = $timestamp ?: $this->getCurrentTimestamp();

        $result = $this->getResult($lat, $lng, $timestamp);

        if (in_array($result->status, $this->errorStatus)) {
            $message = isset($result->errorMessage) ? $result->errorMessage : $result->status;
            throw new RuntimeException($message);
        }

        return new ZoneInfo($result->timeZoneId, $timestamp);
    }

    /**
     * Returns the URI for the specified location and timestamp.
     *
     * @param string|float $lat       Coordinate latitude.
     * @param string|float $lng       Coordinate longitude.
     * @param int|null     $timestamp Seconds since Jan 1, 1970 UTC.
     *
     * @return string
     */
    protected function buildUri($lat, $lng, $timestamp = null)
    {
        $params = [
            'key'       => $this->apiKey,
            'location'  => implode(',', [$lat, $lng]),
            'timestamp' => $timestamp,
        ];

        // Remove null values.
        $params = array_filter($params);

        return static::ENDPOINT.'?'.http_build_query($params);
    }
}