skyhook.js

/*
Name:          skyhook-api
Description:   Lookup IP-address details at Skyhook API
Author:        Franklin van de Meent (https://frankl.in)
Source:        https://github.com/fvdm/nodejs-skyhook
Feedback:      https://github.com/fvdm/nodejs-skyhook/issues
License:       Unlicense (Public Domain)
               See https://github.com/fvdm/nodejs-skyhook/raw/master/LICENSE
*/

'use strict';

const httpreq = require ('httpreq');

let app = {
  user: null,
  key: null,
  timeout: 5000
};


/**
 * Process API response
 *
 * @callback callback
 * @param err {Error, null} - Error
 * @param res {object} - Response data
 * @param callback {function} - `function (err, data) {}`
 * @return {void}
 */

function processResponse (err, res, callback) {
  let data = res && res.body || '';
  let error = null;

  try {
    data = JSON.parse (data);
  } catch (e) {
    error = new Error ('invalid data');
    error.data = data;
  }

  if (err) {
    error = new Error ('request failed');
    error.error = err;
  }

  if (data.error) {
    error = new Error ('api error');
    error.code = data.error.code;
    error.text = data.error.message;
  }

  if (error) {
    error.statusCode = res && res.statusCode;
    callback (error);
  } else {
    data = data.data || data;
    callback (null, data);
  }
}


/**
 * Communicate with API
 *
 * @callback callback
 * @param ip {string} - IP-address to lookup
 * @param callback {function} - `function (err, data) {}`
 * @return {void}
 */

function getIP (ip, callback) {
  const options = {
    url: 'https://context.skyhookwireless.com/accelerator/ip',
    method: 'GET',
    timeout: app.timeout,
    parameters: {
      version: '2.0',
      ip: ip,
      user: app.user,
      key: app.key,
      timestamp: Math.round (Date.now () / 1000)
    },
    headers: {
      'User-Agent': 'npmjs.com/package/skyhook-api',
      'Accept': 'application/json'
    }
  };

  httpreq.doRequest (options, (err, res) => {
    processResponse (err, res, callback);
  });
}


/**
 * Module interface
 *
 * @param user {string} - Username/email
 * @param key {string} - API key
 * @param [timeout = 5000] - Request time out in ms, 1000 = 1 sec
 * @return getIP {function}
 */

module.exports = (user, key, timeout) => {
  app.user = user;
  app.key = key;
  app.timeout = timeout || app.timeout;
  return getIP;
};