Merge pull request #944 from seregamorph/feature/push-pulls-extensions

user, push, pull event extensions

Author: bitwiseman

src/main/java/org/kohsuke/github/GHEventPayload.java

@@ -382,6 +382,7 @@ public static class PullRequest extends GHEventPayload {
         private int number;
         private GHPullRequest pull_request;
         private GHRepository repository;
+        private GHLabel label;
 
         /**
          * Gets action.
@@ -420,6 +421,15 @@ public GHRepository getRepository() {
             return repository;
         }
 
+        /**
+         * Gets label.
+         *
+         * @return the label
+         */
+        public GHLabel getLabel() {
+            return label;
+        }
+
         @Override
         void wrapUp(GitHub root) {
             super.wrapUp(root);
@@ -1280,6 +1290,7 @@ public static class Push extends GHEventPayload {
         private List<PushCommit> commits;
         private GHRepository repository;
         private Pusher pusher;
+        private String compare;
 
         /**
          * The SHA of the HEAD commit on the repository
@@ -1387,6 +1398,15 @@ public void setPusher(Pusher pusher) {
             this.pusher = pusher;
         }
 
+        /**
+         * Gets compare.
+         *
+         * @return compare
+         */
+        public String getCompare() {
+            return compare;
+        }
+
         @Override
         void wrapUp(GitHub root) {
             super.wrapUp(root);
@@ -1440,7 +1460,7 @@ public void setEmail(String email) {
         }
 
         /**
-         * Commit in a push
+         * Commit in a push. Note: sha is an alias for id.
          */
         public static class PushCommit {
             private GitUser author;
@@ -1477,7 +1497,7 @@ public String getUrl() {
             }
 
             /**
-             * Gets sha.
+             * Gets sha (id).
              *
              * @return the sha
              */

src/main/java/org/kohsuke/github/GitUser.java

@@ -4,6 +4,8 @@
 
 import java.util.Date;
 
+import javax.annotation.CheckForNull;
+
 /**
  * Represents a user in Git who authors/commits a commit.
  * <p>
@@ -15,10 +17,10 @@
 @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;
+    private String name, email, date, username;
 
     /**
-     * Gets name.
+     * Gets the git user name for an author or committer on a git commit.
      *
      * @return Human readable name of the user, such as "Kohsuke Kawaguchi"
      */
@@ -27,14 +29,26 @@ public String getName() {
     }
 
     /**
-     * Gets email.
+     * Gets the git email for an author or committer on a git commit.
      *
-     * @return E -mail address, such as "foo@example.com"
+     * @return E-mail address, such as "foo@example.com"
      */
     public String getEmail() {
         return email;
     }
 
+    /**
+     * Gets username. Note: it presents only in events.
+     *
+     * @return GitHub username
+     */
+    @Preview
+    @Deprecated
+    @CheckForNull
+    public String getUsername() {
+        return username;
+    }
+
     /**
      * Gets date.
      *

src/test/java/org/kohsuke/github/GHEventPayloadTest.java

@@ -8,6 +8,7 @@
 import java.util.Collections;
 import java.util.TimeZone;
 
+import static java.lang.Boolean.TRUE;
 import static org.hamcrest.Matchers.*;
 
 public class GHEventPayloadTest extends AbstractGitHubWireMockTest {
@@ -203,6 +204,44 @@ public void pull_request() throws Exception {
         assertThat(event.getSender().getLogin(), is("baxterthehacker"));
     }
 
+    @Test
+    public void pull_request_labeled() throws Exception {
+        GHEventPayload.PullRequest event = GitHub.offline()
+                .parseEventPayload(payload.asReader(), GHEventPayload.PullRequest.class);
+        assertThat(event.getAction(), is("labeled"));
+        assertThat(event.getNumber(), is(79));
+        assertThat(event.getPullRequest().getNumber(), is(79));
+        assertThat(event.getPullRequest().getTitle(), is("Base POJO test enhancement"));
+        assertThat(event.getPullRequest().getBody(),
+                is("This is a pretty simple change that we need to pull into develop."));
+        assertThat(event.getPullRequest().getUser().getLogin(), is("seregamorph"));
+        assertThat(event.getPullRequest().getHead().getUser().getLogin(), is("trilogy-group"));
+        assertThat(event.getPullRequest().getHead().getRef(), is("changes"));
+        assertThat(event.getPullRequest().getHead().getLabel(), is("trilogy-group:changes"));
+        assertThat(event.getPullRequest().getHead().getSha(), is("4b91e3a970fb967fb7be4d52e0969f8e3fb063d0"));
+        assertThat(event.getPullRequest().getBase().getUser().getLogin(), is("trilogy-group"));
+        assertThat(event.getPullRequest().getBase().getRef(), is("3.10"));
+        assertThat(event.getPullRequest().getBase().getLabel(), is("trilogy-group:3.10"));
+        assertThat(event.getPullRequest().getBase().getSha(), is("7a735f17d686c6a1fc7df5b9d395e5863868f364"));
+        assertThat(event.getPullRequest().isMerged(), is(false));
+        assertThat(event.getPullRequest().getMergeable(), is(TRUE));
+        assertThat(event.getPullRequest().getMergeableState(), is("draft"));
+        assertThat(event.getPullRequest().getMergedBy(), nullValue());
+        assertThat(event.getPullRequest().getCommentsCount(), is(1));
+        assertThat(event.getPullRequest().getReviewComments(), is(14));
+        assertThat(event.getPullRequest().getAdditions(), is(137));
+        assertThat(event.getPullRequest().getDeletions(), is(81));
+        assertThat(event.getPullRequest().getChangedFiles(), is(22));
+        assertThat(event.getRepository().getName(), is("trilogy-rest-api-framework"));
+        assertThat(event.getRepository().getOwner().getLogin(), is("trilogy-group"));
+        assertThat(event.getSender().getLogin(), is("schernov-xo"));
+        assertThat(event.getLabel().getUrl(),
+                is("https://api.github.com/repos/trilogy-group/trilogy-rest-api-framework/labels/rest%20api"));
+        assertThat(event.getLabel().getName(), is("rest api"));
+        assertThat(event.getLabel().getColor(), is("fef2c0"));
+        assertThat(event.getLabel().getDescription(), is("REST API pull request"));
+    }
+
     @Test
     public void pull_request_review() throws Exception {
         GHEventPayload.PullRequestReview event = GitHub.offline()
@@ -274,7 +313,9 @@ public void push() throws Exception {
         assertThat(event.getCommits().size(), is(1));
         assertThat(event.getCommits().get(0).getSha(), is("0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c"));
         assertThat(event.getCommits().get(0).getAuthor().getEmail(), is("baxterthehacker@users.noreply.github.com"));
+        assertThat(event.getCommits().get(0).getAuthor().getUsername(), is("baxterthehacker"));
         assertThat(event.getCommits().get(0).getCommitter().getEmail(), is("baxterthehacker@users.noreply.github.com"));
+        assertThat(event.getCommits().get(0).getCommitter().getUsername(), is("baxterthehacker"));
         assertThat(event.getCommits().get(0).getAdded().size(), is(0));
         assertThat(event.getCommits().get(0).getRemoved().size(), is(0));
         assertThat(event.getCommits().get(0).getModified().size(), is(1));
@@ -286,6 +327,8 @@ public void push() throws Exception {
         assertThat(event.getPusher().getName(), is("baxterthehacker"));
         assertThat(event.getPusher().getEmail(), is("baxterthehacker@users.noreply.github.com"));
         assertThat(event.getSender().getLogin(), is("baxterthehacker"));
+        assertThat(event.getCompare(),
+                is("https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f"));
     }
 
     @Test