Skip to content

statsig-io/ip3country-ruby

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ip3country-ruby

A zero-dependency, super small, IP address to 2-letter country code lookup library. There are already several libraries available, but none met our requirements for binary size and lookup speed.

This project in its entirety is <500KB, compared to most alternatives out there that are in the MBs (but might provide more than just countries).

The database used in this project is compacted from IP2Location. Their DB1.LITE edition is provided under CCA, with the attribution below:


NOTE

This site or product includes IP2Location LITE data available from https://lite.ip2location.com.


Usage

require 'country_lookup'
  
CountryLookup.initialize

# Lookup using ip4 str
CountryLookup.lookup_ip_string('123.45.67.8') # => 'KR'

# Lookup using numeric ip
CountryLookup.lookup_ip_number(2066563848) # => 'KR'

Accuracy

ip3country's accuracy is dependent on IP2Location LITE's accuracy. In our experience, for country lookups, it is accurate enough for most applications.

IP2Location publishes accuracy reports here: https://www.ip2location.com/data-accuracy

There's also this third party report available: https://www.cl.cam.ac.uk/~nz247/publications/JSAC2011-Geolocation.pdf

Name

All variants of "ip2country" were already taken in npm when we published the original, nodejs verion. Now, we have re-created it for use in ruby applications

Motivation

At Statsig, we needed a library to evaluate location-based conditions on Feature Gates (Feature Flags). We use ip3country to power country-level rollouts or A/B tests for new features.

About

A ruby, zero-dependency, super small version of IP2Location LITE country lookups

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages