beefo

mg-api-node

module.exports = function (u, p, d, s, o, sId) {

        rootServer = s || 'my.geotab.com',

            ssl: !o || o.ssl === undefined ? true : o.ssl,

            compression: o && o.hasOwnProperty('compression') ? o.compression : 'gzip'

        throw new Error('Must supply userName')

        if (!database || directServer === 'my.geotab.com') {

            throw new Error('Must supply database and server')

            throw new Error('Must supply database')

        throw new Error('Must supply password')

    var post = function (method, params, callback, timeout, timeoutCallback) {

        var paramsStr = getRpc(method, params);

        var option = getOptions(method, paramsStr);

        var done = function (err, data) {

                    callback("no data returned");

                    callback(data.error);

                callback(null, data.result);

        var post_req = (options.ssl ? https : http).request(option, function (res) {

            var encoding = res.headers['content-encoding'];

            if (res.statusCode !== 200) {

                    name: res.statusCode.toString(),

                    message: http.STATUS_CODES[res.statusCode]

            // pipe the response into the gunzip to decompress

                response = zlib.createGunzip();

            response.on('data', function (data) {

                // decompression chunk ready, add it to the chunks

                chunks.push(data.toString())

            response.on('end', function () {

                // response and decompression complete, join the buffer and return

                done(null, chunks.join(''));

            response.on('error', function (e) {

        // If timeout was provided and requesting with http, we add a timeout to the request

        if (typeof timeout === 'number' && !options.ssl){

            typeof timoutCallback === 'function' ? post_req.setTimeout(timeout, timeoutCallback) : post_req.setTimeout(timeout);

        post_req.on('error', function (err) {

    var getOptions = function (method, post_data) {

        var thisServer = (method === 'authenticate' ? rootServer : directServer).replace(/\S*:\/\//, '').replace(/\/$/, '');

                'Content-Type': 'application/x-www-form-urlencoded',

                'Content-Length': post_data.length

            opts.headers['Accept-Encoding'] = options.compression;

    var getRpc = function (method, params, callback) {

  "description": "Unofficial nodejs client for the MyGeotab API",

  "description": "Nodejs client for the MyGeotab API",

    "url": "https://github.com/Geotab/mg-api-node.git"

  "author": "Steve Hansen <beefo@hotmail.com>",

# This project has been deprecated. Please use [mg-api-js](https://github.com/Geotab/mg-api-js).

Unofficial nodejs client for the MyGeotab API

var api = new API(userName, password, database);

If you need to handle potential slow HTTP requests, you can access [request.setTimeout](https://nodejs.org/api/http.html#http_request_settimeout_timeout_callback) by passing an optional timeout (ms) and timeoutCallback to `api.call()` and `api.multicall()`:

var api = new API(userName, password, database, server, {ssl: false}, sessionId);

It's also possible to supply session ID and direct server to re-use a session ID. This avoids costly authentication.

var api = new API(userName, password, database, server, options, sessionId);

        message: 'Incorrect MyGeotab login credentials @ \'g560\'',

    var validateSuccess = function (err, data, server) {

        expect(data.path).to.be.a('string');

        expect(data.path).to.equal(server);

        expect(data.credentials).to.be.a('object');

        expect(data.credentials).to.have.property('userName');

        expect(data.credentials.userName).to.be.a('string').and.to.equal(userName);

        expect(data.credentials).to.have.property('sessionId');

        expect(data.credentials.sessionId).to.be.a('string');

        expect(data.credentials).to.have.property('database');

        expect(data.credentials.database).to.be.a('string').and.to.equal(database);

    it('creates API without userName', function () {

        expect(API).to.throw('Must supply userName');

    it('creates API without password', function () {

        expect(API.bind(API, userName)).to.throw('Must supply password');

    it('creates API without session id or password', function () {

    it('creates API with session id but no database or server', function () {

        expect(API.bind(API, userName, null, null, null, null, sessionId)).to.throw('Must supply database and server');

        expect(API.bind(API, userName, null, null, null, null, sessionId)).to.throw('Must supply database');

    it('creates API with session id and a database but no server', function () {

        expect(API.bind(API, userName, null, database, null, null, sessionId)).to.throw('Must supply database and server');

        expect(API.bind(API, userName, null, database, null, null, sessionId)).to.not.throw();

    it('creates API with session id and a server but no database', function () {

        expect(API.bind(API, userName, null, null, server, null, sessionId)).to.throw('Must supply database and server');

        expect(API.bind(API, userName, null, null, server, null, sessionId)).to.throw('Must supply database');

    it('creates API with session id and a database, but a server that equals "my.geotab.com"', function () {

        expect(API.bind(API, userName, null, database, "my.geotab.com", null, sessionId)).to.throw('Must supply database and server');

        expect(API.bind(API, userName, null, database, "my.geotab.com", null, sessionId)).to.not.throw();

    it('creates API with session id, server, and database', function () {

        api = new API(userName, null, database, server, null, sessionId);

        expect(api.credentials.userName).to.be.a('string');

    it('authenticate without callback', function () {

        api = new API(userName, password, database, server);

        expect(api.authenticate).to.throw('Must provide callback');

    it('authenticate against unknown server', function (done) {

        api = new API(userName, password, database, 'my10000.geotab.com');

        api.authenticate(function (err, data) {

            expect(err).to.be.a('object');

            expect(err.code).to.be.a('string').and.to.equal('ENOTFOUND');

    it('handles non 200 response', function (done) {

        nock('https://www.example.com').post('/apiv1').reply(404);

        api = new API(userName, password, database, 'www.example.com');

            expect(err.message).to.be.a('string');

            expect(err.message).to.equal('Not Found');

            expect(err.name).to.be.a('string');

            expect(err.name).to.equal('404');

    it('authenticates a user successfully [userName, password]', function (done) {

        nock('https://my.geotab.com').post('/apiv1').reply(200, credentialsResult);

        api = new API(userName, password);

            validateSuccess(err, data, server);

    it('authenticates a user successfully [userName, password, database]', function (done) {

        api = new API(userName, password, database);

    it('authenticates a user successfully [userName, password, database, server]', function (done) {

        credentialsResult.result.path = 'ThisServer';

        nock('https://my3.geotab.com').post('/apiv1').reply(200, credentialsResult);

            validateSuccess(err, data, 'ThisServer');

            credentialsResult.result.path = 'my3.geotab.com';

    it('authenticates with invalid credentials', function (done) {

        nock('https://my.geotab.com').post('/apiv1').reply(200, invalidUserError);

        api = new API('foo@bar.com', password, database);

            expect(err).to.deep.equal(invalidUserError.error);

		@@ -23,4 +23,4 @@ var https = require('https');
		if (!!sessionId) {
		if (!database \|\| directServer === 'my.geotab.com') {
		throw new Error('Must supply database and server')
		if (!database) {
		throw new Error('Must supply database')
		}
		@@ -27,0 +27,0 @@

		{
		"name": "mg-api-node",
		"version": "1.3.0",
		"description": "Unofficial nodejs client for the MyGeotab API",
		"version": "1.3.1",
		"description": "Nodejs client for the MyGeotab API",
		"main": "api.js",
		@@ -6,0 +6,0 @@ "devDependencies": {

Fixed alerts

Improved metrics

Worsened metrics

		@@ -65,15 +65,15 @@ var expect = require('chai').expect;
		it('creates API with session id but no database or server', function () {
		expect(API.bind(API, userName, null, null, null, null, sessionId)).to.throw('Must supply database and server');
		expect(API.bind(API, userName, null, null, null, null, sessionId)).to.throw('Must supply database');
		});

		it('creates API with session id and a database but no server', function () {
		expect(API.bind(API, userName, null, database, null, null, sessionId)).to.throw('Must supply database and server');
		expect(API.bind(API, userName, null, database, null, null, sessionId)).to.not.throw();
		});

		it('creates API with session id and a server but no database', function () {
		expect(API.bind(API, userName, null, null, server, null, sessionId)).to.throw('Must supply database and server');
		expect(API.bind(API, userName, null, null, server, null, sessionId)).to.throw('Must supply database');
		});

		it('creates API with session id and a database, but a server that equals "my.geotab.com"', function () {
		expect(API.bind(API, userName, null, database, "my.geotab.com", null, sessionId)).to.throw('Must supply database and server');
		expect(API.bind(API, userName, null, database, "my.geotab.com", null, sessionId)).to.not.throw();
		});
		@@ -80,0 +80,0 @@