mirror of
https://github.com/jlengrand/github-api.git
synced 2026-03-11 08:21:23 +00:00
Compare commits
50 Commits
github-api
...
github-api
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3d03659508 | ||
|
|
0374d2de48 | ||
|
|
2627dc5ee4 | ||
|
|
1f4325e7db | ||
|
|
f2e7b40425 | ||
|
|
4ee3086b6d | ||
|
|
a3a715c3ba | ||
|
|
6cad4a3c33 | ||
|
|
b9b6f4fd44 | ||
|
|
17d1994a53 | ||
|
|
13184e72e1 | ||
|
|
911e8d21a7 | ||
|
|
5b69a2925f | ||
|
|
d1c900a620 | ||
|
|
6bfeb54f3c | ||
|
|
198fede915 | ||
|
|
1212ae3eb3 | ||
|
|
1266dcc0c7 | ||
|
|
6fcddf4a47 | ||
|
|
dfea424b94 | ||
|
|
9d03435aa1 | ||
|
|
26c20a7a22 | ||
|
|
470da06ecf | ||
|
|
a746a310bc | ||
|
|
3dbb516084 | ||
|
|
32177283b3 | ||
|
|
3a66e90b7a | ||
|
|
a454fb10ec | ||
|
|
b5386a35ee | ||
|
|
11651da411 | ||
|
|
88d52c44ad | ||
|
|
2d7d4bbd4e | ||
|
|
e6ee278fde | ||
|
|
6380cf9ed0 | ||
|
|
2e78dc52c7 | ||
|
|
ccb42d3249 | ||
|
|
c5009ab44b | ||
|
|
9d15cd43a3 | ||
|
|
0780e10fa2 | ||
|
|
0731f63237 | ||
|
|
a29896042b | ||
|
|
68ebc08c9d | ||
|
|
a1df526f93 | ||
|
|
0023ecefa4 | ||
|
|
511f156603 | ||
|
|
3f223b1ba0 | ||
|
|
a1528a1a63 | ||
|
|
b8bfddbf3a | ||
|
|
47fc813027 | ||
|
|
c7f2228a44 |
6
pom.xml
6
pom.xml
@@ -3,11 +3,11 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>org.kohsuke</groupId>
|
<groupId>org.kohsuke</groupId>
|
||||||
<artifactId>pom</artifactId>
|
<artifactId>pom</artifactId>
|
||||||
<version>14</version>
|
<version>17</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>github-api</artifactId>
|
<artifactId>github-api</artifactId>
|
||||||
<version>1.80</version>
|
<version>1.85</version>
|
||||||
<name>GitHub API for Java</name>
|
<name>GitHub API for Java</name>
|
||||||
<url>http://github-api.kohsuke.org/</url>
|
<url>http://github-api.kohsuke.org/</url>
|
||||||
<description>GitHub API for Java</description>
|
<description>GitHub API for Java</description>
|
||||||
@@ -16,7 +16,7 @@
|
|||||||
<connection>scm:git:git@github.com/kohsuke/${project.artifactId}.git</connection>
|
<connection>scm:git:git@github.com/kohsuke/${project.artifactId}.git</connection>
|
||||||
<developerConnection>scm:git:ssh://git@github.com/kohsuke/${project.artifactId}.git</developerConnection>
|
<developerConnection>scm:git:ssh://git@github.com/kohsuke/${project.artifactId}.git</developerConnection>
|
||||||
<url>http://${project.artifactId}.kohsuke.org/</url>
|
<url>http://${project.artifactId}.kohsuke.org/</url>
|
||||||
<tag>github-api-1.80</tag>
|
<tag>github-api-1.85</tag>
|
||||||
</scm>
|
</scm>
|
||||||
|
|
||||||
<distributionManagement>
|
<distributionManagement>
|
||||||
|
|||||||
64
src/main/java/org/kohsuke/github/GHBlob.java
Normal file
64
src/main/java/org/kohsuke/github/GHBlob.java
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
package org.kohsuke.github;
|
||||||
|
|
||||||
|
import org.apache.commons.codec.binary.Base64InputStream;
|
||||||
|
|
||||||
|
import java.io.ByteArrayInputStream;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.UnsupportedEncodingException;
|
||||||
|
import java.net.URL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Kanstantsin Shautsou
|
||||||
|
* @author Kohsuke Kawaguchi
|
||||||
|
* @see GHTreeEntry#asBlob()
|
||||||
|
* @see GHRepository#getBlob(String)
|
||||||
|
* @see <a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>
|
||||||
|
*/
|
||||||
|
public class GHBlob {
|
||||||
|
private String content, encoding, url, sha;
|
||||||
|
private long size;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* API URL of this blob.
|
||||||
|
*/
|
||||||
|
public URL getUrl() {
|
||||||
|
return GitHub.parseURL(url);
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getSha() {
|
||||||
|
return sha;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes in this blob.
|
||||||
|
*/
|
||||||
|
public long getSize() {
|
||||||
|
return size;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getEncoding() {
|
||||||
|
return encoding;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encoded content. You probably want {@link #read()}
|
||||||
|
*/
|
||||||
|
public String getContent() {
|
||||||
|
return content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the actual bytes of the blob.
|
||||||
|
*/
|
||||||
|
public InputStream read() {
|
||||||
|
if (encoding.equals("base64")) {
|
||||||
|
try {
|
||||||
|
return new Base64InputStream(new ByteArrayInputStream(content.getBytes("US-ASCII")), false);
|
||||||
|
} catch (UnsupportedEncodingException e) {
|
||||||
|
throw new AssertionError(e); // US-ASCII is mandatory
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new UnsupportedOperationException("Unrecognized encoding: "+encoding);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,13 +1,17 @@
|
|||||||
package org.kohsuke.github;
|
package org.kohsuke.github;
|
||||||
|
|
||||||
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
|
import static org.kohsuke.github.Previews.LOKI;
|
||||||
import org.kohsuke.github.BranchProtection.RequiredStatusChecks;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
import java.net.URL;
|
||||||
import java.util.Arrays;
|
import java.util.Arrays;
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
|
|
||||||
import static org.kohsuke.github.Previews.LOKI;
|
import org.kohsuke.github.BranchProtection.RequiredStatusChecks;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||||
|
|
||||||
|
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A branch in a repository.
|
* A branch in a repository.
|
||||||
@@ -22,6 +26,10 @@ public class GHBranch {
|
|||||||
|
|
||||||
private String name;
|
private String name;
|
||||||
private Commit commit;
|
private Commit commit;
|
||||||
|
@JsonProperty("protected")
|
||||||
|
private boolean protection;
|
||||||
|
private String protection_url;
|
||||||
|
|
||||||
|
|
||||||
public static class Commit {
|
public static class Commit {
|
||||||
String sha;
|
String sha;
|
||||||
@@ -45,6 +53,23 @@ public class GHBranch {
|
|||||||
return name;
|
return name;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns true if the push to this branch is restricted via branch protection.
|
||||||
|
*/
|
||||||
|
@Preview @Deprecated
|
||||||
|
public boolean isProtected() {
|
||||||
|
return protection;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns API URL that deals with the protection of this branch.
|
||||||
|
*/
|
||||||
|
@Preview @Deprecated
|
||||||
|
public URL getProtectionUrl() {
|
||||||
|
return GitHub.parseURL(protection_url);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The commit that this branch currently points to.
|
* The commit that this branch currently points to.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -37,6 +37,12 @@ public class GHCommit {
|
|||||||
|
|
||||||
private int comment_count;
|
private int comment_count;
|
||||||
|
|
||||||
|
static class Tree {
|
||||||
|
String sha;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Tree tree;
|
||||||
|
|
||||||
@WithBridgeMethods(value = GHAuthor.class, castRequired = true)
|
@WithBridgeMethods(value = GHAuthor.class, castRequired = true)
|
||||||
public GitUser getAuthor() {
|
public GitUser getAuthor() {
|
||||||
return author;
|
return author;
|
||||||
@@ -224,6 +230,13 @@ public class GHCommit {
|
|||||||
return stats.deletions;
|
return stats.deletions;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Use this method to walk the tree
|
||||||
|
*/
|
||||||
|
public GHTree getTree() throws IOException {
|
||||||
|
return owner.getTree(getCommitShortInfo().tree.sha);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* URL of this commit like "https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000"
|
* URL of this commit like "https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000"
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -29,13 +29,15 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
|
|||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.net.URL;
|
import java.net.URL;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Arrays;
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.Collections;
|
import java.util.Collections;
|
||||||
import java.util.Date;
|
import java.util.Date;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Locale;
|
import java.util.Locale;
|
||||||
|
|
||||||
import static org.kohsuke.github.Previews.SQUIRREL_GIRL;
|
import static org.kohsuke.github.Previews.*;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an issue on GitHub.
|
* Represents an issue on GitHub.
|
||||||
@@ -51,7 +53,8 @@ public class GHIssue extends GHObject implements Reactable{
|
|||||||
GHRepository owner;
|
GHRepository owner;
|
||||||
|
|
||||||
// API v3
|
// API v3
|
||||||
protected GHUser assignee;
|
protected GHUser assignee; // not sure what this field is now that 'assignees' exist
|
||||||
|
protected GHUser[] assignees;
|
||||||
protected String state;
|
protected String state;
|
||||||
protected int number;
|
protected int number;
|
||||||
protected String closed_at;
|
protected String closed_at;
|
||||||
@@ -81,6 +84,7 @@ public class GHIssue extends GHObject implements Reactable{
|
|||||||
/*package*/ GHIssue wrap(GitHub root) {
|
/*package*/ GHIssue wrap(GitHub root) {
|
||||||
this.root = root;
|
this.root = root;
|
||||||
if(assignee != null) assignee.wrapUp(root);
|
if(assignee != null) assignee.wrapUp(root);
|
||||||
|
if(assignees!=null) GHUser.wrap(assignees,root);
|
||||||
if(user != null) user.wrapUp(root);
|
if(user != null) user.wrapUp(root);
|
||||||
if(closed_by != null) closed_by.wrapUp(root);
|
if(closed_by != null) closed_by.wrapUp(root);
|
||||||
return this;
|
return this;
|
||||||
@@ -187,7 +191,7 @@ public class GHIssue extends GHObject implements Reactable{
|
|||||||
}
|
}
|
||||||
|
|
||||||
public void assignTo(GHUser user) throws IOException {
|
public void assignTo(GHUser user) throws IOException {
|
||||||
editIssue("assignee", user.getLogin());
|
setAssignees(user);
|
||||||
}
|
}
|
||||||
|
|
||||||
public void setLabels(String... labels) throws IOException {
|
public void setLabels(String... labels) throws IOException {
|
||||||
@@ -242,6 +246,40 @@ public class GHIssue extends GHObject implements Reactable{
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void addAssignees(GHUser... assignees) throws IOException {
|
||||||
|
addAssignees(Arrays.asList(assignees));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addAssignees(Collection<GHUser> assignees) throws IOException {
|
||||||
|
List<String> names = toLogins(assignees);
|
||||||
|
root.retrieve().method("POST").with("assignees",names).to(getIssuesApiRoute()+"/assignees",this);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setAssignees(GHUser... assignees) throws IOException {
|
||||||
|
setAssignees(Arrays.asList(assignees));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setAssignees(Collection<GHUser> assignees) throws IOException {
|
||||||
|
editIssue("assignees",toLogins(assignees));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void removeAssignees(GHUser... assignees) throws IOException {
|
||||||
|
removeAssignees(Arrays.asList(assignees));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void removeAssignees(Collection<GHUser> assignees) throws IOException {
|
||||||
|
List<String> names = toLogins(assignees);
|
||||||
|
root.retrieve().method("DELETE").with("assignees",names).inBody().to(getIssuesApiRoute()+"/assignees",this);
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<String> toLogins(Collection<GHUser> assignees) {
|
||||||
|
List<String> names = new ArrayList<String>(assignees.size());
|
||||||
|
for (GHUser a : assignees) {
|
||||||
|
names.add(a.getLogin());
|
||||||
|
}
|
||||||
|
return names;
|
||||||
|
}
|
||||||
|
|
||||||
protected String getApiRoute() {
|
protected String getApiRoute() {
|
||||||
return getIssuesApiRoute();
|
return getIssuesApiRoute();
|
||||||
}
|
}
|
||||||
@@ -253,7 +291,11 @@ public class GHIssue extends GHObject implements Reactable{
|
|||||||
public GHUser getAssignee() {
|
public GHUser getAssignee() {
|
||||||
return assignee;
|
return assignee;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public List<GHUser> getAssignees() {
|
||||||
|
return Collections.unmodifiableList(Arrays.asList(assignees));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* User who submitted the issue.
|
* User who submitted the issue.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ public class GHIssueBuilder {
|
|||||||
private final GHRepository repo;
|
private final GHRepository repo;
|
||||||
private final Requester builder;
|
private final Requester builder;
|
||||||
private List<String> labels = new ArrayList<String>();
|
private List<String> labels = new ArrayList<String>();
|
||||||
|
private List<String> assignees = new ArrayList<String>();
|
||||||
|
|
||||||
GHIssueBuilder(GHRepository repo, String title) {
|
GHIssueBuilder(GHRepository repo, String title) {
|
||||||
this.repo = repo;
|
this.repo = repo;
|
||||||
@@ -28,13 +29,13 @@ public class GHIssueBuilder {
|
|||||||
|
|
||||||
public GHIssueBuilder assignee(GHUser user) {
|
public GHIssueBuilder assignee(GHUser user) {
|
||||||
if (user!=null)
|
if (user!=null)
|
||||||
builder.with("assignee",user.getLogin());
|
assignees.add(user.getLogin());
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public GHIssueBuilder assignee(String user) {
|
public GHIssueBuilder assignee(String user) {
|
||||||
if (user!=null)
|
if (user!=null)
|
||||||
builder.with("assignee",user);
|
assignees.add(user);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -54,6 +55,6 @@ public class GHIssueBuilder {
|
|||||||
* Creates a new issue.
|
* Creates a new issue.
|
||||||
*/
|
*/
|
||||||
public GHIssue create() throws IOException {
|
public GHIssue create() throws IOException {
|
||||||
return builder.with("labels",labels).to(repo.getApiTailUrl("issues"),GHIssue.class).wrap(repo);
|
return builder.with("labels",labels).with("assignees",assignees).to(repo.getApiTailUrl("issues"),GHIssue.class).wrap(repo);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -41,6 +41,11 @@ public class GHIssueSearchBuilder extends GHSearchBuilder<GHIssue> {
|
|||||||
return q("is:merged");
|
return q("is:merged");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public GHIssueSearchBuilder order(GHDirection v) {
|
||||||
|
req.with("order",v);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
public GHIssueSearchBuilder sort(Sort sort) {
|
public GHIssueSearchBuilder sort(Sort sort) {
|
||||||
req.with("sort",sort);
|
req.with("sort",sort);
|
||||||
return this;
|
return this;
|
||||||
|
|||||||
84
src/main/java/org/kohsuke/github/GHMembership.java
Normal file
84
src/main/java/org/kohsuke/github/GHMembership.java
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
package org.kohsuke.github;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.net.URL;
|
||||||
|
import java.util.Locale;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents a membership of a user in an organization.
|
||||||
|
*
|
||||||
|
* @author Kohsuke Kawaguchi
|
||||||
|
* @see GHMyself#listOrgMemberships()
|
||||||
|
*/
|
||||||
|
public class GHMembership /* extends GHObject --- but it doesn't have id, created_at, etc. */ {
|
||||||
|
GitHub root;
|
||||||
|
|
||||||
|
String url;
|
||||||
|
String state;
|
||||||
|
String role;
|
||||||
|
GHUser user;
|
||||||
|
GHOrganization organization;
|
||||||
|
|
||||||
|
public URL getUrl() {
|
||||||
|
return GitHub.parseURL(url);
|
||||||
|
}
|
||||||
|
|
||||||
|
public State getState() {
|
||||||
|
return Enum.valueOf(State.class, state.toUpperCase(Locale.ENGLISH));
|
||||||
|
}
|
||||||
|
|
||||||
|
public Role getRole() {
|
||||||
|
return Enum.valueOf(Role.class, role.toUpperCase(Locale.ENGLISH));
|
||||||
|
}
|
||||||
|
|
||||||
|
public GHUser getUser() {
|
||||||
|
return user;
|
||||||
|
}
|
||||||
|
|
||||||
|
public GHOrganization getOrganization() {
|
||||||
|
return organization;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Accepts a pending invitation to an organization.
|
||||||
|
*
|
||||||
|
* @see GHMyself#getMembership(GHOrganization)
|
||||||
|
*/
|
||||||
|
public void activate() throws IOException {
|
||||||
|
root.retrieve().method("PATCH").with("state",State.ACTIVE).to(url,this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*package*/ GHMembership wrap(GitHub root) {
|
||||||
|
this.root = root;
|
||||||
|
if (user!=null) user = root.getUser(user.wrapUp(root));
|
||||||
|
if (organization!=null) organization.wrapUp(root);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*package*/ static void wrap(GHMembership[] page, GitHub root) {
|
||||||
|
for (GHMembership m : page)
|
||||||
|
m.wrap(root);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Role of a user in an organization.
|
||||||
|
*/
|
||||||
|
public enum Role {
|
||||||
|
/**
|
||||||
|
* Organization owner.
|
||||||
|
*/
|
||||||
|
ADMIN,
|
||||||
|
/**
|
||||||
|
* Non-owner organization member.
|
||||||
|
*/
|
||||||
|
MEMBER;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether a role is currently active or waiting for acceptance (pending)
|
||||||
|
*/
|
||||||
|
public enum State {
|
||||||
|
ACTIVE,
|
||||||
|
PENDING;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -178,6 +178,39 @@ public class GHMyself extends GHUser {
|
|||||||
return listRepositories();
|
return listRepositories();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List your organization memberships
|
||||||
|
*/
|
||||||
|
public PagedIterable<GHMembership> listOrgMemberships() {
|
||||||
|
return listOrgMemberships(null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List your organization memberships
|
||||||
|
*
|
||||||
|
* @param state
|
||||||
|
* Filter by a specific state
|
||||||
|
*/
|
||||||
|
public PagedIterable<GHMembership> listOrgMemberships(final GHMembership.State state) {
|
||||||
|
return new PagedIterable<GHMembership>() {
|
||||||
|
public PagedIterator<GHMembership> _iterator(int pageSize) {
|
||||||
|
return new PagedIterator<GHMembership>(root.retrieve().with("state",state).asIterator("/user/memberships/orgs", GHMembership[].class, pageSize)) {
|
||||||
|
@Override
|
||||||
|
protected void wrapUp(GHMembership[] page) {
|
||||||
|
GHMembership.wrap(page,root);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets your membership in a specific organization.
|
||||||
|
*/
|
||||||
|
public GHMembership getMembership(GHOrganization o) throws IOException {
|
||||||
|
return root.retrieve().to("/user/memberships/orgs/"+o.getLogin(),GHMembership.class).wrap(root);
|
||||||
|
}
|
||||||
|
|
||||||
// public void addEmails(Collection<String> emails) throws IOException {
|
// public void addEmails(Collection<String> emails) throws IOException {
|
||||||
//// new Requester(root,ApiVersion.V3).withCredential().to("/user/emails");
|
//// new Requester(root,ApiVersion.V3).withCredential().to("/user/emails");
|
||||||
// root.retrieveWithAuth3()
|
// root.retrieveWithAuth3()
|
||||||
|
|||||||
59
src/main/java/org/kohsuke/github/GHPermission.java
Normal file
59
src/main/java/org/kohsuke/github/GHPermission.java
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
/*
|
||||||
|
* The MIT License
|
||||||
|
*
|
||||||
|
* Copyright 2016 CloudBees, Inc.
|
||||||
|
*
|
||||||
|
* 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.util.Locale;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Permission for a user in a repository.
|
||||||
|
* @see <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API</a>
|
||||||
|
*/
|
||||||
|
/*package*/ class GHPermission {
|
||||||
|
|
||||||
|
private String permission;
|
||||||
|
private GHUser user;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return one of {@code admin}, {@code write}, {@code read}, or {@code none}
|
||||||
|
*/
|
||||||
|
public String getPermission() {
|
||||||
|
return permission;
|
||||||
|
}
|
||||||
|
|
||||||
|
public GHPermissionType getPermissionType() {
|
||||||
|
return Enum.valueOf(GHPermissionType.class, permission.toUpperCase(Locale.ENGLISH));
|
||||||
|
}
|
||||||
|
|
||||||
|
public GHUser getUser() {
|
||||||
|
return user;
|
||||||
|
}
|
||||||
|
|
||||||
|
void wrapUp(GitHub root) {
|
||||||
|
if (user != null) {
|
||||||
|
user.root = root;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
11
src/main/java/org/kohsuke/github/GHPermissionType.java
Normal file
11
src/main/java/org/kohsuke/github/GHPermissionType.java
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
package org.kohsuke.github;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Kohsuke Kawaguchi
|
||||||
|
*/
|
||||||
|
public enum GHPermissionType {
|
||||||
|
ADMIN,
|
||||||
|
WRITE,
|
||||||
|
READ,
|
||||||
|
NONE
|
||||||
|
}
|
||||||
@@ -93,10 +93,10 @@ public abstract class GHPerson extends GHObject {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads repository list in a pagenated fashion.
|
* Loads repository list in a paginated fashion.
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* For a person with a lot of repositories, GitHub returns the list of repositories in a pagenated fashion.
|
* For a person with a lot of repositories, GitHub returns the list of repositories in a paginated fashion.
|
||||||
* Unlike {@link #getRepositories()}, this method allows the caller to start processing data as it arrives.
|
* Unlike {@link #getRepositories()}, this method allows the caller to start processing data as it arrives.
|
||||||
*
|
*
|
||||||
* Every {@link Iterator#next()} call results in I/O. Exceptions that occur during the processing is wrapped
|
* Every {@link Iterator#next()} call results in I/O. Exceptions that occur during the processing is wrapped
|
||||||
|
|||||||
@@ -213,7 +213,7 @@ public class GHPullRequest extends GHIssue {
|
|||||||
public PagedIterable<GHPullRequestFileDetail> listFiles() {
|
public PagedIterable<GHPullRequestFileDetail> listFiles() {
|
||||||
return new PagedIterable<GHPullRequestFileDetail>() {
|
return new PagedIterable<GHPullRequestFileDetail>() {
|
||||||
public PagedIterator<GHPullRequestFileDetail> _iterator(int pageSize) {
|
public PagedIterator<GHPullRequestFileDetail> _iterator(int pageSize) {
|
||||||
return new PagedIterator<GHPullRequestFileDetail>(root.retrieve().asIterator(String.format("%s/files", getApiURL()),
|
return new PagedIterator<GHPullRequestFileDetail>(root.retrieve().asIterator(String.format("%s/files", getApiRoute()),
|
||||||
GHPullRequestFileDetail[].class, pageSize)) {
|
GHPullRequestFileDetail[].class, pageSize)) {
|
||||||
@Override
|
@Override
|
||||||
protected void wrapUp(GHPullRequestFileDetail[] page) {
|
protected void wrapUp(GHPullRequestFileDetail[] page) {
|
||||||
@@ -247,7 +247,7 @@ public class GHPullRequest extends GHIssue {
|
|||||||
return new PagedIterable<GHPullRequestCommitDetail>() {
|
return new PagedIterable<GHPullRequestCommitDetail>() {
|
||||||
public PagedIterator<GHPullRequestCommitDetail> _iterator(int pageSize) {
|
public PagedIterator<GHPullRequestCommitDetail> _iterator(int pageSize) {
|
||||||
return new PagedIterator<GHPullRequestCommitDetail>(root.retrieve().asIterator(
|
return new PagedIterator<GHPullRequestCommitDetail>(root.retrieve().asIterator(
|
||||||
String.format("%s/commits", getApiURL()),
|
String.format("%s/commits", getApiRoute()),
|
||||||
GHPullRequestCommitDetail[].class, pageSize)) {
|
GHPullRequestCommitDetail[].class, pageSize)) {
|
||||||
@Override
|
@Override
|
||||||
protected void wrapUp(GHPullRequestCommitDetail[] page) {
|
protected void wrapUp(GHPullRequestCommitDetail[] page) {
|
||||||
|
|||||||
@@ -121,9 +121,7 @@ public class GHRelease extends GHObject {
|
|||||||
* Java 7 or greater. Options for fixing this for earlier JVMs can be found here
|
* Java 7 or greater. Options for fixing this for earlier JVMs can be found here
|
||||||
* http://stackoverflow.com/questions/12361090/server-name-indication-sni-on-java but involve more complicated
|
* http://stackoverflow.com/questions/12361090/server-name-indication-sni-on-java but involve more complicated
|
||||||
* handling of the HTTP requests to github's API.
|
* handling of the HTTP requests to github's API.
|
||||||
*
|
*/
|
||||||
* @throws IOException
|
|
||||||
*/
|
|
||||||
public GHAsset uploadAsset(File file, String contentType) throws IOException {
|
public GHAsset uploadAsset(File file, String contentType) throws IOException {
|
||||||
Requester builder = new Requester(owner.root);
|
Requester builder = new Requester(owner.root);
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,6 @@ public class GHReleaseBuilder {
|
|||||||
*
|
*
|
||||||
* @param commitish Defaults to the repository’s default branch (usually "master"). Unused if the Git tag
|
* @param commitish Defaults to the repository’s default branch (usually "master"). Unused if the Git tag
|
||||||
* already exists.
|
* already exists.
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public GHReleaseBuilder commitish(String commitish) {
|
public GHReleaseBuilder commitish(String commitish) {
|
||||||
if (commitish != null) {
|
if (commitish != null) {
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ import org.apache.commons.lang.StringUtils;
|
|||||||
|
|
||||||
import java.io.FileNotFoundException;
|
import java.io.FileNotFoundException;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
import java.io.InputStreamReader;
|
import java.io.InputStreamReader;
|
||||||
import java.io.InterruptedIOException;
|
import java.io.InterruptedIOException;
|
||||||
import java.io.Reader;
|
import java.io.Reader;
|
||||||
@@ -50,8 +51,8 @@ import java.util.Map;
|
|||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
import java.util.TreeMap;
|
import java.util.TreeMap;
|
||||||
|
|
||||||
import static java.util.Arrays.asList;
|
import static java.util.Arrays.*;
|
||||||
import static org.kohsuke.github.Previews.DRAX;
|
import static org.kohsuke.github.Previews.*;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A repository on GitHub.
|
* A repository on GitHub.
|
||||||
@@ -448,25 +449,24 @@ public class GHRepository extends GHObject {
|
|||||||
* Lists up the collaborators on this repository.
|
* Lists up the collaborators on this repository.
|
||||||
*
|
*
|
||||||
* @return Users
|
* @return Users
|
||||||
* @throws IOException
|
|
||||||
*/
|
*/
|
||||||
public PagedIterable<GHUser> listCollaborators() throws IOException {
|
public PagedIterable<GHUser> listCollaborators() throws IOException {
|
||||||
return new PagedIterable<GHUser>() {
|
return listUsers("collaborators");
|
||||||
public PagedIterator<GHUser> _iterator(int pageSize) {
|
}
|
||||||
|
|
||||||
return new PagedIterator<GHUser>(root.retrieve().asIterator(getApiTailUrl("collaborators"), GHUser[].class, pageSize)) {
|
/**
|
||||||
|
* Lists all <a href="https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/">the available assignees</a>
|
||||||
@Override
|
* to which issues may be assigned.
|
||||||
protected void wrapUp(GHUser[] users) {
|
*/
|
||||||
for (GHUser user : users) {
|
public PagedIterable<GHUser> listAssignees() throws IOException {
|
||||||
user.wrapUp(root);
|
return listUsers("assignees");
|
||||||
}
|
}
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if the given user is an assignee for this repository.
|
||||||
|
*/
|
||||||
|
public boolean hasAssignee(GHUser u) throws IOException {
|
||||||
|
return root.retrieve().asHttpStatusCode(getApiTailUrl("assignees/" + u.getLogin()))/100==2;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -480,6 +480,29 @@ public class GHRepository extends GHObject {
|
|||||||
return r;
|
return r;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Obtain permission for a given user in this repository.
|
||||||
|
* @param user a {@link GHUser#getLogin}
|
||||||
|
* @throws FileNotFoundException under some conditions (e.g., private repo you can see but are not an admin of); treat as unknown
|
||||||
|
* @throws HttpException with a 403 under other conditions (e.g., public repo you have no special rights to); treat as unknown
|
||||||
|
*/
|
||||||
|
@Deprecated @Preview
|
||||||
|
public GHPermissionType getPermission(String user) throws IOException {
|
||||||
|
GHPermission perm = root.retrieve().withPreview(KORRA).to(getApiTailUrl("collaborators/" + user + "/permission"), GHPermission.class);
|
||||||
|
perm.wrapUp(root);
|
||||||
|
return perm.getPermissionType();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Obtain permission for a given user in this repository.
|
||||||
|
* @throws FileNotFoundException under some conditions (e.g., private repo you can see but are not an admin of); treat as unknown
|
||||||
|
* @throws HttpException with a 403 under other conditions (e.g., public repo you have no special rights to); treat as unknown
|
||||||
|
*/
|
||||||
|
@Deprecated @Preview
|
||||||
|
public GHPermissionType getPermission(GHUser u) throws IOException {
|
||||||
|
return getPermission(u.getLogin());
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If this repository belongs to an organization, return a set of teams.
|
* If this repository belongs to an organization, return a set of teams.
|
||||||
*/
|
*/
|
||||||
@@ -504,7 +527,6 @@ public class GHRepository extends GHObject {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private void modifyCollaborators(Collection<GHUser> users, String method) throws IOException {
|
private void modifyCollaborators(Collection<GHUser> users, String method) throws IOException {
|
||||||
verifyMine();
|
|
||||||
for (GHUser user : users) {
|
for (GHUser user : users) {
|
||||||
new Requester(root).method(method).to(getApiTailUrl("collaborators/" + user.getLogin()));
|
new Requester(root).method(method).to(getApiTailUrl("collaborators/" + user.getLogin()));
|
||||||
}
|
}
|
||||||
@@ -799,7 +821,7 @@ public class GHRepository extends GHObject {
|
|||||||
*/
|
*/
|
||||||
public GHTree getTree(String sha) throws IOException {
|
public GHTree getTree(String sha) throws IOException {
|
||||||
String url = String.format("/repos/%s/%s/git/trees/%s", getOwnerName(), name, sha);
|
String url = String.format("/repos/%s/%s/git/trees/%s", getOwnerName(), name, sha);
|
||||||
return root.retrieve().to(url, GHTree.class).wrap(root);
|
return root.retrieve().to(url, GHTree.class).wrap(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -814,7 +836,32 @@ public class GHRepository extends GHObject {
|
|||||||
*/
|
*/
|
||||||
public GHTree getTreeRecursive(String sha, int recursive) throws IOException {
|
public GHTree getTreeRecursive(String sha, int recursive) throws IOException {
|
||||||
String url = String.format("/repos/%s/%s/git/trees/%s?recursive=%d", getOwnerName(), name, sha, recursive);
|
String url = String.format("/repos/%s/%s/git/trees/%s?recursive=%d", getOwnerName(), name, sha, recursive);
|
||||||
return root.retrieve().to(url, GHTree.class).wrap(root);
|
return root.retrieve().to(url, GHTree.class).wrap(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Obtains the metadata & the content of a blob.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* This method retrieves the whole content in memory, so beware when you are dealing with large BLOB.
|
||||||
|
*
|
||||||
|
* @see <a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>
|
||||||
|
* @see #readBlob(String)
|
||||||
|
*/
|
||||||
|
public GHBlob getBlob(String blobSha) throws IOException {
|
||||||
|
String target = getApiTailUrl("git/blobs/" + blobSha);
|
||||||
|
return root.retrieve().to(target, GHBlob.class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reads the content of a blob as a stream for better efficiency.
|
||||||
|
*
|
||||||
|
* @see <a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>
|
||||||
|
* @see #getBlob(String)
|
||||||
|
*/
|
||||||
|
public InputStream readBlob(String blobSha) throws IOException {
|
||||||
|
String target = getApiTailUrl("git/blobs/" + blobSha);
|
||||||
|
return root.retrieve().withHeader("Accept","application/vnd.github.VERSION.raw").asStream(target);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1092,11 +1139,6 @@ public class GHRepository extends GHObject {
|
|||||||
// return root.retrieveWithAuth("/pulls/"+owner+'/'+name,JsonPullRequests.class).wrap(root);
|
// return root.retrieveWithAuth("/pulls/"+owner+'/'+name,JsonPullRequests.class).wrap(root);
|
||||||
// }
|
// }
|
||||||
|
|
||||||
private void verifyMine() throws IOException {
|
|
||||||
if (!root.login.equals(getOwnerName()))
|
|
||||||
throw new IOException("Operation not applicable to a repository owned by someone else: " + getOwnerName());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a set that represents the post-commit hook URLs.
|
* Returns a set that represents the post-commit hook URLs.
|
||||||
* The returned set is live, and changes made to them are reflected to GitHub.
|
* The returned set is live, and changes made to them are reflected to GitHub.
|
||||||
|
|||||||
@@ -57,6 +57,11 @@ public class GHRepositorySearchBuilder extends GHSearchBuilder<GHRepository> {
|
|||||||
return q("stars:"+v);
|
return q("stars:"+v);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public GHRepositorySearchBuilder order(GHDirection v) {
|
||||||
|
req.with("order",v);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
public GHRepositorySearchBuilder sort(Sort sort) {
|
public GHRepositorySearchBuilder sort(Sort sort) {
|
||||||
req.with("sort",sort);
|
req.with("sort",sort);
|
||||||
return this;
|
return this;
|
||||||
|
|||||||
@@ -10,10 +10,12 @@ import java.util.List;
|
|||||||
* https://developer.github.com/v3/git/trees/
|
* https://developer.github.com/v3/git/trees/
|
||||||
*
|
*
|
||||||
* @author Daniel Teixeira - https://github.com/ddtxra
|
* @author Daniel Teixeira - https://github.com/ddtxra
|
||||||
|
* @see GHCommit#getTree()
|
||||||
* @see GHRepository#getTree(String)
|
* @see GHRepository#getTree(String)
|
||||||
|
* @see GHTreeEntry#asTree()
|
||||||
*/
|
*/
|
||||||
public class GHTree {
|
public class GHTree {
|
||||||
/* package almost final */GitHub root;
|
/* package almost final */GHRepository repo;
|
||||||
|
|
||||||
private boolean truncated;
|
private boolean truncated;
|
||||||
private String sha, url;
|
private String sha, url;
|
||||||
@@ -28,12 +30,24 @@ public class GHTree {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return an array of entries of the trees
|
* Return an array of entries of the trees
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public List<GHTreeEntry> getTree() {
|
public List<GHTreeEntry> getTree() {
|
||||||
return Collections.unmodifiableList(Arrays.asList(tree));
|
return Collections.unmodifiableList(Arrays.asList(tree));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Finds a tree entry by its name.
|
||||||
|
*
|
||||||
|
* IOW, find a directory entry by a file name.
|
||||||
|
*/
|
||||||
|
public GHTreeEntry getEntry(String path) {
|
||||||
|
for (GHTreeEntry e : tree) {
|
||||||
|
if (e.getPath().equals(path))
|
||||||
|
return e;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if the number of items in the tree array exceeded the GitHub maximum limit.
|
* 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.
|
* @return true true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false.
|
||||||
@@ -50,8 +64,11 @@ public class GHTree {
|
|||||||
return GitHub.parseURL(url);
|
return GitHub.parseURL(url);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* package */GHTree wrap(GitHub root) {
|
/* package */GHTree wrap(GHRepository repo) {
|
||||||
this.root = root;
|
this.repo = repo;
|
||||||
|
for (GHTreeEntry e : tree) {
|
||||||
|
e.tree = this;
|
||||||
|
}
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
package org.kohsuke.github;
|
package org.kohsuke.github;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
import java.net.URL;
|
import java.net.URL;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -10,6 +12,8 @@ import java.net.URL;
|
|||||||
* @see GHTree
|
* @see GHTree
|
||||||
*/
|
*/
|
||||||
public class GHTreeEntry {
|
public class GHTreeEntry {
|
||||||
|
/* package almost final */GHTree tree;
|
||||||
|
|
||||||
private String path, mode, type, sha, url;
|
private String path, mode, type, sha, url;
|
||||||
private long size;
|
private long size;
|
||||||
|
|
||||||
@@ -44,7 +48,7 @@ public class GHTreeEntry {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the type such as:
|
* Gets the type such as:
|
||||||
* "blob"
|
* "blob", "tree", etc.
|
||||||
*
|
*
|
||||||
* @return The type
|
* @return The type
|
||||||
*/
|
*/
|
||||||
@@ -68,4 +72,37 @@ public class GHTreeEntry {
|
|||||||
public URL getUrl() {
|
public URL getUrl() {
|
||||||
return GitHub.parseURL(url);
|
return GitHub.parseURL(url);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If this tree entry represents a file, then return its information.
|
||||||
|
* Otherwise null.
|
||||||
|
*/
|
||||||
|
public GHBlob asBlob() throws IOException {
|
||||||
|
if (type.equals("blob"))
|
||||||
|
return tree.repo.getBlob(sha);
|
||||||
|
else
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If this tree entry represents a file, then return its content.
|
||||||
|
* Otherwise null.
|
||||||
|
*/
|
||||||
|
public InputStream readAsBlob() throws IOException {
|
||||||
|
if (type.equals("blob"))
|
||||||
|
return tree.repo.readBlob(sha);
|
||||||
|
else
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If this tree entry represents a directory, then return it.
|
||||||
|
* Otherwise null.
|
||||||
|
*/
|
||||||
|
public GHTree asTree() throws IOException {
|
||||||
|
if (type.equals("tree"))
|
||||||
|
return tree.repo.getTree(sha);
|
||||||
|
else
|
||||||
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -214,4 +214,9 @@ public class GHUser extends GHPerson {
|
|||||||
if (tail.length()>0 && !tail.startsWith("/")) tail='/'+tail;
|
if (tail.length()>0 && !tail.startsWith("/")) tail='/'+tail;
|
||||||
return "/users/" + login + tail;
|
return "/users/" + login + tail;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*package*/ GHUser wrapUp(GitHub root) {
|
||||||
|
super.wrapUp(root);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,6 +49,11 @@ public class GHUserSearchBuilder extends GHSearchBuilder<GHUser> {
|
|||||||
return q("followers:"+v);
|
return q("followers:"+v);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public GHUserSearchBuilder order(GHDirection v) {
|
||||||
|
req.with("order",v);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
public GHUserSearchBuilder sort(Sort sort) {
|
public GHUserSearchBuilder sort(Sort sort) {
|
||||||
req.with("sort",sort);
|
req.with("sort",sort);
|
||||||
return this;
|
return this;
|
||||||
|
|||||||
@@ -23,12 +23,10 @@
|
|||||||
*/
|
*/
|
||||||
package org.kohsuke.github;
|
package org.kohsuke.github;
|
||||||
|
|
||||||
import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.ANY;
|
import com.fasterxml.jackson.databind.DeserializationFeature;
|
||||||
import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE;
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
import static java.util.logging.Level.FINE;
|
import com.fasterxml.jackson.databind.introspect.VisibilityChecker.Std;
|
||||||
import static java.net.HttpURLConnection.HTTP_UNAUTHORIZED;
|
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
|
||||||
import static org.kohsuke.github.Previews.DRAX;
|
|
||||||
|
|
||||||
import java.io.ByteArrayInputStream;
|
import java.io.ByteArrayInputStream;
|
||||||
import java.io.FileNotFoundException;
|
import java.io.FileNotFoundException;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
@@ -49,17 +47,18 @@ import java.util.List;
|
|||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
import java.util.TimeZone;
|
import java.util.TimeZone;
|
||||||
|
import java.util.logging.Logger;
|
||||||
|
import javax.annotation.CheckForNull;
|
||||||
|
import javax.annotation.Nonnull;
|
||||||
import org.apache.commons.codec.Charsets;
|
import org.apache.commons.codec.Charsets;
|
||||||
import org.apache.commons.codec.binary.Base64;
|
import org.apache.commons.codec.binary.Base64;
|
||||||
|
import org.apache.commons.io.IOUtils;
|
||||||
|
|
||||||
import com.fasterxml.jackson.databind.DeserializationFeature;
|
import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.ANY;
|
||||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE;
|
||||||
import com.fasterxml.jackson.databind.introspect.VisibilityChecker.Std;
|
import static java.net.HttpURLConnection.HTTP_UNAUTHORIZED;
|
||||||
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
|
import static java.util.logging.Level.FINE;
|
||||||
|
import static org.kohsuke.github.Previews.DRAX;
|
||||||
import javax.annotation.Nonnull;
|
|
||||||
import java.util.logging.Logger;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Root of the GitHub API.
|
* Root of the GitHub API.
|
||||||
@@ -90,6 +89,10 @@ public class GitHub {
|
|||||||
|
|
||||||
private HttpConnector connector = HttpConnector.DEFAULT;
|
private HttpConnector connector = HttpConnector.DEFAULT;
|
||||||
|
|
||||||
|
private final Object headerRateLimitLock = new Object();
|
||||||
|
private GHRateLimit headerRateLimit = null;
|
||||||
|
private volatile GHRateLimit rateLimit = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a client API root object.
|
* Creates a client API root object.
|
||||||
*
|
*
|
||||||
@@ -254,6 +257,10 @@ public class GitHub {
|
|||||||
return connector;
|
return connector;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public String getApiUrl() {
|
||||||
|
return apiUrl;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the custom connector used to make requests to GitHub.
|
* Sets the custom connector used to make requests to GitHub.
|
||||||
*/
|
*/
|
||||||
@@ -287,19 +294,63 @@ public class GitHub {
|
|||||||
*/
|
*/
|
||||||
public GHRateLimit getRateLimit() throws IOException {
|
public GHRateLimit getRateLimit() throws IOException {
|
||||||
try {
|
try {
|
||||||
return retrieve().to("/rate_limit", JsonRateLimit.class).rate;
|
return rateLimit = retrieve().to("/rate_limit", JsonRateLimit.class).rate;
|
||||||
} catch (FileNotFoundException e) {
|
} catch (FileNotFoundException e) {
|
||||||
// GitHub Enterprise doesn't have the rate limit, so in that case
|
// GitHub Enterprise doesn't have the rate limit, so in that case
|
||||||
// return some big number that's not too big.
|
// return some big number that's not too big.
|
||||||
// see issue #78
|
// see issue #78
|
||||||
GHRateLimit r = new GHRateLimit();
|
GHRateLimit r = new GHRateLimit();
|
||||||
r.limit = r.remaining = 1000000;
|
r.limit = r.remaining = 1000000;
|
||||||
long hours = 1000L * 60 * 60;
|
long hour = 60L * 60L; // this is madness, storing the date as seconds in a Date object
|
||||||
r.reset = new Date(System.currentTimeMillis() + 1 * hours );
|
r.reset = new Date(System.currentTimeMillis() / 1000L + hour);
|
||||||
return r;
|
return rateLimit = r;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*package*/ void updateRateLimit(@Nonnull GHRateLimit observed) {
|
||||||
|
synchronized (headerRateLimitLock) {
|
||||||
|
if (headerRateLimit == null
|
||||||
|
|| headerRateLimit.getResetDate().getTime() < observed.getResetDate().getTime()
|
||||||
|
|| headerRateLimit.remaining > observed.remaining) {
|
||||||
|
headerRateLimit = observed;
|
||||||
|
LOGGER.log(FINE, "Rate limit now: {0}", headerRateLimit);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the most recently observed rate limit data or {@code null} if either there is no rate limit
|
||||||
|
* (for example GitHub Enterprise) or if no requests have been made.
|
||||||
|
*
|
||||||
|
* @return the most recently observed rate limit data or {@code null}.
|
||||||
|
*/
|
||||||
|
@CheckForNull
|
||||||
|
public GHRateLimit lastRateLimit() {
|
||||||
|
synchronized (headerRateLimitLock) {
|
||||||
|
return headerRateLimit;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the current rate limit while trying not to actually make any remote requests unless absolutely necessary.
|
||||||
|
*
|
||||||
|
* @return the current rate limit data.
|
||||||
|
* @throws IOException if we couldn't get the current rate limit data.
|
||||||
|
*/
|
||||||
|
@Nonnull
|
||||||
|
public GHRateLimit rateLimit() throws IOException {
|
||||||
|
synchronized (headerRateLimitLock) {
|
||||||
|
if (headerRateLimit != null) {
|
||||||
|
return headerRateLimit;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
GHRateLimit rateLimit = this.rateLimit;
|
||||||
|
if (rateLimit == null || rateLimit.getResetDate().getTime() < System.currentTimeMillis()) {
|
||||||
|
rateLimit = getRateLimit();
|
||||||
|
}
|
||||||
|
return rateLimit;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the {@link GHUser} that represents yourself.
|
* Gets the {@link GHUser} that represents yourself.
|
||||||
*/
|
*/
|
||||||
@@ -340,7 +391,7 @@ public class GitHub {
|
|||||||
/**
|
/**
|
||||||
* Interns the given {@link GHUser}.
|
* Interns the given {@link GHUser}.
|
||||||
*/
|
*/
|
||||||
protected GHUser getUser(GHUser orig) throws IOException {
|
protected GHUser getUser(GHUser orig) {
|
||||||
GHUser u = users.get(orig.getLogin());
|
GHUser u = users.get(orig.getLogin());
|
||||||
if (u==null) {
|
if (u==null) {
|
||||||
orig.root = this;
|
orig.root = this;
|
||||||
@@ -416,7 +467,6 @@ public class GitHub {
|
|||||||
*
|
*
|
||||||
* @param key The license key provided from the API
|
* @param key The license key provided from the API
|
||||||
* @return The license details
|
* @return The license details
|
||||||
* @throws IOException
|
|
||||||
* @see GHLicense#getKey()
|
* @see GHLicense#getKey()
|
||||||
*/
|
*/
|
||||||
@Preview @Deprecated
|
@Preview @Deprecated
|
||||||
@@ -652,8 +702,18 @@ public class GitHub {
|
|||||||
Strict-Transport-Security: max-age=31536000; includeSubdomains; preload
|
Strict-Transport-Security: max-age=31536000; includeSubdomains; preload
|
||||||
X-Content-Type-Options: nosniff
|
X-Content-Type-Options: nosniff
|
||||||
*/
|
*/
|
||||||
return uc.getResponseCode() == HTTP_UNAUTHORIZED
|
try {
|
||||||
&& uc.getHeaderField("X-GitHub-Media-Type") != null;
|
return uc.getResponseCode() == HTTP_UNAUTHORIZED
|
||||||
|
&& uc.getHeaderField("X-GitHub-Media-Type") != null;
|
||||||
|
} finally {
|
||||||
|
// ensure that the connection opened by getResponseCode gets closed
|
||||||
|
try {
|
||||||
|
IOUtils.closeQuietly(uc.getInputStream());
|
||||||
|
} catch (IOException ignore) {
|
||||||
|
// ignore
|
||||||
|
}
|
||||||
|
IOUtils.closeQuietly(uc.getErrorStream());
|
||||||
|
}
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import java.util.List;
|
|||||||
import java.util.NoSuchElementException;
|
import java.util.NoSuchElementException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Iterator over a pagenated data source.
|
* Iterator over a paginated data source.
|
||||||
*
|
*
|
||||||
* Aside from the normal iterator operation, this method exposes {@link #nextPage()}
|
* Aside from the normal iterator operation, this method exposes {@link #nextPage()}
|
||||||
* that allows the caller to retrieve items per page.
|
* that allows the caller to retrieve items per page.
|
||||||
|
|||||||
@@ -7,4 +7,5 @@ package org.kohsuke.github;
|
|||||||
static final String LOKI = "application/vnd.github.loki-preview+json";
|
static final String LOKI = "application/vnd.github.loki-preview+json";
|
||||||
static final String DRAX = "application/vnd.github.drax-preview+json";
|
static final String DRAX = "application/vnd.github.drax-preview+json";
|
||||||
static final String SQUIRREL_GIRL = "application/vnd.github.squirrel-girl-preview";
|
static final String SQUIRREL_GIRL = "application/vnd.github.squirrel-girl-preview";
|
||||||
|
static final String KORRA = "application/vnd.github.korra-preview";
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -25,8 +25,6 @@ package org.kohsuke.github;
|
|||||||
|
|
||||||
import com.fasterxml.jackson.databind.JsonMappingException;
|
import com.fasterxml.jackson.databind.JsonMappingException;
|
||||||
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
|
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
|
||||||
import org.apache.commons.io.IOUtils;
|
|
||||||
|
|
||||||
import java.io.FileNotFoundException;
|
import java.io.FileNotFoundException;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.io.InputStream;
|
import java.io.InputStream;
|
||||||
@@ -42,6 +40,7 @@ import java.net.URL;
|
|||||||
import java.net.URLEncoder;
|
import java.net.URLEncoder;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
|
import java.util.Date;
|
||||||
import java.util.HashMap;
|
import java.util.HashMap;
|
||||||
import java.util.Iterator;
|
import java.util.Iterator;
|
||||||
import java.util.LinkedHashMap;
|
import java.util.LinkedHashMap;
|
||||||
@@ -53,12 +52,13 @@ import java.util.logging.Logger;
|
|||||||
import java.util.regex.Matcher;
|
import java.util.regex.Matcher;
|
||||||
import java.util.regex.Pattern;
|
import java.util.regex.Pattern;
|
||||||
import java.util.zip.GZIPInputStream;
|
import java.util.zip.GZIPInputStream;
|
||||||
|
|
||||||
import javax.annotation.WillClose;
|
import javax.annotation.WillClose;
|
||||||
|
import org.apache.commons.io.IOUtils;
|
||||||
|
import org.apache.commons.lang.StringUtils;
|
||||||
|
|
||||||
import static java.util.Arrays.asList;
|
import static java.util.Arrays.asList;
|
||||||
import static java.util.logging.Level.FINE;
|
import static java.util.logging.Level.*;
|
||||||
import static org.kohsuke.github.GitHub.*;
|
import static org.kohsuke.github.GitHub.MAPPER;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A builder pattern for making HTTP call and parsing its output.
|
* A builder pattern for making HTTP call and parsing its output.
|
||||||
@@ -81,6 +81,7 @@ class Requester {
|
|||||||
* Current connection.
|
* Current connection.
|
||||||
*/
|
*/
|
||||||
private HttpURLConnection uc;
|
private HttpURLConnection uc;
|
||||||
|
private boolean forceBody;
|
||||||
|
|
||||||
private static class Entry {
|
private static class Entry {
|
||||||
String key;
|
String key;
|
||||||
@@ -197,6 +198,16 @@ class Requester {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Small number of GitHub APIs use HTTP methods somewhat inconsistently, and use a body where it's not expected.
|
||||||
|
* Normally whether parameters go as query parameters or a body depends on the HTTP verb in use,
|
||||||
|
* but this method forces the parameters to be sent as a body.
|
||||||
|
*/
|
||||||
|
/*package*/ Requester inBody() {
|
||||||
|
forceBody = true;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
public void to(String tailApiUrl) throws IOException {
|
public void to(String tailApiUrl) throws IOException {
|
||||||
to(tailApiUrl,null);
|
to(tailApiUrl,null);
|
||||||
}
|
}
|
||||||
@@ -230,7 +241,7 @@ class Requester {
|
|||||||
|
|
||||||
@SuppressFBWarnings("SBSC_USE_STRINGBUFFER_CONCATENATION")
|
@SuppressFBWarnings("SBSC_USE_STRINGBUFFER_CONCATENATION")
|
||||||
private <T> T _to(String tailApiUrl, Class<T> type, T instance) throws IOException {
|
private <T> T _to(String tailApiUrl, Class<T> type, T instance) throws IOException {
|
||||||
if (METHODS_WITHOUT_BODY.contains(method) && !args.isEmpty()) {
|
if (!isMethodWithBody() && !args.isEmpty()) {
|
||||||
boolean questionMarkFound = tailApiUrl.indexOf('?') != -1;
|
boolean questionMarkFound = tailApiUrl.indexOf('?') != -1;
|
||||||
tailApiUrl += questionMarkFound ? '&' : '?';
|
tailApiUrl += questionMarkFound ? '&' : '?';
|
||||||
for (Iterator<Entry> it = args.listIterator(); it.hasNext();) {
|
for (Iterator<Entry> it = args.listIterator(); it.hasNext();) {
|
||||||
@@ -270,6 +281,8 @@ class Requester {
|
|||||||
return result;
|
return result;
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
handleApiError(e);
|
handleApiError(e);
|
||||||
|
} finally {
|
||||||
|
noteRateLimit(tailApiUrl);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -288,6 +301,8 @@ class Requester {
|
|||||||
return uc.getResponseCode();
|
return uc.getResponseCode();
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
handleApiError(e);
|
handleApiError(e);
|
||||||
|
} finally {
|
||||||
|
noteRateLimit(tailApiUrl);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -302,6 +317,59 @@ class Requester {
|
|||||||
return wrapStream(uc.getInputStream());
|
return wrapStream(uc.getInputStream());
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
handleApiError(e);
|
handleApiError(e);
|
||||||
|
} finally {
|
||||||
|
noteRateLimit(tailApiUrl);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void noteRateLimit(String tailApiUrl) {
|
||||||
|
if ("/rate_limit".equals(tailApiUrl)) {
|
||||||
|
// the rate_limit API is "free"
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (tailApiUrl.startsWith("/search")) {
|
||||||
|
// the search API uses a different rate limit
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
String limit = uc.getHeaderField("X-RateLimit-Limit");
|
||||||
|
if (StringUtils.isBlank(limit)) {
|
||||||
|
// if we are missing a header, return fast
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
String remaining = uc.getHeaderField("X-RateLimit-Remaining");
|
||||||
|
if (StringUtils.isBlank(remaining)) {
|
||||||
|
// if we are missing a header, return fast
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
String reset = uc.getHeaderField("X-RateLimit-Reset");
|
||||||
|
if (StringUtils.isBlank(reset)) {
|
||||||
|
// if we are missing a header, return fast
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
GHRateLimit observed = new GHRateLimit();
|
||||||
|
try {
|
||||||
|
observed.limit = Integer.parseInt(limit);
|
||||||
|
} catch (NumberFormatException e) {
|
||||||
|
if (LOGGER.isLoggable(FINEST)) {
|
||||||
|
LOGGER.log(FINEST, "Malformed X-RateLimit-Limit header value " + limit, e);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
observed.remaining = Integer.parseInt(remaining);
|
||||||
|
} catch (NumberFormatException e) {
|
||||||
|
if (LOGGER.isLoggable(FINEST)) {
|
||||||
|
LOGGER.log(FINEST, "Malformed X-RateLimit-Remaining header value " + remaining, e);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
observed.reset = new Date(Long.parseLong(reset)); // this is madness, storing the date as seconds
|
||||||
|
root.updateRateLimit(observed);
|
||||||
|
} catch (NumberFormatException e) {
|
||||||
|
if (LOGGER.isLoggable(FINEST)) {
|
||||||
|
LOGGER.log(FINEST, "Malformed X-RateLimit-Reset header value " + reset, e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -340,11 +408,11 @@ class Requester {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private boolean isMethodWithBody() {
|
private boolean isMethodWithBody() {
|
||||||
return !METHODS_WITHOUT_BODY.contains(method);
|
return forceBody || !METHODS_WITHOUT_BODY.contains(method);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads pagenated resources.
|
* Loads paginated resources.
|
||||||
*
|
*
|
||||||
* Every iterator call reports a new batch.
|
* Every iterator call reports a new batch.
|
||||||
*/
|
*/
|
||||||
@@ -371,7 +439,7 @@ class Requester {
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
return new PagingIterator<T>(type, root.getApiURL(s.toString()));
|
return new PagingIterator<T>(type, tailApiUrl, root.getApiURL(s.toString()));
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
throw new Error(e);
|
throw new Error(e);
|
||||||
}
|
}
|
||||||
@@ -380,6 +448,7 @@ class Requester {
|
|||||||
class PagingIterator<T> implements Iterator<T> {
|
class PagingIterator<T> implements Iterator<T> {
|
||||||
|
|
||||||
private final Class<T> type;
|
private final Class<T> type;
|
||||||
|
private final String tailApiUrl;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The next batch to be returned from {@link #next()}.
|
* The next batch to be returned from {@link #next()}.
|
||||||
@@ -391,9 +460,10 @@ class Requester {
|
|||||||
*/
|
*/
|
||||||
private URL url;
|
private URL url;
|
||||||
|
|
||||||
PagingIterator(Class<T> type, URL url) {
|
PagingIterator(Class<T> type, String tailApiUrl, URL url) {
|
||||||
this.url = url;
|
|
||||||
this.type = type;
|
this.type = type;
|
||||||
|
this.tailApiUrl = tailApiUrl;
|
||||||
|
this.url = url;
|
||||||
}
|
}
|
||||||
|
|
||||||
public boolean hasNext() {
|
public boolean hasNext() {
|
||||||
@@ -427,6 +497,8 @@ class Requester {
|
|||||||
return;
|
return;
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
handleApiError(e);
|
handleApiError(e);
|
||||||
|
} finally {
|
||||||
|
noteRateLimit(tailApiUrl);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
@@ -569,6 +641,24 @@ class Requester {
|
|||||||
" handling exception " + e, e);
|
" handling exception " + e, e);
|
||||||
throw e;
|
throw e;
|
||||||
}
|
}
|
||||||
|
InputStream es = wrapStream(uc.getErrorStream());
|
||||||
|
if (es != null) {
|
||||||
|
try {
|
||||||
|
String error = IOUtils.toString(es, "UTF-8");
|
||||||
|
if (e instanceof FileNotFoundException) {
|
||||||
|
// pass through 404 Not Found to allow the caller to handle it intelligently
|
||||||
|
e = (IOException) new FileNotFoundException(error).initCause(e);
|
||||||
|
} else if (e instanceof HttpException) {
|
||||||
|
HttpException http = (HttpException) e;
|
||||||
|
e = new HttpException(error, http.getResponseCode(), http.getResponseMessage(),
|
||||||
|
http.getUrl(), e);
|
||||||
|
} else {
|
||||||
|
e = (IOException) new IOException(error).initCause(e);
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
IOUtils.closeQuietly(es);
|
||||||
|
}
|
||||||
|
}
|
||||||
if (responseCode == HttpURLConnection.HTTP_UNAUTHORIZED) // 401 / Unauthorized == bad creds
|
if (responseCode == HttpURLConnection.HTTP_UNAUTHORIZED) // 401 / Unauthorized == bad creds
|
||||||
throw e;
|
throw e;
|
||||||
|
|
||||||
@@ -584,19 +674,7 @@ class Requester {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
InputStream es = wrapStream(uc.getErrorStream());
|
throw e;
|
||||||
try {
|
|
||||||
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);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private static final List<String> METHODS_WITHOUT_BODY = asList("GET", "DELETE");
|
private static final List<String> METHODS_WITHOUT_BODY = asList("GET", "DELETE");
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
package org.kohsuke.github;
|
package org.kohsuke.github;
|
||||||
|
|
||||||
import org.junit.Assert;
|
import org.junit.Assert;
|
||||||
|
import org.junit.Assume;
|
||||||
import org.junit.Before;
|
import org.junit.Before;
|
||||||
import org.kohsuke.randname.RandomNameGenerator;
|
import org.kohsuke.randname.RandomNameGenerator;
|
||||||
|
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author Kohsuke Kawaguchi
|
* @author Kohsuke Kawaguchi
|
||||||
@@ -25,5 +27,18 @@ public abstract class AbstractGitHubApiTestBase extends Assert {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected GHUser getUser() {
|
||||||
|
try {
|
||||||
|
return gitHub.getMyself();
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new RuntimeException(e.getMessage(), e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void kohsuke() {
|
||||||
|
String login = getUser().getLogin();
|
||||||
|
Assume.assumeTrue(login.equals("kohsuke") || login.equals("kohsuke2"));
|
||||||
|
}
|
||||||
|
|
||||||
protected static final RandomNameGenerator rnd = new RandomNameGenerator();
|
protected static final RandomNameGenerator rnd = new RandomNameGenerator();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import org.kohsuke.github.GHCommit.File;
|
|||||||
import org.kohsuke.github.GHOrganization.Permission;
|
import org.kohsuke.github.GHOrganization.Permission;
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
import java.net.URL;
|
import java.net.URL;
|
||||||
import java.util.*;
|
import java.util.*;
|
||||||
import java.util.Map.Entry;
|
import java.util.Map.Entry;
|
||||||
@@ -172,14 +173,6 @@ public class AppTest extends AbstractGitHubApiTestBase {
|
|||||||
return repository;
|
return repository;
|
||||||
}
|
}
|
||||||
|
|
||||||
private GHUser getUser() {
|
|
||||||
try {
|
|
||||||
return gitHub.getMyself();
|
|
||||||
} catch (IOException e) {
|
|
||||||
throw new RuntimeException(e.getMessage(), e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
public void testListIssues() throws IOException {
|
public void testListIssues() throws IOException {
|
||||||
GHUser u = getUser();
|
GHUser u = getUser();
|
||||||
@@ -362,6 +355,11 @@ public class AppTest extends AbstractGitHubApiTestBase {
|
|||||||
assertEquals(48,f.getLinesChanged());
|
assertEquals(48,f.getLinesChanged());
|
||||||
assertEquals("modified",f.getStatus());
|
assertEquals("modified",f.getStatus());
|
||||||
assertEquals("changelog.html", f.getFileName());
|
assertEquals("changelog.html", f.getFileName());
|
||||||
|
|
||||||
|
// walk the tree
|
||||||
|
GHTree t = commit.getTree();
|
||||||
|
assertThat(IOUtils.toString(t.getEntry("todo.txt").readAsBlob()), containsString("executor rendering"));
|
||||||
|
assertNotNull(t.getEntry("war").asTree());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
@@ -888,8 +886,38 @@ public class AppTest extends AbstractGitHubApiTestBase {
|
|||||||
a.delete();
|
a.delete();
|
||||||
}
|
}
|
||||||
|
|
||||||
private void kohsuke() {
|
@Test
|
||||||
String login = getUser().getLogin();
|
public void listOrgMemberships() throws Exception {
|
||||||
Assume.assumeTrue(login.equals("kohsuke") || login.equals("kohsuke2"));
|
GHMyself me = gitHub.getMyself();
|
||||||
|
for (GHMembership m : me.listOrgMemberships()) {
|
||||||
|
assertThat(m.getUser(), is((GHUser)me));
|
||||||
|
assertNotNull(m.getState());
|
||||||
|
assertNotNull(m.getRole());
|
||||||
|
|
||||||
|
System.out.printf("%s %s %s\n",
|
||||||
|
m.getOrganization().getLogin(),
|
||||||
|
m.getState(),
|
||||||
|
m.getRole());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void blob() throws Exception {
|
||||||
|
GHRepository r = gitHub.getRepository("kohsuke/github-api");
|
||||||
|
String sha1 = "a12243f2fc5b8c2ba47dd677d0b0c7583539584d";
|
||||||
|
|
||||||
|
assertBlobContent(r.readBlob(sha1));
|
||||||
|
|
||||||
|
GHBlob blob = r.getBlob(sha1);
|
||||||
|
assertBlobContent(blob.read());
|
||||||
|
assertThat(blob.getSha(),is("a12243f2fc5b8c2ba47dd677d0b0c7583539584d"));
|
||||||
|
assertThat(blob.getSize(),is(1104L));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void assertBlobContent(InputStream is) throws Exception {
|
||||||
|
String content = new String(IOUtils.toByteArray(is),"UTF-8");
|
||||||
|
assertThat(content,containsString("Copyright (c) 2011- Kohsuke Kawaguchi and other contributors"));
|
||||||
|
assertThat(content,containsString("FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR"));
|
||||||
|
assertThat(content.length(),is(1104));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package org.kohsuke.github;
|
|||||||
import org.junit.Test;
|
import org.junit.Test;
|
||||||
import org.kohsuke.github.GHRepository.Contributor;
|
import org.kohsuke.github.GHRepository.Contributor;
|
||||||
|
|
||||||
|
import java.io.FileNotFoundException;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -40,6 +41,33 @@ public class RepositoryTest extends AbstractGitHubApiTestBase {
|
|||||||
assertTrue(kohsuke);
|
assertTrue(kohsuke);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void getPermission() throws Exception {
|
||||||
|
kohsuke();
|
||||||
|
GHRepository r = gitHub.getRepository("github-api-test-org/test-permission");
|
||||||
|
assertEquals(GHPermissionType.ADMIN, r.getPermission("kohsuke"));
|
||||||
|
assertEquals(GHPermissionType.READ, r.getPermission("dude"));
|
||||||
|
r = gitHub.getOrganization("apache").getRepository("groovy");
|
||||||
|
try {
|
||||||
|
r.getPermission("jglick");
|
||||||
|
fail();
|
||||||
|
} catch (HttpException x) {
|
||||||
|
x.printStackTrace(); // good
|
||||||
|
assertEquals(403, x.getResponseCode());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (false) {
|
||||||
|
// can't easily test this; there's no private repository visible to the test user
|
||||||
|
r = gitHub.getOrganization("cloudbees").getRepository("private-repo-not-writable-by-me");
|
||||||
|
try {
|
||||||
|
r.getPermission("jglick");
|
||||||
|
fail();
|
||||||
|
} catch (FileNotFoundException x) {
|
||||||
|
x.printStackTrace(); // good
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private GHRepository getRepository() throws IOException {
|
private GHRepository getRepository() throws IOException {
|
||||||
return gitHub.getOrganization("github-api-test-org").getRepository("jenkins");
|
return gitHub.getOrganization("github-api-test-org").getRepository("jenkins");
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -65,8 +65,7 @@
|
|||||||
"issues_url": "https://api.github.com/repos/baxterandthehackers/public-repo/issues{/number}",
|
"issues_url": "https://api.github.com/repos/baxterandthehackers/public-repo/issues{/number}",
|
||||||
"pulls_url": "https://api.github.com/repos/baxterandthehackers/public-repo/pulls{/number}",
|
"pulls_url": "https://api.github.com/repos/baxterandthehackers/public-repo/pulls{/number}",
|
||||||
"milestones_url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones{/number}",
|
"milestones_url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones{/number}",
|
||||||
"notifications_url": "https://api.github.com/repos/baxterandthehackers/public-repo/notifications{?since,all,
|
"notifications_url": "https://api.github.com/repos/baxterandthehackers/public-repo/notifications{?since,all,participating}",
|
||||||
participating}",
|
|
||||||
"labels_url": "https://api.github.com/repos/baxterandthehackers/public-repo/labels{/name}",
|
"labels_url": "https://api.github.com/repos/baxterandthehackers/public-repo/labels{/name}",
|
||||||
"releases_url": "https://api.github.com/repos/baxterandthehackers/public-repo/releases{/id}",
|
"releases_url": "https://api.github.com/repos/baxterandthehackers/public-repo/releases{/id}",
|
||||||
"deployments_url": "https://api.github.com/repos/baxterandthehackers/public-repo/deployments",
|
"deployments_url": "https://api.github.com/repos/baxterandthehackers/public-repo/deployments",
|
||||||
|
|||||||
@@ -2,8 +2,7 @@
|
|||||||
"action": "created",
|
"action": "created",
|
||||||
"milestone": {
|
"milestone": {
|
||||||
"url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones/3",
|
"url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones/3",
|
||||||
"html_url": "https://github.com/baxterandthehackers/public-repo/milestones/Test%20milestone%20creation%20webhook
|
"html_url": "https://github.com/baxterandthehackers/public-repo/milestones/Test%20milestone%20creation%20webhook%20from%20command%20line2",
|
||||||
%20from%20command%20line2",
|
|
||||||
"labels_url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones/3/labels",
|
"labels_url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones/3/labels",
|
||||||
"id": 2055681,
|
"id": 2055681,
|
||||||
"number": 3,
|
"number": 3,
|
||||||
@@ -96,8 +95,7 @@
|
|||||||
"issues_url": "https://api.github.com/repos/baxterandthehackers/public-repo/issues{/number}",
|
"issues_url": "https://api.github.com/repos/baxterandthehackers/public-repo/issues{/number}",
|
||||||
"pulls_url": "https://api.github.com/repos/baxterandthehackers/public-repo/pulls{/number}",
|
"pulls_url": "https://api.github.com/repos/baxterandthehackers/public-repo/pulls{/number}",
|
||||||
"milestones_url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones{/number}",
|
"milestones_url": "https://api.github.com/repos/baxterandthehackers/public-repo/milestones{/number}",
|
||||||
"notifications_url": "https://api.github.com/repos/baxterandthehackers/public-repo/notifications{?since,all,
|
"notifications_url": "https://api.github.com/repos/baxterandthehackers/public-repo/notifications{?since,all,participating}",
|
||||||
participating}",
|
|
||||||
"labels_url": "https://api.github.com/repos/baxterandthehackers/public-repo/labels{/name}",
|
"labels_url": "https://api.github.com/repos/baxterandthehackers/public-repo/labels{/name}",
|
||||||
"releases_url": "https://api.github.com/repos/baxterandthehackers/public-repo/releases{/id}",
|
"releases_url": "https://api.github.com/repos/baxterandthehackers/public-repo/releases{/id}",
|
||||||
"deployments_url": "https://api.github.com/repos/baxterandthehackers/public-repo/deployments",
|
"deployments_url": "https://api.github.com/repos/baxterandthehackers/public-repo/deployments",
|
||||||
|
|||||||
Reference in New Issue
Block a user