Merge pull request #34 from runk/db-options

create option to set which dbs are downloaded

Author: Dmitry Shirokov

.gitignore

@@ -37,3 +37,5 @@ package-lock.json
 # Optional REPL history
 .node_repl_history
 dbs/*
+
+.DS_Store

README.md

@@ -5,6 +5,8 @@ Maxmind's GeoLite2 Free Databases download helper.
 
 ## Configuration
 
+### Access Key
+
 **IMPORTANT** You must setup `MAXMIND_LICENSE_KEY` environment variable be able to download databases. To do so, go to the https://www.maxmind.com/en/geolite2/signup, create a free account and generate new license key.
 
 If you don't have access to the environment variables during installation, you can provide license key via `package.json`:
@@ -24,6 +26,25 @@ If you don't have access to the environment variables during installation, you c
 
 Beware of security risks of adding keys and secrets to your repository!
 
+### Selecting databases to download
+
+You can select the dbs you want downloaded by adding a `selected-dbs` property on `geolite2` via `package.json`.
+
+`selected-dbs` must be an array of strings, one or more of the values `City`, `Country`, `ASN`.
+
+If `selected-dbs` is unset, or is set but empty, all dbs will be downloaded.
+
+```jsonc
+{
+  ...
+  "geolite2": {
+    "selected-dbs": ["City", "Country", "ASN"]
+  }
+  ...
+}
+```
+
+
 ## Usage
 
 ```javascript

index.js

@@ -1,9 +1,15 @@
-var path = require("path");
+const path = require("path");
+
+const {selectedDbs} = require('./utils');
+const selected = selectedDbs();
+
+const makePath = (type) => path.resolve(__dirname, `dbs/GeoLite2-${type}.mmdb`);
+
+const paths = selected.reduce((a,c) => {
+  a[c.toLowerCase()] = makePath(c);
+  return a;
+}, {});
 
 module.exports = {
-  paths: {
-    city: path.resolve(__dirname, "dbs/GeoLite2-City.mmdb"),
-    country: path.resolve(__dirname, "dbs/GeoLite2-Country.mmdb"),
-    asn: path.resolve(__dirname, "dbs/GeoLite2-ASN.mmdb")
-  }
+  paths
 };

scripts/postinstall.js

@@ -1,40 +1,13 @@
 const fs = require('fs');
 const https = require('https');
 const zlib = require('zlib');
-const path = require('path');
 const tar = require('tar');
-
-const getConfig = () => {
-  const packageJsonFilename = path.join(
-    process.env['INIT_CWD'],
-    'package.json'
-  );
-  const packageJson = JSON.parse(fs.readFileSync(packageJsonFilename, 'utf8'));
-  return packageJson['geolite2'] || {};
-};
-
-const keyLoaders = [
-  () => process.env.MAXMIND_LICENSE_KEY,
-  () => getConfig()['license-key'],
-  () => {
-    const configFile = getConfig()['license-file'];
-    if (!configFile) return;
-
-    const filepath = path.join(process.env['INIT_CWD'], configFile);
-    return fs.existsSync(filepath)
-      ? fs.readFileSync(filepath, 'utf8').trim()
-      : undefined;
-  },
-];
+const path = require('path');
+const {getLicense, selectedDbs} = require('../utils');
 
 let licenseKey;
-
 try {
-  let i = 0;
-  while (i < keyLoaders.length) {
-    licenseKey = keyLoaders[i++]();
-    if (licenseKey) break;
-  }
+  licenseKey = getLicense();
 } catch (e) {
   console.error('geolite2: Error retrieving Maxmind License Key');
   console.error(e.message);
@@ -62,11 +35,14 @@ if (!licenseKey) {
 const link = (edition) =>
   `https://download.maxmind.com/app/geoip_download?edition_id=${edition}&license_key=${licenseKey}&suffix=tar.gz`;
 
+
+const selected = selectedDbs();
 const links = [
-  link('GeoLite2-City'),
-  link('GeoLite2-Country'),
-  link('GeoLite2-ASN'),
-];
+  'City',
+  'Country',
+  'ASN',
+].filter(e => selected.includes(e))
+ .map(e => link(`GeoLite2-${e}`));
 
 const downloadPath = path.join(__dirname, '..', 'dbs');
 

utils.js

@@ -0,0 +1,61 @@
+const path = require('path');
+const fs = require('fs');
+
+const cwdPath = (file) => path.join(process.env['INIT_CWD'] || process.cwd(), file);
+
+const getConfig = () => {
+  const packageJsonFilename = cwdPath('package.json');
+  const packageJson = require(packageJsonFilename);
+  return packageJson['geolite2'] || {};
+};
+
+const getLicense = () => {
+  const envKey = process.env.MAXMIND_LICENSE_KEY;
+  if(envKey) return envKey;
+  
+  const config = getConfig();
+  const licenseKey = config['license-key'];
+  if(licenseKey) return licenseKey;
+
+  const configFile = config['license-file'];
+  if(!configFile) return;
+
+  const configFilePath = cwdPath(configFile);
+  return fs.existsSync(configFilePath) 
+       ? fs.readFileSync(configFilePath, 'utf8').trim()
+       : undefined;
+}
+
+const selectedDbs = () => {
+  const config = getConfig();
+  const selected = config['selected-dbs'];
+  const valids = ['City', 'Country', 'ASN'];
+  if(!selected) return valids;
+  if(!Array.isArray(selected)) {
+    console.error('selected-dbs property must have be an array.');
+    process.exit(1);
+  }
+
+  if(selected.length === 0) return valids;
+
+  if(selected.length > 3) {
+    console.error('selected-dbs has too many values, there are only three valid values: City, Country, ASN.');
+    process.exit(1);
+  }
+
+  for(const value of selected) {
+    const index = valids.indexOf(value);
+    if(index === -1) {
+      console.error(`Invalid value in selected-dbs: ${value}. The only valid values are: City, Country, ASN.`);
+      process.exit(1);
+    }
+  }
+
+  return selected;
+}
+
+module.exports = {
+  getConfig,
+  getLicense,
+  selectedDbs
+}