|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace Ziptastic; |
| 6 | + |
| 7 | +use Http\Client\HttpClient; |
| 8 | +use Http\Discovery\HttpClientDiscovery; |
| 9 | +use Http\Discovery\MessageFactoryDiscovery; |
| 10 | +use Http\Message\MessageFactory; |
| 11 | + |
| 12 | +/** |
| 13 | + * The Ziptastic API class. |
| 14 | + * |
| 15 | + * Example: |
| 16 | + * ``` |
| 17 | + * use Ziptastic\Client; |
| 18 | + * |
| 19 | + * $ziptastic = Client::create($myApiKey); |
| 20 | + * ``` |
| 21 | + */ |
| 22 | +class Client |
| 23 | +{ |
| 24 | + const ZIPTASTIC_LOOKUP_URL = 'https://zip.getziptastic.com/v3/%s/%s'; |
| 25 | + const ZIPTASTIC_REVERSE_URL = 'https://zip.getziptastic.com/v3/reverse/%s/%s/%s'; |
| 26 | + |
| 27 | + /** |
| 28 | + * @var HttpClient; |
| 29 | + */ |
| 30 | + private $http; |
| 31 | + |
| 32 | + /** |
| 33 | + * @var MessageFactory |
| 34 | + */ |
| 35 | + private $messageFactory; |
| 36 | + |
| 37 | + /** |
| 38 | + * @var string |
| 39 | + */ |
| 40 | + private $apiKey; |
| 41 | + |
| 42 | + /** |
| 43 | + * @var string |
| 44 | + */ |
| 45 | + private $countryCode; |
| 46 | + |
| 47 | + /** |
| 48 | + * @param HttpClient $http An HTTP Client implementation. |
| 49 | + * @param MessageFactory $messageFactory An HTTP message factory implementation. |
| 50 | + * @param string $apiKey Ziptastic API Key. |
| 51 | + * @param string|null $countryCode 2-character country code. Currently only |
| 52 | + * supports "US". |
| 53 | + */ |
| 54 | + public function __construct( |
| 55 | + HttpClient $http, |
| 56 | + MessageFactory $messageFactory, |
| 57 | + string $apiKey, |
| 58 | + string $countryCode = 'US' |
| 59 | + ) { |
| 60 | + $this->http = $http; |
| 61 | + $this->messageFactory = $messageFactory; |
| 62 | + $this->apiKey = $apiKey; |
| 63 | + $this->countryCode = $countryCode; |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Create a client instance with the default HTTP handler. |
| 68 | + * |
| 69 | + * Example: |
| 70 | + * ``` |
| 71 | + * $ziptastic = Client::create($myApiKey); |
| 72 | + * ``` |
| 73 | + * |
| 74 | + * @param string $apiKey Ziptastic API Key. |
| 75 | + * @param string|null $countryCode 2-character country code. Currently only |
| 76 | + * supports "US". |
| 77 | + * @return Client |
| 78 | + */ |
| 79 | + public static function create( |
| 80 | + string $apiKey, |
| 81 | + string $countryCode = 'US' |
| 82 | + ): self { |
| 83 | + $http = HttpClientDiscovery::find(); |
| 84 | + $messageFactory = MessageFactoryDiscovery::find(); |
| 85 | + |
| 86 | + return new self($http, $messageFactory, $apiKey, $countryCode); |
| 87 | + } |
| 88 | + |
| 89 | + /** |
| 90 | + * Lookup locale information by a postal code. |
| 91 | + * |
| 92 | + * Example: |
| 93 | + * ``` |
| 94 | + * $result = $ziptastic->forward('48226'); |
| 95 | + * foreach ($result as $item) { |
| 96 | + * echo $item->postalCode() . PHP_EOL; |
| 97 | + * } |
| 98 | + * ``` |
| 99 | + * |
| 100 | + * @param string $zipCode The lookup postal code. |
| 101 | + * @return array[] A list of arrays containing locale data. |
| 102 | + */ |
| 103 | + public function forward(string $postalCode): array |
| 104 | + { |
| 105 | + $url = sprintf( |
| 106 | + self::ZIPTASTIC_LOOKUP_URL, |
| 107 | + $this->countryCode, |
| 108 | + $postalCode |
| 109 | + ); |
| 110 | + |
| 111 | + return $this->request($url); |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * Lookup locale information by a set of coordinates. |
| 116 | + * |
| 117 | + * Example: |
| 118 | + * ``` |
| 119 | + * $result = $ziptastic->reverse(42.331427, -83.0457538); |
| 120 | + * foreach ($result as $item) { |
| 121 | + * echo $item->postalCode() . PHP_EOL; |
| 122 | + * } |
| 123 | + * ``` |
| 124 | + * |
| 125 | + * @param float $latitude The lookup centerpoint latitude. |
| 126 | + * @param float $longitude The lookup centerpoint longitude. |
| 127 | + * @param integer $radius The search radius, in meters. Defaults to `1000`. |
| 128 | + * @return array[] A list of arrays containing locale data. |
| 129 | + */ |
| 130 | + public function reverse(float $latitude, float $longitude, int $radius = 1000): array |
| 131 | + { |
| 132 | + $url = sprintf( |
| 133 | + self::ZIPTASTIC_REVERSE_URL, |
| 134 | + $latitude, |
| 135 | + $longitude, |
| 136 | + $radius |
| 137 | + ); |
| 138 | + |
| 139 | + return $this->request($url); |
| 140 | + } |
| 141 | + |
| 142 | + /** |
| 143 | + * Make a request to a given URI with the ziptastic API key. |
| 144 | + * |
| 145 | + * @param string $url |
| 146 | + * @return array[] A list of arrays containing locale data. |
| 147 | + */ |
| 148 | + private function request(string $url): array |
| 149 | + { |
| 150 | + try { |
| 151 | + $res = $this->http->sendRequest( |
| 152 | + $this->messageFactory->createRequest('GET', $url, [ |
| 153 | + 'x-key' => $this->apiKey |
| 154 | + ]) |
| 155 | + ); |
| 156 | + } catch (\Exception $e) { |
| 157 | + throw new Exception('An error occurred: '. $e->getMessage(), $e->getCode(), $e); |
| 158 | + } |
| 159 | + |
| 160 | + $body = json_decode($res->getBody()->getContents(), true); |
| 161 | + |
| 162 | + if ($res->getStatusCode() !== 200) { |
| 163 | + $message = isset($body['message']) |
| 164 | + ? $body['message'] |
| 165 | + : 'An error occurred'; |
| 166 | + |
| 167 | + throw new Exception($message, $res->getStatusCode()); |
| 168 | + } |
| 169 | + |
| 170 | + $collection = []; |
| 171 | + foreach ($body as $result) { |
| 172 | + // If the timezone is not valid, keep null. |
| 173 | + try { |
| 174 | + $result['timezone'] = new \DateTimeZone($result['timezone']); |
| 175 | + } catch (\Exception $e) { |
| 176 | + $result['timezone'] = null; |
| 177 | + } |
| 178 | + |
| 179 | + $collection[] = $result; |
| 180 | + |
| 181 | + } |
| 182 | + |
| 183 | + return $collection; |
| 184 | + } |
| 185 | +} |
0 commit comments