Github-user-details NPM

User Details

Get user details for one or more users.

Installation

$ npm install github-user-details

Usage

var userinfo = require( 'github-user-details' );

userinfo( opts, clbk )

Gets user details for one or more users.

var opts = {
	'usernames': [
		'kgryte',
		'planeshifter',
		'unknown_username'
	]
};

userinfo( opts, clbk );

function clbk( error, results, info ) {
	// Check for rate limit information...
	if ( info ) {
		console.error( 'Limit: %d', info.limit );
		console.error( 'Remaining: %d', info.remaining );
		console.error( 'Reset: %s', (new Date( info.reset*1000 )).toISOString() );
	}
	if ( error ) {
		throw new Error( error.message );
	}
	console.dir( results );
	/*
		{
			"meta": {
				"total": 3,
				"success": 2,
				"failure": 1
			},
			"data": {
				"kgryte": {...},
				"planeshifter": {...}
			},
			"failures": {
				"unknown_username": "Not Found"
			}
		}
	*/
}

The function accepts the following options:

usernames: array of Github usernames (required).
token: Github access token.
useragent: user agent string.

To authenticate with Github, set the token option.

var opts = {
	'usernames': ['kgryte'],
	'token': 'tkjorjk34ek3nj4!'
};

userinfo( opts, clbk );

To specify a user agent, set the useragent option.

var opts = {
	'usernames': ['kgryte','planeshifter'],
	'useragent': 'hello-github!'
};

userinfo( opts, clbk );

userinfo.factory( options, clbk )

Creates a reusable function.

var opts = {
	'usernames': ['kgryte','planeshifter'],
	'token': 'tkjorjk34ek3nj4!'
};

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

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

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

Notes

If the module encounters an application-level error (e.g., no network connection, etc), that error is returned immediately to the provided callback.
If the module encounters a downstream error (e.g., timeout, reset connection, etc), that error is included in the returned results under the failures field.
Rate limit information includes the following:
- limit: maximum number of requests a consumer is permitted to make per hour.
- remaining: number of remaining requests.
- reset: time at which the current rate limit window resets in UTC seconds.

Examples

var userinfo = require( 'github-user-details' );

var opts = {
	'usernames': [
		'kgryte',
		'planeshifter',
		'rgizz'
	],
	'useragent': 'beep-boop-bop'
};

userinfo( opts, clbk );

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

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

$ DEBUG=* node ./examples/index.js

CLI

Installation

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

$ npm install -g github-user-details

Usage

Usage: ghuserinfo [options] user1 user2 ...

Options:

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

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.
If a user's details are successfully resolved, the user info is written to stdout.
If a user's details cannot be resolved due to a downstream error (failure), the username (and its associated error) is written to sterr.
Output order is not guaranteed to match input order.
Rate limit information is written to stderr.

Examples

Setting the access token using the command-line option:

$ DEBUG=* ghuserinfo --token <token> kgryte planeshifter
# => {...}

Setting the access token using an environment variable:

$ DEBUG=* GITHUB_TOKEN=<token> ghuserinfo kgryte planeshifter
# => {...}

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

$ DEBUG=* ./node_modules/.bin/ghuserinfo --token <token> kgryte planeshifter
# => {...}

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> kgryte planeshifter
# => {...}

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: