- * If {@link S} is the same as {@link R}, {@link #with(String, Object)} will commit changes after the first value change
- * and return a {@link R} from {@link #done()}.
+ * If {@code S} is the same as {@code R}, {@link #with(String, Object)} will commit changes after the first value change
+ * and return a {@code R} from {@link #done()}.
*
*
- * If {@link S} is not the same as {@link R}, {@link #with(String, Object)} will batch together multiple changes and let
+ * If {@code S} is not the same as {@code R}, {@link #with(String, Object)} will batch together multiple changes and let
* the user call {@link #done()} when they are ready.
*
* @author Liam Newman
* @param
* Final return type built by this builder returned when {@link #done()}} is called.
* @param
- * Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@link S}
- * the same as {@link R}, this builder will commit changes after each call to {@link #with(String, Object)}.
+ * Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@code S}
+ * the same as {@code R}, this builder will commit changes after each call to {@link #with(String, Object)}.
*/
-abstract class AbstractBuilder extends GitHubInteractiveObject {
+abstract class AbstractBuilder extends GitHubInteractiveObject implements GitHubRequestBuilderDone {
- @Nonnull
- private final Class returnType;
+ @CheckForNull
+ private final R baseInstance;
private final boolean commitChangesImmediately;
- @CheckForNull
- private final R baseInstance;
+ @Nonnull
+ private final Class returnType;
/** The requester. */
@Nonnull
@@ -56,9 +57,9 @@ abstract class AbstractBuilder extends GitHubInteractiveObject {
// TODO: Not sure how update-in-place behavior should be controlled
// However, it certainly can be controlled dynamically down to the instance level or inherited for all children of
- // some
+ // some connection.
+
/** The update in place. */
- // connection.
protected boolean updateInPlace;
/**
@@ -67,7 +68,7 @@ abstract class AbstractBuilder extends GitHubInteractiveObject {
* @param finalReturnType
* the final return type for built by this builder returned when {@link #done()}} is called.
* @param intermediateReturnType
- * the intermediate return type of type {@link S} returned by calls to {@link #with(String, Object)}.
+ * the intermediate return type of type {@code S} returned by calls to {@link #with(String, Object)}.
* Must either be equal to {@code builtReturnType} or this instance must be castable to this class. If
* not, the constructor will throw {@link IllegalArgumentException}.
* @param root
@@ -75,6 +76,7 @@ abstract class AbstractBuilder extends GitHubInteractiveObject {
* @param baseInstance
* optional instance on which to base this builder.
*/
+ @SuppressFBWarnings(value = { "CT_CONSTRUCTOR_THROW" }, justification = "argument validation, internal class")
protected AbstractBuilder(@Nonnull Class finalReturnType,
@Nonnull Class intermediateReturnType,
@Nonnull GitHub root,
@@ -93,14 +95,9 @@ protected AbstractBuilder(@Nonnull Class finalReturnType,
}
/**
- * Finishes an update, committing changes.
- *
- * This method may update-in-place or not. Either way it returns the resulting instance.
- *
- * @return an instance with updated current data
- * @throws IOException
- * if there is an I/O Exception
+ * {@inheritDoc}
*/
+ @Override
@Nonnull
@BetaApi
public R done() throws IOException {
@@ -114,54 +111,54 @@ public R done() throws IOException {
}
/**
- * Applies a value to a name for this builder.
+ * Chooses whether to return a continuing builder or an updated data record
*
- * If {@link S} is the same as {@link R}, this method will commit changes after the first value change and return a
- * {@link R} from {@link #done()}.
+ * If {@code S} is the same as {@code R}, this method will commit changes after the first value change and return a
+ * {@code R} from {@link #done()}.
*
- * If {@link S} is not the same as {@link R}, this method will return an {@link S} and letting the caller batch
+ * If {@code S} is not the same as {@code R}, this method will return an {@code S} and letting the caller batch
* together multiple changes and call {@link #done()} when they are ready.
*
- * @param name
- * the name of the field
- * @param value
- * the value of the field
* @return either a continuing builder or an updated data record
* @throws IOException
* if an I/O error occurs
*/
@Nonnull
@BetaApi
- protected S with(@Nonnull String name, Object value) throws IOException {
- requester.with(name, value);
- return continueOrDone();
+ protected S continueOrDone() throws IOException {
+ // This little bit of roughness in this base class means all inheriting builders get to create Updater and
+ // Setter classes from almost identical code. Creator can often be implemented with significant code reuse as
+ // well.
+ if (commitChangesImmediately) {
+ // These casts look strange and risky, but they they're actually guaranteed safe due to the return path
+ // being based on the previous comparison of class instances passed to the constructor.
+ return (S) done();
+ } else {
+ return (S) this;
+ }
}
/**
- * Chooses whether to return a continuing builder or an updated data record
+ * Applies a value to a name for this builder.
*
- * If {@link S} is the same as {@link R}, this method will commit changes after the first value change and return a
- * {@link R} from {@link #done()}.
+ * If {@code S} is the same as {@code R}, this method will commit changes after the first value change and return a
+ * {@code R} from {@link #done()}.
*
- * If {@link S} is not the same as {@link R}, this method will return an {@link S} and letting the caller batch
+ * If {@code S} is not the same as {@code R}, this method will return an {@code S} and letting the caller batch
* together multiple changes and call {@link #done()} when they are ready.
*
+ * @param name
+ * the name of the field
+ * @param value
+ * the value of the field
* @return either a continuing builder or an updated data record
* @throws IOException
* if an I/O error occurs
*/
@Nonnull
@BetaApi
- protected S continueOrDone() throws IOException {
- // This little bit of roughness in this base class means all inheriting builders get to create Updater and
- // Setter classes from almost identical code. Creator can often be implemented with significant code reuse as
- // well.
- if (commitChangesImmediately) {
- // These casts look strange and risky, but they they're actually guaranteed safe due to the return path
- // being based on the previous comparison of class instances passed to the constructor.
- return (S) done();
- } else {
- return (S) this;
- }
+ protected S with(@Nonnull String name, Object value) throws IOException {
+ requester.with(name, value);
+ return continueOrDone();
}
}
diff --git a/src/main/java/org/kohsuke/github/AbuseLimitHandler.java b/src/main/java/org/kohsuke/github/AbuseLimitHandler.java
deleted file mode 100644
index d6894adf9a..0000000000
--- a/src/main/java/org/kohsuke/github/AbuseLimitHandler.java
+++ /dev/null
@@ -1,108 +0,0 @@
-package org.kohsuke.github;
-
-import org.kohsuke.github.connector.GitHubConnectorResponse;
-
-import java.io.IOException;
-import java.io.InterruptedIOException;
-import java.net.HttpURLConnection;
-
-import javax.annotation.Nonnull;
-
-// TODO: Auto-generated Javadoc
-/**
- * Pluggable strategy to determine what to do when the API abuse limit is hit.
- *
- * @author Kohsuke Kawaguchi
- * @see GitHubBuilder#withAbuseLimitHandler(GitHubAbuseLimitHandler)
- * GitHubBuilder#withAbuseLimitHandler(GitHubAbuseLimitHandler)
- * @see documentation
- * @see RateLimitHandler
- * @deprecated Switch to {@link GitHubAbuseLimitHandler}.
- */
-@Deprecated
-public abstract class AbuseLimitHandler extends GitHubAbuseLimitHandler {
-
- /**
- * Called when the library encounters HTTP error indicating that the API abuse limit is reached.
- *
- *
- * Any exception thrown from this method will cause the request to fail, and the caller of github-api will receive
- * an exception. If this method returns normally, another request will be attempted. For that to make sense, the
- * implementation needs to wait for some time.
- *
- * @param connectorResponse
- * Response information for this request.
- * @throws IOException
- * on failure
- * @see API documentation from GitHub
- * @see Dealing
- * with abuse rate limits
- *
- */
- public void onError(@Nonnull GitHubConnectorResponse connectorResponse) throws IOException {
- GHIOException e = new HttpException("Abuse limit reached",
- connectorResponse.statusCode(),
- connectorResponse.header("Status"),
- connectorResponse.request().url().toString()).withResponseHeaderFields(connectorResponse.allHeaders());
- onError(e, connectorResponse.toHttpURLConnection());
- }
-
- /**
- * Called when the library encounters HTTP error indicating that the API abuse limit is reached.
- *
- *
- * Any exception thrown from this method will cause the request to fail, and the caller of github-api will receive
- * an exception. If this method returns normally, another request will be attempted. For that to make sense, the
- * implementation needs to wait for some time.
- *
- * @param e
- * Exception from Java I/O layer. If you decide to fail the processing, you can throw this exception (or
- * wrap this exception into another exception and throw it).
- * @param uc
- * Connection that resulted in an error. Useful for accessing other response headers.
- * @throws IOException
- * on failure
- * @see API documentation from GitHub
- * @see Dealing
- * with abuse rate limits
- *
- */
- @Deprecated
- public abstract void onError(IOException e, HttpURLConnection uc) throws IOException;
-
- /**
- * Wait until the API abuse "wait time" is passed.
- */
- @Deprecated
- public static final AbuseLimitHandler WAIT = new AbuseLimitHandler() {
- @Override
- public void onError(IOException e, HttpURLConnection uc) throws IOException {
- try {
- Thread.sleep(parseWaitTime(uc));
- } catch (InterruptedException ex) {
- throw (InterruptedIOException) new InterruptedIOException().initCause(e);
- }
- }
-
- private long parseWaitTime(HttpURLConnection uc) {
- String v = uc.getHeaderField("Retry-After");
- if (v == null)
- return 60 * 1000; // can't tell, return 1 min
-
- return Math.max(1000, Long.parseLong(v) * 1000);
- }
- };
-
- /**
- * Fail immediately.
- */
- @Deprecated
- public static final AbuseLimitHandler FAIL = new AbuseLimitHandler() {
- @Override
- public void onError(IOException e, HttpURLConnection uc) throws IOException {
- throw e;
- }
- };
-}
diff --git a/src/main/java/org/kohsuke/github/BetaApi.java b/src/main/java/org/kohsuke/github/BetaApi.java
index 1c33b7daa3..22ae2d76a6 100644
--- a/src/main/java/org/kohsuke/github/BetaApi.java
+++ b/src/main/java/org/kohsuke/github/BetaApi.java
@@ -5,12 +5,9 @@
import java.lang.annotation.RetentionPolicy;
/**
- * Indicates that the method/class/etc marked is a beta implementation of an sdk feature.
+ * Indicates that the method/class/etc marked is a beta implementation of an SDK feature.
*
- * These APIs are subject to change and not a part of the backward compatibility commitment. Always used in conjunction
- * with 'deprecated' to raise awareness to clients.
- *
- *
+ * These APIs are subject to change and not a part of the backward compatibility commitment.
*/
@Retention(RetentionPolicy.RUNTIME)
@Documented
diff --git a/src/main/java/org/kohsuke/github/EnforcementLevel.java b/src/main/java/org/kohsuke/github/EnforcementLevel.java
deleted file mode 100644
index 0cc69500a9..0000000000
--- a/src/main/java/org/kohsuke/github/EnforcementLevel.java
+++ /dev/null
@@ -1,29 +0,0 @@
-package org.kohsuke.github;
-
-import java.util.Locale;
-
-// TODO: Auto-generated Javadoc
-/**
- * This was added during preview API period but it has changed since then.
- *
- * @author Kohsuke Kawaguchi
- */
-@Deprecated
-public enum EnforcementLevel {
-
- /** The off. */
- OFF,
- /** The non admins. */
- NON_ADMINS,
- /** The everyone. */
- EVERYONE;
-
- /**
- * To string.
- *
- * @return the string
- */
- public String toString() {
- return name().toLowerCase(Locale.ENGLISH);
- }
-}
diff --git a/src/main/java/org/kohsuke/github/EnterpriseManagedSupport.java b/src/main/java/org/kohsuke/github/EnterpriseManagedSupport.java
new file mode 100644
index 0000000000..9d3030558d
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/EnterpriseManagedSupport.java
@@ -0,0 +1,69 @@
+package org.kohsuke.github;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.Optional;
+import java.util.logging.Logger;
+
+/**
+ * Utility class for helping with operations for enterprise managed resources.
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+class EnterpriseManagedSupport {
+
+ private static final Logger LOGGER = Logger.getLogger(EnterpriseManagedSupport.class.getName());
+ static final String COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS = "Could not retrieve organization external groups";
+ static final String NOT_PART_OF_EXTERNALLY_MANAGED_ENTERPRISE_ERROR = "This organization is not part of externally managed enterprise.";
+
+ static final String TEAM_CANNOT_BE_EXTERNALLY_MANAGED_ERROR = "This team cannot be externally managed since it has explicit members.";
+
+ private static String logUnexpectedFailure(final JsonProcessingException exception, final String payload) {
+ final StringWriter sw = new StringWriter();
+ final PrintWriter pw = new PrintWriter(sw);
+ exception.printStackTrace(pw);
+ return String.format("Could not parse GitHub error response: '%s'. Full stacktrace follows:%n%s", payload, sw);
+ }
+
+ static EnterpriseManagedSupport forOrganization(final GHOrganization org) {
+ return new EnterpriseManagedSupport(org);
+ }
+
+ private final GHOrganization organization;
+
+ private EnterpriseManagedSupport(GHOrganization organization) {
+ this.organization = organization;
+ }
+
+ Optional filterException(final GHException e) {
+ if (e.getCause() instanceof HttpException) {
+ final HttpException he = (HttpException) e.getCause();
+ return filterException(he, COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS)
+ .map(translated -> new GHException(COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS, translated));
+ }
+ return Optional.empty();
+ }
+
+ Optional filterException(final HttpException he, final String scenario) {
+ if (he.getResponseCode() == 400) {
+ final String responseMessage = he.getMessage();
+ try {
+ final GHError error = GitHubClient.getMappingObjectReader(this.organization.root())
+ .forType(GHError.class)
+ .readValue(responseMessage);
+ if (NOT_PART_OF_EXTERNALLY_MANAGED_ENTERPRISE_ERROR.equals(error.getMessage())) {
+ return Optional.of(new GHNotExternallyManagedEnterpriseException(scenario, error, he));
+ } else if (TEAM_CANNOT_BE_EXTERNALLY_MANAGED_ERROR.equals(error.getMessage())) {
+ return Optional.of(new GHTeamCannotBeExternallyManagedException(scenario, error, he));
+ }
+ } catch (final JsonProcessingException e) {
+ // We can ignore it
+ LOGGER.warning(() -> logUnexpectedFailure(e, responseMessage));
+ }
+ }
+ return Optional.empty();
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHApp.java b/src/main/java/org/kohsuke/github/GHApp.java
index 91b24b275b..628ac0cf01 100644
--- a/src/main/java/org/kohsuke/github/GHApp.java
+++ b/src/main/java/org/kohsuke/github/GHApp.java
@@ -5,13 +5,13 @@
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.Collections;
+import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
-import static org.kohsuke.github.internal.Previews.MACHINE_MAN;
-
// TODO: Auto-generated Javadoc
/**
* A Github App.
@@ -21,66 +21,20 @@
*/
public class GHApp extends GHObject {
- private GHUser owner;
- private String name;
- private String slug;
private String description;
- private String externalUrl;
- private Map permissions;
+
private List events;
- private long installationsCount;
+ private String externalUrl;
private String htmlUrl;
-
- /**
- * Gets owner.
- *
- * @return the owner
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHUser getOwner() {
- return owner;
- }
-
- /**
- * Sets owner.
- *
- * @param owner
- * the owner
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setOwner(GHUser owner) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets name.
- *
- * @return the name
- */
- public String getName() {
- return name;
- }
-
+ private long installationsCount;
+ private String name;
+ private GHUser owner;
+ private Map permissions;
+ private String slug;
/**
- * Gets the slug name of the GitHub app.
- *
- * @return the slug name of the GitHub app
+ * Create default GHApp instance
*/
- public String getSlug() {
- return slug;
- }
-
- /**
- * Sets name.
- *
- * @param name
- * the name
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setName(String name) {
- throw new RuntimeException("Do not use this method.");
+ public GHApp() {
}
/**
@@ -92,39 +46,6 @@ public String getDescription() {
return description;
}
- /**
- * Sets description.
- *
- * @param description
- * the description
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setDescription(String description) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets external url.
- *
- * @return the external url
- */
- public String getExternalUrl() {
- return externalUrl;
- }
-
- /**
- * Sets external url.
- *
- * @param externalUrl
- * the external url
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setExternalUrl(String externalUrl) {
- throw new RuntimeException("Do not use this method.");
- }
-
/**
* Gets events.
*
@@ -137,36 +58,12 @@ public List getEvents() {
}
/**
- * Sets events.
- *
- * @param events
- * the events
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setEvents(List events) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets installations count.
- *
- * @return the installations count
- */
- public long getInstallationsCount() {
- return installationsCount;
- }
-
- /**
- * Sets installations count.
+ * Gets external url.
*
- * @param installationsCount
- * the installations count
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the external url
*/
- @Deprecated
- public void setInstallationsCount(long installationsCount) {
- throw new RuntimeException("Do not use this method.");
+ public String getExternalUrl() {
+ return externalUrl;
}
/**
@@ -178,43 +75,6 @@ public URL getHtmlUrl() {
return GitHubClient.parseURL(htmlUrl);
}
- /**
- * Gets permissions.
- *
- * @return the permissions
- */
- public Map getPermissions() {
- return Collections.unmodifiableMap(permissions);
- }
-
- /**
- * Sets permissions.
- *
- * @param permissions
- * the permissions
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setPermissions(Map permissions) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Obtains all the installations associated with this app.
- *
- * You must use a JWT to access this endpoint.
- *
- * @return a list of App installations
- * @see List installations
- */
- @Preview(MACHINE_MAN)
- public PagedIterable listInstallations() {
- return root().createRequest()
- .withPreview(MACHINE_MAN)
- .withUrlPath("/app/installations")
- .toIterable(GHAppInstallation[].class, null);
- }
-
/**
* Obtain an installation associated with this app.
*
@@ -227,10 +87,8 @@ public PagedIterable listInstallations() {
* on error
* @see Get an installation
*/
- @Preview(MACHINE_MAN)
public GHAppInstallation getInstallationById(long id) throws IOException {
return root().createRequest()
- .withPreview(MACHINE_MAN)
.withUrlPath(String.format("/app/installations/%d", id))
.fetch(GHAppInstallation.class);
}
@@ -248,10 +106,8 @@ public GHAppInstallation getInstallationById(long id) throws IOException {
* @see Get an organization
* installation
*/
- @Preview(MACHINE_MAN)
public GHAppInstallation getInstallationByOrganization(String name) throws IOException {
return root().createRequest()
- .withPreview(MACHINE_MAN)
.withUrlPath(String.format("/orgs/%s/installation", name))
.fetch(GHAppInstallation.class);
}
@@ -271,10 +127,8 @@ public GHAppInstallation getInstallationByOrganization(String name) throws IOExc
* @see Get a repository
* installation
*/
- @Preview(MACHINE_MAN)
public GHAppInstallation getInstallationByRepository(String ownerName, String repositoryName) throws IOException {
return root().createRequest()
- .withPreview(MACHINE_MAN)
.withUrlPath(String.format("/repos/%s/%s/installation", ownerName, repositoryName))
.fetch(GHAppInstallation.class);
}
@@ -291,12 +145,118 @@ public GHAppInstallation getInstallationByRepository(String ownerName, String re
* on error
* @see Get a user installation
*/
- @Preview(MACHINE_MAN)
public GHAppInstallation getInstallationByUser(String name) throws IOException {
return root().createRequest()
- .withPreview(MACHINE_MAN)
.withUrlPath(String.format("/users/%s/installation", name))
.fetch(GHAppInstallation.class);
}
+ /**
+ * Gets installations count.
+ *
+ * @return the installations count
+ */
+ public long getInstallationsCount() {
+ return installationsCount;
+ }
+
+ /**
+ * Gets name.
+ *
+ * @return the name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Gets owner.
+ *
+ * @return the owner
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHUser getOwner() {
+ return owner;
+ }
+
+ /**
+ * Gets permissions.
+ *
+ * @return the permissions
+ */
+ public Map getPermissions() {
+ return Collections.unmodifiableMap(permissions);
+ }
+
+ /**
+ * Gets the slug name of the GitHub app.
+ *
+ * @return the slug name of the GitHub app
+ */
+ public String getSlug() {
+ return slug;
+ }
+
+ /**
+ * Obtains all the installation requests associated with this app.
+ *
+ * You must use a JWT to access this endpoint.
+ *
+ * @return a list of App installation requests
+ * @see List
+ * installation requests
+ */
+ public PagedIterable listInstallationRequests() {
+ return root().createRequest()
+ .withUrlPath("/app/installation-requests")
+ .toIterable(GHAppInstallationRequest[].class, null);
+ }
+
+ /**
+ * Obtains all the installations associated with this app.
+ *
+ * You must use a JWT to access this endpoint.
+ *
+ * @return a list of App installations
+ * @see List installations
+ */
+ public PagedIterable listInstallations() {
+ return listInstallations(GitHubClient.toInstantOrNull(null));
+ }
+
+ /**
+ * Obtains all the installations associated with this app since a given date.
+ *
+ * You must use a JWT to access this endpoint.
+ *
+ * @param since
+ * - Allows users to get installations that have been updated since a given date.
+ * @return a list of App installations since a given time.
+ * @see List installations
+ * @deprecated use {@link #listInstallations(Instant)}
+ */
+ @Deprecated
+ public PagedIterable listInstallations(final Date since) {
+ return listInstallations(since.toInstant());
+ }
+
+ /**
+ * Obtains all the installations associated with this app since a given date.
+ *
+ * You must use a JWT to access this endpoint.
+ *
+ * @param since
+ * - Allows users to get installations that have been updated since a given date.
+ * @return a list of App installations since a given time.
+ * @see List installations
+ */
+ public PagedIterable listInstallations(final Instant since) {
+ Requester requester = root().createRequest().withUrlPath("/app/installations");
+ if (since != null) {
+ requester.with("since", GitHubClient.printInstant(since));
+ }
+ return requester.toIterable(GHAppInstallation[].class, null);
+ }
+
}
diff --git a/src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java b/src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java
index b809297e66..54c5228257 100644
--- a/src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java
@@ -5,21 +5,18 @@
import java.util.List;
import java.util.Map;
-import static org.kohsuke.github.internal.Previews.MACHINE_MAN;
-
// TODO: Auto-generated Javadoc
/**
* Creates a access token for a GitHub App Installation.
*
* @author Paulo Miguel Almeida
- * @see GHAppInstallation#createToken(Map) GHAppInstallation#createToken(Map)
* @see GHAppInstallation#createToken() GHAppInstallation#createToken()
*/
public class GHAppCreateTokenBuilder extends GitHubInteractiveObject {
+ private final String apiUrlTail;
/** The builder. */
protected final Requester builder;
- private final String apiUrlTail;
/**
* Instantiates a new GH app create token builder.
@@ -37,33 +34,33 @@ public class GHAppCreateTokenBuilder extends GitHubInteractiveObject {
}
/**
- * Instantiates a new GH app create token builder.
+ * Creates an app token with all the parameters.
+ *
+ * You must use a JWT to access this endpoint.
*
- * @param root
- * the root
- * @param apiUrlTail
- * the api url tail
- * @param permissions
- * the permissions
+ * @return a GHAppInstallationToken
+ * @throws IOException
+ * on error
*/
- @BetaApi
- GHAppCreateTokenBuilder(GitHub root, String apiUrlTail, Map permissions) {
- this(root, apiUrlTail);
- permissions(permissions);
+ public GHAppInstallationToken create() throws IOException {
+ return builder.method("POST").withUrlPath(apiUrlTail).fetch(GHAppInstallationToken.class);
}
/**
- * By default the installation token has access to all repositories that the installation can access. To restrict
- * the access to specific repositories, you can provide the repository_ids when creating the token. When you omit
- * repository_ids, the response does not contain neither the repositories nor the permissions key.
+ * Set the permissions granted to the access token. The permissions object includes the permission names and their
+ * access type.
*
- * @param repositoryIds
- * Array containing the repositories Ids
+ * @param permissions
+ * Map containing the permission names and types.
* @return a GHAppCreateTokenBuilder
*/
@BetaApi
- public GHAppCreateTokenBuilder repositoryIds(List repositoryIds) {
- this.builder.with("repository_ids", repositoryIds);
+ public GHAppCreateTokenBuilder permissions(Map permissions) {
+ Map retMap = new HashMap<>();
+ for (Map.Entry entry : permissions.entrySet()) {
+ retMap.put(entry.getKey(), GitHubRequest.transformEnum(entry.getValue()));
+ }
+ builder.with("permissions", retMap);
return this;
}
@@ -82,38 +79,18 @@ public GHAppCreateTokenBuilder repositories(List repositories) {
}
/**
- * Set the permissions granted to the access token. The permissions object includes the permission names and their
- * access type.
+ * By default the installation token has access to all repositories that the installation can access. To restrict
+ * the access to specific repositories, you can provide the repository_ids when creating the token. When you omit
+ * repository_ids, the response does not contain neither the repositories nor the permissions key.
*
- * @param permissions
- * Map containing the permission names and types.
+ * @param repositoryIds
+ * Array containing the repositories Ids
* @return a GHAppCreateTokenBuilder
*/
@BetaApi
- public GHAppCreateTokenBuilder permissions(Map permissions) {
- Map retMap = new HashMap<>();
- for (Map.Entry entry : permissions.entrySet()) {
- retMap.put(entry.getKey(), GitHubRequest.transformEnum(entry.getValue()));
- }
- builder.with("permissions", retMap);
+ public GHAppCreateTokenBuilder repositoryIds(List repositoryIds) {
+ this.builder.with("repository_ids", repositoryIds);
return this;
}
- /**
- * Creates an app token with all the parameters.
- *
- * You must use a JWT to access this endpoint.
- *
- * @return a GHAppInstallationToken
- * @throws IOException
- * on error
- */
- @Preview(MACHINE_MAN)
- public GHAppInstallationToken create() throws IOException {
- return builder.method("POST")
- .withPreview(MACHINE_MAN)
- .withUrlPath(apiUrlTail)
- .fetch(GHAppInstallationToken.class);
- }
-
}
diff --git a/src/main/java/org/kohsuke/github/GHAppFromManifest.java b/src/main/java/org/kohsuke/github/GHAppFromManifest.java
index ed58423bbe..2fa5e3998c 100644
--- a/src/main/java/org/kohsuke/github/GHAppFromManifest.java
+++ b/src/main/java/org/kohsuke/github/GHAppFromManifest.java
@@ -9,9 +9,15 @@
public class GHAppFromManifest extends GHApp {
private String clientId;
+
private String clientSecret;
- private String webhookSecret;
private String pem;
+ private String webhookSecret;
+ /**
+ * Create default GHAppFromManifest instance
+ */
+ public GHAppFromManifest() {
+ }
/**
* Gets the client id
@@ -32,20 +38,20 @@ public String getClientSecret() {
}
/**
- * Gets the webhook secret
+ * Gets the pem
*
- * @return the webhook secret
+ * @return the pem
*/
- public String getWebhookSecret() {
- return webhookSecret;
+ public String getPem() {
+ return pem;
}
/**
- * Gets the pem
+ * Gets the webhook secret
*
- * @return the pem
+ * @return the webhook secret
*/
- public String getPem() {
- return pem;
+ public String getWebhookSecret() {
+ return webhookSecret;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHAppInstallation.java b/src/main/java/org/kohsuke/github/GHAppInstallation.java
index cf5bda32b0..e92c744e99 100644
--- a/src/main/java/org/kohsuke/github/GHAppInstallation.java
+++ b/src/main/java/org/kohsuke/github/GHAppInstallation.java
@@ -1,19 +1,19 @@
package org.kohsuke.github;
import com.fasterxml.jackson.annotation.JsonProperty;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.kohsuke.github.internal.EnumUtils;
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.Collections;
+import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
-import static org.kohsuke.github.internal.Previews.GAMBIT;
-import static org.kohsuke.github.internal.Previews.MACHINE_MAN;
-
// TODO: Auto-generated Javadoc
/**
* A Github App Installation.
@@ -26,67 +26,85 @@
* @see GHApp#getInstallationByUser(String) GHApp#getInstallationByUser(String)
*/
public class GHAppInstallation extends GHObject {
- private GHUser account;
+
+ private static class GHAppInstallationRepositoryResult extends SearchResult {
+ private GHRepository[] repositories;
+
+ @Override
+ GHRepository[] getItems(GitHub root) {
+ return repositories;
+ }
+ }
@JsonProperty("access_tokens_url")
private String accessTokenUrl;
- @JsonProperty("repositories_url")
- private String repositoriesUrl;
+
+ private GHUser account;
@JsonProperty("app_id")
private long appId;
+ private List events;
+ private String htmlUrl;
+ private Map permissions;
+ @JsonProperty("repositories_url")
+ private String repositoriesUrl;
+ @JsonProperty("repository_selection")
+ private GHRepositorySelection repositorySelection;
+ @JsonProperty("single_file_name")
+ private String singleFileName;
+ private String suspendedAt;
+ private GHUser suspendedBy;
@JsonProperty("target_id")
private long targetId;
@JsonProperty("target_type")
private GHTargetType targetType;
- private Map permissions;
- private List events;
- @JsonProperty("single_file_name")
- private String singleFileName;
- @JsonProperty("repository_selection")
- private GHRepositorySelection repositorySelection;
- private String htmlUrl;
/**
- * Gets the html url.
- *
- * @return the html url
+ * Create default GHAppInstallation instance
*/
- public URL getHtmlUrl() {
- return GitHubClient.parseURL(htmlUrl);
+ public GHAppInstallation() {
}
/**
- * Sets root.
+ * Starts a builder that creates a new App Installation Token.
+ *
+ *
+ * You use the returned builder to set various properties, then call {@link GHAppCreateTokenBuilder#create()} to
+ * finally create an access token.
*
- * @param root
- * the root
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return a GHAppCreateTokenBuilder instance
*/
- @Deprecated
- public void setRoot(GitHub root) {
- throw new RuntimeException("Do not use this method.");
+ public GHAppCreateTokenBuilder createToken() {
+ return new GHAppCreateTokenBuilder(root(), String.format("/app/installations/%d/access_tokens", getId()));
}
/**
- * Gets account.
+ * Starts a builder that creates a new App Installation Token.
*
- * @return the account
+ *
+ * You use the returned builder to set various properties, then call {@link GHAppCreateTokenBuilder#create()} to
+ * finally create an access token.
+ *
+ * @param permissions
+ * map of permissions for the created token
+ * @return a GHAppCreateTokenBuilder instance
+ * @deprecated Use {@link GHAppInstallation#createToken()} instead.
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHUser getAccount() {
- return account;
+ @Deprecated
+ public GHAppCreateTokenBuilder createToken(Map permissions) {
+ return createToken().permissions(permissions);
}
/**
- * Sets account.
+ * Delete a Github App installation
+ *
+ * You must use a JWT to access this endpoint.
*
- * @param account
- * the account
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @throws IOException
+ * on error
+ * @see Delete an installation
*/
- @Deprecated
- public void setAccount(GHUser account) {
- throw new RuntimeException("Do not use this method.");
+ public void deleteInstallation() throws IOException {
+ root().createRequest().method("DELETE").withUrlPath(String.format("/app/installations/%d", getId())).send();
}
/**
@@ -99,67 +117,13 @@ public String getAccessTokenUrl() {
}
/**
- * Sets access token url.
- *
- * @param accessTokenUrl
- * the access token url
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setAccessTokenUrl(String accessTokenUrl) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets repositories url.
- *
- * @return the repositories url
- */
- public String getRepositoriesUrl() {
- return repositoriesUrl;
- }
-
- /**
- * List repositories that this app installation can access.
- *
- * @return the paged iterable
- * @deprecated This method cannot work on a {@link GHAppInstallation} retrieved from
- * {@link GHApp#listInstallations()} (for example), except when resorting to unsupported hacks involving
- * {@link GHAppInstallation#setRoot(GitHub)} to switch from an application client to an installation
- * client. This method will be removed. You should instead use an installation client (with an
- * installation token, not a JWT), retrieve a {@link GHAuthenticatedAppInstallation} from
- * {@link GitHub#getInstallation()}, then call
- * {@link GHAuthenticatedAppInstallation#listRepositories()}.
- */
- @Deprecated
- @Preview(MACHINE_MAN)
- public PagedSearchIterable listRepositories() {
- GitHubRequest request;
-
- request = root().createRequest().withPreview(MACHINE_MAN).withUrlPath("/installation/repositories").build();
-
- return new PagedSearchIterable<>(root(), request, GHAppInstallationRepositoryResult.class);
- }
-
- private static class GHAppInstallationRepositoryResult extends SearchResult {
- private GHRepository[] repositories;
-
- @Override
- GHRepository[] getItems(GitHub root) {
- return repositories;
- }
- }
-
- /**
- * Sets repositories url.
+ * Gets account.
*
- * @param repositoriesUrl
- * the repositories url
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the account
*/
- @Deprecated
- public void setRepositoriesUrl(String repositoriesUrl) {
- throw new RuntimeException("Do not use this method.");
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHUser getAccount() {
+ return account;
}
/**
@@ -172,57 +136,44 @@ public long getAppId() {
}
/**
- * Sets app id.
- *
- * @param appId
- * the app id
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setAppId(long appId) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets target id.
+ * Gets events.
*
- * @return the target id
+ * @return the events
*/
- public long getTargetId() {
- return targetId;
+ public List getEvents() {
+ return events.stream()
+ .map(e -> EnumUtils.getEnumOrDefault(GHEvent.class, e, GHEvent.UNKNOWN))
+ .collect(Collectors.toList());
}
/**
- * Sets target id.
+ * Gets the html url.
*
- * @param targetId
- * the target id
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the html url
*/
- @Deprecated
- public void setTargetId(long targetId) {
- throw new RuntimeException("Do not use this method.");
+ public URL getHtmlUrl() {
+ return GitHubClient.parseURL(htmlUrl);
}
/**
- * Gets target type.
+ * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub
+ * App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will
+ * also see the upcoming pending change.
*
- * @return the target type
- */
- public GHTargetType getTargetType() {
- return targetType;
- }
-
- /**
- * Sets target type.
+ *
+ * GitHub Apps must use a JWT to access this endpoint.
+ *
+ * OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
*
- * @param targetType
- * the target type
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return a GHMarketplaceAccountPlan instance
+ * @throws IOException
+ * it may throw an {@link IOException}
+ * @see Get
+ * a subscription plan for an account
*/
- @Deprecated
- public void setTargetType(GHTargetType targetType) {
- throw new RuntimeException("Do not use this method.");
+ public GHMarketplaceAccountPlan getMarketplaceAccount() throws IOException {
+ return new GHMarketplacePlanForAccountBuilder(root(), account.getId()).createRequest();
}
/**
@@ -235,38 +186,21 @@ public Map getPermissions() {
}
/**
- * Sets permissions.
- *
- * @param permissions
- * the permissions
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setPermissions(Map permissions) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets events.
+ * Gets repositories url.
*
- * @return the events
+ * @return the repositories url
*/
- public List getEvents() {
- return events.stream()
- .map(e -> EnumUtils.getEnumOrDefault(GHEvent.class, e, GHEvent.UNKNOWN))
- .collect(Collectors.toList());
+ public String getRepositoriesUrl() {
+ return repositoriesUrl;
}
/**
- * Sets events.
+ * Gets repository selection.
*
- * @param events
- * the events
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the repository selection
*/
- @Deprecated
- public void setEvents(List events) {
- throw new RuntimeException("Do not use this method.");
+ public GHRepositorySelection getRepositorySelection() {
+ return repositorySelection;
}
/**
@@ -279,107 +213,60 @@ public String getSingleFileName() {
}
/**
- * Sets single file name.
+ * Gets suspended at.
*
- * @param singleFileName
- * the single file name
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the suspended at
*/
- @Deprecated
- public void setSingleFileName(String singleFileName) {
- throw new RuntimeException("Do not use this method.");
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getSuspendedAt() {
+ return GitHubClient.parseInstant(suspendedAt);
}
/**
- * Gets repository selection.
+ * Gets suspended by.
*
- * @return the repository selection
+ * @return the suspended by
*/
- public GHRepositorySelection getRepositorySelection() {
- return repositorySelection;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHUser getSuspendedBy() {
+ return suspendedBy;
}
/**
- * Sets repository selection.
+ * Gets target id.
*
- * @param repositorySelection
- * the repository selection
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the target id
*/
- @Deprecated
- public void setRepositorySelection(GHRepositorySelection repositorySelection) {
- throw new RuntimeException("Do not use this method.");
+ public long getTargetId() {
+ return targetId;
}
/**
- * Delete a Github App installation
- *
- * You must use a JWT to access this endpoint.
+ * Gets target type.
*
- * @throws IOException
- * on error
- * @see Delete an installation
+ * @return the target type
*/
- @Preview(GAMBIT)
- public void deleteInstallation() throws IOException {
- root().createRequest()
- .method("DELETE")
- .withPreview(GAMBIT)
- .withUrlPath(String.format("/app/installations/%d", getId()))
- .send();
+ public GHTargetType getTargetType() {
+ return targetType;
}
/**
- * Starts a builder that creates a new App Installation Token.
- *
- *
- * You use the returned builder to set various properties, then call {@link GHAppCreateTokenBuilder#create()} to
- * finally create an access token.
+ * List repositories that this app installation can access.
*
- * @param permissions
- * map of permissions for the created token
- * @return a GHAppCreateTokenBuilder instance
- * @deprecated Use {@link GHAppInstallation#createToken()} instead.
+ * @return the paged iterable
+ * @deprecated This method cannot work on a {@link GHAppInstallation} retrieved from
+ * {@link GHApp#listInstallations()} (for example), except when resorting to unsupported hacks involving
+ * setRoot(GitHub) to switch from an application client to an installation client. This method will be
+ * removed. You should instead use an installation client (with an installation token, not a JWT),
+ * retrieve a {@link GHAuthenticatedAppInstallation} from {@link GitHub#getInstallation()}, then call
+ * {@link GHAuthenticatedAppInstallation#listRepositories()}.
*/
- @BetaApi
- public GHAppCreateTokenBuilder createToken(Map permissions) {
- return new GHAppCreateTokenBuilder(root(),
- String.format("/app/installations/%d/access_tokens", getId()),
- permissions);
- }
+ @Deprecated
+ public PagedSearchIterable listRepositories() {
+ GitHubRequest request;
- /**
- * Starts a builder that creates a new App Installation Token.
- *
- *
- * You use the returned builder to set various properties, then call {@link GHAppCreateTokenBuilder#create()} to
- * finally create an access token.
- *
- * @return a GHAppCreateTokenBuilder instance
- */
- @BetaApi
- public GHAppCreateTokenBuilder createToken() {
- return new GHAppCreateTokenBuilder(root(), String.format("/app/installations/%d/access_tokens", getId()));
- }
+ request = root().createRequest().withUrlPath("/installation/repositories").build();
- /**
- * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub
- * App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will
- * also see the upcoming pending change.
- *
- *
- * GitHub Apps must use a JWT to access this endpoint.
- *
- * OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
- *
- * @return a GHMarketplaceAccountPlan instance
- * @throws IOException
- * it may throw an {@link IOException}
- * @see Get
- * a subscription plan for an account
- */
- public GHMarketplaceAccountPlan getMarketplaceAccount() throws IOException {
- return new GHMarketplacePlanForAccountBuilder(root(), account.getId()).createRequest();
+ return new PagedSearchIterable<>(root(), request, GHAppInstallationRepositoryResult.class);
}
}
diff --git a/src/main/java/org/kohsuke/github/GHAppInstallationRequest.java b/src/main/java/org/kohsuke/github/GHAppInstallationRequest.java
new file mode 100644
index 0000000000..44ace753a2
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHAppInstallationRequest.java
@@ -0,0 +1,42 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+/**
+ * A Github App Installation Request.
+ *
+ * @author Anuj Hydrabadi
+ * @see GHApp#listInstallationRequests() GHApp#listInstallationRequests()
+ */
+public class GHAppInstallationRequest extends GHObject {
+ private GHOrganization account;
+
+ private GHUser requester;
+
+ /**
+ * Create default GHAppInstallationRequest instance
+ */
+ public GHAppInstallationRequest() {
+ }
+
+ /**
+ * Gets the organization where the app was requested to be installed.
+ *
+ * @return the organization where the app was requested to be installed.
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP", "UWF_UNWRITTEN_FIELD" }, justification = "Expected behavior")
+ public GHOrganization getAccount() {
+ return account;
+ }
+
+ /**
+ * Gets the user who requested the installation.
+ *
+ * @return the user who requested the installation.
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP", "UWF_UNWRITTEN_FIELD" }, justification = "Expected behavior")
+ public GHUser getRequester() {
+ return requester;
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHAppInstallationToken.java b/src/main/java/org/kohsuke/github/GHAppInstallationToken.java
index 415cc996bc..3d268cf38a 100644
--- a/src/main/java/org/kohsuke/github/GHAppInstallationToken.java
+++ b/src/main/java/org/kohsuke/github/GHAppInstallationToken.java
@@ -1,9 +1,8 @@
package org.kohsuke.github;
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import java.io.IOException;
+import java.time.Instant;
import java.util.*;
// TODO: Auto-generated Javadoc
@@ -11,27 +10,32 @@
* A Github App Installation Token.
*
* @author Paulo Miguel Almeida
- * @see GHAppInstallation#createToken(Map) GHAppInstallation#createToken(Map)
+ * @see GHAppInstallation#createToken() GHAppInstallation#createToken()
*/
public class GHAppInstallationToken extends GitHubInteractiveObject {
- private String token;
- /** The expires at. */
- protected String expires_at;
private Map permissions;
+
private List repositories;
+
private GHRepositorySelection repositorySelection;
+ private String token;
+ /** The expires at. */
+ protected String expiresAt;
+ /**
+ * Create default GHAppInstallationToken instance
+ */
+ public GHAppInstallationToken() {
+ }
/**
- * Sets root.
+ * Gets expires at.
*
- * @param root
- * the root
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return date when this token expires
*/
- @Deprecated
- public void setRoot(GitHub root) {
- throw new RuntimeException("Do not use this method.");
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getExpiresAt() {
+ return GitHubClient.parseInstant(expiresAt);
}
/**
@@ -43,39 +47,6 @@ public Map getPermissions() {
return Collections.unmodifiableMap(permissions);
}
- /**
- * Sets permissions.
- *
- * @param permissions
- * the permissions
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setPermissions(Map permissions) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets token.
- *
- * @return the token
- */
- public String getToken() {
- return token;
- }
-
- /**
- * Sets token.
- *
- * @param token
- * the token
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setToken(String token) {
- throw new RuntimeException("Do not use this method.");
- }
-
/**
* Gets repositories.
*
@@ -85,18 +56,6 @@ public List getRepositories() {
return GitHubClient.unmodifiableListOrNull(repositories);
}
- /**
- * Sets repositories.
- *
- * @param repositories
- * the repositories
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setRepositories(List repositories) {
- throw new RuntimeException("Do not use this method.");
- }
-
/**
* Gets repository selection.
*
@@ -107,31 +66,11 @@ public GHRepositorySelection getRepositorySelection() {
}
/**
- * Sets repository selection.
- *
- * @param repositorySelection
- * the repository selection
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setRepositorySelection(GHRepositorySelection repositorySelection) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets expires at.
+ * Gets token.
*
- * @return date when this token expires
- * @throws IOException
- * on error
+ * @return the token
*/
- @WithBridgeMethods(value = String.class, adapterMethod = "expiresAtStr")
- public Date getExpiresAt() throws IOException {
- return GitHubClient.parseDate(expires_at);
- }
-
- @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", justification = "Bridge method of getExpiresAt")
- private Object expiresAtStr(Date id, Class type) {
- return expires_at;
+ public String getToken() {
+ return token;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHAppInstallationsIterable.java b/src/main/java/org/kohsuke/github/GHAppInstallationsIterable.java
index 8a150de1fb..fc89d371ee 100644
--- a/src/main/java/org/kohsuke/github/GHAppInstallationsIterable.java
+++ b/src/main/java/org/kohsuke/github/GHAppInstallationsIterable.java
@@ -12,8 +12,8 @@ class GHAppInstallationsIterable extends PagedIterable {
/** The Constant APP_INSTALLATIONS_URL. */
public static final String APP_INSTALLATIONS_URL = "/user/installations";
- private final transient GitHub root;
private GHAppInstallationsPage result;
+ private final transient GitHub root;
/**
* Instantiates a new GH app installations iterable.
diff --git a/src/main/java/org/kohsuke/github/GHAppInstallationsPage.java b/src/main/java/org/kohsuke/github/GHAppInstallationsPage.java
index 9a29832941..cd8f9a1f7e 100644
--- a/src/main/java/org/kohsuke/github/GHAppInstallationsPage.java
+++ b/src/main/java/org/kohsuke/github/GHAppInstallationsPage.java
@@ -5,8 +5,8 @@
* Represents the one page of GHAppInstallations.
*/
class GHAppInstallationsPage {
- private int total_count;
private GHAppInstallation[] installations;
+ private int totalCount;
/**
* Gets the total count.
@@ -14,7 +14,7 @@ class GHAppInstallationsPage {
* @return the total count
*/
public int getTotalCount() {
- return total_count;
+ return totalCount;
}
/**
diff --git a/src/main/java/org/kohsuke/github/GHArtifact.java b/src/main/java/org/kohsuke/github/GHArtifact.java
index a50454d0d0..21c16836f8 100644
--- a/src/main/java/org/kohsuke/github/GHArtifact.java
+++ b/src/main/java/org/kohsuke/github/GHArtifact.java
@@ -1,12 +1,14 @@
package org.kohsuke.github;
import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.apache.commons.lang3.StringUtils;
import org.kohsuke.github.function.InputStreamFunction;
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.Date;
import java.util.Objects;
@@ -20,32 +22,47 @@
*/
public class GHArtifact extends GHObject {
+ private String archiveDownloadUrl;
+
+ private boolean expired;
+
+ private String expiresAt;
+ private String name;
// Not provided by the API.
@JsonIgnore
private GHRepository owner;
-
- private String name;
private long sizeInBytes;
- private String archiveDownloadUrl;
- private boolean expired;
- private String expiresAt;
+ /**
+ * Create default GHArtifact instance
+ */
+ public GHArtifact() {
+ }
/**
- * Gets the name.
+ * Deletes the artifact.
*
- * @return the name
+ * @throws IOException
+ * the io exception
*/
- public String getName() {
- return name;
+ public void delete() throws IOException {
+ root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send();
}
/**
- * Gets the size of the artifact in bytes.
+ * Downloads the artifact.
*
- * @return the size
+ * @param
+ * the type of result
+ * @param streamFunction
+ * The {@link InputStreamFunction} that will process the stream
+ * @return the result of reading the stream.
+ * @throws IOException
+ * The IO exception.
*/
- public long getSizeInBytes() {
- return sizeInBytes;
+ public T download(InputStreamFunction streamFunction) throws IOException {
+ requireNonNull(streamFunction, "Stream function must not be null");
+
+ return root().createRequest().method("GET").withUrlPath(getApiRoute(), "zip").fetchStream(streamFunction);
}
/**
@@ -58,21 +75,22 @@ public URL getArchiveDownloadUrl() {
}
/**
- * If this artifact has expired.
+ * Gets the date at which this artifact will expire.
*
- * @return if the artifact has expired
+ * @return the date of expiration
*/
- public boolean isExpired() {
- return expired;
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getExpiresAt() {
+ return GitHubClient.parseInstant(expiresAt);
}
/**
- * Gets the date at which this artifact will expire.
+ * Gets the name.
*
- * @return the date of expiration
+ * @return the name
*/
- public Date getExpiresAt() {
- return GitHubClient.parseDate(expiresAt);
+ public String getName() {
+ return name;
}
/**
@@ -86,43 +104,21 @@ public GHRepository getRepository() {
}
/**
- * Gets the html url.
- *
- * @return the html url
- * @throws IOException
- * Signals that an I/O exception has occurred.
- * @deprecated This object has no HTML URL.
- */
- @Override
- public URL getHtmlUrl() throws IOException {
- return null;
- }
-
- /**
- * Deletes the artifact.
+ * Gets the size of the artifact in bytes.
*
- * @throws IOException
- * the io exception
+ * @return the size
*/
- public void delete() throws IOException {
- root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send();
+ public long getSizeInBytes() {
+ return sizeInBytes;
}
/**
- * Downloads the artifact.
+ * If this artifact has expired.
*
- * @param
- * the type of result
- * @param streamFunction
- * The {@link InputStreamFunction} that will process the stream
- * @return the result of reading the stream.
- * @throws IOException
- * The IO exception.
+ * @return if the artifact has expired
*/
- public T download(InputStreamFunction streamFunction) throws IOException {
- requireNonNull(streamFunction, "Stream function must not be null");
-
- return root().createRequest().method("GET").withUrlPath(getApiRoute(), "zip").fetchStream(streamFunction);
+ public boolean isExpired() {
+ return expired;
}
private String getApiRoute() {
diff --git a/src/main/java/org/kohsuke/github/GHArtifactsPage.java b/src/main/java/org/kohsuke/github/GHArtifactsPage.java
index 3737343912..8b3675bb11 100644
--- a/src/main/java/org/kohsuke/github/GHArtifactsPage.java
+++ b/src/main/java/org/kohsuke/github/GHArtifactsPage.java
@@ -1,12 +1,16 @@
package org.kohsuke.github;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
// TODO: Auto-generated Javadoc
/**
* Represents the one page of artifacts result when listing artifacts.
*/
+@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
+ justification = "JSON API")
class GHArtifactsPage {
- private int total_count;
private GHArtifact[] artifacts;
+ private int totalCount;
/**
* Gets the total count.
@@ -14,7 +18,7 @@ class GHArtifactsPage {
* @return the total count
*/
public int getTotalCount() {
- return total_count;
+ return totalCount;
}
/**
diff --git a/src/main/java/org/kohsuke/github/GHAsset.java b/src/main/java/org/kohsuke/github/GHAsset.java
index d64116f5eb..8ad0455483 100644
--- a/src/main/java/org/kohsuke/github/GHAsset.java
+++ b/src/main/java/org/kohsuke/github/GHAsset.java
@@ -3,7 +3,6 @@
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
-import java.net.URL;
// TODO: Auto-generated Javadoc
/**
@@ -13,36 +12,64 @@
*/
public class GHAsset extends GHObject {
- /** The owner. */
- GHRepository owner;
- private String name;
+ /**
+ * Wrap gh asset [ ].
+ *
+ * @param assets
+ * the assets
+ * @param release
+ * the release
+ * @return the gh asset [ ]
+ */
+ public static GHAsset[] wrap(GHAsset[] assets, GHRelease release) {
+ for (GHAsset aTo : assets) {
+ aTo.wrap(release);
+ }
+ return assets;
+ }
+
+ private String browserDownloadUrl;
+ private String contentType;
+ private long downloadCount;
private String label;
- private String state;
- private String content_type;
+ private String name;
private long size;
- private long download_count;
- private String browser_download_url;
+ private String state;
+ /** The owner. */
+ GHRepository owner;
/**
- * Gets content type.
- *
- * @return the content type
+ * Create default GHAsset instance
*/
- public String getContentType() {
- return content_type;
+ public GHAsset() {
}
/**
- * Sets content type.
+ * Delete.
*
- * @param contentType
- * the content type
* @throws IOException
* the io exception
*/
- public void setContentType(String contentType) throws IOException {
- edit("content_type", contentType);
- this.content_type = contentType;
+ public void delete() throws IOException {
+ root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send();
+ }
+
+ /**
+ * Gets browser download url.
+ *
+ * @return the browser download url
+ */
+ public String getBrowserDownloadUrl() {
+ return browserDownloadUrl;
+ }
+
+ /**
+ * Gets content type.
+ *
+ * @return the content type
+ */
+ public String getContentType() {
+ return contentType;
}
/**
@@ -51,7 +78,7 @@ public void setContentType(String contentType) throws IOException {
* @return the download count
*/
public long getDownloadCount() {
- return download_count;
+ return downloadCount;
}
/**
@@ -63,19 +90,6 @@ public String getLabel() {
return label;
}
- /**
- * Sets label.
- *
- * @param label
- * the label
- * @throws IOException
- * the io exception
- */
- public void setLabel(String label) throws IOException {
- edit("label", label);
- this.label = label;
- }
-
/**
* Gets name.
*
@@ -114,39 +128,35 @@ public String getState() {
}
/**
- * Gets the html url.
+ * Sets content type.
*
- * @return the html url
- * @deprecated This object has no HTML URL.
+ * @param contentType
+ * the content type
+ * @throws IOException
+ * the io exception
*/
- @Override
- public URL getHtmlUrl() {
- return null;
+ public void setContentType(String contentType) throws IOException {
+ edit("content_type", contentType);
+ this.contentType = contentType;
}
/**
- * Gets browser download url.
+ * Sets label.
*
- * @return the browser download url
+ * @param label
+ * the label
+ * @throws IOException
+ * the io exception
*/
- public String getBrowserDownloadUrl() {
- return browser_download_url;
+ public void setLabel(String label) throws IOException {
+ edit("label", label);
+ this.label = label;
}
private void edit(String key, Object value) throws IOException {
root().createRequest().with(key, value).method("PATCH").withUrlPath(getApiRoute()).send();
}
- /**
- * Delete.
- *
- * @throws IOException
- * the io exception
- */
- public void delete() throws IOException {
- root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send();
- }
-
private String getApiRoute() {
return "/repos/" + owner.getOwnerName() + "/" + owner.getName() + "/releases/assets/" + getId();
}
@@ -162,20 +172,4 @@ GHAsset wrap(GHRelease release) {
this.owner = release.getOwner();
return this;
}
-
- /**
- * Wrap gh asset [ ].
- *
- * @param assets
- * the assets
- * @param release
- * the release
- * @return the gh asset [ ]
- */
- public static GHAsset[] wrap(GHAsset[] assets, GHRelease release) {
- for (GHAsset aTo : assets) {
- aTo.wrap(release);
- }
- return assets;
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHAuthenticatedAppInstallation.java b/src/main/java/org/kohsuke/github/GHAuthenticatedAppInstallation.java
index 7d90645a7e..73d55ba4c1 100644
--- a/src/main/java/org/kohsuke/github/GHAuthenticatedAppInstallation.java
+++ b/src/main/java/org/kohsuke/github/GHAuthenticatedAppInstallation.java
@@ -2,8 +2,6 @@
import javax.annotation.Nonnull;
-import static org.kohsuke.github.internal.Previews.MACHINE_MAN;
-
// TODO: Auto-generated Javadoc
/**
* The Github App Installation corresponding to the installation token used in a client.
@@ -12,6 +10,15 @@
*/
public class GHAuthenticatedAppInstallation extends GitHubInteractiveObject {
+ private static class GHAuthenticatedAppInstallationRepositoryResult extends SearchResult {
+ private GHRepository[] repositories;
+
+ @Override
+ GHRepository[] getItems(GitHub root) {
+ return repositories;
+ }
+ }
+
/**
* Instantiates a new GH authenticated app installation.
*
@@ -27,22 +34,12 @@ protected GHAuthenticatedAppInstallation(@Nonnull GitHub root) {
*
* @return the paged iterable
*/
- @Preview(MACHINE_MAN)
public PagedSearchIterable listRepositories() {
GitHubRequest request;
- request = root().createRequest().withPreview(MACHINE_MAN).withUrlPath("/installation/repositories").build();
+ request = root().createRequest().withUrlPath("/installation/repositories").build();
return new PagedSearchIterable<>(root(), request, GHAuthenticatedAppInstallationRepositoryResult.class);
}
- private static class GHAuthenticatedAppInstallationRepositoryResult extends SearchResult {
- private GHRepository[] repositories;
-
- @Override
- GHRepository[] getItems(GitHub root) {
- return repositories;
- }
- }
-
}
diff --git a/src/main/java/org/kohsuke/github/GHAuthorization.java b/src/main/java/org/kohsuke/github/GHAuthorization.java
index 5286750ed7..9768de3063 100644
--- a/src/main/java/org/kohsuke/github/GHAuthorization.java
+++ b/src/main/java/org/kohsuke/github/GHAuthorization.java
@@ -17,105 +17,92 @@
*/
public class GHAuthorization extends GHObject {
- /** The Constant USER. */
- public static final String USER = "user";
-
- /** The Constant USER_EMAIL. */
- public static final String USER_EMAIL = "user:email";
-
- /** The Constant USER_FOLLOW. */
- public static final String USER_FOLLOW = "user:follow";
+ @SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD" },
+ justification = "JSON API")
+ private static class App {
+ private String name;
+ // private String client_id; not yet used
+ private String url;
+ }
- /** The Constant PUBLIC_REPO. */
- public static final String PUBLIC_REPO = "public_repo";
+ /** The Constant ADMIN_KEY. */
+ public static final String ADMIN_KEY = "admin:public_key";
- /** The Constant REPO. */
- public static final String REPO = "repo";
+ /** The Constant ADMIN_ORG. */
+ public static final String ADMIN_ORG = "admin:org";
- /** The Constant REPO_STATUS. */
- public static final String REPO_STATUS = "repo:status";
+ /** The Constant AMIN_HOOK. */
+ public static final String AMIN_HOOK = "admin:repo_hook";
/** The Constant DELETE_REPO. */
public static final String DELETE_REPO = "delete_repo";
+ /** The Constant GIST. */
+ public static final String GIST = "gist";
+
/** The Constant NOTIFICATIONS. */
public static final String NOTIFICATIONS = "notifications";
- /** The Constant GIST. */
- public static final String GIST = "gist";
+ /** The Constant PUBLIC_REPO. */
+ public static final String PUBLIC_REPO = "public_repo";
/** The Constant READ_HOOK. */
public static final String READ_HOOK = "read:repo_hook";
- /** The Constant WRITE_HOOK. */
- public static final String WRITE_HOOK = "write:repo_hook";
-
- /** The Constant AMIN_HOOK. */
- public static final String AMIN_HOOK = "admin:repo_hook";
+ /** The Constant READ_KEY. */
+ public static final String READ_KEY = "read:public_key";
/** The Constant READ_ORG. */
public static final String READ_ORG = "read:org";
- /** The Constant WRITE_ORG. */
- public static final String WRITE_ORG = "write:org";
+ /** The Constant REPO. */
+ public static final String REPO = "repo";
- /** The Constant ADMIN_ORG. */
- public static final String ADMIN_ORG = "admin:org";
+ /** The Constant REPO_STATUS. */
+ public static final String REPO_STATUS = "repo:status";
- /** The Constant READ_KEY. */
- public static final String READ_KEY = "read:public_key";
+ /** The Constant USER. */
+ public static final String USER = "user";
+
+ /** The Constant USER_EMAIL. */
+ public static final String USER_EMAIL = "user:email";
+
+ /** The Constant USER_FOLLOW. */
+ public static final String USER_FOLLOW = "user:follow";
+
+ /** The Constant WRITE_HOOK. */
+ public static final String WRITE_HOOK = "write:repo_hook";
/** The Constant WRITE_KEY. */
public static final String WRITE_KEY = "write:public_key";
- /** The Constant ADMIN_KEY. */
- public static final String ADMIN_KEY = "admin:public_key";
+ /** The Constant WRITE_ORG. */
+ public static final String WRITE_ORG = "write:org";
- private List scopes;
- private String token;
- private String token_last_eight;
- private String hashed_token;
private App app;
- private String note;
- private String note_url;
private String fingerprint;
// TODO add some user class for https://developer.github.com/v3/oauth_authorizations/#check-an-authorization ?
// private GHUser user;
+ private String hashedToken;
+ private String note;
+ private String noteUrl;
+ private List scopes;
+ private String token;
+ private String tokenLastEight;
/**
- * Gets scopes.
- *
- * @return the scopes
- */
- public List getScopes() {
- return Collections.unmodifiableList(scopes);
- }
-
- /**
- * Gets token.
- *
- * @return the token
+ * Create default GHAuthorization instance
*/
- public String getToken() {
- return token;
+ public GHAuthorization() {
}
/**
- * Gets token last eight.
- *
- * @return the token last eight
- */
- public String getTokenLastEight() {
- return token_last_eight;
- }
-
- /**
- * Gets hashed token.
+ * Gets app name.
*
- * @return the hashed token
+ * @return the app name
*/
- public String getHashedToken() {
- return hashed_token;
+ public String getAppName() {
+ return app.name;
}
/**
@@ -128,35 +115,21 @@ public URL getAppUrl() {
}
/**
- * Gets app name.
- *
- * @return the app name
- */
- public String getAppName() {
- return app.name;
- }
-
- /**
- * Gets api url.
+ * Gets fingerprint.
*
- * @return the api url
- * @deprecated use {@link #getUrl()}
+ * @return the fingerprint
*/
- @Deprecated
- @SuppressFBWarnings(value = "NM_CONFUSING", justification = "It's a part of the library API, cannot be changed")
- public URL getApiURL() {
- return getUrl();
+ public String getFingerprint() {
+ return fingerprint;
}
/**
- * Gets the html url.
+ * Gets hashed token.
*
- * @return the html url
- * @deprecated This object has no HTML URL.
+ * @return the hashed token
*/
- @Override
- public URL getHtmlUrl() {
- return null;
+ public String getHashedToken() {
+ return hashedToken;
}
/**
@@ -174,23 +147,33 @@ public String getNote() {
* @return the note url
*/
public URL getNoteUrl() {
- return GitHubClient.parseURL(note_url);
+ return GitHubClient.parseURL(noteUrl);
}
/**
- * Gets fingerprint.
+ * Gets scopes.
*
- * @return the fingerprint
+ * @return the scopes
*/
- public String getFingerprint() {
- return fingerprint;
+ public List getScopes() {
+ return Collections.unmodifiableList(scopes);
}
- @SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD" },
- justification = "JSON API")
- private static class App {
- private String url;
- private String name;
- // private String client_id; not yet used
+ /**
+ * Gets token.
+ *
+ * @return the token
+ */
+ public String getToken() {
+ return token;
+ }
+
+ /**
+ * Gets token last eight.
+ *
+ * @return the token last eight
+ */
+ public String getTokenLastEight() {
+ return tokenLastEight;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHAutolink.java b/src/main/java/org/kohsuke/github/GHAutolink.java
new file mode 100644
index 0000000000..9fe9c6a791
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHAutolink.java
@@ -0,0 +1,100 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import java.io.IOException;
+
+/**
+ * Represents a GitHub repository autolink reference.
+ *
+ * @author Alaurant
+ * @see GHAutolinkBuilder
+ * @see GHRepository#listAutolinks() GHRepository#listAutolinks()
+ * @see Repository autolinks API
+ */
+public class GHAutolink {
+
+ private int id;
+ private boolean isAlphanumeric;
+ private String keyPrefix;
+ private GHRepository owner;
+ private String urlTemplate;
+
+ /**
+ * Instantiates a new Gh autolink.
+ */
+ public GHAutolink() {
+ }
+
+ /**
+ * Deletes this autolink
+ *
+ * @throws IOException
+ * if the deletion fails
+ */
+ public void delete() throws IOException {
+ owner.root()
+ .createRequest()
+ .method("DELETE")
+ .withUrlPath(String.format("/repos/%s/%s/autolinks/%d", owner.getOwnerName(), owner.getName(), getId()))
+ .send();
+ }
+
+ /**
+ * Gets the autolink ID
+ *
+ * @return the id
+ */
+ public int getId() {
+ return id;
+ }
+
+ /**
+ * Gets the key prefix used to identify issues/PR references
+ *
+ * @return the key prefix string
+ */
+ public String getKeyPrefix() {
+ return keyPrefix;
+ }
+
+ /**
+ * Gets the repository that owns this autolink
+ *
+ * @return the repository instance
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getOwner() {
+ return owner;
+ }
+
+ /**
+ * Gets the URL template that will be used for matching
+ *
+ * @return the URL template string
+ */
+ public String getUrlTemplate() {
+ return urlTemplate;
+ }
+
+ /**
+ * Checks if the autolink uses alphanumeric values
+ *
+ * @return true if alphanumeric, false otherwise
+ */
+ public boolean isAlphanumeric() {
+ return isAlphanumeric;
+ }
+
+ /**
+ * Wraps this autolink with its owner repository.
+ *
+ * @param owner
+ * the repository that owns this autolink
+ * @return this instance
+ */
+ GHAutolink lateBind(GHRepository owner) {
+ this.owner = owner;
+ return this;
+ }
+}
diff --git a/src/main/java/org/kohsuke/github/GHAutolinkBuilder.java b/src/main/java/org/kohsuke/github/GHAutolinkBuilder.java
new file mode 100644
index 0000000000..c5726ced6e
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHAutolinkBuilder.java
@@ -0,0 +1,90 @@
+package org.kohsuke.github;
+
+import java.io.IOException;
+
+// TODO: Auto-generated Javadoc
+/**
+ * The type Gh autolink builder.
+ *
+ * @see GHRepository#createAutolink()
+ * @see GHAutolink
+ */
+public class GHAutolinkBuilder {
+
+ private Boolean isAlphanumeric;
+ private String keyPrefix;
+ private final GHRepository repo;
+ private final Requester req;
+ private String urlTemplate;
+
+ /**
+ * Instantiates a new Gh autolink builder.
+ *
+ * @param repo
+ * the repo
+ */
+ GHAutolinkBuilder(GHRepository repo) {
+ this.repo = repo;
+ req = repo.root().createRequest();
+ }
+
+ /**
+ * Create gh autolink.
+ *
+ * @return the gh autolink
+ * @throws IOException
+ * the io exception
+ */
+ public GHAutolink create() throws IOException {
+ GHAutolink autolink = req.method("POST")
+ .with("key_prefix", keyPrefix)
+ .with("url_template", urlTemplate)
+ .with("is_alphanumeric", isAlphanumeric)
+ .withHeader("Accept", "application/vnd.github+json")
+ .withUrlPath(getApiTail())
+ .fetch(GHAutolink.class);
+
+ return autolink.lateBind(repo);
+ }
+
+ /**
+ * With is alphanumeric gh autolink builder.
+ *
+ * @param isAlphanumeric
+ * the is alphanumeric
+ * @return the gh autolink builder
+ */
+ public GHAutolinkBuilder withIsAlphanumeric(boolean isAlphanumeric) {
+ this.isAlphanumeric = isAlphanumeric;
+ return this;
+ }
+
+ /**
+ * With key prefix gh autolink builder.
+ *
+ * @param keyPrefix
+ * the key prefix
+ * @return the gh autolink builder
+ */
+ public GHAutolinkBuilder withKeyPrefix(String keyPrefix) {
+ this.keyPrefix = keyPrefix;
+ return this;
+ }
+
+ /**
+ * With url template gh autolink builder.
+ *
+ * @param urlTemplate
+ * the url template
+ * @return the gh autolink builder
+ */
+ public GHAutolinkBuilder withUrlTemplate(String urlTemplate) {
+ this.urlTemplate = urlTemplate;
+ return this;
+ }
+
+ private String getApiTail() {
+ return String.format("/repos/%s/%s/autolinks", repo.getOwnerName(), repo.getName());
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHBlob.java b/src/main/java/org/kohsuke/github/GHBlob.java
index 0f109d38ab..31c83b6ff4 100644
--- a/src/main/java/org/kohsuke/github/GHBlob.java
+++ b/src/main/java/org/kohsuke/github/GHBlob.java
@@ -16,16 +16,32 @@
* @see Get a blob
*/
public class GHBlob {
+
private String content, encoding, url, sha;
+
private long size;
+ /**
+ * Create default GHBlob instance
+ */
+ public GHBlob() {
+ }
/**
- * Gets url.
+ * Gets content.
*
- * @return API URL of this blob.
+ * @return Encoded content. You probably want {@link #read()}
*/
- public URL getUrl() {
- return GitHubClient.parseURL(url);
+ public String getContent() {
+ return content;
+ }
+
+ /**
+ * Gets encoding.
+ *
+ * @return the encoding
+ */
+ public String getEncoding() {
+ return encoding;
}
/**
@@ -47,21 +63,12 @@ public long getSize() {
}
/**
- * Gets encoding.
- *
- * @return the encoding
- */
- public String getEncoding() {
- return encoding;
- }
-
- /**
- * Gets content.
+ * Gets url.
*
- * @return Encoded content. You probably want {@link #read()}
+ * @return API URL of this blob.
*/
- public String getContent() {
- return content;
+ public URL getUrl() {
+ return GitHubClient.parseURL(url);
}
/**
diff --git a/src/main/java/org/kohsuke/github/GHBlobBuilder.java b/src/main/java/org/kohsuke/github/GHBlobBuilder.java
index 187867689b..237768e503 100644
--- a/src/main/java/org/kohsuke/github/GHBlobBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHBlobBuilder.java
@@ -22,19 +22,6 @@ public class GHBlobBuilder {
req = repo.root().createRequest();
}
- /**
- * Configures a blob with the specified text {@code content}.
- *
- * @param content
- * string text of the blob
- * @return a GHBlobBuilder
- */
- public GHBlobBuilder textContent(String content) {
- req.with("content", content);
- req.with("encoding", "utf-8");
- return this;
- }
-
/**
* Configures a blob with the specified binary {@code content}.
*
@@ -49,10 +36,6 @@ public GHBlobBuilder binaryContent(byte[] content) {
return this;
}
- private String getApiTail() {
- return String.format("/repos/%s/%s/git/blobs", repo.getOwnerName(), repo.getName());
- }
-
/**
* Creates a blob based on the parameters specified thus far.
*
@@ -63,4 +46,21 @@ private String getApiTail() {
public GHBlob create() throws IOException {
return req.method("POST").withUrlPath(getApiTail()).fetch(GHBlob.class);
}
+
+ /**
+ * Configures a blob with the specified text {@code content}.
+ *
+ * @param content
+ * string text of the blob
+ * @return a GHBlobBuilder
+ */
+ public GHBlobBuilder textContent(String content) {
+ req.with("content", content);
+ req.with("encoding", "utf-8");
+ return this;
+ }
+
+ private String getApiTail() {
+ return String.format("/repos/%s/%s/git/blobs", repo.getOwnerName(), repo.getName());
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHBranch.java b/src/main/java/org/kohsuke/github/GHBranch.java
index 3a88231394..c18bd23aa7 100644
--- a/src/main/java/org/kohsuke/github/GHBranch.java
+++ b/src/main/java/org/kohsuke/github/GHBranch.java
@@ -3,11 +3,9 @@
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import org.kohsuke.github.internal.Previews;
import java.io.IOException;
import java.net.URL;
-import java.util.Collection;
import java.util.Objects;
import javax.annotation.CheckForNull;
@@ -23,49 +21,63 @@
"URF_UNREAD_FIELD" },
justification = "JSON API")
public class GHBranch extends GitHubInteractiveObject {
- private GHRepository owner;
+ /**
+ * The type Commit.
+ */
+ public static class Commit {
+
+ /** The sha. */
+ String sha;
+
+ /** The url. */
+ @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
+ String url;
+
+ /**
+ * Create default Commit instance
+ */
+ public Commit() {
+ }
+ }
- private String name;
private Commit commit;
+ private String name;
+ private GHRepository owner;
@JsonProperty("protected")
private boolean protection;
- private String protection_url;
+
+ private String protectionUrl;
/**
* Instantiates a new GH branch.
*
* @param name
* the name
- * @throws Exception
- * the exception
*/
@JsonCreator
- GHBranch(@JsonProperty(value = "name", required = true) String name) throws Exception {
+ GHBranch(@JsonProperty(value = "name", required = true) String name) {
Objects.requireNonNull(name);
this.name = name;
}
/**
- * The type Commit.
+ * Disables branch protection and allows anyone with push access to push changes.
+ *
+ * @throws IOException
+ * if disabling protection fails
*/
- public static class Commit {
-
- /** The sha. */
- String sha;
-
- /** The url. */
- @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
- String url;
+ public void disableProtection() throws IOException {
+ root().createRequest().method("DELETE").setRawUrlPath(protectionUrl).send();
}
/**
- * Gets owner.
+ * Enables branch protection to control what commit statuses are required to push.
*
- * @return the repository that this branch is in.
+ * @return GHBranchProtectionBuilder for enabling protection
+ * @see GHCommitStatus#getContext() GHCommitStatus#getContext()
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHRepository getOwner() {
- return owner;
+ public GHBranchProtectionBuilder enableProtection() {
+ return new GHBranchProtectionBuilder(this);
}
/**
@@ -78,23 +90,13 @@ public String getName() {
}
/**
- * Is protected boolean.
- *
- * @return true if the push to this branch is restricted via branch protection.
- */
- @Preview(Previews.LUKE_CAGE)
- public boolean isProtected() {
- return protection;
- }
-
- /**
- * Gets protection url.
+ * Gets owner.
*
- * @return API URL that deals with the protection of this branch.
+ * @return the repository that this branch is in.
*/
- @Preview(Previews.LUKE_CAGE)
- public URL getProtectionUrl() {
- return GitHubClient.parseURL(protection_url);
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getOwner() {
+ return owner;
}
/**
@@ -104,68 +106,35 @@ public URL getProtectionUrl() {
* @throws IOException
* the io exception
*/
- @Preview(Previews.LUKE_CAGE)
public GHBranchProtection getProtection() throws IOException {
- return root().createRequest()
- .withPreview(Previews.LUKE_CAGE)
- .setRawUrlPath(protection_url)
- .fetch(GHBranchProtection.class);
- }
-
- /**
- * Gets sha 1.
- *
- * @return The SHA1 of the commit that this branch currently points to.
- */
- public String getSHA1() {
- return commit.sha;
+ return root().createRequest().setRawUrlPath(protectionUrl).fetch(GHBranchProtection.class);
}
/**
- * Disables branch protection and allows anyone with push access to push changes.
+ * Gets protection url.
*
- * @throws IOException
- * if disabling protection fails
+ * @return API URL that deals with the protection of this branch.
*/
- public void disableProtection() throws IOException {
- root().createRequest().method("DELETE").setRawUrlPath(protection_url).send();
+ public URL getProtectionUrl() {
+ return GitHubClient.parseURL(protectionUrl);
}
/**
- * Enables branch protection to control what commit statuses are required to push.
+ * Gets sha 1.
*
- * @return GHBranchProtectionBuilder for enabling protection
- * @see GHCommitStatus#getContext() GHCommitStatus#getContext()
+ * @return The SHA1 of the commit that this branch currently points to.
*/
- @Preview(Previews.LUKE_CAGE)
- public GHBranchProtectionBuilder enableProtection() {
- return new GHBranchProtectionBuilder(this);
+ public String getSHA1() {
+ return commit.sha;
}
/**
- * Enable protection.
+ * Is protected boolean.
*
- * @param level
- * the level
- * @param contexts
- * the contexts
- * @throws IOException
- * the io exception
+ * @return true if the push to this branch is restricted via branch protection.
*/
- // backward compatibility with previous signature
- @Deprecated
- public void enableProtection(EnforcementLevel level, Collection contexts) throws IOException {
- switch (level) {
- case OFF :
- disableProtection();
- break;
- case NON_ADMINS :
- case EVERYONE :
- enableProtection().addRequiredChecks(contexts)
- .includeAdmins(level == EnforcementLevel.EVERYONE)
- .enable();
- break;
- }
+ public boolean isProtected() {
+ return protection;
}
/**
@@ -221,15 +190,6 @@ public GHCommit merge(String head, String commitMessage) throws IOException {
return result;
}
- /**
- * Gets the api route.
- *
- * @return the api route
- */
- String getApiRoute() {
- return owner.getApiTailUrl("/branches/" + name);
- }
-
/**
* To string.
*
@@ -241,6 +201,15 @@ public String toString() {
return "Branch:" + name + " in " + url;
}
+ /**
+ * Gets the api route.
+ *
+ * @return the api route
+ */
+ String getApiRoute() {
+ return owner.getApiTailUrl("/branches/" + name);
+ }
+
/**
* Wrap.
*
diff --git a/src/main/java/org/kohsuke/github/GHBranchProtection.java b/src/main/java/org/kohsuke/github/GHBranchProtection.java
index 834544944f..f5d661459c 100644
--- a/src/main/java/org/kohsuke/github/GHBranchProtection.java
+++ b/src/main/java/org/kohsuke/github/GHBranchProtection.java
@@ -1,5 +1,6 @@
package org.kohsuke.github;
+import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
@@ -7,8 +8,6 @@
import java.util.Collection;
import java.util.Collections;
-import static org.kohsuke.github.internal.Previews.ZZZAX;
-
// TODO: Auto-generated Javadoc
/**
* The type GHBranchProtection.
@@ -20,197 +19,21 @@
"URF_UNREAD_FIELD" },
justification = "JSON API")
public class GHBranchProtection extends GitHubInteractiveObject {
- private static final String REQUIRE_SIGNATURES_URI = "/required_signatures";
-
- @JsonProperty
- private AllowDeletions allowDeletions;
-
- @JsonProperty
- private AllowForcePushes allowForcePushes;
-
- @JsonProperty
- private AllowForkSyncing allowForkSyncing;
-
- @JsonProperty
- private BlockCreations blockCreations;
-
- @JsonProperty
- private EnforceAdmins enforceAdmins;
-
- @JsonProperty
- private LockBranch lockBranch;
-
- @JsonProperty
- private RequiredConversationResolution requiredConversationResolution;
-
- @JsonProperty
- private RequiredLinearHistory requiredLinearHistory;
-
- @JsonProperty("required_pull_request_reviews")
- private RequiredReviews requiredReviews;
-
- @JsonProperty
- private RequiredStatusChecks requiredStatusChecks;
-
- @JsonProperty
- private Restrictions restrictions;
-
- @JsonProperty
- private String url;
-
- /**
- * Enabled signed commits.
- *
- * @throws IOException
- * the io exception
- */
- @Preview(ZZZAX)
- public void enabledSignedCommits() throws IOException {
- requester().method("POST").withUrlPath(url + REQUIRE_SIGNATURES_URI).fetch(RequiredSignatures.class);
- }
-
- /**
- * Disable signed commits.
- *
- * @throws IOException
- * the io exception
- */
- @Preview(ZZZAX)
- public void disableSignedCommits() throws IOException {
- requester().method("DELETE").withUrlPath(url + REQUIRE_SIGNATURES_URI).send();
- }
-
- /**
- * Gets allow deletions.
- *
- * @return the enforce admins
- */
- public AllowDeletions getAllowDeletions() {
- return allowDeletions;
- }
-
- /**
- * Gets allow force pushes.
- *
- * @return the enforce admins
- */
- public AllowForcePushes getAllowForcePushes() {
- return allowForcePushes;
- }
-
- /**
- * Gets allow fork syncing.
- *
- * @return the enforce admins
- */
- public AllowForkSyncing getAllowForkSyncing() {
- return allowForkSyncing;
- }
-
- /**
- * Gets block creations.
- *
- * @return the enforce admins
- */
- public BlockCreations getBlockCreations() {
- return blockCreations;
- }
-
- /**
- * Gets enforce admins.
- *
- * @return the enforce admins
- */
- public EnforceAdmins getEnforceAdmins() {
- return enforceAdmins;
- }
-
- /**
- * Gets lock branch.
- *
- * @return the enforce admins
- */
- public LockBranch getLockBranch() {
- return lockBranch;
- }
-
- /**
- * Gets required conversation resolution.
- *
- * @return the enforce admins
- */
- public RequiredConversationResolution getRequiredConversationResolution() {
- return requiredConversationResolution;
- }
-
- /**
- * Gets required linear history.
- *
- * @return the enforce admins
- */
- public RequiredLinearHistory getRequiredLinearHistory() {
- return requiredLinearHistory;
- }
-
- /**
- * Gets required reviews.
- *
- * @return the required reviews
- */
- public RequiredReviews getRequiredReviews() {
- return requiredReviews;
- }
-
- /**
- * Gets required signatures.
- *
- * @return the required signatures
- * @throws IOException
- * the io exception
- */
- @Preview(ZZZAX)
- public boolean getRequiredSignatures() throws IOException {
- return requester().withUrlPath(url + REQUIRE_SIGNATURES_URI).fetch(RequiredSignatures.class).enabled;
- }
-
- /**
- * Gets required status checks.
- *
- * @return the required status checks
- */
- public RequiredStatusChecks getRequiredStatusChecks() {
- return requiredStatusChecks;
- }
-
- /**
- * Gets restrictions.
- *
- * @return the restrictions
- */
- public Restrictions getRestrictions() {
- return restrictions;
- }
-
- /**
- * Gets url.
- *
- * @return the url
- */
- public String getUrl() {
- return url;
- }
-
- private Requester requester() {
- return root().createRequest().withPreview(ZZZAX);
- }
/**
* The type AllowDeletions.
*/
public static class AllowDeletions {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default AllowDeletions instance
+ */
+ public AllowDeletions() {
+ }
+
/**
* Is enabled boolean.
*
@@ -225,9 +48,16 @@ public boolean isEnabled() {
* The type AllowForcePushes.
*/
public static class AllowForcePushes {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default AllowForcePushes instance
+ */
+ public AllowForcePushes() {
+ }
+
/**
* Is enabled boolean.
*
@@ -242,9 +72,16 @@ public boolean isEnabled() {
* The type AllowForkSyncing.
*/
public static class AllowForkSyncing {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default AllowForkSyncing instance
+ */
+ public AllowForkSyncing() {
+ }
+
/**
* Is enabled boolean.
*
@@ -259,9 +96,16 @@ public boolean isEnabled() {
* The type BlockCreations.
*/
public static class BlockCreations {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default BlockCreations instance
+ */
+ public BlockCreations() {
+ }
+
/**
* Is enabled boolean.
*
@@ -272,16 +116,72 @@ public boolean isEnabled() {
}
}
+ /**
+ * The type Check.
+ */
+ public static class Check {
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ private Integer appId;
+
+ private String context;
+
+ /**
+ * no-arg constructor for the serializer
+ */
+ public Check() {
+ }
+
+ /**
+ * Regular constructor for use in user business logic
+ *
+ * @param context
+ * the context string of the check
+ * @param appId
+ * the application ID the check is supposed to come from. Pass "-1" to explicitly allow any app to
+ * set the status. Pass "null" to automatically select the GitHub App that has recently provided this
+ * check.
+ */
+ public Check(String context, Integer appId) {
+ this.context = context;
+ this.appId = appId;
+ }
+
+ /**
+ * The application ID the check is supposed to come from. The value "-1" indicates "any source".
+ *
+ * @return the integer
+ */
+ public Integer getAppId() {
+ return appId;
+ }
+
+ /**
+ * The context string of the check
+ *
+ * @return the string
+ */
+ public String getContext() {
+ return context;
+ }
+ }
+
/**
* The type EnforceAdmins.
*/
public static class EnforceAdmins {
+
@JsonProperty
private boolean enabled;
@JsonProperty
private String url;
+ /**
+ * Create default EnforceAdmins instance
+ */
+ public EnforceAdmins() {
+ }
+
/**
* Gets url.
*
@@ -305,9 +205,16 @@ public boolean isEnabled() {
* The type LockBranch.
*/
public static class LockBranch {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default LockBranch instance
+ */
+ public LockBranch() {
+ }
+
/**
* Is enabled boolean.
*
@@ -322,9 +229,16 @@ public boolean isEnabled() {
* The type RequiredConversationResolution.
*/
public static class RequiredConversationResolution {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default RequiredConversationResolution instance
+ */
+ public RequiredConversationResolution() {
+ }
+
/**
* Is enabled boolean.
*
@@ -339,9 +253,16 @@ public boolean isEnabled() {
* The type RequiredLinearHistory.
*/
public static class RequiredLinearHistory {
+
@JsonProperty
private boolean enabled;
+ /**
+ * Create default RequiredLinearHistory instance
+ */
+ public RequiredLinearHistory() {
+ }
+
/**
* Is enabled boolean.
*
@@ -356,12 +277,13 @@ public boolean isEnabled() {
* The type RequiredReviews.
*/
public static class RequiredReviews {
- @JsonProperty("dismissal_restrictions")
- private Restrictions dismissalRestriction;
@JsonProperty
private boolean dismissStaleReviews;
+ @JsonProperty("dismissal_restrictions")
+ private Restrictions dismissalRestriction;
+
@JsonProperty
private boolean requireCodeOwnerReviews;
@@ -374,6 +296,12 @@ public static class RequiredReviews {
@JsonProperty
private String url;
+ /**
+ * Create default RequiredReviews instance
+ */
+ public RequiredReviews() {
+ }
+
/**
* Gets dismissal restrictions.
*
@@ -384,9 +312,18 @@ public Restrictions getDismissalRestrictions() {
}
/**
- * Gets url.
+ * Gets required reviewers.
*
- * @return the url
+ * @return the required reviewers
+ */
+ public int getRequiredReviewers() {
+ return requiredReviewers;
+ }
+
+ /**
+ * Gets url.
+ *
+ * @return the url
*/
public String getUrl() {
return url;
@@ -418,55 +355,39 @@ public boolean isRequireCodeOwnerReviews() {
public boolean isRequireLastPushApproval() {
return requireLastPushApproval;
}
-
- /**
- * Gets required reviewers.
- *
- * @return the required reviewers
- */
- public int getRequiredReviewers() {
- return requiredReviewers;
- }
}
- private static class RequiredSignatures {
+ /**
+ * The type RequiredStatusChecks.
+ */
+ public static class RequiredStatusChecks {
+
@JsonProperty
- private boolean enabled;
+ private Collection checks;
+
+ @JsonProperty
+ private Collection contexts;
+
+ @JsonProperty
+ private boolean strict;
@JsonProperty
private String url;
/**
- * Gets url.
- *
- * @return the url
+ * Create default RequiredStatusChecks instance
*/
- public String getUrl() {
- return url;
+ public RequiredStatusChecks() {
}
/**
- * Is enabled boolean.
+ * Gets checks.
*
- * @return the boolean
+ * @return the checks
*/
- public boolean isEnabled() {
- return enabled;
+ public Collection getChecks() {
+ return Collections.unmodifiableCollection(checks);
}
- }
-
- /**
- * The type RequiredStatusChecks.
- */
- public static class RequiredStatusChecks {
- @JsonProperty
- private Collection contexts;
-
- @JsonProperty
- private boolean strict;
-
- @JsonProperty
- private String url;
/**
* Gets contexts.
@@ -500,6 +421,7 @@ public boolean isRequiresBranchUpToDate() {
* The type Restrictions.
*/
public static class Restrictions {
+
@JsonProperty
private Collection teams;
@@ -513,6 +435,12 @@ public static class Restrictions {
private String usersUrl;
+ /**
+ * Create default Restrictions instance
+ */
+ public Restrictions() {
+ }
+
/**
* Gets teams.
*
@@ -558,4 +486,217 @@ public String getUsersUrl() {
return usersUrl;
}
}
+
+ private static class RequiredSignatures {
+ @JsonProperty
+ private boolean enabled;
+
+ @JsonProperty
+ private String url;
+
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public String getUrl() {
+ return url;
+ }
+
+ /**
+ * Is enabled boolean.
+ *
+ * @return the boolean
+ */
+ public boolean isEnabled() {
+ return enabled;
+ }
+ }
+
+ private static final String REQUIRE_SIGNATURES_URI = "/required_signatures";
+
+ @JsonProperty
+ private AllowDeletions allowDeletions;
+
+ @JsonProperty
+ private AllowForcePushes allowForcePushes;
+
+ @JsonProperty
+ private AllowForkSyncing allowForkSyncing;
+
+ @JsonProperty
+ private BlockCreations blockCreations;
+
+ @JsonProperty
+ private EnforceAdmins enforceAdmins;
+
+ @JsonProperty
+ private LockBranch lockBranch;
+
+ @JsonProperty
+ private RequiredConversationResolution requiredConversationResolution;
+
+ @JsonProperty
+ private RequiredLinearHistory requiredLinearHistory;
+
+ @JsonProperty("required_pull_request_reviews")
+ private RequiredReviews requiredReviews;
+
+ @JsonProperty
+ private RequiredStatusChecks requiredStatusChecks;
+
+ @JsonProperty
+ private Restrictions restrictions;
+
+ @JsonProperty
+ private String url;
+
+ /**
+ * Create default GHBranchProtection instance
+ */
+ public GHBranchProtection() {
+ }
+
+ /**
+ * Disable signed commits.
+ *
+ * @throws IOException
+ * the io exception
+ */
+ public void disableSignedCommits() throws IOException {
+ requester().method("DELETE").withUrlPath(url + REQUIRE_SIGNATURES_URI).send();
+ }
+
+ /**
+ * Enabled signed commits.
+ *
+ * @throws IOException
+ * the io exception
+ */
+ public void enabledSignedCommits() throws IOException {
+ requester().method("POST").withUrlPath(url + REQUIRE_SIGNATURES_URI).fetch(RequiredSignatures.class);
+ }
+
+ /**
+ * Gets allow deletions.
+ *
+ * @return the enforce admins
+ */
+ public AllowDeletions getAllowDeletions() {
+ return allowDeletions;
+ }
+
+ /**
+ * Gets allow force pushes.
+ *
+ * @return the enforce admins
+ */
+ public AllowForcePushes getAllowForcePushes() {
+ return allowForcePushes;
+ }
+
+ /**
+ * Gets allow fork syncing.
+ *
+ * @return the enforce admins
+ */
+ public AllowForkSyncing getAllowForkSyncing() {
+ return allowForkSyncing;
+ }
+
+ /**
+ * Gets block creations.
+ *
+ * @return the enforce admins
+ */
+ public BlockCreations getBlockCreations() {
+ return blockCreations;
+ }
+
+ /**
+ * Gets enforce admins.
+ *
+ * @return the enforce admins
+ */
+ public EnforceAdmins getEnforceAdmins() {
+ return enforceAdmins;
+ }
+
+ /**
+ * Gets lock branch.
+ *
+ * @return the enforce admins
+ */
+ public LockBranch getLockBranch() {
+ return lockBranch;
+ }
+
+ /**
+ * Gets required conversation resolution.
+ *
+ * @return the enforce admins
+ */
+ public RequiredConversationResolution getRequiredConversationResolution() {
+ return requiredConversationResolution;
+ }
+
+ /**
+ * Gets required linear history.
+ *
+ * @return the enforce admins
+ */
+ public RequiredLinearHistory getRequiredLinearHistory() {
+ return requiredLinearHistory;
+ }
+
+ /**
+ * Gets required reviews.
+ *
+ * @return the required reviews
+ */
+ public RequiredReviews getRequiredReviews() {
+ return requiredReviews;
+ }
+
+ /**
+ * Gets required signatures.
+ *
+ * @return the required signatures
+ * @throws IOException
+ * the io exception
+ */
+ public boolean getRequiredSignatures() throws IOException {
+ return requester().withUrlPath(url + REQUIRE_SIGNATURES_URI).fetch(RequiredSignatures.class).enabled;
+ }
+
+ /**
+ * Gets required status checks.
+ *
+ * @return the required status checks
+ */
+ public RequiredStatusChecks getRequiredStatusChecks() {
+ return requiredStatusChecks;
+ }
+
+ /**
+ * Gets restrictions.
+ *
+ * @return the restrictions
+ */
+ public Restrictions getRestrictions() {
+ return restrictions;
+ }
+
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public String getUrl() {
+ return url;
+ }
+
+ private Requester requester() {
+ return root().createRequest();
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java b/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java
index ec21b3168c..5b1521d9f1 100644
--- a/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java
@@ -12,8 +12,6 @@
import java.util.Map;
import java.util.Set;
-import static org.kohsuke.github.internal.Previews.LUKE_CAGE;
-
// TODO: Auto-generated Javadoc
/**
* Builder to configure the branch protection settings.
@@ -25,11 +23,21 @@
"URF_UNREAD_FIELD" },
justification = "JSON API")
public class GHBranchProtectionBuilder {
- private final GHBranch branch;
+ private static class Restrictions {
+ private Set teams = new HashSet();
+ private Set users = new HashSet();
+ }
+ private static class StatusChecks {
+ final List checks = new ArrayList<>();
+ boolean strict;
+ }
+ private final GHBranch branch;
private Map fields = new HashMap();
private Map prReviews;
+
private Restrictions restrictions;
+
private StatusChecks statusChecks;
/**
@@ -50,8 +58,8 @@ public class GHBranchProtectionBuilder {
* the checks
* @return the gh branch protection builder
*/
- public GHBranchProtectionBuilder addRequiredChecks(Collection checks) {
- getStatusChecks().contexts.addAll(checks);
+ public GHBranchProtectionBuilder addRequiredChecks(GHBranchProtection.Check... checks) {
+ addRequiredStatusChecks(Arrays.asList(checks));
return this;
}
@@ -62,8 +70,8 @@ public GHBranchProtectionBuilder addRequiredChecks(Collection checks) {
* the checks
* @return the gh branch protection builder
*/
- public GHBranchProtectionBuilder addRequiredChecks(String... checks) {
- addRequiredChecks(Arrays.asList(checks));
+ public GHBranchProtectionBuilder addRequiredStatusChecks(Collection checks) {
+ getStatusChecks().checks.addAll(checks);
return this;
}
@@ -237,18 +245,6 @@ public GHBranchProtectionBuilder lockBranch(boolean v) {
return this;
}
- /**
- * Required reviewers gh branch protection builder.
- *
- * @param v
- * the v
- * @return the gh branch protection builder
- */
- public GHBranchProtectionBuilder requiredReviewers(int v) {
- getPrReviews().put("required_approving_review_count", v);
- return this;
- }
-
/**
* Require branch is up to date gh branch protection builder.
*
@@ -312,6 +308,16 @@ public GHBranchProtectionBuilder requireLastPushApproval(boolean v) {
return this;
}
+ /**
+ * Require reviews gh branch protection builder.
+ *
+ * @return the gh branch protection builder
+ */
+ public GHBranchProtectionBuilder requireReviews() {
+ getPrReviews();
+ return this;
+ }
+
/**
* Require all conversations on code to be resolved before a pull request can be merged into a branch that matches
* this rule.
@@ -359,12 +365,24 @@ public GHBranchProtectionBuilder requiredLinearHistory(boolean v) {
}
/**
- * Require reviews gh branch protection builder.
+ * Required reviewers gh branch protection builder.
*
+ * @param v
+ * the v
* @return the gh branch protection builder
*/
- public GHBranchProtectionBuilder requireReviews() {
- getPrReviews();
+ public GHBranchProtectionBuilder requiredReviewers(int v) {
+ getPrReviews().put("required_approving_review_count", v);
+ return this;
+ }
+
+ /**
+ * Restrict push access gh branch protection builder.
+ *
+ * @return the gh branch protection builder
+ */
+ public GHBranchProtectionBuilder restrictPushAccess() {
+ getRestrictions();
return this;
}
@@ -383,16 +401,6 @@ public GHBranchProtectionBuilder restrictReviewDismissals() {
return this;
}
- /**
- * Restrict push access gh branch protection builder.
- *
- * @return the gh branch protection builder
- */
- public GHBranchProtectionBuilder restrictPushAccess() {
- getRestrictions();
- return this;
- }
-
/**
* Team push access gh branch protection builder.
*
@@ -538,16 +546,6 @@ private StatusChecks getStatusChecks() {
}
private Requester requester() {
- return branch.root().createRequest().withPreview(LUKE_CAGE);
- }
-
- private static class Restrictions {
- private Set teams = new HashSet();
- private Set users = new HashSet();
- }
-
- private static class StatusChecks {
- final List contexts = new ArrayList();
- boolean strict;
+ return branch.root().createRequest();
}
}
diff --git a/src/main/java/org/kohsuke/github/GHBranchSync.java b/src/main/java/org/kohsuke/github/GHBranchSync.java
new file mode 100644
index 0000000000..47b1a34158
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHBranchSync.java
@@ -0,0 +1,96 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+/**
+ * The type Gh branch sync.
+ */
+public class GHBranchSync extends GitHubInteractiveObject {
+
+ /**
+ * The base branch.
+ */
+ private String baseBranch;
+
+ /**
+ * The merge type.
+ */
+ private String mergeType;
+
+ /**
+ * The message.
+ */
+ private String message;
+
+ /**
+ * The Repository that this branch is in.
+ */
+ private GHRepository owner;
+
+ /**
+ * Create default GHBranchSync instance
+ */
+ public GHBranchSync() {
+ }
+
+ /**
+ * Gets base branch.
+ *
+ * @return the base branch
+ */
+ public String getBaseBranch() {
+ return baseBranch;
+ }
+
+ /**
+ * Gets merge type.
+ *
+ * @return the merge type
+ */
+ public String getMergeType() {
+ return mergeType;
+ }
+
+ /**
+ * Gets message.
+ *
+ * @return the message
+ */
+ public String getMessage() {
+ return message;
+ }
+
+ /**
+ * Gets owner.
+ *
+ * @return the repository that this branch is in.
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getOwner() {
+ return owner;
+ }
+
+ /**
+ * To string.
+ *
+ * @return the string
+ */
+ @Override
+ public String toString() {
+ return "GHBranchSync{" + "message='" + message + '\'' + ", mergeType='" + mergeType + '\'' + ", baseBranch='"
+ + baseBranch + '\'' + '}';
+ }
+
+ /**
+ * Wrap.
+ *
+ * @param repo
+ * the repo
+ * @return the GH branch sync
+ */
+ GHBranchSync wrap(GHRepository repo) {
+ this.owner = repo;
+ return this;
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHCheckRun.java b/src/main/java/org/kohsuke/github/GHCheckRun.java
index 0203bc8a85..2c776af8d7 100644
--- a/src/main/java/org/kohsuke/github/GHCheckRun.java
+++ b/src/main/java/org/kohsuke/github/GHCheckRun.java
@@ -5,10 +5,10 @@
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.kohsuke.github.internal.EnumUtils;
-import org.kohsuke.github.internal.Previews;
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
@@ -25,89 +25,43 @@
justification = "JSON API")
public class GHCheckRun extends GHObject {
- /** The owner. */
- @JsonProperty("repository")
- GHRepository owner;
-
- private String status;
- private String conclusion;
- private String name;
- private String headSha;
- private String nodeId;
- private String externalId;
- private String startedAt;
- private String completedAt;
- private String htmlUrl;
- private String detailsUrl;
- private Output output;
- private GHApp app;
- private GHPullRequest[] pullRequests = new GHPullRequest[0];
- private GHCheckSuite checkSuite;
-
/**
- * Wrap.
- *
- * @param owner
- * the owner
- * @return the GH check run
- */
- GHCheckRun wrap(GHRepository owner) {
- this.owner = owner;
- wrap(owner.root());
- return this;
- }
-
- /**
- * Wrap.
- *
- * @param root
- * the root
- * @return the GH check run
+ * The Enum AnnotationLevel.
*/
- GHCheckRun wrap(GitHub root) {
- if (owner != null) {
- for (GHPullRequest singlePull : pullRequests) {
- singlePull.wrap(owner);
- }
- }
- if (checkSuite != null) {
- if (owner != null) {
- checkSuite.wrap(owner);
- } else {
- checkSuite.wrap(root);
- }
- }
+ public static enum AnnotationLevel {
- return this;
+ /** The failure. */
+ FAILURE,
+ /** The notice. */
+ NOTICE,
+ /** The warning. */
+ WARNING
}
/**
- * Gets status of the check run.
+ * Final conclusion of the check.
*
- * @return Status of the check run
- * @see Status
- */
- @WithBridgeMethods(value = String.class, adapterMethod = "statusAsStr")
- public Status getStatus() {
- return Status.from(status);
- }
-
- @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", justification = "Bridge method of getStatus")
- private Object statusAsStr(Status status, Class type) {
- return status;
- }
-
- /**
- * The Enum Status.
+ * From Check Run
+ * Parameters - conclusion.
*/
- public static enum Status {
+ public static enum Conclusion {
- /** The queued. */
- QUEUED,
- /** The in progress. */
- IN_PROGRESS,
- /** The completed. */
- COMPLETED,
+ /** The action required. */
+ ACTION_REQUIRED,
+ /** The cancelled. */
+ CANCELLED,
+ /** The failure. */
+ FAILURE,
+ /** The neutral. */
+ NEUTRAL,
+ /** The skipped. */
+ SKIPPED,
+ /** The stale. */
+ STALE,
+ /** The success. */
+ SUCCESS,
+ /** The timed out. */
+ TIMED_OUT,
/** The unknown. */
UNKNOWN;
@@ -116,10 +70,10 @@ public static enum Status {
*
* @param value
* the value
- * @return the status
+ * @return the conclusion
*/
- public static Status from(String value) {
- return EnumUtils.getNullableEnumOrDefault(Status.class, value, Status.UNKNOWN);
+ public static Conclusion from(String value) {
+ return EnumUtils.getNullableEnumOrDefault(Conclusion.class, value, Conclusion.UNKNOWN);
}
/**
@@ -134,45 +88,80 @@ public String toString() {
}
/**
- * Gets conclusion of a completed check run.
+ * Represents an output in a check run to include summary and other results.
*
- * @return Status of the check run
- * @see Conclusion
+ * @see documentation
*/
- @WithBridgeMethods(value = String.class, adapterMethod = "conclusionAsStr")
- public Conclusion getConclusion() {
- return Conclusion.from(conclusion);
- }
+ public static class Output {
- @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", justification = "Bridge method of getConclusion")
- private Object conclusionAsStr(Conclusion conclusion, Class type) {
- return conclusion;
- }
+ private int annotationsCount;
+
+ private String annotationsUrl;
+ private String summary;
+ private String text;
+ private String title;
+ /**
+ * Create default Output instance
+ */
+ public Output() {
+ }
+
+ /**
+ * Gets the annotation count of a check run.
+ *
+ * @return annotation count of a check run
+ */
+ public int getAnnotationsCount() {
+ return annotationsCount;
+ }
+ /**
+ * Gets the URL of annotations.
+ *
+ * @return URL of annotations
+ */
+ public URL getAnnotationsUrl() {
+ return GitHubClient.parseURL(annotationsUrl);
+ }
+
+ /**
+ * Gets the summary of the check run, note that it supports Markdown.
+ *
+ * @return summary of check run
+ */
+ public String getSummary() {
+ return summary;
+ }
+
+ /**
+ * Gets the details of the check run, note that it supports Markdown.
+ *
+ * @return Details of the check run
+ */
+ public String getText() {
+ return text;
+ }
+
+ /**
+ * Gets the title of check run.
+ *
+ * @return title of check run
+ */
+ public String getTitle() {
+ return title;
+ }
+ }
/**
- * Final conclusion of the check.
- *
- * From Check Run
- * Parameters - conclusion.
+ * The Enum Status.
*/
- public static enum Conclusion {
+ public static enum Status {
- /** The action required. */
- ACTION_REQUIRED,
- /** The cancelled. */
- CANCELLED,
- /** The failure. */
- FAILURE,
- /** The neutral. */
- NEUTRAL,
- /** The success. */
- SUCCESS,
- /** The skipped. */
- SKIPPED,
- /** The stale. */
- STALE,
- /** The timed out. */
- TIMED_OUT,
+ /** The completed. */
+ COMPLETED,
+ /** The in progress. */
+ IN_PROGRESS,
+ /** The queued. */
+ QUEUED,
/** The unknown. */
UNKNOWN;
@@ -181,10 +170,10 @@ public static enum Conclusion {
*
* @param value
* the value
- * @return the conclusion
+ * @return the status
*/
- public static Conclusion from(String value) {
- return EnumUtils.getNullableEnumOrDefault(Conclusion.class, value, Conclusion.UNKNOWN);
+ public static Status from(String value) {
+ return EnumUtils.getNullableEnumOrDefault(Status.class, value, Status.UNKNOWN);
}
/**
@@ -197,71 +186,71 @@ public String toString() {
return name().toLowerCase(Locale.ROOT);
}
}
+ private GHApp app;
+ private GHCheckSuite checkSuite;
+ private String completedAt;
+ private String conclusion;
+ private String detailsUrl;
+ private String externalId;
+ private String headSha;
+ private String htmlUrl;
+ private String name;
+ private String nodeId;
+ private Output output;
+ private GHPullRequest[] pullRequests = new GHPullRequest[0];
- /**
- * Gets the custom name of this check run.
- *
- * @return Name of the check run
- */
- public String getName() {
- return name;
- }
+ private String startedAt;
+
+ private String status;
+
+ /** The owner. */
+ @JsonProperty("repository")
+ GHRepository owner;
/**
- * Gets the HEAD SHA.
- *
- * @return sha for the HEAD commit
+ * Create default GHCheckRun instance
*/
- public String getHeadSha() {
- return headSha;
+ public GHCheckRun() {
}
/**
- * Gets the pull requests participated in this check run.
- *
- * Note this field is only populated for events. When getting a {@link GHCheckRun} outside of an event, this is
- * always empty.
+ * Gets the GitHub app this check run belongs to, included in response.
*
- * @return the list of {@link GHPullRequest}s for this check run. Only populated for events.
- * @throws IOException
- * the io exception
+ * @return GitHub App
*/
- public List getPullRequests() throws IOException {
- for (GHPullRequest singlePull : pullRequests) {
- // Only refresh if we haven't do so before
- singlePull.refresh(singlePull.getTitle());
- }
- return Collections.unmodifiableList(Arrays.asList(pullRequests));
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHApp getApp() {
+ return app;
}
/**
- * Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of
- * the check run.
+ * Gets the check suite this check run belongs to.
*
- * @return HTML URL
+ * @return Check suite
*/
- @Override
- public URL getHtmlUrl() {
- return GitHubClient.parseURL(htmlUrl);
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHCheckSuite getCheckSuite() {
+ return checkSuite;
}
/**
- * Gets the global node id to access most objects in GitHub.
+ * Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
*
- * @return Global node id
- * @see documentation
+ * @return Timestamp of the completed time
*/
- public String getNodeId() {
- return nodeId;
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getCompletedAt() {
+ return GitHubClient.parseInstant(completedAt);
}
/**
- * Gets a reference for the check run on the integrator's system.
+ * Gets conclusion of a completed check run.
*
- * @return Reference id
+ * @return Status of the check run
+ * @see Conclusion
*/
- public String getExternalId() {
- return externalId;
+ public Conclusion getConclusion() {
+ return Conclusion.from(conclusion);
}
/**
@@ -274,41 +263,50 @@ public URL getDetailsUrl() {
}
/**
- * Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+ * Gets a reference for the check run on the integrator's system.
*
- * @return Timestamp of the start time
+ * @return Reference id
*/
- public Date getStartedAt() {
- return GitHubClient.parseDate(startedAt);
+ public String getExternalId() {
+ return externalId;
}
/**
- * Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+ * Gets the HEAD SHA.
*
- * @return Timestamp of the completed time
+ * @return sha for the HEAD commit
*/
- public Date getCompletedAt() {
- return GitHubClient.parseDate(completedAt);
+ public String getHeadSha() {
+ return headSha;
}
/**
- * Gets the GitHub app this check run belongs to, included in response.
+ * Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of
+ * the check run.
*
- * @return GitHub App
+ * @return HTML URL
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHApp getApp() {
- return app;
+ public URL getHtmlUrl() {
+ return GitHubClient.parseURL(htmlUrl);
}
/**
- * Gets the check suite this check run belongs to.
+ * Gets the custom name of this check run.
*
- * @return Check suite
+ * @return Name of the check run
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHCheckSuite getCheckSuite() {
- return checkSuite;
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Gets the global node id to access most objects in GitHub.
+ *
+ * @return Global node id
+ * @see documentation
+ */
+ public String getNodeId() {
+ return nodeId;
}
/**
@@ -322,74 +320,41 @@ public Output getOutput() {
}
/**
- * Represents an output in a check run to include summary and other results.
+ * Gets the pull requests participated in this check run.
*
- * @see documentation
+ * Note this field is only populated for events. When getting a {@link GHCheckRun} outside of an event, this is
+ * always empty.
+ *
+ * @return the list of {@link GHPullRequest}s for this check run. Only populated for events.
+ * @throws IOException
+ * the io exception
*/
- public static class Output {
- private String title;
- private String summary;
- private String text;
- private int annotationsCount;
- private String annotationsUrl;
-
- /**
- * Gets the title of check run.
- *
- * @return title of check run
- */
- public String getTitle() {
- return title;
- }
-
- /**
- * Gets the summary of the check run, note that it supports Markdown.
- *
- * @return summary of check run
- */
- public String getSummary() {
- return summary;
- }
-
- /**
- * Gets the details of the check run, note that it supports Markdown.
- *
- * @return Details of the check run
- */
- public String getText() {
- return text;
- }
-
- /**
- * Gets the annotation count of a check run.
- *
- * @return annotation count of a check run
- */
- public int getAnnotationsCount() {
- return annotationsCount;
- }
-
- /**
- * Gets the URL of annotations.
- *
- * @return URL of annotations
- */
- public URL getAnnotationsUrl() {
- return GitHubClient.parseURL(annotationsUrl);
+ public List getPullRequests() throws IOException {
+ for (GHPullRequest singlePull : pullRequests) {
+ // Only refresh if we haven't do so before
+ singlePull.refresh(singlePull.getTitle());
}
+ return Collections.unmodifiableList(Arrays.asList(pullRequests));
}
/**
- * The Enum AnnotationLevel.
+ * Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+ *
+ * @return Timestamp of the start time
*/
- public static enum AnnotationLevel {
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getStartedAt() {
+ return GitHubClient.parseInstant(startedAt);
+ }
- /** The notice. */
- NOTICE,
- /** The warning. */
- WARNING,
- /** The failure. */
- FAILURE
+ /**
+ * Gets status of the check run.
+ *
+ * @return Status of the check run
+ * @see Status
+ */
+ public Status getStatus() {
+ return Status.from(status);
}
/**
@@ -397,9 +362,45 @@ public static enum AnnotationLevel {
*
* @return a builder which you should customize, then call {@link GHCheckRunBuilder#create}
*/
- @Preview(Previews.ANTIOPE)
public @NonNull GHCheckRunBuilder update() {
return new GHCheckRunBuilder(owner, getId());
}
+ /**
+ * Wrap.
+ *
+ * @param owner
+ * the owner
+ * @return the GH check run
+ */
+ GHCheckRun wrap(GHRepository owner) {
+ this.owner = owner;
+ wrap(owner.root());
+ return this;
+ }
+
+ /**
+ * Wrap.
+ *
+ * @param root
+ * the root
+ * @return the GH check run
+ */
+ GHCheckRun wrap(GitHub root) {
+ if (owner != null) {
+ for (GHPullRequest singlePull : pullRequests) {
+ singlePull.wrap(owner);
+ }
+ }
+ if (checkSuite != null) {
+ if (owner != null) {
+ checkSuite.wrap(owner);
+ } else {
+ checkSuite.wrap(root);
+ }
+ }
+
+ return this;
+ }
+
}
diff --git a/src/main/java/org/kohsuke/github/GHCheckRunBuilder.java b/src/main/java/org/kohsuke/github/GHCheckRunBuilder.java
index b1ddcaf284..0dcff092ba 100644
--- a/src/main/java/org/kohsuke/github/GHCheckRunBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHCheckRunBuilder.java
@@ -28,9 +28,9 @@
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import org.kohsuke.github.internal.Previews;
import java.io.IOException;
+import java.time.Instant;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedList;
@@ -48,16 +48,270 @@
* @see documentation
*/
@SuppressFBWarnings(value = "URF_UNREAD_FIELD", justification = "Jackson serializes these even without a getter")
-@Preview(Previews.ANTIOPE)
public final class GHCheckRunBuilder {
+ /**
+ * The Class Action.
+ *
+ * @see documentation
+ */
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ public static final class Action {
+
+ private final String description;
+ private final String identifier;
+ private final String label;
+
+ /**
+ * Instantiates a new action.
+ *
+ * @param label
+ * the label
+ * @param description
+ * the description
+ * @param identifier
+ * the identifier
+ */
+ public Action(@NonNull String label, @NonNull String description, @NonNull String identifier) {
+ this.label = label;
+ this.description = description;
+ this.identifier = identifier;
+ }
+
+ }
+
+ /**
+ * The Class Annotation.
+ *
+ * @see documentation
+ */
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ public static final class Annotation {
+
+ private final String annotationLevel;
+ private Integer endColumn;
+ private final int endLine;
+ private final String message;
+ private final String path;
+ private String rawDetails;
+ private Integer startColumn;
+ private final int startLine;
+ private String title;
+
+ /**
+ * Instantiates a new annotation.
+ *
+ * @param path
+ * the path
+ * @param line
+ * the line
+ * @param annotationLevel
+ * the annotation level
+ * @param message
+ * the message
+ */
+ public Annotation(@NonNull String path,
+ int line,
+ @NonNull GHCheckRun.AnnotationLevel annotationLevel,
+ @NonNull String message) {
+ this(path, line, line, annotationLevel, message);
+ }
+
+ /**
+ * Instantiates a new annotation.
+ *
+ * @param path
+ * the path
+ * @param startLine
+ * the start line
+ * @param endLine
+ * the end line
+ * @param annotationLevel
+ * the annotation level
+ * @param message
+ * the message
+ */
+ public Annotation(@NonNull String path,
+ int startLine,
+ int endLine,
+ @NonNull GHCheckRun.AnnotationLevel annotationLevel,
+ @NonNull String message) {
+ this.path = path;
+ this.startLine = startLine;
+ this.endLine = endLine;
+ this.annotationLevel = annotationLevel.toString().toLowerCase(Locale.ROOT);
+ this.message = message;
+ }
+
+ /**
+ * With end column.
+ *
+ * @param endColumn
+ * the end column
+ * @return the annotation
+ */
+ public @NonNull Annotation withEndColumn(@CheckForNull Integer endColumn) {
+ this.endColumn = endColumn;
+ return this;
+ }
+
+ /**
+ * With raw details.
+ *
+ * @param rawDetails
+ * the raw details
+ * @return the annotation
+ */
+ public @NonNull Annotation withRawDetails(@CheckForNull String rawDetails) {
+ this.rawDetails = rawDetails;
+ return this;
+ }
+
+ /**
+ * With start column.
+ *
+ * @param startColumn
+ * the start column
+ * @return the annotation
+ */
+ public @NonNull Annotation withStartColumn(@CheckForNull Integer startColumn) {
+ this.startColumn = startColumn;
+ return this;
+ }
+
+ /**
+ * With title.
+ *
+ * @param title
+ * the title
+ * @return the annotation
+ */
+ public @NonNull Annotation withTitle(@CheckForNull String title) {
+ this.title = title;
+ return this;
+ }
+
+ }
+ /**
+ * The Class Image.
+ *
+ * @see documentation
+ */
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ public static final class Image {
+
+ private final String alt;
+ private String caption;
+ private final String imageUrl;
+
+ /**
+ * Instantiates a new image.
+ *
+ * @param alt
+ * the alt
+ * @param imageURL
+ * the image URL
+ */
+ public Image(@NonNull String alt, @NonNull String imageURL) {
+ this.alt = alt;
+ this.imageUrl = imageURL;
+ }
+
+ /**
+ * With caption.
+ *
+ * @param caption
+ * the caption
+ * @return the image
+ */
+ public @NonNull Image withCaption(@CheckForNull String caption) {
+ this.caption = caption;
+ return this;
+ }
+
+ }
+ /**
+ * The Class Output.
+ *
+ * @see documentation
+ */
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ public static final class Output {
+
+ private List annotations;
+ private List images;
+ private final String summary;
+ private String text;
+ private final String title;
+
+ /**
+ * Instantiates a new output.
+ *
+ * @param title
+ * the title
+ * @param summary
+ * the summary
+ */
+ public Output(@NonNull String title, @NonNull String summary) {
+ this.title = title;
+ this.summary = summary;
+ }
+
+ /**
+ * Adds the.
+ *
+ * @param annotation
+ * the annotation
+ * @return the output
+ */
+ public @NonNull Output add(@NonNull Annotation annotation) {
+ if (annotations == null) {
+ annotations = new LinkedList<>();
+ }
+ annotations.add(annotation);
+ return this;
+ }
+
+ /**
+ * Adds the.
+ *
+ * @param image
+ * the image
+ * @return the output
+ */
+ public @NonNull Output add(@NonNull Image image) {
+ if (images == null) {
+ images = new LinkedList<>();
+ }
+ images.add(image);
+ return this;
+ }
+
+ /**
+ * With text.
+ *
+ * @param text
+ * the text
+ * @return the output
+ */
+ public @NonNull Output withText(@CheckForNull String text) {
+ this.text = text;
+ return this;
+ }
+
+ }
+
+ private static final int MAX_ANNOTATIONS = 50;
+
+ private List actions;
+
+ private Output output;
+
/** The repo. */
protected final GHRepository repo;
/** The requester. */
protected final Requester requester;
- private Output output;
- private List actions;
private GHCheckRunBuilder(GHRepository repo, Requester requester) {
this.repo = repo;
@@ -78,7 +332,6 @@ private GHCheckRunBuilder(GHRepository repo, Requester requester) {
this(repo,
repo.root()
.createRequest()
- .withPreview(Previews.ANTIOPE)
.method("POST")
.with("name", name)
.with("head_sha", headSHA)
@@ -95,108 +348,21 @@ private GHCheckRunBuilder(GHRepository repo, Requester requester) {
*/
GHCheckRunBuilder(GHRepository repo, long checkId) {
this(repo,
- repo.root()
- .createRequest()
- .withPreview(Previews.ANTIOPE)
- .method("PATCH")
- .withUrlPath(repo.getApiTailUrl("check-runs/" + checkId)));
+ repo.root().createRequest().method("PATCH").withUrlPath(repo.getApiTailUrl("check-runs/" + checkId)));
}
/**
- * With name.
+ * Adds the.
*
- * @param name
- * the name
- * @param oldName
- * the old name
+ * @param action
+ * the action
* @return the GH check run builder
*/
- public @NonNull GHCheckRunBuilder withName(@CheckForNull String name, String oldName) {
- if (oldName == null) {
- throw new GHException("Can not update uncreated check run");
- }
- requester.with("name", name);
- return this;
- }
-
- /**
- * With details URL.
- *
- * @param detailsURL
- * the details URL
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder withDetailsURL(@CheckForNull String detailsURL) {
- requester.with("details_url", detailsURL);
- return this;
- }
-
- /**
- * With external ID.
- *
- * @param externalID
- * the external ID
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder withExternalID(@CheckForNull String externalID) {
- requester.with("external_id", externalID);
- return this;
- }
-
- /**
- * With status.
- *
- * @param status
- * the status
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder withStatus(@CheckForNull GHCheckRun.Status status) {
- if (status != null) {
- // Do *not* use the overload taking Enum, as that s/_/-/g which would be wrong here.
- requester.with("status", status.toString().toLowerCase(Locale.ROOT));
- }
- return this;
- }
-
- /**
- * With conclusion.
- *
- * @param conclusion
- * the conclusion
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder withConclusion(@CheckForNull GHCheckRun.Conclusion conclusion) {
- if (conclusion != null) {
- requester.with("conclusion", conclusion.toString().toLowerCase(Locale.ROOT));
- }
- return this;
- }
-
- /**
- * With started at.
- *
- * @param startedAt
- * the started at
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder withStartedAt(@CheckForNull Date startedAt) {
- if (startedAt != null) {
- requester.with("started_at", GitHubClient.printDate(startedAt));
- }
- return this;
- }
-
- /**
- * With completed at.
- *
- * @param completedAt
- * the completed at
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder withCompletedAt(@CheckForNull Date completedAt) {
- if (completedAt != null) {
- requester.with("completed_at", GitHubClient.printDate(completedAt));
+ public @NonNull GHCheckRunBuilder add(@NonNull Action action) {
+ if (actions == null) {
+ actions = new LinkedList<>();
}
+ actions.add(action);
return this;
}
@@ -215,22 +381,6 @@ private GHCheckRunBuilder(GHRepository repo, Requester requester) {
return this;
}
- /**
- * Adds the.
- *
- * @param action
- * the action
- * @return the GH check run builder
- */
- public @NonNull GHCheckRunBuilder add(@NonNull Action action) {
- if (actions == null) {
- actions = new LinkedList<>();
- }
- actions.add(action);
- return this;
- }
-
- private static final int MAX_ANNOTATIONS = 50;
/**
* Actually creates the check run. (If more than fifty annotations were requested, this is done in batches.)
*
@@ -254,7 +404,6 @@ private GHCheckRunBuilder(GHRepository repo, Requester requester) {
extraAnnotations = extraAnnotations.subList(i, extraAnnotations.size());
run = repo.root()
.createRequest()
- .withPreview(Previews.ANTIOPE)
.method("PATCH")
.with("output", output2)
.withUrlPath(repo.getApiTailUrl("check-runs/" + run.getId()))
@@ -265,256 +414,126 @@ private GHCheckRunBuilder(GHRepository repo, Requester requester) {
}
/**
- * The Class Output.
+ * With completed at.
*
- * @see documentation
+ * @param completedAt
+ * the completed at
+ * @return the GH check run builder
+ * @deprecated Use {@link #withCompletedAt(Instant)}
*/
- @JsonInclude(JsonInclude.Include.NON_NULL)
- public static final class Output {
-
- private final String title;
- private final String summary;
- private String text;
- private List annotations;
- private List images;
-
- /**
- * Instantiates a new output.
- *
- * @param title
- * the title
- * @param summary
- * the summary
- */
- public Output(@NonNull String title, @NonNull String summary) {
- this.title = title;
- this.summary = summary;
- }
-
- /**
- * With text.
- *
- * @param text
- * the text
- * @return the output
- */
- public @NonNull Output withText(@CheckForNull String text) {
- this.text = text;
- return this;
- }
-
- /**
- * Adds the.
- *
- * @param annotation
- * the annotation
- * @return the output
- */
- public @NonNull Output add(@NonNull Annotation annotation) {
- if (annotations == null) {
- annotations = new LinkedList<>();
- }
- annotations.add(annotation);
- return this;
- }
-
- /**
- * Adds the.
- *
- * @param image
- * the image
- * @return the output
- */
- public @NonNull Output add(@NonNull Image image) {
- if (images == null) {
- images = new LinkedList<>();
- }
- images.add(image);
- return this;
- }
-
+ @Deprecated
+ public @NonNull GHCheckRunBuilder withCompletedAt(@CheckForNull Date completedAt) {
+ return withCompletedAt(GitHubClient.toInstantOrNull(completedAt));
}
/**
- * The Class Annotation.
+ * With completed at.
*
- * @see documentation
+ * @param completedAt
+ * the completed at
+ * @return the GH check run builder
*/
- @JsonInclude(JsonInclude.Include.NON_NULL)
- public static final class Annotation {
-
- private final String path;
- private final int start_line;
- private final int end_line;
- private final String annotation_level;
- private final String message;
- private Integer start_column;
- private Integer end_column;
- private String title;
- private String raw_details;
-
- /**
- * Instantiates a new annotation.
- *
- * @param path
- * the path
- * @param line
- * the line
- * @param annotationLevel
- * the annotation level
- * @param message
- * the message
- */
- public Annotation(@NonNull String path,
- int line,
- @NonNull GHCheckRun.AnnotationLevel annotationLevel,
- @NonNull String message) {
- this(path, line, line, annotationLevel, message);
- }
-
- /**
- * Instantiates a new annotation.
- *
- * @param path
- * the path
- * @param startLine
- * the start line
- * @param endLine
- * the end line
- * @param annotationLevel
- * the annotation level
- * @param message
- * the message
- */
- public Annotation(@NonNull String path,
- int startLine,
- int endLine,
- @NonNull GHCheckRun.AnnotationLevel annotationLevel,
- @NonNull String message) {
- this.path = path;
- start_line = startLine;
- end_line = endLine;
- annotation_level = annotationLevel.toString().toLowerCase(Locale.ROOT);
- this.message = message;
- }
-
- /**
- * With start column.
- *
- * @param startColumn
- * the start column
- * @return the annotation
- */
- public @NonNull Annotation withStartColumn(@CheckForNull Integer startColumn) {
- start_column = startColumn;
- return this;
+ public @NonNull GHCheckRunBuilder withCompletedAt(@CheckForNull Instant completedAt) {
+ if (completedAt != null) {
+ requester.with("completed_at", GitHubClient.printInstant(completedAt));
}
+ return this;
+ }
- /**
- * With end column.
- *
- * @param endColumn
- * the end column
- * @return the annotation
- */
- public @NonNull Annotation withEndColumn(@CheckForNull Integer endColumn) {
- end_column = endColumn;
- return this;
+ /**
+ * With conclusion.
+ *
+ * @param conclusion
+ * the conclusion
+ * @return the GH check run builder
+ */
+ public @NonNull GHCheckRunBuilder withConclusion(@CheckForNull GHCheckRun.Conclusion conclusion) {
+ if (conclusion != null) {
+ requester.with("conclusion", conclusion.toString().toLowerCase(Locale.ROOT));
}
+ return this;
+ }
- /**
- * With title.
- *
- * @param title
- * the title
- * @return the annotation
- */
- public @NonNull Annotation withTitle(@CheckForNull String title) {
- this.title = title;
- return this;
- }
+ /**
+ * With details URL.
+ *
+ * @param detailsURL
+ * the details URL
+ * @return the GH check run builder
+ */
+ public @NonNull GHCheckRunBuilder withDetailsURL(@CheckForNull String detailsURL) {
+ requester.with("details_url", detailsURL);
+ return this;
+ }
+ /**
+ * With external ID.
+ *
+ * @param externalID
+ * the external ID
+ * @return the GH check run builder
+ */
+ public @NonNull GHCheckRunBuilder withExternalID(@CheckForNull String externalID) {
+ requester.with("external_id", externalID);
+ return this;
+ }
- /**
- * With raw details.
- *
- * @param rawDetails
- * the raw details
- * @return the annotation
- */
- public @NonNull Annotation withRawDetails(@CheckForNull String rawDetails) {
- raw_details = rawDetails;
- return this;
+ /**
+ * With name.
+ *
+ * @param name
+ * the name
+ * @param oldName
+ * the old name
+ * @return the GH check run builder
+ */
+ public @NonNull GHCheckRunBuilder withName(@CheckForNull String name, String oldName) {
+ if (oldName == null) {
+ throw new GHException("Can not update uncreated check run");
}
-
+ requester.with("name", name);
+ return this;
}
/**
- * The Class Image.
+ * With started at.
*
- * @see documentation
+ * @param startedAt
+ * the started at
+ * @return the GH check run builder
+ * @deprecated Use {@link #withStartedAt(Instant)}
*/
- @JsonInclude(JsonInclude.Include.NON_NULL)
- public static final class Image {
-
- private final String alt;
- private final String image_url;
- private String caption;
-
- /**
- * Instantiates a new image.
- *
- * @param alt
- * the alt
- * @param imageURL
- * the image URL
- */
- public Image(@NonNull String alt, @NonNull String imageURL) {
- this.alt = alt;
- image_url = imageURL;
- }
+ @Deprecated
+ public @NonNull GHCheckRunBuilder withStartedAt(@CheckForNull Date startedAt) {
+ return withStartedAt(GitHubClient.toInstantOrNull(startedAt));
+ }
- /**
- * With caption.
- *
- * @param caption
- * the caption
- * @return the image
- */
- public @NonNull Image withCaption(@CheckForNull String caption) {
- this.caption = caption;
- return this;
+ /**
+ * With started at.
+ *
+ * @param startedAt
+ * the started at
+ * @return the GH check run builder
+ */
+ public @NonNull GHCheckRunBuilder withStartedAt(@CheckForNull Instant startedAt) {
+ if (startedAt != null) {
+ requester.with("started_at", GitHubClient.printInstant(startedAt));
}
-
+ return this;
}
/**
- * The Class Action.
+ * With status.
*
- * @see documentation
+ * @param status
+ * the status
+ * @return the GH check run builder
*/
- @JsonInclude(JsonInclude.Include.NON_NULL)
- public static final class Action {
-
- private final String label;
- private final String description;
- private final String identifier;
-
- /**
- * Instantiates a new action.
- *
- * @param label
- * the label
- * @param description
- * the description
- * @param identifier
- * the identifier
- */
- public Action(@NonNull String label, @NonNull String description, @NonNull String identifier) {
- this.label = label;
- this.description = description;
- this.identifier = identifier;
+ public @NonNull GHCheckRunBuilder withStatus(@CheckForNull GHCheckRun.Status status) {
+ if (status != null) {
+ // Do *not* use the overload taking Enum, as that s/_/-/g which would be wrong here.
+ requester.with("status", status.toString().toLowerCase(Locale.ROOT));
}
-
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHCheckRunsPage.java b/src/main/java/org/kohsuke/github/GHCheckRunsPage.java
index f9262f2561..d0b5d012f2 100644
--- a/src/main/java/org/kohsuke/github/GHCheckRunsPage.java
+++ b/src/main/java/org/kohsuke/github/GHCheckRunsPage.java
@@ -1,12 +1,16 @@
package org.kohsuke.github;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
// TODO: Auto-generated Javadoc
/**
* Represents the one page of check-runs result when listing check-runs.
*/
+@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
+ justification = "JSON API")
class GHCheckRunsPage {
- private int total_count;
- private GHCheckRun[] check_runs;
+ private GHCheckRun[] checkRuns;
+ private int totalCount;
/**
* Gets the total count.
@@ -14,7 +18,7 @@ class GHCheckRunsPage {
* @return the total count
*/
public int getTotalCount() {
- return total_count;
+ return totalCount;
}
/**
@@ -25,9 +29,9 @@ public int getTotalCount() {
* @return the check runs
*/
GHCheckRun[] getCheckRuns(GHRepository owner) {
- for (GHCheckRun check_run : check_runs) {
- check_run.wrap(owner);
+ for (GHCheckRun checkRun : checkRuns) {
+ checkRun.wrap(owner);
}
- return check_runs;
+ return checkRuns;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHCheckSuite.java b/src/main/java/org/kohsuke/github/GHCheckSuite.java
index ee70b4c74f..0ada44e82b 100644
--- a/src/main/java/org/kohsuke/github/GHCheckSuite.java
+++ b/src/main/java/org/kohsuke/github/GHCheckSuite.java
@@ -1,10 +1,12 @@
package org.kohsuke.github;
import com.fasterxml.jackson.annotation.JsonProperty;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
@@ -20,98 +22,138 @@
justification = "JSON API")
public class GHCheckSuite extends GHObject {
- /** The owner. */
- @JsonProperty("repository")
- GHRepository owner;
-
- private String nodeId;
- private String headBranch;
- private String headSha;
- private String status;
- private String conclusion;
- private String before;
- private String after;
- private int latestCheckRunsCount;
- private String checkRunsUrl;
- private HeadCommit headCommit;
- private GHApp app;
- private GHPullRequest[] pullRequests;
-
/**
- * Wrap.
- *
- * @param owner
- * the owner
- * @return the GH check suite
+ * The Class HeadCommit.
*/
- GHCheckSuite wrap(GHRepository owner) {
- this.owner = owner;
- this.wrap(owner.root());
- return this;
- }
+ public static class HeadCommit extends GitHubBridgeAdapterObject {
- /**
- * Wrap.
- *
- * @param root
- * the root
- * @return the GH check suite
- */
- GHCheckSuite wrap(GitHub root) {
- if (owner != null) {
- if (pullRequests != null && pullRequests.length != 0) {
- for (GHPullRequest singlePull : pullRequests) {
- singlePull.wrap(owner);
- }
- }
+ private GitUser author;
+
+ private GitUser committer;
+ private String id;
+ private String message;
+ private String timestamp;
+ private String treeId;
+ /**
+ * Create default HeadCommit instance
+ */
+ public HeadCommit() {
+ }
+
+ /**
+ * Gets author.
+ *
+ * @return the author
+ */
+ public GitUser getAuthor() {
+ return author;
+ }
+
+ /**
+ * Gets committer.
+ *
+ * @return the committer
+ */
+ public GitUser getCommitter() {
+ return committer;
+ }
+
+ /**
+ * Gets id of the commit, used by {@link GHCheckSuite} when a {@link GHEvent#CHECK_SUITE} comes.
+ *
+ * @return id of the commit
+ */
+ public String getId() {
+ return id;
+ }
+
+ /**
+ * Gets message.
+ *
+ * @return commit message.
+ */
+ public String getMessage() {
+ return message;
+ }
+
+ /**
+ * Gets timestamp of the commit.
+ *
+ * @return timestamp of the commit
+ */
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getTimestamp() {
+ return GitHubClient.parseInstant(timestamp);
+ }
+
+ /**
+ * Gets id of the tree.
+ *
+ * @return id of the tree
+ */
+ public String getTreeId() {
+ return treeId;
}
- return this;
}
+ private String after;
+
+ private GHApp app;
+ private String before;
+ private String checkRunsUrl;
+ private String conclusion;
+ private String headBranch;
+ private HeadCommit headCommit;
+ private String headSha;
+ private int latestCheckRunsCount;
+ private String nodeId;
+ private GHPullRequest[] pullRequests;
+ private String status;
+ /** The owner. */
+ @JsonProperty("repository")
+ GHRepository owner;
+
/**
- * Wrap.
- *
- * @return the GH pull request[]
+ * Create default GHCheckSuite instance
*/
- GHPullRequest[] wrap() {
- return pullRequests;
+ public GHCheckSuite() {
}
/**
- * Gets the global node id to access most objects in GitHub.
+ * The SHA of the most recent commit on ref after the push.
*
- * @return global node id
- * @see documentation
+ * @return sha of a commit
*/
- public String getNodeId() {
- return nodeId;
+ public String getAfter() {
+ return after;
}
/**
- * The head branch name the changes are on.
+ * Gets the GitHub app this check suite belongs to, included in response.
*
- * @return head branch name
+ * @return GitHub App
*/
- public String getHeadBranch() {
- return headBranch;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHApp getApp() {
+ return app;
}
/**
- * Gets the HEAD SHA.
+ * The SHA of the most recent commit on ref before the push.
*
- * @return sha for the HEAD commit
+ * @return sha of a commit
*/
- public String getHeadSha() {
- return headSha;
+ public String getBefore() {
+ return before;
}
/**
- * Gets status of the check suite. It can be one of request, in_progress, or completed.
+ * The url used to list all the check runs belonged to this suite.
*
- * @return status of the check suite
+ * @return url containing all check runs
*/
- public String getStatus() {
- return status;
+ public URL getCheckRunsUrl() {
+ return GitHubClient.parseURL(checkRunsUrl);
}
/**
@@ -126,58 +168,49 @@ public String getConclusion() {
}
/**
- * The SHA of the most recent commit on ref before the push.
- *
- * @return sha of a commit
- */
- public String getBefore() {
- return before;
- }
-
- /**
- * The SHA of the most recent commit on ref after the push.
+ * The head branch name the changes are on.
*
- * @return sha of a commit
+ * @return head branch name
*/
- public String getAfter() {
- return after;
+ public String getHeadBranch() {
+ return headBranch;
}
/**
- * The quantity of check runs that had run as part of the latest push.
+ * The commit of current head.
*
- * @return sha of the most recent commit
+ * @return head commit
*/
- public int getLatestCheckRunsCount() {
- return latestCheckRunsCount;
+ public HeadCommit getHeadCommit() {
+ return headCommit;
}
/**
- * The url used to list all the check runs belonged to this suite.
+ * Gets the HEAD SHA.
*
- * @return url containing all check runs
+ * @return sha for the HEAD commit
*/
- public URL getCheckRunsUrl() {
- return GitHubClient.parseURL(checkRunsUrl);
+ public String getHeadSha() {
+ return headSha;
}
/**
- * The commit of current head.
+ * The quantity of check runs that had run as part of the latest push.
*
- * @return head commit
+ * @return sha of the most recent commit
*/
- public HeadCommit getHeadCommit() {
- return headCommit;
+ public int getLatestCheckRunsCount() {
+ return latestCheckRunsCount;
}
/**
- * Gets the GitHub app this check suite belongs to, included in response.
+ * Gets the global node id to access most objects in GitHub.
*
- * @return GitHub App
+ * @return global node id
+ * @see documentation
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHApp getApp() {
- return app;
+ public String getNodeId() {
+ return nodeId;
}
/**
@@ -202,78 +235,51 @@ public List getPullRequests() throws IOException {
}
/**
- * Check suite doesn't have a HTML URL.
+ * Gets status of the check suite. It can be one of request, in_progress, or completed.
*
- * @return null
+ * @return status of the check suite
*/
- @Override
- public URL getHtmlUrl() {
- return null;
+ public String getStatus() {
+ return status;
}
/**
- * The Class HeadCommit.
+ * Wrap.
+ *
+ * @return the GH pull request[]
*/
- public static class HeadCommit {
- private String id;
- private String treeId;
- private String message;
- private String timestamp;
- private GitUser author;
- private GitUser committer;
-
- /**
- * Gets id of the commit, used by {@link GHCheckSuite} when a {@link GHEvent#CHECK_SUITE} comes.
- *
- * @return id of the commit
- */
- public String getId() {
- return id;
- }
-
- /**
- * Gets id of the tree.
- *
- * @return id of the tree
- */
- public String getTreeId() {
- return treeId;
- }
-
- /**
- * Gets message.
- *
- * @return commit message.
- */
- public String getMessage() {
- return message;
- }
-
- /**
- * Gets timestamp of the commit.
- *
- * @return timestamp of the commit
- */
- public Date getTimestamp() {
- return GitHubClient.parseDate(timestamp);
- }
+ GHPullRequest[] wrap() {
+ return pullRequests;
+ }
- /**
- * Gets author.
- *
- * @return the author
- */
- public GitUser getAuthor() {
- return author;
- }
+ /**
+ * Wrap.
+ *
+ * @param owner
+ * the owner
+ * @return the GH check suite
+ */
+ GHCheckSuite wrap(GHRepository owner) {
+ this.owner = owner;
+ this.wrap(owner.root());
+ return this;
+ }
- /**
- * Gets committer.
- *
- * @return the committer
- */
- public GitUser getCommitter() {
- return committer;
+ /**
+ * Wrap.
+ *
+ * @param root
+ * the root
+ * @return the GH check suite
+ */
+ GHCheckSuite wrap(GitHub root) {
+ if (owner != null) {
+ if (pullRequests != null && pullRequests.length != 0) {
+ for (GHPullRequest singlePull : pullRequests) {
+ singlePull.wrap(owner);
+ }
+ }
}
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHCodeownersError.java b/src/main/java/org/kohsuke/github/GHCodeownersError.java
index 8d5662700c..b090a1673b 100644
--- a/src/main/java/org/kohsuke/github/GHCodeownersError.java
+++ b/src/main/java/org/kohsuke/github/GHCodeownersError.java
@@ -8,17 +8,15 @@
* @author Michael Grant
*/
public class GHCodeownersError {
- private int line, column;
private String kind, source, suggestion, message, path;
+ private int line, column;
+
/**
- * Gets line.
- *
- * @return the line
+ * Create default GHCodeownersError instance
*/
- public int getLine() {
- return line;
+ public GHCodeownersError() {
}
/**
@@ -40,21 +38,12 @@ public String getKind() {
}
/**
- * Gets source.
- *
- * @return the source
- */
- public String getSource() {
- return source;
- }
-
- /**
- * Gets suggestion.
+ * Gets line.
*
- * @return the suggestion
+ * @return the line
*/
- public String getSuggestion() {
- return suggestion;
+ public int getLine() {
+ return line;
}
/**
@@ -74,4 +63,22 @@ public String getMessage() {
public String getPath() {
return path;
}
+
+ /**
+ * Gets source.
+ *
+ * @return the source
+ */
+ public String getSource() {
+ return source;
+ }
+
+ /**
+ * Gets suggestion.
+ *
+ * @return the suggestion
+ */
+ public String getSuggestion() {
+ return suggestion;
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHCommentAuthorAssociation.java b/src/main/java/org/kohsuke/github/GHCommentAuthorAssociation.java
index b00905ab8f..011016f504 100644
--- a/src/main/java/org/kohsuke/github/GHCommentAuthorAssociation.java
+++ b/src/main/java/org/kohsuke/github/GHCommentAuthorAssociation.java
@@ -38,5 +38,9 @@ public enum GHCommentAuthorAssociation {
/**
* Author is the owner of the repository.
*/
- OWNER
+ OWNER,
+ /**
+ * Author association is not recognized.
+ */
+ UNKNOWN
}
diff --git a/src/main/java/org/kohsuke/github/GHCommit.java b/src/main/java/org/kohsuke/github/GHCommit.java
index 250dbe7755..1edf0503d3 100644
--- a/src/main/java/org/kohsuke/github/GHCommit.java
+++ b/src/main/java/org/kohsuke/github/GHCommit.java
@@ -1,18 +1,17 @@
package org.kohsuke.github;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.AbstractList;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;
-import static org.kohsuke.github.internal.Previews.ANTIOPE;
-import static org.kohsuke.github.internal.Previews.GROOT;
-
// TODO: Auto-generated Javadoc
/**
* A commit in a repository.
@@ -24,122 +23,60 @@
@SuppressFBWarnings(value = { "NP_UNWRITTEN_FIELD", "UWF_UNWRITTEN_FIELD" }, justification = "JSON API")
public class GHCommit {
- private GHRepository owner;
-
- private ShortInfo commit;
-
/**
- * Short summary of this commit.
+ * A file that was modified.
*/
- @SuppressFBWarnings(
- value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD",
- "UWF_UNWRITTEN_FIELD" },
- justification = "JSON API")
- public static class ShortInfo extends GitCommit {
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "It's being initialized by JSON deserialization")
+ public static class File {
- private int comment_count = -1;
+ /** The deletions. */
+ int changes, additions, deletions;
- /**
- * Gets comment count.
- *
- * @return the comment count
- * @throws GHException
- * the GH exception
- */
- public int getCommentCount() throws GHException {
- if (comment_count < 0) {
- throw new GHException("Not available on this endpoint.");
- }
- return comment_count;
- }
+ /** The previous filename. */
+ String filename, previousFilename;
- /**
- * Creates instance of {@link GHCommit.ShortInfo}.
- */
- public ShortInfo() {
- // Empty constructor required for Jackson binding
- };
+ /** The patch. */
+ String rawUrl, blobUrl, sha, patch;
+
+ /** The status. */
+ String status;
/**
- * Instantiates a new short info.
- *
- * @param commit
- * the commit
+ * Create default File instance
*/
- ShortInfo(GitCommit commit) {
- // Inherited copy constructor, used for bridge method from {@link GitCommit},
- // which is used in {@link GHContentUpdateResponse}) to {@link GHCommit}.
- super(commit);
+ public File() {
}
/**
- * Gets the parent SHA 1 s.
+ * Gets blob url.
*
- * @return the parent SHA 1 s
+ * @return URL like
+ * 'https://github.com/jenkinsci/jenkins/blob/1182e2ebb1734d0653142bd422ad33c21437f7cf/core/pom.xml'
+ * that resolves to the HTML page that describes this file.
*/
- @Override
- public List getParentSHA1s() {
- List shortInfoParents = super.getParentSHA1s();
- if (shortInfoParents == null) {
- throw new GHException("Not available on this endpoint. Try calling getParentSHA1s from outer class.");
- }
- return shortInfoParents;
+ public URL getBlobUrl() {
+ return GitHubClient.parseURL(blobUrl);
}
- }
-
- /**
- * The type GHAuthor.
- *
- * @deprecated Use {@link GitUser} instead.
- */
- @Deprecated
- public static class GHAuthor extends GitUser {
-
/**
- * Instantiates a new GH author.
+ * Gets file name.
+ *
+ * @return Full path in the repository.
*/
- public GHAuthor() {
- super();
+ @SuppressFBWarnings(value = "NM_CONFUSING",
+ justification = "It's a part of the library's API and cannot be renamed")
+ public String getFileName() {
+ return filename;
}
/**
- * Instantiates a new GH author.
+ * Gets lines added.
*
- * @param user
- * the user
+ * @return Number of lines added.
*/
- public GHAuthor(GitUser user) {
- super(user);
+ public int getLinesAdded() {
+ return additions;
}
- }
-
- /**
- * The type Stats.
- */
- public static class Stats {
-
- /** The deletions. */
- int total, additions, deletions;
- }
-
- /**
- * A file that was modified.
- */
- @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "It's being initialized by JSON deserialization")
- public static class File {
-
- /** The status. */
- String status;
-
- /** The deletions. */
- int changes, additions, deletions;
-
- /** The patch. */
- String raw_url, blob_url, sha, patch;
-
- /** The previous filename. */
- String filename, previous_filename;
/**
* Gets lines changed.
@@ -150,15 +87,6 @@ public int getLinesChanged() {
return changes;
}
- /**
- * Gets lines added.
- *
- * @return Number of lines added.
- */
- public int getLinesAdded() {
- return additions;
- }
-
/**
* Gets lines deleted.
*
@@ -169,23 +97,12 @@ public int getLinesDeleted() {
}
/**
- * Gets status.
- *
- * @return "modified", "added", or "removed"
- */
- public String getStatus() {
- return status;
- }
-
- /**
- * Gets file name.
+ * Gets patch.
*
- * @return Full path in the repository.
+ * @return The actual change.
*/
- @SuppressFBWarnings(value = "NM_CONFUSING",
- justification = "It's a part of the library's API and cannot be renamed")
- public String getFileName() {
- return filename;
+ public String getPatch() {
+ return patch;
}
/**
@@ -194,16 +111,7 @@ public String getFileName() {
* @return Previous path, in case file has moved.
*/
public String getPreviousFilename() {
- return previous_filename;
- }
-
- /**
- * Gets patch.
- *
- * @return The actual change.
- */
- public String getPatch() {
- return patch;
+ return previousFilename;
}
/**
@@ -214,27 +122,25 @@ public String getPatch() {
* resolves to the actual content of the file.
*/
public URL getRawUrl() {
- return GitHubClient.parseURL(raw_url);
+ return GitHubClient.parseURL(rawUrl);
}
/**
- * Gets blob url.
+ * Gets sha.
*
- * @return URL like
- * 'https://github.com/jenkinsci/jenkins/blob/1182e2ebb1734d0653142bd422ad33c21437f7cf/core/pom.xml'
- * that resolves to the HTML page that describes this file.
+ * @return [0 -9a-f]{40} SHA1 checksum.
*/
- public URL getBlobUrl() {
- return GitHubClient.parseURL(blob_url);
+ public String getSha() {
+ return sha;
}
/**
- * Gets sha.
+ * Gets status.
*
- * @return [0 -9a-f]{40} SHA1 checksum.
+ * @return "modified", "added", or "removed"
*/
- public String getSha() {
- return sha;
+ public String getStatus() {
+ return status;
}
}
@@ -243,12 +149,93 @@ public String getSha() {
*/
public static class Parent {
+ /** The sha. */
+ String sha;
+
/** The url. */
@SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
String url;
- /** The sha. */
- String sha;
+ /**
+ * Create default Parent instance
+ */
+ public Parent() {
+ }
+ }
+
+ /**
+ * Short summary of this commit.
+ */
+ @SuppressFBWarnings(
+ value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD",
+ "UWF_UNWRITTEN_FIELD" },
+ justification = "JSON API")
+ public static class ShortInfo extends GitCommit {
+
+ private int commentCount = -1;
+
+ /**
+ * Creates instance of {@link GHCommit.ShortInfo}.
+ */
+ public ShortInfo() {
+ // Empty constructor required for Jackson binding
+ }
+
+ /**
+ * Instantiates a new short info.
+ *
+ * @param commit
+ * the commit
+ */
+ ShortInfo(GitCommit commit) {
+ // Inherited copy constructor, used for bridge method from {@link GitCommit},
+ // which is used in {@link GHContentUpdateResponse}) to {@link GHCommit}.
+ super(commit);
+ };
+
+ /**
+ * Gets comment count.
+ *
+ * @return the comment count
+ * @throws GHException
+ * the GH exception
+ */
+ public int getCommentCount() throws GHException {
+ if (commentCount < 0) {
+ throw new GHException("Not available on this endpoint.");
+ }
+ return commentCount;
+ }
+
+ /**
+ * Gets the parent SHA 1 s.
+ *
+ * @return the parent SHA 1 s
+ */
+ @Override
+ public List getParentSHA1s() {
+ List shortInfoParents = super.getParentSHA1s();
+ if (shortInfoParents == null) {
+ throw new GHException("Not available on this endpoint. Try calling getParentSHA1s from outer class.");
+ }
+ return shortInfoParents;
+ }
+
+ }
+
+ /**
+ * The type Stats.
+ */
+ public static class Stats {
+
+ /** The deletions. */
+ int total, additions, deletions;
+
+ /**
+ * Create default Stats instance
+ */
+ public Stats() {
+ }
}
/**
@@ -256,33 +243,37 @@ public static class Parent {
*/
static class User {
- /** The gravatar id. */
- // TODO: what if someone who doesn't have an account on GitHub makes a commit?
- @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
- String url, avatar_url, gravatar_id;
-
/** The id. */
@SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
int id;
/** The login. */
String login;
+
+ /** The gravatar id. */
+ // TODO: what if someone who doesn't have an account on GitHub makes a commit?
+ @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
+ String url, avatarUrl, gravatarId;
}
- /** The sha. */
- String url, html_url, sha, message;
+ private ShortInfo commit;
+
+ private GHRepository owner;
+
+ /** The committer. */
+ User author, committer;
/** The files. */
List files;
- /** The stats. */
- Stats stats;
-
/** The parents. */
List parents;
- /** The committer. */
- User author, committer;
+ /** The stats. */
+ Stats stats;
+
+ /** The sha. */
+ String url, htmlUrl, sha, message;
/**
* Creates an instance of {@link GHCommit}.
@@ -305,7 +296,7 @@ public GHCommit() {
commit = shortInfo;
owner = commit.getOwner();
- html_url = commit.getHtmlUrl();
+ htmlUrl = commit.getHtmlUrl();
sha = commit.getSha();
url = commit.getUrl();
parents = commit.getParents();
@@ -313,73 +304,119 @@ public GHCommit() {
}
/**
- * Gets commit short info.
+ * Create comment gh commit comment.
+ *
+ * @param body
+ * the body
+ * @return the gh commit comment
+ * @throws IOException
+ * the io exception
+ */
+ public GHCommitComment createComment(String body) throws IOException {
+ return createComment(body, null, null, null);
+ }
+
+ /**
+ * Creates a commit comment.
+ *
+ * I'm not sure how path/line/position parameters interact with each other.
+ *
+ * @param body
+ * body of the comment
+ * @param path
+ * path of file being commented on
+ * @param line
+ * target line for comment
+ * @param position
+ * position on line
+ * @return created GHCommitComment
+ * @throws IOException
+ * if comment is not created
+ */
+ public GHCommitComment createComment(String body, String path, Integer line, Integer position) throws IOException {
+ GHCommitComment r = owner.root()
+ .createRequest()
+ .method("POST")
+ .with("body", body)
+ .with("path", path)
+ .with("line", line)
+ .with("position", position)
+ .withUrlPath(
+ String.format("/repos/%s/%s/commits/%s/comments", owner.getOwnerName(), owner.getName(), sha))
+ .fetch(GHCommitComment.class);
+ return r.wrap(owner);
+ }
+
+ /**
+ * Gets author.
*
- * @return the commit short info
+ * @return the author
* @throws IOException
* the io exception
*/
- public ShortInfo getCommitShortInfo() throws IOException {
- if (commit == null)
- populate();
- return commit;
+ public GHUser getAuthor() throws IOException {
+ populate();
+ return resolveUser(author);
}
/**
- * Gets owner.
+ * Gets the date the change was authored on.
*
- * @return the repository that contains the commit.
+ * @return the date the change was authored on.
+ * @throws IOException
+ * if the information was not already fetched and an attempt at fetching the information failed.
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHRepository getOwner() {
- return owner;
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getAuthoredDate() throws IOException {
+ return getCommitShortInfo().getAuthoredDate();
}
/**
- * Gets lines changed.
+ * Gets check-runs for given sha.
*
- * @return the number of lines added + removed.
+ * @return check runs for given sha.
* @throws IOException
- * if the field was not populated and refresh fails
+ * on error
*/
- public int getLinesChanged() throws IOException {
- populate();
- return stats.total;
+ public PagedIterable getCheckRuns() throws IOException {
+ return owner.getCheckRuns(sha);
}
/**
- * Gets lines added.
+ * Gets the date the change was committed on.
*
- * @return Number of lines added.
+ * @return the date the change was committed on.
* @throws IOException
- * if the field was not populated and refresh fails
+ * if the information was not already fetched and an attempt at fetching the information failed.
*/
- public int getLinesAdded() throws IOException {
- populate();
- return stats.additions;
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getCommitDate() throws IOException {
+ return getCommitShortInfo().getCommitDate();
}
/**
- * Gets lines deleted.
+ * Gets commit short info.
*
- * @return Number of lines removed.
+ * @return the commit short info
* @throws IOException
- * if the field was not populated and refresh fails
+ * the io exception
*/
- public int getLinesDeleted() throws IOException {
- populate();
- return stats.deletions;
+ public ShortInfo getCommitShortInfo() throws IOException {
+ if (commit == null)
+ populate();
+ return commit;
}
/**
- * Use this method to walk the tree.
+ * Gets committer.
*
- * @return a GHTree to walk
+ * @return the committer
* @throws IOException
- * on error
+ * the io exception
*/
- public GHTree getTree() throws IOException {
- return owner.getTree(getCommitShortInfo().getTreeSHA1());
+ public GHUser getCommitter() throws IOException {
+ populate();
+ return resolveUser(committer);
}
/**
@@ -389,55 +426,64 @@ public GHTree getTree() throws IOException {
* "https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000"
*/
public URL getHtmlUrl() {
- return GitHubClient.parseURL(html_url);
+ return GitHubClient.parseURL(htmlUrl);
}
/**
- * Gets sha 1.
+ * Gets last status.
*
- * @return [0 -9a-f]{40} SHA1 checksum.
+ * @return the last status of this commit, which is what gets shown in the UI.
+ * @throws IOException
+ * on error
*/
- public String getSHA1() {
- return sha;
+ public GHCommitStatus getLastStatus() throws IOException {
+ return owner.getLastCommitStatus(sha);
}
/**
- * Gets url.
+ * Gets lines added.
*
- * @return API URL of this object.
+ * @return Number of lines added.
+ * @throws IOException
+ * if the field was not populated and refresh fails
*/
- public URL getUrl() {
- return GitHubClient.parseURL(url);
+ public int getLinesAdded() throws IOException {
+ populate();
+ return stats.additions;
}
/**
- * List of files changed/added/removed in this commit.
+ * Gets lines changed.
*
- * @return Can be empty but never null.
+ * @return the number of lines added + removed.
* @throws IOException
- * on error
- * @deprecated Use {@link #listFiles()} instead.
+ * if the field was not populated and refresh fails
*/
- @Deprecated
- public List getFiles() throws IOException {
- return listFiles().toList();
+ public int getLinesChanged() throws IOException {
+ populate();
+ return stats.total;
}
/**
- * List of files changed/added/removed in this commit. Uses a paginated list if the files returned by GitHub exceed
- * 300 in quantity.
+ * Gets lines deleted.
*
- * @return the List of files
- * @see Get a
- * commit
+ * @return Number of lines removed.
* @throws IOException
- * on error
+ * if the field was not populated and refresh fails
*/
- public PagedIterable listFiles() throws IOException {
-
+ public int getLinesDeleted() throws IOException {
populate();
+ return stats.deletions;
+ }
- return new GHCommitFileIterable(owner, sha, files);
+ /**
+ * Gets owner.
+ *
+ * @return the repository that contains the commit.
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getOwner() {
+ return owner;
}
/**
@@ -477,83 +523,42 @@ public List getParents() throws IOException {
}
/**
- * Gets author.
- *
- * @return the author
- * @throws IOException
- * the io exception
- */
- public GHUser getAuthor() throws IOException {
- populate();
- return resolveUser(author);
- }
-
- /**
- * Gets the date the change was authored on.
- *
- * @return the date the change was authored on.
- * @throws IOException
- * if the information was not already fetched and an attempt at fetching the information failed.
- */
- public Date getAuthoredDate() throws IOException {
- return getCommitShortInfo().getAuthoredDate();
- }
-
- /**
- * Gets committer.
+ * Gets sha 1.
*
- * @return the committer
- * @throws IOException
- * the io exception
+ * @return [0 -9a-f]{40} SHA1 checksum.
*/
- public GHUser getCommitter() throws IOException {
- populate();
- return resolveUser(committer);
+ public String getSHA1() {
+ return sha;
}
/**
- * Gets the date the change was committed on.
+ * Use this method to walk the tree.
*
- * @return the date the change was committed on.
+ * @return a GHTree to walk
* @throws IOException
- * if the information was not already fetched and an attempt at fetching the information failed.
+ * on error
*/
- public Date getCommitDate() throws IOException {
- return getCommitShortInfo().getCommitDate();
- }
-
- private GHUser resolveUser(User author) throws IOException {
- if (author == null || author.login == null)
- return null;
- return owner.root().getUser(author.login);
+ public GHTree getTree() throws IOException {
+ return owner.getTree(getCommitShortInfo().getTreeSHA1());
}
/**
- * Retrieves a list of pull requests which contain this commit.
+ * Gets url.
*
- * @return {@link PagedIterable} with the pull requests which contain this commit
+ * @return API URL of this object.
*/
- @Preview(GROOT)
- public PagedIterable listPullRequests() {
- return owner.root()
- .createRequest()
- .withPreview(GROOT)
- .withUrlPath(String.format("/repos/%s/%s/commits/%s/pulls", owner.getOwnerName(), owner.getName(), sha))
- .toIterable(GHPullRequest[].class, item -> item.wrapUp(owner));
+ public URL getUrl() {
+ return GitHubClient.parseURL(url);
}
/**
* Retrieves a list of branches where this commit is the head commit.
*
* @return {@link PagedIterable} with the branches where the commit is the head commit
- * @throws IOException
- * the io exception
*/
- @Preview(GROOT)
- public PagedIterable listBranchesWhereHead() throws IOException {
+ public PagedIterable listBranchesWhereHead() {
return owner.root()
.createRequest()
- .withPreview(GROOT)
.withUrlPath(String.format("/repos/%s/%s/commits/%s/branches-where-head",
owner.getOwnerName(),
owner.getName(),
@@ -571,47 +576,32 @@ public PagedIterable listComments() {
}
/**
- * Creates a commit comment.
- *
- * I'm not sure how path/line/position parameters interact with each other.
+ * List of files changed/added/removed in this commit. Uses a paginated list if the files returned by GitHub exceed
+ * 300 in quantity.
*
- * @param body
- * body of the comment
- * @param path
- * path of file being commented on
- * @param line
- * target line for comment
- * @param position
- * position on line
- * @return created GHCommitComment
+ * @return the List of files
+ * @see Get a
+ * commit
* @throws IOException
- * if comment is not created
+ * on error
*/
- public GHCommitComment createComment(String body, String path, Integer line, Integer position) throws IOException {
- GHCommitComment r = owner.root()
- .createRequest()
- .method("POST")
- .with("body", body)
- .with("path", path)
- .with("line", line)
- .with("position", position)
- .withUrlPath(
- String.format("/repos/%s/%s/commits/%s/comments", owner.getOwnerName(), owner.getName(), sha))
- .fetch(GHCommitComment.class);
- return r.wrap(owner);
+ public PagedIterable listFiles() throws IOException {
+
+ populate();
+
+ return new GHCommitFileIterable(owner, sha, files);
}
/**
- * Create comment gh commit comment.
+ * Retrieves a list of pull requests which contain this commit.
*
- * @param body
- * the body
- * @return the gh commit comment
- * @throws IOException
- * the io exception
+ * @return {@link PagedIterable} with the pull requests which contain this commit
*/
- public GHCommitComment createComment(String body) throws IOException {
- return createComment(body, null, null, null);
+ public PagedIterable listPullRequests() {
+ return owner.root()
+ .createRequest()
+ .withUrlPath(String.format("/repos/%s/%s/commits/%s/pulls", owner.getOwnerName(), owner.getName(), sha))
+ .toIterable(GHPullRequest[].class, item -> item.wrapUp(owner));
}
/**
@@ -625,27 +615,10 @@ public PagedIterable listStatuses() throws IOException {
return owner.listCommitStatuses(sha);
}
- /**
- * Gets last status.
- *
- * @return the last status of this commit, which is what gets shown in the UI.
- * @throws IOException
- * on error
- */
- public GHCommitStatus getLastStatus() throws IOException {
- return owner.getLastCommitStatus(sha);
- }
-
- /**
- * Gets check-runs for given sha.
- *
- * @return check runs for given sha.
- * @throws IOException
- * on error
- */
- @Preview(ANTIOPE)
- public PagedIterable getCheckRuns() throws IOException {
- return owner.getCheckRuns(sha);
+ private GHUser resolveUser(User author) throws IOException {
+ if (author == null || author.login == null)
+ return null;
+ return owner.root().getUser(author.login);
}
/**
diff --git a/src/main/java/org/kohsuke/github/GHCommitBuilder.java b/src/main/java/org/kohsuke/github/GHCommitBuilder.java
index 11c382312b..65f4c6d679 100644
--- a/src/main/java/org/kohsuke/github/GHCommitBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHCommitBuilder.java
@@ -1,37 +1,32 @@
package org.kohsuke.github;
import java.io.IOException;
-import java.text.DateFormat;
-import java.text.SimpleDateFormat;
+import java.time.Instant;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
-import java.util.TimeZone;
// TODO: Auto-generated Javadoc
/**
* Builder pattern for creating a new commit. Based on https://developer.github.com/v3/git/commits/#create-a-commit
*/
public class GHCommitBuilder {
- private final GHRepository repo;
- private final Requester req;
-
- private final List parents = new ArrayList();
-
private static final class UserInfo {
- private final String name;
- private final String email;
private final String date;
+ private final String email;
+ private final String name;
- private UserInfo(String name, String email, Date date) {
+ private UserInfo(String name, String email, Instant date) {
this.name = name;
this.email = email;
- TimeZone tz = TimeZone.getTimeZone("UTC");
- DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
- df.setTimeZone(tz);
- this.date = df.format((date != null) ? date : new Date());
+ this.date = GitHubClient.printInstant(date);
}
}
+ private final List parents = new ArrayList();
+
+ private final GHRepository repo;
+
+ private final Requester req;
/**
* Instantiates a new GH commit builder.
@@ -45,39 +40,20 @@ private UserInfo(String name, String email, Date date) {
}
/**
- * Message gh commit builder.
- *
- * @param message
- * the commit message
- * @return the gh commit builder
- */
- public GHCommitBuilder message(String message) {
- req.with("message", message);
- return this;
- }
-
- /**
- * Tree gh commit builder.
- *
- * @param tree
- * the SHA of the tree object this commit points to
- * @return the gh commit builder
- */
- public GHCommitBuilder tree(String tree) {
- req.with("tree", tree);
- return this;
- }
-
- /**
- * Parent gh commit builder.
+ * Configures the author of this commit.
*
- * @param parent
- * the SHA of a parent commit.
+ * @param name
+ * the name
+ * @param email
+ * the email
+ * @param date
+ * the date
* @return the gh commit builder
+ * @deprecated use {@link #author(String, String, Instant)} instead
*/
- public GHCommitBuilder parent(String parent) {
- parents.add(parent);
- return this;
+ @Deprecated
+ public GHCommitBuilder author(String name, String email, Date date) {
+ return author(name, email, GitHubClient.toInstantOrNull(date));
}
/**
@@ -91,22 +67,26 @@ public GHCommitBuilder parent(String parent) {
* the date
* @return the gh commit builder
*/
- public GHCommitBuilder author(String name, String email, Date date) {
+ public GHCommitBuilder author(String name, String email, Instant date) {
req.with("author", new UserInfo(name, email, date));
return this;
}
/**
- * Configures the PGP signature of this commit.
- *
- * @param signature
- * the signature calculated from the commit
+ * Configures the committer of this commit.
*
+ * @param name
+ * the name
+ * @param email
+ * the email
+ * @param date
+ * the date
* @return the gh commit builder
+ * @deprecated use {@link #committer(String, String, Instant)} instead
*/
- public GHCommitBuilder withSignature(String signature) {
- req.with("signature", signature);
- return this;
+ @Deprecated
+ public GHCommitBuilder committer(String name, String email, Date date) {
+ return committer(name, email, GitHubClient.toInstantOrNull(date));
}
/**
@@ -120,15 +100,11 @@ public GHCommitBuilder withSignature(String signature) {
* the date
* @return the gh commit builder
*/
- public GHCommitBuilder committer(String name, String email, Date date) {
+ public GHCommitBuilder committer(String name, String email, Instant date) {
req.with("committer", new UserInfo(name, email, date));
return this;
}
- private String getApiTail() {
- return String.format("/repos/%s/%s/git/commits", repo.getOwnerName(), repo.getName());
- }
-
/**
* Creates a blob based on the parameters specified thus far.
*
@@ -140,4 +116,57 @@ public GHCommit create() throws IOException {
req.with("parents", parents);
return req.method("POST").withUrlPath(getApiTail()).fetch(GHCommit.class).wrapUp(repo);
}
+
+ /**
+ * Message gh commit builder.
+ *
+ * @param message
+ * the commit message
+ * @return the gh commit builder
+ */
+ public GHCommitBuilder message(String message) {
+ req.with("message", message);
+ return this;
+ }
+
+ /**
+ * Parent gh commit builder.
+ *
+ * @param parent
+ * the SHA of a parent commit.
+ * @return the gh commit builder
+ */
+ public GHCommitBuilder parent(String parent) {
+ parents.add(parent);
+ return this;
+ }
+
+ /**
+ * Tree gh commit builder.
+ *
+ * @param tree
+ * the SHA of the tree object this commit points to
+ * @return the gh commit builder
+ */
+ public GHCommitBuilder tree(String tree) {
+ req.with("tree", tree);
+ return this;
+ }
+
+ /**
+ * Configures the PGP signature of this commit.
+ *
+ * @param signature
+ * the signature calculated from the commit
+ *
+ * @return the gh commit builder
+ */
+ public GHCommitBuilder withSignature(String signature) {
+ req.with("signature", signature);
+ return this;
+ }
+
+ private String getApiTail() {
+ return String.format("/repos/%s/%s/git/commits", repo.getOwnerName(), repo.getName());
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHCommitComment.java b/src/main/java/org/kohsuke/github/GHCommitComment.java
index bf040d36c8..b73a49666d 100644
--- a/src/main/java/org/kohsuke/github/GHCommitComment.java
+++ b/src/main/java/org/kohsuke/github/GHCommitComment.java
@@ -5,8 +5,6 @@
import java.io.IOException;
import java.net.URL;
-import static org.kohsuke.github.internal.Previews.SQUIRREL_GIRL;
-
// TODO: Auto-generated Javadoc
/**
* A comment attached to a commit (or a specific line in a specific file of a commit.)
@@ -20,10 +18,11 @@
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
justification = "JSON API")
public class GHCommitComment extends GHObject implements Reactable {
+
private GHRepository owner;
/** The commit id. */
- String body, html_url, commit_id;
+ String body, htmlUrl, commitId;
/** The line. */
Integer line;
@@ -35,33 +34,53 @@ public class GHCommitComment extends GHObject implements Reactable {
GHUser user; // not fully populated. beware.
/**
- * Gets owner.
+ * Create default GHCommitComment instance
+ */
+ public GHCommitComment() {
+ }
+
+ /**
+ * Creates the reaction.
*
- * @return the owner
+ * @param content
+ * the content
+ * @return the GH reaction
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHRepository getOwner() {
- return owner;
+ public GHReaction createReaction(ReactionContent content) throws IOException {
+ return owner.root()
+ .createRequest()
+ .method("POST")
+ .with("content", content.getContent())
+ .withUrlPath(getApiTail() + "/reactions")
+ .fetch(GHReaction.class);
}
/**
- * URL like
- * 'https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000#commitcomment-1252827' to
- * show this commit comment in a browser.
+ * Deletes this comment.
*
- * @return the html url
+ * @throws IOException
+ * the io exception
*/
- public URL getHtmlUrl() {
- return GitHubClient.parseURL(html_url);
+ public void delete() throws IOException {
+ owner.root().createRequest().method("DELETE").withUrlPath(getApiTail()).send();
}
/**
- * Gets sha 1.
+ * Delete reaction.
*
- * @return the sha 1
+ * @param reaction
+ * the reaction
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
- public String getSHA1() {
- return commit_id;
+ public void deleteReaction(GHReaction reaction) throws IOException {
+ owner.root()
+ .createRequest()
+ .method("DELETE")
+ .withUrlPath(getApiTail(), "reactions", String.valueOf(reaction.getId()))
+ .send();
}
/**
@@ -74,99 +93,75 @@ public String getBody() {
}
/**
- * A commit comment can be on a specific line of a specific file, if so, this field points to a file. Otherwise
- * null.
+ * Gets the commit to which this comment is associated with.
*
- * @return the path
+ * @return the commit
+ * @throws IOException
+ * the io exception
*/
- public String getPath() {
- return path;
+ public GHCommit getCommit() throws IOException {
+ return getOwner().getCommit(getSHA1());
}
/**
- * A commit comment can be on a specific line of a specific file, if so, this field points to the line number in the
- * file. Otherwise -1.
+ * URL like
+ * 'https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000#commitcomment-1252827' to
+ * show this commit comment in a browser.
*
- * @return the line
+ * @return the html url
*/
- public int getLine() {
- return line != null ? line : -1;
+ public URL getHtmlUrl() {
+ return GitHubClient.parseURL(htmlUrl);
}
/**
- * Gets the user who put this comment.
+ * A commit comment can be on a specific line of a specific file, if so, this field points to the line number in the
+ * file. Otherwise -1.
*
- * @return the user
- * @throws IOException
- * the io exception
+ * @return the line
*/
- public GHUser getUser() throws IOException {
- return owner == null || owner.isOffline() ? user : owner.root().getUser(user.login);
+ public int getLine() {
+ return line != null ? line : -1;
}
/**
- * Gets the commit to which this comment is associated with.
+ * Gets owner.
*
- * @return the commit
- * @throws IOException
- * the io exception
+ * @return the owner
*/
- public GHCommit getCommit() throws IOException {
- return getOwner().getCommit(getSHA1());
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getOwner() {
+ return owner;
}
/**
- * Updates the body of the commit message.
+ * A commit comment can be on a specific line of a specific file, if so, this field points to a file. Otherwise
+ * null.
*
- * @param body
- * the body
- * @throws IOException
- * the io exception
+ * @return the path
*/
- public void update(String body) throws IOException {
- owner.root()
- .createRequest()
- .method("PATCH")
- .with("body", body)
- .withUrlPath(getApiTail())
- .fetch(GHCommitComment.class);
- this.body = body;
+ public String getPath() {
+ return path;
}
/**
- * Creates the reaction.
+ * Gets sha 1.
*
- * @param content
- * the content
- * @return the GH reaction
- * @throws IOException
- * Signals that an I/O exception has occurred.
+ * @return the sha 1
*/
- @Preview(SQUIRREL_GIRL)
- public GHReaction createReaction(ReactionContent content) throws IOException {
- return owner.root()
- .createRequest()
- .method("POST")
- .withPreview(SQUIRREL_GIRL)
- .with("content", content.getContent())
- .withUrlPath(getApiTail() + "/reactions")
- .fetch(GHReaction.class);
+ public String getSHA1() {
+ return commitId;
}
/**
- * Delete reaction.
+ * Gets the user who put this comment.
*
- * @param reaction
- * the reaction
+ * @return the user
* @throws IOException
- * Signals that an I/O exception has occurred.
+ * the io exception
*/
- public void deleteReaction(GHReaction reaction) throws IOException {
- owner.root()
- .createRequest()
- .method("DELETE")
- .withUrlPath(getApiTail(), "reactions", String.valueOf(reaction.getId()))
- .send();
+ public GHUser getUser() throws IOException {
+ return owner == null || owner.isOffline() ? user : owner.root().getUser(user.login);
}
/**
@@ -174,23 +169,29 @@ public void deleteReaction(GHReaction reaction) throws IOException {
*
* @return the paged iterable
*/
- @Preview(SQUIRREL_GIRL)
public PagedIterable listReactions() {
return owner.root()
.createRequest()
- .withPreview(SQUIRREL_GIRL)
.withUrlPath(getApiTail() + "/reactions")
.toIterable(GHReaction[].class, item -> owner.root());
}
/**
- * Deletes this comment.
+ * Updates the body of the commit message.
*
+ * @param body
+ * the body
* @throws IOException
* the io exception
*/
- public void delete() throws IOException {
- owner.root().createRequest().method("DELETE").withUrlPath(getApiTail()).send();
+ public void update(String body) throws IOException {
+ owner.root()
+ .createRequest()
+ .method("PATCH")
+ .with("body", body)
+ .withUrlPath(getApiTail())
+ .fetch(GHCommitComment.class);
+ this.body = body;
}
private String getApiTail() {
diff --git a/src/main/java/org/kohsuke/github/GHCommitFileIterable.java b/src/main/java/org/kohsuke/github/GHCommitFileIterable.java
index 8a3f02a6fe..808f036017 100644
--- a/src/main/java/org/kohsuke/github/GHCommitFileIterable.java
+++ b/src/main/java/org/kohsuke/github/GHCommitFileIterable.java
@@ -21,9 +21,9 @@ class GHCommitFileIterable extends PagedIterable {
*/
private static final int GH_FILE_LIMIT_PER_COMMIT_PAGE = 300;
+ private final File[] files;
private final GHRepository owner;
private final String sha;
- private final File[] files;
/**
* Instantiates a new GH commit iterable.
diff --git a/src/main/java/org/kohsuke/github/GHCommitPointer.java b/src/main/java/org/kohsuke/github/GHCommitPointer.java
index 870872ad6f..41cb15114c 100644
--- a/src/main/java/org/kohsuke/github/GHCommitPointer.java
+++ b/src/main/java/org/kohsuke/github/GHCommitPointer.java
@@ -34,32 +34,35 @@
* @author Kohsuke Kawaguchi
*/
public class GHCommitPointer {
+
private String ref, sha, label;
- private GHUser user;
+
private GHRepository repo;
+ private GHUser user;
+ /**
+ * Create default GHCommitPointer instance
+ */
+ public GHCommitPointer() {
+ }
/**
- * This points to the user who owns the {@link #getRepository()}.
+ * Obtains the commit that this pointer is referring to.
*
- * @return the user
+ * @return the commit
* @throws IOException
* the io exception
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHUser getUser() throws IOException {
- if (user != null)
- return user.root().intern(user);
- return user;
+ public GHCommit getCommit() throws IOException {
+ return getRepository().getCommit(getSha());
}
/**
- * The repository that contains the commit.
+ * String that looks like "USERNAME:REF".
*
- * @return the repository
+ * @return the label
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHRepository getRepository() {
- return repo;
+ public String getLabel() {
+ return label;
}
/**
@@ -72,32 +75,34 @@ public String getRef() {
}
/**
- * SHA1 of the commit.
+ * The repository that contains the commit.
*
- * @return the sha
+ * @return the repository
*/
- public String getSha() {
- return sha;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getRepository() {
+ return repo;
}
/**
- * String that looks like "USERNAME:REF".
+ * SHA1 of the commit.
*
- * @return the label
+ * @return the sha
*/
- public String getLabel() {
- return label;
+ public String getSha() {
+ return sha;
}
/**
- * Obtains the commit that this pointer is referring to.
+ * This points to the user who owns the {@link #getRepository()}.
*
- * @return the commit
- * @throws IOException
- * the io exception
+ * @return the user
*/
- public GHCommit getCommit() throws IOException {
- return getRepository().getCommit(getSha());
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHUser getUser() {
+ if (user != null)
+ return user.root().intern(user);
+ return user;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHCommitQueryBuilder.java b/src/main/java/org/kohsuke/github/GHCommitQueryBuilder.java
index e9b8f0cca8..8a03adb62f 100644
--- a/src/main/java/org/kohsuke/github/GHCommitQueryBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHCommitQueryBuilder.java
@@ -1,5 +1,6 @@
package org.kohsuke.github;
+import java.time.Instant;
import java.util.Date;
// TODO: Auto-generated Javadoc
@@ -20,8 +21,8 @@
* @see GHRepository#queryCommits() GHRepository#queryCommits()
*/
public class GHCommitQueryBuilder {
- private final Requester req;
private final GHRepository repo;
+ private final Requester req;
/**
* Instantiates a new GH commit query builder.
@@ -46,18 +47,6 @@ public GHCommitQueryBuilder author(String author) {
return this;
}
- /**
- * Only commits containing this file path will be returned.
- *
- * @param path
- * the path
- * @return the gh commit query builder
- */
- public GHCommitQueryBuilder path(String path) {
- req.with("path", path);
- return this;
- }
-
/**
* Specifies the SHA1 commit / tag / branch / etc to start listing commits from.
*
@@ -70,6 +59,15 @@ public GHCommitQueryBuilder from(String ref) {
return this;
}
+ /**
+ * Lists up the commits with the criteria built so far.
+ *
+ * @return the paged iterable
+ */
+ public PagedIterable list() {
+ return req.withUrlPath(repo.getApiTailUrl("commits")).toIterable(GHCommit[].class, item -> item.wrapUp(repo));
+ }
+
/**
* Page size gh commit query builder.
*
@@ -82,15 +80,40 @@ public GHCommitQueryBuilder pageSize(int pageSize) {
return this;
}
+ /**
+ * Only commits containing this file path will be returned.
+ *
+ * @param path
+ * the path
+ * @return the gh commit query builder
+ */
+ public GHCommitQueryBuilder path(String path) {
+ req.with("path", path);
+ return this;
+ }
+
/**
* Only commits after this date will be returned.
*
* @param dt
* the dt
* @return the gh commit query builder
+ * @deprecated use {@link #since(Instant)}
*/
+ @Deprecated
public GHCommitQueryBuilder since(Date dt) {
- req.with("since", GitHubClient.printDate(dt));
+ return since(GitHubClient.toInstantOrNull(dt));
+ }
+
+ /**
+ * Only commits after this date will be returned.
+ *
+ * @param dt
+ * the dt
+ * @return the gh commit query builder
+ */
+ public GHCommitQueryBuilder since(Instant dt) {
+ req.with("since", GitHubClient.printInstant(dt));
return this;
}
@@ -102,7 +125,7 @@ public GHCommitQueryBuilder since(Date dt) {
* @return the gh commit query builder
*/
public GHCommitQueryBuilder since(long timestamp) {
- return since(new Date(timestamp));
+ return since(Instant.ofEpochMilli(timestamp));
}
/**
@@ -111,29 +134,33 @@ public GHCommitQueryBuilder since(long timestamp) {
* @param dt
* the dt
* @return the gh commit query builder
+ * @deprecated use {@link #until(Instant)}
*/
+ @Deprecated
public GHCommitQueryBuilder until(Date dt) {
- req.with("until", GitHubClient.printDate(dt));
- return this;
+ return until(GitHubClient.toInstantOrNull(dt));
}
/**
* Only commits before this date will be returned.
*
- * @param timestamp
- * the timestamp
+ * @param dt
+ * the dt
* @return the gh commit query builder
*/
- public GHCommitQueryBuilder until(long timestamp) {
- return until(new Date(timestamp));
+ public GHCommitQueryBuilder until(Instant dt) {
+ req.with("until", GitHubClient.printInstant(dt));
+ return this;
}
/**
- * Lists up the commits with the criteria built so far.
+ * Only commits before this date will be returned.
*
- * @return the paged iterable
+ * @param timestamp
+ * the timestamp
+ * @return the gh commit query builder
*/
- public PagedIterable list() {
- return req.withUrlPath(repo.getApiTailUrl("commits")).toIterable(GHCommit[].class, item -> item.wrapUp(repo));
+ public GHCommitQueryBuilder until(long timestamp) {
+ return until(Instant.ofEpochMilli(timestamp));
}
}
diff --git a/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java b/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java
index 7d166bc9b4..3a1ddbffce 100644
--- a/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java
@@ -1,7 +1,7 @@
package org.kohsuke.github;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.apache.commons.lang3.StringUtils;
-import org.kohsuke.github.internal.Previews;
import java.io.IOException;
@@ -12,74 +12,83 @@
* @author Marc de Verdelhan
* @see GitHub#searchCommits() GitHub#searchCommits()
*/
-@Preview(Previews.CLOAK)
public class GHCommitSearchBuilder extends GHSearchBuilder {
/**
- * Instantiates a new GH commit search builder.
- *
- * @param root
- * the root
+ * The enum Sort.
*/
- GHCommitSearchBuilder(GitHub root) {
- super(root, CommitSearchResult.class);
- req.withPreview(Previews.CLOAK);
+ public enum Sort {
+
+ /** The author date. */
+ AUTHOR_DATE,
+ /** The committer date. */
+ COMMITTER_DATE
}
- /**
- * Search terms.
- *
- * @param term
- * the term
- * @return the GH commit search builder
- */
- public GHCommitSearchBuilder q(String term) {
- super.q(term);
- return this;
+ @SuppressFBWarnings(
+ value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
+ justification = "JSON API")
+ private static class CommitSearchResult extends SearchResult {
+ private GHCommit[] items;
+
+ @Override
+ GHCommit[] getItems(GitHub root) {
+ for (GHCommit commit : items) {
+ String repoName = getRepoName(commit.url);
+ try {
+ GHRepository repo = root.getRepository(repoName);
+ commit.wrapUp(repo);
+ } catch (IOException ioe) {
+ }
+ }
+ return items;
+ }
}
/**
- * Author gh commit search builder.
- *
- * @param v
- * the v
- * @return the gh commit search builder
+ * @param commitUrl
+ * a commit URL
+ * @return the repo name ("username/reponame")
*/
- public GHCommitSearchBuilder author(String v) {
- return q("author:" + v);
+ private static String getRepoName(String commitUrl) {
+ if (StringUtils.isBlank(commitUrl)) {
+ return null;
+ }
+ int indexOfUsername = (GitHubClient.GITHUB_URL + "/repos/").length();
+ String[] tokens = commitUrl.substring(indexOfUsername).split("/", 3);
+ return tokens[0] + '/' + tokens[1];
}
/**
- * Committer gh commit search builder.
+ * Instantiates a new GH commit search builder.
*
- * @param v
- * the v
- * @return the gh commit search builder
+ * @param root
+ * the root
*/
- public GHCommitSearchBuilder committer(String v) {
- return q("committer:" + v);
+ GHCommitSearchBuilder(GitHub root) {
+ super(root, CommitSearchResult.class);
}
/**
- * Author name gh commit search builder.
+ * Author gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder authorName(String v) {
- return q("author-name:" + v);
+ public GHCommitSearchBuilder author(String v) {
+ return q("author:" + v);
}
/**
- * Committer name gh commit search builder.
+ * Author date gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder committerName(String v) {
- return q("committer-name:" + v);
+ public GHCommitSearchBuilder authorDate(String v) {
+ return q("author-date:" + v);
}
/**
@@ -94,25 +103,25 @@ public GHCommitSearchBuilder authorEmail(String v) {
}
/**
- * Committer email gh commit search builder.
+ * Author name gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder committerEmail(String v) {
- return q("committer-email:" + v);
+ public GHCommitSearchBuilder authorName(String v) {
+ return q("author-name:" + v);
}
/**
- * Author date gh commit search builder.
+ * Committer gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder authorDate(String v) {
- return q("author-date:" + v);
+ public GHCommitSearchBuilder committer(String v) {
+ return q("committer:" + v);
}
/**
@@ -127,69 +136,70 @@ public GHCommitSearchBuilder committerDate(String v) {
}
/**
- * Merge gh commit search builder.
+ * Committer email gh commit search builder.
*
- * @param merge
- * the merge
+ * @param v
+ * the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder merge(boolean merge) {
- return q("merge:" + Boolean.valueOf(merge).toString().toLowerCase());
+ public GHCommitSearchBuilder committerEmail(String v) {
+ return q("committer-email:" + v);
}
/**
- * Hash gh commit search builder.
+ * Committer name gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder hash(String v) {
- return q("hash:" + v);
+ public GHCommitSearchBuilder committerName(String v) {
+ return q("committer-name:" + v);
}
/**
- * Parent gh commit search builder.
+ * Hash gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder parent(String v) {
- return q("parent:" + v);
+ public GHCommitSearchBuilder hash(String v) {
+ return q("hash:" + v);
}
/**
- * Tree gh commit search builder.
+ * Is gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder tree(String v) {
- return q("tree:" + v);
+ public GHCommitSearchBuilder is(String v) {
+ return q("is:" + v);
}
/**
- * Is gh commit search builder.
+ * Merge gh commit search builder.
*
- * @param v
- * the v
+ * @param merge
+ * the merge
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder is(String v) {
- return q("is:" + v);
+ public GHCommitSearchBuilder merge(boolean merge) {
+ return q("merge:" + Boolean.valueOf(merge).toString().toLowerCase());
}
/**
- * User gh commit search builder.
+ * Order gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder user(String v) {
- return q("user:" + v);
+ public GHCommitSearchBuilder order(GHDirection v) {
+ req.with("order", v);
+ return this;
}
/**
@@ -204,26 +214,37 @@ public GHCommitSearchBuilder org(String v) {
}
/**
- * Repo gh commit search builder.
+ * Parent gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder repo(String v) {
- return q("repo:" + v);
+ public GHCommitSearchBuilder parent(String v) {
+ return q("parent:" + v);
}
/**
- * Order gh commit search builder.
+ * Search terms.
+ *
+ * @param term
+ * the term
+ * @return the GH commit search builder
+ */
+ public GHCommitSearchBuilder q(String term) {
+ super.q(term);
+ return this;
+ }
+
+ /**
+ * Repo gh commit search builder.
*
* @param v
* the v
* @return the gh commit search builder
*/
- public GHCommitSearchBuilder order(GHDirection v) {
- req.with("order", v);
- return this;
+ public GHCommitSearchBuilder repo(String v) {
+ return q("repo:" + v);
}
/**
@@ -239,45 +260,25 @@ public GHCommitSearchBuilder sort(Sort sort) {
}
/**
- * The enum Sort.
+ * Tree gh commit search builder.
+ *
+ * @param v
+ * the v
+ * @return the gh commit search builder
*/
- public enum Sort {
-
- /** The author date. */
- AUTHOR_DATE,
- /** The committer date. */
- COMMITTER_DATE
- }
-
- private static class CommitSearchResult extends SearchResult {
- private GHCommit[] items;
-
- @Override
- GHCommit[] getItems(GitHub root) {
- for (GHCommit commit : items) {
- String repoName = getRepoName(commit.url);
- try {
- GHRepository repo = root.getRepository(repoName);
- commit.wrapUp(repo);
- } catch (IOException ioe) {
- }
- }
- return items;
- }
+ public GHCommitSearchBuilder tree(String v) {
+ return q("tree:" + v);
}
/**
- * @param commitUrl
- * a commit URL
- * @return the repo name ("username/reponame")
+ * User gh commit search builder.
+ *
+ * @param v
+ * the v
+ * @return the gh commit search builder
*/
- private static String getRepoName(String commitUrl) {
- if (StringUtils.isBlank(commitUrl)) {
- return null;
- }
- int indexOfUsername = (GitHubClient.GITHUB_URL + "/repos/").length();
- String[] tokens = commitUrl.substring(indexOfUsername).split("/", 3);
- return tokens[0] + '/' + tokens[1];
+ public GHCommitSearchBuilder user(String v) {
+ return q("user:" + v);
}
/**
diff --git a/src/main/java/org/kohsuke/github/GHCommitState.java b/src/main/java/org/kohsuke/github/GHCommitState.java
index bdefc01446..7a89a3dc72 100644
--- a/src/main/java/org/kohsuke/github/GHCommitState.java
+++ b/src/main/java/org/kohsuke/github/GHCommitState.java
@@ -9,12 +9,12 @@
*/
public enum GHCommitState {
- /** The pending. */
- PENDING,
- /** The success. */
- SUCCESS,
/** The error. */
ERROR,
/** The failure. */
- FAILURE
+ FAILURE,
+ /** The pending. */
+ PENDING,
+ /** The success. */
+ SUCCESS
}
diff --git a/src/main/java/org/kohsuke/github/GHCommitStatus.java b/src/main/java/org/kohsuke/github/GHCommitStatus.java
index 45a5d94360..fe61d61ea7 100644
--- a/src/main/java/org/kohsuke/github/GHCommitStatus.java
+++ b/src/main/java/org/kohsuke/github/GHCommitStatus.java
@@ -1,8 +1,5 @@
package org.kohsuke.github;
-import java.io.IOException;
-import java.net.URL;
-
// TODO: Auto-generated Javadoc
/**
* Represents a status of a commit.
@@ -15,40 +12,40 @@
*/
public class GHCommitStatus extends GHObject {
- /** The state. */
- String state;
-
- /** The description. */
- String target_url, description;
-
/** The context. */
String context;
/** The creator. */
GHUser creator;
+ /** The state. */
+ String state;
+
+ /** The description. */
+ String targetUrl, description;
+
/**
- * Gets state.
+ * Create default GHCommitStatus instance
+ */
+ public GHCommitStatus() {
+ }
+
+ /**
+ * Gets context.
*
- * @return the state
+ * @return the context
*/
- public GHCommitState getState() {
- for (GHCommitState s : GHCommitState.values()) {
- if (s.name().equalsIgnoreCase(state))
- return s;
- }
- throw new IllegalStateException("Unexpected state: " + state);
+ public String getContext() {
+ return context;
}
/**
- * The URL that this status is linked to.
- *
- * This is the URL specified when creating a commit status.
+ * Gets creator.
*
- * @return the target url
+ * @return the creator
*/
- public String getTargetUrl() {
- return target_url;
+ public GHUser getCreator() {
+ return root().intern(creator);
}
/**
@@ -61,33 +58,27 @@ public String getDescription() {
}
/**
- * Gets creator.
+ * Gets state.
*
- * @return the creator
- * @throws IOException
- * the io exception
+ * @return the state
*/
- public GHUser getCreator() throws IOException {
- return root().intern(creator);
+ public GHCommitState getState() {
+ for (GHCommitState s : GHCommitState.values()) {
+ if (s.name().equalsIgnoreCase(state))
+ return s;
+ }
+ throw new IllegalStateException("Unexpected state: " + state);
}
/**
- * Gets context.
+ * The URL that this status is linked to.
+ *
+ * This is the URL specified when creating a commit status.
*
- * @return the context
+ * @return the target url
*/
- public String getContext() {
- return context;
+ public String getTargetUrl() {
+ return targetUrl;
}
- /**
- * Gets the html url.
- *
- * @return the html url
- * @deprecated This object has no HTML URL.
- */
- @Override
- public URL getHtmlUrl() {
- return null;
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHCompare.java b/src/main/java/org/kohsuke/github/GHCompare.java
index 08c6f051b1..48340fda36 100644
--- a/src/main/java/org/kohsuke/github/GHCompare.java
+++ b/src/main/java/org/kohsuke/github/GHCompare.java
@@ -1,7 +1,6 @@
package org.kohsuke.github;
import com.fasterxml.jackson.annotation.JacksonInject;
-import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
@@ -19,214 +18,6 @@
*/
public class GHCompare {
- private String url, html_url, permalink_url, diff_url, patch_url;
- private Status status;
- private int ahead_by, behind_by, total_commits;
- private Commit base_commit, merge_base_commit;
- private Commit[] commits;
- private GHCommit.File[] files;
-
- private GHRepository owner;
-
- @JacksonInject("GHCompare_usePaginatedCommits")
- private boolean usePaginatedCommits;
-
- /**
- * Gets url.
- *
- * @return the url
- */
- public URL getUrl() {
- return GitHubClient.parseURL(url);
- }
-
- /**
- * Gets html url.
- *
- * @return the html url
- */
- public URL getHtmlUrl() {
- return GitHubClient.parseURL(html_url);
- }
-
- /**
- * Gets permalink url.
- *
- * @return the permalink url
- */
- public URL getPermalinkUrl() {
- return GitHubClient.parseURL(permalink_url);
- }
-
- /**
- * Gets diff url.
- *
- * @return the diff url
- */
- public URL getDiffUrl() {
- return GitHubClient.parseURL(diff_url);
- }
-
- /**
- * Gets patch url.
- *
- * @return the patch url
- */
- public URL getPatchUrl() {
- return GitHubClient.parseURL(patch_url);
- }
-
- /**
- * Gets status.
- *
- * @return the status
- */
- public Status getStatus() {
- return status;
- }
-
- /**
- * Gets ahead by.
- *
- * @return the ahead by
- */
- public int getAheadBy() {
- return ahead_by;
- }
-
- /**
- * Gets behind by.
- *
- * @return the behind by
- */
- public int getBehindBy() {
- return behind_by;
- }
-
- /**
- * Gets total commits.
- *
- * @return the total commits
- */
- public int getTotalCommits() {
- return total_commits;
- }
-
- /**
- * Gets base commit.
- *
- * @return the base commit
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public Commit getBaseCommit() {
- return base_commit;
- }
-
- /**
- * Gets merge base commit.
- *
- * @return the merge base commit
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public Commit getMergeBaseCommit() {
- return merge_base_commit;
- }
-
- /**
- * Gets an array of commits.
- *
- * By default, the commit list is limited to 250 results.
- *
- * Since
- * 2021-03-22,
- * compare supports pagination of commits. This makes the initial {@link GHCompare} response return faster and
- * supports comparisons with more than 250 commits. To read commits progressively using pagination, set
- * {@link GHRepository#setCompareUsePaginatedCommits(boolean)} to true before calling
- * {@link GHRepository#getCompare(String, String)}.
- *
- * @return A copy of the array being stored in the class.
- */
- public Commit[] getCommits() {
- try {
- return listCommits().withPageSize(100).toArray();
- } catch (IOException e) {
- throw new GHException(e.getMessage(), e);
- }
- }
-
- /**
- * Iterable of commits for this comparison.
- *
- * By default, the commit list is limited to 250 results.
- *
- * Since
- * 2021-03-22,
- * compare supports pagination of commits. This makes the initial {@link GHCompare} response return faster and
- * supports comparisons with more than 250 commits. To read commits progressively using pagination, set
- * {@link GHRepository#setCompareUsePaginatedCommits(boolean)} to true before calling
- * {@link GHRepository#getCompare(String, String)}.
- *
- * @return iterable of commits
- */
- public PagedIterable listCommits() {
- if (usePaginatedCommits) {
- return new GHCompareCommitsIterable();
- } else {
- // if not using paginated commits, adapt the returned commits array
- return new PagedIterable() {
- @Nonnull
- @Override
- public PagedIterator _iterator(int pageSize) {
- return new PagedIterator<>(Collections.singleton(commits).iterator(), null);
- }
- };
- }
- }
-
- /**
- * Gets an array of files.
- *
- * By default, the file array is limited to 300 results. To retrieve the full list of files, iterate over each
- * commit returned by {@link GHCompare#listCommits} and use {@link GHCommit#listFiles} to get the files for each
- * commit.
- *
- * @return A copy of the array being stored in the class.
- */
- public GHCommit.File[] getFiles() {
- GHCommit.File[] newValue = new GHCommit.File[files.length];
- System.arraycopy(files, 0, newValue, 0, files.length);
- return newValue;
- }
-
- /**
- * Wrap gh compare.
- *
- * @param owner
- * the owner
- * @return the gh compare
- */
- @Deprecated
- public GHCompare wrap(GHRepository owner) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Wrap gh compare.
- *
- * @param owner
- * the owner
- * @return the gh compare
- */
- GHCompare lateBind(GHRepository owner) {
- this.owner = owner;
- for (Commit commit : commits) {
- commit.wrapUp(owner);
- }
- merge_base_commit.wrapUp(owner);
- base_commit.wrapUp(owner);
- return this;
- }
-
/**
* Compare commits had a child commit element with additional details we want to capture. This extension of GHCommit
* provides that.
@@ -237,6 +28,12 @@ public static class Commit extends GHCommit {
private InnerCommit commit;
+ /**
+ * Create default Commit instance
+ */
+ public Commit() {
+ }
+
/**
* Gets commit.
*
@@ -251,26 +48,33 @@ public InnerCommit getCommit() {
* The type InnerCommit.
*/
public static class InnerCommit {
- private String url, sha, message;
- private User author, committer;
+
+ private GitUser author, committer;
+
private Tree tree;
+ private String url, sha, message;
+ /**
+ * Create default InnerCommit instance
+ */
+ public InnerCommit() {
+ }
/**
- * Gets url.
+ * Gets author.
*
- * @return the url
+ * @return the author
*/
- public String getUrl() {
- return url;
+ public GitUser getAuthor() {
+ return author;
}
/**
- * Gets sha.
+ * Gets committer.
*
- * @return the sha
+ * @return the committer
*/
- public String getSha() {
- return sha;
+ public GitUser getCommitter() {
+ return committer;
}
/**
@@ -283,48 +87,57 @@ public String getMessage() {
}
/**
- * Gets author.
+ * Gets sha.
*
- * @return the author
+ * @return the sha
*/
- @WithBridgeMethods(value = User.class, castRequired = true)
- public GitUser getAuthor() {
- return author;
+ public String getSha() {
+ return sha;
}
/**
- * Gets committer.
+ * Gets tree.
*
- * @return the committer
+ * @return the tree
*/
- @WithBridgeMethods(value = User.class, castRequired = true)
- public GitUser getCommitter() {
- return committer;
+ public Tree getTree() {
+ return tree;
}
/**
- * Gets tree.
+ * Gets url.
*
- * @return the tree
+ * @return the url
*/
- public Tree getTree() {
- return tree;
+ public String getUrl() {
+ return url;
}
}
+ /**
+ * The enum Status.
+ */
+ public static enum Status {
+ /** The ahead. */
+ ahead,
+ /** The behind. */
+ behind,
+ /** The diverged. */
+ diverged,
+ /** The identical. */
+ identical
+ }
/**
* The type Tree.
*/
public static class Tree {
+
private String url, sha;
/**
- * Gets url.
- *
- * @return the url
+ * Create default Tree instance
*/
- public String getUrl() {
- return url;
+ public Tree() {
}
/**
@@ -335,31 +148,16 @@ public String getUrl() {
public String getSha() {
return sha;
}
- }
-
- /**
- * The type User.
- *
- * @deprecated use {@link GitUser} instead.
- */
- public static class User extends GitUser {
- }
-
- /**
- * The enum Status.
- */
- public static enum Status {
- /** The behind. */
- behind,
- /** The ahead. */
- ahead,
- /** The identical. */
- identical,
- /** The diverged. */
- diverged
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public String getUrl() {
+ return url;
+ }
}
-
/**
* Iterable for commit listing.
*/
@@ -421,4 +219,209 @@ public Commit[] next() {
};
}
}
+ private int aheadBy, behindBy, totalCommits;
+ private Commit baseCommit, mergeBaseCommit;
+
+ private Commit[] commits;
+
+ private GHCommit.File[] files;
+
+ private GHRepository owner;
+
+ private Status status;
+
+ private String url, htmlUrl, permalinkUrl, diffUrl, patchUrl;
+
+ @JacksonInject("GHCompare_usePaginatedCommits")
+ private boolean usePaginatedCommits;
+
+ /**
+ * Create default GHCompare instance
+ */
+ public GHCompare() {
+ }
+
+ /**
+ * Gets ahead by.
+ *
+ * @return the ahead by
+ */
+ public int getAheadBy() {
+ return aheadBy;
+ }
+
+ /**
+ * Gets base commit.
+ *
+ * @return the base commit
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public Commit getBaseCommit() {
+ return baseCommit;
+ }
+
+ /**
+ * Gets behind by.
+ *
+ * @return the behind by
+ */
+ public int getBehindBy() {
+ return behindBy;
+ }
+
+ /**
+ * Gets an array of commits.
+ *
+ * By default, the commit list is limited to 250 results.
+ *
+ * Since
+ * 2021-03-22,
+ * compare supports pagination of commits. This makes the initial {@link GHCompare} response return faster and
+ * supports comparisons with more than 250 commits. To read commits progressively using pagination, set
+ * {@link GHRepository#setCompareUsePaginatedCommits(boolean)} to true before calling
+ * {@link GHRepository#getCompare(String, String)}.
+ *
+ * @return A copy of the array being stored in the class.
+ */
+ public Commit[] getCommits() {
+ try {
+ return listCommits().withPageSize(100).toArray();
+ } catch (IOException e) {
+ throw new GHException(e.getMessage(), e);
+ }
+ }
+
+ /**
+ * Gets diff url.
+ *
+ * @return the diff url
+ */
+ public URL getDiffUrl() {
+ return GitHubClient.parseURL(diffUrl);
+ }
+
+ /**
+ * Gets an array of files.
+ *
+ * By default, the file array is limited to 300 results. To retrieve the full list of files, iterate over each
+ * commit returned by {@link GHCompare#listCommits} and use {@link GHCommit#listFiles} to get the files for each
+ * commit.
+ *
+ * @return A copy of the array being stored in the class.
+ */
+ public GHCommit.File[] getFiles() {
+ GHCommit.File[] newValue = new GHCommit.File[files.length];
+ System.arraycopy(files, 0, newValue, 0, files.length);
+ return newValue;
+ }
+
+ /**
+ * Gets html url.
+ *
+ * @return the html url
+ */
+ public URL getHtmlUrl() {
+ return GitHubClient.parseURL(htmlUrl);
+ }
+
+ /**
+ * Gets merge base commit.
+ *
+ * @return the merge base commit
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public Commit getMergeBaseCommit() {
+ return mergeBaseCommit;
+ }
+
+ /**
+ * Gets patch url.
+ *
+ * @return the patch url
+ */
+ public URL getPatchUrl() {
+ return GitHubClient.parseURL(patchUrl);
+ }
+
+ /**
+ * Gets permalink url.
+ *
+ * @return the permalink url
+ */
+ public URL getPermalinkUrl() {
+ return GitHubClient.parseURL(permalinkUrl);
+ }
+
+ /**
+ * Gets status.
+ *
+ * @return the status
+ */
+ public Status getStatus() {
+ return status;
+ }
+
+ /**
+ * Gets total commits.
+ *
+ * @return the total commits
+ */
+ public int getTotalCommits() {
+ return totalCommits;
+ }
+
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public URL getUrl() {
+ return GitHubClient.parseURL(url);
+ }
+
+ /**
+ * Iterable of commits for this comparison.
+ *
+ * By default, the commit list is limited to 250 results.
+ *
+ * Since
+ * 2021-03-22,
+ * compare supports pagination of commits. This makes the initial {@link GHCompare} response return faster and
+ * supports comparisons with more than 250 commits. To read commits progressively using pagination, set
+ * {@link GHRepository#setCompareUsePaginatedCommits(boolean)} to true before calling
+ * {@link GHRepository#getCompare(String, String)}.
+ *
+ * @return iterable of commits
+ */
+ public PagedIterable listCommits() {
+ if (usePaginatedCommits) {
+ return new GHCompareCommitsIterable();
+ } else {
+ // if not using paginated commits, adapt the returned commits array
+ return new PagedIterable() {
+ @Nonnull
+ @Override
+ public PagedIterator _iterator(int pageSize) {
+ return new PagedIterator<>(Collections.singleton(commits).iterator(), null);
+ }
+ };
+ }
+ }
+
+ /**
+ * Wrap gh compare.
+ *
+ * @param owner
+ * the owner
+ * @return the gh compare
+ */
+ GHCompare lateBind(GHRepository owner) {
+ this.owner = owner;
+ for (Commit commit : commits) {
+ commit.wrapUp(owner);
+ }
+ mergeBaseCommit.wrapUp(owner);
+ baseCommit.wrapUp(owner);
+ return this;
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHContent.java b/src/main/java/org/kohsuke/github/GHContent.java
index c476a89d8c..98d94da4ab 100644
--- a/src/main/java/org/kohsuke/github/GHContent.java
+++ b/src/main/java/org/kohsuke/github/GHContent.java
@@ -17,96 +17,113 @@
*/
@SuppressWarnings({ "UnusedDeclaration" })
public class GHContent extends GitHubInteractiveObject implements Refreshable {
+
+ /**
+ * Gets the api route.
+ *
+ * @param repository
+ * the repository
+ * @param path
+ * the path
+ * @return the api route
+ */
+ static String getApiRoute(GHRepository repository, String path) {
+ return repository.getApiTailUrl("contents/" + path);
+ }
+
+ private String content;
+
+ private String downloadUrl;
+ private String encoding;
+ private String gitUrl; // this is the Blob url
+ private String htmlUrl; // this is the UI
+ private String name;
+ private String path;
/*
* In normal use of this class, repository field is set via wrap(), but in the code search API, there's a nested
* 'repository' field that gets populated from JSON.
*/
private GHRepository repository;
-
- private String type;
- private String encoding;
- private long size;
private String sha;
- private String name;
- private String path;
+ private long size;
private String target;
- private String content;
+ private String type;
private String url; // this is the API url
- private String git_url; // this is the Blob url
- private String html_url; // this is the UI
- private String download_url;
/**
- * Gets owner.
- *
- * @return the owner
+ * Create default GHContent instance
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHRepository getOwner() {
- return repository;
+ public GHContent() {
}
/**
- * Gets type.
+ * Creates a builder that can be used to delete this file.
*
- * @return the type
- */
- public String getType() {
- return type;
- }
-
- /**
- * Gets encoding.
+ *
+ * Unlike the {@link #delete(String)} convenience methods, this builder supports setting the author and committer of
+ * the resulting commit.
*
- * @return the encoding
+ * @return a content deleter
+ * @see GHContentDeleter
*/
- public String getEncoding() {
- return encoding;
+ public GHContentDeleter createDelete() {
+ return new GHContentDeleter(this);
}
/**
- * Gets size.
+ * Creates a builder that can be used to update this file's content.
*
- * @return the size
- */
- public long getSize() {
- return size;
- }
-
- /**
- * Gets sha.
+ *
+ * Unlike the {@link #update(String, String)} convenience methods, this builder supports setting the author and
+ * committer of the resulting commit.
*
- * @return the sha
+ * @return a content updater
+ * @see GHContentUpdater
*/
- public String getSha() {
- return sha;
+ public GHContentUpdater createUpdate() {
+ return new GHContentUpdater(this);
}
/**
- * Gets name.
+ * Delete gh content update response.
*
- * @return the name
+ * @param message
+ * the message
+ * @return the gh content update response
+ * @throws IOException
+ * the io exception
*/
- public String getName() {
- return name;
+ public GHContentUpdateResponse delete(String message) throws IOException {
+ return delete(message, null);
}
/**
- * Gets path.
+ * Delete gh content update response.
*
- * @return the path
+ * @param commitMessage
+ * the commit message
+ * @param branch
+ * the branch
+ * @return the gh content update response
+ * @throws IOException
+ * the io exception
*/
- public String getPath() {
- return path;
- }
+ public GHContentUpdateResponse delete(String commitMessage, String branch) throws IOException {
+ Requester requester = root().createRequest()
+ .method("DELETE")
+ .with("path", path)
+ .with("message", commitMessage)
+ .with("sha", sha);
- /**
- * Gets target of a symlink. This will only be set if {@code "symlink".equals(getType())}
- *
- * @return the target
- */
- public String getTarget() {
- return target;
+ if (branch != null) {
+ requester.with("branch", branch);
+ }
+
+ GHContentUpdateResponse response = requester.withUrlPath(getApiRoute(repository, path))
+ .fetch(GHContentUpdateResponse.class);
+
+ response.getCommit().wrapUp(repository);
+ return response;
}
/**
@@ -121,9 +138,22 @@ public String getTarget() {
* the io exception
* @deprecated Use {@link #read()}
*/
+ @Deprecated
@SuppressFBWarnings("DM_DEFAULT_ENCODING")
public String getContent() throws IOException {
- return new String(Base64.getMimeDecoder().decode(getEncodedContent()));
+ return new String(readDecodedContent());
+ }
+
+ /**
+ * URL to retrieve the raw content of the file. Null if this is a directory.
+ *
+ * @return the download url
+ * @throws IOException
+ * the io exception
+ */
+ public String getDownloadUrl() throws IOException {
+ refresh(downloadUrl);
+ return downloadUrl;
}
/**
@@ -138,18 +168,19 @@ public String getContent() throws IOException {
* the io exception
* @deprecated Use {@link #read()}
*/
+ @Deprecated
public String getEncodedContent() throws IOException {
refresh(content);
return content;
}
/**
- * Gets url.
+ * Gets encoding.
*
- * @return the url
+ * @return the encoding
*/
- public String getUrl() {
- return url;
+ public String getEncoding() {
+ return encoding;
}
/**
@@ -158,7 +189,7 @@ public String getUrl() {
* @return the git url
*/
public String getGitUrl() {
- return git_url;
+ return gitUrl;
}
/**
@@ -167,56 +198,80 @@ public String getGitUrl() {
* @return the html url
*/
public String getHtmlUrl() {
- return html_url;
+ return htmlUrl;
}
/**
- * Retrieves the actual content stored here.
+ * Gets name.
*
- * @return the input stream
- * @throws IOException
- * Signals that an I/O exception has occurred.
+ * @return the name
*/
+ public String getName() {
+ return name;
+ }
+
/**
- * Retrieves the actual bytes of the blob.
+ * Gets owner.
*
- * @return the input stream
- * @throws IOException
- * the io exception
+ * @return the owner
*/
- public InputStream read() throws IOException {
- refresh(content);
- if (encoding.equals("base64")) {
- try {
- Base64.Decoder decoder = Base64.getMimeDecoder();
- return new ByteArrayInputStream(decoder.decode(content.getBytes(StandardCharsets.US_ASCII)));
- } catch (IllegalArgumentException e) {
- throw new AssertionError(e); // US-ASCII is mandatory
- }
- }
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHRepository getOwner() {
+ return repository;
+ }
- throw new UnsupportedOperationException("Unrecognized encoding: " + encoding);
+ /**
+ * Gets path.
+ *
+ * @return the path
+ */
+ public String getPath() {
+ return path;
}
/**
- * URL to retrieve the raw content of the file. Null if this is a directory.
+ * Gets sha.
*
- * @return the download url
- * @throws IOException
- * the io exception
+ * @return the sha
*/
- public String getDownloadUrl() throws IOException {
- refresh(download_url);
- return download_url;
+ public String getSha() {
+ return sha;
}
/**
- * Is file boolean.
+ * Gets size.
*
- * @return the boolean
+ * @return the size
*/
- public boolean isFile() {
- return "file".equals(type);
+ public long getSize() {
+ return size;
+ }
+
+ /**
+ * Gets target of a symlink. This will only be set if {@code "symlink".equals(getType())}
+ *
+ * @return the target
+ */
+ public String getTarget() {
+ return target;
+ }
+
+ /**
+ * Gets type.
+ *
+ * @return the type
+ */
+ public String getType() {
+ return type;
+ }
+
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public String getUrl() {
+ return url;
}
/**
@@ -229,31 +284,50 @@ public boolean isDirectory() {
}
/**
- * Fully populate the data by retrieving missing data.
- *
- * Depending on the original API call where this object is created, it may not contain everything.
+ * Is file boolean.
*
- * @throws IOException
- * the io exception
+ * @return the boolean
*/
- protected synchronized void populate() throws IOException {
- root().createRequest().withUrlPath(url).fetchInto(this);
+ public boolean isFile() {
+ return "file".equals(type);
}
/**
* List immediate children of this directory.
*
* @return the paged iterable
- * @throws IOException
- * the io exception
*/
- public PagedIterable listDirectoryContent() throws IOException {
+ public PagedIterable listDirectoryContent() {
if (!isDirectory())
throw new IllegalStateException(path + " is not a directory");
return root().createRequest().setRawUrlPath(url).toIterable(GHContent[].class, item -> item.wrap(repository));
}
+ /**
+ * Retrieves the actual bytes of the blob.
+ *
+ * @return the input stream
+ * @throws IOException
+ * the io exception
+ */
+ public InputStream read() throws IOException {
+ return new ByteArrayInputStream(readDecodedContent());
+ }
+
+ /**
+ * Fully populate the data by retrieving missing data.
+ *
+ * Depending on the original API call where this object is created, it may not contain everything.
+ *
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ */
+ @Override
+ public synchronized void refresh() throws IOException {
+ root().createRequest().setRawUrlPath(url).fetchInto(this);
+ }
+
/**
* Update gh content update response.
*
@@ -342,58 +416,36 @@ public GHContentUpdateResponse update(byte[] newContentBytes, String commitMessa
}
/**
- * Delete gh content update response.
+ * Retrieves the decoded bytes of the blob.
*
- * @param message
- * the message
- * @return the gh content update response
- * @throws IOException
- * the io exception
- */
- public GHContentUpdateResponse delete(String message) throws IOException {
- return delete(message, null);
- }
-
- /**
- * Delete gh content update response.
- *
- * @param commitMessage
- * the commit message
- * @param branch
- * the branch
- * @return the gh content update response
+ * @return the input stream
* @throws IOException
* the io exception
*/
- public GHContentUpdateResponse delete(String commitMessage, String branch) throws IOException {
- Requester requester = root().createRequest()
- .method("DELETE")
- .with("path", path)
- .with("message", commitMessage)
- .with("sha", sha);
-
- if (branch != null) {
- requester.with("branch", branch);
+ private byte[] readDecodedContent() throws IOException {
+ String encodedContent = getEncodedContent();
+ if (encoding.equals("base64")) {
+ try {
+ Base64.Decoder decoder = Base64.getMimeDecoder();
+ return decoder.decode(encodedContent.getBytes(StandardCharsets.US_ASCII));
+ } catch (IllegalArgumentException e) {
+ throw new AssertionError(e); // US-ASCII is mandatory
+ }
}
- GHContentUpdateResponse response = requester.withUrlPath(getApiRoute(repository, path))
- .fetch(GHContentUpdateResponse.class);
-
- response.getCommit().wrapUp(repository);
- return response;
+ throw new UnsupportedOperationException("Unrecognized encoding: " + encoding);
}
/**
- * Gets the api route.
+ * Fully populate the data by retrieving missing data.
+ *
+ * Depending on the original API call where this object is created, it may not contain everything.
*
- * @param repository
- * the repository
- * @param path
- * the path
- * @return the api route
+ * @throws IOException
+ * the io exception
*/
- static String getApiRoute(GHRepository repository, String path) {
- return repository.getApiTailUrl("contents/" + path);
+ protected synchronized void populate() throws IOException {
+ root().createRequest().withUrlPath(url).fetchInto(this);
}
/**
@@ -407,17 +459,4 @@ GHContent wrap(GHRepository owner) {
this.repository = owner;
return this;
}
-
- /**
- * Fully populate the data by retrieving missing data.
- *
- * Depending on the original API call where this object is created, it may not contain everything.
- *
- * @throws IOException
- * Signals that an I/O exception has occurred.
- */
- @Override
- public synchronized void refresh() throws IOException {
- root().createRequest().setRawUrlPath(url).fetchInto(this);
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHContentBuilder.java b/src/main/java/org/kohsuke/github/GHContentBuilder.java
index 9b24af92b0..3ae0e8a941 100644
--- a/src/main/java/org/kohsuke/github/GHContentBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHContentBuilder.java
@@ -1,8 +1,13 @@
package org.kohsuke.github;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+
import java.io.IOException;
import java.nio.charset.StandardCharsets;
+import java.time.Instant;
import java.util.Base64;
+import java.util.Date;
// TODO: Auto-generated Javadoc
/**
@@ -15,9 +20,22 @@
* @see GHRepository#createContent() GHRepository#createContent()
*/
public final class GHContentBuilder {
+ @JsonInclude(Include.NON_NULL)
+ private static final class UserInfo {
+ private final String date;
+ private final String email;
+ private final String name;
+
+ private UserInfo(String name, String email, Instant date) {
+ this.name = name;
+ this.email = email;
+ this.date = date != null ? GitHubClient.printInstant(date) : null;
+ }
+ }
+
+ private String path;
private final GHRepository repo;
private final Requester req;
- private String path;
/**
* Instantiates a new GH content builder.
@@ -31,15 +49,48 @@ public final class GHContentBuilder {
}
/**
- * Path gh content builder.
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
*
- * @param path
- * the path
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
* @return the gh content builder
*/
- public GHContentBuilder path(String path) {
- this.path = path;
- req.with("path", path);
+ public GHContentBuilder author(String name, String email) {
+ return author(name, email, (Instant) null);
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @param date
+ * the date of the authoring
+ * @return the gh content builder
+ * @deprecated use {@link #author(String, String, Instant)} instead
+ */
+ @Deprecated
+ public GHContentBuilder author(String name, String email, Date date) {
+ return author(name, email, GitHubClient.toInstantOrNull(date));
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @param date
+ * the timestamp for the authoring
+ * @return the gh content builder
+ */
+ public GHContentBuilder author(String name, String email, Instant date) {
+ req.with("author", new UserInfo(name, email, date));
return this;
}
@@ -56,14 +107,65 @@ public GHContentBuilder branch(String branch) {
}
/**
- * Used when updating (but not creating a new content) to specify the blob SHA of the file being replaced.
+ * Commits a new content.
*
- * @param sha
- * the sha
+ * @return the gh content update response
+ * @throws IOException
+ * the io exception
+ */
+ public GHContentUpdateResponse commit() throws IOException {
+ GHContentUpdateResponse response = req.withUrlPath(GHContent.getApiRoute(repo, path))
+ .fetch(GHContentUpdateResponse.class);
+
+ response.getContent().wrap(repo);
+ response.getCommit().wrapUp(repo);
+
+ return response;
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
* @return the gh content builder
*/
- public GHContentBuilder sha(String sha) {
- req.with("sha", sha);
+ public GHContentBuilder committer(String name, String email) {
+ return committer(name, email, (Instant) null);
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @param date
+ * the date of the commit
+ * @return the gh content builder
+ * @deprecated use {@link #committer(String, String, Instant)} instead
+ */
+ @Deprecated
+ public GHContentBuilder committer(String name, String email, Date date) {
+ return committer(name, email, GitHubClient.toInstantOrNull(date));
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @param date
+ * the timestamp of the commit
+ * @return the gh content builder
+ */
+ public GHContentBuilder committer(String name, String email, Instant date) {
+ req.with("committer", new UserInfo(name, email, date));
return this;
}
@@ -74,9 +176,8 @@ public GHContentBuilder sha(String sha) {
* the content
* @return the gh content builder
*/
- public GHContentBuilder content(byte[] content) {
- req.with("content", Base64.getEncoder().encodeToString(content));
- return this;
+ public GHContentBuilder content(String content) {
+ return content(content.getBytes(StandardCharsets.UTF_8));
}
/**
@@ -86,8 +187,9 @@ public GHContentBuilder content(byte[] content) {
* the content
* @return the gh content builder
*/
- public GHContentBuilder content(String content) {
- return content(content.getBytes(StandardCharsets.UTF_8));
+ public GHContentBuilder content(byte[] content) {
+ req.with("content", Base64.getEncoder().encodeToString(content));
+ return this;
}
/**
@@ -103,19 +205,27 @@ public GHContentBuilder message(String commitMessage) {
}
/**
- * Commits a new content.
+ * Path gh content builder.
*
- * @return the gh content update response
- * @throws IOException
- * the io exception
+ * @param path
+ * the path
+ * @return the gh content builder
*/
- public GHContentUpdateResponse commit() throws IOException {
- GHContentUpdateResponse response = req.withUrlPath(GHContent.getApiRoute(repo, path))
- .fetch(GHContentUpdateResponse.class);
-
- response.getContent().wrap(repo);
- response.getCommit().wrapUp(repo);
+ public GHContentBuilder path(String path) {
+ this.path = path;
+ req.with("path", path);
+ return this;
+ }
- return response;
+ /**
+ * Used when updating (but not creating a new content) to specify the blob SHA of the file being replaced.
+ *
+ * @param sha
+ * the sha
+ * @return the gh content builder
+ */
+ public GHContentBuilder sha(String sha) {
+ req.with("sha", sha);
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHContentDeleter.java b/src/main/java/org/kohsuke/github/GHContentDeleter.java
new file mode 100644
index 0000000000..03d4c31e28
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHContentDeleter.java
@@ -0,0 +1,177 @@
+package org.kohsuke.github;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+
+import java.io.IOException;
+import java.time.Instant;
+import java.util.Date;
+
+/**
+ * Builder for deleting repository content with support for specifying author and committer information.
+ *
+ *
+ * Obtain an instance via {@link GHContent#createDelete()}.
+ *
+ * @see GHContent#createDelete()
+ */
+public final class GHContentDeleter {
+ @JsonInclude(Include.NON_NULL)
+ private static final class UserInfo {
+ private final String date;
+ private final String email;
+ private final String name;
+
+ private UserInfo(String name, String email, Instant date) {
+ this.name = name;
+ this.email = email;
+ this.date = date != null ? GitHubClient.printInstant(date) : null;
+ }
+ }
+
+ private final GHContent content;
+ private final Requester req;
+
+ GHContentDeleter(GHContent content) {
+ this.content = content;
+ final GHRepository repository = content.getOwner();
+ this.req = repository.root()
+ .createRequest()
+ .method("DELETE")
+ .inBody()
+ .with("path", content.getPath())
+ .with("sha", content.getSha());
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @return this deleter
+ */
+ public GHContentDeleter author(String name, String email) {
+ return author(name, email, (Instant) null);
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @param date
+ * the date of the authoring
+ * @return this deleter
+ * @deprecated use {@link #author(String, String, Instant)} instead
+ */
+ @Deprecated
+ public GHContentDeleter author(String name, String email, Date date) {
+ return author(name, email, GitHubClient.toInstantOrNull(date));
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @param date
+ * the timestamp for the authoring
+ * @return this deleter
+ */
+ public GHContentDeleter author(String name, String email, Instant date) {
+ req.with("author", new UserInfo(name, email, date));
+ return this;
+ }
+
+ /**
+ * Sets the branch to delete the content from.
+ *
+ * @param branch
+ * the branch name
+ * @return this deleter
+ */
+ public GHContentDeleter branch(String branch) {
+ req.with("branch", branch);
+ return this;
+ }
+
+ /**
+ * Commits the deletion.
+ *
+ * @return the response containing the commit information
+ * @throws IOException
+ * the io exception
+ */
+ public GHContentUpdateResponse commit() throws IOException {
+ final GHRepository repository = content.getOwner();
+ GHContentUpdateResponse response = req.withUrlPath(GHContent.getApiRoute(repository, content.getPath()))
+ .fetch(GHContentUpdateResponse.class);
+
+ response.getCommit().wrapUp(repository);
+ return response;
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @return this deleter
+ */
+ public GHContentDeleter committer(String name, String email) {
+ return committer(name, email, (Instant) null);
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @param date
+ * the date of the commit
+ * @return this deleter
+ * @deprecated use {@link #committer(String, String, Instant)} instead
+ */
+ @Deprecated
+ public GHContentDeleter committer(String name, String email, Date date) {
+ return committer(name, email, GitHubClient.toInstantOrNull(date));
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @param date
+ * the timestamp of the commit
+ * @return this deleter
+ */
+ public GHContentDeleter committer(String name, String email, Instant date) {
+ req.with("committer", new UserInfo(name, email, date));
+ return this;
+ }
+
+ /**
+ * Sets the commit message.
+ *
+ * @param message
+ * the commit message
+ * @return this deleter
+ */
+ public GHContentDeleter message(String message) {
+ req.with("message", message);
+ return this;
+ }
+}
diff --git a/src/main/java/org/kohsuke/github/GHContentSearchBuilder.java b/src/main/java/org/kohsuke/github/GHContentSearchBuilder.java
index 305c61b36a..bdd16cea3e 100644
--- a/src/main/java/org/kohsuke/github/GHContentSearchBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHContentSearchBuilder.java
@@ -10,66 +10,55 @@
public class GHContentSearchBuilder extends GHSearchBuilder {
/**
- * Instantiates a new GH content search builder.
- *
- * @param root
- * the root
+ * The enum Sort.
*/
- GHContentSearchBuilder(GitHub root) {
- super(root, ContentSearchResult.class);
- }
+ public enum Sort {
- /**
- * {@inheritDoc}
- */
- @Override
- public GHContentSearchBuilder q(String term) {
- super.q(term);
- return this;
+ /** The best match. */
+ BEST_MATCH,
+ /** The indexed. */
+ INDEXED
}
- /**
- * {@inheritDoc}
- */
- @Override
- GHContentSearchBuilder q(String qualifier, String value) {
- super.q(qualifier, value);
- return this;
+ private static class ContentSearchResult extends SearchResult {
+ private GHContent[] items;
+
+ @Override
+ GHContent[] getItems(GitHub root) {
+ return items;
+ }
}
/**
- * In gh content search builder.
+ * Instantiates a new GH content search builder.
*
- * @param v
- * the v
- * @return the gh content search builder
+ * @param root
+ * the root
*/
- public GHContentSearchBuilder in(String v) {
- return q("in:" + v);
+ GHContentSearchBuilder(GitHub root) {
+ super(root, ContentSearchResult.class);
}
/**
- * Language gh content search builder.
+ * Extension gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
*/
- public GHContentSearchBuilder language(String v) {
- return q("language:" + v);
+ public GHContentSearchBuilder extension(String v) {
+ return q("extension:" + v);
}
/**
- * Fork gh content search builder.
+ * Filename gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
- * @deprecated use {@link #fork(GHFork)}.
*/
- @Deprecated
- public GHContentSearchBuilder fork(String v) {
- return q("fork", v);
+ public GHContentSearchBuilder filename(String v) {
+ return q("filename:" + v);
}
/**
@@ -89,58 +78,57 @@ public GHContentSearchBuilder fork(GHFork fork) {
}
/**
- * Size gh content search builder.
+ * In gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
*/
- public GHContentSearchBuilder size(String v) {
- return q("size:" + v);
+ public GHContentSearchBuilder in(String v) {
+ return q("in:" + v);
}
/**
- * Path gh content search builder.
+ * Language gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
*/
- public GHContentSearchBuilder path(String v) {
- return q("path:" + v);
+ public GHContentSearchBuilder language(String v) {
+ return q("language:" + v);
}
/**
- * Filename gh content search builder.
+ * Order gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
*/
- public GHContentSearchBuilder filename(String v) {
- return q("filename:" + v);
+ public GHContentSearchBuilder order(GHDirection v) {
+ req.with("order", v);
+ return this;
}
/**
- * Extension gh content search builder.
+ * Path gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
*/
- public GHContentSearchBuilder extension(String v) {
- return q("extension:" + v);
+ public GHContentSearchBuilder path(String v) {
+ return q("path:" + v);
}
/**
- * User gh content search builder.
- *
- * @param v
- * the v
- * @return the gh content search builder
+ * {@inheritDoc}
*/
- public GHContentSearchBuilder user(String v) {
- return q("user:" + v);
+ @Override
+ public GHContentSearchBuilder q(String term) {
+ super.q(term);
+ return this;
}
/**
@@ -155,15 +143,14 @@ public GHContentSearchBuilder repo(String v) {
}
/**
- * Order gh content search builder.
+ * Size gh content search builder.
*
* @param v
* the v
* @return the gh content search builder
*/
- public GHContentSearchBuilder order(GHDirection v) {
- req.with("order", v);
- return this;
+ public GHContentSearchBuilder size(String v) {
+ return q("size:" + v);
}
/**
@@ -183,23 +170,14 @@ public GHContentSearchBuilder sort(GHContentSearchBuilder.Sort sort) {
}
/**
- * The enum Sort.
+ * User gh content search builder.
+ *
+ * @param v
+ * the v
+ * @return the gh content search builder
*/
- public enum Sort {
-
- /** The best match. */
- BEST_MATCH,
- /** The indexed. */
- INDEXED
- }
-
- private static class ContentSearchResult extends SearchResult {
- private GHContent[] items;
-
- @Override
- GHContent[] getItems(GitHub root) {
- return items;
- }
+ public GHContentSearchBuilder user(String v) {
+ return q("user:" + v);
}
/**
@@ -211,4 +189,13 @@ GHContent[] getItems(GitHub root) {
protected String getApiUrl() {
return "/search/code";
}
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ GHContentSearchBuilder q(String qualifier, String value) {
+ super.q(qualifier, value);
+ return this;
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHContentUpdateResponse.java b/src/main/java/org/kohsuke/github/GHContentUpdateResponse.java
index 5da5ecf7cd..193ed2bd1f 100644
--- a/src/main/java/org/kohsuke/github/GHContentUpdateResponse.java
+++ b/src/main/java/org/kohsuke/github/GHContentUpdateResponse.java
@@ -1,6 +1,5 @@
package org.kohsuke.github;
-import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
// TODO: Auto-generated Javadoc
@@ -8,17 +7,14 @@
* The response that is returned when updating repository content.
*/
public class GHContentUpdateResponse {
- private GHContent content;
+
private GitCommit commit;
+ private GHContent content;
/**
- * Gets content.
- *
- * @return the content
+ * Create default GHContentUpdateResponse instance
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHContent getContent() {
- return content;
+ public GHContentUpdateResponse() {
}
/**
@@ -27,14 +23,18 @@ public GHContent getContent() {
* @return the commit
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- @WithBridgeMethods(value = GHCommit.class, adapterMethod = "gitCommitToGHCommit")
public GitCommit getCommit() {
return commit;
}
- @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", justification = "bridge method of getCommit")
- private Object gitCommitToGHCommit(GitCommit commit, Class targetType) {
- return new GHCommit(new GHCommit.ShortInfo(commit));
+ /**
+ * Gets content.
+ *
+ * @return the content
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHContent getContent() {
+ return content;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHContentUpdater.java b/src/main/java/org/kohsuke/github/GHContentUpdater.java
new file mode 100644
index 0000000000..41111af339
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHContentUpdater.java
@@ -0,0 +1,205 @@
+package org.kohsuke.github;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.time.Instant;
+import java.util.Base64;
+import java.util.Date;
+
+/**
+ * Builder for updating existing repository content with support for specifying author and committer information.
+ *
+ *
+ * Obtain an instance via {@link GHContent#createUpdate()}.
+ *
+ * @see GHContent#createUpdate()
+ */
+public final class GHContentUpdater {
+ @JsonInclude(Include.NON_NULL)
+ private static final class UserInfo {
+ private final String date;
+ private final String email;
+ private final String name;
+
+ private UserInfo(String name, String email, Instant date) {
+ this.name = name;
+ this.email = email;
+ this.date = date != null ? GitHubClient.printInstant(date) : null;
+ }
+ }
+
+ private final GHContent content;
+ private String encodedContent;
+ private final Requester req;
+
+ GHContentUpdater(GHContent content) {
+ this.content = content;
+ final GHRepository repository = content.getOwner();
+ this.req = repository.root()
+ .createRequest()
+ .method("PUT")
+ .with("path", content.getPath())
+ .with("sha", content.getSha());
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @return this updater
+ */
+ public GHContentUpdater author(String name, String email) {
+ return author(name, email, (Instant) null);
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @param date
+ * the date of the authoring
+ * @return this updater
+ * @deprecated use {@link #author(String, String, Instant)} instead
+ */
+ @Deprecated
+ public GHContentUpdater author(String name, String email, Date date) {
+ return author(name, email, GitHubClient.toInstantOrNull(date));
+ }
+
+ /**
+ * Configures the author of the commit. If not specified, the authenticated user is used as the author.
+ *
+ * @param name
+ * the name of the author
+ * @param email
+ * the email of the author
+ * @param date
+ * the timestamp for the authoring
+ * @return this updater
+ */
+ public GHContentUpdater author(String name, String email, Instant date) {
+ req.with("author", new UserInfo(name, email, date));
+ return this;
+ }
+
+ /**
+ * Sets the branch to update the content on.
+ *
+ * @param branch
+ * the branch name
+ * @return this updater
+ */
+ public GHContentUpdater branch(String branch) {
+ req.with("branch", branch);
+ return this;
+ }
+
+ /**
+ * Commits the update.
+ *
+ * @return the response containing the updated content and commit information
+ * @throws IOException
+ * the io exception
+ */
+ public GHContentUpdateResponse commit() throws IOException {
+ final GHRepository repository = content.getOwner();
+ GHContentUpdateResponse response = req.withUrlPath(GHContent.getApiRoute(repository, content.getPath()))
+ .fetch(GHContentUpdateResponse.class);
+
+ response.getContent().wrap(repository);
+ response.getCommit().wrapUp(repository);
+
+ return response;
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @return this updater
+ */
+ public GHContentUpdater committer(String name, String email) {
+ return committer(name, email, (Instant) null);
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @param date
+ * the date of the commit
+ * @return this updater
+ * @deprecated use {@link #committer(String, String, Instant)} instead
+ */
+ @Deprecated
+ public GHContentUpdater committer(String name, String email, Date date) {
+ return committer(name, email, GitHubClient.toInstantOrNull(date));
+ }
+
+ /**
+ * Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
+ *
+ * @param name
+ * the name of the committer
+ * @param email
+ * the email of the committer
+ * @param date
+ * the timestamp of the commit
+ * @return this updater
+ */
+ public GHContentUpdater committer(String name, String email, Instant date) {
+ req.with("committer", new UserInfo(name, email, date));
+ return this;
+ }
+
+ /**
+ * Sets the new file content as a string.
+ *
+ * @param newContent
+ * the new content
+ * @return this updater
+ */
+ public GHContentUpdater content(String newContent) {
+ return content(newContent.getBytes(StandardCharsets.UTF_8));
+ }
+
+ /**
+ * Sets the new file content as raw bytes.
+ *
+ * @param newContent
+ * the new content bytes
+ * @return this updater
+ */
+ public GHContentUpdater content(byte[] newContent) {
+ this.encodedContent = Base64.getEncoder().encodeToString(newContent);
+ req.with("content", encodedContent);
+ return this;
+ }
+
+ /**
+ * Sets the commit message.
+ *
+ * @param message
+ * the commit message
+ * @return this updater
+ */
+ public GHContentUpdater message(String message) {
+ req.with("message", message);
+ return this;
+ }
+}
diff --git a/src/main/java/org/kohsuke/github/GHCreateRepositoryBuilder.java b/src/main/java/org/kohsuke/github/GHCreateRepositoryBuilder.java
index f2ec24a14b..c4957b1072 100644
--- a/src/main/java/org/kohsuke/github/GHCreateRepositoryBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHCreateRepositoryBuilder.java
@@ -1,8 +1,7 @@
package org.kohsuke.github;
import java.io.IOException;
-
-import static org.kohsuke.github.internal.Previews.BAPTISTE;
+import java.util.Objects;
// TODO: Auto-generated Javadoc
/**
@@ -34,72 +33,95 @@ public GHCreateRepositoryBuilder(String name, GitHub root, String apiTail) {
}
/**
- * Creates a default .gitignore
+ * If true, create an initial commit with empty README.
*
- * @param language
- * template to base the ignore file on
- * @return a builder to continue with building See https://developer.github.com/v3/repos/#create
+ * @param enabled
+ * true if enabled
+ * @return a builder to continue with building
* @throws IOException
* In case of any networking error or error from the server.
*/
- public GHCreateRepositoryBuilder gitignoreTemplate(String language) throws IOException {
- return with("gitignore_template", language);
+ public GHCreateRepositoryBuilder autoInit(boolean enabled) throws IOException {
+ return with("auto_init", enabled);
}
/**
- * Desired license template to apply.
+ * Creates a repository with all the parameters.
*
- * @param license
- * template to base the license file on
- * @return a builder to continue with building See https://developer.github.com/v3/repos/#create
+ * @return the gh repository
* @throws IOException
- * In case of any networking error or error from the server.
+ * if repository cannot be created
*/
- public GHCreateRepositoryBuilder licenseTemplate(String license) throws IOException {
- return with("license_template", license);
+ public GHRepository create() throws IOException {
+ return done();
}
/**
- * If true, create an initial commit with empty README.
+ * Create repository from template repository.
*
- * @param enabled
- * true if enabled
+ * @param templateRepository
+ * the template repository as a GHRepository
+ * @return a builder to continue with building
+ */
+ public GHCreateRepositoryBuilder fromTemplateRepository(GHRepository templateRepository) {
+ Objects.requireNonNull(templateRepository, "templateRepository cannot be null");
+ if (!templateRepository.isTemplate()) {
+ throw new IllegalArgumentException("The provided repository is not a template repository.");
+ }
+ return fromTemplateRepository(templateRepository.getOwnerName(), templateRepository.getName());
+ }
+
+ /**
+ * Create repository from template repository.
+ *
+ * @param templateOwner
+ * template repository owner
+ * @param templateRepo
+ * template repository
* @return a builder to continue with building
+ */
+ public GHCreateRepositoryBuilder fromTemplateRepository(String templateOwner, String templateRepo) {
+ requester.withUrlPath("/repos/" + templateOwner + "/" + templateRepo + "/generate");
+ return this;
+ }
+
+ /**
+ * Creates a default .gitignore
+ *
+ * @param language
+ * template to base the ignore file on
+ * @return a builder to continue with building See https://developer.github.com/v3/repos/#create
* @throws IOException
* In case of any networking error or error from the server.
*/
- public GHCreateRepositoryBuilder autoInit(boolean enabled) throws IOException {
- return with("auto_init", enabled);
+ public GHCreateRepositoryBuilder gitignoreTemplate(String language) throws IOException {
+ return with("gitignore_template", language);
}
/**
- * The team that gets granted access to this repository. Only valid for creating a repository in an organization.
+ * Include all branches when creating from a template repository
*
- * @param team
- * team to grant access to
+ * @param includeAllBranches
+ * whether or not to include all branches from the template repository
* @return a builder to continue with building
* @throws IOException
* In case of any networking error or error from the server.
*/
- public GHCreateRepositoryBuilder team(GHTeam team) throws IOException {
- if (team != null)
- return with("team_id", team.getId());
- return this;
+ public GHCreateRepositoryBuilder includeAllBranches(boolean includeAllBranches) throws IOException {
+ return with("include_all_branches", includeAllBranches);
}
/**
- * Specifies whether the repository is a template.
+ * Desired license template to apply.
*
- * @param enabled
- * true if enabled
- * @return a builder to continue with building
+ * @param license
+ * template to base the license file on
+ * @return a builder to continue with building See https://developer.github.com/v3/repos/#create
* @throws IOException
* In case of any networking error or error from the server.
- * @deprecated Use {@link #isTemplate(boolean)} method instead
*/
- @Deprecated
- public GHCreateRepositoryBuilder templateRepository(boolean enabled) throws IOException {
- return isTemplate(enabled);
+ public GHCreateRepositoryBuilder licenseTemplate(String license) throws IOException {
+ return with("license_template", license);
}
/**
@@ -116,29 +138,17 @@ public GHCreateRepositoryBuilder owner(String owner) throws IOException {
}
/**
- * Create repository from template repository.
+ * The team that gets granted access to this repository. Only valid for creating a repository in an organization.
*
- * @param templateOwner
- * template repository owner
- * @param templateRepo
- * template repository
+ * @param team
+ * team to grant access to
* @return a builder to continue with building
- * @see GitHub API Previews
- */
- @Preview(BAPTISTE)
- public GHCreateRepositoryBuilder fromTemplateRepository(String templateOwner, String templateRepo) {
- requester.withPreview(BAPTISTE).withUrlPath("/repos/" + templateOwner + "/" + templateRepo + "/generate");
- return this;
- }
-
- /**
- * Creates a repository with all the parameters.
- *
- * @return the gh repository
* @throws IOException
- * if repository cannot be created
+ * In case of any networking error or error from the server.
*/
- public GHRepository create() throws IOException {
- return done();
+ public GHCreateRepositoryBuilder team(GHTeam team) throws IOException {
+ if (team != null)
+ return with("team_id", team.getId());
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHDeployKey.java b/src/main/java/org/kohsuke/github/GHDeployKey.java
index 2af3b9d7ee..cba3e243c7 100644
--- a/src/main/java/org/kohsuke/github/GHDeployKey.java
+++ b/src/main/java/org/kohsuke/github/GHDeployKey.java
@@ -1,8 +1,10 @@
package org.kohsuke.github;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import org.apache.commons.lang3.builder.ToStringBuilder;
import java.io.IOException;
+import java.time.Instant;
import java.util.Date;
// TODO: Auto-generated Javadoc
@@ -11,80 +13,94 @@
*/
public class GHDeployKey {
- /** The title. */
- protected String url, key, title;
+ /** Name of user that added the deploy key */
+ private String addedBy;
- /** The verified. */
- protected boolean verified;
+ /** Creation date of the deploy key */
+ private String createdAt;
+
+ /** Last used date of the deploy key */
+ private String lastUsed;
- /** The id. */
- protected long id;
private GHRepository owner;
+ /** Whether the deploykey has readonly permission or full access */
+ private boolean readOnly;
- /** Creation date of the deploy key */
- private String created_at;
+ /** The id. */
+ protected long id;
- /** Last used date of the deploy key */
- private String last_used;
+ /** The title. */
+ protected String url, key, title;
- /** Name of user that added the deploy key */
- private String added_by;
+ /** The verified. */
+ protected boolean verified;
- /** Whether the deploykey has readonly permission or full access */
- private boolean read_only;
+ /**
+ * Create default GHDeployKey instance
+ */
+ public GHDeployKey() {
+ }
/**
- * Gets id.
+ * Delete.
*
- * @return the id
+ * @throws IOException
+ * the io exception
*/
- public long getId() {
- return id;
+ public void delete() throws IOException {
+ owner.root()
+ .createRequest()
+ .method("DELETE")
+ .withUrlPath(String.format("/repos/%s/%s/keys/%d", owner.getOwnerName(), owner.getName(), id))
+ .send();
}
/**
- * Gets key.
+ * Gets added_by
*
- * @return the key
+ * @return the added_by
*/
- public String getKey() {
- return key;
+ public String getAddedBy() {
+ return addedBy;
}
/**
- * Gets title.
+ * Gets added_by
*
- * @return the title
+ * @return the added_by
+ * @deprecated Use {@link #getAddedBy()}
*/
- public String getTitle() {
- return title;
+ @Deprecated
+ public String getAdded_by() {
+ return getAddedBy();
}
/**
- * Gets url.
+ * Gets createdAt.
*
- * @return the url
+ * @return the createdAt
*/
- public String getUrl() {
- return url;
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getCreatedAt() {
+ return GitHubClient.parseInstant(createdAt);
}
/**
- * Is verified boolean.
+ * Gets id.
*
- * @return the boolean
+ * @return the id
*/
- public boolean isVerified() {
- return verified;
+ public long getId() {
+ return id;
}
/**
- * Gets created_at.
+ * Gets key.
*
- * @return the created_at
+ * @return the key
*/
- public Date getCreatedAt() {
- return GitHubClient.parseDate(created_at);
+ public String getKey() {
+ return key;
}
/**
@@ -92,17 +108,27 @@ public Date getCreatedAt() {
*
* @return the last_used
*/
- public Date getLastUsedAt() {
- return GitHubClient.parseDate(last_used);
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getLastUsedAt() {
+ return GitHubClient.parseInstant(lastUsed);
}
/**
- * Gets added_by
+ * Gets title.
*
- * @return the added_by
+ * @return the title
*/
- public String getAdded_by() {
- return added_by;
+ public String getTitle() {
+ return title;
+ }
+
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public String getUrl() {
+ return url;
}
/**
@@ -110,32 +136,28 @@ public String getAdded_by() {
*
* @return true if the key can only read. False if the key has write permission as well.
*/
- public boolean isRead_only() {
- return read_only;
+ public boolean isReadOnly() {
+ return readOnly;
}
/**
- * Wrap gh deploy key.
+ * Is read_only
*
- * @param repo
- * the repo
- * @return the gh deploy key
+ * @return true if the key can only read. False if the key has write permission as well.
+ * @deprecated {@link #isReadOnly()}
*/
@Deprecated
- public GHDeployKey wrap(GHRepository repo) {
- throw new RuntimeException("Do not use this method.");
+ public boolean isRead_only() {
+ return isReadOnly();
}
/**
- * Wrap gh deploy key.
+ * Is verified boolean.
*
- * @param repo
- * the repo
- * @return the gh deploy key
+ * @return the boolean
*/
- GHDeployKey lateBind(GHRepository repo) {
- this.owner = repo;
- return this;
+ public boolean isVerified() {
+ return verified;
}
/**
@@ -147,24 +169,22 @@ public String toString() {
return new ToStringBuilder(this).append("title", title)
.append("id", id)
.append("key", key)
- .append("created_at", created_at)
- .append("last_used", last_used)
- .append("added_by", added_by)
- .append("read_only", read_only)
+ .append("created_at", createdAt)
+ .append("last_used", lastUsed)
+ .append("added_by", addedBy)
+ .append("read_only", readOnly)
.toString();
}
/**
- * Delete.
+ * Wrap gh deploy key.
*
- * @throws IOException
- * the io exception
+ * @param repo
+ * the repo
+ * @return the gh deploy key
*/
- public void delete() throws IOException {
- owner.root()
- .createRequest()
- .method("DELETE")
- .withUrlPath(String.format("/repos/%s/%s/keys/%d", owner.getOwnerName(), owner.getName(), id))
- .send();
+ GHDeployKey lateBind(GHRepository repo) {
+ this.owner = repo;
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHDeployment.java b/src/main/java/org/kohsuke/github/GHDeployment.java
index 6e994d7a1b..95770de8c4 100644
--- a/src/main/java/org/kohsuke/github/GHDeployment.java
+++ b/src/main/java/org/kohsuke/github/GHDeployment.java
@@ -1,8 +1,5 @@
package org.kohsuke.github;
-import org.kohsuke.github.internal.Previews;
-
-import java.io.IOException;
import java.net.URL;
import java.util.Collections;
import java.util.Map;
@@ -17,81 +14,87 @@
* @see GHRepository#getDeployment(long) GHRepository#getDeployment(long)
*/
public class GHDeployment extends GHObject {
+
private GHRepository owner;
- /** The sha. */
- protected String sha;
+ /** The creator. */
+ protected GHUser creator;
- /** The ref. */
- protected String ref;
+ /** The description. */
+ protected String description;
- /** The task. */
- protected String task;
+ /** The environment. */
+ protected String environment;
+
+ /** The original environment. */
+ protected String originalEnvironment;
/** The payload. */
protected Object payload;
- /** The environment. */
- protected String environment;
-
- /** The description. */
- protected String description;
+ /** The production environment. */
+ protected boolean productionEnvironment;
- /** The statuses url. */
- protected String statuses_url;
+ /** The ref. */
+ protected String ref;
/** The repository url. */
- protected String repository_url;
+ protected String repositoryUrl;
- /** The creator. */
- protected GHUser creator;
+ /** The sha. */
+ protected String sha;
- /** The original environment. */
- protected String original_environment;
+ /** The statuses url. */
+ protected String statusesUrl;
+
+ /** The task. */
+ protected String task;
/** The transient environment. */
- protected boolean transient_environment;
+ protected boolean transientEnvironment;
- /** The production environment. */
- protected boolean production_environment;
+ /**
+ * Create default GHDeployment instance
+ */
+ public GHDeployment() {
+ }
/**
- * Wrap.
+ * Create status gh deployment status builder.
*
- * @param owner
- * the owner
- * @return the GH deployment
+ * @param state
+ * the state
+ * @return the gh deployment status builder
*/
- GHDeployment wrap(GHRepository owner) {
- this.owner = owner;
- return this;
+ public GHDeploymentStatusBuilder createStatus(GHDeploymentState state) {
+ return new GHDeploymentStatusBuilder(owner, getId(), state);
}
/**
- * Gets statuses url.
+ * Gets creator.
*
- * @return the statuses url
+ * @return the creator
*/
- public URL getStatusesUrl() {
- return GitHubClient.parseURL(statuses_url);
+ public GHUser getCreator() {
+ return root().intern(creator);
}
/**
- * Gets repository url.
+ * Gets environment.
*
- * @return the repository url
+ * @return the environment
*/
- public URL getRepositoryUrl() {
- return GitHubClient.parseURL(repository_url);
+ public String getEnvironment() {
+ return environment;
}
/**
- * Gets task.
+ * The environment defined when the deployment was first created.
*
- * @return the task
+ * @return the original deployment environment
*/
- public String getTask() {
- return task;
+ public String getOriginalEnvironment() {
+ return originalEnvironment;
}
/**
@@ -124,97 +127,67 @@ public Object getPayloadObject() {
}
/**
- * The environment defined when the deployment was first created.
- *
- * @return the original deployment environment
- * @deprecated until preview feature has graduated to stable
- */
- @Preview(Previews.FLASH)
- public String getOriginalEnvironment() {
- return original_environment;
- }
-
- /**
- * Gets environment.
- *
- * @return the environment
- */
- public String getEnvironment() {
- return environment;
- }
-
- /**
- * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the
- * future.
+ * Gets ref.
*
- * @return the environment is transient
- * @deprecated until preview feature has graduated to stable
+ * @return the ref
*/
- @Preview(Previews.ANT_MAN)
- public boolean isTransientEnvironment() {
- return transient_environment;
+ public String getRef() {
+ return ref;
}
/**
- * Specifies if the given environment is one that end-users directly interact with.
+ * Gets repository url.
*
- * @return the environment is used by end-users directly
- * @deprecated until preview feature has graduated to stable
+ * @return the repository url
*/
- @Preview(Previews.ANT_MAN)
- public boolean isProductionEnvironment() {
- return production_environment;
+ public URL getRepositoryUrl() {
+ return GitHubClient.parseURL(repositoryUrl);
}
/**
- * Gets creator.
+ * Gets sha.
*
- * @return the creator
- * @throws IOException
- * the io exception
+ * @return the sha
*/
- public GHUser getCreator() throws IOException {
- return root().intern(creator);
+ public String getSha() {
+ return sha;
}
/**
- * Gets ref.
+ * Gets statuses url.
*
- * @return the ref
+ * @return the statuses url
*/
- public String getRef() {
- return ref;
+ public URL getStatusesUrl() {
+ return GitHubClient.parseURL(statusesUrl);
}
/**
- * Gets sha.
+ * Gets task.
*
- * @return the sha
+ * @return the task
*/
- public String getSha() {
- return sha;
+ public String getTask() {
+ return task;
}
/**
- * Gets the html url.
+ * Specifies if the given environment is one that end-users directly interact with.
*
- * @return the html url
- * @deprecated This object has no HTML URL.
+ * @return the environment is used by end-users directly
*/
- @Override
- public URL getHtmlUrl() {
- return null;
+ public boolean isProductionEnvironment() {
+ return productionEnvironment;
}
/**
- * Create status gh deployment status builder.
+ * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the
+ * future.
*
- * @param state
- * the state
- * @return the gh deployment status builder
+ * @return the environment is transient
*/
- public GHDeploymentStatusBuilder createStatus(GHDeploymentState state) {
- return new GHDeploymentStatusBuilder(owner, getId(), state);
+ public boolean isTransientEnvironment() {
+ return transientEnvironment;
}
/**
@@ -224,9 +197,7 @@ public GHDeploymentStatusBuilder createStatus(GHDeploymentState state) {
*/
public PagedIterable listStatuses() {
return root().createRequest()
- .withUrlPath(statuses_url)
- .withPreview(Previews.ANT_MAN)
- .withPreview(Previews.FLASH)
+ .withUrlPath(statusesUrl)
.toIterable(GHDeploymentStatus[].class, item -> item.lateBind(owner));
}
@@ -239,4 +210,16 @@ public PagedIterable listStatuses() {
GHRepository getOwner() {
return owner;
}
+
+ /**
+ * Wrap.
+ *
+ * @param owner
+ * the owner
+ * @return the GH deployment
+ */
+ GHDeployment wrap(GHRepository owner) {
+ this.owner = owner;
+ return this;
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHDeploymentBuilder.java b/src/main/java/org/kohsuke/github/GHDeploymentBuilder.java
index 84b333d65e..3340558bbe 100644
--- a/src/main/java/org/kohsuke/github/GHDeploymentBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHDeploymentBuilder.java
@@ -1,7 +1,6 @@
package org.kohsuke.github;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import org.kohsuke.github.internal.Previews;
import java.io.IOException;
import java.util.List;
@@ -12,8 +11,8 @@
*/
// Based on https://developer.github.com/v3/repos/deployments/#create-a-deployment
public class GHDeploymentBuilder {
- private final GHRepository repo;
private final Requester builder;
+ private final GHRepository repo;
/**
* Instantiates a new Gh deployment builder.
@@ -24,11 +23,7 @@ public class GHDeploymentBuilder {
@SuppressFBWarnings(value = { "EI_EXPOSE_REP2" }, justification = "Acceptable")
public GHDeploymentBuilder(GHRepository repo) {
this.repo = repo;
- this.builder = repo.root()
- .createRequest()
- .withPreview(Previews.ANT_MAN)
- .withPreview(Previews.FLASH)
- .method("POST");
+ this.builder = repo.root().createRequest().method("POST");
}
/**
@@ -45,54 +40,53 @@ public GHDeploymentBuilder(GHRepository repo, String ref) {
}
/**
- * Ref gh deployment builder.
+ * Auto merge gh deployment builder.
*
- * @param branch
- * the branch
+ * @param autoMerge
+ * the auto merge
*
* @return the gh deployment builder
*/
- public GHDeploymentBuilder ref(String branch) {
- builder.with("ref", branch);
+ public GHDeploymentBuilder autoMerge(boolean autoMerge) {
+ builder.with("auto_merge", autoMerge);
return this;
}
/**
- * Task gh deployment builder.
+ * Create gh deployment.
*
- * @param task
- * the task
+ * @return the gh deployment
*
- * @return the gh deployment builder
+ * @throws IOException
+ * the io exception
*/
- public GHDeploymentBuilder task(String task) {
- builder.with("task", task);
- return this;
+ public GHDeployment create() throws IOException {
+ return builder.withUrlPath(repo.getApiTailUrl("deployments")).fetch(GHDeployment.class).wrap(repo);
}
/**
- * Auto merge gh deployment builder.
+ * Description gh deployment builder.
*
- * @param autoMerge
- * the auto merge
+ * @param description
+ * the description
*
* @return the gh deployment builder
*/
- public GHDeploymentBuilder autoMerge(boolean autoMerge) {
- builder.with("auto_merge", autoMerge);
+ public GHDeploymentBuilder description(String description) {
+ builder.with("description", description);
return this;
}
/**
- * Required contexts gh deployment builder.
+ * Environment gh deployment builder.
*
- * @param requiredContexts
- * the required contexts
+ * @param environment
+ * the environment
*
* @return the gh deployment builder
*/
- public GHDeploymentBuilder requiredContexts(List requiredContexts) {
- builder.with("required_contexts", requiredContexts);
+ public GHDeploymentBuilder environment(String environment) {
+ builder.with("environment", environment);
return this;
}
@@ -110,69 +104,66 @@ public GHDeploymentBuilder payload(String payload) {
}
/**
- * Environment gh deployment builder.
- *
- * @param environment
- * the environment
+ * Specifies if the given environment is one that end-users directly interact with.
*
+ * @param productionEnvironment
+ * the environment is used by end-users directly
* @return the gh deployment builder
*/
- public GHDeploymentBuilder environment(String environment) {
- builder.with("environment", environment);
+ public GHDeploymentBuilder productionEnvironment(boolean productionEnvironment) {
+ builder.with("production_environment", productionEnvironment);
return this;
}
/**
- * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the
- * future.
+ * Ref gh deployment builder.
+ *
+ * @param branch
+ * the branch
*
- * @param transientEnvironment
- * the environment is transient
* @return the gh deployment builder
- * @deprecated until preview feature has graduated to stable
*/
- @Preview(Previews.ANT_MAN)
- public GHDeploymentBuilder transientEnvironment(boolean transientEnvironment) {
- builder.with("transient_environment", transientEnvironment);
+ public GHDeploymentBuilder ref(String branch) {
+ builder.with("ref", branch);
return this;
}
/**
- * Specifies if the given environment is one that end-users directly interact with.
+ * Required contexts gh deployment builder.
+ *
+ * @param requiredContexts
+ * the required contexts
*
- * @param productionEnvironment
- * the environment is used by end-users directly
* @return the gh deployment builder
- * @deprecated until preview feature has graduated to stable
*/
- @Preview(Previews.ANT_MAN)
- public GHDeploymentBuilder productionEnvironment(boolean productionEnvironment) {
- builder.with("production_environment", productionEnvironment);
+ public GHDeploymentBuilder requiredContexts(List requiredContexts) {
+ builder.with("required_contexts", requiredContexts);
return this;
}
/**
- * Description gh deployment builder.
+ * Task gh deployment builder.
*
- * @param description
- * the description
+ * @param task
+ * the task
*
* @return the gh deployment builder
*/
- public GHDeploymentBuilder description(String description) {
- builder.with("description", description);
+ public GHDeploymentBuilder task(String task) {
+ builder.with("task", task);
return this;
}
/**
- * Create gh deployment.
- *
- * @return the gh deployment
+ * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the
+ * future.
*
- * @throws IOException
- * the io exception
+ * @param transientEnvironment
+ * the environment is transient
+ * @return the gh deployment builder
*/
- public GHDeployment create() throws IOException {
- return builder.withUrlPath(repo.getApiTailUrl("deployments")).fetch(GHDeployment.class).wrap(repo);
+ public GHDeploymentBuilder transientEnvironment(boolean transientEnvironment) {
+ builder.with("transient_environment", transientEnvironment);
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHDeploymentState.java b/src/main/java/org/kohsuke/github/GHDeploymentState.java
index 628979aa7d..cefb3bc8ac 100644
--- a/src/main/java/org/kohsuke/github/GHDeploymentState.java
+++ b/src/main/java/org/kohsuke/github/GHDeploymentState.java
@@ -1,40 +1,35 @@
package org.kohsuke.github;
-import org.kohsuke.github.internal.Previews;
-
// TODO: Auto-generated Javadoc
/**
* Represents the state of deployment.
*/
public enum GHDeploymentState {
- /** The pending. */
- PENDING,
-
- /** The success. */
- SUCCESS,
-
/** The error. */
ERROR,
/** The failure. */
FAILURE,
+ /**
+ * The state of the deployment currently reflects it's no longer active.
+ */
+ INACTIVE,
+
/**
* The state of the deployment currently reflects it's in progress.
*/
- @Preview(Previews.FLASH)
IN_PROGRESS,
+ /** The pending. */
+ PENDING,
+
/**
* The state of the deployment currently reflects it's queued up for processing.
*/
- @Preview(Previews.FLASH)
QUEUED,
- /**
- * The state of the deployment currently reflects it's no longer active.
- */
- @Preview(Previews.ANT_MAN)
- INACTIVE
+ /** The success. */
+ SUCCESS
}
diff --git a/src/main/java/org/kohsuke/github/GHDeploymentStatus.java b/src/main/java/org/kohsuke/github/GHDeploymentStatus.java
index 208b5e92cf..3cf39fecf9 100644
--- a/src/main/java/org/kohsuke/github/GHDeploymentStatus.java
+++ b/src/main/java/org/kohsuke/github/GHDeploymentStatus.java
@@ -1,7 +1,5 @@
package org.kohsuke.github;
-import org.kohsuke.github.internal.Previews;
-
import java.net.URL;
import java.util.Locale;
@@ -10,100 +8,64 @@
* The type GHDeploymentStatus.
*/
public class GHDeploymentStatus extends GHObject {
+
private GHRepository owner;
/** The creator. */
protected GHUser creator;
- /** The state. */
- protected String state;
+ /** The deployment url. */
+ protected String deploymentUrl;
/** The description. */
protected String description;
- /** The target url. */
- protected String target_url;
+ /** The environment url. */
+ protected String environmentUrl;
/** The log url. */
- protected String log_url;
-
- /** The deployment url. */
- protected String deployment_url;
+ protected String logUrl;
/** The repository url. */
- protected String repository_url;
+ protected String repositoryUrl;
- /** The environment url. */
- protected String environment_url;
+ /** The state. */
+ protected String state;
+
+ /** The target url. */
+ protected String targetUrl;
/**
- * Wrap gh deployment status.
- *
- * @param owner
- * the owner
- *
- * @return the gh deployment status
+ * Create default GHDeploymentStatus instance
*/
- @Deprecated
- public GHDeploymentStatus wrap(GHRepository owner) {
- throw new RuntimeException("Do not use this method.");
+ public GHDeploymentStatus() {
}
/**
- * Wrap gh deployment status.
- *
- * @param owner
- * the owner
+ * Gets deployment url.
*
- * @return the gh deployment status
+ * @return the deployment url
*/
- GHDeploymentStatus lateBind(GHRepository owner) {
- this.owner = owner;
- return this;
+ public URL getDeploymentUrl() {
+ return GitHubClient.parseURL(deploymentUrl);
}
/**
- * Gets target url.
+ * Gets deployment environment url.
*
- * @return the target url
- * @deprecated Target url is deprecated in favor of {@link #getLogUrl() getLogUrl}
+ * @return the deployment environment url
*/
- @Deprecated
- public URL getTargetUrl() {
- return GitHubClient.parseURL(target_url);
+ public URL getEnvironmentUrl() {
+ return GitHubClient.parseURL(environmentUrl);
}
/**
* Gets target url.
- *
- * This method replaces {@link #getTargetUrl() getTargetUrl}}.
*
* @return the target url
- * @deprecated until preview feature has graduated to stable
*/
- @Preview(Previews.ANT_MAN)
public URL getLogUrl() {
- return GitHubClient.parseURL(log_url);
- }
-
- /**
- * Gets deployment url.
- *
- * @return the deployment url
- */
- public URL getDeploymentUrl() {
- return GitHubClient.parseURL(deployment_url);
- }
-
- /**
- * Gets deployment environment url.
- *
- * @return the deployment environment url
- * @deprecated until preview feature has graduated to stable
- */
- @Preview(Previews.ANT_MAN)
- public URL getEnvironmentUrl() {
- return GitHubClient.parseURL(environment_url);
+ return GitHubClient.parseURL(logUrl);
}
/**
@@ -112,7 +74,7 @@ public URL getEnvironmentUrl() {
* @return the repository url
*/
public URL getRepositoryUrl() {
- return GitHubClient.parseURL(repository_url);
+ return GitHubClient.parseURL(repositoryUrl);
}
/**
@@ -124,17 +86,6 @@ public GHDeploymentState getState() {
return GHDeploymentState.valueOf(state.toUpperCase(Locale.ENGLISH));
}
- /**
- * Gets the html url.
- *
- * @return the html url
- * @deprecated This object has no HTML URL.
- */
- @Override
- public URL getHtmlUrl() {
- return null;
- }
-
/**
* Gets the owner.
*
@@ -144,4 +95,17 @@ public URL getHtmlUrl() {
GHRepository getOwner() {
return owner;
}
+
+ /**
+ * Wrap gh deployment status.
+ *
+ * @param owner
+ * the owner
+ *
+ * @return the gh deployment status
+ */
+ GHDeploymentStatus lateBind(GHRepository owner) {
+ this.owner = owner;
+ return this;
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHDeploymentStatusBuilder.java b/src/main/java/org/kohsuke/github/GHDeploymentStatusBuilder.java
index 8cfc9ad5eb..23406e0580 100644
--- a/src/main/java/org/kohsuke/github/GHDeploymentStatusBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHDeploymentStatusBuilder.java
@@ -1,7 +1,5 @@
package org.kohsuke.github;
-import org.kohsuke.github.internal.Previews;
-
import java.io.IOException;
// TODO: Auto-generated Javadoc
@@ -12,25 +10,8 @@
*/
public class GHDeploymentStatusBuilder {
private final Requester builder;
- private GHRepository repo;
private long deploymentId;
-
- /**
- * Instantiates a new Gh deployment status builder.
- *
- * @param repo
- * the repo
- * @param deploymentId
- * the deployment id
- * @param state
- * the state
- *
- * @deprecated Use {@link GHDeployment#createStatus(GHDeploymentState)}
- */
- @Deprecated
- public GHDeploymentStatusBuilder(GHRepository repo, int deploymentId, GHDeploymentState state) {
- this(repo, (long) deploymentId, state);
- }
+ private GHRepository repo;
/**
* Instantiates a new GH deployment status builder.
@@ -45,11 +26,7 @@ public GHDeploymentStatusBuilder(GHRepository repo, int deploymentId, GHDeployme
GHDeploymentStatusBuilder(GHRepository repo, long deploymentId, GHDeploymentState state) {
this.repo = repo;
this.deploymentId = deploymentId;
- this.builder = repo.root()
- .createRequest()
- .withPreview(Previews.ANT_MAN)
- .withPreview(Previews.FLASH)
- .method("POST");
+ this.builder = repo.root().createRequest().method("POST");
this.builder.with("state", state);
}
@@ -61,14 +38,26 @@ public GHDeploymentStatusBuilder(GHRepository repo, int deploymentId, GHDeployme
* @param autoInactive
* Add inactive status flag
* @return the gh deployment status builder
- * @deprecated until preview feature has graduated to stable
*/
- @Preview({ Previews.ANT_MAN, Previews.FLASH })
public GHDeploymentStatusBuilder autoInactive(boolean autoInactive) {
this.builder.with("auto_inactive", autoInactive);
return this;
}
+ /**
+ * Create gh deployment status.
+ *
+ * @return the gh deployment status
+ *
+ * @throws IOException
+ * the io exception
+ */
+ public GHDeploymentStatus create() throws IOException {
+ return builder.withUrlPath(repo.getApiTailUrl("deployments/" + deploymentId + "/statuses"))
+ .fetch(GHDeploymentStatus.class)
+ .lateBind(repo);
+ }
+
/**
* Description gh deployment status builder.
*
@@ -88,9 +77,7 @@ public GHDeploymentStatusBuilder description(String description) {
* @param environment
* the environment name
* @return the gh deployment status builder
- * @deprecated until preview feature has graduated to stable
*/
- @Preview(Previews.FLASH)
public GHDeploymentStatusBuilder environment(String environment) {
this.builder.with("environment", environment);
return this;
@@ -102,9 +89,7 @@ public GHDeploymentStatusBuilder environment(String environment) {
* @param environmentUrl
* the environment url
* @return the gh deployment status builder
- * @deprecated until preview feature has graduated to stable
*/
- @Preview(Previews.ANT_MAN)
public GHDeploymentStatusBuilder environmentUrl(String environmentUrl) {
this.builder.with("environment_url", environmentUrl);
return this;
@@ -112,45 +97,13 @@ public GHDeploymentStatusBuilder environmentUrl(String environmentUrl) {
/**
* The full URL of the deployment's output.
- *
- * This method replaces {@link #targetUrl(String) targetUrl}.
*
* @param logUrl
* the deployment output url
* @return the gh deployment status builder
- * @deprecated until preview feature has graduated to stable
*/
- @Preview(Previews.ANT_MAN)
public GHDeploymentStatusBuilder logUrl(String logUrl) {
this.builder.with("log_url", logUrl);
return this;
}
-
- /**
- * Target url gh deployment status builder.
- *
- * @param targetUrl
- * the target url
- * @return the gh deployment status builder
- * @deprecated Target url is deprecated in favor of {@link #logUrl(String) logUrl}
- */
- @Deprecated
- public GHDeploymentStatusBuilder targetUrl(String targetUrl) {
- this.builder.with("target_url", targetUrl);
- return this;
- }
-
- /**
- * Create gh deployment status.
- *
- * @return the gh deployment status
- *
- * @throws IOException
- * the io exception
- */
- public GHDeploymentStatus create() throws IOException {
- return builder.withUrlPath(repo.getApiTailUrl("deployments/" + deploymentId + "/statuses"))
- .fetch(GHDeploymentStatus.class)
- .lateBind(repo);
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHDiscussion.java b/src/main/java/org/kohsuke/github/GHDiscussion.java
index 3308736166..99e8801d08 100644
--- a/src/main/java/org/kohsuke/github/GHDiscussion.java
+++ b/src/main/java/org/kohsuke/github/GHDiscussion.java
@@ -2,7 +2,6 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import org.kohsuke.github.internal.Previews;
import java.io.IOException;
import java.net.URL;
@@ -20,94 +19,57 @@
*/
public class GHDiscussion extends GHObject {
- private GHTeam team;
- private long number;
- private String body, title, htmlUrl;
-
- @JsonProperty(value = "private")
- private boolean isPrivate;
-
- /**
- * Gets the html url.
- *
- * @return the html url
- * @throws IOException
- * Signals that an I/O exception has occurred.
- */
- @Override
- public URL getHtmlUrl() throws IOException {
- return GitHubClient.parseURL(htmlUrl);
- }
-
/**
- * Wrap up.
- *
- * @param team
- * the team
- * @return the GH discussion
- */
- GHDiscussion wrapUp(GHTeam team) {
- this.team = team;
- return this;
- }
-
- /**
- * Get the team to which this discussion belongs.
+ * A {@link GHLabelBuilder} that creates a new {@link GHLabel}
*
- * @return the team for this discussion
+ * Consumer must call {@link Creator#done()} to create the new instance.
*/
- @Nonnull
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHTeam getTeam() {
- return team;
- }
+ public static class Creator extends GHDiscussionBuilder {
- /**
- * Get the title of the discussion.
- *
- * @return the title
- */
- public String getTitle() {
- return title;
- }
+ private Creator(@Nonnull GHTeam team) {
+ super(GHDiscussion.Creator.class, team, null);
+ requester.method("POST").setRawUrlPath(getRawUrlPath(team, null));
+ }
- /**
- * The description of this discussion.
- *
- * @return the body
- */
- public String getBody() {
- return body;
+ /**
+ * Sets whether this discussion is private to this team.
+ *
+ * @param value
+ * privacy of this discussion
+ * @return either a continuing builder or an updated {@link GHDiscussion}
+ * @throws IOException
+ * if there is an I/O Exception
+ */
+ @Nonnull
+ public Creator private_(boolean value) throws IOException {
+ return with("private", value);
+ }
}
/**
- * The number of this discussion.
+ * A {@link GHLabelBuilder} that updates a single property per request
*
- * @return the number
+ * {@link GitHubRequestBuilderDone#done()} is called automatically after the property is set.
*/
- public long getNumber() {
- return number;
+ public static class Setter extends GHDiscussionBuilder {
+ private Setter(@Nonnull GHDiscussion base) {
+ super(GHDiscussion.class, base.team, base);
+ requester.method("PATCH").setRawUrlPath(base.getUrl().toString());
+ }
}
-
/**
- * The id number of this discussion. GitHub discussions have "number" instead of "id". This is provided for
- * convenience.
+ * A {@link GHLabelBuilder} that allows multiple properties to be updated per request.
*
- * @return the id number for this discussion
- * @see #getNumber()
+ * Consumer must call {@link Updater#done()} to commit changes.
*/
- @Override
- public long getId() {
- return getNumber();
+ public static class Updater extends GHDiscussionBuilder {
+ private Updater(@Nonnull GHDiscussion base) {
+ super(GHDiscussion.Updater.class, base.team, base);
+ requester.method("PATCH").setRawUrlPath(base.getUrl().toString());
+ }
}
-
- /**
- * Whether the discussion is private to the team.
- *
- * @return {@code true} if discussion is private.
- */
- public boolean isPrivate() {
- return isPrivate;
+ private static String getRawUrlPath(@Nonnull GHTeam team, @CheckForNull Long discussionNumber) {
+ return team.getUrl().toString() + "/discussions" + (discussionNumber == null ? "" : "/" + discussionNumber);
}
/**
@@ -118,10 +80,8 @@ public boolean isPrivate() {
* @param team
* the team in which the discussion will be created.
* @return a {@link GHLabel.Creator}
- * @throws IOException
- * the io exception
*/
- static GHDiscussion.Creator create(GHTeam team) throws IOException {
+ static GHDiscussion.Creator create(GHTeam team) {
return new GHDiscussion.Creator(team);
}
@@ -150,36 +110,27 @@ static GHDiscussion read(GHTeam team, long discussionNumber) throws IOException
* @param team
* the team
* @return the paged iterable
- * @throws IOException
- * Signals that an I/O exception has occurred.
*/
- static PagedIterable readAll(GHTeam team) throws IOException {
+ static PagedIterable readAll(GHTeam team) {
return team.root()
.createRequest()
.setRawUrlPath(getRawUrlPath(team, null))
.toIterable(GHDiscussion[].class, item -> item.wrapUp(team));
}
- /**
- * Begins a batch update
- *
- * Consumer must call {@link GHDiscussion.Updater#done()} to commit changes.
- *
- * @return a {@link GHDiscussion.Updater}
- */
- @Preview(Previews.SQUIRREL_GIRL)
- public GHDiscussion.Updater update() {
- return new GHDiscussion.Updater(this);
- }
+ private String body, title, htmlUrl;
+
+ @JsonProperty(value = "private")
+ private boolean isPrivate;
+
+ private long number;
+
+ private GHTeam team;
/**
- * Begins a single property update.
- *
- * @return a {@link GHDiscussion.Setter}
+ * Create default GHDiscussion instance
*/
- @Preview(Previews.SQUIRREL_GIRL)
- public GHDiscussion.Setter set() {
- return new GHDiscussion.Setter(this);
+ public GHDiscussion() {
}
/**
@@ -192,79 +143,83 @@ public void delete() throws IOException {
team.root().createRequest().method("DELETE").setRawUrlPath(getRawUrlPath(team, number)).send();
}
- private static String getRawUrlPath(@Nonnull GHTeam team, @CheckForNull Long discussionNumber) {
- return team.getUrl().toString() + "/discussions" + (discussionNumber == null ? "" : "/" + discussionNumber);
+ /**
+ * Equals.
+ *
+ * @param o
+ * the o
+ * @return true, if successful
+ */
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ GHDiscussion that = (GHDiscussion) o;
+ return number == that.number && Objects.equals(getUrl(), that.getUrl()) && Objects.equals(team, that.team)
+ && Objects.equals(body, that.body) && Objects.equals(title, that.title);
}
/**
- * A {@link GHLabelBuilder} that updates a single property per request
+ * The description of this discussion.
*
- * {@link #done()} is called automatically after the property is set.
+ * @return the body
*/
- public static class Setter extends GHDiscussionBuilder {
- private Setter(@Nonnull GHDiscussion base) {
- super(GHDiscussion.class, base.team, base);
- requester.method("PATCH").setRawUrlPath(base.getUrl().toString());
- }
+ public String getBody() {
+ return body;
}
/**
- * A {@link GHLabelBuilder} that allows multiple properties to be updated per request.
+ * Gets the html url.
*
- * Consumer must call {@link #done()} to commit changes.
+ * @return the html url
*/
- public static class Updater extends GHDiscussionBuilder {
- private Updater(@Nonnull GHDiscussion base) {
- super(GHDiscussion.Updater.class, base.team, base);
- requester.method("PATCH").setRawUrlPath(base.getUrl().toString());
- }
+ public URL getHtmlUrl() {
+ return GitHubClient.parseURL(htmlUrl);
}
/**
- * A {@link GHLabelBuilder} that creates a new {@link GHLabel}
+ * The id number of this discussion. GitHub discussions have "number" instead of "id". This is provided for
+ * convenience.
*
- * Consumer must call {@link #done()} to create the new instance.
+ * @return the id number for this discussion
+ * @see #getNumber()
*/
- public static class Creator extends GHDiscussionBuilder {
+ @Override
+ public long getId() {
+ return getNumber();
+ }
- private Creator(@Nonnull GHTeam team) {
- super(GHDiscussion.Creator.class, team, null);
- requester.method("POST").setRawUrlPath(getRawUrlPath(team, null));
- }
+ /**
+ * The number of this discussion.
+ *
+ * @return the number
+ */
+ public long getNumber() {
+ return number;
+ }
- /**
- * Sets whether this discussion is private to this team.
- *
- * @param value
- * privacy of this discussion
- * @return either a continuing builder or an updated {@link GHDiscussion}
- * @throws IOException
- * if there is an I/O Exception
- */
- @Nonnull
- public Creator private_(boolean value) throws IOException {
- return with("private", value);
- }
+ /**
+ * Get the team to which this discussion belongs.
+ *
+ * @return the team for this discussion
+ */
+ @Nonnull
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHTeam getTeam() {
+ return team;
}
/**
- * Equals.
+ * Get the title of the discussion.
*
- * @param o
- * the o
- * @return true, if successful
+ * @return the title
*/
- @Override
- public boolean equals(Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- GHDiscussion that = (GHDiscussion) o;
- return number == that.number && Objects.equals(getUrl(), that.getUrl()) && Objects.equals(team, that.team)
- && Objects.equals(body, that.body) && Objects.equals(title, that.title);
+ public String getTitle() {
+ return title;
}
/**
@@ -276,4 +231,45 @@ public boolean equals(Object o) {
public int hashCode() {
return Objects.hash(team, number, body, title);
}
+
+ /**
+ * Whether the discussion is private to the team.
+ *
+ * @return {@code true} if discussion is private.
+ */
+ public boolean isPrivate() {
+ return isPrivate;
+ }
+
+ /**
+ * Begins a single property update.
+ *
+ * @return a {@link GHDiscussion.Setter}
+ */
+ public GHDiscussion.Setter set() {
+ return new GHDiscussion.Setter(this);
+ }
+
+ /**
+ * Begins a batch update
+ *
+ * Consumer must call {@link GHDiscussion.Updater#done()} to commit changes.
+ *
+ * @return a {@link GHDiscussion.Updater}
+ */
+ public GHDiscussion.Updater update() {
+ return new GHDiscussion.Updater(this);
+ }
+
+ /**
+ * Wrap up.
+ *
+ * @param team
+ * the team
+ * @return the GH discussion
+ */
+ GHDiscussion wrapUp(GHTeam team) {
+ this.team = team;
+ return this;
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHDiscussionBuilder.java b/src/main/java/org/kohsuke/github/GHDiscussionBuilder.java
index 19097c09fc..30d1986731 100644
--- a/src/main/java/org/kohsuke/github/GHDiscussionBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHDiscussionBuilder.java
@@ -10,7 +10,7 @@
* Base class for creating or updating a discussion.
*
* @param
- * Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@link S}
+ * Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@code S}
* the same as {@link GHLabel}, this builder will commit changes after each call to
* {@link #with(String, Object)}.
*/
@@ -23,7 +23,7 @@ class GHDiscussionBuilder extends AbstractBuilder {
*
* @param intermediateReturnType
* Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If
- * {@link S} the same as {@link GHDiscussion}, this builder will commit changes after each call to
+ * {@code S} the same as {@link GHDiscussion}, this builder will commit changes after each call to
* {@link #with(String, Object)}.
* @param team
* the GitHub team. Updates will be sent to the root of this team.
@@ -43,20 +43,6 @@ protected GHDiscussionBuilder(@Nonnull Class intermediateReturnType,
}
}
- /**
- * Title for this discussion.
- *
- * @param value
- * title of discussion
- * @return either a continuing builder or an updated {@link GHDiscussion}
- * @throws IOException
- * if there is an I/O Exception
- */
- @Nonnull
- public S title(String value) throws IOException {
- return with("title", value);
- }
-
/**
* Body content for this discussion.
*
@@ -79,4 +65,18 @@ public S body(String value) throws IOException {
public GHDiscussion done() throws IOException {
return super.done().wrapUp(team);
}
+
+ /**
+ * Title for this discussion.
+ *
+ * @param value
+ * title of discussion
+ * @return either a continuing builder or an updated {@link GHDiscussion}
+ * @throws IOException
+ * if there is an I/O Exception
+ */
+ @Nonnull
+ public S title(String value) throws IOException {
+ return with("title", value);
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHEmail.java b/src/main/java/org/kohsuke/github/GHEmail.java
index 270f09baf1..f5446a338d 100644
--- a/src/main/java/org/kohsuke/github/GHEmail.java
+++ b/src/main/java/org/kohsuke/github/GHEmail.java
@@ -46,6 +46,28 @@ public class GHEmail {
/** The verified. */
protected boolean verified;
+ /**
+ * Create default GHEmail instance
+ */
+ public GHEmail() {
+ }
+
+ /**
+ * Equals.
+ *
+ * @param obj
+ * the obj
+ * @return true, if successful
+ */
+ @Override
+ public boolean equals(Object obj) {
+ if (obj instanceof GHEmail) {
+ GHEmail that = (GHEmail) obj;
+ return this.email.equals(that.email);
+ }
+ return false;
+ }
+
/**
* Gets email.
*
@@ -55,6 +77,16 @@ public String getEmail() {
return email;
}
+ /**
+ * Hash code.
+ *
+ * @return the int
+ */
+ @Override
+ public int hashCode() {
+ return email.hashCode();
+ }
+
/**
* Is primary boolean.
*
@@ -82,30 +114,4 @@ public boolean isVerified() {
public String toString() {
return "Email:" + email;
}
-
- /**
- * Hash code.
- *
- * @return the int
- */
- @Override
- public int hashCode() {
- return email.hashCode();
- }
-
- /**
- * Equals.
- *
- * @param obj
- * the obj
- * @return true, if successful
- */
- @Override
- public boolean equals(Object obj) {
- if (obj instanceof GHEmail) {
- GHEmail that = (GHEmail) obj;
- return this.email.equals(that.email);
- }
- return false;
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHEnterpriseManagedUsersException.java b/src/main/java/org/kohsuke/github/GHEnterpriseManagedUsersException.java
new file mode 100644
index 0000000000..9f237da599
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHEnterpriseManagedUsersException.java
@@ -0,0 +1,44 @@
+package org.kohsuke.github;
+
+/**
+ * Failure related to Enterprise Managed Users operations.
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+public class GHEnterpriseManagedUsersException extends GHIOException {
+
+ /**
+ * The serial version UID of the exception.
+ */
+ private static final long serialVersionUID = 1980051901L;
+
+ /**
+ * The error that caused the exception.
+ */
+ private final GHError error;
+
+ /**
+ * Instantiates a new exception.
+ *
+ * @param message
+ * the message
+ * @param error
+ * the error that caused the exception
+ * @param cause
+ * the cause
+ */
+ public GHEnterpriseManagedUsersException(final String message, final GHError error, final Throwable cause) {
+ super(message, cause);
+ this.error = error;
+ }
+
+ /**
+ * Get the error that caused the exception.
+ *
+ * @return the error
+ */
+ public GHError getError() {
+ return error;
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHError.java b/src/main/java/org/kohsuke/github/GHError.java
new file mode 100644
index 0000000000..3602703945
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHError.java
@@ -0,0 +1,58 @@
+package org.kohsuke.github;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import java.io.Serializable;
+import java.net.URL;
+
+/**
+ * Represents an error from GitHub.
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+public class GHError implements Serializable {
+
+ /**
+ * The serial version UID of the error
+ */
+ private static final long serialVersionUID = 2008071901;
+
+ /**
+ * The URL to the documentation for the error.
+ */
+ @JsonProperty("documentation_url")
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String documentation;
+
+ /**
+ * The error message.
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String message;
+
+ /**
+ * Create default GHError instance
+ */
+ public GHError() {
+ }
+
+ /**
+ * Get the URL to the documentation for the error.
+ *
+ * @return the url
+ */
+ public URL getDocumentationUrl() {
+ return GitHubClient.parseURL(documentation);
+ }
+
+ /**
+ * Get the error message.
+ *
+ * @return the message
+ */
+ public String getMessage() {
+ return message;
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHEvent.java b/src/main/java/org/kohsuke/github/GHEvent.java
index 1170743ac3..b83aa820b9 100644
--- a/src/main/java/org/kohsuke/github/GHEvent.java
+++ b/src/main/java/org/kohsuke/github/GHEvent.java
@@ -12,6 +12,9 @@
*/
public enum GHEvent {
+ /** Special event type that means "every possible event". */
+ ALL,
+
/** The branch protection rule. */
BRANCH_PROTECTION_RULE,
@@ -36,15 +39,15 @@ public enum GHEvent {
/** The delete. */
DELETE,
- /** The deploy key. */
- DEPLOY_KEY,
-
/** The deployment. */
DEPLOYMENT,
/** The deployment status. */
DEPLOYMENT_STATUS,
+ /** The deploy key. */
+ DEPLOY_KEY,
+
/** The discussion. */
DISCUSSION,
@@ -54,6 +57,9 @@ public enum GHEvent {
/** The download. */
DOWNLOAD,
+ /** The dynamic events like Dependabot autorun. */
+ DYNAMIC,
+
/** The follow. */
FOLLOW,
@@ -63,12 +69,12 @@ public enum GHEvent {
/** The fork apply. */
FORK_APPLY,
- /** The github app authorization. */
- GITHUB_APP_AUTHORIZATION,
-
/** The gist. */
GIST,
+ /** The github app authorization. */
+ GITHUB_APP_AUTHORIZATION,
+
/** The gollum. */
GOLLUM,
@@ -81,12 +87,12 @@ public enum GHEvent {
/** The integration installation repositories. */
INTEGRATION_INSTALLATION_REPOSITORIES,
- /** The issue comment. */
- ISSUE_COMMENT,
-
/** The issues. */
ISSUES,
+ /** The issue comment. */
+ ISSUE_COMMENT,
+
/** The label. */
LABEL,
@@ -99,12 +105,12 @@ public enum GHEvent {
/** The membership. */
MEMBERSHIP,
- /** The merge queue entry. */
- MERGE_QUEUE_ENTRY,
-
/** The merge group entry. */
MERGE_GROUP,
+ /** The merge queue entry. */
+ MERGE_QUEUE_ENTRY,
+
/** The meta. */
META,
@@ -123,18 +129,18 @@ public enum GHEvent {
/** The page build. */
PAGE_BUILD,
+ /** The ping. */
+ PING,
+
+ /** The project. */
+ PROJECT,
+
/** The project card. */
PROJECT_CARD,
/** The project column. */
PROJECT_COLUMN,
- /** The project. */
- PROJECT,
-
- /** The ping. */
- PING,
-
/** The public. */
PUBLIC,
@@ -158,13 +164,13 @@ public enum GHEvent {
/** The release. */
RELEASE,
-
- /** The repository dispatch. */
- REPOSITORY_DISPATCH,
/** The repository. */
// only valid for org hooks
REPOSITORY,
+ /** The repository dispatch. */
+ REPOSITORY_DISPATCH,
+
/** The repository import. */
REPOSITORY_IMPORT,
@@ -189,25 +195,22 @@ public enum GHEvent {
/** The team add. */
TEAM_ADD,
+ /**
+ * Special event type that means we haven't found an enum value corresponding to the event.
+ */
+ UNKNOWN,
+
/** The watch. */
WATCH,
- /** The workflow job. */
- WORKFLOW_JOB,
-
/** The workflow dispatch. */
WORKFLOW_DISPATCH,
- /** The workflow run. */
- WORKFLOW_RUN,
-
- /**
- * Special event type that means we haven't found an enum value corresponding to the event.
- */
- UNKNOWN,
+ /** The workflow job. */
+ WORKFLOW_JOB,
- /** Special event type that means "every possible event". */
- ALL;
+ /** The workflow run. */
+ WORKFLOW_RUN;
/**
* Returns GitHub's internal representation of this event.
diff --git a/src/main/java/org/kohsuke/github/GHEventInfo.java b/src/main/java/org/kohsuke/github/GHEventInfo.java
index a781cb5668..b22f498bff 100644
--- a/src/main/java/org/kohsuke/github/GHEventInfo.java
+++ b/src/main/java/org/kohsuke/github/GHEventInfo.java
@@ -1,9 +1,10 @@
package org.kohsuke.github;
-import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
+import java.time.Instant;
import java.util.*;
// TODO: Auto-generated Javadoc
@@ -14,27 +15,6 @@
*/
@SuppressFBWarnings(value = "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", justification = "JSON API")
public class GHEventInfo extends GitHubInteractiveObject {
- // we don't want to expose Jackson dependency to the user. This needs databinding
- private ObjectNode payload;
-
- private long id;
- private String created_at;
-
- /**
- * Representation of GitHub Event API Event Type.
- *
- * This is not the same as the values used for hook methods such as
- * {@link GHRepository#createHook(String, Map, Collection, boolean)}.
- *
- * @see GitHub event
- * types
- */
- private String type;
-
- // these are all shallow objects
- private GHEventRepository repo;
- private GHUser actor;
- private GHOrganization org;
/**
* Inside the event JSON model, GitHub uses a slightly different format.
@@ -44,11 +24,18 @@ public class GHEventInfo extends GitHubInteractiveObject {
"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" },
justification = "JSON API")
public static class GHEventRepository {
+
@SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
private long id;
+
+ private String name; // owner/repo
@SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
private String url; // repository API URL
- private String name; // owner/repo
+ /**
+ * Create default GHEventRepository instance
+ */
+ public GHEventRepository() {
+ }
}
/** The Constant mapTypeStringToEvent. */
@@ -79,7 +66,6 @@ private static Map createEventMap() {
map.put("WatchEvent", GHEvent.WATCH);
return Collections.unmodifiableMap(map);
}
-
/**
* Transform type to GH event.
*
@@ -91,44 +77,32 @@ static GHEvent transformTypeToGHEvent(String type) {
return mapTypeStringToEvent.getOrDefault(type, GHEvent.UNKNOWN);
}
- /**
- * Gets type.
- *
- * @return the type
- */
- public GHEvent getType() {
- return transformTypeToGHEvent(type);
- }
+ private GHUser actor;
- /**
- * Gets id.
- *
- * @return the id
- */
- public long getId() {
- return id;
- }
+ private String createdAt;
+ private long id;
+ private GHOrganization org;
+
+ private Object payload;
+
+ // these are all shallow objects
+ private GHEventRepository repo;
/**
- * Gets created at.
+ * Representation of GitHub Event API Event Type.
*
- * @return the created at
+ * This is not the same as the values used for hook methods such as
+ * {@link GHRepository#createHook(String, Map, Collection, boolean)}.
+ *
+ * @see GitHub event
+ * types
*/
- public Date getCreatedAt() {
- return GitHubClient.parseDate(created_at);
- }
+ private String type;
/**
- * Gets repository.
- *
- * @return Repository where the change was made.
- * @throws IOException
- * on error
+ * Create default GHEventInfo instance
*/
- @SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" },
- justification = "The field comes from JSON deserialization")
- public GHRepository getRepository() throws IOException {
- return root().getRepository(repo.name);
+ public GHEventInfo() {
}
/**
@@ -148,13 +122,30 @@ public GHUser getActor() throws IOException {
* Gets actor login.
*
* @return the login of the actor.
- * @throws IOException
- * on error
*/
- public String getActorLogin() throws IOException {
+ public String getActorLogin() {
return actor.getLogin();
}
+ /**
+ * Gets created at.
+ *
+ * @return the created at
+ */
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getCreatedAt() {
+ return GitHubClient.parseInstant(createdAt);
+ }
+
+ /**
+ * Gets id.
+ *
+ * @return the id
+ */
+ public long getId() {
+ return id;
+ }
+
/**
* Gets organization.
*
@@ -181,8 +172,32 @@ public GHOrganization getOrganization() throws IOException {
* if payload cannot be parsed
*/
public T getPayload(Class type) throws IOException {
- T v = GitHubClient.getMappingObjectReader(root()).readValue(payload.traverse(), type);
+ T v = GitHubClient.getMappingObjectReader(root())
+ .forType(type)
+ .readValue(GitHubClient.getMappingObjectWriter().writeValueAsString(payload));
v.lateBind();
return v;
}
+
+ /**
+ * Gets repository.
+ *
+ * @return Repository where the change was made.
+ * @throws IOException
+ * on error
+ */
+ @SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" },
+ justification = "The field comes from JSON deserialization")
+ public GHRepository getRepository() throws IOException {
+ return root().getRepository(repo.name);
+ }
+
+ /**
+ * Gets type.
+ *
+ * @return the type
+ */
+ public GHEvent getType() {
+ return transformTypeToGHEvent(type);
+ }
}
diff --git a/src/main/java/org/kohsuke/github/GHEventPayload.java b/src/main/java/org/kohsuke/github/GHEventPayload.java
index 9413418af1..12a95e0979 100644
--- a/src/main/java/org/kohsuke/github/GHEventPayload.java
+++ b/src/main/java/org/kohsuke/github/GHEventPayload.java
@@ -1,10 +1,15 @@
package org.kohsuke.github;
+import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.io.Reader;
+import java.time.Instant;
+import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;
@@ -21,120 +26,6 @@
*/
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" }, justification = "JSON API")
public abstract class GHEventPayload extends GitHubInteractiveObject {
- // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#webhook-payload-object-common-properties
- // Webhook payload object common properties: action, sender, repository, organization, installation
- private String action;
- private GHUser sender;
- private GHRepository repository;
- private GHOrganization organization;
- private GHAppInstallation installation;
-
- /**
- * Instantiates a new GH event payload.
- */
- GHEventPayload() {
- }
-
- /**
- * Gets the action for the triggered event. Most but not all webhook payloads contain an action property that
- * contains the specific activity that triggered the event.
- *
- * @return event action
- */
- public String getAction() {
- return action;
- }
-
- /**
- * Gets the sender or {@code null} if accessed via the events API.
- *
- * @return the sender or {@code null} if accessed via the events API.
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHUser getSender() {
- return sender;
- }
-
- /**
- * Sets sender.
- *
- * @param sender
- * the sender
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setSender(GHUser sender) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets repository.
- *
- * @return the repository
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHRepository getRepository() {
- return repository;
- }
-
- /**
- * Sets repository.
- *
- * @param repository
- * the repository
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setRepository(GHRepository repository) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets organization.
- *
- * @return the organization
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHOrganization getOrganization() {
- return organization;
- }
-
- /**
- * Sets organization.
- *
- * @param organization
- * the organization
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setOrganization(GHOrganization organization) {
- throw new RuntimeException("Do not use this method.");
- }
-
- /**
- * Gets installation.
- *
- * @return the installation
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHAppInstallation getInstallation() {
- return installation;
- }
-
- // List of events that still need to be added:
- // ContentReferenceEvent
- // DeployKeyEvent DownloadEvent FollowEvent ForkApplyEvent GitHubAppAuthorizationEvent GistEvent GollumEvent
- // InstallationEvent InstallationRepositoriesEvent IssuesEvent LabelEvent MarketplacePurchaseEvent MemberEvent
- // MembershipEvent MetaEvent MilestoneEvent OrganizationEvent OrgBlockEvent PackageEvent PageBuildEvent
- // ProjectCardEvent ProjectColumnEvent ProjectEvent RepositoryDispatchEvent RepositoryImportEvent
- // RepositoryVulnerabilityAlertEvent SecurityAdvisoryEvent StarEvent StatusEvent TeamEvent TeamAddEvent WatchEvent
-
- /**
- * Late bind.
- */
- void lateBind() {
- }
-
/**
* A check run event has been created, rerequested, completed, or has a requested_action.
*
@@ -143,29 +34,15 @@ void lateBind() {
* @see Check Runs
*/
public static class CheckRun extends GHEventPayload {
- private int number;
- private GHCheckRun checkRun;
- private GHRequestedAction requestedAction;
- /**
- * Gets number.
- *
- * @return the number
- */
- public int getNumber() {
- return number;
- }
+ private GHCheckRun checkRun;
+ private int number;
+ private GHRequestedAction requestedAction;
/**
- * Sets Check Run object.
- *
- * @param currentCheckRun
- * the check run object
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * Create default CheckRun instance
*/
- @Deprecated
- public void setCheckRun(GHCheckRun currentCheckRun) {
- throw new RuntimeException("Do not use this method.");
+ public CheckRun() {
}
/**
@@ -179,15 +56,12 @@ public GHCheckRun getCheckRun() {
}
/**
- * Sets the Requested Action object.
+ * Gets number.
*
- * @param currentRequestedAction
- * the current action
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the number
*/
- @Deprecated
- public void setRequestedAction(GHRequestedAction currentRequestedAction) {
- throw new RuntimeException("Do not use this method.");
+ public int getNumber() {
+ return number;
}
/**
@@ -217,7 +91,6 @@ void lateBind() {
}
}
}
-
/**
* A check suite event has been requested, rerequested or completed.
*
@@ -226,8 +99,15 @@ void lateBind() {
* @see Check Suites
*/
public static class CheckSuite extends GHEventPayload {
+
private GHCheckSuite checkSuite;
+ /**
+ * Create default CheckSuite instance
+ */
+ public CheckSuite() {
+ }
+
/**
* Gets the Check Suite object.
*
@@ -255,172 +135,216 @@ void lateBind() {
}
}
}
+ /**
+ * Wrapper for changes on issue and pull request review comments action="edited".
+ *
+ * @see GHEventPayload.IssueComment
+ * @see GHEventPayload.PullRequestReviewComment
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "JSON API")
+ public static class CommentChanges {
+
+ /**
+ * Wrapper for changed values.
+ */
+ public static class GHFrom {
+
+ private String from;
+
+ /**
+ * Create default GHFrom instance
+ */
+ public GHFrom() {
+ }
+
+ /**
+ * Previous comment value that was changed.
+ *
+ * @return previous value
+ */
+ public String getFrom() {
+ return from;
+ }
+ }
+
+ private GHFrom body;
+
+ /**
+ * Create default CommentChanges instance
+ */
+ public CommentChanges() {
+ }
+ /**
+ * Gets the previous comment body.
+ *
+ * @return previous comment body (or null if not changed)
+ */
+ public GHFrom getBody() {
+ return body;
+ }
+ }
/**
- * An installation has been installed, uninstalled, or its permissions have been changed.
+ * A comment was added to a commit.
*
* @see
- * installation event
- * @see GitHub App Installation
+ * "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#commit_comment">
+ * commit comment
+ * @see Comments
*/
- public static class Installation extends GHEventPayload {
- private List repositories;
+ public static class CommitComment extends GHEventPayload {
+
+ private GHCommitComment comment;
+
+ /**
+ * Create default CommitComment instance
+ */
+ public CommitComment() {
+ }
/**
- * Gets repositories.
+ * Gets comment.
*
- * @return the repositories
+ * @return the comment
*/
- public List getRepositories() {
- return Collections.unmodifiableList(repositories);
- };
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHCommitComment getComment() {
+ return comment;
+ }
/**
* Late bind.
*/
@Override
void lateBind() {
- if (getInstallation() == null) {
- throw new IllegalStateException(
- "Expected installation payload, but got something else. Maybe we've got another type of event?");
- }
super.lateBind();
- if (repositories != null && !repositories.isEmpty()) {
- try {
- for (GHRepository singleRepo : repositories) {
- // populate each repository
- // the repository information provided here is so limited
- // as to be unusable without populating, so we do it eagerly
- singleRepo.populate();
- }
- } catch (IOException e) {
- throw new GHException("Failed to refresh repositories", e);
- }
+ GHRepository repository = getRepository();
+ if (repository != null) {
+ comment.wrap(repository);
}
}
}
-
/**
- * A repository has been added or removed from an installation.
+ * A repository, branch, or tag was created.
*
- * @see
- * installation_repositories event
- * @see GitHub App installation
+ * @see
+ * create event
+ * @see Git data
*/
- public static class InstallationRepositories extends GHEventPayload {
- private String repositorySelection;
- private List repositoriesAdded;
- private List repositoriesRemoved;
+ public static class Create extends GHEventPayload {
+
+ private String description;
+ private String masterBranch;
+ private String ref;
+ private String refType;
/**
- * Gets installation selection.
- *
- * @return the installation selection
+ * Create default Create instance
*/
- public String getRepositorySelection() {
- return repositorySelection;
+ public Create() {
}
/**
- * Gets repositories added.
+ * Gets description.
*
- * @return the repositories
+ * @return the description
*/
- public List getRepositoriesAdded() {
- return Collections.unmodifiableList(repositoriesAdded);
+ public String getDescription() {
+ return description;
}
/**
- * Gets repositories removed.
+ * Gets default branch.
*
- * @return the repositories
+ * Name is an artifact of when "master" was the most common default.
+ *
+ * @return the default branch
*/
- public List getRepositoriesRemoved() {
- return Collections.unmodifiableList(repositoriesRemoved);
+ public String getMasterBranch() {
+ return masterBranch;
}
/**
- * Late bind.
+ * Gets ref.
+ *
+ * @return the ref
*/
- @Override
- void lateBind() {
- if (getInstallation() == null) {
- throw new IllegalStateException(
- "Expected installation_repositories payload, but got something else. Maybe we've got another type of event?");
- }
- super.lateBind();
- List repositories;
- if ("added".equals(getAction()))
- repositories = repositoriesAdded;
- else // action == "removed"
- repositories = repositoriesRemoved;
+ public String getRef() {
+ return ref;
+ }
- if (repositories != null && !repositories.isEmpty()) {
- try {
- for (GHRepository singleRepo : repositories) { // warp each of the repository
- singleRepo.populate();
- }
- } catch (IOException e) {
- throw new GHException("Failed to refresh repositories", e);
- }
- }
+ /**
+ * Gets ref type.
+ *
+ * @return the ref type
+ */
+ public String getRefType() {
+ return refType;
}
}
/**
- * A pull request status has changed.
+ * A branch, or tag was deleted.
*
- * @see
- * pull_request event
- * @see Pull Requests
+ * @see
+ * delete event
+ * @see Git data
*/
- @SuppressFBWarnings(value = { "NP_UNWRITTEN_FIELD" }, justification = "JSON API")
- public static class PullRequest extends GHEventPayload {
- private int number;
- private GHPullRequest pullRequest;
- private GHLabel label;
- private GHPullRequestChanges changes;
+ public static class Delete extends GHEventPayload {
+
+ private String ref;
+ private String refType;
/**
- * Gets number.
- *
- * @return the number
+ * Create default Delete instance
*/
- public int getNumber() {
- return number;
+ public Delete() {
}
/**
- * Gets pull request.
+ * Gets ref.
*
- * @return the pull request
+ * @return the ref
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHPullRequest getPullRequest() {
- return pullRequest;
+ public String getRef() {
+ return ref;
}
/**
- * Gets the added or removed label for labeled/unlabeled events.
+ * Gets ref type.
*
- * @return label the added or removed label
+ * @return the ref type
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHLabel getLabel() {
- return label;
+ public String getRefType() {
+ return refType;
}
+ }
+
+ /**
+ * A deployment.
+ *
+ * @see
+ * deployment event
+ * @see Deployments
+ */
+ public static class Deployment extends GHEventPayload {
+
+ private GHDeployment deployment;
/**
- * Get changes (for action="edited").
+ * Create default Deployment instance
+ */
+ public Deployment() {
+ }
+
+ /**
+ * Gets deployment.
*
- * @return changes
+ * @return the deployment
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHPullRequestChanges getChanges() {
- return changes;
+ public GHDeployment getDeployment() {
+ return deployment;
}
/**
@@ -428,47 +352,51 @@ public GHPullRequestChanges getChanges() {
*/
@Override
void lateBind() {
- if (pullRequest == null)
- throw new IllegalStateException(
- "Expected pull_request payload, but got something else. Maybe we've got another type of event?");
super.lateBind();
GHRepository repository = getRepository();
if (repository != null) {
- pullRequest.wrapUp(repository);
+ deployment.wrap(repository);
}
}
}
/**
- * A review was added to a pull request.
+ * A deployment status.
*
* @see
- * pull_request_review event
- * @see Pull Request Reviews
+ * "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status">
+ * deployment_status event
+ * @see Deployments
*/
- public static class PullRequestReview extends GHEventPayload {
- private GHPullRequestReview review;
- private GHPullRequest pullRequest;
+ public static class DeploymentStatus extends GHEventPayload {
+ private GHDeployment deployment;
+
+ private GHDeploymentStatus deploymentStatus;
/**
- * Gets review.
+ * Create default DeploymentStatus instance
+ */
+ public DeploymentStatus() {
+ }
+
+ /**
+ * Gets deployment.
*
- * @return the review
+ * @return the deployment
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHPullRequestReview getReview() {
- return review;
+ public GHDeployment getDeployment() {
+ return deployment;
}
/**
- * Gets pull request.
+ * Gets deployment status.
*
- * @return the pull request
+ * @return the deployment status
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHPullRequest getPullRequest() {
- return pullRequest;
+ public GHDeploymentStatus getDeploymentStatus() {
+ return deploymentStatus;
}
/**
@@ -476,172 +404,256 @@ public GHPullRequest getPullRequest() {
*/
@Override
void lateBind() {
- if (review == null)
- throw new IllegalStateException(
- "Expected pull_request_review payload, but got something else. Maybe we've got another type of event?");
super.lateBind();
-
- review.wrapUp(pullRequest);
-
GHRepository repository = getRepository();
if (repository != null) {
- pullRequest.wrapUp(repository);
+ deployment.wrap(repository);
+ deploymentStatus.lateBind(repository);
}
}
}
/**
- * Wrapper for changes on issue and pull request review comments action="edited".
+ * A discussion was closed, reopened, created, edited, deleted, pinned, unpinned, locked, unlocked, transferred,
+ * category_changed, answered, or unanswered.
*
- * @see GHEventPayload.IssueComment
- * @see GHEventPayload.PullRequestReviewComment
+ * @see
+ * discussion event
*/
- @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "JSON API")
- public static class CommentChanges {
+ public static class Discussion extends GHEventPayload {
- private GHFrom body;
+ private GHRepositoryDiscussion discussion;
+
+ private GHLabel label;
/**
- * Gets the previous comment body.
- *
- * @return previous comment body (or null if not changed)
+ * Create default Discussion instance
*/
- public GHFrom getBody() {
- return body;
+ public Discussion() {
}
/**
- * Wrapper for changed values.
+ * Gets discussion.
+ *
+ * @return the discussion
*/
- public static class GHFrom {
- private String from;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHRepositoryDiscussion getDiscussion() {
+ return discussion;
+ }
- /**
- * Previous comment value that was changed.
- *
- * @return previous value
- */
- public String getFrom() {
- return from;
- }
+ /**
+ * Gets the added or removed label for labeled/unlabeled events.
+ *
+ * May be {@code null} when the unlabeled event was triggered by deleting the label from the repository.
+ *
+ * @return label the added or removed label, or {@code null} if the label was deleted
+ */
+ @CheckForNull
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHLabel getLabel() {
+ return label;
}
}
/**
- * A review comment was added to a pull request.
+ * A discussion comment was created, deleted, or edited.
*
* @see
- * pull_request_review_comment event
- * @see Pull Request Review Comments
+ * "https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion_comment">
+ * discussion event
*/
- public static class PullRequestReviewComment extends GHEventPayload {
- private GHPullRequestReviewComment comment;
- private GHPullRequest pullRequest;
- private CommentChanges changes;
+ public static class DiscussionComment extends GHEventPayload {
- /**
- * Gets comment.
- *
- * @return the comment
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHPullRequestReviewComment getComment() {
- return comment;
- }
+ private GHRepositoryDiscussionComment comment;
+
+ private GHRepositoryDiscussion discussion;
/**
- * Get changes (for action="edited").
- *
- * @return changes
+ * Create default DiscussionComment instance
*/
- public CommentChanges getChanges() {
- return changes;
+ public DiscussionComment() {
}
/**
- * Gets pull request.
+ * Gets discussion comment.
*
- * @return the pull request
+ * @return the discussion
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHPullRequest getPullRequest() {
- return pullRequest;
+ public GHRepositoryDiscussionComment getComment() {
+ return comment;
}
/**
- * Late bind.
+ * Gets discussion.
+ *
+ * @return the discussion
*/
- @Override
- void lateBind() {
- if (comment == null)
- throw new IllegalStateException(
- "Expected pull_request_review_comment payload, but got something else. Maybe we've got another type of event?");
- super.lateBind();
- comment.wrapUp(pullRequest);
-
- GHRepository repository = getRepository();
- if (repository != null) {
- pullRequest.wrapUp(repository);
- }
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHRepositoryDiscussion getDiscussion() {
+ return discussion;
}
}
/**
- * A Issue has been assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or
- * reopened.
+ * A user forked a repository.
*
- * @see
- * issues events
- * @see Issues Comments
+ * @see fork
+ * event
+ * @see Forks
*/
- public static class Issue extends GHEventPayload {
- private GHIssue issue;
+ public static class Fork extends GHEventPayload {
- private GHLabel label;
+ private GHRepository forkee;
- private GHIssueChanges changes;
+ /**
+ * Create default Fork instance
+ */
+ public Fork() {
+ }
/**
- * Gets issue.
+ * Gets forkee.
*
- * @return the issue
+ * @return the forkee
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHIssue getIssue() {
- return issue;
+ public GHRepository getForkee() {
+ return forkee;
}
+ }
+
+ // List of events that still need to be added:
+ // ContentReferenceEvent
+ // DeployKeyEvent DownloadEvent FollowEvent ForkApplyEvent GitHubAppAuthorizationEvent GistEvent GollumEvent
+ // InstallationEvent InstallationRepositoriesEvent IssuesEvent LabelEvent MarketplacePurchaseEvent MemberEvent
+ // MembershipEvent MetaEvent MilestoneEvent OrganizationEvent OrgBlockEvent PackageEvent PageBuildEvent
+ // ProjectCardEvent ProjectColumnEvent ProjectEvent RepositoryDispatchEvent RepositoryImportEvent
+ // RepositoryVulnerabilityAlertEvent SecurityAdvisoryEvent StarEvent StatusEvent TeamEvent TeamAddEvent WatchEvent
+
+ /**
+ * An installation has been installed, uninstalled, or its permissions have been changed.
+ *
+ * @see
+ * installation event
+ * @see GitHub App Installation
+ */
+ public static class Installation extends GHEventPayload {
/**
- * Sets issue.
- *
- * @param issue
- * the issue
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * A special minimal implementation of a {@link GHRepository} which contains only fields from "Properties of
+ * repositories" from here
+ */
+ public static class Repository {
+
+ private String fullName;
+
+ private long id;
+ @JsonProperty(value = "private")
+ private boolean isPrivate;
+ private String name;
+ private String nodeId;
+ /**
+ * Create default Repository instance
+ */
+ public Repository() {
+ }
+
+ /**
+ * Gets the full name.
+ *
+ * @return the full name
+ */
+ public String getFullName() {
+ return fullName;
+ }
+
+ /**
+ * Get the id.
+ *
+ * @return the id
+ */
+ public long getId() {
+ return id;
+ }
+
+ /**
+ * Gets the name.
+ *
+ * @return the name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Gets the node id.
+ *
+ * @return the node id
+ */
+ public String getNodeId() {
+ return nodeId;
+ }
+
+ /**
+ * Gets the repository private flag.
+ *
+ * @return whether the repository is private
+ */
+ public boolean isPrivate() {
+ return isPrivate;
+ }
+ }
+
+ private List ghRepositories = null;
+ private List repositories;
+
+ /**
+ * Create default Installation instance
*/
- @Deprecated
- public void setIssue(GHIssue issue) {
- throw new RuntimeException("Do not use this method.");
+ public Installation() {
}
/**
- * Gets the added or removed label for labeled/unlabeled events.
+ * Returns a list of raw, unpopulated repositories. Useful when calling from within Installation event with
+ * action "deleted". You can't fetch the info for repositories of an already deleted installation.
*
- * @return label the added or removed label
+ * @return the list of raw Repository records
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHLabel getLabel() {
- return label;
+ public List getRawRepositories() {
+ return Collections.unmodifiableList(repositories);
}
/**
- * Get changes (for action="edited").
+ * Gets repositories. For the "deleted" action please rather call {@link #getRawRepositories()}
*
- * @return changes
+ * @return the repositories
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHIssueChanges getChanges() {
- return changes;
+ public List getRepositories() {
+ if ("deleted".equalsIgnoreCase(getAction())) {
+ throw new IllegalStateException("Can't call #getRepositories() on Installation event "
+ + "with 'deleted' action. Call #getRawRepositories() instead.");
+ }
+
+ if (ghRepositories == null) {
+ ghRepositories = new ArrayList<>(repositories.size());
+ try {
+ for (Repository singleRepo : repositories) {
+ // populate each repository
+ // the repository information provided here is so limited
+ // as to be unusable without populating, so we do it eagerly
+ ghRepositories.add(this.root().getRepositoryById(singleRepo.getId()));
+ }
+ } catch (IOException e) {
+ throw new GHException("Failed to refresh repositories", e);
+ }
+ }
+
+ return Collections.unmodifiableList(ghRepositories);
}
/**
@@ -649,56 +661,119 @@ public GHIssueChanges getChanges() {
*/
@Override
void lateBind() {
- super.lateBind();
- GHRepository repository = getRepository();
- if (repository != null) {
- issue.wrap(repository);
+ if (getInstallation() == null) {
+ throw new IllegalStateException(
+ "Expected installation payload, but got something else. Maybe we've got another type of event?");
}
+ super.lateBind();
}
}
/**
- * A comment was added to an issue.
+ * A repository has been added or removed from an installation.
*
* @see
- * issue_comment event
- * @see Issue Comments
+ * "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation_repositories">
+ * installation_repositories event
+ * @see GitHub App installation
*/
- public static class IssueComment extends GHEventPayload {
- private GHIssueComment comment;
- private GHIssue issue;
- private CommentChanges changes;
+ public static class InstallationRepositories extends GHEventPayload {
+
+ private List repositoriesAdded;
+ private List repositoriesRemoved;
+ private String repositorySelection;
/**
- * Gets comment.
+ * Create default InstallationRepositories instance
+ */
+ public InstallationRepositories() {
+ }
+
+ /**
+ * Gets repositories added.
*
- * @return the comment
+ * @return the repositories
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHIssueComment getComment() {
- return comment;
+ public List getRepositoriesAdded() {
+ return Collections.unmodifiableList(repositoriesAdded);
}
/**
- * Get changes (for action="edited").
+ * Gets repositories removed.
*
- * @return changes
+ * @return the repositories
*/
- public CommentChanges getChanges() {
- return changes;
+ public List getRepositoriesRemoved() {
+ return Collections.unmodifiableList(repositoriesRemoved);
+ }
+
+ /**
+ * Gets installation selection.
+ *
+ * @return the installation selection
+ */
+ public String getRepositorySelection() {
+ return repositorySelection;
+ }
+
+ /**
+ * Late bind.
+ */
+ @Override
+ void lateBind() {
+ if (getInstallation() == null) {
+ throw new IllegalStateException(
+ "Expected installation_repositories payload, but got something else. Maybe we've got another type of event?");
+ }
+ super.lateBind();
+ List repositories;
+ if ("added".equals(getAction()))
+ repositories = repositoriesAdded;
+ else // action == "removed"
+ repositories = repositoriesRemoved;
+
+ if (repositories != null && !repositories.isEmpty()) {
+ try {
+ for (GHRepository singleRepo : repositories) { // warp each of the repository
+ singleRepo.populate();
+ }
+ } catch (IOException e) {
+ throw new GHException("Failed to refresh repositories", e);
+ }
+ }
+ }
+ }
+
+ /**
+ * A Issue has been assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or
+ * reopened.
+ *
+ * @see
+ * issues events
+ * @see Issues Comments
+ */
+ public static class Issue extends GHEventPayload {
+
+ private GHIssueChanges changes;
+
+ private GHIssue issue;
+
+ private GHLabel label;
+
+ /**
+ * Create default Issue instance
+ */
+ public Issue() {
}
/**
- * Sets comment.
+ * Get changes (for action="edited").
*
- * @param comment
- * the comment
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return changes
*/
- @Deprecated
- public void setComment(GHIssueComment comment) {
- throw new RuntimeException("Do not use this method.");
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHIssueChanges getChanges() {
+ return changes;
}
/**
@@ -712,15 +787,16 @@ public GHIssue getIssue() {
}
/**
- * Sets issue.
+ * Gets the added or removed label for labeled/unlabeled events.
+ *
+ * May be {@code null} when the unlabeled event was triggered by deleting the label from the repository.
*
- * @param issue
- * the issue
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return label the added or removed label, or {@code null} if the label was deleted
*/
- @Deprecated
- public void setIssue(GHIssue issue) {
- throw new RuntimeException("Do not use this method.");
+ @CheckForNull
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHLabel getLabel() {
+ return label;
}
/**
@@ -733,20 +809,37 @@ void lateBind() {
if (repository != null) {
issue.wrap(repository);
}
- comment.wrapUp(issue);
}
}
/**
- * A comment was added to a commit.
+ * A comment was added to an issue.
*
* @see
- * commit comment
- * @see Comments
+ * "https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment">
+ * issue_comment event
+ * @see Issue Comments
*/
- public static class CommitComment extends GHEventPayload {
- private GHCommitComment comment;
+ public static class IssueComment extends GHEventPayload {
+
+ private CommentChanges changes;
+
+ private GHIssueComment comment;
+ private GHIssue issue;
+ /**
+ * Create default IssueComment instance
+ */
+ public IssueComment() {
+ }
+
+ /**
+ * Get changes (for action="edited").
+ *
+ * @return changes
+ */
+ public CommentChanges getChanges() {
+ return changes;
+ }
/**
* Gets comment.
@@ -754,20 +847,18 @@ public static class CommitComment extends GHEventPayload {
* @return the comment
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHCommitComment getComment() {
+ public GHIssueComment getComment() {
return comment;
}
/**
- * Sets comment.
+ * Gets issue.
*
- * @param comment
- * the comment
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the issue
*/
- @Deprecated
- public void setComment(GHCommitComment comment) {
- throw new RuntimeException("Do not use this method.");
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHIssue getIssue() {
+ return issue;
}
/**
@@ -778,192 +869,122 @@ void lateBind() {
super.lateBind();
GHRepository repository = getRepository();
if (repository != null) {
- comment.wrap(repository);
+ issue.wrap(repository);
}
+ comment.wrapUp(issue);
}
}
/**
- * A repository, branch, or tag was created.
+ * A label was created, edited or deleted.
*
- * @see
- * create event
- * @see Git data
+ * @see
+ * label event
*/
- public static class Create extends GHEventPayload {
- private String ref;
- private String refType;
- private String masterBranch;
- private String description;
+ public static class Label extends GHEventPayload {
- /**
- * Gets ref.
- *
- * @return the ref
- */
- public String getRef() {
- return ref;
- }
+ private GHLabelChanges changes;
+
+ private GHLabel label;
/**
- * Gets ref type.
- *
- * @return the ref type
+ * Create default Label instance
*/
- public String getRefType() {
- return refType;
+ public Label() {
}
/**
- * Gets default branch.
- *
- * Name is an artifact of when "master" was the most common default.
+ * Gets changes (for action="edited").
*
- * @return the default branch
+ * @return changes
*/
- public String getMasterBranch() {
- return masterBranch;
+ public GHLabelChanges getChanges() {
+ return changes;
}
/**
- * Gets description.
+ * Gets the label.
*
- * @return the description
+ * @return the label
*/
- public String getDescription() {
- return description;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHLabel getLabel() {
+ return label;
}
}
/**
- * A branch, or tag was deleted.
+ * A member event was triggered.
*
- * @see
- * delete event
- * @see Git data
+ * @see member event
*/
- public static class Delete extends GHEventPayload {
- private String ref;
- private String refType;
-
- /**
- * Gets ref.
- *
- * @return the ref
- */
- public String getRef() {
- return ref;
- }
+ public static class Member extends GHEventPayload {
- /**
- * Gets ref type.
- *
- * @return the ref type
- */
- public String getRefType() {
- return refType;
- }
- }
+ private GHMemberChanges changes;
- /**
- * A deployment.
- *
- * @see
- * deployment event
- * @see Deployments
- */
- public static class Deployment extends GHEventPayload {
- private GHDeployment deployment;
+ private GHUser member;
/**
- * Gets deployment.
- *
- * @return the deployment
+ * Create default Member instance
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHDeployment getDeployment() {
- return deployment;
+ public Member() {
}
/**
- * Sets deployment.
+ * Gets the changes made to the member.
*
- * @param deployment
- * the deployment
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the changes made to the member
*/
- @Deprecated
- public void setDeployment(GHDeployment deployment) {
- throw new RuntimeException("Do not use this method.");
+ public GHMemberChanges getChanges() {
+ return changes;
}
/**
- * Late bind.
+ * Gets the member.
+ *
+ * @return the member
*/
- @Override
- void lateBind() {
- super.lateBind();
- GHRepository repository = getRepository();
- if (repository != null) {
- deployment.wrap(repository);
- }
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHUser getMember() {
+ return member;
}
}
/**
- * A deployment status.
+ * A membership event was triggered.
*
- * @see
- * deployment_status event
- * @see Deployments
+ * @see membership event
*/
- public static class DeploymentStatus extends GHEventPayload {
- private GHDeploymentStatus deploymentStatus;
- private GHDeployment deployment;
+ public static class Membership extends GHEventPayload {
- /**
- * Gets deployment status.
- *
- * @return the deployment status
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHDeploymentStatus getDeploymentStatus() {
- return deploymentStatus;
- }
+ private GHUser member;
+
+ private GHTeam team;
/**
- * Sets deployment status.
- *
- * @param deploymentStatus
- * the deployment status
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * Create default Membership instance
*/
- @Deprecated
- public void setDeploymentStatus(GHDeploymentStatus deploymentStatus) {
- throw new RuntimeException("Do not use this method.");
+ public Membership() {
}
/**
- * Gets deployment.
+ * Gets the member.
*
- * @return the deployment
+ * @return the member
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHDeployment getDeployment() {
- return deployment;
+ public GHUser getMember() {
+ return member;
}
/**
- * Sets deployment.
+ * Gets the team.
*
- * @param deployment
- * the deployment
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the team
*/
- @Deprecated
- public void setDeployment(GHDeployment deployment) {
- throw new RuntimeException("Do not use this method.");
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHTeam getTeam() {
+ return team;
}
/**
@@ -971,55 +992,71 @@ public void setDeployment(GHDeployment deployment) {
*/
@Override
void lateBind() {
+ if (team == null) {
+ throw new IllegalStateException(
+ "Expected membership payload, but got something else. Maybe we've got another type of event?");
+ }
super.lateBind();
- GHRepository repository = getRepository();
- if (repository != null) {
- deployment.wrap(repository);
- deploymentStatus.lateBind(repository);
+ GHOrganization organization = getOrganization();
+ if (organization == null) {
+ throw new IllegalStateException("Organization must not be null");
}
+ team.wrapUp(organization);
}
}
/**
- * A user forked a repository.
+ * A ping.
*
- * @see fork
+ * ping
+ * event
+ */
+ public static class Ping extends GHEventPayload {
+
+ /**
+ * Create default Ping instance
+ */
+ public Ping() {
+ }
+
+ }
+
+ /**
+ * A project v2 item was archived, converted, created, edited, restored, deleted, or reordered.
+ *
+ * @see projects_v2_item
* event
- * @see Forks
*/
- public static class Fork extends GHEventPayload {
- private GHRepository forkee;
+ public static class ProjectsV2Item extends GHEventPayload {
+
+ private GHProjectsV2ItemChanges changes;
+ private GHProjectsV2Item projectsV2Item;
/**
- * Gets forkee.
- *
- * @return the forkee
+ * Create default ProjectsV2Item instance
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHRepository getForkee() {
- return forkee;
+ public ProjectsV2Item() {
}
/**
- * Sets forkee.
+ * Gets the changes.
*
- * @param forkee
- * the forkee
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the changes
*/
- @Deprecated
- public void setForkee(GHRepository forkee) {
- throw new RuntimeException("Do not use this method.");
+ public GHProjectsV2ItemChanges getChanges() {
+ return changes;
}
- }
- /**
- * A ping.
- *
- * ping
- * event
- */
- public static class Ping extends GHEventPayload {
+ /**
+ * Gets the projects V 2 item.
+ *
+ * @return the projects V 2 item
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHProjectsV2Item getProjectsV2Item() {
+ return projectsV2Item;
+ }
}
/**
@@ -1029,201 +1066,253 @@ public static class Ping extends GHEventPayload {
* public event
*/
public static class Public extends GHEventPayload {
+
+ /**
+ * Create default Public instance
+ */
+ public Public() {
+ }
+
}
/**
- * A commit was pushed.
+ * A pull request status has changed.
*
- * @see push
- * event
+ * @see
+ * pull_request event
+ * @see Pull Requests
*/
- public static class Push extends GHEventPayload {
- private String head, before;
- private boolean created, deleted, forced;
- private String ref;
- private int size;
- private List commits;
- private PushCommit headCommit;
- private Pusher pusher;
- private String compare;
+ @SuppressFBWarnings(value = { "NP_UNWRITTEN_FIELD" }, justification = "JSON API")
+ public static class PullRequest extends GHEventPayload {
- /**
- * The SHA of the HEAD commit on the repository.
- *
- * @return the head
- */
- public String getHead() {
- return head;
- }
+ private GHPullRequestChanges changes;
+ private GHLabel label;
+ private int number;
+ private GHPullRequest pullRequest;
/**
- * This is undocumented, but it looks like this captures the commit that the ref was pointing to before the
- * push.
- *
- * @return the before
+ * Create default PullRequest instance
*/
- public String getBefore() {
- return before;
- }
-
- @JsonSetter // alias
- private void setAfter(String after) {
- head = after;
+ public PullRequest() {
}
/**
- * The full Git ref that was pushed. Example: ârefs/heads/mainâ
+ * Get changes (for action="edited").
*
- * @return the ref
+ * @return changes
*/
- public String getRef() {
- return ref;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHPullRequestChanges getChanges() {
+ return changes;
}
/**
- * The number of commits in the push. Is this always the same as {@code getCommits().size()}?
+ * Gets the added or removed label for labeled/unlabeled events.
*
- * @return the size
+ * May be {@code null} when the unlabeled event was triggered by deleting the label from the repository.
+ *
+ * @return label the added or removed label, or {@code null} if the label was deleted
*/
- public int getSize() {
- return size;
+ @CheckForNull
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHLabel getLabel() {
+ return label;
}
/**
- * Is created boolean.
+ * Gets number.
*
- * @return the boolean
+ * @return the number
*/
- public boolean isCreated() {
- return created;
+ public int getNumber() {
+ return number;
}
/**
- * Is deleted boolean.
+ * Gets pull request.
*
- * @return the boolean
+ * @return the pull request
*/
- public boolean isDeleted() {
- return deleted;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHPullRequest getPullRequest() {
+ return pullRequest;
}
/**
- * Is forced boolean.
- *
- * @return the boolean
+ * Late bind.
*/
- public boolean isForced() {
- return forced;
+ @Override
+ void lateBind() {
+ if (pullRequest == null)
+ throw new IllegalStateException(
+ "Expected pull_request payload, but got something else. Maybe we've got another type of event?");
+ super.lateBind();
+ GHRepository repository = getRepository();
+ if (repository != null) {
+ pullRequest.wrapUp(repository);
+ }
}
+ }
+
+ /**
+ * A review was added to a pull request.
+ *
+ * @see
+ * pull_request_review event
+ * @see Pull Request Reviews
+ */
+ public static class PullRequestReview extends GHEventPayload {
+ private GHPullRequest pullRequest;
+
+ private GHPullRequestReview review;
/**
- * The list of pushed commits.
- *
- * @return the commits
+ * Create default PullRequestReview instance
*/
- public List getCommits() {
- return Collections.unmodifiableList(commits);
+ public PullRequestReview() {
}
/**
- * The head commit of the push.
+ * Gets pull request.
*
- * @return the commit
+ * @return the pull request
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public PushCommit getHeadCommit() {
- return headCommit;
+ public GHPullRequest getPullRequest() {
+ return pullRequest;
}
/**
- * Gets pusher.
+ * Gets review.
*
- * @return the pusher
+ * @return the review
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public Pusher getPusher() {
- return pusher;
+ public GHPullRequestReview getReview() {
+ return review;
}
/**
- * Sets pusher.
- *
- * @param pusher
- * the pusher
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * Late bind.
*/
- @Deprecated
- public void setPusher(Pusher pusher) {
- throw new RuntimeException("Do not use this method.");
+ @Override
+ void lateBind() {
+ if (review == null)
+ throw new IllegalStateException(
+ "Expected pull_request_review payload, but got something else. Maybe we've got another type of event?");
+ super.lateBind();
+
+ review.wrapUp(pullRequest);
+
+ GHRepository repository = getRepository();
+ if (repository != null) {
+ pullRequest.wrapUp(repository);
+ }
}
+ }
+ /**
+ * A review comment was added to a pull request.
+ *
+ * @see
+ * pull_request_review_comment event
+ * @see Pull Request Review Comments
+ */
+ public static class PullRequestReviewComment extends GHEventPayload {
+
+ private CommentChanges changes;
+
+ private GHPullRequestReviewComment comment;
+ private GHPullRequest pullRequest;
/**
- * Gets compare.
- *
- * @return compare
+ * Create default PullRequestReviewComment instance
*/
- public String getCompare() {
- return compare;
+ public PullRequestReviewComment() {
}
/**
- * The type Pusher.
+ * Get changes (for action="edited").
+ *
+ * @return changes
*/
- public static class Pusher {
- private String name, email;
+ public CommentChanges getChanges() {
+ return changes;
+ }
- /**
- * Gets name.
- *
- * @return the name
- */
- public String getName() {
- return name;
- }
+ /**
+ * Gets comment.
+ *
+ * @return the comment
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHPullRequestReviewComment getComment() {
+ return comment;
+ }
- /**
- * Sets name.
- *
- * @param name
- * the name
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setName(String name) {
- throw new RuntimeException("Do not use this method.");
- }
+ /**
+ * Gets pull request.
+ *
+ * @return the pull request
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHPullRequest getPullRequest() {
+ return pullRequest;
+ }
- /**
- * Gets email.
- *
- * @return the email
- */
- public String getEmail() {
- return email;
- }
+ /**
+ * Late bind.
+ */
+ @Override
+ void lateBind() {
+ if (comment == null)
+ throw new IllegalStateException(
+ "Expected pull_request_review_comment payload, but got something else. Maybe we've got another type of event?");
+ super.lateBind();
+ comment.wrapUp(pullRequest);
- /**
- * Sets email.
- *
- * @param email
- * the email
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setEmail(String email) {
- throw new RuntimeException("Do not use this method.");
+ GHRepository repository = getRepository();
+ if (repository != null) {
+ pullRequest.wrapUp(repository);
}
}
+ }
+
+ /**
+ * A commit was pushed.
+ *
+ * @see push
+ * event
+ */
+ public static class Push extends GHEventPayload {
/**
* Commit in a push. Note: sha is an alias for id.
*/
public static class PushCommit {
+
+ private List added, removed, modified;
+
private GitUser author;
private GitUser committer;
- private String url, sha, message, timestamp;
private boolean distinct;
- private List added, removed, modified;
+ private String url, sha, message, timestamp;
+ /**
+ * Create default PushCommit instance
+ */
+ public PushCommit() {
+ }
+
+ /**
+ * Gets added.
+ *
+ * @return the added
+ */
+ public List getAdded() {
+ return Collections.unmodifiableList(added);
+ }
/**
* Gets author.
@@ -1244,12 +1333,30 @@ public GitUser getCommitter() {
}
/**
- * Points to the commit API resource.
+ * Gets message.
*
- * @return the url
+ * @return the message
*/
- public String getUrl() {
- return url;
+ public String getMessage() {
+ return message;
+ }
+
+ /**
+ * Gets modified.
+ *
+ * @return the modified
+ */
+ public List getModified() {
+ return Collections.unmodifiableList(modified);
+ }
+
+ /**
+ * Gets removed.
+ *
+ * @return the removed
+ */
+ public List getRemoved() {
+ return Collections.unmodifiableList(removed);
}
/**
@@ -1261,18 +1368,23 @@ public String getSha() {
return sha;
}
- @JsonSetter
- private void setId(String id) {
- sha = id;
+ /**
+ * Obtains the timestamp of the commit.
+ *
+ * @return the timestamp
+ */
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getTimestamp() {
+ return GitHubClient.parseInstant(timestamp);
}
/**
- * Gets message.
+ * Points to the commit API resource.
*
- * @return the message
+ * @return the url
*/
- public String getMessage() {
- return message;
+ public String getUrl() {
+ return url;
}
/**
@@ -1284,42 +1396,166 @@ public boolean isDistinct() {
return distinct;
}
- /**
- * Gets added.
- *
- * @return the added
- */
- public List getAdded() {
- return Collections.unmodifiableList(added);
+ @JsonSetter
+ private void setId(String id) {
+ sha = id;
}
+ }
+
+ /**
+ * The type Pusher.
+ */
+ public static class Pusher {
+
+ private String name, email;
+
/**
- * Gets removed.
- *
- * @return the removed
+ * Create default Pusher instance
*/
- public List getRemoved() {
- return Collections.unmodifiableList(removed);
+ public Pusher() {
}
/**
- * Gets modified.
+ * Gets email.
*
- * @return the modified
+ * @return the email
*/
- public List getModified() {
- return Collections.unmodifiableList(modified);
+ public String getEmail() {
+ return email;
}
/**
- * Obtains the timestamp of the commit.
+ * Gets name.
*
- * @return the timestamp
+ * @return the name
*/
- public Date getTimestamp() {
- return GitHubClient.parseDate(timestamp);
+ public String getName() {
+ return name;
}
}
+ private List commits;
+ private String compare;
+ private boolean created, deleted, forced;
+ private String head, before;
+ private PushCommit headCommit;
+ private Pusher pusher;
+ private String ref;
+
+ private int size;
+
+ /**
+ * Create default Push instance
+ */
+ public Push() {
+ }
+
+ /**
+ * This is undocumented, but it looks like this captures the commit that the ref was pointing to before the
+ * push.
+ *
+ * @return the before
+ */
+ public String getBefore() {
+ return before;
+ }
+
+ /**
+ * The list of pushed commits.
+ *
+ * @return the commits
+ */
+ public List getCommits() {
+ return Collections.unmodifiableList(commits);
+ }
+
+ /**
+ * Gets compare.
+ *
+ * @return compare
+ */
+ public String getCompare() {
+ return compare;
+ }
+
+ /**
+ * The SHA of the HEAD commit on the repository.
+ *
+ * @return the head
+ */
+ public String getHead() {
+ return head;
+ }
+
+ /**
+ * The head commit of the push.
+ *
+ * @return the commit
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public PushCommit getHeadCommit() {
+ return headCommit;
+ }
+
+ /**
+ * Gets pusher.
+ *
+ * @return the pusher
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public Pusher getPusher() {
+ return pusher;
+ }
+
+ /**
+ * The full Git ref that was pushed. Example: ârefs/heads/mainâ
+ *
+ * @return the ref
+ */
+ public String getRef() {
+ return ref;
+ }
+
+ /**
+ * The number of commits in the push. Is this always the same as {@code getCommits().size()}?
+ *
+ * @return the size
+ */
+ public int getSize() {
+ return size;
+ }
+
+ /**
+ * Is created boolean.
+ *
+ * @return the boolean
+ */
+ public boolean isCreated() {
+ return created;
+ }
+
+ /**
+ * Is deleted boolean.
+ *
+ * @return the boolean
+ */
+ public boolean isDeleted() {
+ return deleted;
+ }
+
+ /**
+ * Is forced boolean.
+ *
+ * @return the boolean
+ */
+ public boolean isForced() {
+ return forced;
+ }
+
+ @JsonSetter // alias
+ private void setAfter(String after) {
+ head = after;
+ }
}
/**
@@ -1332,8 +1568,15 @@ public Date getTimestamp() {
@SuppressFBWarnings(value = { "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" },
justification = "Constructed by JSON deserialization")
public static class Release extends GHEventPayload {
+
private GHRelease release;
+ /**
+ * Create default Release instance
+ */
+ public Release() {
+ }
+
/**
* Gets release.
*
@@ -1343,18 +1586,6 @@ public static class Release extends GHEventPayload {
public GHRelease getRelease() {
return release;
}
-
- /**
- * Sets release.
- *
- * @param release
- * the release
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
- */
- @Deprecated
- public void setRelease(GHRelease release) {
- throw new RuntimeException("Do not use this method.");
- }
}
/**
@@ -1366,6 +1597,51 @@ public void setRelease(GHRelease release) {
*/
public static class Repository extends GHEventPayload {
+ private GHRepositoryChanges changes;
+
+ /**
+ * Create default Repository instance
+ */
+ public Repository() {
+ }
+
+ /**
+ * Get changes.
+ *
+ * @return GHRepositoryChanges
+ */
+ public GHRepositoryChanges getChanges() {
+ return changes;
+ }
+
+ }
+
+ /**
+ * A star was created or deleted on a repository.
+ *
+ * @see star
+ * event
+ */
+ public static class Star extends GHEventPayload {
+
+ private String starredAt;
+
+ /**
+ * Create default Star instance
+ */
+ public Star() {
+ }
+
+ /**
+ * Gets the date when the star is added. Is null when the star is deleted.
+ *
+ * @return the date when the star is added
+ */
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getStarredAt() {
+ return GitHubClient.parseInstant(starredAt);
+ }
}
/**
@@ -1376,28 +1652,36 @@ public static class Repository extends GHEventPayload {
* @see Repository Statuses
*/
public static class Status extends GHEventPayload {
+
+ private GHCommit commit;
+
private String context;
private String description;
private GHCommitState state;
- private GHCommit commit;
private String targetUrl;
+ /**
+ * Create default Status instance
+ */
+ public Status() {
+ }
/**
- * Gets the status content.
+ * Gets the commit associated with the status event.
*
- * @return status content
+ * @return commit
*/
- public String getContext() {
- return context;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHCommit getCommit() {
+ return commit;
}
/**
- * The optional link added to the status.
+ * Gets the status content.
*
- * @return a url
+ * @return status content
*/
- public String getTargetUrl() {
- return targetUrl;
+ public String getContext() {
+ return context;
}
/**
@@ -1419,37 +1703,67 @@ public GHCommitState getState() {
}
/**
- * Sets the status stage.
+ * The optional link added to the status.
*
- * @param state
- * status state
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return a url
+ */
+ public String getTargetUrl() {
+ return targetUrl;
+ }
+
+ /**
+ * Late bind.
+ */
+ @Override
+ void lateBind() {
+
+ if (state == null) {
+ throw new IllegalStateException(
+ "Expected status payload, but got something else. Maybe we've got another type of event?");
+ }
+ super.lateBind();
+
+ GHRepository repository = getRepository();
+ if (repository != null) {
+ commit.wrapUp(repository);
+ }
+ }
+ }
+
+ /**
+ * A team event was triggered.
+ *
+ * @see team event
+ */
+ public static class Team extends GHEventPayload {
+
+ private GHTeamChanges changes;
+
+ private GHTeam team;
+
+ /**
+ * Create default Team instance
*/
- @Deprecated
- public void setState(GHCommitState state) {
- throw new RuntimeException("Do not use this method.");
+ public Team() {
}
/**
- * Gets the commit associated with the status event.
+ * Gets the changes made to the team.
*
- * @return commit
+ * @return the changes made to the team, null unless action is "edited".
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHCommit getCommit() {
- return commit;
+ public GHTeamChanges getChanges() {
+ return changes;
}
/**
- * Sets the commit associated with the status event.
+ * Gets the team.
*
- * @param commit
- * commit
- * @deprecated Do not use this method. It was added due to incomplete understanding of Jackson binding.
+ * @return the team
*/
- @Deprecated
- public void setCommit(GHCommit commit) {
- throw new RuntimeException("Do not use this method.");
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHTeam getTeam() {
+ return team;
}
/**
@@ -1457,17 +1771,59 @@ public void setCommit(GHCommit commit) {
*/
@Override
void lateBind() {
+ if (team == null) {
+ throw new IllegalStateException(
+ "Expected team payload, but got something else. Maybe we've got another type of event?");
+ }
+ super.lateBind();
+ GHOrganization organization = getOrganization();
+ if (organization == null) {
+ throw new IllegalStateException("Organization must not be null");
+ }
+ team.wrapUp(organization);
+ }
+ }
- if (state == null) {
+ /**
+ * A team_add event was triggered.
+ *
+ * @see team_add event
+ */
+ public static class TeamAdd extends GHEventPayload {
+
+ private GHTeam team;
+
+ /**
+ * Create default TeamAdd instance
+ */
+ public TeamAdd() {
+ }
+
+ /**
+ * Gets the team.
+ *
+ * @return the team
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHTeam getTeam() {
+ return team;
+ }
+
+ /**
+ * Late bind.
+ */
+ @Override
+ void lateBind() {
+ if (team == null) {
throw new IllegalStateException(
- "Expected status payload, but got something else. Maybe we've got another type of event?");
+ "Expected team payload, but got something else. Maybe we've got another type of event?");
}
super.lateBind();
-
- GHRepository repository = getRepository();
- if (repository != null) {
- commit.wrapUp(repository);
+ GHOrganization organization = getOrganization();
+ if (organization == null) {
+ throw new IllegalStateException("Organization must not be null");
}
+ team.wrapUp(organization);
}
}
@@ -1483,9 +1839,16 @@ void lateBind() {
* trigger workflows
*/
public static class WorkflowDispatch extends GHEventPayload {
+
private Map inputs;
+
private String ref;
private String workflow;
+ /**
+ * Create default WorkflowDispatch instance
+ */
+ public WorkflowDispatch() {
+ }
/**
* Gets the map of input parameters passed to the workflow.
@@ -1515,57 +1878,6 @@ public String getWorkflow() {
}
}
- /**
- * A workflow run was requested or completed.
- *
- * @see
- * workflow run event
- * @see Actions Workflow Runs
- */
- public static class WorkflowRun extends GHEventPayload {
- private GHWorkflowRun workflowRun;
- private GHWorkflow workflow;
-
- /**
- * Gets the workflow run.
- *
- * @return the workflow run
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHWorkflowRun getWorkflowRun() {
- return workflowRun;
- }
-
- /**
- * Gets the associated workflow.
- *
- * @return the associated workflow
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHWorkflow getWorkflow() {
- return workflow;
- }
-
- /**
- * Late bind.
- */
- @Override
- void lateBind() {
- if (workflowRun == null || workflow == null) {
- throw new IllegalStateException(
- "Expected workflow and workflow_run payload, but got something else. Maybe we've got another type of event?");
- }
- super.lateBind();
- GHRepository repository = getRepository();
- if (repository == null) {
- throw new IllegalStateException("Repository must not be null");
- }
- workflowRun.wrapUp(repository);
- workflow.wrapUp(repository);
- }
- }
-
/**
* A workflow job has been queued, is in progress, or has been completed.
*
@@ -1578,6 +1890,12 @@ public static class WorkflowJob extends GHEventPayload {
private GHWorkflowJob workflowJob;
+ /**
+ * Create default WorkflowJob instance
+ */
+ public WorkflowJob() {
+ }
+
/**
* Gets the workflow job.
*
@@ -1607,156 +1925,134 @@ void lateBind() {
}
/**
- * A label was created, edited or deleted.
+ * A workflow run was requested or completed.
*
- * @see
- * label event
+ * @see
+ * workflow run event
+ * @see Actions Workflow Runs
*/
- public static class Label extends GHEventPayload {
-
- private GHLabel label;
+ public static class WorkflowRun extends GHEventPayload {
- private GHLabelChanges changes;
+ private GHWorkflow workflow;
+ private GHWorkflowRun workflowRun;
/**
- * Gets the label.
- *
- * @return the label
+ * Create default WorkflowRun instance
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHLabel getLabel() {
- return label;
+ public WorkflowRun() {
}
/**
- * Gets changes (for action="edited").
+ * Gets the associated workflow.
*
- * @return changes
+ * @return the associated workflow
*/
- public GHLabelChanges getChanges() {
- return changes;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHWorkflow getWorkflow() {
+ return workflow;
}
- }
-
- /**
- * A discussion was closed, reopened, created, edited, deleted, pinned, unpinned, locked, unlocked, transferred,
- * category_changed, answered, or unanswered.
- *
- * @see
- * discussion event
- */
- public static class Discussion extends GHEventPayload {
-
- private GHRepositoryDiscussion discussion;
-
- private GHLabel label;
/**
- * Gets discussion.
+ * Gets the workflow run.
*
- * @return the discussion
+ * @return the workflow run
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHRepositoryDiscussion getDiscussion() {
- return discussion;
+ public GHWorkflowRun getWorkflowRun() {
+ return workflowRun;
}
/**
- * Gets the added or removed label for labeled/unlabeled events.
- *
- * @return label the added or removed label
+ * Late bind.
*/
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHLabel getLabel() {
- return label;
+ @Override
+ void lateBind() {
+ if (workflowRun == null || workflow == null) {
+ throw new IllegalStateException(
+ "Expected workflow and workflow_run payload, but got something else. Maybe we've got another type of event?");
+ }
+ super.lateBind();
+ GHRepository repository = getRepository();
+ if (repository == null) {
+ throw new IllegalStateException("Repository must not be null");
+ }
+ workflowRun.wrapUp(repository);
+ workflow.wrapUp(repository);
}
}
- /**
- * A discussion comment was created, deleted, or edited.
- *
- * @see
- * discussion event
- */
- public static class DiscussionComment extends GHEventPayload {
+ // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#webhook-payload-object-common-properties
+ // Webhook payload object common properties: action, sender, repository, organization, installation
+ private String action;
- private GHRepositoryDiscussion discussion;
+ private GHAppInstallation installation;
- private GHRepositoryDiscussionComment comment;
+ private GHOrganization organization;
- /**
- * Gets discussion.
- *
- * @return the discussion
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHRepositoryDiscussion getDiscussion() {
- return discussion;
- }
+ private GHRepository repository;
- /**
- * Gets discussion comment.
- *
- * @return the discussion
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHRepositoryDiscussionComment getComment() {
- return comment;
- }
+ private GHUser sender;
+
+ /**
+ * Instantiates a new GH event payload.
+ */
+ GHEventPayload() {
}
/**
- * A star was created or deleted on a repository.
+ * Gets the action for the triggered event. Most but not all webhook payloads contain an action property that
+ * contains the specific activity that triggered the event.
*
- * @see star
- * event
+ * @return event action
*/
- public static class Star extends GHEventPayload {
-
- private String starredAt;
+ public String getAction() {
+ return action;
+ }
- /**
- * Gets the date when the star is added. Is null when the star is deleted.
- *
- * @return the date when the star is added
- */
- public Date getStarredAt() {
- return GitHubClient.parseDate(starredAt);
- }
+ /**
+ * Gets installation.
+ *
+ * @return the installation
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHAppInstallation getInstallation() {
+ return installation;
}
/**
- * A project v2 item was archived, converted, created, edited, restored, deleted, or reordered.
+ * Gets organization.
*
- * @see star
- * event
+ * @return the organization
*/
- public static class ProjectsV2Item extends GHEventPayload {
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHOrganization getOrganization() {
+ return organization;
+ }
- private GHProjectsV2Item projectsV2Item;
- private GHProjectsV2ItemChanges changes;
+ /**
+ * Gets repository.
+ *
+ * @return the repository
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHRepository getRepository() {
+ return repository;
+ }
- /**
- * Gets the projects V 2 item.
- *
- * @return the projects V 2 item
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
- public GHProjectsV2Item getProjectsV2Item() {
- return projectsV2Item;
- }
+ /**
+ * Gets the sender or {@code null} if accessed via the events API.
+ *
+ * @return the sender or {@code null} if accessed via the events API.
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+ public GHUser getSender() {
+ return sender;
+ }
- /**
- * Gets the changes.
- *
- * @return the changes
- */
- public GHProjectsV2ItemChanges getChanges() {
- return changes;
- }
+ /**
+ * Late bind.
+ */
+ void lateBind() {
}
}
diff --git a/src/main/java/org/kohsuke/github/GHExternalGroup.java b/src/main/java/org/kohsuke/github/GHExternalGroup.java
new file mode 100644
index 0000000000..f5fb69a78d
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHExternalGroup.java
@@ -0,0 +1,266 @@
+package org.kohsuke.github;
+
+import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import java.io.IOException;
+import java.time.Instant;
+import java.util.Collections;
+import java.util.Date;
+import java.util.List;
+
+/**
+ * An external group available in a GitHub organization.
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+public class GHExternalGroup extends GitHubInteractiveObject implements Refreshable {
+
+ /**
+ * A reference of an external member linked to an external group
+ */
+ public static class GHLinkedExternalMember {
+
+ /**
+ * The email attached to the user
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String memberEmail;
+
+ /**
+ * The internal user ID of the identity
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private long memberId;
+
+ /**
+ * The handle/login for the user
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String memberLogin;
+
+ /**
+ * The user display name/profile name
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String memberName;
+
+ /**
+ * Create default GHLinkedExternalMember instance
+ */
+ public GHLinkedExternalMember() {
+ }
+
+ /**
+ * Get the linked member email
+ *
+ * @return the email
+ */
+ public String getEmail() {
+ return memberEmail;
+ }
+
+ /**
+ * Get the linked member identifier
+ *
+ * @return the id
+ */
+ public long getId() {
+ return memberId;
+ }
+
+ /**
+ * Get the linked member login
+ *
+ * @return the login
+ */
+ public String getLogin() {
+ return memberLogin;
+ }
+
+ /**
+ * Get the linked member name
+ *
+ * @return the name
+ */
+ public String getName() {
+ return memberName;
+ }
+
+ }
+
+ /**
+ * A reference of a team linked to an external group
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+ public static class GHLinkedTeam {
+
+ /**
+ * The identifier of the team
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private long teamId;
+
+ /**
+ * The name of the team
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String teamName;
+
+ /**
+ * Create default GHLinkedTeam instance
+ */
+ public GHLinkedTeam() {
+ }
+
+ /**
+ * Get the linked team identifier
+ *
+ * @return the id
+ */
+ public long getId() {
+ return teamId;
+ }
+
+ /**
+ * Get the linked team name
+ *
+ * @return the name
+ */
+ public String getName() {
+ return teamName;
+ }
+
+ }
+
+ /**
+ * The identifier of the external group
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private long groupId;
+
+ /**
+ * The name of the external group
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String groupName;
+
+ /**
+ * The external members linked to this group
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private List members;
+
+ private GHOrganization organization;
+
+ /**
+ * The teams linked to this group
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private List teams;
+
+ /**
+ * The date when the group was last updated at
+ */
+ @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
+ private String updatedAt;
+
+ GHExternalGroup() {
+ this.teams = Collections.emptyList();
+ this.members = Collections.emptyList();
+ }
+
+ /**
+ * Get the external group id.
+ *
+ * @return the id
+ */
+ public long getId() {
+ return groupId;
+ }
+
+ /**
+ * Get the external members linked to this group.
+ *
+ * @return the external members
+ */
+ public List getMembers() {
+ return Collections.unmodifiableList(members);
+ }
+
+ /**
+ * Get the external group name.
+ *
+ * @return the name
+ */
+ public String getName() {
+ return groupName;
+ }
+
+ /**
+ * Gets organization.
+ *
+ * @return the organization
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHOrganization getOrganization() {
+ return organization;
+ }
+
+ /**
+ * Get the teams linked to this group.
+ *
+ * @return the teams
+ */
+ public List getTeams() {
+ return Collections.unmodifiableList(teams);
+ }
+
+ /**
+ * Get the external group last update date.
+ *
+ * @return the date
+ */
+ @WithBridgeMethods(value = Date.class, adapterMethod = "instantToDate")
+ public Instant getUpdatedAt() {
+ return GitHubClient.parseInstant(updatedAt);
+ }
+
+ /**
+ * Refresh.
+ *
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ */
+ @Override
+ public void refresh() throws IOException {
+ root().createRequest().withUrlPath(api("")).fetchInto(this).wrapUp(root());
+ }
+
+ private String api(final String tail) {
+ return "/orgs/" + organization.getLogin() + "/external-group/" + getId() + tail;
+ }
+
+ /**
+ * Wrap up.
+ *
+ * @param owner
+ * the owner
+ */
+ GHExternalGroup wrapUp(final GHOrganization owner) {
+ this.organization = owner;
+ return this;
+ }
+
+ /**
+ * Wrap up.
+ *
+ * @param root
+ * the root
+ */
+ void wrapUp(final GitHub root) { // auto-wrapUp when organization is known from GET /orgs/{org}/external-groups
+ wrapUp(organization);
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHExternalGroupIterable.java b/src/main/java/org/kohsuke/github/GHExternalGroupIterable.java
new file mode 100644
index 0000000000..f921fdd920
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHExternalGroupIterable.java
@@ -0,0 +1,77 @@
+package org.kohsuke.github;
+
+import java.util.Arrays;
+import java.util.Iterator;
+
+import javax.annotation.Nonnull;
+
+/**
+ * Iterable for external group listing.
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+class GHExternalGroupIterable extends PagedIterable {
+
+ private final GHOrganization owner;
+
+ private final GitHubRequest request;
+
+ private GHExternalGroupPage result;
+
+ /**
+ * Instantiates a new GH external groups iterable.
+ *
+ * @param owner
+ * the owner
+ * @param requestBuilder
+ * the request builder
+ */
+ GHExternalGroupIterable(final GHOrganization owner, final GitHubRequest.Builder requestBuilder) {
+ this.owner = owner;
+ this.request = requestBuilder.build();
+ }
+
+ /**
+ * Iterator.
+ *
+ * @param pageSize
+ * the page size
+ * @return the paged iterator
+ */
+ @Nonnull
+ @Override
+ public PagedIterator _iterator(int pageSize) {
+ return new PagedIterator<>(
+ adapt(GitHubPageIterator
+ .create(owner.root().getClient(), GHExternalGroupPage.class, request, pageSize)),
+ null);
+ }
+
+ /**
+ * Adapt.
+ *
+ * @param base
+ * the base
+ * @return the iterator
+ */
+ private Iterator adapt(final Iterator base) {
+ return new Iterator() {
+ public boolean hasNext() {
+ try {
+ return base.hasNext();
+ } catch (final GHException e) {
+ throw EnterpriseManagedSupport.forOrganization(owner).filterException(e).orElse(e);
+ }
+ }
+
+ public GHExternalGroup[] next() {
+ GHExternalGroupPage v = base.next();
+ if (result == null) {
+ result = v;
+ }
+ Arrays.stream(v.getGroups()).forEach(g -> g.wrapUp(owner));
+ return v.getGroups();
+ }
+ };
+ }
+}
diff --git a/src/main/java/org/kohsuke/github/GHExternalGroupPage.java b/src/main/java/org/kohsuke/github/GHExternalGroupPage.java
new file mode 100644
index 0000000000..d47b49678c
--- /dev/null
+++ b/src/main/java/org/kohsuke/github/GHExternalGroupPage.java
@@ -0,0 +1,34 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+/**
+ * A list of external groups.
+ *
+ * @author Miguel Esteban GutiÊrrez
+ */
+class GHExternalGroupPage {
+
+ private static final GHExternalGroup[] GH_EXTERNAL_GROUPS = new GHExternalGroup[0];
+
+ private GHExternalGroup[] groups;
+
+ GHExternalGroupPage() {
+ this(GH_EXTERNAL_GROUPS);
+ }
+
+ GHExternalGroupPage(GHExternalGroup[] groups) {
+ this.groups = groups;
+ }
+
+ /**
+ * Gets the groups.
+ *
+ * @return the groups
+ */
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHExternalGroup[] getGroups() {
+ return groups;
+ }
+
+}
diff --git a/src/main/java/org/kohsuke/github/GHFork.java b/src/main/java/org/kohsuke/github/GHFork.java
index 34434e137f..620cab32e0 100644
--- a/src/main/java/org/kohsuke/github/GHFork.java
+++ b/src/main/java/org/kohsuke/github/GHFork.java
@@ -7,18 +7,18 @@
public enum GHFork {
/**
- * Search in the parent repository and in forks with more stars than the parent repository.
+ * Search only in forks with more stars than the parent repository.
*
- * Forks with the same or fewer stars than the parent repository are still ignored.
+ * The parent repository is ignored. If no forks have more stars than the parent, no results will be returned.
*/
- PARENT_AND_FORKS("true"),
+ FORKS_ONLY("only"),
/**
- * Search only in forks with more stars than the parent repository.
+ * Search in the parent repository and in forks with more stars than the parent repository.
*
- * The parent repository is ignored. If no forks have more stars than the parent, no results will be returned.
+ * Forks with the same or fewer stars than the parent repository are still ignored.
*/
- FORKS_ONLY("only"),
+ PARENT_AND_FORKS("true"),
/**
* (Default) Search only the parent repository.
diff --git a/src/main/java/org/kohsuke/github/GHGist.java b/src/main/java/org/kohsuke/github/GHGist.java
index d035ee6ef6..e7c4042f5b 100644
--- a/src/main/java/org/kohsuke/github/GHGist.java
+++ b/src/main/java/org/kohsuke/github/GHGist.java
@@ -23,21 +23,21 @@
*/
public class GHGist extends GHObject {
- /** The owner. */
- final GHUser owner;
-
- private String forks_url, commits_url, id, git_pull_url, git_push_url, html_url;
+ private int comments;
- @JsonProperty("public")
- private boolean _public;
+ private String commentsUrl;
private String description;
- private int comments;
+ private final Map files;
- private String comments_url;
+ private String forksUrl, commitsUrl, id, gitPullUrl, gitPushUrl, htmlUrl;
- private final Map files;
+ @JsonProperty("public")
+ private boolean isPublic;
+
+ /** The owner. */
+ final GHUser owner;
@JsonCreator
private GHGist(@JsonProperty("owner") GHUser owner, @JsonProperty("files") Map files) {
@@ -49,48 +49,60 @@ private GHGist(@JsonProperty("owner") GHUser owner, @JsonProperty("files") Map getFiles() {
+ return Collections.unmodifiableMap(files);
}
/**
- * Is public boolean.
+ * Gets forks url.
*
- * @return the boolean
+ * @return the forks url
*/
- public boolean isPublic() {
- return _public;
+ public String getForksUrl() {
+ return forksUrl;
}
/**
- * Gets description.
+ * Gets the id for this Gist. Unlike most other GitHub objects, the id for Gists can be non-numeric, such as
+ * "aa5a315d61ae9438b18d". This should be used instead of {@link #getId()}.
*
- * @return the description
+ * @return id of this Gist
*/
- public String getDescription() {
- return description;
+ public String getGistId() {
+ return this.id;
}
/**
- * Gets comment count.
+ * Gets git pull url.
*
- * @return the comment count
+ * @return URL like https://gist.github.com/gists/12345.git
*/
- public int getCommentCount() {
- return comments;
+ public String getGitPullUrl() {
+ return gitPullUrl;
}
/**
- * Gets comments url.
+ * Gets git push url.
*
- * @return API URL of listing comments.
+ * @return the git push url
*/
- public String getCommentsUrl() {
- return comments_url;
+ public String getGitPushUrl() {
+ return gitPushUrl;
}
/**
- * Gets file.
+ * Get the html url.
*
- * @param name
- * the name
- * @return the file
+ * @return the github html url
*/
- public GHGistFile getFile(String name) {
- return files.get(name);
+ public URL getHtmlUrl() {
+ return GitHubClient.parseURL(htmlUrl);
}
/**
- * Gets files.
+ * Unlike most other GitHub objects, the id for Gists can be non-numeric, such as "aa5a315d61ae9438b18d". If the id
+ * is numeric, this method will get it. If id is not numeric, this will throw a runtime
+ * {@link NumberFormatException}.
*
- * @return the files
+ * @return id of the Gist.
+ * @deprecated Use {@link #getGistId()} instead.
*/
- public Map getFiles() {
- return Collections.unmodifiableMap(files);
+ @Deprecated
+ @Override
+ public long getId() {
+ return Long.parseLong(getGistId());
}
/**
- * Gets the api tail url.
+ * Gets owner.
*
- * @param tail
- * the tail
- * @return the api tail url
+ * @return User that owns this Gist.
*/
- String getApiTailUrl(String tail) {
- String result = "/gists/" + id;
- if (!StringUtils.isBlank(tail)) {
- result += StringUtils.prependIfMissing(tail, "/");
- }
- return result;
+ @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
+ public GHUser getOwner() {
+ return owner;
}
/**
- * Star.
+ * Hash code.
*
- * @throws IOException
- * the io exception
+ * @return the int
*/
- public void star() throws IOException {
- root().createRequest().method("PUT").withUrlPath(getApiTailUrl("star")).send();
+ @Override
+ public int hashCode() {
+ return id.hashCode();
}
/**
- * Unstar.
+ * Is public boolean.
*
- * @throws IOException
- * the io exception
+ * @return the boolean
*/
- public void unstar() throws IOException {
- root().createRequest().method("DELETE").withUrlPath(getApiTailUrl("star")).send();
+ public boolean isPublic() {
+ return isPublic;
}
/**
@@ -231,17 +243,6 @@ public boolean isStarred() throws IOException {
return root().createRequest().withUrlPath(getApiTailUrl("star")).fetchHttpStatusCode() / 100 == 2;
}
- /**
- * Forks this gist into your own.
- *
- * @return the gh gist
- * @throws IOException
- * the io exception
- */
- public GHGist fork() throws IOException {
- return root().createRequest().method("POST").withUrlPath(getApiTailUrl("forks")).fetch(GHGist.class);
- }
-
/**
* List forks paged iterable.
*
@@ -252,51 +253,46 @@ public PagedIterable listForks() {
}
/**
- * Deletes this gist.
+ * Star.
*
* @throws IOException
* the io exception
*/
- public void delete() throws IOException {
- root().createRequest().method("DELETE").withUrlPath("/gists/" + id).send();
+ public void star() throws IOException {
+ root().createRequest().method("PUT").withUrlPath(getApiTailUrl("star")).send();
}
/**
- * Updates this gist via a builder.
+ * Unstar.
*
- * @return the gh gist updater
* @throws IOException
* the io exception
*/
- public GHGistUpdater update() throws IOException {
- return new GHGistUpdater(this);
+ public void unstar() throws IOException {
+ root().createRequest().method("DELETE").withUrlPath(getApiTailUrl("star")).send();
}
/**
- * Equals.
+ * Updates this gist via a builder.
*
- * @param o
- * the o
- * @return true, if successful
+ * @return the gh gist updater
*/
- @Override
- public boolean equals(Object o) {
- if (this == o)
- return true;
- if (o == null || getClass() != o.getClass())
- return false;
- GHGist ghGist = (GHGist) o;
- return id.equals(ghGist.id);
-
+ public GHGistUpdater update() {
+ return new GHGistUpdater(this);
}
/**
- * Hash code.
+ * Gets the api tail url.
*
- * @return the int
+ * @param tail
+ * the tail
+ * @return the api tail url
*/
- @Override
- public int hashCode() {
- return id.hashCode();
+ String getApiTailUrl(String tail) {
+ String result = "/gists/" + id;
+ if (!StringUtils.isBlank(tail)) {
+ result += StringUtils.prependIfMissing(tail, "/");
+ }
+ return result;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHGistBuilder.java b/src/main/java/org/kohsuke/github/GHGistBuilder.java
index c2797b628c..5d7cb908d9 100644
--- a/src/main/java/org/kohsuke/github/GHGistBuilder.java
+++ b/src/main/java/org/kohsuke/github/GHGistBuilder.java
@@ -14,8 +14,8 @@
* @see GitHub#createGist() GitHub#createGist()
*/
public class GHGistBuilder {
- private final Requester req;
private final LinkedHashMap files = new LinkedHashMap();
+ private final Requester req;
/**
* Instantiates a new Gh gist builder.
@@ -28,26 +28,26 @@ public GHGistBuilder(GitHub root) {
}
/**
- * Description gh gist builder.
+ * Creates a Gist based on the parameters specified thus far.
*
- * @param desc
- * the desc
- * @return the gh gist builder
+ * @return created Gist
+ * @throws IOException
+ * if Gist cannot be created.
*/
- public GHGistBuilder description(String desc) {
- req.with("description", desc);
- return this;
+ public GHGist create() throws IOException {
+ req.with("files", files);
+ return req.withUrlPath("/gists").fetch(GHGist.class);
}
/**
- * Public gh gist builder.
+ * Description gh gist builder.
*
- * @param v
- * the v
+ * @param desc
+ * the desc
* @return the gh gist builder
*/
- public GHGistBuilder public_(boolean v) {
- req.with("public", v);
+ public GHGistBuilder description(String desc) {
+ req.with("description", desc);
return this;
}
@@ -66,14 +66,14 @@ public GHGistBuilder file(@Nonnull String fileName, @Nonnull String content) {
}
/**
- * Creates a Gist based on the parameters specified thus far.
+ * Public gh gist builder.
*
- * @return created Gist
- * @throws IOException
- * if Gist cannot be created.
+ * @param v
+ * the v
+ * @return the gh gist builder
*/
- public GHGist create() throws IOException {
- req.with("files", files);
- return req.withUrlPath("/gists").fetch(GHGist.class);
+ public GHGistBuilder public_(boolean v) {
+ req.with("public", v);
+ return this;
}
}
diff --git a/src/main/java/org/kohsuke/github/GHGistFile.java b/src/main/java/org/kohsuke/github/GHGistFile.java
index 67237094d1..da60cc902d 100644
--- a/src/main/java/org/kohsuke/github/GHGistFile.java
+++ b/src/main/java/org/kohsuke/github/GHGistFile.java
@@ -10,12 +10,27 @@
*/
public class GHGistFile {
- /** The file name. */
- /* package almost final */ String fileName;
+ private String rawUrl, type, language, content;
private int size;
- private String raw_url, type, language, content;
+
private boolean truncated;
+ /** The file name. */
+ /* package almost final */ String fileName;
+ /**
+ * Create default GHGistFile instance
+ */
+ public GHGistFile() {
+ }
+
+ /**
+ * Content of this file.
+ *
+ * @return the content
+ */
+ public String getContent() {
+ return content;
+ }
/**
* Gets file name.
@@ -27,12 +42,12 @@ public String getFileName() {
}
/**
- * File size in bytes.
+ * Gets language.
*
- * @return the size
+ * @return the language
*/
- public int getSize() {
- return size;
+ public String getLanguage() {
+ return language;
}
/**
@@ -41,34 +56,25 @@ public int getSize() {
* @return the raw url
*/
public String getRawUrl() {
- return raw_url;
+ return rawUrl;
}
/**
- * Content type of this Gist, such as "text/plain".
- *
- * @return the type
- */
- public String getType() {
- return type;
- }
-
- /**
- * Gets language.
+ * File size in bytes.
*
- * @return the language
+ * @return the size
*/
- public String getLanguage() {
- return language;
+ public int getSize() {
+ return size;
}
/**
- * Content of this file.
+ * Content type of this Gist, such as "text/plain".
*
- * @return the content
+ * @return the type
*/
- public String getContent() {
- return content;
+ public String getType() {
+ return type;
}
/**
diff --git a/src/main/java/org/kohsuke/github/GHGistUpdater.java b/src/main/java/org/kohsuke/github/GHGistUpdater.java
index 5faaccde4d..cc67de6f89 100644
--- a/src/main/java/org/kohsuke/github/GHGistUpdater.java
+++ b/src/main/java/org/kohsuke/github/GHGistUpdater.java
@@ -41,10 +41,8 @@ public class GHGistUpdater {
* @param content
* the content
* @return the gh gist updater
- * @throws IOException
- * the io exception
*/
- public GHGistUpdater addFile(@Nonnull String fileName, @Nonnull String content) throws IOException {
+ public GHGistUpdater addFile(@Nonnull String fileName, @Nonnull String content) {
updateFile(fileName, content);
return this;
}
@@ -55,14 +53,24 @@ public GHGistUpdater addFile(@Nonnull String fileName, @Nonnull String content)
* @param fileName
* the file name
* @return the GH gist updater
- * @throws IOException
- * Signals that an I/O exception has occurred.
*/
- public GHGistUpdater deleteFile(@Nonnull String fileName) throws IOException {
+ public GHGistUpdater deleteFile(@Nonnull String fileName) {
files.put(fileName, null);
return this;
}
+ /**
+ * Description gh gist updater.
+ *
+ * @param desc
+ * the desc
+ * @return the gh gist updater
+ */
+ public GHGistUpdater description(String desc) {
+ builder.with("description", desc);
+ return this;
+ }
+
/**
* Rename file gh gist updater.
*
@@ -71,15 +79,25 @@ public GHGistUpdater deleteFile(@Nonnull String fileName) throws IOException {
* @param newFileName
* the new file name
* @return the gh gist updater
- * @throws IOException
- * the io exception
*/
- public GHGistUpdater renameFile(@Nonnull String fileName, @Nonnull String newFileName) throws IOException {
+ public GHGistUpdater renameFile(@Nonnull String fileName, @Nonnull String newFileName) {
Map file = files.computeIfAbsent(fileName, d -> new HashMap<>());
file.put("filename", newFileName);
return this;
}
+ /**
+ * Updates the Gist based on the parameters specified thus far.
+ *
+ * @return the gh gist
+ * @throws IOException
+ * the io exception
+ */
+ public GHGist update() throws IOException {
+ builder.with("files", files);
+ return builder.method("PATCH").withUrlPath(base.getApiTailUrl("")).fetch(GHGist.class);
+ }
+
/**
* Update file gh gist updater.
*
@@ -88,10 +106,8 @@ public GHGistUpdater renameFile(@Nonnull String fileName, @Nonnull String newFil
* @param content
* the content
* @return the gh gist updater
- * @throws IOException
- * the io exception
*/
- public GHGistUpdater updateFile(@Nonnull String fileName, @Nonnull String content) throws IOException {
+ public GHGistUpdater updateFile(@Nonnull String fileName, @Nonnull String content) {
Map file = files.computeIfAbsent(fileName, d -> new HashMap<>());
file.put("content", content);
return this;
@@ -107,39 +123,12 @@ public GHGistUpdater updateFile(@Nonnull String fileName, @Nonnull String conten
* @param content
* the content
* @return the gh gist updater
- * @throws IOException
- * the io exception
*/
- public GHGistUpdater updateFile(@Nonnull String fileName, @Nonnull String newFileName, @Nonnull String content)
- throws IOException {
+ public GHGistUpdater updateFile(@Nonnull String fileName, @Nonnull String newFileName, @Nonnull String content) {
Map file = files.computeIfAbsent(fileName, d -> new HashMap<>());
file.put("content", content);
file.put("filename", newFileName);
files.put(fileName, file);
return this;
}
-
- /**
- * Description gh gist updater.
- *
- * @param desc
- * the desc
- * @return the gh gist updater
- */
- public GHGistUpdater description(String desc) {
- builder.with("description", desc);
- return this;
- }
-
- /**
- * Updates the Gist based on the parameters specified thus far.
- *
- * @return the gh gist
- * @throws IOException
- * the io exception
- */
- public GHGist update() throws IOException {
- builder.with("files", files);
- return builder.method("PATCH").withUrlPath(base.getApiTailUrl("")).fetch(GHGist.class);
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHHook.java b/src/main/java/org/kohsuke/github/GHHook.java
index 08f2b9e798..cc41288b7f 100644
--- a/src/main/java/org/kohsuke/github/GHHook.java
+++ b/src/main/java/org/kohsuke/github/GHHook.java
@@ -4,7 +4,6 @@
import org.kohsuke.github.internal.EnumUtils;
import java.io.IOException;
-import java.net.URL;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
@@ -20,25 +19,41 @@
justification = "JSON API")
public abstract class GHHook extends GHObject {
- /** The name. */
- String name;
-
- /** The events. */
- List events;
-
/** The active. */
boolean active;
/** The config. */
Map config;
+ /** The events. */
+ List events;
+
+ /** The name. */
+ String name;
+
/**
- * Gets name.
+ * Create default GHHook instance
+ */
+ public GHHook() {
+ }
+
+ /**
+ * Deletes this hook.
*
- * @return the name
+ * @throws IOException
+ * the io exception
*/
- public String getName() {
- return name;
+ public void delete() throws IOException {
+ root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send();
+ }
+
+ /**
+ * Gets config.
+ *
+ * @return the config
+ */
+ public Map getConfig() {
+ return Collections.unmodifiableMap(config);
}
/**
@@ -55,21 +70,21 @@ public EnumSet getEvents() {
}
/**
- * Is active boolean.
+ * Gets name.
*
- * @return the boolean
+ * @return the name
*/
- public boolean isActive() {
- return active;
+ public String getName() {
+ return name;
}
/**
- * Gets config.
+ * Is active boolean.
*
- * @return the config
+ * @return the boolean
*/
- public Map getConfig() {
- return Collections.unmodifiableMap(config);
+ public boolean isActive() {
+ return active;
}
/**
@@ -84,25 +99,11 @@ public void ping() throws IOException {
}
/**
- * Deletes this hook.
- *
- * @throws IOException
- * the io exception
- */
- public void delete() throws IOException {
- root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send();
- }
-
- /**
- * Gets the html url.
+ * Gets the api route.
*
- * @return the html url
- * @deprecated This object has no HTML URL.
+ * @return the api route
*/
- @Override
- public URL getHtmlUrl() {
- return null;
- }
+ abstract String getApiRoute();
/**
* Root.
@@ -110,11 +111,4 @@ public URL getHtmlUrl() {
* @return the git hub
*/
abstract GitHub root();
-
- /**
- * Gets the api route.
- *
- * @return the api route
- */
- abstract String getApiRoute();
}
diff --git a/src/main/java/org/kohsuke/github/GHHooks.java b/src/main/java/org/kohsuke/github/GHHooks.java
index addcad3179..25fe143d82 100644
--- a/src/main/java/org/kohsuke/github/GHHooks.java
+++ b/src/main/java/org/kohsuke/github/GHHooks.java
@@ -14,6 +14,66 @@
*/
class GHHooks {
+ private static class OrgContext extends Context {
+ private final GHOrganization organization;
+
+ private OrgContext(GHOrganization organization) {
+ super(organization.root());
+ this.organization = organization;
+ }
+
+ @Override
+ Class clazz() {
+ return GHOrgHook.class;
+ }
+
+ @Override
+ String collection() {
+ return String.format("/orgs/%s/hooks", organization.getLogin());
+ }
+
+ @Override
+ Class collectionClass() {
+ return GHOrgHook[].class;
+ }
+
+ @Override
+ GHHook wrap(GHHook hook) {
+ return ((GHOrgHook) hook).wrap(organization);
+ }
+ }
+
+ private static class RepoContext extends Context {
+ private final GHUser owner;
+ private final GHRepository repository;
+
+ private RepoContext(GHRepository repository, GHUser owner) {
+ super(repository.root());
+ this.repository = repository;
+ this.owner = owner;
+ }
+
+ @Override
+ Class clazz() {
+ return GHRepoHook.class;
+ }
+
+ @Override
+ String collection() {
+ return String.format("/repos/%s/%s/hooks", owner.getLogin(), repository.getName());
+ }
+
+ @Override
+ Class collectionClass() {
+ return GHRepoHook[].class;
+ }
+
+ @Override
+ GHHook wrap(GHHook hook) {
+ return ((GHRepoHook) hook).wrap(repository);
+ }
+ }
+
/**
* The Class Context.
*/
@@ -23,39 +83,6 @@ private Context(GitHub root) {
super(root);
}
- /**
- * Gets hooks.
- *
- * @return the hooks
- * @throws IOException
- * the io exception
- */
- public List getHooks() throws IOException {
-
- // jdk/eclipse bug
- GHHook[] hookArray = root().createRequest().withUrlPath(collection()).fetch(collectionClass());
- // requires this
- // to be on separate line
- List list = new ArrayList(Arrays.asList(hookArray));
- for (GHHook h : list)
- wrap(h);
- return list;
- }
-
- /**
- * Gets hook.
- *
- * @param id
- * the id
- * @return the hook
- * @throws IOException
- * the io exception
- */
- public GHHook getHook(int id) throws IOException {
- GHHook hook = root().createRequest().withUrlPath(collection() + "/" + id).fetch(clazz());
- return wrap(hook);
- }
-
/**
* Create hook gh hook.
*
@@ -105,18 +132,37 @@ public void deleteHook(int id) throws IOException {
}
/**
- * Collection.
+ * Gets hook.
*
- * @return the string
+ * @param id
+ * the id
+ * @return the hook
+ * @throws IOException
+ * the io exception
*/
- abstract String collection();
+ public GHHook getHook(int id) throws IOException {
+ GHHook hook = root().createRequest().withUrlPath(collection() + "/" + id).fetch(clazz());
+ return wrap(hook);
+ }
/**
- * Collection class.
+ * Gets hooks.
*
- * @return the class
+ * @return the hooks
+ * @throws IOException
+ * the io exception
*/
- abstract Class collectionClass();
+ public List getHooks() throws IOException {
+
+ // jdk/eclipse bug
+ GHHook[] hookArray = root().createRequest().withUrlPath(collection()).fetch(collectionClass());
+ // requires this
+ // to be on separate line
+ List list = new ArrayList(Arrays.asList(hookArray));
+ for (GHHook h : list)
+ wrap(h);
+ return list;
+ }
/**
* Clazz.
@@ -125,6 +171,20 @@ public void deleteHook(int id) throws IOException {
*/
abstract Class clazz();
+ /**
+ * Collection.
+ *
+ * @return the string
+ */
+ abstract String collection();
+
+ /**
+ * Collection class.
+ *
+ * @return the class
+ */
+ abstract Class collectionClass();
+
/**
* Wrap.
*
@@ -135,64 +195,15 @@ public void deleteHook(int id) throws IOException {
abstract GHHook wrap(GHHook hook);
}
- private static class RepoContext extends Context {
- private final GHRepository repository;
- private final GHUser owner;
-
- private RepoContext(GHRepository repository, GHUser owner) {
- super(repository.root());
- this.repository = repository;
- this.owner = owner;
- }
-
- @Override
- String collection() {
- return String.format("/repos/%s/%s/hooks", owner.getLogin(), repository.getName());
- }
-
- @Override
- Class collectionClass() {
- return GHRepoHook[].class;
- }
-
- @Override
- Class clazz() {
- return GHRepoHook.class;
- }
-
- @Override
- GHHook wrap(GHHook hook) {
- return ((GHRepoHook) hook).wrap(repository);
- }
- }
-
- private static class OrgContext extends Context {
- private final GHOrganization organization;
-
- private OrgContext(GHOrganization organization) {
- super(organization.root());
- this.organization = organization;
- }
-
- @Override
- String collection() {
- return String.format("/orgs/%s/hooks", organization.getLogin());
- }
-
- @Override
- Class collectionClass() {
- return GHOrgHook[].class;
- }
-
- @Override
- Class clazz() {
- return GHOrgHook.class;
- }
-
- @Override
- GHHook wrap(GHHook hook) {
- return ((GHOrgHook) hook).wrap(organization);
- }
+ /**
+ * Org context.
+ *
+ * @param organization
+ * the organization
+ * @return the context
+ */
+ static Context orgContext(GHOrganization organization) {
+ return new OrgContext(organization);
}
/**
@@ -207,15 +218,4 @@ GHHook wrap(GHHook hook) {
static Context repoContext(GHRepository repository, GHUser owner) {
return new RepoContext(repository, owner);
}
-
- /**
- * Org context.
- *
- * @param organization
- * the organization
- * @return the context
- */
- static Context orgContext(GHOrganization organization) {
- return new OrgContext(organization);
- }
}
diff --git a/src/main/java/org/kohsuke/github/GHInvitation.java b/src/main/java/org/kohsuke/github/GHInvitation.java
index 4985bb9c1e..726179d897 100644
--- a/src/main/java/org/kohsuke/github/GHInvitation.java
+++ b/src/main/java/org/kohsuke/github/GHInvitation.java
@@ -18,11 +18,17 @@
justification = "JSON API")
public class GHInvitation extends GHObject {
+ private String htmlUrl;
+
private int id;
- private GHRepository repository;
private GHUser invitee, inviter;
private String permissions;
- private String html_url;
+ private GHRepository repository;
+ /**
+ * Create default GHInvitation instance
+ */
+ public GHInvitation() {
+ }
/**
* Accept a repository invitation.
@@ -49,8 +55,7 @@ public void decline() throws IOException {
*
* @return the html url
*/
- @Override
public URL getHtmlUrl() {
- return GitHubClient.parseURL(html_url);
+ return GitHubClient.parseURL(htmlUrl);
}
}
diff --git a/src/main/java/org/kohsuke/github/GHIssue.java b/src/main/java/org/kohsuke/github/GHIssue.java
index 0f031b3b4c..e2d5e39bdb 100644
--- a/src/main/java/org/kohsuke/github/GHIssue.java
+++ b/src/main/java/org/kohsuke/github/GHIssue.java
@@ -31,6 +31,7 @@
import java.io.IOException;
import java.net.URL;
+import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
@@ -42,8 +43,6 @@
import java.util.Map;
import java.util.Objects;
-import static org.kohsuke.github.internal.Previews.SQUIRREL_GIRL;
-
// TODO: Auto-generated Javadoc
/**
* Represents an issue on GitHub.
@@ -55,10 +54,65 @@
* @see GHIssueSearchBuilder
*/
public class GHIssue extends GHObject implements Reactable {
+
+ /**
+ * The type PullRequest.
+ */
+ @SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD" }, justification = "JSON API")
+ public static class PullRequest {
+
+ private String diffUrl, patchUrl, htmlUrl;
+
+ /**
+ * Create default PullRequest instance
+ */
+ public PullRequest() {
+ }
+
+ /**
+ * Gets diff url.
+ *
+ * @return the diff url
+ */
+ public URL getDiffUrl() {
+ return GitHubClient.parseURL(diffUrl);
+ }
+
+ /**
+ * Gets patch url.
+ *
+ * @return the patch url
+ */
+ public URL getPatchUrl() {
+ return GitHubClient.parseURL(patchUrl);
+ }
+
+ /**
+ * Gets url.
+ *
+ * @return the url
+ */
+ public URL getUrl() {
+ return GitHubClient.parseURL(htmlUrl);
+ }
+ }
+
private static final String ASSIGNEES = "assignees";
- /** The owner. */
- GHRepository owner;
+ /**
+ * Gets the logins.
+ *
+ * @param users
+ * the users
+ * @return the logins
+ */
+ protected static List getLogins(Collection users) {
+ List names = new ArrayList(users.size());
+ for (GHUser a : users) {
+ names.add(a.getLogin());
+ }
+ return names;
+ }
/** The assignee. */
// API v3
@@ -67,202 +121,163 @@ public class GHIssue extends GHObject implements Reactable {
/** The assignees. */
protected GHUser[] assignees;
- /** The state. */
- protected String state;
-
- /** The state reason. */
- protected String state_reason;
-
- /** The number. */
- protected int number;
+ /** The body. */
+ @SkipFromToString
+ protected String body;
/** The closed at. */
- protected String closed_at;
+ protected String closedAt;
+
+ /** The closed by. */
+ protected GHUser closedBy;
/** The comments. */
protected int comments;
- /** The body. */
- @SkipFromToString
- protected String body;
-
/** The labels. */
protected List labels;
- /** The user. */
- protected GHUser user;
-
- /** The html url. */
- protected String title, html_url;
-
- /** The pull request. */
- protected GHIssue.PullRequest pull_request;
+ /** The locked. */
+ protected boolean locked;
/** The milestone. */
protected GHMilestone milestone;
- /** The closed by. */
- protected GHUser closed_by;
+ /** The number. */
+ protected int number;
- /** The locked. */
- protected boolean locked;
+ /** The pull request. */
+ protected GHIssue.PullRequest pullRequest;
- /**
- * Wrap.
- *
- * @param owner
- * the owner
- * @return the GH issue
- */
- GHIssue wrap(GHRepository owner) {
- this.owner = owner;
- if (milestone != null)
- milestone.lateBind(owner);
- return this;
- }
+ /** The state. */
+ protected String state;
- private String getRepositoryUrlPath() {
- String url = getUrl().toString();
- int index = url.indexOf("/issues");
- if (index == -1) {
- index = url.indexOf("/pulls");
- }
- return url.substring(0, index);
- }
+ /** The state reason. */
+ protected String stateReason;
- /**
- * Repository to which the issue belongs.
- *
- * @return the repository
- */
- @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
- public GHRepository getRepository() {
- try {
- synchronized (this) {
- if (owner == null) {
- String repositoryUrlPath = getRepositoryUrlPath();
- wrap(root().createRequest().withUrlPath(repositoryUrlPath).fetch(GHRepository.class));
- }
- }
- } catch (IOException e) {
- throw new GHException("Failed to fetch repository", e);
- }
- return owner;
- }
+ /** The html url. */
+ protected String title, htmlUrl;
- /**
- * The description of this pull request.
- *
- * @return the body
- */
- public String getBody() {
- return body;
- }
+ /** The user. */
+ protected GHUser user;
- /**
- * ID.
- *
- * @return the number
- */
- public int getNumber() {
- return number;
- }
+ /** The owner. */
+ GHRepository owner;
/**
- * The HTML page of this issue, like https://github.com/jenkinsci/jenkins/issues/100
- *
- * @return the html url
+ * Create default GHIssue instance
*/
- public URL getHtmlUrl() {
- return GitHubClient.parseURL(html_url);
+ public GHIssue() {
}
/**
- * Gets title.
+ * Add assignees.
*
- * @return the title
+ * @param assignees
+ * the assignees
+ * @throws IOException
+ * the io exception
*/
- public String getTitle() {
- return title;
+ public void addAssignees(Collection assignees) throws IOException {
+ root().createRequest()
+ .method("POST")
+ .with(ASSIGNEES, getLogins(assignees))
+ .withUrlPath(getIssuesApiRoute() + "/assignees")
+ .fetchInto(this);
}
/**
- * Is locked boolean.
+ * Add assignees.
*
- * @return the boolean
+ * @param assignees
+ * the assignees
+ * @throws IOException
+ * the io exception
*/
- public boolean isLocked() {
- return locked;
+ public void addAssignees(GHUser... assignees) throws IOException {
+ addAssignees(Arrays.asList(assignees));
}
/**
- * Gets state.
+ * Add labels.
*
- * @return the state
- */
- public GHIssueState getState() {
- return Enum.valueOf(GHIssueState.class, state.toUpperCase(Locale.ENGLISH));
- }
-
- /**
- * Gets state reason.
+ * Labels that are already present on the target are ignored.
*
- * @return the state reason
+ * @param labels
+ * the labels
+ * @return the complete list of labels including the new additions
+ * @throws IOException
+ * the io exception
*/
- public GHIssueStateReason getStateReason() {
- return EnumUtils.getNullableEnumOrDefault(GHIssueStateReason.class, state_reason, GHIssueStateReason.UNKNOWN);
+ public List addLabels(Collection