Rank Followers
Rank a user's followers.
Installation
$ npm install github-rank-followers
Usage
var rank = ;
rank( opts, clbk )
Ranks a user's followers.
var opts ='username': 'kgryte';;{// Check for rate limit information...if infoconsole;console;console;if errorthrow errormessage ;console;/*{"data": [{"login":"followerN",...},{"login":"followerM",...},...],"results": [78,67,62,...]}*/}
The returned results
is comprised as follows:
- data: raw user detail data.
- results: corresponding computed scores used to rank followers.
The function
accepts the following options
:
- token: Github access token.
- username: Github username.
- useragent: user agent
string
. - method: analysis method (see github-rank-users). Default:
'followers'
.
To authenticate with Github, set the token
option.
var opts ='token': 'tkjorjk34ek3nj4!';;
To analyze the followers of a particular user, set the username
option.
var opts ='username': 'kgryte';;
To specify a user agent, set the useragent
option.
var opts ='useragent': 'hello-github!';;
To specify an analysis method, set the method
option.
var opts ='method': 'ffratio';;
rank.factory( options, clbk )
Creates a reusable function
.
var opts ='username': 'kgryte''token': 'tkjorjk34ek3nj4!';var run = rank;;;;// ...
The factory method accepts the same options
as rank()
.
Notes
- Either a
username
or atoken
or both must be provided. If provided atoken
, but not ausername
, thefunction
analyzes the authenticated user's Github followers. - 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 = ;var opts ='username': 'kgryte''useragent': 'beep-boop-bop''method': 'ffratio';;{if infoconsole;if errorthrow errormessage ;console;}
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-followers
Usage
Usage: ghrankfollowers [options]Options:-h, --help Print this message.-V, --version Print the package version.--token token Github access token.--username username Github username.-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 aGITHUB_TOKEN
environment variable. The command-line option always takes precedence. - Analysis results are written to
stdout
.- If the output format is
csv
, only theusername
and associated score used to rank a user are written tostdout
. - If the output format is
json
, results written tostdout
include both raw user detail data and associated scores.
- If the output format is
- Rate limit information is written to
stderr
.
Examples
Setting the access token using the command-line option:
$ DEBUG=* ghrankfollowers --token <token> --username kgryte# => username,value# => user1,869# => user2,637# => user3,544# => ...
Setting the access token using an environment variable:
$ DEBUG=* GITHUB_TOKEN=<token> ghrankfollowers --username kgryte# => 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/ghrankfollowers --token <token> --username kgryte# => 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> --username kgryte# => username,value# => user1,869# => user2,637# => user3,544# => ...
To output as JSON, set the format
option.
$ DEBUG=* ghrankfollowers --token <token> --username kgryte --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
Copyright
Copyright © 2016. Athan Reines.