trafficlive/lib/trafficLive.js

An API wrapper for TrafficLive

/* jshint node: true, deve: true, browserify: true */
"use strict"
var rest = require("restler")

var trafficLive = function(options) {
  var self = this
  if (!options.token) throw "Token is required"
  if (!options.email) throw "Email is required"

  var hash = new Buffer(options.email + ":" + options.token)
  this.auth = hash.toString("base64")

  this.pageSize = options.pageSize || 25
  this.page = 1
  this.results = []
  this.filter = ""
  this.baseUri = "https://api.sohnar.com/TrafficLiteServer/openapi"

  this.api = {
    employees: {
      related: function(options, callback) {
        callback({})
      },
      all: function(callback) {
        return self.request(rest.get, "/staff/employee", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/staff/employee/" + id, {}, function(
          result
        ) {
          callback(result)
        })
      },
      find: function(filter, callback) {
        self.filter = filter
        return self.request(
          rest.get,
          `/staff/employee/?windowSize=${self.pageSize}&filter=${filter}`,
          {},
          function(result) {
            callback(result)
          }
        )
      },
      tasks: function(id, callback) {
        return self.request(
          rest.get,
          `/staff/employee/${id}/jobtaskallocations`,
          {},
          function(result) {
            callback(result)
          }
        )
      },
      locations: function(callback) {
        return self.request(rest.get, `/staff/location`, {}, function(result) {
          callback(result)
        })
      }
    },
    projects: {
      all: function(callback) {
        return self.request(rest.get, "/project", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/project/" + id, {}, function(result) {
          callback(result)
        })
      }
    },
    chargebands: {
      all: function(callback) {
        return self.request(rest.get, "/chargeband", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/chargeband/" + id, {}, function(
          result
        ) {
          callback(result)
        })
      }
    },
    departments: {
      all: function(callback) {
        return self.request(rest.get, "/staff/department", {}, function(
          result
        ) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "	/staff/department/" + id, {}, function(
          result
        ) {
          callback(result)
        })
      }
    },
    tasks: {
      all: function(callback) {
        return self.request(rest.get, "/timeallocations/jobtasks", {}, function(
          result
        ) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(
          rest.get,
          "/timeallocations/jobtasks/" + id,
          {},
          function(result) {
            callback(result)
          }
        )
      }
    },
    invoices: {
      all: function(callback) {
        return self.request(rest.get, "/invoice", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/invoice/" + id, {}, function(result) {
          callback(result)
        })
      }
    },
    clients: {
      all: function(callback) {
        return self.request(rest.get, "/crm/client", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/crm/client/" + id, {}, function(
          result
        ) {
          callback(result)
        })
      }
    },
    quotes: {
      all: function(callback) {
        return self.request(rest.get, "/quote", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/quote/" + id, {}, function(result) {
          callback(result)
        })
      }
    },
    allocations: {
      all: function(callback) {
        return self.request(rest.get, "/timeallocations/jobtasks", {}, function(
          result
        ) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(
          rest.get,
          "/timeallocations/jobtasks/" + id,
          {},
          function(result) {
            callback(result)
          }
        )
      },
      find: function(filter, callback) {
        self.filter = encodeURIComponent(filter)
        return self.request(
          rest.get,
          `/timeallocations/jobtasks/?windowSize=${self.pageSize}&filter=${self.filter}`,
          {},
          function(result) {
            callback(result)
          }
        )
      }
    },
    entries: {
      all: function(callback) {
        return self.request(rest.get, "/timeentries", {}, function(result) {
          callback(result)
        })
      },
      find: function(filter, callback) {
        if (typeof callback != "function") {
          callback = filter
          filter = ""
        }
        self.filter = filter
        return self.request(rest.get, `/timeentries`, {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/timeentries/" + id, {}, function(
          result
        ) {
          callback(result)
        })
      }
    },
    lists: {
      items: function(type, callback) {
        return self.request(rest.get, "/listitem/" + type, {}, function(
          result
        ) {
          callback(result)
        })
      }
    },
    tags: {
      all: function(callback) {
        return self.request(rest.get, "/tag", {}, function(result) {
          callback(result)
        })
      }
    },
    jobs: {
      all: function(callback) {
        return self.request(rest.get, "/job", {}, function(result) {
          callback(result)
        })
      },
      one: function(id, callback) {
        return self.request(rest.get, "/job/" + id, {}, function(result) {
          callback(result)
        })
      },
      allDetails: function(callback) {
        return self.request(rest.get, "/jobdetail/", {}, function(result) {
          callback(result)
        })
      },
      oneDetail: function(id, callback) {
        return self.request(rest.get, "/jobdetail/" + id, {}, function(result) {
          callback(result)
        })
      }
    }
  }
  return this.api
}

trafficLive.prototype.request = function(fn, uri, q, callback) {
  var self = this
  var request = this.baseUri + uri

  var options = {
    query: {
      windowSize: this.pageSize,
      currentPage: this.page,
      filter: this.filter
    },
    headers: {
      "Content-Type": "application/json",
      Authorization: "Basic " + this.auth,
      Accept: "application/json",
      Host: "api.sohnar.com",
      "X-Target-URI": "https://api.sohnar.com"
    }
  }
  options.query = Object.assign(options.query, q)
  var payload = {
    data: {},
    error: false,
    message: "",
    count: 0
  }

  fn(request, options)
    .on("400", function() {
      payload.message =
        "bad request: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again."
    })
    .on("401", function() {
      payload.message =
        "no authorization: This can happen when you try to read or write to objects that the user does not have access to. The API key and request syntax were valid but the server is refusing to complete the request."
    })
    .on("403", function() {
      payload.message =
        "forbidden: This can happen when you try to read or write to objects that the user does not have access to. The API key and request syntax were valid but the server is refusing to complete the request."
    })
    .on("404", function() {
      payload.message =
        "not found: Either the object specified by the request does not exist, or the request method and path supplied do not specify a known action in the API."
    })
    .on("500", function() {
      payload.message =
        "internal server error: There was a problem on TrafficLIVE`s end."
    })
    .on("502", function() {
      payload.message = "bad gateway: There was a problem on TrafficLIVE`s end."
    })
    .on("503", function() {
      payload.message =
        "service unavailable: TrafficLIVE API imposes a limit on the rate at which users can make requests. The limit is currently 120 request per minute."
    })
    .on("complete", function(result) {
      if (typeof result == "string") {
        payload.error = true
        callback(payload)
      } else {
        if (result.resultList) {
          self.results = self.results.concat(result.resultList)
        } else {
          self.results = self.results.concat(result)
        }
        if (!result.maxResults) {
          result.maxResults = 1
        }

        if (result.maxResults > self.page * self.pageSize) {
          console.log(self.page)
          self.page++
          self.request(fn, uri, q, function(result) {
            callback(result)
          })
        } else {
          payload.data = self.results
          payload.count = self.results.length
          console.log(self.results.length + " of " + result.maxResults)
          callback(payload)
        }
      }
    })
}
module.exports = trafficLive