jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-04-01 15:50:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enable automatic code formatter with CI validation

Browse Source 
This may be controversial but it we're doing it. Having code formatting needs to be consistent
and a non-issue during code review. I'm willing modify the configuration if people see a strong
need, but formatting needs to be present and enforced.
This commit is contained in:
Liam Newman
2019-11-13 13:28:23 -08:00
parent 8943af9840
commit 9d8460bb81
169 changed files with 3851 additions and 4180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
src/main/java/org/kohsuke/github/Requester.java
View File

@@ -74,7 +74,7 @@ import static org.kohsuke.github.GitHub.MAPPER;
class Requester {
private final GitHub root;
private final List<Entry> args = new ArrayList<Entry>();
private final Map<String,String> headers = new LinkedHashMap<String, String>();
private final Map<String, String> headers = new LinkedHashMap<String, String>();
/**
* Request method.
@@ -109,16 +109,16 @@ class Requester {
* 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);
headers.put(name, value);
}
public Requester withHeader(String name, String value) {
setHeader(name,value);
setHeader(name, value);
return this;
}
/*package*/ Requester withPreview(String name) {
return withHeader("Accept",name);
/* package */ Requester withPreview(String name) {
return withHeader("Accept", name);
}
/**
@@ -140,7 +140,7 @@ class Requester {
}
public Requester with(String key, Integer value) {
if (value!=null)
if (value != null)
_with(key, value);
return this;
}
@@ -148,12 +148,14 @@ 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, Enum e) {
if (e==null) return _with(key, null);
if (e == null)
return _with(key, null);
return with(key, transformEnum(e));
}
@@ -170,7 +172,7 @@ class Requester {
for (GHUser a : users) {
names.add(a.getLogin());
}
return with(key,names);
return with(key, names);
}
public Requester with(String key, Map<String, String> value) {
@@ -178,14 +180,14 @@ class Requester {
}
public Requester withPermissions(String key, Map<String, GHPermissionType> value) {
Map<String,String> retMap = new HashMap<String, String>();
Map<String, String> retMap = new HashMap<String, String>();
for (Map.Entry<String, GHPermissionType> entry : value.entrySet()) {
retMap.put(entry.getKey(), transformEnum(entry.getValue()));
}
return _with(key, retMap);
}
public Requester with(@WillClose/*later*/ InputStream body) {
public Requester with(@WillClose /* later */ InputStream body) {
this.body = body;
return this;
}
@@ -196,8 +198,8 @@ class Requester {
}
public Requester _with(String key, Object value) {
if (value!=null) {
args.add(new Entry(key,value));
if (value != null) {
args.add(new Entry(key, value));
}
return this;
}
@@ -212,7 +214,7 @@ class Requester {
return this;
}
}
return _with(key,value);
return _with(key, value);
}
public Requester method(String method) {
@@ -227,25 +229,24 @@ class Requester {
/**
* 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.
* 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() {
/* package */ Requester inBody() {
forceBody = true;
return this;
}
public void to(String tailApiUrl) throws IOException {
to(tailApiUrl,null);
to(tailApiUrl, null);
}
/**
* 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.
* @return
* {@link Reader} that reads the response.
* if the server returns 4xx/5xx responses.
* @return {@link Reader} that reads the response.
*/
public <T> T to(String tailApiUrl, Class<T> type) throws IOException {
return _to(tailApiUrl, type, null);
@@ -273,7 +274,7 @@ class Requester {
tailApiUrl += questionMarkFound ? '&' : '?';
for (Iterator<Entry> it = args.listIterator(); it.hasNext();) {
Entry arg = it.next();
tailApiUrl += arg.key + '=' + URLEncoder.encode(arg.value.toString(),"UTF-8");
tailApiUrl += arg.key + '=' + URLEncoder.encode(arg.value.toString(), "UTF-8");
if (it.hasNext()) {
tailApiUrl += '&';
}
@@ -298,7 +299,8 @@ class Requester {
setResponseHeaders(nextResult);
final int resultLength = Array.getLength(result);
final int nextResultLength = Array.getLength(nextResult);
T concatResult = (T) Array.newInstance(type.getComponentType(), resultLength + nextResultLength);
T concatResult = (T) Array.newInstance(type.getComponentType(),
resultLength + nextResultLength);
System.arraycopy(result, 0, concatResult, 0, resultLength);
System.arraycopy(nextResult, 0, concatResult, resultLength, nextResultLength);
result = concatResult;
@@ -408,7 +410,6 @@ class Requester {
return uc.getHeaderField(header);
}
/**
* Set up the request parameters or POST payload.
*/
@@ -417,14 +418,14 @@ class Requester {
uc.setDoOutput(true);
if (body == null) {
uc.setRequestProperty("Content-type", defaultString(contentType,"application/json"));
uc.setRequestProperty("Content-type", defaultString(contentType, "application/json"));
Map json = new HashMap();
for (Entry e : args) {
json.put(e.key, e.value);
}
MAPPER.writeValue(uc.getOutputStream(), json);
} else {
uc.setRequestProperty("Content-type", defaultString(contentType,"application/x-www-form-urlencoded"));
uc.setRequestProperty("Content-type", defaultString(contentType, "application/x-www-form-urlencoded"));
try {
byte[] bytes = new byte[32768];
int read;
@@ -442,7 +443,7 @@ class Requester {
return forceBody || !METHODS_WITHOUT_BODY.contains(method);
}
/*package*/ <T> PagedIterable<T> asPagedIterable(String tailApiUrl, Class<T[]> type, Consumer<T> consumer) {
/* package */ <T> PagedIterable<T> asPagedIterable(String tailApiUrl, Class<T[]> type, Consumer<T> consumer) {
return new PagedIterableWithConsumer(type, this, tailApiUrl, consumer);
}
@@ -453,7 +454,8 @@ class Requester {
private final String tailApiUrl;
private final Consumer<S> consumer;
public PagedIterableWithConsumer(Class<S[]> clazz, Requester requester, String tailApiUrl, Consumer<S> consumer) {
public PagedIterableWithConsumer(Class<S[]> clazz, Requester requester, String tailApiUrl,
Consumer<S> consumer) {
this.clazz = clazz;
this.tailApiUrl = tailApiUrl;
this.requester = requester;
@@ -481,11 +483,11 @@ class Requester {
*
* Every iterator call reports a new batch.
*/
/*package*/ <T> Iterator<T> asIterator(String tailApiUrl, Class<T> type, int pageSize) {
/* package */ <T> Iterator<T> asIterator(String tailApiUrl, Class<T> type, int pageSize) {
method("GET");
if (pageSize!=0)
args.add(new Entry("per_page",pageSize));
if (pageSize != 0)
args.add(new Entry("per_page", pageSize));
StringBuilder s = new StringBuilder(tailApiUrl);
if (!args.isEmpty()) {
@@ -499,14 +501,14 @@ class Requester {
s.append(URLEncoder.encode(a.value.toString(), "UTF-8"));
}
} catch (UnsupportedEncodingException e) {
throw new AssertionError(e); // UTF-8 is mandatory
throw new AssertionError(e); // UTF-8 is mandatory
}
}
try {
return new PagingIterator<T>(type, tailApiUrl, root.getApiURL(s.toString()));
} catch (IOException e) {
throw new GHException("Unable to build github Api URL",e);
throw new GHException("Unable to build github Api URL", e);
}
}
@@ -533,13 +535,14 @@ class Requester {
public boolean hasNext() {
fetch();
return next!=null;
return next != null;
}
public T next() {
fetch();
T r = next;
if (r==null) throw new NoSuchElementException();
if (r == null)
throw new NoSuchElementException();
next = null;
return r;
}
@@ -549,15 +552,17 @@ class Requester {
}
private void fetch() {
if (next!=null) return; // already fetched
if (url==null) return; // no more data to fetch
if (next != null)
return; // already fetched
if (url == null)
return; // no more data to fetch
try {
while (true) {// loop while API rate limit is hit
setupConnection(url);
try {
next = parse(type,null);
assert next!=null;
next = parse(type, null);
assert next != null;
findNextURL();
return;
} catch (IOException e) {
@@ -577,14 +582,15 @@ class Requester {
private void findNextURL() throws MalformedURLException {
url = null; // start defensively
String link = uc.getHeaderField("Link");
if (link==null) return;
if (link == null)
return;
for (String token : link.split(", ")) {
if (token.endsWith("rel=\"next\"")) {
// found the next page. This should look something like
// <https://api.github.com/repos?page=3&per_page=100>; rel="next"
int idx = token.indexOf('>');
url = new URL(token.substring(1,idx));
url = new URL(token.substring(1, idx));
return;
}
}
@@ -593,21 +599,21 @@ class Requester {
}
}
private void setupConnection(URL url) throws IOException {
if (LOGGER.isLoggable(FINE)) {
LOGGER.log(FINE, "GitHub API request [" + (root.login == null ? "anonymous" : root.login) + "]: " + method + " " + url.toString());
LOGGER.log(FINE, "GitHub API request [" + (root.login == null ? "anonymous" : root.login) + "]: " + method
+ " " + url.toString());
}
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)
if (root.encodedAuthorization != null)
uc.setRequestProperty("Authorization", root.encodedAuthorization);
for (Map.Entry<String, String> e : headers.entrySet()) {
String v = e.getValue();
if (v!=null)
if (v != null)
uc.setRequestProperty(e.getKey(), v);
}
@@ -623,9 +629,9 @@ class Requester {
try {
Field $method = HttpURLConnection.class.getDeclaredField("method");
$method.setAccessible(true);
$method.set(uc,method);
$method.set(uc, method);
} catch (Exception x) {
throw (IOException)new IOException("Failed to set the custom verb").initCause(x);
throw (IOException) new IOException("Failed to set the custom verb").initCause(x);
}
// sun.net.www.protocol.https.DelegatingHttpsURLConnection delegates to another HttpURLConnection
try {
@@ -639,11 +645,11 @@ class Requester {
} catch (NoSuchFieldException x) {
// no problem
} catch (IllegalAccessException x) {
throw (IOException)new IOException("Failed to set the custom verb").initCause(x);
throw (IOException) new IOException("Failed to set the custom verb").initCause(x);
}
}
if (!uc.getRequestMethod().equals(method))
throw new IllegalStateException("Failed to set the request method to "+method);
throw new IllegalStateException("Failed to set the request method to " + method);
}
@CheckForNull
@@ -659,11 +665,11 @@ class Requester {
responseCode = uc.getResponseCode();
responseMessage = uc.getResponseMessage();
if (responseCode == 304) {
return null; // special case handling for 304 unmodified, as the content will be ""
return null; // special case handling for 304 unmodified, as the content will be ""
}
if (responseCode == 204 && type!=null && type.isArray()) {
if (responseCode == 204 && type != null && type.isArray()) {
// no content
return type.cast(Array.newInstance(type.getComponentType(),0));
return type.cast(Array.newInstance(type.getComponentType(), 0));
}
// Response code 202 means the statistics are still being cached.
@@ -676,18 +682,19 @@ class Requester {
r = new InputStreamReader(wrapStream(uc.getInputStream()), "UTF-8");
String data = IOUtils.toString(r);
if (type!=null)
if (type != null)
try {
return setResponseHeaders(MAPPER.readValue(data, type));
} catch (JsonMappingException e) {
throw (IOException)new IOException("Failed to deserialize " +data).initCause(e);
throw (IOException) new IOException("Failed to deserialize " + data).initCause(e);
}
if (instance!=null) {
return setResponseHeaders(MAPPER.readerForUpdating(instance).<T>readValue(data));
if (instance != null) {
return setResponseHeaders(MAPPER.readerForUpdating(instance).<T> readValue(data));
}
return null;
} catch (FileNotFoundException e) {
// java.net.URLConnection handles 404 exception has FileNotFoundException, don't wrap exception in HttpException
// java.net.URLConnection handles 404 exception has FileNotFoundException, don't wrap exception in
// HttpException
// to preserve backward compatibility
throw e;
} catch (IOException e) {
@@ -710,7 +717,7 @@ class Requester {
setResponseHeaders((GHObject) readValue);
} else if (readValue instanceof JsonRateLimit) {
// if we're getting a GHRateLimit it needs the server date
((JsonRateLimit)readValue).resources.getCore().recalculateResetDate(uc.getHeaderField("Date"));
((JsonRateLimit) readValue).resources.getCore().recalculateResetDate(uc.getHeaderField("Date"));
}
return readValue;
}
@@ -724,16 +731,18 @@ class Requester {
*/
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);
if (encoding == null || in == null)
return in;
if (encoding.equals("gzip"))
return new GZIPInputStream(in);
throw new UnsupportedOperationException("Unexpected Content-Encoding: "+encoding);
throw new UnsupportedOperationException("Unexpected Content-Encoding: " + encoding);
}
/**
* Handle API error by either throwing it or by returning normally to retry.
*/
/*package*/ void handleApiError(IOException e) throws IOException {
/* package */ void handleApiError(IOException e) throws IOException {
int responseCode;
try {
responseCode = uc.getResponseCode();
@@ -741,8 +750,8 @@ class Requester {
// likely to be a network exception (e.g. SSLHandshakeException),
// uc.getResponseCode() and any other getter on the response will cause an exception
if (LOGGER.isLoggable(FINE))
LOGGER.log(FINE, "Silently ignore exception retrieving response code for '" + uc.getURL() + "'" +
" handling exception " + e, e);
LOGGER.log(FINE, "Silently ignore exception retrieving response code for '" + uc.getURL() + "'"
+ " handling exception " + e, e);
throw e;
}
InputStream es = wrapStream(uc.getErrorStream());
@@ -754,8 +763,7 @@ class Requester {
e = (IOException) new GHFileNotFoundException(error).withResponseHeaderFields(uc).initCause(e);
} else if (e instanceof HttpException) {
HttpException http = (HttpException) e;
e = new HttpException(error, http.getResponseCode(), http.getResponseMessage(),
http.getUrl(), e);
e = new HttpException(error, http.getResponseCode(), http.getResponseMessage(), http.getUrl(), e);
} else {
e = (IOException) new GHIOException(error).withResponseHeaderFields(uc).initCause(e);
}
@@ -766,20 +774,19 @@ class Requester {
if (responseCode == HttpURLConnection.HTTP_UNAUTHORIZED) // 401 Unauthorized == bad creds or OTP request
// In the case of a user with 2fa enabled, a header with X-GitHub-OTP
// will be returned indicating the user needs to respond with an otp
if(uc.getHeaderField("X-GitHub-OTP") != null)
if (uc.getHeaderField("X-GitHub-OTP") != null)
throw (IOException) new GHOTPRequiredException().withResponseHeaderFields(uc).initCause(e);
else
throw e; // usually org.kohsuke.github.HttpException (which extends IOException)
if ("0".equals(uc.getHeaderField("X-RateLimit-Remaining"))) {
root.rateLimitHandler.onError(e,uc);
root.rateLimitHandler.onError(e, uc);
return;
}
// Retry-After is not documented but apparently that field exists
if (responseCode == HttpURLConnection.HTTP_FORBIDDEN &&
uc.getHeaderField("Retry-After") != null) {
this.root.abuseLimitHandler.onError(e,uc);
if (responseCode == HttpURLConnection.HTTP_FORBIDDEN && uc.getHeaderField("Retry-After") != null) {
this.root.abuseLimitHandler.onError(e, uc);
return;
}
@@ -788,10 +795,12 @@ class Requester {
/**
* Transform Java Enum into Github constants given its conventions
* @param en - Enum to be transformed
*
* @param en
* Enum to be transformed
* @return a String containing the value of a Github constant
*/
private String transformEnum(Enum en){
private String transformEnum(Enum en) {
// by convention Java constant names are upper cases, but github uses
// lower-case constants. GitHub also uses '-', which in Java we always
// replace by '_'