w3c / ghapi Goto Github PK

Node.js proxy to the GitHub API to fetch data about an organisation's repos :warning: Discontinued, not being maintained

JavaScript 100.00%

ghapi's Introduction

ghapi

Node.js proxy to the GitHub API to fetch and aggregate data about an organisation's repositories

⚠️ This project is discontinued, and not being actively maintained.

Howto

Clone and install dependencies:

git clone https://github.com/w3c/ghapi.git
cd ghapi/
npm install

Set up (you'll need a GitHub access token):

cp conf.json.example conf.json
edit conf.json # edit at least "organisation" and "token"

Run:

npm start
> [email protected] start /foo/bar/ghapi
> node --use_strict --throw-deprecation app
Listening on port 3000; visit http://localhost:3000/projects
GH API, token deadbeef: 4593/5000 (92%) requests available; resets in 58′36″
acme's 713 public projects:
bar, baz, foo, […] plugh, waldo, xyzzy
▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░▌  xyzzy

Wait until data about all repos is fetched (watch the progress bar), then visit http://localhost:3000/projects.

ghapi's People

Contributors

Watchers

Forkers

kleopatra999 bhanditz isabella232

ghapi's Issues

Use octonode methods instead of get(URL)

URLs as literals are fragile. And I'm assuming that it'll be more efficient to use octonode's data structures instead of querying the GH API with a new request every time.

So, instead of:

client.get('/repos/w3c/' + projectName + '/commits', {}, function (err, status, body, headers) {
    ⋮
});
client.get('/repos/w3c/' + projectName + '/issues', {}, function (err, status, body, headers) {
    ⋮
});
client.get('/repos/w3c/' + projectName + '/contributors', {}, function (err, status, body, headers) {
    ⋮
});

do:

const repo = client.repo(`w3c/${projectName}`);
repo.commits((err, data, headers) => {
    ⋮
});
repo.issues((err, data, headers) => {
    ⋮
});
repo.contributors((err, data, headers) => {
    ⋮
});

TypeError: Cannot read property “commit” of undefined

$ npm start
⋮
TypeError: Cannot read property 'commit' of undefined
    at app.js:121:70
    at Client.errorHandle (node_modules/octonode/lib/octonode/client.js:196:14)
    at Request._callback (node_modules/octonode/lib/octonode/client.js:210:24)
    at Request.self.callback (node_modules/request/request.js:187:22)
    at emitTwo (events.js:106:13)
    at Request.emit (events.js:191:7)
    at Request.<anonymous> (node_modules/request/request.js:1044:10)
    at emitOne (events.js:96:13)
    at Request.emit (events.js:188:7)
⋮

(Line numbers may differ from master; as I tested with some local changes.)

TypeError: Cannot read property “tag_name” of undefined

$ npm start
⋮
TypeError: Cannot read property 'tag_name' of undefined
    at app.js:124:68
    at Client.errorHandle (node_modules/octonode/lib/octonode/client.js:196:14)
    at Request._callback (node_modules/octonode/lib/octonode/client.js:210:24)
    at Request.self.callback (node_modules/request/request.js:187:22)
    at emitTwo (events.js:106:13)
    at Request.emit (events.js:191:7)
    at Request.<anonymous> (node_modules/request/request.js:1044:10)
    at emitOne (events.js:96:13)
    at Request.emit (events.js:188:7)
    at IncomingMessage.<anonymous> (node_modules/request/request.js:965:12)
⋮

Appears several times (once for each repo, it seems).

Add test suite

Retrieve all W3C repos programmatically using the GH API

Instead of hard-coding them.
At least for public projects, there should be no problem doing that.

Parameterise “w3c” (GH username) and make it part of config

Once #3 is fixed, this would be the only bit missing to make this project truly reusable for other organisations/users.

w3c / ghapi Goto Github PK

ghapi's Introduction

ghapi

Howto

ghapi's People

Contributors

Watchers

Forkers

ghapi's Issues

Use octonode methods instead of get(URL)

TypeError: Cannot read property “commit” of undefined

TypeError: Cannot read property “tag_name” of undefined

Add test suite

Retrieve all W3C repos programmatically using the GH API

Parameterise “w3c” (GH username) and make it part of config

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent