[maven-release-plugin] prepare release github-api-1.68

Fixes issue #176

pom.xml

@@ -7,7 +7,7 @@
   </parent>
 
   <artifactId>github-api</artifactId>
-  <version>1.64-SNAPSHOT</version>
+  <version>1.68</version>
   <name>GitHub API for Java</name>
   <url>http://github-api.kohsuke.org/</url>
   <description>GitHub API for Java</description>
@@ -16,7 +16,7 @@
     <connection>scm:git:git@github.com/kohsuke/${project.artifactId}.git</connection>
     <developerConnection>scm:git:ssh://git@github.com/kohsuke/${project.artifactId}.git</developerConnection>
     <url>http://${project.artifactId}.kohsuke.org/</url>
-    <tag>HEAD</tag>
+    <tag>github-api-1.68</tag>
   </scm>
 
   <distributionManagement>

src/main/java/org/kohsuke/github/GHAsset.java

@@ -1,6 +1,7 @@
 package org.kohsuke.github;
 
 import java.io.IOException;
+import java.net.URL;
 
 /**
  * Asset in a release.
@@ -60,6 +61,14 @@ public class GHAsset extends GHObject {
         return state;
     }
 
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
+
     public String getBrowserDownloadUrl() {
         return browser_download_url;
     }

src/main/java/org/kohsuke/github/GHAuthorization.java

@@ -10,78 +10,83 @@ import java.util.List;
  *
  * @author janinko
  * @see GitHub#createToken(Collection, String, String)
- * @see http://developer.github.com/v3/oauth/#create-a-new-authorization
+ * @see <a href="http://developer.github.com/v3/oauth/#create-a-new-authorization">API documentation</a>
  */
 public class GHAuthorization extends GHObject {
-	public static final String USER = "user";
-	public static final String USER_EMAIL = "user:email";
-	public static final String USER_FOLLOW = "user:follow";
-	public static final String PUBLIC_REPO = "public_repo";
-	public static final String REPO = "repo";
-	public static final String REPO_STATUS = "repo:status";
-	public static final String DELETE_REPO = "delete_repo";
-	public static final String NOTIFICATIONS = "notifications";
-	public static final String GIST = "gist";
-	public static final String READ_HOOK = "read:repo_hook";
-	public static final String WRITE_HOOK = "write:repo_hook";
-	public static final String AMIN_HOOK = "admin:repo_hook";
-	public static final String READ_ORG = "read:org";
-	public static final String WRITE_ORG = "write:org";
-	public static final String ADMIN_ORG = "admin:org";
-	public static final String READ_KEY = "read:public_key";
-	public static final String WRITE_KEY = "write:public_key";
-	public static final String ADMIN_KEY = "admin:public_key";
+    public static final String USER = "user";
+    public static final String USER_EMAIL = "user:email";
+    public static final String USER_FOLLOW = "user:follow";
+    public static final String PUBLIC_REPO = "public_repo";
+    public static final String REPO = "repo";
+    public static final String REPO_STATUS = "repo:status";
+    public static final String DELETE_REPO = "delete_repo";
+    public static final String NOTIFICATIONS = "notifications";
+    public static final String GIST = "gist";
+    public static final String READ_HOOK = "read:repo_hook";
+    public static final String WRITE_HOOK = "write:repo_hook";
+    public static final String AMIN_HOOK = "admin:repo_hook";
+    public static final String READ_ORG = "read:org";
+    public static final String WRITE_ORG = "write:org";
+    public static final String ADMIN_ORG = "admin:org";
+    public static final String READ_KEY = "read:public_key";
+    public static final String WRITE_KEY = "write:public_key";
+    public static final String ADMIN_KEY = "admin:public_key";
 
-	private GitHub root;
-	private List<String> scopes;
-	private String token;
-	private App app;
-	private String note;
-	private String note_url;
+    private GitHub root;
+    private List<String> scopes;
+    private String token;
+    private App app;
+    private String note;
+    private String note_url;
 
     public GitHub getRoot() {
         return root;
     }
 
-	public List<String> getScopes() {
-		return scopes;
-	}
+    public List<String> getScopes() {
+        return scopes;
+    }
 
-	public String getToken(){
-		return token;
-	}
+    public String getToken() {
+        return token;
+    }
 
-	public URL getAppUrl(){
+    public URL getAppUrl() {
         return GitHub.parseURL(app.url);
-	}
+    }
 
-	public String getAppName() {
-		return app.name;
-	}
-   
-	public URL getApiURL(){
+    public String getAppName() {
+        return app.name;
+    }
+
+    public URL getApiURL() {
         return GitHub.parseURL(url);
-	}
+    }
 
-	public String getNote() {
-		return note;
-	}
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
 
-	public URL getNoteUrl(){
+    public String getNote() {
+        return note;
+    }
+
+    public URL getNoteUrl() {
         return GitHub.parseURL(note_url);
-	}
+    }
 
-	/*package*/ GHAuthorization wrap(GitHub root) {
-		this.root = root;
-		return this;
-	}
+    /*package*/ GHAuthorization wrap(GitHub root) {
+        this.root = root;
+        return this;
+    }
 
 
-
-
-
-	private static class App{
-		private String url;
-		private String name;
-	}
+    private static class App {
+        private String url;
+        private String name;
+    }
 }

src/main/java/org/kohsuke/github/GHCommit.java

@@ -32,26 +32,26 @@ public class GHCommit {
         
         private int comment_count;
 
-        @WithBridgeMethods(value=GHAuthor.class,castRequired=true)
-    	public GitUser getAuthor() {
-    		return author;
-    	}
+        @WithBridgeMethods(value = GHAuthor.class, castRequired = true)
+        public GitUser getAuthor() {
+            return author;
+        }
 
-        @WithBridgeMethods(value=GHAuthor.class,castRequired=true)
-		public GitUser getCommitter() {
-			return committer;
-		}
+        @WithBridgeMethods(value = GHAuthor.class, castRequired = true)
+        public GitUser getCommitter() {
+            return committer;
+        }
 
         /**
          * Commit message.
          */
-		public String getMessage() {
-			return message;
-		}
+        public String getMessage() {
+            return message;
+        }
 
-		public int getCommentCount() {
-			return comment_count;
-		}
+        public int getCommentCount() {
+            return comment_count;
+        }
     }
 
     /**
@@ -153,14 +153,13 @@ public class GHCommit {
     Stats stats;
     List<Parent> parents;
     User author,committer;
-    
-    
+
 
     public ShortInfo getCommitShortInfo() {
-		return commit;
-	}
+        return commit;
+    }
 
-	/**
+    /**
      * The repository that contains the commit.
      */
     public GHRepository getOwner() {

src/main/java/org/kohsuke/github/GHCommitPointer.java

@@ -23,6 +23,8 @@
  */
 package org.kohsuke.github;
 
+import java.io.IOException;
+
 /**
  * Identifies a commit in {@link GHPullRequest}.
  *
@@ -69,6 +71,13 @@ public class GHCommitPointer {
         return label;
     }
 
+    /**
+     * Obtains the commit that this pointer is referring to.
+     */
+    public GHCommit getCommit() throws IOException {
+        return getRepository().getCommit(getSha());
+    }
+
     void wrapUp(GitHub root) {
         if (user!=null) user.root = root;
         if (repo!=null) repo.wrap(root);

src/main/java/org/kohsuke/github/GHCommitStatus.java

@@ -1,14 +1,15 @@
 package org.kohsuke.github;
 
 import java.io.IOException;
+import java.net.URL;
 import java.util.Date;
 
 /**
  * Represents a status of a commit.
  *
  * @author Kohsuke Kawaguchi
- * @see GHRepository#getCommitStatus(String)
- * @see GHCommit#getStatus()
+ * @see GHRepository#getLastCommitStatus(String)
+ * @see GHCommit#getLastStatus()
  */
 public class GHCommitStatus extends GHObject {
     String state;
@@ -49,7 +50,15 @@ public class GHCommitStatus extends GHObject {
         return creator;
     }
 
-	public String getContext() {
-		return context;
-	}
+    public String getContext() {
+        return context;
+    }
+
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
 }

src/main/java/org/kohsuke/github/GHCompare.java

@@ -70,10 +70,10 @@ public class GHCompare {
     }
     
     public GHCommit.File[] getFiles() {
-		return files;
-	}
+        return files;
+    }
 
-	public GHCompare wrap(GHRepository owner) {
+    public GHCompare wrap(GHRepository owner) {
         this.owner = owner;
         for (Commit commit : commits) {
             commit.wrapUp(owner);

src/main/java/org/kohsuke/github/GHContent.java

@@ -16,7 +16,13 @@ import javax.xml.bind.DatatypeConverter;
  */
 @SuppressWarnings({"UnusedDeclaration"})
 public class GHContent {
-    private GHRepository owner;
+    /*
+        In normal use of this class, repository field is set via wrap(),
+        but in the code search API, there's a nested 'repository' field that gets populated from JSON.
+     */
+    private GHRepository repository;
+
+    private GitHub root;
 
     private String type;
     private String encoding;
@@ -31,7 +37,7 @@ public class GHContent {
     private String download_url;
 
     public GHRepository getOwner() {
-        return owner;
+        return repository;
     }
 
     public String getType() {
@@ -107,13 +113,16 @@ public class GHContent {
      * Retrieves the actual content stored here.
      */
     public InputStream read() throws IOException {
-        return new Requester(owner.root).read(getDownloadUrl());
+        return new Requester(root).asStream(getDownloadUrl());
     }
 
     /**
      * URL to retrieve the raw content of the file. Null if this is a directory.
      */
-    public String getDownloadUrl() { return download_url; }
+    public String getDownloadUrl() throws IOException {
+        populate();
+        return download_url;
+    }
 
     public boolean isFile() {
         return "file".equals(type);
@@ -123,6 +132,16 @@ public class GHContent {
         return "dir".equals(type);
     }
 
+    /**
+     * Fully populate the data by retrieving missing data.
+     *
+     * Depending on the original API call where this object is created, it may not contain everything.
+     */
+    protected synchronized void populate() throws IOException {
+        if (download_url!=null)    return; // already populated
+        root.retrieve().to(url, this);
+    }
+
     /**
      * List immediate children of this directory.
      */
@@ -132,10 +151,10 @@ public class GHContent {
 
         return new PagedIterable<GHContent>() {
             public PagedIterator<GHContent> iterator() {
-                return new PagedIterator<GHContent>(owner.root.retrieve().asIterator(url, GHContent[].class)) {
+                return new PagedIterator<GHContent>(root.retrieve().asIterator(url, GHContent[].class)) {
                     @Override
                     protected void wrapUp(GHContent[] page) {
-                        GHContent.wrap(page,owner);
+                        GHContent.wrap(page, repository);
                     }
                 };
             }
@@ -157,7 +176,7 @@ public class GHContent {
     public GHContentUpdateResponse update(byte[] newContentBytes, String commitMessage, String branch) throws IOException {
         String encodedContent = DatatypeConverter.printBase64Binary(newContentBytes);
 
-        Requester requester = new Requester(owner.root)
+        Requester requester = new Requester(root)
             .with("path", path)
             .with("message", commitMessage)
             .with("sha", sha)
@@ -170,8 +189,8 @@ public class GHContent {
 
         GHContentUpdateResponse response = requester.to(getApiRoute(), GHContentUpdateResponse.class);
 
-        response.getContent().wrap(owner);
-        response.getCommit().wrapUp(owner);
+        response.getContent().wrap(repository);
+        response.getCommit().wrapUp(repository);
 
         this.content = encodedContent;
         return response;
@@ -182,7 +201,7 @@ public class GHContent {
     }
 
     public GHContentUpdateResponse delete(String commitMessage, String branch) throws IOException {
-        Requester requester = new Requester(owner.root)
+        Requester requester = new Requester(root)
             .with("path", path)
             .with("message", commitMessage)
             .with("sha", sha)
@@ -194,18 +213,26 @@ public class GHContent {
 
         GHContentUpdateResponse response = requester.to(getApiRoute(), GHContentUpdateResponse.class);
 
-        response.getCommit().wrapUp(owner);
+        response.getCommit().wrapUp(repository);
         return response;
     }
 
     private String getApiRoute() {
-        return "/repos/" + owner.getOwnerName() + "/" + owner.getName() + "/contents/" + path;
+        return "/repos/" + repository.getOwnerName() + "/" + repository.getName() + "/contents/" + path;
     }
 
     GHContent wrap(GHRepository owner) {
-        this.owner = owner;
+        this.repository = owner;
+        this.root = owner.root;
         return this;
     }
+    GHContent wrap(GitHub root) {
+        this.root = root;
+        if (repository!=null)
+            repository.wrap(root);
+        return this;
+    }
+
 
     public static GHContent[] wrap(GHContent[] contents, GHRepository repository) {
         for (GHContent unwrappedContent : contents) {

src/main/java/org/kohsuke/github/GHContentSearchBuilder.java

@@ -0,0 +1,74 @@
+package org.kohsuke.github;
+
+/**
+ * Search code for {@link GHContent}.
+ *
+ * @author Kohsuke Kawaguchi
+ * @see GitHub#searchContent()
+ */
+public class GHContentSearchBuilder extends GHSearchBuilder<GHContent> {
+    /*package*/ GHContentSearchBuilder(GitHub root) {
+        super(root,ContentSearchResult.class);
+    }
+
+    /**
+     * Search terms.
+     */
+    public GHContentSearchBuilder q(String term) {
+        super.q(term);
+        return this;
+    }
+
+    public GHContentSearchBuilder in(String v) {
+        return q("in:"+v);
+    }
+
+    public GHContentSearchBuilder language(String v) {
+        return q("language:"+v);
+    }
+
+    public GHContentSearchBuilder fork(String v) {
+        return q("fork:"+v);
+    }
+
+    public GHContentSearchBuilder size(String v) {
+        return q("size:"+v);
+    }
+
+    public GHContentSearchBuilder path(String v) {
+        return q("path:"+v);
+    }
+
+    public GHContentSearchBuilder filename(String v) {
+        return q("filename:"+v);
+    }
+
+    public GHContentSearchBuilder extension(String v) {
+        return q("extension:"+v);
+    }
+
+    public GHContentSearchBuilder user(String v) {
+        return q("user:"+v);
+    }
+
+
+    public GHContentSearchBuilder repo(String v) {
+        return q("repo:"+v);
+    }
+
+    private static class ContentSearchResult extends SearchResult<GHContent> {
+        private GHContent[] items;
+
+        @Override
+        /*package*/ GHContent[] getItems(GitHub root) {
+            for (GHContent item : items)
+                item.wrap(root);
+            return items;
+        }
+    }
+
+    @Override
+    protected String getApiUrl() {
+        return "/search/code";
+    }
+}

src/main/java/org/kohsuke/github/GHDeployKey.java

@@ -9,7 +9,7 @@ public class GHDeployKey {
     protected String url, key, title;
     protected boolean verified;
     protected int id;
-	private GHRepository owner;
+    private GHRepository owner;
 
     public int getId() {
         return id;
@@ -31,10 +31,10 @@ public class GHDeployKey {
         return verified;
     }
 
-	public GHDeployKey wrap(GHRepository repo) {
-		this.owner = repo;
-		return this;
-	}
+    public GHDeployKey wrap(GHRepository repo) {
+        this.owner = repo;
+        return this;
+    }
 
     public String toString() {
         return new ToStringBuilder(this).append("title",title).append("id",id).append("key",key).toString();

src/main/java/org/kohsuke/github/GHDeployment.java

@@ -50,4 +50,12 @@ public class GHDeployment extends GHObject {
     public String getSha(){
         return sha;
     }
+
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
 }

src/main/java/org/kohsuke/github/GHDeploymentStatus.java

@@ -32,5 +32,11 @@ public class GHDeploymentStatus extends GHObject {
         return GHDeploymentState.valueOf(state.toUpperCase());
     }
 
-
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
 }

src/main/java/org/kohsuke/github/GHEventPayload.java

@@ -165,6 +165,7 @@ public abstract class GHEventPayload {
 
         @Override
         void wrapUp(GitHub root) {
+            super.wrapUp(root);
             if (repository!=null)
                 repository.wrap(root);
         }

src/main/java/org/kohsuke/github/GHGist.java

@@ -3,6 +3,7 @@ package org.kohsuke.github;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import java.io.IOException;
+import java.net.URL;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
@@ -60,8 +61,8 @@ public class GHGist extends GHObject {
         return git_push_url;
     }
 
-    public String getHtmlUrl() {
-        return html_url;
+    public URL getHtmlUrl() {
+        return GitHub.parseURL(html_url);
     }
 
     public boolean isPublic() {

src/main/java/org/kohsuke/github/GHHook.java

@@ -1,6 +1,7 @@
 package org.kohsuke.github;
 
 import java.io.IOException;
+import java.net.URL;
 import java.util.Collections;
 import java.util.EnumSet;
 import java.util.List;
@@ -51,4 +52,12 @@ public class GHHook extends GHObject {
     public void delete() throws IOException {
         new Requester(repository.root).method("DELETE").to(String.format("/repos/%s/%s/hooks/%d", repository.getOwnerName(), repository.getName(), id));
     }
+
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
 }

src/main/java/org/kohsuke/github/GHIssue.java

@@ -44,8 +44,8 @@ import java.util.Locale;
 public class GHIssue extends GHObject {
     GitHub root;
     GHRepository owner;
-	
-	// API v3
+    
+    // API v3
     protected GHUser assignee;
     protected String state;
     protected int number;
@@ -74,9 +74,9 @@ public class GHIssue extends GHObject {
 
     /*package*/ GHIssue wrap(GitHub root) {
         this.root = root;
-		if(assignee != null) assignee.wrapUp(root);
-		if(user != null) user.wrapUp(root);
-		if(closed_by != null) closed_by.wrapUp(root);
+        if(assignee != null) assignee.wrapUp(root);
+        if(user != null) user.wrapUp(root);
+        if(closed_by != null) closed_by.wrapUp(root);
         return this;
     }
 
@@ -134,9 +134,9 @@ public class GHIssue extends GHObject {
         return GitHub.parseDate(closed_at);
     }
 
-	public URL getApiURL(){
+    public URL getApiURL(){
         return GitHub.parseURL(url);
-	}
+    }
 
     /**
      * Updates the issue by adding a comment.
@@ -185,16 +185,16 @@ public class GHIssue extends GHObject {
 
     /**
      * Obtains all the comments associated with this issue.
-	 * 
-	 * @see #listComments() 
+     * 
+     * @see #listComments() 
+     */
+    public List<GHIssueComment> getComments() throws IOException {
+        return listComments().asList();
+    }
+    
+    /**
+     * Obtains all the comments associated with this issue.
      */
-	public List<GHIssueComment> getComments() throws IOException {
-		return listComments().asList();
-	}
-	
-	/**
-	 * Obtains all the comments associated with this issue.
-	 */
     public PagedIterable<GHIssueComment> listComments() throws IOException {
         return new PagedIterable<GHIssueComment>() {
             public PagedIterator<GHIssueComment> iterator() {
@@ -216,16 +216,16 @@ public class GHIssue extends GHObject {
         return "/repos/"+owner.getOwnerName()+"/"+owner.getName()+"/issues/"+number;
     }
 
-	public GHUser getAssignee() {
-		return assignee;
-	}
-	
+    public GHUser getAssignee() {
+        return assignee;
+    }
+    
     /**
      * User who submitted the issue.
      */
-	public GHUser getUser() {
+    public GHUser getUser() {
         return user;
-	}
+    }
 
     /**
      * Reports who has closed the issue.
@@ -235,46 +235,46 @@ public class GHIssue extends GHObject {
      * even for an issue that's already closed. See
      * https://github.com/kohsuke/github-api/issues/60.
      */
-	public GHUser getClosedBy() {
-		if(!"closed".equals(state)) return null;
-		if(closed_by != null) return closed_by;
-		
-		//TODO closed_by = owner.getIssue(number).getClosed_by();
-		return closed_by;
-	}
-	
-	public int getCommentsCount(){
-		return comments;
-	}
+    public GHUser getClosedBy() {
+        if(!"closed".equals(state)) return null;
+        if(closed_by != null) return closed_by;
+        
+        //TODO closed_by = owner.getIssue(number).getClosed_by();
+        return closed_by;
+    }
+    
+    public int getCommentsCount(){
+        return comments;
+    }
 
     /**
      * Returns non-null if this issue is a shadow of a pull request.
      */
-	public PullRequest getPullRequest() {
-		return pull_request;
-	}
+    public PullRequest getPullRequest() {
+        return pull_request;
+    }
 
     public boolean isPullRequest() {
         return pull_request!=null;
     }
 
-	public GHMilestone getMilestone() {
-		return milestone;
-	}
+    public GHMilestone getMilestone() {
+        return milestone;
+    }
 
-	public static class PullRequest{
-		private String diff_url, patch_url, html_url;
-		
-		public URL getDiffUrl() {
-			return GitHub.parseURL(diff_url);
-		}
-		
-		public URL getPatchUrl() {
-			return GitHub.parseURL(patch_url);
-		}
-		
-		public URL getUrl() {
-			return GitHub.parseURL(html_url);
-		}
-	}
+    public static class PullRequest{
+        private String diff_url, patch_url, html_url;
+        
+        public URL getDiffUrl() {
+            return GitHub.parseURL(diff_url);
+        }
+        
+        public URL getPatchUrl() {
+            return GitHub.parseURL(patch_url);
+        }
+        
+        public URL getUrl() {
+            return GitHub.parseURL(html_url);
+        }
+    }
 }

src/main/java/org/kohsuke/github/GHIssueComment.java

@@ -71,4 +71,12 @@ public class GHIssueComment extends GHObject {
     public GHUser getUser() throws IOException {
         return owner.root.getUser(user.getLogin());
     }
+    
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
 }

src/main/java/org/kohsuke/github/GHIssueSearchBuilder.java

@@ -1,9 +1,5 @@
 package org.kohsuke.github;
 
-import org.apache.commons.lang.StringUtils;
-
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Locale;
 
 /**
@@ -12,21 +8,16 @@ import java.util.Locale;
  * @author Kohsuke Kawaguchi
  * @see GitHub#searchIssues()
  */
-public class GHIssueSearchBuilder {
-    private final GitHub root;
-    private final Requester req;
-    private final List<String> terms = new ArrayList<String>();
-
+public class GHIssueSearchBuilder extends GHSearchBuilder<GHIssue> {
     /*package*/ GHIssueSearchBuilder(GitHub root) {
-        this.root = root;
-        req = root.retrieve();
+        super(root,IssueSearchResult.class);
     }
 
     /**
      * Search terms.
      */
     public GHIssueSearchBuilder q(String term) {
-        terms.add(term);
+        super.q(term);
         return this;
     }
 
@@ -61,25 +52,15 @@ public class GHIssueSearchBuilder {
         private GHIssue[] items;
 
         @Override
-        public GHIssue[] getItems() {
+        /*package*/ GHIssue[] getItems(GitHub root) {
+            for (GHIssue i : items)
+                i.wrap(root);
             return items;
         }
     }
 
-    /**
-     * Lists up the issues with the criteria built so far.
-     */
-    public PagedSearchIterable<GHIssue> list() {
-        return new PagedSearchIterable<GHIssue>() {
-            public PagedIterator<GHIssue> iterator() {
-                req.set("q", StringUtils.join(terms," "));
-                return new PagedIterator<GHIssue>(adapt(req.asIterator("/search/issues", IssueSearchResult.class))) {
-                    protected void wrapUp(GHIssue[] page) {
-                        for (GHIssue c : page)
-                            c.wrap(root);
-                    }
-                };
-            }
-        };
+    @Override
+    protected String getApiUrl() {
+        return "/search/issues";
     }
 }

src/main/java/org/kohsuke/github/GHMilestone.java

@@ -1,6 +1,7 @@
 package org.kohsuke.github;
 
 import java.io.IOException;
+import java.net.URL;
 import java.util.Date;
 import java.util.Locale;
 
@@ -11,52 +12,56 @@ import java.util.Locale;
  */
 public class GHMilestone extends GHObject {
     GitHub root;
-	GHRepository owner;
+    GHRepository owner;
 
-	GHUser creator;
-	private String state, due_on, title, description;
-	private int closed_issues, open_issues, number;
+    GHUser creator;
+    private String state, due_on, title, description, html_url;
+    private int closed_issues, open_issues, number;
 
-	public GitHub getRoot() {
-		return root;
-	}
-	
-	public GHRepository getOwner() {
-		return owner;
-	}
-	
-	public GHUser getCreator() {
-		return creator;
-	}
-	
-	public Date getDueOn() {
-		if (due_on == null) return null;
-		return GitHub.parseDate(due_on);
-	}
-	
-	public String getTitle() {
-		return title;
-	}
-	
-	public String getDescription() {
-		return description;
-	}
-	
-	public int getClosedIssues() {
-		return closed_issues;
-	}
-	
-	public int getOpenIssues() {
-		return open_issues;
-	}
-	
-	public int getNumber() {
-		return number;
-	}
-	
-	public GHMilestoneState getState() {
-		return Enum.valueOf(GHMilestoneState.class, state.toUpperCase(Locale.ENGLISH));
-	}
+    public GitHub getRoot() {
+        return root;
+    }
+    
+    public GHRepository getOwner() {
+        return owner;
+    }
+    
+    public GHUser getCreator() {
+        return creator;
+    }
+    
+    public Date getDueOn() {
+        if (due_on == null) return null;
+        return GitHub.parseDate(due_on);
+    }
+    
+    public String getTitle() {
+        return title;
+    }
+    
+    public String getDescription() {
+        return description;
+    }
+    
+    public int getClosedIssues() {
+        return closed_issues;
+    }
+    
+    public int getOpenIssues() {
+        return open_issues;
+    }
+    
+    public int getNumber() {
+        return number;
+    }
+
+    public URL getHtmlUrl() {
+        return GitHub.parseURL(html_url);
+    }
+    
+    public GHMilestoneState getState() {
+        return Enum.valueOf(GHMilestoneState.class, state.toUpperCase(Locale.ENGLISH));
+    }
 
     /**
      * Closes this issue.
@@ -73,9 +78,9 @@ public class GHMilestone extends GHObject {
         return "/repos/"+owner.getOwnerName()+"/"+owner.getName()+"/milestones/"+number;
     }
 
-	public GHMilestone wrap(GHRepository repo) {
-		this.owner = repo;
-		this.root = repo.root;
-		return this;
-	}
+    public GHMilestone wrap(GHRepository repo) {
+        this.owner = repo;
+        this.root = repo.root;
+        return this;
+    }
 }

src/main/java/org/kohsuke/github/GHNotificationStream.java

@@ -0,0 +1,207 @@
+package org.kohsuke.github;
+
+import java.io.IOException;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+/**
+ * Listens to GitHub notification stream.
+ *
+ * <p>
+ * This class supports two modes of retrieving notifications that can
+ * be controlled via {@link #nonBlocking(boolean)}.
+ *
+ * <p>
+ * In the blocking mode, which is the default, iterator will be infinite.
+ * The call to {@link Iterator#next()} will block until a new notification
+ * arrives. This is useful for application that runs perpetually and reacts
+ * to notifications.
+ *
+ * <p>
+ * In the non-blocking mode, the iterator will only report the set of
+ * notifications initially retrieved from GitHub, then quit. This is useful
+ * for a batch application to process the current set of notifications.
+ *
+ * @author Kohsuke Kawaguchi
+ * @see GitHub#listNotifications()
+ * @see GHRepository#listNotifications()
+ */
+public class GHNotificationStream implements Iterable<GHThread> {
+    private final GitHub root;
+
+    private Boolean all, participating;
+    private String since;
+    private String apiUrl;
+    private boolean nonBlocking = false;
+
+    /*package*/ GHNotificationStream(GitHub root, String apiUrl) {
+        this.root = root;
+        this.apiUrl = apiUrl;
+    }
+
+    /**
+     * Should the stream include notifications that are already read?
+     */
+    public GHNotificationStream read(boolean v) {
+        all = v;
+        return this;
+    }
+
+    /**
+     * Should the stream be restricted to notifications in which the user
+     * is directly participating or mentioned?
+     */
+    public GHNotificationStream participating(boolean v) {
+        participating = v;
+        return this;
+    }
+
+    public GHNotificationStream since(long timestamp) {
+        return since(new Date(timestamp));
+    }
+
+    public GHNotificationStream since(Date dt) {
+        since = GitHub.printDate(dt);
+        return this;
+    }
+
+    /**
+     * If set to true, {@link #iterator()} will stop iterating instead of blocking and
+     * waiting for the updates to arrive.
+     */
+    public GHNotificationStream nonBlocking(boolean v) {
+        this.nonBlocking = v;
+        return this;
+    }
+
+    /**
+     * Returns an infinite blocking {@link Iterator} that returns
+     * {@link GHThread} as notifications arrive.
+     */
+    public Iterator<GHThread> iterator() {
+        // capture the configuration setting here
+        final Requester req = new Requester(root).method("GET")
+                .with("all", all).with("participating", participating).with("since", since);
+
+        return new Iterator<GHThread>() {
+            /**
+             * Stuff we've fetched but haven't returned to the caller.
+             * Newer ones first.
+             */
+            private GHThread[] threads = EMPTY_ARRAY;
+
+            /**
+             * Next element in {@link #threads} to return. This counts down.
+             */
+            private int idx=-1;
+
+            /**
+             * threads whose updated_at is older than this should be ignored.
+             */
+            private long lastUpdated = -1;
+
+            /**
+             * Next request should have "If-Modified-Since" header with this value.
+             */
+            private String lastModified;
+
+            /**
+             * When is the next polling allowed?
+             */
+            private long nextCheckTime = -1;
+
+            private GHThread next;
+
+            public GHThread next() {
+                if (next==null) {
+                    next = fetch();
+                    if (next==null)
+                        throw new NoSuchElementException();
+                }
+
+                GHThread r = next;
+                next = null;
+                return r;
+            }
+
+            public boolean hasNext() {
+                if (next==null)
+                    next = fetch();
+                return next!=null;
+            }
+
+            GHThread fetch() {
+                try {
+                    while (true) {// loop until we get new threads to return
+
+                        // if we have fetched un-returned threads, use them first
+                        while (idx>=0) {
+                            GHThread n = threads[idx--];
+                            long nt = n.getUpdatedAt().getTime();
+                            if (nt >= lastUpdated) {
+                                lastUpdated = nt;
+                                return n.wrap(root);
+                            }
+                        }
+
+                        if (nonBlocking && nextCheckTime>=0)
+                            return null;    // nothing more to report, and we aren't blocking
+
+                        // observe the polling interval before making the call
+                        while (true) {
+                            long now = System.currentTimeMillis();
+                            if (nextCheckTime < now) break;
+                            long waitTime = Math.max(Math.min(nextCheckTime - now, 1000), 60 * 1000);
+                            Thread.sleep(waitTime);
+                        }
+
+                        req.setHeader("If-Modified-Since", lastModified);
+
+                        threads = req.to(apiUrl, GHThread[].class);
+                        if (threads==null) {
+                            threads = EMPTY_ARRAY;  // if unmodified, we get empty array
+                        } else {
+                            // we get a new batch, but we want to ignore the ones that we've seen
+                            lastUpdated++;
+                        }
+                        idx = threads.length-1;
+
+                        nextCheckTime = calcNextCheckTime();
+                        lastModified = req.getResponseHeader("Last-Modified");
+                    }
+                } catch (IOException e) {
+                    throw new RuntimeException(e);
+                } catch (InterruptedException e) {
+                    throw new RuntimeException(e);
+                }
+            }
+
+            private long calcNextCheckTime() {
+                String v = req.getResponseHeader("X-Poll-Interval");
+                if (v==null)    v="60";
+                return System.currentTimeMillis()+Integer.parseInt(v)*1000;
+            }
+
+            public void remove() {
+                throw new UnsupportedOperationException();
+            }
+        };
+    }
+
+    public void markAsRead() throws IOException {
+        markAsRead(-1);
+    }
+
+    /**
+     * Marks all the notifications as read.
+     */
+    public void markAsRead(long timestamp) throws IOException {
+        final Requester req = new Requester(root).method("PUT");
+        if (timestamp>=0)
+            req.with("last_read_at", GitHub.printDate(new Date(timestamp)));
+        req.asHttpStatusCode(apiUrl);
+    }
+
+    private static final GHThread[] EMPTY_ARRAY = new GHThread[0];
+}

src/main/java/org/kohsuke/github/GHObject.java

@@ -38,6 +38,12 @@ public abstract class GHObject {
         return GitHub.parseURL(url);
     }
 
+    /**
+     * URL of this object for humans, which renders some HTML.
+     */
+    @WithBridgeMethods(value=String.class, adapterMethod="urlToString")
+    public abstract URL getHtmlUrl();
+
     /**
      * When was this resource last updated?
      */

src/main/java/org/kohsuke/github/GHPerson.java

@@ -2,6 +2,7 @@ package org.kohsuke.github;
 
 import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.net.URL;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Date;
@@ -214,8 +215,9 @@ public abstract class GHPerson extends GHObject {
         return blog;
     }
 
-    public String getHtmlUrl() {
-        return html_url;
+    @Override
+    public URL getHtmlUrl() {
+        return GitHub.parseURL(html_url);
     }
 
     /**

src/main/java/org/kohsuke/github/GHPullRequest.java

@@ -27,7 +27,6 @@ import java.io.IOException;
 import java.net.URL;
 import java.util.Collection;
 import java.util.Date;
-import java.util.Locale;
 
 /**
  * A pull request.
@@ -37,20 +36,20 @@ import java.util.Locale;
  */
 @SuppressWarnings({"UnusedDeclaration"})
 public class GHPullRequest extends GHIssue {
-	
-	private String patch_url, diff_url, issue_url;
-	private GHCommitPointer base;
-	private String merged_at;
-	private GHCommitPointer head;
+
+    private String patch_url, diff_url, issue_url;
+    private GHCommitPointer base;
+    private String merged_at;
+    private GHCommitPointer head;
 
     // details that are only available when obtained from ID
     private GHUser merged_by;
-   	private int review_comments, additions;
-   	private boolean merged;
-   	private Boolean mergeable;
-   	private int deletions;
-   	private String mergeable_state;
-   	private int changed_files;
+    private int review_comments, additions;
+    private boolean merged;
+    private Boolean mergeable;
+    private int deletions;
+    private String mergeable_state;
+    private int changed_files;
 
     /**
      * GitHub doesn't return some properties of {@link GHIssue} when requesting the GET on the 'pulls' API
@@ -60,15 +59,15 @@ public class GHPullRequest extends GHIssue {
     private transient boolean fetchedIssueDetails;
 
 
-	GHPullRequest wrapUp(GHRepository owner) {
-		this.wrap(owner);
+    GHPullRequest wrapUp(GHRepository owner) {
+        this.wrap(owner);
         return wrapUp(owner.root);
     }
-	
+
     GHPullRequest wrapUp(GitHub root) {
-        if (owner!=null)    owner.wrap(root);
-        if (base!=null)     base.wrapUp(root);
-        if (head!=null)     head.wrapUp(root);
+        if (owner != null) owner.wrap(root);
+        if (base != null) base.wrapUp(root);
+        if (head != null) head.wrapUp(root);
         if (merged_by != null) merged_by.wrapUp(root);
         return this;
     }
@@ -85,8 +84,8 @@ public class GHPullRequest extends GHIssue {
     public URL getPatchUrl() {
         return GitHub.parseURL(patch_url);
     }
-	
-	/**
+    
+    /**
      * The URL of the patch file.
      * like https://github.com/jenkinsci/jenkins/pull/100.patch
      */
@@ -108,8 +107,8 @@ public class GHPullRequest extends GHIssue {
     public GHCommitPointer getHead() {
         return head;
     }
-
-	@Deprecated
+    
+    @Deprecated
     public Date getIssueUpdatedAt() throws IOException {
         return super.getUpdatedAt();
     }
@@ -126,65 +125,65 @@ public class GHPullRequest extends GHIssue {
         return GitHub.parseDate(merged_at);
     }
 
-	@Override
-	public Collection<GHLabel> getLabels() throws IOException {
+    @Override
+    public Collection<GHLabel> getLabels() throws IOException {
         fetchIssue();
-		return super.getLabels();
-	}
+        return super.getLabels();
+    }
 
     @Override
-	public GHUser getClosedBy() {
-		return null;
-	}
+    public GHUser getClosedBy() {
+        return null;
+    }
 
-	@Override
-	public PullRequest getPullRequest() {
-		return null;
-	}
+    @Override
+    public PullRequest getPullRequest() {
+        return null;
+    }
 
-//
+    //
 // details that are only available via get with ID
 //
 //
     public GHUser getMergedBy() throws IOException {
         populate();
-   		return merged_by;
-   	}
+        return merged_by;
+    }
 
-   	public int getReviewComments() throws IOException {
+    public int getReviewComments() throws IOException {
         populate();
-   		return review_comments;
-   	}
+        return review_comments;
+    }
 
-   	public int getAdditions() throws IOException {
+    public int getAdditions() throws IOException {
         populate();
-   		return additions;
-   	}
+        return additions;
+    }
 
     public boolean isMerged() throws IOException {
         populate();
-   		return merged;
-   	}
+        return merged;
+    }
 
-   	public Boolean getMergeable() throws IOException {
+    public Boolean getMergeable() throws IOException {
         populate();
-   		return mergeable;
-   	}
+        return mergeable;
+    }
 
-   	public int getDeletions() throws IOException {
+    public int getDeletions() throws IOException {
         populate();
-   		return deletions;
-   	}
+        return deletions;
+    }
 
-   	public String getMergeableState() throws IOException {
+    public String getMergeableState() throws IOException {
         populate();
-   		return mergeable_state;
-   	}
+        return mergeable_state;
+    }
 
-   	public int getChangedFiles() throws IOException {
+    public int getChangedFiles() throws IOException {
         populate();
-   		return changed_files;
-   	}
+        return changed_files;
+    }
 
     /**
      * Fully populate the data by retrieving missing data.
@@ -197,6 +196,39 @@ public class GHPullRequest extends GHIssue {
         root.retrieve().to(url, this).wrapUp(owner);
     }
 
+    /**
+     * Retrieves all the commits associated to this pull request.
+     */
+    public PagedIterable<GHPullRequestFileDetail> listFiles() {
+        return new PagedIterable<GHPullRequestFileDetail>() {
+            public PagedIterator<GHPullRequestFileDetail> iterator() {
+                return new PagedIterator<GHPullRequestFileDetail>(root.retrieve().asIterator(String.format("%s/files", getApiURL()),
+                        GHPullRequestFileDetail[].class)) {
+                    @Override
+                    protected void wrapUp(GHPullRequestFileDetail[] page) {
+                    }
+                };
+            }
+        };
+    }
+
+    /**
+     * Obtains all the review comments associated with this pull request.
+     */
+    public PagedIterable<GHPullRequestReviewComment> listReviewComments() throws IOException {
+        return new PagedIterable<GHPullRequestReviewComment>() {
+            public PagedIterator<GHPullRequestReviewComment> iterator() {
+                return new PagedIterator<GHPullRequestReviewComment>(root.retrieve().asIterator(getApiRoute() + "/comments",
+                        GHPullRequestReviewComment[].class)) {
+                    protected void wrapUp(GHPullRequestReviewComment[] page) {
+                        for (GHPullRequestReviewComment c : page)
+                            c.wrapUp(GHPullRequest.this);
+                    }
+                };
+            }
+        };
+    }
+
     /**
      * Retrieves all the commits associated to this pull request.
      */
@@ -208,12 +240,23 @@ public class GHPullRequest extends GHIssue {
                         GHPullRequestCommitDetail[].class)) {
                     @Override
                     protected void wrapUp(GHPullRequestCommitDetail[] page) {
+                        for (GHPullRequestCommitDetail c : page)
+                            c.wrapUp(GHPullRequest.this);
                     }
                 };
             }
         };
     }
 
+    public GHPullRequestReviewComment createReviewComment(String body, String sha, String path, int position) throws IOException {
+        return new Requester(root).method("POST")
+                .with("body", body)
+                .with("commit_id", sha)
+                .with("path", path)
+                .with("position", position)
+                .to(getApiRoute() + "/comments", GHPullRequestReviewComment.class).wrapUp(this);
+    }
+
     /**
      * Merge this pull request.
      *
@@ -223,7 +266,21 @@ public class GHPullRequest extends GHIssue {
      *      Commit message. If null, the default one will be used.
      */
     public void merge(String msg) throws IOException {
-        new Requester(root).method("PUT").with("commit_message",msg).to(getApiRoute()+"/merge");
+        merge(msg,null);
+    }
+
+    /**
+     * Merge this pull request.
+     *
+     * The equivalent of the big green "Merge pull request" button.
+     *
+     * @param msg
+     *      Commit message. If null, the default one will be used.
+     * @param sha
+     *      SHA that pull request head must match to allow merge.
+     */
+    public void merge(String msg, String sha) throws IOException {
+        new Requester(root).method("PUT").with("commit_message",msg).with("sha",sha).to(getApiRoute()+"/merge");
     }
 
     private void fetchIssue() throws IOException {

src/main/java/org/kohsuke/github/GHPullRequestCommitDetail.java

@@ -31,99 +31,111 @@ import java.net.URL;
  * Commit detail inside a {@link GHPullRequest}.
  * 
  * @author Luca Milanesio
+ * @see GHPullRequest#listCommits()
  */
 public class GHPullRequestCommitDetail {
+    private GHPullRequest owner;
+
+    /*package*/ void wrapUp(GHPullRequest owner) {
+        this.owner = owner;
+    }
 
     /**
      * @deprecated Use {@link GitUser}
      */
-    public static class Authorship extends GitUser {}
+    public static class Authorship extends GitUser {
+    }
 
     public static class Tree {
+        String sha;
+        String url;
+
+        public String getSha() {
+            return sha;
+        }
+
+        public URL getUrl() {
+            return GitHub.parseURL(url);
+        }
+    }
+
+    public static class Commit {
+        Authorship author;
+        Authorship committer;
+        String message;
+        Tree tree;
+        String url;
+        int comment_count;
+
+        @WithBridgeMethods(value = Authorship.class, castRequired = true)
+        public GitUser getAuthor() {
+            return author;
+        }
+
+        @WithBridgeMethods(value = Authorship.class, castRequired = true)
+        public GitUser getCommitter() {
+            return committer;
+        }
+
+        public String getMessage() {
+            return message;
+        }
+
+        public URL getUrl() {
+            return GitHub.parseURL(url);
+        }
+
+        public int getComment_count() {
+            return comment_count;
+        }
+    }
+
+    public static class CommitPointer {
+        String sha;
+        String url;
+        String html_url;
+
+        public URL getUrl() {
+            return GitHub.parseURL(url);
+        }
+
+        public URL getHtml_url() {
+            return GitHub.parseURL(html_url);
+        }
+
+        public String getSha() {
+            return sha;
+        }
+    }
+
     String sha;
-    String url;
-
-    public String getSha() {
-      return sha;
-    }
-
-    public URL getUrl() {
-      return GitHub.parseURL(url);
-    }
-  }
-
-  public static class Commit {
-    Authorship author;
-    Authorship committer;
-    String message;
-    Tree tree;
-    String url;
-    int comment_count;
-
-    @WithBridgeMethods(value=Authorship.class,castRequired=true)
-    public GitUser getAuthor() {
-      return author;
-    }
-
-    @WithBridgeMethods(value=Authorship.class,castRequired=true)
-    public GitUser getCommitter() {
-      return committer;
-    }
-
-    public String getMessage() {
-      return message;
-    }
-
-    public URL getUrl() {
-      return GitHub.parseURL(url);
-    }
-
-    public int getComment_count() {
-      return comment_count;
-    }
-  }
-
-  public static class CommitPointer {
-    String sha;
+    Commit commit;
     String url;
     String html_url;
-
-    public URL getUrl() {
-      return GitHub.parseURL(url);
-    }
-
-    public URL getHtml_url() {
-      return GitHub.parseURL(html_url);
-    }
+    String comments_url;
+    CommitPointer[] parents;
 
     public String getSha() {
-      return sha;
+        return sha;
     }
-  }
 
-  String sha;
-  Commit commit;
-  String url;
-  String html_url;
-  String comments_url;
-  CommitPointer[] parents;
-  
-  public String getSha() {
-    return sha;
-  }
-  public Commit getCommit() {
-    return commit;
-  }
-  public URL getApiUrl() {
-    return GitHub.parseURL(url);
-  }
-  public URL getUrl() {
-    return GitHub.parseURL(html_url);
-  }
-  public URL getCommentsUrl() {
-    return GitHub.parseURL(comments_url);
-  }
-  public CommitPointer[] getParents() {
-    return parents;
-  }
+    public Commit getCommit() {
+        return commit;
+    }
+
+    public URL getApiUrl() {
+        return GitHub.parseURL(url);
+    }
+
+    public URL getUrl() {
+        return GitHub.parseURL(html_url);
+    }
+
+    public URL getCommentsUrl() {
+        return GitHub.parseURL(comments_url);
+    }
+
+    public CommitPointer[] getParents() {
+        return parents;
+    }
 }

src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java

@@ -0,0 +1,86 @@
+/*
+ * The MIT License
+ * 
+ * Copyright (c) 2015, Julien Henry
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.kohsuke.github;
+
+import java.net.URL;
+
+/**
+ * File detail inside a {@link GHPullRequest}.
+ * 
+ * @author Julien Henry
+ * @see GHPullRequest#listFiles()
+ */
+public class GHPullRequestFileDetail {
+
+    String sha;
+    String filename;
+    String status;
+    int additions;
+    int deletions;
+    int changes;
+    String blob_url;
+    String raw_url;
+    String contents_url;
+    String patch;
+
+    public String getSha() {
+        return sha;
+    }
+
+    public String getFilename() {
+        return filename;
+    }
+
+    public String getStatus() {
+        return status;
+    }
+
+    public int getAdditions() {
+        return additions;
+    }
+
+    public int getDeletions() {
+        return deletions;
+    }
+
+    public int getChanges() {
+        return changes;
+    }
+
+    public URL getBlobUrl() {
+        return GitHub.parseURL(blob_url);
+    }
+
+    public URL getRawUrl() {
+        return GitHub.parseURL(raw_url);
+    }
+
+    public URL getContentsUrl() {
+        return GitHub.parseURL(contents_url);
+    }
+
+    public String getPatch() {
+        return patch;
+    }
+}

src/main/java/org/kohsuke/github/GHPullRequestReviewComment.java

@@ -0,0 +1,105 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2010, Kohsuke Kawaguchi
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.kohsuke.github;
+
+import java.io.IOException;
+import java.net.URL;
+
+/**
+ * Review comment to the pull request
+ *
+ * @author Julien Henry
+ * @see GHPullRequest#listReviewComments()
+ * @see GHPullRequest#createReviewComment(String, String, String, int)
+ */
+public class GHPullRequestReviewComment extends GHObject {
+    GHPullRequest owner;
+
+    private String body;
+    private GHUser user;
+    private String path;
+    private int position;
+    private int originalPosition;
+
+    /*package*/ GHPullRequestReviewComment wrapUp(GHPullRequest owner) {
+        this.owner = owner;
+        return this;
+    }
+
+    /**
+     * Gets the pull request to which this review comment is associated.
+     */
+    public GHPullRequest getParent() {
+        return owner;
+    }
+
+    /**
+     * The comment itself.
+     */
+    public String getBody() {
+        return body;
+    }
+
+    /**
+     * Gets the user who posted this comment.
+     */
+    public GHUser getUser() throws IOException {
+        return owner.root.getUser(user.getLogin());
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    public int getPosition() {
+        return position;
+    }
+
+    public int getOriginalPosition() {
+        return originalPosition;
+    }
+
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
+
+    protected String getApiRoute() {
+        return "/repos/"+owner.getRepository().getFullName()+"/comments/"+id;
+    }
+
+    /**
+     * Updates the comment.
+     */
+    public void update(String body) throws IOException {
+        new Requester(owner.root).method("PATCH").with("body", body).to(getApiRoute(),this);
+    }
+
+    /**
+     * Deletes this review comment.
+     */
+    public void delete() throws IOException {
+        new Requester(owner.root).method("DELETE").to(getApiRoute());
+    }
+}

src/main/java/org/kohsuke/github/GHRelease.java

@@ -3,6 +3,7 @@ package org.kohsuke.github;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.net.URL;
 import java.util.Arrays;
 import java.util.Date;
 import java.util.List;
@@ -44,8 +45,8 @@ public class GHRelease extends GHObject {
         return draft;
     }
 
-    public String getHtmlUrl() {
-        return html_url;
+    public URL getHtmlUrl() {
+        return GitHub.parseURL(html_url);
     }
 
     public String getName() {

src/main/java/org/kohsuke/github/GHRepository.java

@@ -63,6 +63,8 @@ public class GHRepository extends GHObject {
 
     private GHRepoPermission permissions;
 
+    private GHRepository source, parent;
+    
     public GHDeploymentBuilder createDeployment(String ref) {
         return new GHDeploymentBuilder(this,ref);
     }
@@ -159,6 +161,10 @@ public class GHRepository extends GHObject {
         return ssh_url;
     }
 
+    public URL getHtmlUrl() {
+        return GitHub.parseURL(html_url);
+    }
+    
     /**
      * Short repository name without the owner. For example 'jenkins' in case of http://github.com/jenkinsci/jenkins
      */
@@ -353,7 +359,7 @@ public class GHRepository extends GHObject {
     }
 
     /**
-     * Returns the primary branch you'll configure in the "Admin > Options" config page.
+     * Returns the primary branch you'll configure in the "Admin > Options" config page.
      *
      * @return
      *      This field is null until the user explicitly configures the master branch.
@@ -642,48 +648,48 @@ public class GHRepository extends GHObject {
         return GHRef.wrap(root.retrieve().to(String.format("/repos/%s/%s/git/refs/%s", owner.login, name, refType), GHRef[].class),root);
     }
     /**
-	 * Retrive a ref of the given type for the current GitHub repository.
-	 * 
-	 * @param refName
-	 *            eg: heads/branch
-	 * @return refs matching the request type
-	 * @throws IOException
-	 *             on failure communicating with GitHub, potentially due to an
-	 *             invalid ref type being requested
-	 */
-	public GHRef getRef(String refName) throws IOException {
-		return root.retrieve().to(String.format("/repos/%s/%s/git/refs/%s", owner.login, name, refName), GHRef.class).wrap(root);
-	}
+     * Retrive a ref of the given type for the current GitHub repository.
+     * 
+     * @param refName
+     *            eg: heads/branch
+     * @return refs matching the request type
+     * @throws IOException
+     *             on failure communicating with GitHub, potentially due to an
+     *             invalid ref type being requested
+     */
+    public GHRef getRef(String refName) throws IOException {
+        return root.retrieve().to(String.format("/repos/%s/%s/git/refs/%s", owner.login, name, refName), GHRef.class).wrap(root);
+    }
     /**
-	 * Retrive a tree of the given type for the current GitHub repository.
-	 * 
-	 * @param sha - sha number or branch name ex: "master"
-	 * @return refs matching the request type
-	 * @throws IOException
-	 *             on failure communicating with GitHub, potentially due to an
-	 *             invalid tree type being requested
-	 */
-	public GHTree getTree(String sha) throws IOException {
-		String url = String.format("/repos/%s/%s/git/trees/%s", owner.login, name, sha);
-		return root.retrieve().to(url, GHTree.class).wrap(root);
-	}
-	
-	/**
-	 * Retrieves the tree for the current GitHub repository, recursively as described in here:
-	 * https://developer.github.com/v3/git/trees/#get-a-tree-recursively
-	 * 
-	 * @param sha - sha number or branch name ex: "master"
-	 * @param recursive use 1
-	 * @throws IOException
-	 *             on failure communicating with GitHub, potentially due to an
-	 *             invalid tree type being requested
-	 */
-	public GHTree getTreeRecursive(String sha, int recursive) throws IOException {
-		String url = String.format("/repos/%s/%s/git/trees/%s?recursive=%d", owner.login, name, sha, recursive);
-		return root.retrieve().to(url, GHTree.class).wrap(root);
-	}
+     * Retrive a tree of the given type for the current GitHub repository.
+     * 
+     * @param sha - sha number or branch name ex: "master"
+     * @return refs matching the request type
+     * @throws IOException
+     *             on failure communicating with GitHub, potentially due to an
+     *             invalid tree type being requested
+     */
+    public GHTree getTree(String sha) throws IOException {
+        String url = String.format("/repos/%s/%s/git/trees/%s", owner.login, name, sha);
+        return root.retrieve().to(url, GHTree.class).wrap(root);
+    }
+    
+    /**
+     * Retrieves the tree for the current GitHub repository, recursively as described in here:
+     * https://developer.github.com/v3/git/trees/#get-a-tree-recursively
+     * 
+     * @param sha - sha number or branch name ex: "master"
+     * @param recursive use 1
+     * @throws IOException
+     *             on failure communicating with GitHub, potentially due to an
+     *             invalid tree type being requested
+     */
+    public GHTree getTreeRecursive(String sha, int recursive) throws IOException {
+        String url = String.format("/repos/%s/%s/git/trees/%s?recursive=%d", owner.login, name, sha, recursive);
+        return root.retrieve().to(url, GHTree.class).wrap(root);
+    }
 
-	/**
+    /**
      * Gets a commit object in this repository.
      */
     public GHCommit getCommit(String sha1) throws IOException {
@@ -780,10 +786,10 @@ public class GHRepository extends GHObject {
     }
     
     /**
-     *  @see {@link #createCommitStatus(String, GHCommitState,String,String,String) createCommitStatus} 
+     *  @see #createCommitStatus(String, GHCommitState,String,String,String)
      */
     public GHCommitStatus createCommitStatus(String sha1, GHCommitState state, String targetUrl, String description) throws IOException {
-    	return createCommitStatus(sha1, state, targetUrl, description,null);
+        return createCommitStatus(sha1, state, targetUrl, description,null);
     }
 
     /**
@@ -989,10 +995,10 @@ public class GHRepository extends GHObject {
      */
     public Map<Integer, GHMilestone> getMilestones() throws IOException {
         Map<Integer,GHMilestone> milestones = new TreeMap<Integer, GHMilestone>();
-    	for (GHMilestone m : listMilestones(GHIssueState.OPEN)) {
-    		milestones.put(m.getNumber(), m);
-    	}
-    	return milestones;
+        for (GHMilestone m : listMilestones(GHIssueState.OPEN)) {
+            milestones.put(m.getNumber(), m);
+        }
+        return milestones;
     }
 
     /**
@@ -1012,16 +1018,16 @@ public class GHRepository extends GHObject {
         };
     }
 
-	public GHMilestone getMilestone(int number) throws IOException {
-		GHMilestone m = milestones.get(number);
-		if (m == null) {
+    public GHMilestone getMilestone(int number) throws IOException {
+        GHMilestone m = milestones.get(number);
+        if (m == null) {
             m = root.retrieve().to(getApiTailUrl("milestones/" + number), GHMilestone.class);
-    		m.owner = this;
-    		m.root = root;
-			milestones.put(m.getNumber(), m);
-		}
-		return m;
-	}
+            m.owner = this;
+            m.root = root;
+            milestones.put(m.getNumber(), m);
+        }
+        return m;
+    }
 
     public GHContent getFileContent(String path) throws IOException {
         return getFileContent(path, null);
@@ -1088,25 +1094,57 @@ public class GHRepository extends GHObject {
         return response;
     }
 
-	public GHMilestone createMilestone(String title, String description) throws IOException {
+    public GHMilestone createMilestone(String title, String description) throws IOException {
         return new Requester(root)
                 .with("title", title).with("description", description).method("POST").to(getApiTailUrl("milestones"), GHMilestone.class).wrap(this);
-	}
-	
-	public GHDeployKey addDeployKey(String title,String key) throws IOException {
-		 return new Requester(root)
+    }
+    
+    public GHDeployKey addDeployKey(String title,String key) throws IOException {
+         return new Requester(root)
          .with("title", title).with("key", key).method("POST").to(getApiTailUrl("keys"), GHDeployKey.class).wrap(this);
-		
-	}
-	
-	public List<GHDeployKey> getDeployKeys() throws IOException{
-		 List<GHDeployKey> list = new ArrayList<GHDeployKey>(Arrays.asList(
-	                root.retrieve().to(getApiTailUrl("keys"), GHDeployKey[].class)));
-	        for (GHDeployKey h : list)
-	            h.wrap(this);
-	        return list;	
-	}
+        
+    }
+    
+    public List<GHDeployKey> getDeployKeys() throws IOException{
+         List<GHDeployKey> list = new ArrayList<GHDeployKey>(Arrays.asList(
+                    root.retrieve().to(getApiTailUrl("keys"), GHDeployKey[].class)));
+            for (GHDeployKey h : list)
+                h.wrap(this);
+            return list;    
+    }
 
+    /**
+     * Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.
+     *
+     * @return
+     *      {@link GHRepository} that points to the root repository where this repository is forked
+     *      (indirectly or directly) from. Otherwise null.
+     * @see #getParent()       
+     */
+    public GHRepository getSource() throws IOException {
+        if (source == null) return null;
+        if (source.root == null)
+            source = root.getRepository(source.getFullName());
+        return source;
+    }
+
+    /**
+     * Forked repositories have a 'parent' attribute that specifies the repository this repository
+     * is directly forked from. If we keep traversing {@link #getParent()} until it returns null, that
+     * is {@link #getSource()}.
+     *
+     * @return
+     *      {@link GHRepository} that points to the repository where this repository is forked
+     *      directly from. Otherwise null.
+     * @see #getSource()      
+     */
+    public GHRepository getParent() throws IOException {
+        if (parent == null) return null;
+        if (parent.root == null)
+            parent = root.getRepository(parent.getFullName());
+        return parent;
+    }
+    
     /**
      * Subscribes to this repository to get notifications.
      */
@@ -1166,11 +1204,17 @@ public class GHRepository extends GHObject {
                     .with("text", text)
                     .with("mode",mode==null?null:mode.toString())
                     .with("context", getFullName())
-                    .read("/markdown"),
+                    .asStream("/markdown"),
             "UTF-8");
     }
 
-	
+    /**
+     * List all the notifications in a repository for the current user.
+     */
+    public GHNotificationStream listNotifications() {
+        return new GHNotificationStream(root,getApiTailUrl("/notifications"));
+    }
+
 
     @Override
     public String toString() {

src/main/java/org/kohsuke/github/GHRepositorySearchBuilder.java

@@ -0,0 +1,82 @@
+package org.kohsuke.github;
+
+import java.util.Locale;
+
+/**
+ * Search repositories.
+ *
+ * @author Kohsuke Kawaguchi
+ * @see GitHub#searchRepositories()
+ */
+public class GHRepositorySearchBuilder extends GHSearchBuilder<GHRepository> {
+    /*package*/ GHRepositorySearchBuilder(GitHub root) {
+        super(root,RepositorySearchResult.class);
+    }
+
+    /**
+     * Search terms.
+     */
+    public GHRepositorySearchBuilder q(String term) {
+        super.q(term);
+        return this;
+    }
+
+    public GHRepositorySearchBuilder in(String v) {
+        return q("in:"+v);
+    }
+
+    public GHRepositorySearchBuilder size(String v) {
+        return q("size:"+v);
+    }
+
+    public GHRepositorySearchBuilder forks(String v) {
+        return q("forks:"+v);
+    }
+
+    public GHRepositorySearchBuilder created(String v) {
+        return q("created:"+v);
+    }
+
+    public GHRepositorySearchBuilder pushed(String v) {
+        return q("pushed:"+v);
+    }
+
+    public GHRepositorySearchBuilder user(String v) {
+        return q("user:"+v);
+    }
+
+    public GHRepositorySearchBuilder repo(String v) {
+        return q("repo:"+v);
+    }
+
+    public GHRepositorySearchBuilder language(String v) {
+        return q("language:"+v);
+    }
+
+    public GHRepositorySearchBuilder stars(String v) {
+        return q("stars:"+v);
+    }
+
+    public GHRepositorySearchBuilder sort(Sort sort) {
+        req.with("sort",sort.toString().toLowerCase(Locale.ENGLISH));
+        return this;
+    }
+
+    public enum Sort { STARS, FORKS, UPDATED }
+
+    private static class RepositorySearchResult extends SearchResult<GHRepository> {
+        private GHRepository[] items;
+
+        @Override
+        /*package*/ GHRepository[] getItems(GitHub root) {
+            for (GHRepository item : items)
+                item.wrap(root);
+            return items;
+        }
+    }
+
+    @Override
+    protected String getApiUrl() {
+        return "/search/repositories";
+    }
+}

src/main/java/org/kohsuke/github/GHSearchBuilder.java

@@ -0,0 +1,54 @@
+package org.kohsuke.github;
+
+import org.apache.commons.lang.StringUtils;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Base class for various search builders.
+ *
+ * @author Kohsuke Kawaguchi
+ */
+public abstract class GHSearchBuilder<T> {
+    protected final GitHub root;
+    protected final Requester req;
+    protected final List<String> terms = new ArrayList<String>();
+
+    /**
+     * Data transfer object that receives the result of search.
+     */
+    private final Class<? extends SearchResult<T>> receiverType;
+
+    /*package*/ GHSearchBuilder(GitHub root, Class<? extends SearchResult<T>> receiverType) {
+        this.root = root;
+        this.req = root.retrieve();
+        this.receiverType = receiverType;
+    }
+
+    /**
+     * Search terms.
+     */
+    public GHSearchBuilder q(String term) {
+        terms.add(term);
+        return this;
+    }
+
+    /**
+     * Performs the search.
+     */
+    public PagedSearchIterable<T> list() {
+        return new PagedSearchIterable<T>(root) {
+            public PagedIterator<T> iterator() {
+                req.set("q", StringUtils.join(terms, " "));
+                return new PagedIterator<T>(adapt(req.asIterator(getApiUrl(), receiverType))) {
+                    protected void wrapUp(T[] page) {
+                        // SearchResult.getItems() should do it
+                    }
+                };
+            }
+        };
+    }
+
+    protected abstract String getApiUrl();
+}

src/main/java/org/kohsuke/github/GHSubscription.java

@@ -4,9 +4,11 @@ import java.io.IOException;
 import java.util.Date;
 
 /**
- * Represents your subscribing to a repository.
+ * Represents your subscribing to a repository / conversation thread..
  *
  * @author Kohsuke Kawaguchi
+ * @see GHRepository#getSubscription()
+ * @see GHThread#getSubscription()
  */
 public class GHSubscription {
     private String created_at, url, repository_url, reason;

src/main/java/org/kohsuke/github/GHTeam.java

@@ -47,10 +47,10 @@ public class GHTeam {
         return id;
     }
 
-	/**
-	 * Retrieves the current members.
-	 */
-	public PagedIterable<GHUser> listMembers() throws IOException {
+    /**
+     * Retrieves the current members.
+     */
+    public PagedIterable<GHUser> listMembers() throws IOException {
         return new PagedIterable<GHUser>() {
             public PagedIterator<GHUser> iterator() {
                 return new PagedIterator<GHUser>(org.root.retrieve().asIterator(api("/members"), GHUser[].class)) {
@@ -64,8 +64,8 @@ public class GHTeam {
     }
 
     public Set<GHUser> getMembers() throws IOException {
-		return Collections.unmodifiableSet(listMembers().asSet());
-	}
+        return Collections.unmodifiableSet(listMembers().asSet());
+    }
 
     /**
      * Checks if this team has the specified user as a member.

src/main/java/org/kohsuke/github/GHThread.java

@@ -0,0 +1,142 @@
+package org.kohsuke.github;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.net.URL;
+import java.util.Date;
+
+/**
+ * A conversation in the notification API.
+ *
+ * @see <a href="https://developer.github.com/v3/activity/notifications/">documentation</a>
+ * @see GHNotificationStream
+ * @author Kohsuke Kawaguchi
+ */
+public class GHThread extends GHObject {
+    private GitHub root;
+    private GHRepository repository;
+    private Subject subject;
+    private String reason;
+    private boolean unread;
+    private String last_read_at;
+    private String url,subscription_url;
+
+    static class Subject {
+        String title;
+        String url;
+        String latest_comment_url;
+        String type;
+    }
+
+    private GHThread() {// no external construction allowed
+    }
+
+    /**
+     * Returns null if the entire thread has never been read.
+     */
+    public Date getLastReadAt() {
+        return GitHub.parseDate(last_read_at);
+    }
+
+    /**
+     * @deprecated This object has no HTML URL.
+     */
+    @Override
+    public URL getHtmlUrl() {
+        return null;
+    }
+
+    public String getReason() {
+        return reason;
+    }
+
+    public GHRepository getRepository() {
+        return repository;
+    }
+
+    // TODO: how to expose the subject?
+
+    public boolean isRead() {
+        return !unread;
+    }
+
+    public String getTitle() {
+        return subject.title;
+    }
+
+    public String getType() {
+        return subject.type;
+    }
+
+    /**
+     * If this thread is about an issue, return that issue.
+     * 
+     * @return null if this thread is not about an issue.
+     */
+    public GHIssue getBoundIssue() throws IOException {
+        if (!"Issue".equals(subject.type) && "PullRequest".equals(subject.type))
+            return null;
+        return repository.getIssue(
+                Integer.parseInt(subject.url.substring(subject.url.lastIndexOf('/') + 1)));
+    }
+
+    /**
+     * If this thread is about a pull request, return that pull request.
+     *
+     * @return null if this thread is not about a pull request.
+     */
+    public GHPullRequest getBoundPullRequest() throws IOException {
+        if (!"PullRequest".equals(subject.type))
+            return null;
+        return repository.getPullRequest(
+                Integer.parseInt(subject.url.substring(subject.url.lastIndexOf('/') + 1)));
+    }
+
+    /**
+     * If this thread is about a commit, return that commit.
+     *
+     * @return null if this thread is not about a commit.
+     */
+    public GHCommit getBoundCommit() throws IOException {
+        if (!"Commit".equals(subject.type))
+            return null;
+        return repository.getCommit(subject.url.substring(subject.url.lastIndexOf('/') + 1));
+    }
+
+    /*package*/ GHThread wrap(GitHub root) {
+        this.root = root;
+        if (this.repository!=null)
+            this.repository.wrap(root);
+        return this;
+    }
+
+    /**
+     * Marks this thread as read.
+     */
+    public void markAsRead() throws IOException {
+        new Requester(root).method("PATCH").to(url);
+    }
+
+    /**
+     * Subscribes to this conversation to get notifications.
+     */
+    public GHSubscription subscribe(boolean subscribed, boolean ignored) throws IOException {
+        return new Requester(root)
+            .with("subscribed", subscribed)
+            .with("ignored", ignored)
+            .method("PUT").to(subscription_url, GHSubscription.class).wrapUp(root);
+    }
+
+    /**
+     * Returns the current subscription for this thread.
+     *
+     * @return null if no subscription exists.
+     */
+    public GHSubscription getSubscription() throws IOException {
+        try {
+            return new Requester(root).to(subscription_url, GHSubscription.class).wrapUp(root);
+        } catch (FileNotFoundException e) {
+            return null;
+        }
+    }
+}

src/main/java/org/kohsuke/github/GHTree.java

@@ -13,46 +13,46 @@ import java.util.List;
  * @see GHRepository#getTree(String)
  */
 public class GHTree {
-	/* package almost final */GitHub root;
+    /* package almost final */GitHub root;
 
-	private boolean truncated;
-	private String sha, url;
-	private GHTreeEntry[] tree;
+    private boolean truncated;
+    private String sha, url;
+    private GHTreeEntry[] tree;
 
-	/**
-	 * The SHA for this trees
-	 */
-	public String getSha() {
-		return sha;
-	}
+    /**
+     * The SHA for this trees
+     */
+    public String getSha() {
+        return sha;
+    }
 
-	/**
-	 * Return an array of entries of the trees
-	 * @return
-	 */
-	public List<GHTreeEntry> getTree() {
-		return Collections.unmodifiableList(Arrays.asList(tree));
-	}
+    /**
+     * Return an array of entries of the trees
+     * @return
+     */
+    public List<GHTreeEntry> getTree() {
+        return Collections.unmodifiableList(Arrays.asList(tree));
+    }
 
-	/**
-	 * Returns true if the number of items in the tree array exceeded the GitHub maximum limit. 
-	 * @return true true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false.
-	 */
-	public boolean isTruncated() {
-		return truncated;
-	}
+    /**
+     * Returns true if the number of items in the tree array exceeded the GitHub maximum limit. 
+     * @return true true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false.
+     */
+    public boolean isTruncated() {
+        return truncated;
+    }
 
-	/**
-	 * The API URL of this tag, such as
-	 * "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7",
-	 */
-	public URL getUrl() {
-		return GitHub.parseURL(url);
-	}
+    /**
+     * The API URL of this tag, such as
+     * "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7",
+     */
+    public URL getUrl() {
+        return GitHub.parseURL(url);
+    }
 
-	/* package */GHTree wrap(GitHub root) {
-		this.root = root;
-		return this;
-	}
+    /* package */GHTree wrap(GitHub root) {
+        this.root = root;
+        return this;
+    }
 
 }

src/main/java/org/kohsuke/github/GHUserSearchBuilder.java

@@ -0,0 +1,72 @@
+package org.kohsuke.github;
+
+import java.util.Locale;
+
+/**
+ * Search users.
+ *
+ * @author Kohsuke Kawaguchi
+ * @see GitHub#searchUsers()
+ */
+public class GHUserSearchBuilder extends GHSearchBuilder<GHUser> {
+    /*package*/ GHUserSearchBuilder(GitHub root) {
+        super(root,UserSearchResult.class);
+    }
+
+    /**
+     * Search terms.
+     */
+    public GHUserSearchBuilder q(String term) {
+        super.q(term);
+        return this;
+    }
+
+    public GHUserSearchBuilder type(String v) {
+        return q("type:"+v);
+    }
+
+    public GHUserSearchBuilder in(String v) {
+        return q("in:"+v);
+    }
+
+    public GHUserSearchBuilder repos(String v) {
+        return q("repos:"+v);
+    }
+
+    public GHUserSearchBuilder location(String v) {
+        return q("location:"+v);
+    }
+
+    public GHUserSearchBuilder language(String v) {
+        return q("language:"+v);
+    }
+
+    public GHUserSearchBuilder created(String v) {
+        return q("created:"+v);
+    }
+
+    public GHUserSearchBuilder followers(String v) {
+        return q("followers:"+v);
+    }
+
+    public GHUserSearchBuilder sort(Sort sort) {
+        req.with("sort",sort.toString().toLowerCase(Locale.ENGLISH));
+        return this;
+    }
+
+    public enum Sort { FOLLOWERS, REPOSITORIES, JOINED }
+
+    private static class UserSearchResult extends SearchResult<GHUser> {
+        private GHUser[] items;
+
+        @Override
+        /*package*/ GHUser[] getItems(GitHub root) {
+            return GHUser.wrap(items,root);
+        }
+    }
+
+    @Override
+    protected String getApiUrl() {
+        return "/search/users";
+    }
+}

src/main/java/org/kohsuke/github/GitHub.java

@@ -60,7 +60,7 @@ import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
  * <p>
  * This library aims to be safe for use by multiple threads concurrently, although
  * the library itself makes no attempt to control/serialize potentially conflicting
- * operations to GitHub, such as updating & deleting a repository at the same time.
+ * operations to GitHub, such as updating &amp; deleting a repository at the same time.
  *
  * @author Kohsuke Kawaguchi
  */
@@ -133,10 +133,11 @@ public class GitHub {
             }
         }
 
+        this.rateLimitHandler = rateLimitHandler;
+
         if (login==null && encodedAuthorization!=null)
             login = getMyself().getLogin();
         this.login = login;
-        this.rateLimitHandler = rateLimitHandler;
     }
 
     /**
@@ -252,11 +253,11 @@ public class GitHub {
     }
 
     /**
-	 * Gets the {@link GHUser} that represents yourself.
-	 */
+     * Gets the {@link GHUser} that represents yourself.
+     */
     @WithBridgeMethods(GHUser.class)
-	public GHMyself getMyself() throws IOException {
-		requireCredential();
+    public GHMyself getMyself() throws IOException {
+        requireCredential();
 
         GHMyself u = retrieve().to("/user", GHMyself.class);
 
@@ -264,20 +265,20 @@ public class GitHub {
         users.put(u.getLogin(), u);
 
         return u;
-	}
+    }
 
-	/**
-	 * Obtains the object that represents the named user.
-	 */
-	public GHUser getUser(String login) throws IOException {
-		GHUser u = users.get(login);
-		if (u == null) {
+    /**
+     * Obtains the object that represents the named user.
+     */
+    public GHUser getUser(String login) throws IOException {
+        GHUser u = users.get(login);
+        if (u == null) {
             u = retrieve().to("/users/" + login, GHUser.class);
             u.root = this;
             users.put(u.getLogin(), u);
-		}
-		return u;
-	}
+        }
+        return u;
+    }
 
 
     /**
@@ -415,14 +416,14 @@ public class GitHub {
      *
      * @see <a href="http://developer.github.com/v3/oauth/#create-a-new-authorization">Documentation</a>
      */
-	public GHAuthorization createToken(Collection<String> scope, String note, String noteUrl) throws IOException{
-		Requester requester = new Requester(this)
-				.with("scopes", scope)
-				.with("note", note)
-				.with("note_url", noteUrl);
+    public GHAuthorization createToken(Collection<String> scope, String note, String noteUrl) throws IOException{
+        Requester requester = new Requester(this)
+                .with("scopes", scope)
+                .with("note", note)
+                .with("note_url", noteUrl);
 
-		return requester.method("POST").to("/authorizations", GHAuthorization.class).wrap(this);
-	}
+        return requester.method("POST").to("/authorizations", GHAuthorization.class).wrap(this);
+    }
 
     /**
      * Ensures that the credential is valid.
@@ -443,6 +444,34 @@ public class GitHub {
         return new GHIssueSearchBuilder(this);
     }
 
+    /**
+     * Search users.
+     */
+    public GHUserSearchBuilder searchUsers() {
+        return new GHUserSearchBuilder(this);
+    }
+
+    /**
+     * Search repositories.
+     */
+    public GHRepositorySearchBuilder searchRepositories() {
+        return new GHRepositorySearchBuilder(this);
+    }
+
+    /**
+     * Search content.
+     */
+    public GHContentSearchBuilder searchContent() {
+        return new GHContentSearchBuilder(this);
+    }
+
+    /**
+     * List all the notifications.
+     */
+    public GHNotificationStream listNotifications() {
+        return new GHNotificationStream(this,"/notifications");
+    }
+
     /**
      * This provides a dump of every public repository, in the order that they were created.
      * @see <a href="https://developer.github.com/v3/repos/#list-all-public-repositories">documentation</a>
@@ -487,7 +516,7 @@ public class GitHub {
             new Requester(this)
                     .with(new ByteArrayInputStream(text.getBytes("UTF-8")))
                     .contentType("text/plain;charset=UTF-8")
-                    .read("/markdown/raw"),
+                    .asStream("/markdown/raw"),
             "UTF-8");
     }
 

src/main/java/org/kohsuke/github/GitHubBuilder.java

@@ -45,18 +45,18 @@ public class GitHubBuilder {
      * @throws IOException If there are no credentials defined in the ~/.github properties file or the process environment.
      */
     public static GitHubBuilder fromCredentials() throws IOException {
-    	Exception cause = null;
-    	GitHubBuilder builder;
+        Exception cause = null;
+        GitHubBuilder builder;
 
-		try {
-			builder = fromPropertyFile();
+        try {
+            builder = fromPropertyFile();
 
-			if (builder.user != null)
-	    		return builder;
-		} catch (FileNotFoundException e) {
+            if (builder.user != null)
+                return builder;
+        } catch (FileNotFoundException e) {
             // fall through
             cause = e;
-		}
+        }
 
         builder = fromEnvironment();
 
@@ -77,8 +77,8 @@ public class GitHubBuilder {
 
     private static void loadIfSet(String envName, Properties p, String propName) {
         String v = System.getenv(envName);
-       	if (v != null)
-       		p.put(propName, v);
+           if (v != null)
+               p.put(propName, v);
     }
 
     /**
@@ -87,12 +87,12 @@ public class GitHubBuilder {
      *      different clients of this library will all recognize one consistent set of coordinates.
      */
     public static GitHubBuilder fromEnvironment(String loginVariableName, String passwordVariableName, String oauthVariableName, String endpointVariableName) throws IOException {
-    	Properties env = new Properties();
-    	loadIfSet(loginVariableName,env,"login");
+        Properties env = new Properties();
+        loadIfSet(loginVariableName,env,"login");
         loadIfSet(passwordVariableName,env,"password");
         loadIfSet(oauthVariableName,env,"oauth");
         loadIfSet(endpointVariableName,env,"endpoint");
-    	return fromProperties(env);
+        return fromProperties(env);
     }
 
     /**
@@ -116,7 +116,7 @@ public class GitHubBuilder {
      * login, password, oauth
      */
     public static GitHubBuilder fromEnvironment() throws IOException {
-    	Properties props = new Properties();
+        Properties props = new Properties();
         for (Entry<String, String> e : System.getenv().entrySet()) {
             String name = e.getKey().toLowerCase(Locale.ENGLISH);
             if (name.startsWith("github_")) name=name.substring(7);

src/main/java/org/kohsuke/github/PagedSearchIterable.java

@@ -8,11 +8,17 @@ import java.util.Iterator;
  * @author Kohsuke Kawaguchi
  */
 public abstract class PagedSearchIterable<T> extends PagedIterable<T> {
+    private final GitHub root;
+
     /**
      * As soon as we have any result fetched, it's set here so that we can report the total count.
      */
     private SearchResult<T> result;
 
+    /*package*/ PagedSearchIterable(GitHub root) {
+        this.root = root;
+    }
+
     /**
      * Returns the total number of hit, including the results that's not yet fetched.
      */
@@ -43,7 +49,7 @@ public abstract class PagedSearchIterable<T> extends PagedIterable<T> {
             public T[] next() {
                 SearchResult<T> v = base.next();
                 if (result==null)   result = v;
-                return v.getItems();
+                return v.getItems(root);
             }
 
             public void remove() {

src/main/java/org/kohsuke/github/Requester.java

@@ -23,7 +23,8 @@
  */
 package org.kohsuke.github;
 
-import static org.kohsuke.github.GitHub.MAPPER;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import org.apache.commons.io.IOUtils;
 
 import java.io.FileNotFoundException;
 import java.io.IOException;
@@ -43,6 +44,7 @@ import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -51,8 +53,7 @@ import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.zip.GZIPInputStream;
 
-import com.fasterxml.jackson.databind.JsonMappingException;
-import org.apache.commons.io.IOUtils;
+import static org.kohsuke.github.GitHub.*;
 
 /**
  * A builder pattern for making HTTP call and parsing its output.
@@ -62,6 +63,7 @@ import org.apache.commons.io.IOUtils;
 class Requester {
     private final GitHub root;
     private final List<Entry> args = new ArrayList<Entry>();
+    private final Map<String,String> headers = new LinkedHashMap<String, String>();
 
     /**
      * Request method.
@@ -70,6 +72,11 @@ class Requester {
     private String contentType = "application/x-www-form-urlencoded";
     private InputStream body;
 
+    /**
+     * Current connection.
+     */
+    private HttpURLConnection uc;
+
     private static class Entry {
         String key;
         Object value;
@@ -84,6 +91,15 @@ class Requester {
         this.root = root;
     }
 
+    /**
+     * Sets the request HTTP header.
+     *
+     * If a header of the same name is already set, this method overrides it.
+     */
+    public void setHeader(String name, String value) {
+        headers.put(name,value);
+    }
+
     /**
      * Makes a request with authentication credential.
      */
@@ -107,6 +123,10 @@ class Requester {
     public Requester with(String key, boolean value) {
         return _with(key, value);
     }
+    public Requester with(String key, Boolean value) {
+        return _with(key, value);
+    }
+
 
     public Requester with(String key, String value) {
         return _with(key, value);
@@ -196,12 +216,12 @@ class Requester {
                 }
                 tailApiUrl += qs.toString();
             }
-            HttpURLConnection uc = setupConnection(root.getApiURL(tailApiUrl));
+            setupConnection(root.getApiURL(tailApiUrl));
 
-            buildRequest(uc);
+            buildRequest();
 
             try {
-                T result = parse(uc, type, instance);
+                T result = parse(type, instance);
                 if (type != null && type.isArray()) { // we might have to loop for pagination - done through recursion
                     final String links = uc.getHeaderField("link");
                     if (links != null && links.contains("rel=\"next\"")) {
@@ -222,7 +242,7 @@ class Requester {
                 }
                 return result;
             } catch (IOException e) {
-                handleApiError(e,uc);
+                handleApiError(e);
             }
         }
     }
@@ -232,33 +252,41 @@ class Requester {
      */
     public int asHttpStatusCode(String tailApiUrl) throws IOException {
         while (true) {// loop while API rate limit is hit
-            HttpURLConnection uc = setupConnection(root.getApiURL(tailApiUrl));
+            setupConnection(root.getApiURL(tailApiUrl));
 
-            buildRequest(uc);
+            buildRequest();
 
             try {
                 return uc.getResponseCode();
             } catch (IOException e) {
-                handleApiError(e,uc);
+                handleApiError(e);
             }
         }
     }
 
-    public InputStream read(String tailApiUrl) throws IOException {
+    public InputStream asStream(String tailApiUrl) throws IOException {
         while (true) {// loop while API rate limit is hit
-            HttpURLConnection uc = setupConnection(root.getApiURL(tailApiUrl));
+            setupConnection(root.getApiURL(tailApiUrl));
 
-            buildRequest(uc);
+            buildRequest();
 
             try {
-                return wrapStream(uc,uc.getInputStream());
+                return wrapStream(uc.getInputStream());
             } catch (IOException e) {
-                handleApiError(e,uc);
+                handleApiError(e);
             }
         }
     }
 
-    private void buildRequest(HttpURLConnection uc) throws IOException {
+    public String getResponseHeader(String header) {
+        return uc.getHeaderField(header);
+    }
+
+
+    /**
+     * Set up the request parameters or POST payload.
+     */
+    private void buildRequest() throws IOException {
         if (!method.equals("GET")) {
             uc.setDoOutput(true);
             uc.setRequestProperty("Content-type", contentType);
@@ -347,14 +375,14 @@ class Requester {
 
                 try {
                     while (true) {// loop while API rate limit is hit
-                        HttpURLConnection uc = setupConnection(url);
+                        setupConnection(url);
                         try {
-                            next = parse(uc,type,null);
+                            next = parse(type,null);
                             assert next!=null;
-                            findNextURL(uc);
+                            findNextURL();
                             return;
                         } catch (IOException e) {
-                            handleApiError(e,uc);
+                            handleApiError(e);
                         }
                     }
                 } catch (IOException e) {
@@ -365,7 +393,7 @@ class Requester {
             /**
              * Locate the next page from the pagination "Link" tag.
              */
-            private void findNextURL(HttpURLConnection uc) throws MalformedURLException {
+            private void findNextURL() throws MalformedURLException {
                 url = null; // start defensively
                 String link = uc.getHeaderField("Link");
                 if (link==null) return;
@@ -386,14 +414,20 @@ class Requester {
     }
 
 
-    private HttpURLConnection setupConnection(URL url) throws IOException {
-        HttpURLConnection uc = root.getConnector().connect(url);
+    private void setupConnection(URL url) throws IOException {
+        uc = root.getConnector().connect(url);
 
         // if the authentication is needed but no credential is given, try it anyway (so that some calls
         // that do work with anonymous access in the reduced form should still work.)
         if (root.encodedAuthorization!=null)
             uc.setRequestProperty("Authorization", root.encodedAuthorization);
 
+        for (Map.Entry<String, String> e : headers.entrySet()) {
+            String v = e.getValue();
+            if (v!=null)
+                uc.setRequestProperty(e.getKey(), v);
+        }
+
         try {
             uc.setRequestMethod(method);
         } catch (ProtocolException e) {
@@ -407,13 +441,14 @@ class Requester {
             }
         }
         uc.setRequestProperty("Accept-Encoding", "gzip");
-        return uc;
     }
 
-    private <T> T parse(HttpURLConnection uc, Class<T> type, T instance) throws IOException {
+    private <T> T parse(Class<T> type, T instance) throws IOException {
+        if (uc.getResponseCode()==304)
+            return null;    // special case handling for 304 unmodified, as the content will be ""
         InputStreamReader r = null;
         try {
-            r = new InputStreamReader(wrapStream(uc, uc.getInputStream()), "UTF-8");
+            r = new InputStreamReader(wrapStream(uc.getInputStream()), "UTF-8");
             String data = IOUtils.toString(r);
             if (type!=null)
                 try {
@@ -432,7 +467,7 @@ class Requester {
     /**
      * Handles the "Content-Encoding" header.
      */
-    private InputStream wrapStream(HttpURLConnection uc, InputStream in) throws IOException {
+    private InputStream wrapStream(InputStream in) throws IOException {
         String encoding = uc.getContentEncoding();
         if (encoding==null || in==null) return in;
         if (encoding.equals("gzip"))    return new GZIPInputStream(in);
@@ -443,19 +478,23 @@ class Requester {
     /**
      * Handle API error by either throwing it or by returning normally to retry.
      */
-    /*package*/ void handleApiError(IOException e, HttpURLConnection uc) throws IOException {
+    /*package*/ void handleApiError(IOException e) throws IOException {
+        if (uc.getResponseCode() == 401) // Unauthorized == bad creds
+            throw e;
+
         if ("0".equals(uc.getHeaderField("X-RateLimit-Remaining"))) {
             root.rateLimitHandler.onError(e,uc);
         }
 
-        if (e instanceof FileNotFoundException)
-            throw e;    // pass through 404 Not Found to allow the caller to handle it intelligently
-
-        InputStream es = wrapStream(uc, uc.getErrorStream());
+        InputStream es = wrapStream(uc.getErrorStream());
         try {
-            if (es!=null)
-                throw (IOException)new IOException(IOUtils.toString(es,"UTF-8")).initCause(e);
-            else
+            if (es!=null) {
+                if (e instanceof FileNotFoundException) {
+                    // pass through 404 Not Found to allow the caller to handle it intelligently
+                    throw (IOException) new FileNotFoundException(IOUtils.toString(es, "UTF-8")).initCause(e);
+                } else
+                    throw (IOException) new IOException(IOUtils.toString(es, "UTF-8")).initCause(e);
+            } else
                 throw e;
         } finally {
             IOUtils.closeQuietly(es);

src/main/java/org/kohsuke/github/SearchResult.java

@@ -9,5 +9,8 @@ abstract class SearchResult<T> {
     int total_count;
     boolean incomplete_results;
 
-    public abstract T[] getItems();
+    /**
+     * Wraps up the retrieved object and return them. Only called once.
+     */
+    /*package*/ abstract T[] getItems(GitHub root);
 }

src/site/markdown/index.md

@@ -41,4 +41,11 @@ This library comes with a pluggable connector to use different HTTP client imple
 through `HttpConnector`. In particular, this means you can use [OkHttp](http://square.github.io/okhttp/),
 so we can make use of it's HTTP response cache.
 Making a conditional request against the GitHub API and receiving a 304 response
-[does not count against the rate limit](http://developer.github.com/v3/#conditional-requests).
+[does not count against the rate limit](http://developer.github.com/v3/#conditional-requests).
+
+The following code shows an example of how to set up persistent cache on the disk:
+
+    Cache cache = new Cache(cacheDirectory, 10 * 1024 * 1024); // 10MB cache
+    GitHub gitHub = GitHubBuilder.fromCredentials()
+        .withConnector(new OkHttpConnector(new OkUrlFactory(new OkHttpClient().setCache(cache))))
+        .build();

src/test/java/org/kohsuke/github/AbstractGitHubApiTestBase.java

@@ -19,9 +19,9 @@ public abstract class AbstractGitHubApiTestBase extends Assert {
         if (f.exists()) {
             // use the non-standard credential preferentially, so that developers of this library do not have
             // to clutter their event stream.
-            gitHub = GitHubBuilder.fromPropertyFile(f.getPath()).build();
+            gitHub = GitHubBuilder.fromPropertyFile(f.getPath()).withRateLimitHandler(RateLimitHandler.FAIL).build();
         } else {
-            gitHub = GitHub.connect();
+            gitHub = GitHubBuilder.fromCredentials().withRateLimitHandler(RateLimitHandler.FAIL).build();
         }
     }
 

src/test/java/org/kohsuke/github/AppTest.java

@@ -598,10 +598,10 @@ public class AppTest extends AbstractGitHubApiTestBase {
     }
 
     @Test
-	public void testRef() throws IOException {
-		GHRef masterRef = gitHub.getRepository("jenkinsci/jenkins").getRef("heads/master");
-		assertEquals("https://api.github.com/repos/jenkinsci/jenkins/git/refs/heads/master", masterRef.getUrl().toString());
-	}
+    public void testRef() throws IOException {
+        GHRef masterRef = gitHub.getRepository("jenkinsci/jenkins").getRef("heads/master");
+        assertEquals("https://api.github.com/repos/jenkinsci/jenkins/git/refs/heads/master", masterRef.getUrl().toString());
+    }
 
     @Test
     public void directoryListing() throws IOException {
@@ -618,8 +618,8 @@ public class AppTest extends AbstractGitHubApiTestBase {
     
     @Test
     public void testAddDeployKey() throws IOException {
-    	GHRepository myRepository = Iterables.get(gitHub.getMyself().getRepositories().values(),0);
-    	final GHDeployKey newDeployKey = myRepository.addDeployKey("test", "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUt0RAycC5cS42JKh6SecfFZBR1RrF+2hYMctz4mk74/arBE+wFb7fnSHGzdGKX2h5CFOWODifRCJVhB7hlVxodxe+QkQQYAEL/x1WVCJnGgTGQGOrhOMj95V3UE5pQKhsKD608C+u5tSofcWXLToP1/wZ7U4/AHjqYi08OLsWToHCax55TZkvdt2jo0hbIoYU+XI9Q8Uv4ONDN1oabiOdgeKi8+crvHAuvNleiBhWVBzFh8KdfzaH5uNdw7ihhFjEd1vzqACsjCINCjdMfzl6jD9ExuWuE92nZJnucls2cEoNC6k2aPmrZDg9hA32FXVpyseY+bDUWFU6LO2LG6PB kohsuke@atlas");
+        GHRepository myRepository = Iterables.get(gitHub.getMyself().getRepositories().values(),0);
+        final GHDeployKey newDeployKey = myRepository.addDeployKey("test", "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUt0RAycC5cS42JKh6SecfFZBR1RrF+2hYMctz4mk74/arBE+wFb7fnSHGzdGKX2h5CFOWODifRCJVhB7hlVxodxe+QkQQYAEL/x1WVCJnGgTGQGOrhOMj95V3UE5pQKhsKD608C+u5tSofcWXLToP1/wZ7U4/AHjqYi08OLsWToHCax55TZkvdt2jo0hbIoYU+XI9Q8Uv4ONDN1oabiOdgeKi8+crvHAuvNleiBhWVBzFh8KdfzaH5uNdw7ihhFjEd1vzqACsjCINCjdMfzl6jD9ExuWuE92nZJnucls2cEoNC6k2aPmrZDg9hA32FXVpyseY+bDUWFU6LO2LG6PB kohsuke@atlas");
         try {
             assertNotNull(newDeployKey.getId());
 
@@ -636,11 +636,11 @@ public class AppTest extends AbstractGitHubApiTestBase {
     
     @Test
     public void testCommitStatusContext() throws IOException {
-    	GHRepository myRepository = Iterables.get(gitHub.getMyself().getRepositories().values(), 0);
-    	GHRef masterRef = myRepository.getRef("heads/master");
-    	GHCommitStatus commitStatus = myRepository.createCommitStatus(masterRef.getObject().getSha(), GHCommitState.SUCCESS, "http://www.example.com", "test", "test/context");
-    	assertEquals("test/context", commitStatus.getContext());
-    	 
+        GHRepository myRepository = Iterables.get(gitHub.getMyself().getRepositories().values(), 0);
+        GHRef masterRef = myRepository.getRef("heads/master");
+        GHCommitStatus commitStatus = myRepository.createCommitStatus(masterRef.getObject().getSha(), GHCommitState.SUCCESS, "http://www.example.com", "test", "test/context");
+        assertEquals("test/context", commitStatus.getContext());
+         
     }
 
     @Test
@@ -671,28 +671,28 @@ public class AppTest extends AbstractGitHubApiTestBase {
     
     @Test
     public void testTrees() throws IOException {
-    	GHTree masterTree = gitHub.getRepository("kohsuke/github-api").getTree("master");
-    	boolean foundReadme = false;
-    	for(GHTreeEntry e : masterTree.getTree()){ 
-    		if("readme".equalsIgnoreCase(e.getPath().replaceAll(".md", ""))){
-    			foundReadme = true;
-    			break;
-    		}
-    	}
-    	assertTrue(foundReadme);
+        GHTree masterTree = gitHub.getRepository("kohsuke/github-api").getTree("master");
+        boolean foundReadme = false;
+        for(GHTreeEntry e : masterTree.getTree()){
+            if("readme".equalsIgnoreCase(e.getPath().replaceAll("\\.md", ""))){
+                foundReadme = true;
+                break;
+            }
+        }
+        assertTrue(foundReadme);
     }
     
     @Test
     public void testTreesRecursive() throws IOException {
-    	GHTree masterTree = gitHub.getRepository("kohsuke/github-api").getTreeRecursive("master", 1);
-    	boolean foundThisFile = false;
-    	for(GHTreeEntry e : masterTree.getTree()){ 
-    		if(e.getPath().endsWith(AppTest.class.getSimpleName() + ".java")){
-    			foundThisFile = true;
-    			break;
-    		}
-    	}
-    	assertTrue(foundThisFile);
+        GHTree masterTree = gitHub.getRepository("kohsuke/github-api").getTreeRecursive("master", 1);
+        boolean foundThisFile = false;
+        for(GHTreeEntry e : masterTree.getTree()){ 
+            if(e.getPath().endsWith(AppTest.class.getSimpleName() + ".java")){
+                foundThisFile = true;
+                break;
+            }
+        }
+        assertTrue(foundThisFile);
     }
 
     @Test
@@ -777,6 +777,56 @@ public class AppTest extends AbstractGitHubApiTestBase {
         assertTrue(actual.contains("to fix issue"));
     }
 
+    @Test
+    public void searchUsers() throws Exception {
+        PagedSearchIterable<GHUser> r = gitHub.searchUsers().q("tom").repos(">42").followers(">1000").list();
+        GHUser u = r.iterator().next();
+        System.out.println(u.getName());
+        assertNotNull(u.getId());
+        assertTrue(r.getTotalCount() > 0);
+    }
+
+    @Test
+    public void searchRepositories() throws Exception {
+        PagedSearchIterable<GHRepository> r = gitHub.searchRepositories().q("tetris").language("assembly").sort(GHRepositorySearchBuilder.Sort.STARS).list();
+        GHRepository u = r.iterator().next();
+        System.out.println(u.getName());
+        assertNotNull(u.getId());
+        assertEquals("Assembly", u.getLanguage());
+        assertTrue(r.getTotalCount() > 0);
+    }
+
+    @Test
+    public void searchContent() throws Exception {
+        PagedSearchIterable<GHContent> r = gitHub.searchContent().q("addClass").in("file").language("js").repo("jquery/jquery").list();
+        GHContent c = r.iterator().next();
+        System.out.println(c.getName());
+        assertNotNull(c.getDownloadUrl());
+        assertNotNull(c.getOwner());
+        assertEquals("jquery/jquery",c.getOwner().getFullName());
+        assertTrue(r.getTotalCount() > 0);
+    }
+
+    @Test
+    public void notifications() throws Exception {
+        boolean found=false;
+        for (GHThread t : gitHub.listNotifications().nonBlocking(true).read(true)) {
+            if (!found) {
+                found = true;
+                t.markAsRead(); // test this by calling it once on old nofication
+            }
+            assertNotNull(t.getTitle());
+            assertNotNull(t.getReason());
+
+            System.out.println(t.getTitle());
+            System.out.println(t.getLastReadAt());
+            System.out.println(t.getType());
+            System.out.println();
+        }
+        assertTrue(found);
+        gitHub.listNotifications().markAsRead();
+    }
+
     private void kohsuke() {
         String login = getUser().getLogin();
         Assume.assumeTrue(login.equals("kohsuke") || login.equals("kohsuke2"));

src/test/java/org/kohsuke/github/GitHubTest.java

@@ -30,21 +30,21 @@ public class GitHubTest extends TestCase {
     }
     
     public void testGitHubBuilderFromEnvironment() throws IOException {
-    	
-    	Map<String, String>props = new HashMap<String, String>();
-    	
-    	props.put("login", "bogus");
-    	props.put("oauth", "bogus");
-    	props.put("password", "bogus");
-    	
-    	setupEnvironment(props);
-    	
-    	GitHubBuilder builder = GitHubBuilder.fromEnvironment();
-    	
-    	assertEquals("bogus", builder.user);
-    	assertEquals("bogus", builder.oauthToken);
-    	assertEquals("bogus", builder.password);
-    	
+        
+        Map<String, String>props = new HashMap<String, String>();
+        
+        props.put("login", "bogus");
+        props.put("oauth", "bogus");
+        props.put("password", "bogus");
+        
+        setupEnvironment(props);
+        
+        GitHubBuilder builder = GitHubBuilder.fromEnvironment();
+        
+        assertEquals("bogus", builder.user);
+        assertEquals("bogus", builder.oauthToken);
+        assertEquals("bogus", builder.password);
+        
     }
     
     /*
@@ -55,59 +55,54 @@ public class GitHubTest extends TestCase {
      * Its used to wire in values for the github credentials to test that the GitHubBuilder works properly to resolve them.
      */
     private void setupEnvironment(Map<String, String> newenv) {
-    	  try
-    	    {
-    	        Class<?> processEnvironmentClass = Class.forName("java.lang.ProcessEnvironment");
-    	        Field theEnvironmentField = processEnvironmentClass.getDeclaredField("theEnvironment");
-    	        theEnvironmentField.setAccessible(true);
-    	        Map<String, String> env = (Map<String, String>) theEnvironmentField.get(null);
-    	        env.putAll(newenv);
-    	        Field theCaseInsensitiveEnvironmentField = processEnvironmentClass.getDeclaredField("theCaseInsensitiveEnvironment");
-    	        theCaseInsensitiveEnvironmentField.setAccessible(true);
-    	        Map<String, String> cienv = (Map<String, String>)     theCaseInsensitiveEnvironmentField.get(null);
-    	        cienv.putAll(newenv);
-    	    }
-    	    catch (NoSuchFieldException e)
-    	    {
-    	      try {
-    	        Class[] classes = Collections.class.getDeclaredClasses();
-    	        Map<String, String> env = System.getenv();
-    	        for(Class cl : classes) {
-    	            if("java.util.Collections$UnmodifiableMap".equals(cl.getName())) {
-    	                Field field = cl.getDeclaredField("m");
-    	                field.setAccessible(true);
-    	                Object obj = field.get(env);
-    	                Map<String, String> map = (Map<String, String>) obj;
-    	                map.clear();
-    	                map.putAll(newenv);
-    	            }
-    	        }
-    	      } catch (Exception e2) {
-    	        e2.printStackTrace();
-    	      }
-    	    } catch (Exception e1) {
-    	        e1.printStackTrace();
-    	    } 
-		
-	}
-
-	public void testGitHubBuilderFromCustomEnvironment() throws IOException {
-    	
-		Map<String, String>props = new HashMap<String, String>();
-    	
-    	props.put("customLogin", "bogusLogin");
-    	props.put("customOauth", "bogusOauth");
-    	props.put("customPassword", "bogusPassword");
-       props.put("customEndpoint", "bogusEndpoint");
-
-    	setupEnvironment(props);
-    	
-       GitHubBuilder builder = GitHubBuilder.fromEnvironment("customLogin", "customPassword", "customOauth", "customEndpoint");
-    	
-    	assertEquals("bogusLogin", builder.user);
-    	assertEquals("bogusOauth", builder.oauthToken);
-    	assertEquals("bogusPassword", builder.password);
-       assertEquals("bogusEndpoint", builder.endpoint);
+        try {
+            Class<?> processEnvironmentClass = Class.forName("java.lang.ProcessEnvironment");
+            Field theEnvironmentField = processEnvironmentClass.getDeclaredField("theEnvironment");
+            theEnvironmentField.setAccessible(true);
+            Map<String, String> env = (Map<String, String>) theEnvironmentField.get(null);
+            env.putAll(newenv);
+            Field theCaseInsensitiveEnvironmentField = processEnvironmentClass.getDeclaredField("theCaseInsensitiveEnvironment");
+            theCaseInsensitiveEnvironmentField.setAccessible(true);
+            Map<String, String> cienv = (Map<String, String>) theCaseInsensitiveEnvironmentField.get(null);
+            cienv.putAll(newenv);
+        } catch (NoSuchFieldException e) {
+            try {
+                Class[] classes = Collections.class.getDeclaredClasses();
+                Map<String, String> env = System.getenv();
+                for (Class cl : classes) {
+                    if ("java.util.Collections$UnmodifiableMap".equals(cl.getName())) {
+                        Field field = cl.getDeclaredField("m");
+                        field.setAccessible(true);
+                        Object obj = field.get(env);
+                        Map<String, String> map = (Map<String, String>) obj;
+                        map.clear();
+                        map.putAll(newenv);
+                    }
+                }
+            } catch (Exception e2) {
+                e2.printStackTrace();
+            }
+        } catch (Exception e1) {
+            e1.printStackTrace();
+        }
     }
-    
+
+    public void testGitHubBuilderFromCustomEnvironment() throws IOException {
+        Map<String, String> props = new HashMap<String, String>();
+
+        props.put("customLogin", "bogusLogin");
+        props.put("customOauth", "bogusOauth");
+        props.put("customPassword", "bogusPassword");
+        props.put("customEndpoint", "bogusEndpoint");
+
+        setupEnvironment(props);
+
+        GitHubBuilder builder = GitHubBuilder.fromEnvironment("customLogin", "customPassword", "customOauth", "customEndpoint");
+
+        assertEquals("bogusLogin", builder.user);
+        assertEquals("bogusOauth", builder.oauthToken);
+        assertEquals("bogusPassword", builder.password);
+        assertEquals("bogusEndpoint", builder.endpoint);
+    }
+
 }