github-rank-users v1.0.2

Rank Users

Rank users.

Installation

$ npm install github-rank-users

Usage

var rank = require( 'github-rank-users' );

rank( data, opts, clbk )

Ranks users provided a user detail input data array.

var data = [
	{
		'login': 'beep',
		'followers': 9,
		// ...user details
	},
	{
		'login': 'boop',
		'followers': 10,
		// ...user details
	}
];

var opts = {
	'method': 'followers'
};

rank( data, 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.log( JSON.stringify( results ) );
	/*
		{
			"data": [
				{"login":"boop",...},
				{"login":"beep",...}
			],
			"results": [ 10, 9 ]
		}
	*/
}

The returned results is comprised as follows:

• data: ranked user detail data.
• results: corresponding computed scores used to rank users.

The function accepts the following options:

• token: Github access token.
• useragent: user agent string.
• method: analysis method. Default: 'followers'.
  • followers: rank based on follower count.
  • following: rank based on following count.
  • repos: rank based on number of public repositories.
  • gists: rank based on number of public gists.
  • created: rank based on when a user created a Github account.
  • ffratio: rank based on the ratio of follower-to-following.

During analysis, the module may need to request resources from the Github API. To permit Github authentication, set the token option.

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

rank( data, opts, clbk );

To specify a user agent when interacting with the Github API, set the useragent option.

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

rank( data, opts, clbk );

To specify an analysis method, set the method option.

var opts = {
	'method': 'ffratio'
};

rank( data, opts, clbk );

rank.factory( options, clbk )

Creates a reusable function.

var opts = {
	'method': 'following',
	'token': 'tkjorjk34ek3nj4!'
};

var run = rank.factory( opts, clbk );

run( data );
run( data );
run( data );
// ...

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

Notes

• If an analysis method requires interacting with the Github API, rate limit information is returned to the provided callback.
• 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 rank = require( 'github-rank-users' );
var data = require( './data.json' );

var opts = {
	'method': 'ffratio'
};

rank( data, opts, clbk );

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

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

$ node ./examples/index.js

CLI

Installation

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

$ npm install -g github-rank-users

Usage

Usage: ghrankusers [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.
       --method method        Rank method. Default: followers.
       --format format        Output format: csv or json. Default: csv.
       --delimiter delimiter  CSV column delimiter. Default: ','.

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.
• Analysis results are written to stdout.
  • If the output format is csv, only the username and associated score used to rank a user are written to stdout.
  • If the output format is json, results written to stdout include both raw user detail data and associated scores.
• Rate limit information is written to stderr.

Examples

Setting the access token using the command-line option:

$ DEBUG=* ghrankusers --token <token> user1 user2 user3
# => username,value
# => user1,869
# => user2,637
# => user3,544
# => ...

Setting the access token using an environment variable:

$ DEBUG=* GITHUB_TOKEN=<token> ghrankusers user1 user2 user3
# => username,value
# => user1,869
# => user2,637
# => user3,544
# => ...

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

$ DEBUG=* ./node_modules/.bin/ghrankusers user1 user2 user3
# => username,value
# => user1,869
# => user2,637
# => user3,544
# => ...

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> user1 user2 user3
# => username,value
# => user1,869
# => user2,637
# => user3,544
# => ...

To output as JSON, set the format option.

$ DEBUG=* ghrankusers --token <token> user1 user2 user3 --format json
# => '{"data":[{...},{...},...],"results":[...]}'

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.