-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: Add ipinfo driver * Fix styling * throwable * update readme and config
- Loading branch information
1 parent
e7f6262
commit 1dc7860
Showing
7 changed files
with
218 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <?php | ||
|
|
||
| namespace PulkitJalan\IPGeolocation\Drivers; | ||
|
|
||
| use Throwable; | ||
| use Illuminate\Support\Arr; | ||
| use GuzzleHttp\Client as GuzzleClient; | ||
| use PulkitJalan\IPGeolocation\Exceptions\InvalidCredentialsException; | ||
|
|
||
| class IPInfoDriver extends AbstractIPGeolocationDriver implements IPGeolocationInterface | ||
| { | ||
| /** | ||
| * @param array $config | ||
| * @param GuzzleClient|null $guzzle | ||
| * @throws InvalidCredentialsException | ||
| */ | ||
| public function __construct(array $config, GuzzleClient $guzzle = null) | ||
| { | ||
| parent::__construct($config, $guzzle); | ||
|
|
||
| if (! Arr::get($this->config, 'token')) { | ||
| throw new InvalidCredentialsException('The IPInfo access token is required.'); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get array of data using IPInfo. | ||
| * | ||
| * @param string $ip | ||
| * @return array | ||
| */ | ||
| public function get($ip) | ||
| { | ||
| $data = $this->getRaw($ip); | ||
|
|
||
| if (empty($data)) { | ||
| return $this->getDefault(); | ||
| } | ||
|
|
||
| return [ | ||
| 'city' => Arr::get($data, 'city'), | ||
| 'country' => Arr::get($data, 'country'), | ||
| 'countryCode' => Arr::get($data, 'country'), | ||
| 'latitude' => (float) explode(',', Arr::get($data, 'loc', '0,0'))[0], | ||
| 'longitude' => (float) explode(',', Arr::get($data, 'loc', '0,0'))[1], | ||
| 'region' => Arr::get($data, 'region'), | ||
| 'regionCode' => Arr::get($data, 'region'), | ||
| 'timezone' => Arr::get($data, 'timezone'), | ||
| 'postalCode' => Arr::get($data, 'postal'), | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Get the raw IPGeolocation info using IPInfo. | ||
| * | ||
| * @param string $ip | ||
| * @return array | ||
| */ | ||
| public function getRaw($ip) | ||
| { | ||
| $url = "https://ipinfo.io/{$ip}?token=" . Arr::get($this->config, 'token'); | ||
|
|
||
| try { | ||
| $response = $this->guzzle->get($url); | ||
|
|
||
| return json_decode($response->getBody(), true); | ||
| } catch (Throwable $e) { | ||
| return []; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <?php | ||
|
|
||
| use GuzzleHttp\Client; | ||
| use GuzzleHttp\HandlerStack; | ||
| use GuzzleHttp\Psr7\Response; | ||
| use GuzzleHttp\Handler\MockHandler; | ||
| use PulkitJalan\IPGeolocation\Drivers\IPInfoDriver; | ||
| use PulkitJalan\IPGeolocation\Exceptions\InvalidCredentialsException; | ||
|
|
||
| beforeEach(function () { | ||
| $this->validConfig = ['token' => 'test_token']; | ||
| $this->invalidConfig = []; | ||
| }); | ||
|
|
||
| it('throws exception with invalid config', function () { | ||
| expect(fn () => new IPInfoDriver($this->invalidConfig)) | ||
| ->toThrow(InvalidCredentialsException::class); | ||
| }); | ||
|
|
||
| it('returns correct data for valid IP', function () { | ||
| $mockResponse = [ | ||
| 'ip' => '8.8.8.8', | ||
| 'city' => 'Mountain View', | ||
| 'region' => 'California', | ||
| 'country' => 'US', | ||
| 'loc' => '37.4056,-122.0775', | ||
| 'postal' => '94043', | ||
| 'timezone' => 'America/Los_Angeles', | ||
| ]; | ||
|
|
||
| $mock = new MockHandler([ | ||
| new Response(200, [], json_encode($mockResponse)), | ||
| ]); | ||
|
|
||
| $handlerStack = HandlerStack::create($mock); | ||
| $client = new Client(['handler' => $handlerStack]); | ||
|
|
||
| $driver = new IPInfoDriver($this->validConfig, $client); | ||
| $result = $driver->get('8.8.8.8'); | ||
|
|
||
| expect($result)->toMatchArray([ | ||
| 'city' => 'Mountain View', | ||
| 'country' => 'US', | ||
| 'countryCode' => 'US', | ||
| 'latitude' => 37.4056, | ||
| 'longitude' => -122.0775, | ||
| 'region' => 'California', | ||
| 'regionCode' => 'California', | ||
| 'timezone' => 'America/Los_Angeles', | ||
| 'postalCode' => '94043', | ||
| ]); | ||
| }); | ||
|
|
||
| it('returns default data for invalid response', function () { | ||
| $mock = new MockHandler([ | ||
| new Response(400, []), | ||
| ]); | ||
|
|
||
| $handlerStack = HandlerStack::create($mock); | ||
| $client = new Client(['handler' => $handlerStack]); | ||
|
|
||
| $driver = new IPInfoDriver($this->validConfig, $client); | ||
|
|
||
| expect($driver->get('invalid_ip'))->toEqual([ | ||
| 'city' => null, | ||
| 'country' => null, | ||
| 'countryCode' => null, | ||
| 'latitude' => null, | ||
| 'longitude' => null, | ||
| 'region' => null, | ||
| 'regionCode' => null, | ||
| 'timezone' => null, | ||
| 'postalCode' => null, | ||
| ]); | ||
| }); | ||
|
|
||
| it('returns raw data for valid IP', function () { | ||
| $mockResponse = [ | ||
| 'ip' => '8.8.8.8', | ||
| 'city' => 'Mountain View', | ||
| 'region' => 'California', | ||
| 'country' => 'US', | ||
| 'loc' => '37.4056,-122.0775', | ||
| 'postal' => '94043', | ||
| 'timezone' => 'America/Los_Angeles', | ||
| ]; | ||
|
|
||
| $mock = new MockHandler([ | ||
| new Response(200, [], json_encode($mockResponse)), | ||
| ]); | ||
|
|
||
| $handlerStack = HandlerStack::create($mock); | ||
| $client = new Client(['handler' => $handlerStack]); | ||
|
|
||
| $driver = new IPInfoDriver($this->validConfig, $client); | ||
| $result = $driver->getRaw('8.8.8.8'); | ||
|
|
||
| expect($result)->toBe($mockResponse); | ||
| }); |