From 8943af98406749e1d75229031bf655fff164d2ef Mon Sep 17 00:00:00 2001 From: Liam Newman Date: Wed, 13 Nov 2019 12:47:19 -0800 Subject: [PATCH] Cleanup tabs and whitespace --- pom.xml | 22 +-- .../java/org/kohsuke/github/DeleteToken.java | 2 +- .../org/kohsuke/github/GHAuthorization.java | 4 +- .../github/GHBranchProtectionBuilder.java | 6 +- .../java/org/kohsuke/github/GHCommit.java | 16 +- .../org/kohsuke/github/GHCommitComment.java | 2 +- .../kohsuke/github/GHCommitSearchBuilder.java | 2 +- .../java/org/kohsuke/github/GHCompare.java | 4 +- .../java/org/kohsuke/github/GHDeployKey.java | 2 +- .../kohsuke/github/GHDeploymentStatus.java | 2 +- src/main/java/org/kohsuke/github/GHEmail.java | 2 +- .../java/org/kohsuke/github/GHEventInfo.java | 10 +- .../org/kohsuke/github/GHEventPayload.java | 20 +- src/main/java/org/kohsuke/github/GHHook.java | 2 +- src/main/java/org/kohsuke/github/GHHooks.java | 2 +- src/main/java/org/kohsuke/github/GHIssue.java | 20 +- .../org/kohsuke/github/GHIssueComment.java | 4 +- src/main/java/org/kohsuke/github/GHKey.java | 2 +- .../java/org/kohsuke/github/GHMilestone.java | 18 +- .../org/kohsuke/github/GHMilestoneState.java | 2 +- .../github/GHOTPRequiredException.java | 2 +- .../java/org/kohsuke/github/GHObject.java | 2 +- .../java/org/kohsuke/github/GHPerson.java | 2 +- .../java/org/kohsuke/github/GHPersonSet.java | 6 +- .../org/kohsuke/github/GHProjectCard.java | 178 +++++++++--------- .../org/kohsuke/github/GHProjectColumn.java | 140 +++++++------- .../github/GHPullRequestCommitDetail.java | 12 +- .../github/GHPullRequestFileDetail.java | 10 +- src/main/java/org/kohsuke/github/GHRef.java | 2 +- .../java/org/kohsuke/github/GHRelease.java | 2 +- .../java/org/kohsuke/github/GHRepository.java | 20 +- src/main/java/org/kohsuke/github/GHTag.java | 2 +- .../java/org/kohsuke/github/GHTagObject.java | 2 +- src/main/java/org/kohsuke/github/GHTeam.java | 4 +- .../java/org/kohsuke/github/GHThread.java | 6 +- src/main/java/org/kohsuke/github/GHTree.java | 2 +- src/main/java/org/kohsuke/github/GitHub.java | 20 +- .../org/kohsuke/github/GitHubBuilder.java | 4 +- src/main/java/org/kohsuke/github/GitUser.java | 2 +- .../java/org/kohsuke/github/Requester.java | 12 +- .../java/org/kohsuke/github/SearchResult.java | 2 +- src/test/java/org/kohsuke/github/AppTest.java | 20 +- .../org/kohsuke/github/GHProjectCardTest.java | 170 ++++++++--------- .../kohsuke/github/GHProjectColumnTest.java | 108 +++++------ .../org/kohsuke/github/GHProjectTest.java | 126 ++++++------- .../org/kohsuke/github/GHRepositoryTest.java | 4 +- .../java/org/kohsuke/github/GitHubTest.java | 2 +- .../org/kohsuke/github/Github2faTest.java | 46 ++--- 48 files changed, 526 insertions(+), 526 deletions(-) diff --git a/pom.xml b/pom.xml index 3fba1cf33..107ff1ebf 100644 --- a/pom.xml +++ b/pom.xml @@ -152,17 +152,17 @@ - - com.infradna.tool - bridge-method-injector - 1.18 - - - - process - - - + + com.infradna.tool + bridge-method-injector + 1.18 + + + + process + + + com.github.spotbugs diff --git a/src/main/java/org/kohsuke/github/DeleteToken.java b/src/main/java/org/kohsuke/github/DeleteToken.java index d9d4724eb..30079d0a2 100644 --- a/src/main/java/org/kohsuke/github/DeleteToken.java +++ b/src/main/java/org/kohsuke/github/DeleteToken.java @@ -28,7 +28,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; /** * @author Kohsuke Kawaguchi */ -@SuppressFBWarnings(value = "UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD", +@SuppressFBWarnings(value = "UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD", justification = "Being constructed by JSON deserialization") class DeleteToken { public String delete_token; diff --git a/src/main/java/org/kohsuke/github/GHAuthorization.java b/src/main/java/org/kohsuke/github/GHAuthorization.java index bf7e24c7f..428ecf92f 100644 --- a/src/main/java/org/kohsuke/github/GHAuthorization.java +++ b/src/main/java/org/kohsuke/github/GHAuthorization.java @@ -73,7 +73,7 @@ public class GHAuthorization extends GHObject { return app.name; } - @SuppressFBWarnings(value = "NM_CONFUSING", + @SuppressFBWarnings(value = "NM_CONFUSING", justification = "It's a part of the library API, cannot be changed") public URL getApiURL() { return GitHub.parseURL(url); @@ -104,7 +104,7 @@ public class GHAuthorization extends GHObject { return this; } - @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD"}, + @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD"}, justification = "JSON API") private static class App { private String url; diff --git a/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java b/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java index 822541a14..3eb5e3913 100644 --- a/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java +++ b/src/main/java/org/kohsuke/github/GHBranchProtectionBuilder.java @@ -37,7 +37,7 @@ public class GHBranchProtectionBuilder { getStatusChecks().contexts.addAll(checks); return this; } - + public GHBranchProtectionBuilder addRequiredChecks(String... checks) { addRequiredChecks(Arrays.asList(checks)); return this; @@ -148,7 +148,7 @@ public class GHBranchProtectionBuilder { } return this; } - + public GHBranchProtectionBuilder userPushAccess(GHUser... users) { for (GHUser user : users) { getRestrictions().users.add(user.getLogin()); @@ -173,7 +173,7 @@ public class GHBranchProtectionBuilder { private void addReviewRestriction(String restriction, boolean isTeam) { restrictReviewDismissals(); Restrictions restrictions = (Restrictions) prReviews.get("dismissal_restrictions"); - + if (isTeam) { restrictions.teams.add(restriction); } else { diff --git a/src/main/java/org/kohsuke/github/GHCommit.java b/src/main/java/org/kohsuke/github/GHCommit.java index 4891065ad..25fb0eae9 100644 --- a/src/main/java/org/kohsuke/github/GHCommit.java +++ b/src/main/java/org/kohsuke/github/GHCommit.java @@ -18,24 +18,24 @@ import java.util.List; * @see GHRepository#getCommit(String) * @see GHCommitComment#getCommit() */ -@SuppressFBWarnings(value = {"NP_UNWRITTEN_FIELD", "UWF_UNWRITTEN_FIELD"}, +@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. */ - @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", + @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "UWF_UNWRITTEN_FIELD"}, justification = "JSON API") public static class ShortInfo { private GHAuthor author; private GHAuthor committer; - + private String message; - + private int comment_count; static class Tree { @@ -88,7 +88,7 @@ public class GHCommit { /** * A file that was modified. */ - @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", + @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "It's being initilized by JSON deserialization") public static class File { String status; @@ -173,7 +173,7 @@ public class GHCommit { public static class Parent { @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now") - String url; + String url; String sha; } @@ -183,7 +183,7 @@ public class GHCommit { String url,avatar_url,gravatar_id; @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now") int id; - + String login; } diff --git a/src/main/java/org/kohsuke/github/GHCommitComment.java b/src/main/java/org/kohsuke/github/GHCommitComment.java index a0047c3d1..fe762d12d 100644 --- a/src/main/java/org/kohsuke/github/GHCommitComment.java +++ b/src/main/java/org/kohsuke/github/GHCommitComment.java @@ -15,7 +15,7 @@ import static org.kohsuke.github.Previews.*; * @see GHCommit#listComments() * @see GHCommit#createComment(String, String, Integer, Integer) */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@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; diff --git a/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java b/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java index 3d29aa80f..e6116e02f 100644 --- a/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java +++ b/src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java @@ -116,7 +116,7 @@ public class GHCommitSearchBuilder extends GHSearchBuilder { return items; } } - + /** * @param commitUrl a commit URL * @return the repo name ("username/reponame") diff --git a/src/main/java/org/kohsuke/github/GHCompare.java b/src/main/java/org/kohsuke/github/GHCompare.java index 100753db0..628c12e1e 100644 --- a/src/main/java/org/kohsuke/github/GHCompare.java +++ b/src/main/java/org/kohsuke/github/GHCompare.java @@ -74,7 +74,7 @@ public class GHCompare { System.arraycopy(commits, 0, newValue, 0, commits.length); return newValue; } - + /** * Gets an array of commits. * @return A copy of the array being stored in the class. @@ -99,7 +99,7 @@ public class GHCompare { * Compare commits had a child commit element with additional details we want to capture. * This extenstion of GHCommit provides that. */ - @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD"}, + @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD"}, justification = "JSON API") public static class Commit extends GHCommit { diff --git a/src/main/java/org/kohsuke/github/GHDeployKey.java b/src/main/java/org/kohsuke/github/GHDeployKey.java index f5d0f9de6..4e7f29c1e 100644 --- a/src/main/java/org/kohsuke/github/GHDeployKey.java +++ b/src/main/java/org/kohsuke/github/GHDeployKey.java @@ -39,7 +39,7 @@ public class GHDeployKey { public String toString() { return new ToStringBuilder(this).append("title",title).append("id",id).append("key",key).toString(); } - + public void delete() throws IOException { new Requester(owner.root).method("DELETE").to(String.format("/repos/%s/%s/keys/%d", owner.getOwnerName(), owner.getName(), id)); } diff --git a/src/main/java/org/kohsuke/github/GHDeploymentStatus.java b/src/main/java/org/kohsuke/github/GHDeploymentStatus.java index a058b8a44..7482e6503 100644 --- a/src/main/java/org/kohsuke/github/GHDeploymentStatus.java +++ b/src/main/java/org/kohsuke/github/GHDeploymentStatus.java @@ -29,7 +29,7 @@ public class GHDeploymentStatus extends GHObject { public URL getRepositoryUrl() { return GitHub.parseURL(repository_url); } - + public GHDeploymentState getState() { return GHDeploymentState.valueOf(state.toUpperCase(Locale.ENGLISH)); } diff --git a/src/main/java/org/kohsuke/github/GHEmail.java b/src/main/java/org/kohsuke/github/GHEmail.java index 9eeac0433..adc39561d 100644 --- a/src/main/java/org/kohsuke/github/GHEmail.java +++ b/src/main/java/org/kohsuke/github/GHEmail.java @@ -31,7 +31,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; * * @author Kelly Campbell */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "NP_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD"}, justification = "JSON API") public class GHEmail { diff --git a/src/main/java/org/kohsuke/github/GHEventInfo.java b/src/main/java/org/kohsuke/github/GHEventInfo.java index ca7e3d4f0..b486c1856 100644 --- a/src/main/java/org/kohsuke/github/GHEventInfo.java +++ b/src/main/java/org/kohsuke/github/GHEventInfo.java @@ -66,13 +66,13 @@ public class GHEventInfo { /** * Repository where the change was made. */ - @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" }, + @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); } - - @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" }, + + @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" }, justification = "The field comes from JSON deserialization") public GHUser getActor() throws IOException { return root.getUser(actor.getLogin()); @@ -85,7 +85,7 @@ public class GHEventInfo { return actor.getLogin(); } - @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" }, + @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" }, justification = "The field comes from JSON deserialization") public GHOrganization getOrganization() throws IOException { return (org==null || org.getLogin()==null) ? null : root.getOrganization(org.getLogin()); @@ -93,7 +93,7 @@ public class GHEventInfo { /** * Retrieves the payload. - * + * * @param type * Specify one of the {@link GHEventPayload} subtype that defines a type-safe access to the payload. * This must match the {@linkplain #getType() event type}. diff --git a/src/main/java/org/kohsuke/github/GHEventPayload.java b/src/main/java/org/kohsuke/github/GHEventPayload.java index acdf5c74e..b3a3b2748 100644 --- a/src/main/java/org/kohsuke/github/GHEventPayload.java +++ b/src/main/java/org/kohsuke/github/GHEventPayload.java @@ -9,7 +9,7 @@ import java.util.List; /** * Base type for types used in databinding of the event payload. - * + * * @see GitHub#parseEventPayload(Reader, Class) * @see GHEventInfo#getPayload(Class) */ @@ -46,7 +46,7 @@ public abstract class GHEventPayload { * * @see authoritative source */ - @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", + @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public static class PullRequest extends GHEventPayload { private String action; @@ -100,7 +100,7 @@ public abstract class GHEventPayload { public String getAction() { return action; } - + public GHPullRequestReview getReview() { return review; } @@ -118,9 +118,9 @@ public abstract class GHEventPayload { super.wrapUp(root); if (review==null) throw new IllegalStateException("Expected pull_request_review payload, but got something else. Maybe we've got another type of event?"); - + review.wrapUp(pull_request); - + if (repository!=null) { repository.wrap(root); pull_request.wrapUp(repository); @@ -129,7 +129,7 @@ public abstract class GHEventPayload { } } } - + /** * A review comment was added to a pull request * @@ -144,7 +144,7 @@ public abstract class GHEventPayload { public String getAction() { return action; } - + public GHPullRequestReviewComment getComment() { return comment; } @@ -162,9 +162,9 @@ public abstract class GHEventPayload { super.wrapUp(root); if (comment==null) throw new IllegalStateException("Expected pull_request_review_comment payload, but got something else. Maybe we've got another type of event?"); - + comment.wrapUp(pull_request); - + if (repository!=null) { repository.wrap(root); pull_request.wrapUp(repository); @@ -224,7 +224,7 @@ public abstract class GHEventPayload { * * @see authoritative source */ - @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" }, + @SuppressFBWarnings(value = {"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", "NP_UNWRITTEN_FIELD" }, justification = "Constructed by JSON deserialization") public static class IssueComment extends GHEventPayload { private String action; diff --git a/src/main/java/org/kohsuke/github/GHHook.java b/src/main/java/org/kohsuke/github/GHHook.java index b7f450307..f1fb45cdb 100644 --- a/src/main/java/org/kohsuke/github/GHHook.java +++ b/src/main/java/org/kohsuke/github/GHHook.java @@ -13,7 +13,7 @@ import java.util.Map; /** * @author Kohsuke Kawaguchi */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public abstract class GHHook extends GHObject { String name; diff --git a/src/main/java/org/kohsuke/github/GHHooks.java b/src/main/java/org/kohsuke/github/GHHooks.java index 6ecbb04b6..9ea4910b4 100644 --- a/src/main/java/org/kohsuke/github/GHHooks.java +++ b/src/main/java/org/kohsuke/github/GHHooks.java @@ -20,7 +20,7 @@ class GHHooks { } public List getHooks() throws IOException { - + GHHook [] hookArray = root.retrieve().to(collection(),collectionClass()); // jdk/eclipse bug requires this to be on separate line List list = new ArrayList(Arrays.asList(hookArray)); for (GHHook h : list) diff --git a/src/main/java/org/kohsuke/github/GHIssue.java b/src/main/java/org/kohsuke/github/GHIssue.java index 20343266b..aa7e1fbbe 100644 --- a/src/main/java/org/kohsuke/github/GHIssue.java +++ b/src/main/java/org/kohsuke/github/GHIssue.java @@ -54,7 +54,7 @@ public class GHIssue extends GHObject implements Reactable{ GitHub root; GHRepository owner; - + // API v3 protected GHUser assignee; // not sure what this field is now that 'assignees' exist protected GHUser[] assignees; @@ -78,7 +78,7 @@ public class GHIssue extends GHObject implements Reactable{ */ public static class Label extends GHLabel { } - + /*package*/ GHIssue wrap(GHRepository owner) { this.owner = owner; if(milestone != null) milestone.wrap(owner); @@ -281,13 +281,13 @@ public class GHIssue extends GHObject implements Reactable{ /** * Obtains all the comments associated with this issue. - * - * @see #listComments() + * + * @see #listComments() */ public List getComments() throws IOException { return listComments().asList(); } - + /** * Obtains all the comments associated with this issue. */ @@ -382,7 +382,7 @@ public class GHIssue extends GHObject implements Reactable{ */ return root.intern(closed_by); } - + public int getCommentsCount(){ return comments; } @@ -402,19 +402,19 @@ public class GHIssue extends GHObject implements Reactable{ return milestone; } - @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD"}, + @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD"}, justification = "JSON API") public static class PullRequest{ private String diff_url, patch_url, html_url; - + public URL getDiffUrl() { return GitHub.parseURL(diff_url); } - + public URL getPatchUrl() { return GitHub.parseURL(patch_url); } - + public URL getUrl() { return GitHub.parseURL(html_url); } diff --git a/src/main/java/org/kohsuke/github/GHIssueComment.java b/src/main/java/org/kohsuke/github/GHIssueComment.java index 258718312..f53e2fb2f 100644 --- a/src/main/java/org/kohsuke/github/GHIssueComment.java +++ b/src/main/java/org/kohsuke/github/GHIssueComment.java @@ -74,7 +74,7 @@ public class GHIssueComment extends GHObject implements Reactable { public GHUser getUser() throws IOException { return owner == null || owner.root.isOffline() ? user : owner.root.getUser(user.getLogin()); } - + @Override public URL getHtmlUrl() { return GitHub.parseURL(html_url); @@ -83,7 +83,7 @@ public class GHIssueComment extends GHObject implements Reactable { public GHCommentAuthorAssociation getAuthorAssociation() { return GHCommentAuthorAssociation.valueOf(author_association); } - + /** * Updates the body of the issue comment. */ diff --git a/src/main/java/org/kohsuke/github/GHKey.java b/src/main/java/org/kohsuke/github/GHKey.java index d4c8197db..d88009232 100644 --- a/src/main/java/org/kohsuke/github/GHKey.java +++ b/src/main/java/org/kohsuke/github/GHKey.java @@ -38,7 +38,7 @@ public class GHKey { public GitHub getRoot() { return root; } - + public boolean isVerified() { return verified; } diff --git a/src/main/java/org/kohsuke/github/GHMilestone.java b/src/main/java/org/kohsuke/github/GHMilestone.java index 3ed54636c..8a57f024e 100644 --- a/src/main/java/org/kohsuke/github/GHMilestone.java +++ b/src/main/java/org/kohsuke/github/GHMilestone.java @@ -6,7 +6,7 @@ import java.util.Date; import java.util.Locale; /** - * + * * @author Yusuke Kokubo * */ @@ -22,15 +22,15 @@ public class GHMilestone extends GHObject { public GitHub getRoot() { return root; } - + public GHRepository getOwner() { return owner; } - + public GHUser getCreator() throws IOException { return root.intern(creator); } - + public Date getDueOn() { if (due_on == null) return null; return GitHub.parseDate(due_on); @@ -46,19 +46,19 @@ public class GHMilestone extends GHObject { public String getTitle() { return title; } - + public String getDescription() { return description; } - + public int getClosedIssues() { return closed_issues; } - + public int getOpenIssues() { return open_issues; } - + public int getNumber() { return number; } @@ -66,7 +66,7 @@ public class GHMilestone extends GHObject { public URL getHtmlUrl() { return GitHub.parseURL(html_url); } - + public GHMilestoneState getState() { return Enum.valueOf(GHMilestoneState.class, state.toUpperCase(Locale.ENGLISH)); } diff --git a/src/main/java/org/kohsuke/github/GHMilestoneState.java b/src/main/java/org/kohsuke/github/GHMilestoneState.java index 92194546c..9a1a55afd 100644 --- a/src/main/java/org/kohsuke/github/GHMilestoneState.java +++ b/src/main/java/org/kohsuke/github/GHMilestoneState.java @@ -1,7 +1,7 @@ package org.kohsuke.github; /** - * + * * @author Yusuke Kokubo * */ diff --git a/src/main/java/org/kohsuke/github/GHOTPRequiredException.java b/src/main/java/org/kohsuke/github/GHOTPRequiredException.java index f7d935bd5..ab3db56cf 100644 --- a/src/main/java/org/kohsuke/github/GHOTPRequiredException.java +++ b/src/main/java/org/kohsuke/github/GHOTPRequiredException.java @@ -1,7 +1,7 @@ package org.kohsuke.github; /** * This exception is thrown when GitHub is requesting an OTP from the user - * + * * @author Kevin Harrington mad.hephaestus@gmail.com * */ diff --git a/src/main/java/org/kohsuke/github/GHObject.java b/src/main/java/org/kohsuke/github/GHObject.java index 2bad0891b..4bae2292f 100644 --- a/src/main/java/org/kohsuke/github/GHObject.java +++ b/src/main/java/org/kohsuke/github/GHObject.java @@ -16,7 +16,7 @@ import java.util.Map; /** * Most (all?) domain objects in GitHub seems to have these 4 properties. */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public abstract class GHObject { /** diff --git a/src/main/java/org/kohsuke/github/GHPerson.java b/src/main/java/org/kohsuke/github/GHPerson.java index 137dd5b36..e6ad76d5a 100644 --- a/src/main/java/org/kohsuke/github/GHPerson.java +++ b/src/main/java/org/kohsuke/github/GHPerson.java @@ -13,7 +13,7 @@ import java.util.TreeMap; /** * Common part of {@link GHUser} and {@link GHOrganization}. - * + * * @author Kohsuke Kawaguchi */ public abstract class GHPerson extends GHObject { diff --git a/src/main/java/org/kohsuke/github/GHPersonSet.java b/src/main/java/org/kohsuke/github/GHPersonSet.java index eb35b1bf7..2a68a3ff5 100644 --- a/src/main/java/org/kohsuke/github/GHPersonSet.java +++ b/src/main/java/org/kohsuke/github/GHPersonSet.java @@ -6,12 +6,12 @@ import java.util.HashSet; /** * Set of {@link GHPerson} with helper lookup methods. - * + * * @author Kohsuke Kawaguchi */ public class GHPersonSet extends HashSet { private static final long serialVersionUID = 1L; - + public GHPersonSet() { } @@ -39,5 +39,5 @@ public class GHPersonSet extends HashSet { if (t.getLogin().equals(login)) return t; return null; - } + } } diff --git a/src/main/java/org/kohsuke/github/GHProjectCard.java b/src/main/java/org/kohsuke/github/GHProjectCard.java index d6fb97cd8..a4bd9dc40 100644 --- a/src/main/java/org/kohsuke/github/GHProjectCard.java +++ b/src/main/java/org/kohsuke/github/GHProjectCard.java @@ -12,112 +12,112 @@ import static org.kohsuke.github.Previews.INERTIA; * @author Gunnar Skjold */ public class GHProjectCard extends GHObject { - private GitHub root; - private GHProject project; - private GHProjectColumn column; + private GitHub root; + private GHProject project; + private GHProjectColumn column; - private String note; - private GHUser creator; - private String content_url, project_url, column_url; - private boolean archived; + private String note; + private GHUser creator; + private String content_url, project_url, column_url; + private boolean archived; - public URL getHtmlUrl() throws IOException { - return null; - } + public URL getHtmlUrl() throws IOException { + return null; + } - public GHProjectCard wrap(GitHub root) { - this.root = root; - return this; - } + public GHProjectCard wrap(GitHub root) { + this.root = root; + return this; + } - public GHProjectCard wrap(GHProjectColumn column) { - this.column = column; - this.project = column.project; - this.root = column.root; - return this; - } + public GHProjectCard wrap(GHProjectColumn column) { + this.column = column; + this.project = column.project; + this.root = column.root; + return this; + } - public GitHub getRoot() { - return root; - } + public GitHub getRoot() { + return root; + } - public GHProject getProject() throws IOException { - if(project == null) { - try { - project = root.retrieve().to(getProjectUrl().getPath(), GHProject.class).wrap(root); - } catch (FileNotFoundException e) { - return null; - } - } - return project; - } + public GHProject getProject() throws IOException { + if(project == null) { + try { + project = root.retrieve().to(getProjectUrl().getPath(), GHProject.class).wrap(root); + } catch (FileNotFoundException e) { + return null; + } + } + return project; + } - public GHProjectColumn getColumn() throws IOException { - if(column == null) { - try { - column = root.retrieve().to(getColumnUrl().getPath(), GHProjectColumn.class).wrap(root); - } catch (FileNotFoundException e) { - return null; - } - } - return column; - } + public GHProjectColumn getColumn() throws IOException { + if(column == null) { + try { + column = root.retrieve().to(getColumnUrl().getPath(), GHProjectColumn.class).wrap(root); + } catch (FileNotFoundException e) { + return null; + } + } + return column; + } - public GHIssue getContent() throws IOException { - if(StringUtils.isEmpty(content_url)) - return null; - try { - if(content_url.contains("/pulls")) { - return root.retrieve().to(getContentUrl().getPath(), GHPullRequest.class).wrap(root); - } else { - return root.retrieve().to(getContentUrl().getPath(), GHIssue.class).wrap(root); - } - } catch (FileNotFoundException e) { - return null; - } - } + public GHIssue getContent() throws IOException { + if(StringUtils.isEmpty(content_url)) + return null; + try { + if(content_url.contains("/pulls")) { + return root.retrieve().to(getContentUrl().getPath(), GHPullRequest.class).wrap(root); + } else { + return root.retrieve().to(getContentUrl().getPath(), GHIssue.class).wrap(root); + } + } catch (FileNotFoundException e) { + return null; + } + } - public String getNote() { - return note; - } + public String getNote() { + return note; + } - public GHUser getCreator() { - return creator; - } + public GHUser getCreator() { + return creator; + } - public URL getContentUrl() { - return GitHub.parseURL(content_url); - } + public URL getContentUrl() { + return GitHub.parseURL(content_url); + } - public URL getProjectUrl() { - return GitHub.parseURL(project_url); - } + public URL getProjectUrl() { + return GitHub.parseURL(project_url); + } - public URL getColumnUrl() { - return GitHub.parseURL(column_url); - } + public URL getColumnUrl() { + return GitHub.parseURL(column_url); + } - public boolean isArchived() { - return archived; - } + public boolean isArchived() { + return archived; + } - public void setNote(String note) throws IOException { - edit("note", note); - } + public void setNote(String note) throws IOException { + edit("note", note); + } - public void setArchived(boolean archived) throws IOException { - edit("archived", archived); - } + public void setArchived(boolean archived) throws IOException { + edit("archived", archived); + } - private void edit(String key, Object value) throws IOException { - new Requester(root).withPreview(INERTIA)._with(key, value).method("PATCH").to(getApiRoute()); - } + private void edit(String key, Object value) throws IOException { + new Requester(root).withPreview(INERTIA)._with(key, value).method("PATCH").to(getApiRoute()); + } - protected String getApiRoute() { - return String.format("/projects/columns/cards/%d", id); - } + protected String getApiRoute() { + return String.format("/projects/columns/cards/%d", id); + } - public void delete() throws IOException { - new Requester(root).withPreview(INERTIA).method("DELETE").to(getApiRoute()); - } + public void delete() throws IOException { + new Requester(root).withPreview(INERTIA).method("DELETE").to(getApiRoute()); + } } diff --git a/src/main/java/org/kohsuke/github/GHProjectColumn.java b/src/main/java/org/kohsuke/github/GHProjectColumn.java index 3b853962f..b9a54e9c4 100644 --- a/src/main/java/org/kohsuke/github/GHProjectColumn.java +++ b/src/main/java/org/kohsuke/github/GHProjectColumn.java @@ -10,89 +10,89 @@ import static org.kohsuke.github.Previews.INERTIA; * @author Gunnar Skjold */ public class GHProjectColumn extends GHObject { - protected GitHub root; - protected GHProject project; + protected GitHub root; + protected GHProject project; - private String name; - private String project_url; + private String name; + private String project_url; - @Override - public URL getHtmlUrl() throws IOException { - return null; - } + @Override + public URL getHtmlUrl() throws IOException { + return null; + } - public GHProjectColumn wrap(GitHub root) { - this.root = root; - return this; - } + public GHProjectColumn wrap(GitHub root) { + this.root = root; + return this; + } - public GHProjectColumn wrap(GHProject project) { - this.project = project; - this.root = project.root; - return this; - } + public GHProjectColumn wrap(GHProject project) { + this.project = project; + this.root = project.root; + return this; + } - public GitHub getRoot() { - return root; - } + public GitHub getRoot() { + return root; + } - public GHProject getProject() throws IOException { - if(project == null) { - try { - project = root.retrieve().to(getProjectUrl().getPath(), GHProject.class).wrap(root); - } catch (FileNotFoundException e) { - return null; - } - } - return project; - } + public GHProject getProject() throws IOException { + if(project == null) { + try { + project = root.retrieve().to(getProjectUrl().getPath(), GHProject.class).wrap(root); + } catch (FileNotFoundException e) { + return null; + } + } + return project; + } - public String getName() { - return name; - } + public String getName() { + return name; + } - public URL getProjectUrl() { - return GitHub.parseURL(project_url); - } + public URL getProjectUrl() { + return GitHub.parseURL(project_url); + } - public void setName(String name) throws IOException { - edit("name", name); - } + public void setName(String name) throws IOException { + edit("name", name); + } - private void edit(String key, Object value) throws IOException { - new Requester(root).withPreview(INERTIA)._with(key, value).method("PATCH").to(getApiRoute()); - } + private void edit(String key, Object value) throws IOException { + new Requester(root).withPreview(INERTIA)._with(key, value).method("PATCH").to(getApiRoute()); + } - protected String getApiRoute() { - return String.format("/projects/columns/%d", id); - } + protected String getApiRoute() { + return String.format("/projects/columns/%d", id); + } - public void delete() throws IOException { - new Requester(root).withPreview(INERTIA).method("DELETE").to(getApiRoute()); - } + public void delete() throws IOException { + new Requester(root).withPreview(INERTIA).method("DELETE").to(getApiRoute()); + } - public PagedIterable listCards() throws IOException { - final GHProjectColumn column = this; - return root.retrieve() - .withPreview(INERTIA) - .asPagedIterable( - String.format("/projects/columns/%d/cards", id), - GHProjectCard[].class, - item -> item.wrap(column) ); - } + public PagedIterable listCards() throws IOException { + final GHProjectColumn column = this; + return root.retrieve() + .withPreview(INERTIA) + .asPagedIterable( + String.format("/projects/columns/%d/cards", id), + GHProjectCard[].class, + item -> item.wrap(column) ); + } - public GHProjectCard createCard(String note) throws IOException { - return root.retrieve().method("POST") - .withPreview(INERTIA) - .with("note", note) - .to(String.format("/projects/columns/%d/cards", id), GHProjectCard.class).wrap(this); - } + public GHProjectCard createCard(String note) throws IOException { + return root.retrieve().method("POST") + .withPreview(INERTIA) + .with("note", note) + .to(String.format("/projects/columns/%d/cards", id), GHProjectCard.class).wrap(this); + } - public GHProjectCard createCard(GHIssue issue) throws IOException { - return root.retrieve().method("POST") - .withPreview(INERTIA) - .with("content_type", issue instanceof GHPullRequest ? "PullRequest" : "Issue") - .with("content_id", issue.getId()) - .to(String.format("/projects/columns/%d/cards", id), GHProjectCard.class).wrap(this); - } + public GHProjectCard createCard(GHIssue issue) throws IOException { + return root.retrieve().method("POST") + .withPreview(INERTIA) + .with("content_type", issue instanceof GHPullRequest ? "PullRequest" : "Issue") + .with("content_id", issue.getId()) + .to(String.format("/projects/columns/%d/cards", id), GHProjectCard.class).wrap(this); + } } diff --git a/src/main/java/org/kohsuke/github/GHPullRequestCommitDetail.java b/src/main/java/org/kohsuke/github/GHPullRequestCommitDetail.java index e6c558b9e..b2a4f82eb 100644 --- a/src/main/java/org/kohsuke/github/GHPullRequestCommitDetail.java +++ b/src/main/java/org/kohsuke/github/GHPullRequestCommitDetail.java @@ -1,18 +1,18 @@ /* * The MIT License - * + * * Copyright (c) 2013, Luca Milanesio - * + * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: - * + * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. - * + * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE @@ -30,11 +30,11 @@ import java.net.URL; /** * Commit detail inside a {@link GHPullRequest}. - * + * * @author Luca Milanesio * @see GHPullRequest#listCommits() */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "URF_UNREAD_FIELD"}, justification = "JSON API") public class GHPullRequestCommitDetail { private GHPullRequest owner; diff --git a/src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java b/src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java index 35bb86c44..deda76ecb 100644 --- a/src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java +++ b/src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java @@ -1,18 +1,18 @@ /* * The MIT License - * + * * Copyright (c) 2015, Julien Henry - * + * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: - * + * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. - * + * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE @@ -27,7 +27,7 @@ import java.net.URL; /** * File detail inside a {@link GHPullRequest}. - * + * * @author Julien Henry * @see GHPullRequest#listFiles() */ diff --git a/src/main/java/org/kohsuke/github/GHRef.java b/src/main/java/org/kohsuke/github/GHRef.java index c8462d3fe..892edb2ad 100644 --- a/src/main/java/org/kohsuke/github/GHRef.java +++ b/src/main/java/org/kohsuke/github/GHRef.java @@ -79,7 +79,7 @@ public class GHRef { return in; } - @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", + @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public static class GHObject { private String type, sha, url; diff --git a/src/main/java/org/kohsuke/github/GHRelease.java b/src/main/java/org/kohsuke/github/GHRelease.java index 0df6b415b..44cab38f7 100644 --- a/src/main/java/org/kohsuke/github/GHRelease.java +++ b/src/main/java/org/kohsuke/github/GHRelease.java @@ -133,7 +133,7 @@ public class GHRelease extends GHObject { s.close(); } } - + public GHAsset uploadAsset(String filename, InputStream stream, String contentType) throws IOException { Requester builder = new Requester(owner.root); diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java index 88a13b3be..d21562289 100644 --- a/src/main/java/org/kohsuke/github/GHRepository.java +++ b/src/main/java/org/kohsuke/github/GHRepository.java @@ -84,11 +84,11 @@ public class GHRepository extends GHObject { private String git_url, ssh_url, clone_url, svn_url, mirror_url; private GHUser owner; // not fully populated. beware. private boolean has_issues, has_wiki, fork, has_downloads, has_pages, archived; - + private boolean allow_squash_merge; private boolean allow_merge_commit; private boolean allow_rebase_merge; - + @JsonProperty("private") private boolean _private; private int forks_count, stargazers_count, watchers_count, size, open_issues_count, subscribers_count; @@ -326,7 +326,7 @@ public class GHRepository extends GHObject { return null; // no release for this tag } } - + public GHRelease getLatestRelease() throws IOException { try { return root.retrieve().to(getApiTailUrl("releases/latest"), GHRelease.class).wrap(this); @@ -386,15 +386,15 @@ public class GHRepository extends GHObject { public boolean isArchived() { return archived; } - + public boolean isAllowSquashMerge() { return allow_squash_merge; } - + public boolean isAllowMergeCommit() { return allow_merge_commit; } - + public boolean isAllowRebaseMerge() { return allow_rebase_merge; } @@ -624,19 +624,19 @@ public class GHRepository extends GHObject { public void setPrivate(boolean value) throws IOException { edit("private", Boolean.toString(value)); } - + public void allowSquashMerge(boolean value) throws IOException { edit("allow_squash_merge", Boolean.toString(value)); } - + public void allowMergeCommit(boolean value) throws IOException { edit("allow_merge_commit", Boolean.toString(value)); } - + public void allowRebaseMerge(boolean value) throws IOException { edit("allow_rebase_merge", Boolean.toString(value)); } - + /** * Deletes this repository. */ diff --git a/src/main/java/org/kohsuke/github/GHTag.java b/src/main/java/org/kohsuke/github/GHTag.java index 802f51f8f..e8b9435a9 100644 --- a/src/main/java/org/kohsuke/github/GHTag.java +++ b/src/main/java/org/kohsuke/github/GHTag.java @@ -7,7 +7,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; * * @see GHRepository#listTags() */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public class GHTag { private GHRepository owner; diff --git a/src/main/java/org/kohsuke/github/GHTagObject.java b/src/main/java/org/kohsuke/github/GHTagObject.java index 0e3acdeaa..b2b667b1f 100644 --- a/src/main/java/org/kohsuke/github/GHTagObject.java +++ b/src/main/java/org/kohsuke/github/GHTagObject.java @@ -7,7 +7,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; * * @see GHRepository#getTagObject(String) */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public class GHTagObject { private GHRepository owner; diff --git a/src/main/java/org/kohsuke/github/GHTeam.java b/src/main/java/org/kohsuke/github/GHTeam.java index 00f43e194..dfc63fe3a 100644 --- a/src/main/java/org/kohsuke/github/GHTeam.java +++ b/src/main/java/org/kohsuke/github/GHTeam.java @@ -8,7 +8,7 @@ import java.util.TreeMap; /** * A team in GitHub organization. - * + * * @author Kohsuke Kawaguchi */ public class GHTeam implements Refreshable { @@ -171,7 +171,7 @@ public class GHTeam implements Refreshable { public void remove(GHRepository r) throws IOException { root.retrieve().method("DELETE").to(api("/repos/" + r.getOwnerName() + '/' + r.getName()), null); } - + /** * Deletes this team. */ diff --git a/src/main/java/org/kohsuke/github/GHThread.java b/src/main/java/org/kohsuke/github/GHThread.java index faf4c87b7..5a6be799a 100644 --- a/src/main/java/org/kohsuke/github/GHThread.java +++ b/src/main/java/org/kohsuke/github/GHThread.java @@ -14,7 +14,7 @@ import java.util.Date; * @see GHNotificationStream * @author Kohsuke Kawaguchi */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public class GHThread extends GHObject { private GitHub root; @@ -71,14 +71,14 @@ public class GHThread extends GHObject { public String getType() { return subject.type; } - + public String getLastCommentUrl() { return subject.latest_comment_url; } /** * If this thread is about an issue, return that issue. - * + * * @return null if this thread is not about an issue. */ public GHIssue getBoundIssue() throws IOException { diff --git a/src/main/java/org/kohsuke/github/GHTree.java b/src/main/java/org/kohsuke/github/GHTree.java index d52e02a79..527b24063 100644 --- a/src/main/java/org/kohsuke/github/GHTree.java +++ b/src/main/java/org/kohsuke/github/GHTree.java @@ -49,7 +49,7 @@ public class GHTree { } /** - * Returns true if the number of items in the tree array exceeded the GitHub maximum limit. + * Returns true if the number of items in the tree array exceeded the GitHub maximum limit. * @return true true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false. */ public boolean isTruncated() { diff --git a/src/main/java/org/kohsuke/github/GitHub.java b/src/main/java/org/kohsuke/github/GitHub.java index 94ffd6f0b..5741db69d 100644 --- a/src/main/java/org/kohsuke/github/GitHub.java +++ b/src/main/java/org/kohsuke/github/GitHub.java @@ -570,7 +570,7 @@ public class GitHub { } return r; } - + /** * Alias for {@link #getUserPublicOrganizations(String)}. */ @@ -625,7 +625,7 @@ public class GitHub { public GHTeam getTeam(int id) throws IOException { return retrieve().to("/teams/" + id, GHTeam.class).wrapUp(this); } - + /** * Public events visible to you. Equivalent of what's displayed on https://github.com/ */ @@ -705,9 +705,9 @@ public class GitHub { } /** * Creates a new authorization using an OTP. - * + * * Start by running createToken, if exception is thrown, prompt for OTP from user - * + * * Once OTP is received, call this token request * * The token created can be then used for {@link GitHub#connectUsingOAuth(String)} in the future. @@ -715,18 +715,18 @@ public class GitHub { * @see Documentation */ public GHAuthorization createToken(Collection scope, String note, String noteUrl, Supplier OTP) throws IOException{ - try { - return createToken(scope, note, noteUrl); - }catch (GHOTPRequiredException ex){ - String OTPstring=OTP.get(); - Requester requester = new Requester(this) + try { + return createToken(scope, note, noteUrl); + }catch (GHOTPRequiredException ex){ + String OTPstring=OTP.get(); + Requester requester = new Requester(this) .with("scopes", scope) .with("note", note) .with("note_url", noteUrl); // Add the OTP from the user requester.setHeader("x-github-otp", OTPstring); return requester.method("POST").to("/authorizations", GHAuthorization.class).wrap(this); - } + } } /** * @see docs diff --git a/src/main/java/org/kohsuke/github/GitHubBuilder.java b/src/main/java/org/kohsuke/github/GitHubBuilder.java index f0db8e609..352538a1e 100644 --- a/src/main/java/org/kohsuke/github/GitHubBuilder.java +++ b/src/main/java/org/kohsuke/github/GitHubBuilder.java @@ -144,10 +144,10 @@ public class GitHubBuilder implements Cloneable { } finally { IOUtils.closeQuietly(in); } - + return fromProperties(props); } - + public static GitHubBuilder fromProperties(Properties props) { GitHubBuilder self = new GitHubBuilder(); self.withOAuthToken(props.getProperty("oauth"), props.getProperty("login")); diff --git a/src/main/java/org/kohsuke/github/GitUser.java b/src/main/java/org/kohsuke/github/GitUser.java index 9cd50bb22..939787a34 100644 --- a/src/main/java/org/kohsuke/github/GitUser.java +++ b/src/main/java/org/kohsuke/github/GitUser.java @@ -13,7 +13,7 @@ import java.util.Date; * * @author Kohsuke Kawaguchi */ -@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API") public class GitUser { private String name, email, date; diff --git a/src/main/java/org/kohsuke/github/Requester.java b/src/main/java/org/kohsuke/github/Requester.java index 12765bd45..74e8b4208 100644 --- a/src/main/java/org/kohsuke/github/Requester.java +++ b/src/main/java/org/kohsuke/github/Requester.java @@ -190,10 +190,10 @@ class Requester { return this; } - public Requester withNullable(String key, Object value) { - args.add(new Entry(key, value)); - return this; - } + public Requester withNullable(String key, Object value) { + args.add(new Entry(key, value)); + return this; + } public Requester _with(String key, Object value) { if (value!=null) { @@ -764,8 +764,8 @@ class Requester { } } if (responseCode == HttpURLConnection.HTTP_UNAUTHORIZED) // 401 Unauthorized == bad creds or OTP request - // In the case of a user with 2fa enabled, a header with X-GitHub-OTP - // will be returned indicating the user needs to respond with an otp + // In the case of a user with 2fa enabled, a header with X-GitHub-OTP + // will be returned indicating the user needs to respond with an otp if(uc.getHeaderField("X-GitHub-OTP") != null) throw (IOException) new GHOTPRequiredException().withResponseHeaderFields(uc).initCause(e); else diff --git a/src/main/java/org/kohsuke/github/SearchResult.java b/src/main/java/org/kohsuke/github/SearchResult.java index 2fb2dca06..53a65ab68 100644 --- a/src/main/java/org/kohsuke/github/SearchResult.java +++ b/src/main/java/org/kohsuke/github/SearchResult.java @@ -10,7 +10,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; abstract class SearchResult { @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization") int total_count; - + @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization") boolean incomplete_results; diff --git a/src/test/java/org/kohsuke/github/AppTest.java b/src/test/java/org/kohsuke/github/AppTest.java index 9f4d253ef..6be25916c 100755 --- a/src/test/java/org/kohsuke/github/AppTest.java +++ b/src/test/java/org/kohsuke/github/AppTest.java @@ -217,23 +217,23 @@ public class AppTest extends AbstractGitHubWireMockTest { } } } - + @Test public void testUserPublicOrganizationsWhenThereAreSome() throws IOException { - // kohsuke had some public org memberships at the time Wiremock recorded the GitHub API responses - GHUser user = new GHUser(); - user.login = "kohsuke"; - + // kohsuke had some public org memberships at the time Wiremock recorded the GitHub API responses + GHUser user = new GHUser(); + user.login = "kohsuke"; + Map orgs = gitHub.getUserPublicOrganizations( user ); assertFalse(orgs.isEmpty()); } - + @Test public void testUserPublicOrganizationsWhenThereAreNone() throws IOException { - // bitwiseman had no public org memberships at the time Wiremock recorded the GitHub API responses - GHUser user = new GHUser(); - user.login = "bitwiseman"; - + // bitwiseman had no public org memberships at the time Wiremock recorded the GitHub API responses + GHUser user = new GHUser(); + user.login = "bitwiseman"; + Map orgs = gitHub.getUserPublicOrganizations( user ); assertTrue(orgs.isEmpty()); } diff --git a/src/test/java/org/kohsuke/github/GHProjectCardTest.java b/src/test/java/org/kohsuke/github/GHProjectCardTest.java index e155f8602..7a62d1fa9 100644 --- a/src/test/java/org/kohsuke/github/GHProjectCardTest.java +++ b/src/test/java/org/kohsuke/github/GHProjectCardTest.java @@ -12,96 +12,96 @@ import java.io.IOException; * @author Gunnar Skjold */ public class GHProjectCardTest extends AbstractGitHubWireMockTest { - private GHOrganization org; - private GHProject project; - private GHProjectColumn column; - private GHProjectCard card; + private GHOrganization org; + private GHProject project; + private GHProjectColumn column; + private GHProjectCard card; - @Before - public void setUp() throws Exception { - org = gitHub.getOrganization(GITHUB_API_TEST_ORG); - project = org.createProject("test-project", "This is a test project"); - column = project.createColumn("column-one"); - card = column.createCard("This is a card"); - } + @Before + public void setUp() throws Exception { + org = gitHub.getOrganization(GITHUB_API_TEST_ORG); + project = org.createProject("test-project", "This is a test project"); + column = project.createColumn("column-one"); + card = column.createCard("This is a card"); + } - @Test - public void testCreatedCard() { - Assert.assertEquals("This is a card", card.getNote()); - Assert.assertFalse(card.isArchived()); - } + @Test + public void testCreatedCard() { + Assert.assertEquals("This is a card", card.getNote()); + Assert.assertFalse(card.isArchived()); + } - @Test - public void testEditCardNote() throws IOException { - card.setNote("New note"); - card = gitHub.getProjectCard(card.getId()); - Assert.assertEquals("New note", card.getNote()); - Assert.assertFalse(card.isArchived()); - } + @Test + public void testEditCardNote() throws IOException { + card.setNote("New note"); + card = gitHub.getProjectCard(card.getId()); + Assert.assertEquals("New note", card.getNote()); + Assert.assertFalse(card.isArchived()); + } - @Test - public void testArchiveCard() throws IOException { - card.setArchived(true); - card = gitHub.getProjectCard(card.getId()); - Assert.assertEquals("This is a card", card.getNote()); - Assert.assertTrue(card.isArchived()); - } + @Test + public void testArchiveCard() throws IOException { + card.setArchived(true); + card = gitHub.getProjectCard(card.getId()); + Assert.assertEquals("This is a card", card.getNote()); + Assert.assertTrue(card.isArchived()); + } - @Test - public void testCreateCardFromIssue() throws IOException { - GHRepository repo = org.createRepository("repo-for-project-card").create(); - try { - GHIssue issue = repo.createIssue("new-issue").body("With body").create(); - GHProjectCard card = column.createCard(issue); - Assert.assertEquals(issue.getUrl(), card.getContentUrl()); - } finally { - repo.delete(); - } - } + @Test + public void testCreateCardFromIssue() throws IOException { + GHRepository repo = org.createRepository("repo-for-project-card").create(); + try { + GHIssue issue = repo.createIssue("new-issue").body("With body").create(); + GHProjectCard card = column.createCard(issue); + Assert.assertEquals(issue.getUrl(), card.getContentUrl()); + } finally { + repo.delete(); + } + } - @Test - public void testDeleteCard() throws IOException { - card.delete(); - try { - card = gitHub.getProjectCard(card.getId()); - Assert.assertNull(card); - } catch (FileNotFoundException e) { - card = null; - } - } + @Test + public void testDeleteCard() throws IOException { + card.delete(); + try { + card = gitHub.getProjectCard(card.getId()); + Assert.assertNull(card); + } catch (FileNotFoundException e) { + card = null; + } + } - @After - public void after() throws IOException { - if(mockGitHub.isUseProxy()) { - if (card != null) { - card = gitHubBeforeAfter.getProjectCard(card.getId()); - try { - card.delete(); - card = null; - } catch (FileNotFoundException e) { - card = null; - } - } - if (column != null) { - column = gitHubBeforeAfter - .getProjectColumn(column.getId()); - try { - column.delete(); - column = null; - } catch (FileNotFoundException e) { - column = null; - } - } - if (project != null) { - project = gitHubBeforeAfter - .getProject(project.getId()); - try { - project.delete(); - project = null; - } catch (FileNotFoundException e) { - project = null; - } - } - } - } + @After + public void after() throws IOException { + if(mockGitHub.isUseProxy()) { + if (card != null) { + card = gitHubBeforeAfter.getProjectCard(card.getId()); + try { + card.delete(); + card = null; + } catch (FileNotFoundException e) { + card = null; + } + } + if (column != null) { + column = gitHubBeforeAfter + .getProjectColumn(column.getId()); + try { + column.delete(); + column = null; + } catch (FileNotFoundException e) { + column = null; + } + } + if (project != null) { + project = gitHubBeforeAfter + .getProject(project.getId()); + try { + project.delete(); + project = null; + } catch (FileNotFoundException e) { + project = null; + } + } + } + } } diff --git a/src/test/java/org/kohsuke/github/GHProjectColumnTest.java b/src/test/java/org/kohsuke/github/GHProjectColumnTest.java index db3003da6..6334b8fa9 100644 --- a/src/test/java/org/kohsuke/github/GHProjectColumnTest.java +++ b/src/test/java/org/kohsuke/github/GHProjectColumnTest.java @@ -12,63 +12,63 @@ import java.io.IOException; * @author Gunnar Skjold */ public class GHProjectColumnTest extends AbstractGitHubWireMockTest { - private GHProject project; - private GHProjectColumn column; + private GHProject project; + private GHProjectColumn column; - @Before - public void setUp() throws Exception { - project = gitHub - .getOrganization(GITHUB_API_TEST_ORG) - .createProject("test-project", "This is a test project"); - column = project.createColumn("column-one"); - } + @Before + public void setUp() throws Exception { + project = gitHub + .getOrganization(GITHUB_API_TEST_ORG) + .createProject("test-project", "This is a test project"); + column = project.createColumn("column-one"); + } - @Test - public void testCreatedColumn() { - Assert.assertEquals("column-one", column.getName()); - } + @Test + public void testCreatedColumn() { + Assert.assertEquals("column-one", column.getName()); + } - @Test - public void testEditColumnName() throws IOException { - column.setName("new-name"); - column = gitHub.getProjectColumn(column.getId()); - Assert.assertEquals("new-name", column.getName()); - } + @Test + public void testEditColumnName() throws IOException { + column.setName("new-name"); + column = gitHub.getProjectColumn(column.getId()); + Assert.assertEquals("new-name", column.getName()); + } - @Test - public void testDeleteColumn() throws IOException { - column.delete(); - try { - column = gitHub.getProjectColumn(column.getId()); - Assert.assertNull(column); - } catch (FileNotFoundException e) { - column = null; - } - } + @Test + public void testDeleteColumn() throws IOException { + column.delete(); + try { + column = gitHub.getProjectColumn(column.getId()); + Assert.assertNull(column); + } catch (FileNotFoundException e) { + column = null; + } + } - @After - public void after() throws IOException { - if(mockGitHub.isUseProxy()) { - if (column != null) { - column = gitHubBeforeAfter - .getProjectColumn(column.getId()); - try { - column.delete(); - column = null; - } catch (FileNotFoundException e) { - column = null; - } - } - if (project != null) { - project = gitHubBeforeAfter - .getProject(project.getId()); - try { - project.delete(); - project = null; - } catch (FileNotFoundException e) { - project = null; - } - } - } - } + @After + public void after() throws IOException { + if(mockGitHub.isUseProxy()) { + if (column != null) { + column = gitHubBeforeAfter + .getProjectColumn(column.getId()); + try { + column.delete(); + column = null; + } catch (FileNotFoundException e) { + column = null; + } + } + if (project != null) { + project = gitHubBeforeAfter + .getProject(project.getId()); + try { + project.delete(); + project = null; + } catch (FileNotFoundException e) { + project = null; + } + } + } + } } diff --git a/src/test/java/org/kohsuke/github/GHProjectTest.java b/src/test/java/org/kohsuke/github/GHProjectTest.java index fe1722576..1b73d2af7 100644 --- a/src/test/java/org/kohsuke/github/GHProjectTest.java +++ b/src/test/java/org/kohsuke/github/GHProjectTest.java @@ -12,74 +12,74 @@ import java.io.IOException; * @author Gunnar Skjold */ public class GHProjectTest extends AbstractGitHubWireMockTest { - private GHProject project; + private GHProject project; - @Before - public void setUp() throws Exception { - project = gitHub - .getOrganization(GITHUB_API_TEST_ORG) - .createProject("test-project", "This is a test project"); - } + @Before + public void setUp() throws Exception { + project = gitHub + .getOrganization(GITHUB_API_TEST_ORG) + .createProject("test-project", "This is a test project"); + } - @Test - public void testCreatedProject() { - Assert.assertNotNull(project); - Assert.assertEquals("test-project", project.getName()); - Assert.assertEquals("This is a test project", project.getBody()); - Assert.assertEquals(GHProject.ProjectState.OPEN, project.getState()); - } + @Test + public void testCreatedProject() { + Assert.assertNotNull(project); + Assert.assertEquals("test-project", project.getName()); + Assert.assertEquals("This is a test project", project.getBody()); + Assert.assertEquals(GHProject.ProjectState.OPEN, project.getState()); + } - @Test - public void testEditProjectName() throws IOException { - project.setName("new-name"); - project = gitHub.getProject(project.getId()); - Assert.assertEquals("new-name", project.getName()); - Assert.assertEquals("This is a test project", project.getBody()); - Assert.assertEquals(GHProject.ProjectState.OPEN, project.getState()); - } + @Test + public void testEditProjectName() throws IOException { + project.setName("new-name"); + project = gitHub.getProject(project.getId()); + Assert.assertEquals("new-name", project.getName()); + Assert.assertEquals("This is a test project", project.getBody()); + Assert.assertEquals(GHProject.ProjectState.OPEN, project.getState()); + } - @Test - public void testEditProjectBody() throws IOException { - project.setBody("New body"); - project = gitHub.getProject(project.getId()); - Assert.assertEquals("test-project", project.getName()); - Assert.assertEquals("New body", project.getBody()); - Assert.assertEquals(GHProject.ProjectState.OPEN, project.getState()); - } + @Test + public void testEditProjectBody() throws IOException { + project.setBody("New body"); + project = gitHub.getProject(project.getId()); + Assert.assertEquals("test-project", project.getName()); + Assert.assertEquals("New body", project.getBody()); + Assert.assertEquals(GHProject.ProjectState.OPEN, project.getState()); + } - @Test - public void testEditProjectState() throws IOException { - project.setState(GHProject.ProjectState.CLOSED); - project = gitHub.getProject(project.getId()); - Assert.assertEquals("test-project", project.getName()); - Assert.assertEquals("This is a test project", project.getBody()); - Assert.assertEquals(GHProject.ProjectState.CLOSED, project.getState()); - } + @Test + public void testEditProjectState() throws IOException { + project.setState(GHProject.ProjectState.CLOSED); + project = gitHub.getProject(project.getId()); + Assert.assertEquals("test-project", project.getName()); + Assert.assertEquals("This is a test project", project.getBody()); + Assert.assertEquals(GHProject.ProjectState.CLOSED, project.getState()); + } - @Test - public void testDeleteProject() throws IOException { - project.delete(); - try { - project = gitHub.getProject(project.getId()); - Assert.assertNull(project); - } catch (FileNotFoundException e) { - project = null; - } - } + @Test + public void testDeleteProject() throws IOException { + project.delete(); + try { + project = gitHub.getProject(project.getId()); + Assert.assertNull(project); + } catch (FileNotFoundException e) { + project = null; + } + } - @After - public void after() throws IOException { - if (mockGitHub.isUseProxy()) { - if (project != null) { - project = gitHubBeforeAfter - .getProject(project.getId()); - try { - project.delete(); - project = null; - } catch (FileNotFoundException e) { - project = null; - } - } - } - } + @After + public void after() throws IOException { + if (mockGitHub.isUseProxy()) { + if (project != null) { + project = gitHubBeforeAfter + .getProject(project.getId()); + try { + project.delete(); + project = null; + } catch (FileNotFoundException e) { + project = null; + } + } + } + } } diff --git a/src/test/java/org/kohsuke/github/GHRepositoryTest.java b/src/test/java/org/kohsuke/github/GHRepositoryTest.java index f19955be9..1aab6280f 100644 --- a/src/test/java/org/kohsuke/github/GHRepositoryTest.java +++ b/src/test/java/org/kohsuke/github/GHRepositoryTest.java @@ -234,7 +234,7 @@ public class GHRepositoryTest extends AbstractGitHubWireMockTest { assertTrue(actual.contains("class=\"issue-link ")); assertTrue(actual.contains("to fix issue")); } - + @Test public void getMergeOptions() throws IOException { GHRepository r = getTempRepository(); @@ -242,7 +242,7 @@ public class GHRepositoryTest extends AbstractGitHubWireMockTest { assertNotNull(r.isAllowRebaseMerge()); assertNotNull(r.isAllowSquashMerge()); } - + @Test public void setMergeOptions() throws IOException { // String repoName = "github-api-test-org/test-mergeoptions"; diff --git a/src/test/java/org/kohsuke/github/GitHubTest.java b/src/test/java/org/kohsuke/github/GitHubTest.java index bd37714b4..319108bf5 100644 --- a/src/test/java/org/kohsuke/github/GitHubTest.java +++ b/src/test/java/org/kohsuke/github/GitHubTest.java @@ -58,7 +58,7 @@ public class GitHubTest extends AbstractGitHubWireMockTest { assertNotEquals(0L, r.getId()); } } - + @Test public void searchContent() throws Exception { PagedSearchIterable r = gitHub.searchContent().q("addClass").in("file").language("js").repo("jquery/jquery").list(); diff --git a/src/test/java/org/kohsuke/github/Github2faTest.java b/src/test/java/org/kohsuke/github/Github2faTest.java index ebac9e684..d6e4b9d3f 100644 --- a/src/test/java/org/kohsuke/github/Github2faTest.java +++ b/src/test/java/org/kohsuke/github/Github2faTest.java @@ -10,29 +10,29 @@ import org.junit.Test; */ public class Github2faTest extends AbstractGitHubWireMockTest { - @Test - public void test2faToken() throws IOException { - assertFalse("Test only valid when not proxying", mockGitHub.isUseProxy()); + @Test + public void test2faToken() throws IOException { + assertFalse("Test only valid when not proxying", mockGitHub.isUseProxy()); - List asList = Arrays.asList("repo", "gist", "write:packages", "read:packages", "delete:packages", - "user", "delete_repo"); - String nameOfToken = "Test2faTokenCreate";//+timestamp;// use time stamp to ensure the token creations do not collide with older tokens + List asList = Arrays.asList("repo", "gist", "write:packages", "read:packages", "delete:packages", + "user", "delete_repo"); + String nameOfToken = "Test2faTokenCreate";//+timestamp;// use time stamp to ensure the token creations do not collide with older tokens - GHAuthorization token=gitHub.createToken( - asList, - nameOfToken, - "this is a test token created by a unit test", () -> { - String data = "111878"; - // TO UPDATE run this in debugger mode, put a breakpoint here, and enter the OTP you get into the value of Data - return data; - }); - assert token!=null; - for(int i=0;i { + String data = "111878"; + // TO UPDATE run this in debugger mode, put a breakpoint here, and enter the OTP you get into the value of Data + return data; + }); + assert token!=null; + for(int i=0;i