jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-03-10 08:21:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

A step toward using Poster in place of the retrieve* methods.

Browse Source 
I was trying to add  the flavor of the retrieve method that reads into an existing instance, when I realized that there are just too many orthogonal axes here to rely on overloaded methods.

That calls for a builder pattern, which we already have --- it's called Poster, but it can actually already handle GET and other HTTP requests.

So I'm retiring the retrieveXYZ methods and moving the code into Poster. This is the first step.
This commit is contained in:
Kohsuke Kawaguchi
2012-09-05 18:52:37 -07:00
parent 3f1bb1a214
commit d6d73f5165
10 changed files with 105 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pom.xml
View File

@@ -64,7 +64,7 @@
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-mapper-asl</artifactId>
<version>1.5.0</version>
<version>1.9.9</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>

7
src/main/java/org/kohsuke/github/GHCommitComment.java
View File

@@ -98,9 +98,8 @@ public class GHCommitComment {
*/
public void update(String body) throws IOException {
GHCommitComment r = new Poster(owner.root)
.with("body",body)
.withCredential()
.to(getApiTail(),GHCommitComment.class,"PATCH");
.with("body", body)
.withCredential().method("PATCH").to(getApiTail(), GHCommitComment.class);
this.body = body;
}
@@ -108,7 +107,7 @@ public class GHCommitComment {
* Deletes this comment.
*/
public void delete() throws IOException {
new Poster(owner.root).withCredential().to(getApiTail(),null,"DELETE");
new Poster(owner.root).withCredential().method("DELETE").to(getApiTail());
}
private String getApiTail() {

3
src/main/java/org/kohsuke/github/GHHook.java
View File

@@ -54,7 +54,6 @@ public final class GHHook {
* Deletes this hook.
*/
public void delete() throws IOException {
new Poster(repository.root).withCredential()
.to(String.format("/repos/%s/%s/hooks/%d",repository.getOwnerName(),repository.getName(),id),null,"DELETE");
new Poster(repository.root).withCredential().method("DELETE").to(String.format("/repos/%s/%s/hooks/%d", repository.getOwnerName(), repository.getName(), id));
}
}

6
src/main/java/org/kohsuke/github/GHIssue.java
View File

@@ -26,7 +26,6 @@ package org.kohsuke.github;
import java.io.IOException;
import java.net.URL;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
@@ -116,12 +115,11 @@ public class GHIssue {
* Updates the issue by adding a comment.
*/
public void comment(String message) throws IOException {
new Poster(root).withCredential().with("body",message).to(getApiRoute()+"/comments",null,"POST");
new Poster(root).withCredential().with("body",message).to(getApiRoute() + "/comments");
}
private void edit(String key, Object value) throws IOException {
new Poster(root).withCredential()._with(key, value)
.to(getApiRoute(),null,"PATCH");
new Poster(root).withCredential()._with(key, value).method("PATCH").to(getApiRoute());
}
/**

2
src/main/java/org/kohsuke/github/GHOrganization.java
View File

@@ -101,7 +101,7 @@ public class GHOrganization extends GHPerson {
repo_names.add(r.getName());
}
post.with("repo_names",repo_names);
return post.to("/orgs/"+login+"/teams",GHTeam.class,"POST").wrapUp(this);
return post.method("POST").to("/orgs/" + login + "/teams", GHTeam.class).wrapUp(this);
}
public GHTeam createTeam(String name, Permission p, GHRepository... repositories) throws IOException {

12
src/main/java/org/kohsuke/github/GHRepository.java
View File

@@ -253,7 +253,7 @@ public class GHRepository {
private void modifyCollaborators(Collection<GHUser> users, String method) throws IOException {
verifyMine();
for (GHUser user : users) {
new Poster(root).withCredential().to("/repos/"+owner.login+"/"+name+"/collaborators/"+user.getLogin(),null,method);
new Poster(root).withCredential().method(method).to("/repos/" + owner.login + "/" + name + "/collaborators/" + user.getLogin());
}
}
@@ -273,8 +273,7 @@ public class GHRepository {
Poster poster = new Poster(root).withCredential();
if (!key.equals("name"))
poster.with("name", name); // even when we don't change the name, we need to send it in
poster.with(key, value)
.to("/repos/" + owner.login + "/" + name, null, "PATCH");
poster.with(key, value).method("PATCH").to("/repos/" + owner.login + "/" + name);
}
/**
@@ -314,7 +313,7 @@ public class GHRepository {
* Deletes this repository.
*/
public void delete() throws IOException {
new Poster(root).withCredential().to("/repos/" + owner.login +"/"+name, null, "DELETE");
new Poster(root).withCredential().method("DELETE").to("/repos/" + owner.login + "/" + name);
}
/**
@@ -324,7 +323,7 @@ public class GHRepository {
* Newly forked repository that belong to you.
*/
public GHRepository fork() throws IOException {
return new Poster(root).withCredential().to("/repos/" + owner.login + "/" + name + "/forks", GHRepository.class, "POST").wrap(root);
return new Poster(root).withCredential().method("POST").to("/repos/" + owner.login + "/" + name + "/forks", GHRepository.class).wrap(root);
}
/**
@@ -642,8 +641,7 @@ public class GHRepository {
public GHMilestone createMilestone(String title, String description) throws IOException {
return new Poster(root).withCredential()
.with("title", title).with("description", description)
.to("/repos/"+owner.login+"/"+name+"/milestones", GHMilestone.class,"POST").wrap(this);
.with("title", title).with("description", description).method("POST").to("/repos/" + owner.login + "/" + name + "/milestones", GHMilestone.class).wrap(this);
}
@Override

4
src/main/java/org/kohsuke/github/GHUser.java
View File

@@ -41,14 +41,14 @@ public class GHUser extends GHPerson {
* Follow this user.
*/
public void follow() throws IOException {
new Poster(root).withCredential().to("/user/following/"+login,null,"PUT");
new Poster(root).withCredential().method("PUT").to("/user/following/" + login);
}
/**
* Unfollow this user.
*/
public void unfollow() throws IOException {
new Poster(root).withCredential().to("/user/following/"+login,null,"DELETE");
new Poster(root).withCredential().method("DELETE").to("/user/following/" + login);
}
/**

11
src/main/java/org/kohsuke/github/GitHub.java
View File

@@ -170,6 +170,10 @@ public class GitHub {
return new URL(tailApiUrl);
}
/*package*/ Poster retrieve() {
return new Poster(this).method("GET");
}
/*package*/ <T> T retrieve(String tailApiUrl, Class<T> type) throws IOException {
return _retrieve(tailApiUrl, type, "GET", false);
}
@@ -379,7 +383,7 @@ public class GitHub {
public GHUser getUser(String login) throws IOException {
GHUser u = users.get(login);
if (u == null) {
u = retrieve("/users/" + login, GHUser.class);
u = retrieve().to("/users/" + login, GHUser.class);
u.root = this;
users.put(u.getLogin(), u);
}
@@ -465,9 +469,10 @@ public class GitHub {
* Newly created repository.
*/
public GHRepository createRepository(String name, String description, String homepage, boolean isPublic) throws IOException {
return new Poster(this).withCredential()
Poster poster = new Poster(this).withCredential()
.with("name", name).with("description", description).with("homepage", homepage)
.with("public", isPublic ? 1 : 0).to("/user/repos", GHRepository.class,"POST").wrap(this);
.with("public", isPublic ? 1 : 0);
return poster.method("POST").to("/user/repos", GHRepository.class).wrap(this);
}
/**

114
src/main/java/org/kohsuke/github/Poster.java
View File

@@ -26,6 +26,7 @@ package org.kohsuke.github;
import org.apache.commons.io.IOUtils;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.lang.reflect.Field;
@@ -36,11 +37,13 @@ import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.zip.GZIPInputStream;
import static org.kohsuke.github.GitHub.*;
/**
* Handles HTTP POST.
* A builder pattern for making HTTP call and parsing its output.
*
* @author Kohsuke Kawaguchi
*/
class Poster {
@@ -48,6 +51,11 @@ class Poster {
private final List<Entry> args = new ArrayList<Entry>();
private boolean authenticate;
/**
* Request method.
*/
private String method = "POST";
private static class Entry {
String key;
Object value;
@@ -62,8 +70,12 @@ class Poster {
this.root = root;
}
/**
* Makes a request with authentication credential.
*/
public Poster withCredential() {
root.requireCredential();
// keeping it inline with retrieveWithAuth not to enforce the check
// root.requireCredential();
authenticate = true;
return this;
}
@@ -97,12 +109,17 @@ class Poster {
return this;
}
public Poster method(String method) {
this.method = method;
return this;
}
public void to(String tailApiUrl) throws IOException {
to(tailApiUrl,null);
}
/**
* POSTs the form to the specified URL.
* Sends a request to the specified URL, and parses the response into the given type via databinding.
*
* @throws IOException
* if the server returns 4xx/5xx responses.
@@ -110,54 +127,85 @@ class Poster {
* {@link Reader} that reads the response.
*/
public <T> T to(String tailApiUrl, Class<T> type) throws IOException {
return to(tailApiUrl,type,"POST");
return _to(tailApiUrl, type, null);
}
/**
* Like {@link #to(String, Class)} but updates an existing object instead of creating a new instance.
*/
public <T> T to(String tailApiUrl, T existingInstance) throws IOException {
return _to(tailApiUrl, null, existingInstance);
}
/**
* Short for {@code method(method).to(tailApiUrl,type)}
*/
@Deprecated
public <T> T to(String tailApiUrl, Class<T> type, String method) throws IOException {
return method(method).to(tailApiUrl,type);
}
private <T> T _to(String tailApiUrl, Class<T> type, T instance) throws IOException {
while (true) {// loop while API rate limit is hit
HttpURLConnection uc = (HttpURLConnection) root.getApiURL(tailApiUrl).openConnection();
uc.setRequestProperty("Accept-Encoding", "gzip");
uc.setDoOutput(true);
uc.setRequestProperty("Content-type","application/x-www-form-urlencoded");
if (authenticate) {
if (root.oauthAccessToken!=null) {
uc.setRequestProperty("Authorization", "token " + root.oauthAccessToken);
} else {
if (root.password==null)
throw new IllegalArgumentException("V3 API doesn't support API token");
uc.setRequestProperty("Authorization", "Basic " + root.encodedAuthorization);
if (!method.equals("GET")) {
uc.setDoOutput(true);
uc.setRequestProperty("Content-type","application/x-www-form-urlencoded");
if (authenticate) {
if (root.oauthAccessToken!=null) {
uc.setRequestProperty("Authorization", "token " + root.oauthAccessToken);
} else {
if (root.password==null)
throw new IllegalArgumentException("V3 API doesn't support API token");
uc.setRequestProperty("Authorization", "Basic " + root.encodedAuthorization);
}
}
}
try {
uc.setRequestMethod(method);
} catch (ProtocolException e) {
// JDK only allows one of the fixed set of verbs. Try to override that
try {
Field $method = HttpURLConnection.class.getDeclaredField("method");
$method.setAccessible(true);
$method.set(uc,method);
} catch (Exception x) {
throw (IOException)new IOException("Failed to set the custom verb").initCause(x);
uc.setRequestMethod(method);
} catch (ProtocolException e) {
// JDK only allows one of the fixed set of verbs. Try to override that
try {
Field $method = HttpURLConnection.class.getDeclaredField("method");
$method.setAccessible(true);
$method.set(uc,method);
} catch (Exception x) {
throw (IOException)new IOException("Failed to set the custom verb").initCause(x);
}
}
}
Map json = new HashMap();
for (Entry e : args) {
json.put(e.key, e.value);
Map json = new HashMap();
for (Entry e : args) {
json.put(e.key, e.value);
}
MAPPER.writeValue(uc.getOutputStream(),json);
}
MAPPER.writeValue(uc.getOutputStream(),json);
try {
InputStreamReader r = new InputStreamReader(uc.getInputStream(), "UTF-8");
InputStreamReader r = new InputStreamReader(wrapStream(uc,uc.getInputStream()), "UTF-8");
String data = IOUtils.toString(r);
if (type==null) {
return null;
}
return MAPPER.readValue(data,type);
if (type!=null)
return MAPPER.readValue(data,type);
if (instance!=null)
return MAPPER.readerForUpdating(instance).<T>readValue(data);
return null;
} catch (IOException e) {
root.handleApiError(e,uc);
}
}
}
/**
* Handles the "Content-Encoding" header.
*/
private InputStream wrapStream(HttpURLConnection uc, InputStream in) throws IOException {
String encoding = uc.getContentEncoding();
if (encoding==null || in==null) return in;
if (encoding.equals("gzip")) return new GZIPInputStream(in);
throw new UnsupportedOperationException("Unexpected Content-Encoding: "+encoding);
}
}

2
src/test/java/org/kohsuke/AppTest.java
View File

@@ -87,7 +87,7 @@ public class AppTest extends TestCase {
assertFalse(r.hasAdminAccess());
}
public void tryGetMyself() throws Exception {
public void testGetMyself() throws Exception {
GitHub hub = GitHub.connect();
GHMyself me = hub.getMyself();
System.out.println(me);