All Projects → ipinfo → laravel

ipinfo / laravel

Licence: Apache-2.0 License
Official Laravel client library for IPinfo API (IP geolocation and other types of IP data)

Programming Languages

PHP
23972 projects - #3 most used programming language
Blade
752 projects
shell
77523 projects

Projects that are alternatives of or similar to laravel

go
Go library for IPinfo API (IP geolocation and other types of IP data)
Stars: ✭ 76 (-5%)
Mutual labels:  ipinfo, ip-address, ip-geolocation, ip-data
rails
Official Rails Library for IPinfo API (IP geolocation and other types of IP data)
Stars: ✭ 16 (-80%)
Mutual labels:  ipinfo, ip-address, ip-geolocation, ip-data
cli
Official Command Line Interface for the IPinfo API (IP geolocation and other types of IP data)
Stars: ✭ 1,279 (+1498.75%)
Mutual labels:  ipinfo, ip-address, ip-geolocation, ip-data
ruby
Official Ruby client library for IPinfo API (IP geolocation and other types of IP data)
Stars: ✭ 42 (-47.5%)
Mutual labels:  ipinfo, ip-address, ip-geolocation
django
Official Django Library for IPinfo API (IP geolocation and other types of IP data)
Stars: ✭ 36 (-55%)
Mutual labels:  ipinfo, ip-address, ip-geolocation
Geolocate-IP-Browser-Extension
A browser extension, which shows you the origin of your IP address.
Stars: ✭ 21 (-73.75%)
Mutual labels:  ip-address, ip-geolocation
ipapi-python
Python bindings for https://ipapi.co (IP Address Location) - Use with python / django / flask for IP address location lookup
Stars: ✭ 42 (-47.5%)
Mutual labels:  ip-address, ip-geolocation
flask-ipblock
Block certain IP addresses from accessing your Flask app
Stars: ✭ 14 (-82.5%)
Mutual labels:  ip-address
Report-IP-hourly
📬 Report Linux IP by email hourly.
Stars: ✭ 43 (-46.25%)
Mutual labels:  ip-address
server-ip-addresses
Daily updated list of IP addresses / CIDR blocks used by data centers, cloud service providers, servers, etc.
Stars: ✭ 74 (-7.5%)
Mutual labels:  ip-address
findip
🔧 Python Script For Finding All Available Local IP Addresses
Stars: ✭ 38 (-52.5%)
Mutual labels:  ip-address
IP2Country
Ip to country mapping
Stars: ✭ 39 (-51.25%)
Mutual labels:  ip-geolocation
load-ip-set
download and parse ip-set (blocklist) files
Stars: ✭ 19 (-76.25%)
Mutual labels:  ip-address
ip
Immutable value object for IPv4 and IPv6 addresses, including helper methods and Doctrine support.
Stars: ✭ 212 (+165%)
Mutual labels:  ip-address
ip2location-iata-icao
This list contains the airport codes of IATA airport code and ICAO airport code together with country code and region name supported in IP2Location geolocation database.
Stars: ✭ 39 (-51.25%)
Mutual labels:  ip-geolocation
ip2location-nginx
This is IP2Location Nginx module that enables the user to find the country, region (state), city, latitude, longitude, zip code, time zone, ISP, domain name, connection type, area code, weather, mobile network, elevation, usage type, address type and IAB category by IP address or hostname originates from.
Stars: ✭ 38 (-52.5%)
Mutual labels:  ip-geolocation
IP2Location-C-Library
IP2Location C library enables the user to find the country, region, city, coordinates, zip code, time zone, ISP, domain name, connection type, area code, weather station code, weather station name, mobile, usage types, etc that any IP address or hostname originates from.
Stars: ✭ 37 (-53.75%)
Mutual labels:  ip-address
IP2Location-PHP-Module
This module is a PHP module that enables the user to find the country, region, city, coordinates, zip code, ISP, domain name, timezone, connection speed, IDD code, area code, weather station code, weather station name, mobile, usage types, address type, IAB category, etc that any IP address or host name originates from.
Stars: ✭ 154 (+92.5%)
Mutual labels:  ip-address
Hostess.swift
A Swift implementation of NSHost that works on iOS, OS X and tvOS. Hostess.swift is safe to use in a framework because it does not require a bridging header. Hostess is Swift 4.0 (or newer) only and replaces the Swift 2.x only Host.swift.
Stars: ✭ 27 (-66.25%)
Mutual labels:  ip-address
ip2location-cakephp
IP2Location CakePHP plugin enables the user to find the country, region, city, coordinates, zip code, time zone, ISP, domain name, connection type, area code, weather, MCC, MNC, mobile brand name, elevation, usage type, IP address type and IAB advertising category from IP address using IP2Location database.
Stars: ✭ 17 (-78.75%)
Mutual labels:  ip-geolocation

IPinfo IPinfo Laravel Client Library

This is the official Laravel client library for the IPinfo.io IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:

  • IP geolocation (city, region, country, postal code, latitude and longitude)
  • ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
  • Company information (the name and domain of the business that uses the IP address)
  • Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)

Check all the data we have for your IP address here.

Getting Started

You'll need an IPinfo API access token, which you can get by singing up for a free account at https://ipinfo.io/signup.

The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see https://ipinfo.io/pricing.

Installation

composer require ipinfo/ipinfolaravel

Open your application's \app\Http\Kernel.php file and add the following to the Kernel::middleware property:

protected $middleware = [
    ...
    \ipinfo\ipinfolaravel\ipinfolaravel::class,
];

Quick Start

Route::get('/', function (Request $request) {
    $location_text = "The IP address {$request->ipinfo->ip}.";
    return view('index', ['location' => $location_text]);
});

will return the following string to the index view:

"The IP address 127.0.0.1."

Authentication

The IPinfo library can be authenticated with your IPinfo API token. It also works without an authentication token, but in a more limited capacity. To set your access token, add the following to your app's \config\services.php file and replace {{access_token}} with your own token:

'ipinfo' => [
    'access_token' => {{access_token}},
],

To do this in a more secure manner and avoid putting secret keys in your codebase, create an IPINFO_SECRET (or similar) environment variable and access this value from within \config\services.php, like so:

'ipinfo' => [
    'access_token' => env('IPINFO_SECRET'),
],

Details Data

$request->ipinfo is a Details object that contains all fields listed IPinfo developer docs with a few minor additions. Properties can be accessed directly.

>>> $request->ipinfo->hostname
cpe-104-175-221-247.socal.res.rr.com

Country Name

$request->ipinfo->country_name will return the country name, as supplied by the countries.json file. See below for instructions on changing that file for use with non-English languages. $request->ipinfo->country will still return the country code.

>>> $request->ipinfo->country
US
>>> $request->ipinfo->country_name
United States

Accessing all properties

$request->ipinfo->all will return all details data as an array.

>>> $request->ipinfo->all
{
'asn': {  'asn': 'AS20001',
           'domain': 'twcable.com',
           'name': 'Time Warner Cable Internet LLC',
           'route': '104.172.0.0/14',
           'type': 'isp'},
'city': 'Los Angeles',
'company': {   'domain': 'twcable.com',
               'name': 'Time Warner Cable Internet LLC',
               'type': 'isp'},
'country': 'US',
'country_name': 'United States',
'hostname': 'cpe-104-175-221-247.socal.res.rr.com',
'ip': '104.175.221.247',
'ip_address': IPv4Address('104.175.221.247'),
'loc': '34.0293,-118.3570',
'latitude': '34.0293',
'longitude': '-118.3570',
'phone': '323',
'postal': '90016',
'region': 'California'
}

Caching

In-memory caching of Details data is provided by default via Laravel's file-based cache. LRU (least recently used) cache-invalidation functionality has been added to the default TTL (time to live). This means that values will be cached for the specified duration; if the cache's max size is reached, cache values will be invalidated as necessary, starting with the oldest cached value.

Modifying cache options

Default cache TTL and maximum size can be changed by setting values in the $settings argument array.

  • Default maximum cache size: 4096 (multiples of 2 are recommended to increase efficiency)
  • Default TTL: 24 hours (in minutes)
'ipinfo' => [
    'cache_maxsize' => {{cache_maxsize}},
    'cache_ttl' => {{cache_ttl}},
],

Using a different cache

It is possible to use a custom cache by creating a child class of the CacheInterface class and setting the the cache config value in \config\services.php. FYI this is known as the Strategy Pattern.

'ipinfo' => [
    ...
    'cache' => new MyCustomCacheObject(),
],

Internationalization

When looking up an IP address, the response object includes a $request->ipinfo->country_name property which includes the country name based on American English. It is possible to return the country name in other languages by telling the library to read from a custom file. To define a custom file, add the following to your app's \config\services.php file and replace {{countries}} with your own file path.

'ipinfo' => [
    ...
    'countries_file' => {{countries}},
],

The file must be a .json file with the following structure:

{
    {{country_code}}: {{country_name}},
    "BD": "Bangladesh",
    "BE": "Belgium",
    "BF": "Burkina Faso",
    "BG": "Bulgaria"
    ...
}

Filtering

By default, ipinfolaravel filters out requests that have bot or spider in the user-agent. Instead of looking up IP address data for these requests, the $request->ipinfo attribute is set to null. This is to prevent you from unnecessarily using up requests on non-user traffic. This behavior can be switched off by adding the following to your app's \config\services.php file.

'ipinfo' => [
    ...
    'filter' => false,
 ],

To set your own filtering rules, thereby replacing the default filter, you can set ipinfo.config to your own, custom callable function which satisfies the following rules:

  • Accepts one request.
  • Returns True to filter out, False to allow lookup

To use your own filter function:

'ipinfo' => [
    ...
    'filter' => $customFilterFunction,
],

Suppressing Exceptions

Laravel middleware does not allow you to catch exceptions from other middleware, so if the IPinfo middleware throws an exception, it'll be quite hard to deal with it.

We allow suppressing exceptions by specifying the no_except key in the config:

'ipinfo' => [
    ...
    'no_except' => true,
],

If an exception occurs when this setting is true, the $request->ipinfo object will be equal to null.

Other Libraries

There are official IPinfo client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.

About IPinfo

Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers.

image

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].