Simple GitHub API wrapper for node.js

Lots of times you don't need a full-fledged GitHub API client with authentication and what-not. Maybe you just want to load public data, or index and process your public repositories somehow. This simple GitHub API 'wrapper' provides the basics and can access all non-restricted API end points. And it's easily extendable too!

The wrapper loads a JSON file (routes.json) which contains a name space, a method name and an end point URI. Together, all methods are dynamically created at startup-time. This makes it very easy to add new end points in the future. The library makes use of promises through request-promise.

Currently _not all suitable end points_ have been added. You can either wait for me to add them to routes.json, or you can do it yourself (and submit a pull request, of course! ;)).

Install



npm install github-api-simple





Usage

js

const SimpleApi = require('github-api-simple');

let api = new SimpleApi(); // takes an options argument, see below



simpleApi.Repositories.getReposForUser('MichielvdVelde')

	.then(function(repos) {

		console.log('This user has %d repos', repos.length);

	});





The constructor takes an options argument, which is fed to request-promise. The defaults are:

js

const DEFAULT_OPTIONS = {

	'baseUrl': 'https://api.github.com',

	'headers': {

		'User-Agent': 'github-api-simple v' + pkg.version + ' [nodejs] [https://github.com/MichielvdVelde/github-api-simple]'

	},

	'json': true

};





You can change the

User-Agent

 header to set your own, the GitHub API requires one.



Routes



$3



#### Single user



All route methods take an optional

options object as the last argument. This object is extend()-ed with the options you gave when usig new

. For example, if you want to get all your repositories sorted by when it was last pushed to, you can:

js

let options = {

	'qs': {

		'sort': 'pushed',

		'direction': 'desc' // optional, GitHub API uses 'desc' by default for 'pushed'

	}

}

simpleApi.Users.getUser('MichielvdVelde', options)

	.then(function(repos) {

		console.log('This user has %d repos', repos.length);

	});





GitHub API reference

js

simpleApi.Users.getUser('MichielvdVelde')

	.then(function(repos) {

		console.log('This user has %d repos', repos.length);

	});





#### All users



GitHub API reference

js

simpleApi.Users.getUsers()

	.then(function(users) {

		console.log('I got %d users', users.length);

	});





$3



#### Repositories for a single user



GitHub API reference

js

simpleApi.Repositories.getReposForUser('MichielvdVelde')

	.then(function(repos) {

		console.log('This user has %d repos', repos.length);

	});





#### Single repository



GitHub API reference

js

simpleApi.Repositories.getRepo('MichielvdVelde', 'github-api-simple')

	.then(function(repo) {

		console.log('This repo has %d watchers', repo.watchers_count);

	});







#### Contributors



GitHub API reference

js

simpleApi.Repositories.getRepoContributors('MichielvdVelde', 'github-api-simple')

	.then(function(contributors) {

		console.log('This repo has %d contributors', contributors.length);

	});







#### Languages



GitHub API reference

js

simpleApi.Repositories.getRepoLanguages('MichielvdVelde', 'github-api-simple')

	.then(function(languages) {

		for(let language of languages) {

			console.log('language %s, %d bytes', language, languages[language]);

		}

	});







#### Teams



GitHub API reference

js

simpleApi.Repositories.getRepoTeams('MichielvdVelde', 'github-api-simple')

	.then(function(teams) {

		if(teams) {

			console.log('This repo has %d teams', teams.length);

		}

	});







#### Tags



GitHub API reference

js

simpleApi.Repositories.getRepoTags('MichielvdVelde', 'github-api-simple')

	.then(function(tags) {

		console.log('This repo has %d tags', tags.length);

	});







#### Branches



GitHub API reference

js

simpleApi.Repositories.getRepoBranches('MichielvdVelde', 'github-api-simple')

	.then(function(branches) {

		console.log('This repo has %d branches', branches.length);

	});







#### Single branch



GitHub API reference

js

simpleApi.Repositories.getRepoBranche('MichielvdVelde', 'github-api-simple', 'master')

	.then(function(branche) {

		console.log('Latest commit on master is %s', branche.commit.sha);

	});







#### Contents of a repository file



GitHub API reference

js

simpleApi.Repositories.getRepoFile('MichielvdVelde', 'github-api-simple', 'README.md')

	.then(function(content) {

		console.log('Readme sha is %s', content.sha);

	});







#### Repository commits



GitHub API reference

js

simpleApi.Repositories.getRepoCommits('MichielvdVelde', 'github-api-simple')

	.then(function(commits) {

		console.log('This repo has %d commits', commits.length);

	});







#### Repository single commit



GitHub API reference

js

simpleApi.Repositories.getRepoCommit('MichielvdVelde', 'github-api-simple', '6dcb09b5b57875f334f61aebed695e2e4193db5e')

	.then(function(commit) {

		console.log('Commit %s says %s', commit.sha, commit.commit.message);

	});





$3





#### Get followers for user



GitHub API reference

js

simpleApi.Followers.getFollowersForUser('MichielvdVelde')

	.then(function(followers) {

		console.log('This user has %d followers', followers.length);

	});







#### Get followers by user



GitHub API reference

js

simpleApi.Followers.getFollowersByUser('MichielvdVelde')

	.then(function(followers) {

		console.log('This user follows %d others', followers.length);

	});





$3





#### Get issues for repository



GitHub API reference

js

simpleApi.Issues.getIssuesForRepo('MichielvdVelde', 'github-api-simple')

	.then(function(issues) {

		console.log('This repo has %d issues', issues.length);

	});







#### Get a single issue



GitHub API reference

js

simpleApi.Issues.getIssue('MichielvdVelde', 'github-api-simple', 138)

	.then(function(issue) {

		console.log('This issue is %s', issue.state);

	});







#### Get issue comments



GitHub API reference

js

simpleApi.Issues.getIssueComments('MichielvdVelde', 'github-api-simple', 138)

	.then(function(comments) {

		console.log('This issue has %d comments', comments.length);

	});







#### Get issue comments



GitHub API reference

js

simpleApi.Issues.getRepoIssues('MichielvdVelde', 'github-api-simple')

	.then(function(issues) {

		console.log('This repo has %d issues', issues.length);

	});







#### Get issue comment



GitHub API reference

js

simpleApi.Issues.getIssueComment('MichielvdVelde', 'github-api-simple', 96)

	.then(function(comment) {

		console.log('Comment by %s', comment.owner.login);

	});





$3





#### Get all milestones for a repository



GitHub API reference

js

simpleApi.Milestones.getRepoMilestones('MichielvdVelde', 'github-api-simple')

	.then(function(milestones) {

		console.log('This repo has %d milestones', milestones.length);

	});







#### Get a single milestone



GitHub API reference

js

simpleApi.Milestones.getMilestone('MichielvdVelde', 'github-api-simple', 544)

	.then(function(milestone) {

		console.log('Milestone title i %s', milestone.title);

	});





To do



* Add the rest of the applicable API end points to the routes file

* Add paging support

* Make rate limiting headers available

* Write some tests



Changelog



* 0.1.0 - 25 October 2017

  * Drop fs and .readFileSync() to support Browserify (thanks to jywarren)

* 0.0.4 - 0.0.5 10 December 2015

  * (0.0.6) Added

Repositories.getRepoCommits() and Repositories.getRepoCommit()



  * (0.0.5) Added

Repositories.getRepositoryFile(username, reponame, filename)



  * (0.0.4) Added a lot of new end points to

routes.json



  * (0.0.4) Fixed some readme mistakes

* 0.0.1 - 0.0.3 - 9 December 2015

  * (0.0.3) Improved readme

  * (0.0.2) Moved

routes.json to dir assets`
* (0.0.2) Fixed stupid-ass path error
* (0.0.1) Initial commit

License