github-user-rate-limit v1.0.1

Rate Limit

Get a user's rate limit status.

Installation

$ npm install github-user-rate-limit

Usage

var ratelimit = require( 'github-user-rate-limit' );

ratelimit( opts, clbk )

Gets a user's rate limit status.

var opts = {
	'token': 'tkjorjk34ek3nj4!'
};

ratelimit( opts, clbk );

function clbk( error, status ) {
	if ( error ) {
		throw new Error( error.message );
	}
	console.dir( status );
	/*
		{
			"core": {
				"limit": 5000,
				"remaining": 4999,
				"reset": 1372700873 // UTC seconds
			},
			"search": {
				"limit": 30,
				"remaining": 18,
				"reset": 1372697452 // UTC seconds
			}
		}
	*/
}

The function accepts the following options:

• token: Github access token (required).
• useragent: user agent string.

To authenticate with Github, set the token option.

var opts = {
	'token': 'tkjorjk34ek3nj4!'
};

ratelimit( opts, clbk );

To specify a user agent, set the useragent option.

var opts = {
	'token': 'tkjorjk34ek3nj4!',
	'useragent': 'hello-github!'
};

ratelimit( opts, clbk );

ratelimit.factory( options, clbk )

Creates a reusable function.

var opts = {
	'token': 'tkjorjk34ek3nj4!',
	'useragent': 'hello-github!'
};

var get = ratelimit.factory( opts, clbk );

get();
get();
get();
// ...

The factory method accepts the same options as ratelimit().

Examples

var ratelimit = require( 'github-user-rate-limit' );

var opts = {
	'token': 'tkjorjk34ek3nj4!',
	'useragent': 'beep-boop-bop'
};

ratelimit( opts, clbk );

function clbk( error, status ) {
	if ( error ) {
		throw new Error( error.message );
	}
	console.dir( status );
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

Note: in order to run the example, you will need to obtain an access token and modify the token option accordingly.

CLI

Installation

To use the module as a general utility, install the module globally

$ npm install -g github-user-rate-limit

Usage

Usage: ghratelimit [options] 

Options:

  -h,  --help               Print this message.
  -V,  --version            Print the package version.
       --token token        Github access token.
  -ua, --useragent ua       User agent.
       --pretty             Pretty format.

Notes

• In addition to the token option, the token may also be specified by a GITHUB_TOKEN environment variable. The command-line option always takes precedence.
• Rate limit information is written to stdout.

Examples

Setting the access token using the command-line option:

$ DEBUG=* ghratelimit --token <token>
# => {"core":{...},"search":{...}}

Setting the access token using an environment variable:

$ DEBUG=* GITHUB_TOKEN=<token> ghratelimit
# => {"core":{...},"search":{...}}

For local installations, modify the command to point to the local installation directory; e.g.,

$ DEBUG=* ./node_modules/.bin/ghratelimit --token <token>
# => {"core":{...},"search":{...}}

Or, if you have cloned this repository and run npm install, modify the command to point to the executable; e.g.,

$ DEBUG=* node ./bin/cli --token <token>
# => {"core":{...},"search":{...}}

To pretty format the rate limit status, set the pretty option.

$ DEBUG=* ghratelimit --token <token> --pretty
#
# core
#   limit: 5000
#   remaining: 4999
#   reset: 2016-02-12T02:11:34.000Z
#
# search
#   limit: 30
#   remaining: 30
#   reset: 2016-02-12T01:25:28.000Z
#

Tests

Unit

This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

Browser Support

This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

$ make test-browsers

To view the tests in a local web browser,

$ make view-browser-tests

License

MIT license.

Copyright

Copyright © 2016. Athan Reines.