feature(search): return all pages from a search

Closes #302

Author: clayreimann

lib/Requestable.js

@@ -203,7 +203,7 @@ class Requestable {
    _requestAllPages(path, options, cb, results) {
       results = results || [];
 
-      return this._request('GET', path, null)
+      return this._request('GET', path, options)
          .then((response) => {
             results.push.apply(results, response.data);
 

lib/Search.js

@@ -24,11 +24,20 @@ class Search extends Requestable {
       this.__defaults = this._getOptionsWithDefaults(defaults);
    }
 
+   /**
+    * Available search options
+    * @see https://developer.github.com/v3/search/#parameters
+    * @typedef {Object} Search.Params
+    * @param {string} q - the query to make
+    * @param {string} sort - the sort field, one of `stars`, `forks`, or `updated`.
+    *                      Default is [best match](https://developer.github.com/v3/search/#ranking-search-results)
+    * @param {string} order - the ordering, either `asc` or `desc`
+    */
    /**
     * Perform a search on the GitHub API
     * @private
     * @param {string} path - the scope of the search
-    * @param {Object} [withOptions] - additional parameters for the search
+    * @param {Search.Params} [withOptions] - additional parameters for the search
     * @param {Requestable.callback} [cb] - will receive the results of the search
     * @return {Promise} - the promise for the http request
     */
@@ -38,13 +47,13 @@ class Search extends Requestable {
       Object.keys(withOptions).forEach((prop) => requestOptions[prop] = withOptions[prop]);
 
       log(`searching ${path} with options:`, requestOptions);
-      return this._request('GET', `/search/${path}`, requestOptions, cb);
+      return this._requestAllPages(`/search/${path}`, requestOptions, cb);
    }
 
    /**
     * Search for repositories
     * @see https://developer.github.com/v3/search/#search-repositories
-    * @param {Object} [options] - additional parameters for the search
+    * @param {Search.Params} [options] - additional parameters for the search
     * @param {Requestable.callback} [cb] - will receive the results of the search
     * @return {Promise} - the promise for the http request
     */
@@ -55,7 +64,7 @@ class Search extends Requestable {
    /**
     * Search for code
     * @see https://developer.github.com/v3/search/#search-code
-    * @param {Object} [options] - additional parameters for the search
+    * @param {Search.Params} [options] - additional parameters for the search
     * @param {Requestable.callback} [cb] - will receive the results of the search
     * @return {Promise} - the promise for the http request
     */
@@ -66,7 +75,7 @@ class Search extends Requestable {
    /**
     * Search for issues
     * @see https://developer.github.com/v3/search/#search-issues
-    * @param {Object} [options] - additional parameters for the search
+    * @param {Search.Params} [options] - additional parameters for the search
     * @param {Requestable.callback} [cb] - will receive the results of the search
     * @return {Promise} - the promise for the http request
     */
@@ -77,7 +86,7 @@ class Search extends Requestable {
    /**
     * Search for users
     * @see https://developer.github.com/v3/search/#search-users
-    * @param {Object} [options] - additional parameters for the search
+    * @param {Search.Params} [options] - additional parameters for the search
     * @param {Requestable.callback} [cb] - will receive the results of the search
     * @return {Promise} - the promise for the http request
     */

test/search.spec.js

@@ -33,7 +33,7 @@ describe('Search', function() {
 
    it('should search issues', function(done) {
       let search = github.search({
-         q: 'windows label:bug language:python state:open',
+         q: 'windows pip label:bug language:python state:open ',
          sort: 'created',
          order: 'asc'
       });