lyndsysimon / gab

A wrapper for the gab.ai API

gab.ai

A wrapper for the gab.ai API

Service	Status
CircleCI

If you find this project useful:

Usage

The API is exposed as a single Gab object, which must be initialized with an authorized JWT.

var Gab = require('gab.ai').Gab;

var api = new Gab({
    authToken: '<your JWT>'
})

Once you have an instance of the Gab object, calling each API method will return a Promise object. For example, to get information for a user:

api.getUser('a')
    .then(function(data) {
        console.log(data);
    }).catch(function() {
        console.log('Request failed.');
    });

For information on Promise objects, see the documentation for request-promise.

Running Tests

npm test

gab's Issues

Where do I find my authToken?

I tried using my id_token but that isn't working.

Allow authorization with a username and password instead of a JWT

Existing Behavior:

var api = new Gab({
    authToken: '<your JWT>'
})

Desired Behavior

var api = new Gab({
    username: 'LyndsySimon',
    password: 'NotR3411yMyP4ssw0rd'
})

Allow `#getUser` to work for a user's ID in addition to their username

Current Behavior

api.getUser('LyndsySimon')

Desired Behavior

api.getUser('LyndsySimon')
// OR
api.getUser(60129)

Implement `async` flag in options

When instantiating a new Gab object, passing the option async: false should allow the library to function without returning promises.

var Gab = require('gab.ai').Gab;
var api_client = new Gab({
    authToken: '<your JWT here>',
    async: false
});

api_client.getUser('LyndsySimon');
// { ... }

api_client.getUser('UserThatDoesNotExist');
// ValueError: User does not exist.

wrapper for official API?

but where can I find the official API documents?