https://github.com/huehodaniel/ip2location-elixir
IP2Location API for Elixir
https://github.com/huehodaniel/ip2location-elixir
elixir geolocation ip2location ip2location-database
Last synced: 9 months ago
JSON representation
IP2Location API for Elixir
- Host: GitHub
- URL: https://github.com/huehodaniel/ip2location-elixir
- Owner: huehodaniel
- License: lgpl-3.0
- Created: 2017-02-05T09:08:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-09T22:25:36.000Z (over 9 years ago)
- Last Synced: 2025-09-07T03:58:17.029Z (10 months ago)
- Topics: elixir, geolocation, ip2location, ip2location-database
- Language: Elixir
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IP2Location-Elixir
Interface for accessing IP2Location Binary Format databases.
**This is unstable software, and not officially vetted by IP2Location or anybody else.** You have been warned.
## Implementation details
This is mostly a port of the [official Erlang library](https://github.com/IP2Location/IP2Location-erlang),
with three main differences:
- It uses binary strings instead of charlists (as is common with Elixir libraries).
- It returns structs instead of records (again, as usual).
- It accepts the raw binary rather than directly using file IO, giving a very small speed bonus at a massive
memory cost. This library is therefore almost useless except for regional databases. Due to how large
binaries are stored in the BEAM VM heap (using refcounting), once you load a binary database it should
be safe to send it across processes without memory copying.
## Installation
The package can be installed by adding `ip2location_elixir` to your list of dependencies in `mix.exs`.
As of now, this library does not set a OTP application, so you have to tell Mix that when building your project:
```elixir
def deps do
[{:ip2location_elixir, "~> 0.1.0", app: false}]
end
```
## Usage
```elixir
# Load your file
raw = File.read!("path/to/database.bin")
# Prepare headers for use
db = IP2Location.read_database(raw)
# Alternatively you can just use the `open_database!/1` shortcut
# db = IP2Location.open_database!("path/to/database.bin")
# Grab your stuff
%IP2Location.Record{city: city} = IP2Location.query(db, "some IP")
```
## License
See [LICENSE](LICENSE)