Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 3.72 KB

README.md

File metadata and controls

105 lines (81 loc) · 3.72 KB
Raw

clj-geoip

Build Status

clj-geoip is a thin Clojure layer on top of the legacy MaxMind GeoIP Java API. It allows you to query information like the country, city or network provider of a given IP. Have a look at the usage section for an example.

The new version can be found at GeoIP2.

"This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com/."

Preparation

To use clj-geoip you first need to download the newest version of the free GeoIP data files. To do so you can use the download script UpdateGeoIpFiles.sh provided in the scripts folder. It simply downloads the newest archives and extracts them into the resources folder.

MaxMind provides new versions of the data files on a monthly basis. So it's a good idea to run the script every now and then.

Usage

This API is pretty simple, just have a look at the following code:

user> (use 'clojure.pprint)
nil
user> (require ['de.bertschneider.clj-geoip.core :refer :all])
nil
user> (def mls (multi-lookup-service))
#'user/mls
user> (pprint (lookup mls "87.152.91.74"))
{:timezone "Europe/Berlin",
 :ip "87.152.91.74",
 :area-code 0,
 :dma-code 0,
 :city "Lindlar",
 :country-code "DE",
 :metro-code 0,
 :longitude 7.366501,
 :postal-code "51789",
 :region "Nordrhein-Westfalen",
 :org "AS3320 Deutsche Telekom AG",
 :latitude 51.033203,
 :country-name "Germany"}
user=> (pprint (lookup mls "2a00:1450:8003::93"))
{:timezone "Europe/Dublin",
 :ip "2a00:1450:8003::93",
 :area-code 0,
 :dma-code 0,
 :city nil,
 :country-code "IE",
 :metro-code 0,
 :longitude -8.0,
 :postal-code nil,
 :region nil,
 :org "AS15169 Google Inc.",
 :latitude 53.0,
 :country-name "Ireland"}
user> (close mls)
nil

Use lookup-service to create a lookup service from a specific db file or multi-lookup-service to create one from both db files. Afterwards the service can be used to look up IPv4 and IPv6 addresses.

During the creation of a lookup-service or multi-lookup-service one or more of the following cache options can be specified and will be passed through to the MaxMind LookupService. :standard, :memory-cache, :check-cache, :index-cache

Ring Handler

You can use the provided ring handler to add location information to the request map. Here is a Noir example:

(use 'de.bertschneider.clj-geoip.handler)
(add-middleware #'geoip-handler)
(defpage "/" []
    (str (:location (ring-request))))
;; -> {:country-name "United States", :area-code 650, :longitude -122.0574 ... }

Dependencies

This library can be used as dependency in your leiningen project:

Clojars Project

Please note, that the jar does not contain any database files.

Changelog

Version 0.2

  • Moved code to namespace de.bertschneider.clj-geoip.
  • Removed global lookup service in favor of the Lookupable protocol so that geoip-init is not needed anymore.
  • Added :timezone and :region to the lookup map.
  • Renamed some keywords in the returned map from the lookup function to more clojure idiomatic names.
  • Cache options can be provided during the initialization (:standard, :memory-cache, :check-cache, :index-cache).

License

Copyright (C) 2012--2014

Distributed under the Eclipse Public License, the same as Clojure.