Giter Club home page Giter Club logo

geoip2-erl's Introduction

Erlang wrapper for MaxMind GeoIP2 C library

The geoip2-erl is a safe port wrapper OTP application for MaxMind's libmaxminddb.

Basic build instruction

rebar3 compile

Configuration

In your sys.config you can specify multiple named instances of geoip2 servers and for every instance you can specify the path of its mmdb file and optionally its options. Right now the only option you can specify is {cache, false} turning off default map cache of IP lookups.

Example:

{geoip2, [{
    instances, [
        {city, "./GeoIP2-City.mmdb"},
        {city_no_cache, "./GeoIP2-City.mmdb", [{cache, false}]}
    ]
}]} 

Usage

To lookup for data related to a given IPv4 / IPv6 address you can specify it as a tuple / string / binary:

{ok, ResultMap} = geoip2:lookup(city, "8.8.8.8").

To quickly extract just an interesting part of information from returned map you can use get (throws error) or find (returns error | {ok, Value}) functions :

{ok, Result} = geoip2:find([country, iso_code], ResultMap).

or

Result = geoip2:get([country, iso_code], ResultMap, <<"EN">>)

If you are interested only in specified part of information you can use "combo" versions of get or find functions:

{ok, Result} = geoip2:find(city, [country, iso_code], "8.8.8.8").

To dynamically add instance of geoip2 server use:

geoip2:start(country, "./GeoIP2-Country.mmdb").

There are also stop and restart functions available.

License

This library is licensed under the MIT license.

geoip2-erl's People

Contributors

ssmyczynski avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.