@tomasperezv/node-api-client v1.0.0

node-api-client2

A node.js library for creating clients for different HTTP API's, it includes a cache layer.

Example

Example of how to create an API client for the Google Maps API:

var ApiClient = require('../core/api/api-client');

var GoogleApiClient = function() {

  ApiClient.call(this);

  /**
   * @type {String} _clientId
   * @private
   */
  this._clientId = 'maps-directions';

  // Override the default parameters
  this._baseUrl = '';
  this._defaultParameters.key = '';

};

GoogleApiClient.prototype = new ApiClient();

/**
 * @param {Object} origin
 *  {Float} latitude
 *  {Float} longitude
 ** @param {Object|String} destination
 *  {Float} latitude
 *  {Float} longitude
 * @param {Function} onComplete
 * @method directions
 * @public
 */
GoogleApiClient.prototype.directions = function(origin, destination, onComplete) {

  origin = origin.latitude + ',' + origin.longitude;

  if (typeof destination === 'object') {
    destination = destination.latitude + ',' + destination.longitude;
  }

  var cacheKey = this._getMCKey(origin, destination + '10');

  var parameters = {
    origin: origin,
    destination: destination
  };

  // Requests to the google maps api need to go through https,
  // for that reason we use the useHTTPS boolean.
  this.GET(parameters, cacheKey, onComplete, true);
};