Added code search API method. Original idea by @zamith. Fixes octokit#228.

Author: mikedeboer

api/v3.0.0/issues.js

@@ -173,7 +173,7 @@ var issues = module.exports = {
      *  - body (String): Optional. 
      *  - assignee (String): Optional. Login for the user that this issue should be assigned to.
      *  - milestone (Number): Optional. Milestone to associate this issue with. Validation rule: ` ^[0-9]+$ `.
-     *  - labels (Json): Required. Array of strings - Labels to associate with this issue.
+     *  - labels (Json): Optional. Array of strings - Labels to associate with this issue.
      **/
     this.create = function(msg, block, callback) {
         var self = this;

api/v3.0.0/orgs.js

@@ -159,7 +159,7 @@ var orgs = module.exports = {
      *  - org (String): Required. 
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
-     *  - filter (String): Optional. Validation rule: ` (all|2fa_disabled) `, Default: ` all `.
+     *  - filter (String): Optional.  Validation rule: ` ^(all|2fa_disabled)$ `.
      **/
     this.getMembers = function(msg, block, callback) {
         var self = this;

api/v3.0.0/pullRequests.js

@@ -30,8 +30,8 @@ var pullRequests = module.exports = {
      *  - user (String): Required. 
      *  - repo (String): Required. 
      *  - state (String): Optional. open, closed, or all Validation rule: ` ^(open|closed|all)$ `.
-     *  - head (String): Optional. Filter pulls by head user and branch name in the format of user:ref-name. Example: github:new-script-format.
-     *  - base (String): Optional. Filter pulls by base branch name. Example: gh-pages.
+     *  - head (String): Required. The branch (or git ref) where your changes are implemented.
+     *  - base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
      *  - sort (String): Optional. Possible values are: `created`, `updated`, `popularity`, `long-running`, Default: `created` Validation rule: ` ^(created|updated|popularity|long-running)$ `.

api/v3.0.0/routes.json

@@ -3559,6 +3559,24 @@
     },
 
     "search": {
+        "code": {
+            "url": "/search/code",
+            "method": "GET",
+            "params": {
+                "$q": null,
+                "sort": {
+                    "type": "String",
+                    "required": false,
+                    "validation": "^indexed$",
+                    "invalidmsg": "indexed only",
+                    "description": "indexed only"
+                },
+                "$order": null,
+                "$page": null,
+                "$per_page": null
+            }
+        },
+
         "issues": {
             "url": "/search/issues",
             "method": "GET",

api/v3.0.0/search.js

@@ -19,6 +19,50 @@ var search = module.exports = {
 };
 
 (function() {
+    /** section: github
+     *  search#code(msg, callback) -> null
+     *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
+     *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
+     *
+     *  ##### Params on the `msg` object:
+     *
+     *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
+     *  - q (String): Required. Search Term
+     *  - sort (String): Optional. indexed only Validation rule: ` ^indexed$ `.
+     *  - order (String): Optional. asc or desc Validation rule: ` ^(asc|desc)$ `.
+     *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
+     *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     **/
+    this.code = function(msg, block, callback) {
+        var self = this;
+        this.client.httpSend(msg, block, function(err, res) {
+            if (err)
+                return self.sendError(err, null, msg, callback);
+
+            var ret;
+            try {
+                ret = res.data && JSON.parse(res.data);
+            }
+            catch (ex) {
+                if (callback)
+                    callback(new error.InternalServerError(ex.message), res);
+                return;
+            }
+
+            if (!ret)
+                ret = {};
+            if (!ret.meta)
+                ret.meta = {};
+            ["x-ratelimit-limit", "x-ratelimit-remaining", "x-ratelimit-reset", "x-oauth-scopes", "link", "location", "last-modified", "etag", "status"].forEach(function(header) {
+                if (res.headers[header])
+                    ret.meta[header] = res.headers[header];
+            });
+
+            if (callback)
+                callback(null, ret);
+        });
+    };
+
     /** section: github
      *  search#issues(msg, callback) -> null
      *      - msg (Object): Object that contains the parameters and their values to be sent to the server.

api/v3.0.0/searchTest.js

@@ -26,10 +26,26 @@ describe("[search]", function() {
         });*/
     });
 
+    it("should successfully execute GET /search/code/:q (code)",  function(next) {
+        client.search.code(
+            {
+                q: ['test', 'repo:mikedeboertest/1423836276146'].join('+')
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                Assert.equal(res.items.length, 1);
+                var file = res.items[0];
+                Assert.equal(file.name, "TEST.md");
+
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /search/issues/:q (issues)",  function(next) {
         client.search.issues(
             {
-                q: ['macaroni', 'repo:mikedeboertest/node_chat', 'state:open'].join('+')
+                q: ['debate', 'repo:mikedeboertest/node_chat', 'state:open'].join('+')
             },
             function(err, res) {
                 Assert.equal(err, null);

api/v3.0.0/user.js

@@ -58,6 +58,7 @@ var user = module.exports = {
                 callback(null, ret);
         });
     };
+
     /** section: github
      *  user#getFrom(msg, callback) -> null
      *      - msg (Object): Object that contains the parameters and their values to be sent to the server.