offline-geo-from-ip/lib/offline-geo-from-ip.js

Get geo location information from an IP address

// get node packages
const debug = require('debug')('offline-geo-from-ip:main')
const path = require('path')
const mmdbreader = require('maxmind-db-reader')

const city = mmdbreader.openSync(
  path.resolve(path.join(__dirname, '/../database/geolite2-city.mmdb'))
)

debug(`offline-geo-from-ip ready for action!`)

/**
 * get all data about an IP
 * @param  {String} ip ip address
 * @return {Object}    result object containing all the data
 */
function allData(ip) {
  debug(`allData function called with ip: ${ip}`)
  // get all data for ip
  const geodata = city.getGeoDataSync(ip)
  const result = {
    code: {}
  }

  // consolidate data based on type
  if (geodata) {
    debug(`got location, consolidating`)
    // city
    if (geodata.city) {
      result.city = geodata.city.names.en
    } else {
      result.city = null
    }
    // state
    if (geodata.subdivisions) {
      result.state = geodata.subdivisions[0].names.en
      result.code.state = geodata.subdivisions[0].iso_code
    } else {
      result.state = null
      result.code.state = null
    }
    // country
    if (geodata.country) {
      result.country = geodata.country.names.en
      result.code.country = geodata.country.iso_code
    }
    // continent
    if (geodata.continent) {
      result.continent = geodata.continent.names.en
      result.code.continent = geodata.continent.code
    }
    // postal
    if (geodata.postal) {
      result.postal = geodata.postal.code
    }
    // location
    if (geodata.location) {
      result.location = geodata.location
    }
  } else {
    // error
    debug(`🚨 could not get location, sorry!`)
    result.error = 'NA'
    result.ip = ip
  }

  debug(`returning location result: ${JSON.stringify(result)}`)
  // return result
  return result
}

// export
module.exports.allData = allData