Episode VI: Return of the Promise PRs (getPage Promise support)

[jamsinclair]

Was hesitant to re-open the issue you just closed #425. I had a similar situation where I was trying to retrieve a large number or all records via paging and promises.

This PR follows in the footsteps of #262 and adds pluggable promise support to all getPage based methods.

Not as nice as I would've liked. Most of it is duplicated code taken from the #262 solution.

Example outcome from PR:

var GitHubApi = require('github');

var gh = new GitHubApi ({
  Promise: require('bluebird')
});

function getAllOrgRepos(orgName) {
  var repos = [];

  function pager(res) {
    repos = repos.concat(res);
    if (gh.hasNextPage(res)) {
      return gh.getNextPage(res)
        .then(pager);
    }
    return repos;
  }

  return gh.repos.getForOrg({ org: orgName })
    .then(pager);
}


getAllOrgRepos('organization')
  .then(/* Do stuff with all repos */);

If this is not at all how you would like it approached feel free to close this PR, as not to waste your time 😸. Very happy to make changes.

Edit: Tidied up example code.

[jamsinclair]

Worth throwing an error if neither promise or callback defined, like below?

[kaizensoze]

Up to you. Not a dealbreaker without it.

[jamsinclair]

I'll leave it be 😄 , I'm sure my lazy developer habits will come back to haunt me.

[kaizensoze]

This looks good. I'll add the example output to the examples section. As a bonus, how much work would it be to get the promise stuff also compatible with Q? If a significant amount I'll just go ahead and merge this.

[jamsinclair]

From a quick 5 minute play, it seems like the Q library is compatible. I've commented in the issue #400 😄

If you're fine with the PR, happy for you to merge 👍

[kaizensoze]

Awesome. Good to go.