fxa/README.md в f88ac809847a758bc986b05a6118f0e8100cfe71

3.7 KiB

Исходник Ответственный История

Firefox Accounts GeoDB Repo for Geolocation based services

Provides a wrapper around node-maxmind for getting the location data in an easy-to-read format.

Getting started

Install the module by running npm install fxa-geodb --save. Then, include the module in your source file, like so:

var geoDb = require('fxa-geodb')();

You can also pass other options like the path to the database to the require statement, like so:

var geoDb = require('fxa-geodb')({
  dbPath: 'cities-db.mmdb' // Defaults to fxa-geodb/db/cities-db.mmdb
});

API

The function returns a location object or throws if the ip was invalid or location data could not be found. Call the function like so:

try {
  const location = geoDb(ip);
  // Use location...
} catch (err) {
  // Handle err
}

The location object has the following properties:

accuracy: Accuracy radius in km (number)
city: Human readable city name (string)
state: Human readable state name (string)
stateCode: ISO 3166-2 state code (string)
country: Human readable country name (string)
countryCode: ISO 3166-1 alpha-2 country code (string)
continent: Human readable continent name (string)
timeZone: IANA tz database timezone (string)
latLong: An object containing two properties:
- latitude: Latitude (number)
- longitude: Longitude (number)

For example:

{
  accuracy: 5,
  city: 'Mountain View',
  state: 'California',
  stateCode: 'CA',
  country: 'United States',
  countryCode: 'US',
  continent: 'North America',
  timeZone: 'America/Los_Angeles'
  latLong: {
    latitude: 37.3885,
    longitude: -122.0741
  }
}

A working example is provided in the examples directory.

Testing

Mocha Tests are located in the test subdirectory. To run the tests, call npm test.

Code Coverage

Code coverage is provided with nyc, to run coverage, call npm run-script cover

Updating

A Cron job is provided in lib/maxmind-db-downloader, that can be configured and run like so:

  var maxmindDbDownloader = new MaxmindDbDownloader();
  var targetDirPath = maxmindDbDownloader.createTargetDir('db-name');
  var downloadPromiseFunctions = maxmindDbDownloader.setupDownloadList(
    path.join(__dirname, '..','path-to-sources-file'),
    targetDirPath
  );
  maxmindDbDownloader.setupAutoUpdate('30 30 1 * * 3', downloadPromiseFunctions);

By default, the cron job runs every week on Wednesday at 01:30:30 (UTC -7) and updates the Geodata-DB from Maxmind.

Getting involved

Interested in contributing to the development of Firefox Accounts GeoDB repo? Great! Head over to the #fxa:mozilla.org room on Matrix with questions, or jump ahead and fix any of the issues we have.

Please review and understand the Mozilla Community Participation Guidelines before contributing to this project. Also, following the commit guidelines is greatly appreciated.

UPDATE: On March 2020, Mozilla moved from IRC to Matrix. For more information on Matrix, check out the following wiki article: https://wiki.mozilla.org/Matrix.

Submitting bugs

You can file issues here on GitHub. Please try to include as much information as you can and under what conditions you saw the issue.

Attribution

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

License

MPL 2.0

3.7 KiB Исходник Ответственный История