davidepastore / ipinfo

A wrapper around the ipinfo.io services

ipinfo

A wrapper around the ipinfo.io services.

Install

You can install the library using composer:

$ composer require davidepastore/ipinfo

How to use

Settings

Token

You can set your token when you instantiate the object but it's not mandatory.

$ipInfo = new DavidePastore\Ipinfo\Ipinfo(array(
	"token" => "your_api_key"
));

cURL options

The cURL options to use while trying to connect when you instantiate the object:

$ipInfo = new DavidePastore\Ipinfo\Ipinfo(array(
	"curlOptions" => array(
            CURLOPT_CONNECTTIMEOUT => 1,
            CURLOPT_TIMEOUT => 2,
            CURLOPT_CAINFO => __DIR__ . "/cacert.pem"
    )
));

Read details about the given ip

You can read all the properties from the given ip.

//Get all the properties
$host = $ipInfo->getFullIpDetails("8.8.8.8");

//Get only a single property (this could save bandwidth)
$city = $ipInfo->getSpecificField("8.8.8.8", DavidePastore\Ipinfo\Ipinfo::CITY);

Read details about your ip

You can read all the properties from your ip.

//Get all the properties
$host = $ipInfo->getYourOwnIpDetails();

//Get only a single property (this could save bandwidth)
$city = $ipInfo->getYourOwnIpSpecificField(DavidePastore\Ipinfo\Ipinfo::CITY);

Get info from the host

After obtaining the Host instance you can read all the properties or each of them individually.

//Read all the properties
$city = $host->getCity();
$country = $host->getCountry();
$hostname = $host->getHostname();
$ip = $host->getIp();
$loc = $host->getLoc();
$org = $host->getOrg();
$phone = $host->getPhone();
$postal = $host->getPostal();
$region = $host->getRegion();

//Get the associative array with all the properties
$properties = $host->getProperties();

Read only a field

There are different constants that you could use to read specific field value from an Ipinfo instance using the getSpecificField() and getYourOwnIpSpecificField() methods:

IpInfo::IP; //For the ip address
IpInfo::HOSTNAME; //For the hostname
IpInfo::LOC; //For the loc
IpInfo::ORG; //For the org
IpInfo::CITY; //For the city
IpInfo::REGION; //For the region
IpInfo::COUNTRY; //For the country
IpInfo::PHONE; //For the phone
IpInfo::POSTAL; //For the postal
IpInfo::GEO; //For the geo info. See the paragraph below for more info

Read only the Geo data (which is faster)

By using the getIpGeoDetails() method you will get less fields. This call tends to be faster than getFullIpDetails() so use this call in case you only need the following fields:

IpInfo::IP; //For the ip address
IpInfo::CITY; //For the city
IpInfo::REGION; //For the region
IpInfo::COUNTRY; //For the country
IpInfo::PHONE; //For the phone
IpInfo::POSTAL; //For the postal

These fields will be empty:

IpInfo::HOSTNAME; //For the hostname
IpInfo::LOC; //For the loc
IpInfo::ORG; //For the org

Error Handling

You can handle all the types of IpInfo exceptions by catching the IpInfoExceptionException:

use DavidePastore\Ipinfo\Exception\IpInfoExceptionException;

try {
    $host = $ipInfo->getFullIpDetails("8.8.8.8");
} catch (IpInfoExceptionException $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

Invalid Token Exception

It could happen that the token you are using to make the API call is not valid. You can handle it by catching the InvalidTokenException:

use DavidePastore\Ipinfo\Exception\InvalidTokenException;

try {
    $host = $ipInfo->getFullIpDetails("8.8.8.8");
} catch (InvalidTokenException $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

Rate Limit Exceed Exception

It could happen that your API call exceeds the rate limit. You can handle it by catching the RateLimitExceedException:

use DavidePastore\Ipinfo\Exception\RateLimitExceedException;

try {
    $host = $ipInfo->getFullIpDetails("8.8.8.8");
} catch (RateLimitExceedException $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

Wrong Ip Exception

It could happen that your API call is trying to obtain info about a wrong ip. You can handle it by catching the WrongIpException:

use DavidePastore\Ipinfo\Exception\WrongIpException;

try {
    $host = $ipInfo->getFullIpDetails("qwerty");
} catch (WrongIpException $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

Issues

If you have issues, just open one here.

ipinfo's Issues

Use GitHub Actions instead of Travis

Fix test data

Test data is different.

Few issues

Hi!
Thank you for your work, but current version lacks the following functionality:

• use HTTPS to contact ipinfo.io instead of HTTP
• set timeout for the operation

If you could improve that, then it could be a great project!

IPInfoDB Support

Do you have plan to support IPInfoDB.com API?

Ignore HHVM and PHP 5.3 build errors

Instalation

Where can I put the files?

adding a license

hello!

I would like to use this package but there doesn't seem to be any license for how it can be used. Is there a chance you could add one?

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository

Add exception in case of invalid token

If the used token is not valid, throw an exception.

Add parameter to configure cURL options

As discussed here.

Add composer.lock file to .gitignore

$response must be check for NULL value

https://github.com/DavidePastore/ipinfo/blob/master/src/DavidePastore/Ipinfo/Ipinfo.php#L202

Add documentation regarding rate limit exceed exception

Update the instructions used to install the library

It's best to remove the section where the README.md talks about the version of the library.

Fix test output

Prepare for next release

Update the installation process, pointing to the new release.

Fix HHVM build on Travis

Something is wrong with the HHVM build on Travis.

Improve code coverage

Investigate: Some ip contains the postal field

To do

• check if we have to edit code;
• add it in the documentation;
• fix test

Update installation docs

May be it's better to change the way the lib is installed, and do it like this, so it's safe to use the latest release of the same major version:

"require" : {
	"davidepastore/ipinfo" : "^0.3.*"
}

Throw exception if API call fails

I'm currently getting this error when the API returns unsuccessful response... no way to catch these in my application.

E_WARNING: array_merge(): Argument #2 is not an array
1 File "/public_html/vendor/davidepastore/ipinfo/src/DavidePastore/Ipinfo/Host.php" line 33 in array_merge
2 File "/public_html/vendor/davidepastore/ipinfo/src/DavidePastore/Ipinfo/Host.php" line 33 in __construct
3 File "/public_html/vendor/davidepastore/ipinfo/src/DavidePastore/Ipinfo/Ipinfo.php" line 153 in checkGeo
4 File "/public_html/vendor/davidepastore/ipinfo/src/DavidePastore/Ipinfo/Ipinfo.php" line 125 in getSpecificField

results are null

Why my results are null from the $host variable

The code i have used is:

require DIR . '/vendor/autoload.php';

$ipInfo = new DavidePastore\Ipinfo\Ipinfo(array(
"token" => "XXXXXXXXXXX",
"curlOptions" => array(
CURLOPT_CONNECTTIMEOUT => 1,
CURLOPT_TIMEOUT => 2,
CURLOPT_CAINFO => DIR . "/cacert.pem"
)
));

try {
$host = $ipInfo->getFullIpDetails("8.8.8.8");
print_r($host)
} catch (IpInfoExceptionException $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}

My result is:
DavidePastore\Ipinfo\Host Object ( [properties:protected] => Array ( [city] => [country] => [hostname] => [ip] => [loc] => [org] => [phone] => [postal] => [region] => ) )

Remove php-eye badge

Fix version in README.md

Fix the version specified in the Install section.

String response is not handled properly

ipinfo/src/DavidePastore/Ipinfo/Ipinfo.php

Line 136 in 5f3cf07

$response = $this->jsonDecodeResponse($response);

In case there is a string response from ipinfo, the json decoding function returns a NULL. This in turn fails in the Host.php constructor.

Scenario: When subscription has expired. The below response is received,
Rate limit exceeded. Subscribe to a paid plan to increase your usage limits at http://ipinfo.io/pricing, or contact us via http://ipinfo.io/contact

As explained above, this fails as array_merge in the Host.php constructor is called with a NULL input.

Add PHP 7.1 test for Travis