[maven-release-plugin] prepare release github-api-1.76

This change makes this hack even worse, but this is the only way I can think of, since I cannot update HttpURLConnection.methods that is static final.

pom.xml

@@ -7,7 +7,7 @@
   </parent>
 
   <artifactId>github-api</artifactId>
-  <version>1.75</version>
+  <version>1.76</version>
   <name>GitHub API for Java</name>
   <url>http://github-api.kohsuke.org/</url>
   <description>GitHub API for Java</description>
@@ -16,7 +16,7 @@
     <connection>scm:git:git@github.com/kohsuke/${project.artifactId}.git</connection>
     <developerConnection>scm:git:ssh://git@github.com/kohsuke/${project.artifactId}.git</developerConnection>
     <url>http://${project.artifactId}.kohsuke.org/</url>
-    <tag>github-api-1.75</tag>
+    <tag>github-api-1.76</tag>
   </scm>
 
   <distributionManagement>

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

@@ -0,0 +1,21 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author Kohsuke Kawaguchi
+ * @see GHBranch#disableProtection()
+ */
+@SuppressFBWarnings(value = {"UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "URF_UNREAD_FIELD"}, justification = "JSON API")
+class BranchProtection {
+    boolean enabled;
+    RequiredStatusChecks requiredStatusChecks;
+
+    static class RequiredStatusChecks {
+        EnforcementLevel enforcement_level;
+        List<String> contexts = new ArrayList<String>();
+    }
+}

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

@@ -0,0 +1,14 @@
+package org.kohsuke.github;
+
+import java.util.Locale;
+
+/**
+ * @author Kohsuke Kawaguchi
+ */
+public enum EnforcementLevel {
+    OFF, NON_ADMINS, EVERYONE;
+
+    public String toString() {
+        return name().toLowerCase(Locale.ENGLISH);
+    }
+}

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

@@ -1,6 +1,11 @@
 package org.kohsuke.github;
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import org.kohsuke.github.BranchProtection.RequiredStatusChecks;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Collection;
 
 /**
  * A branch in a repository.
@@ -8,7 +13,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  * @author Yusuke Kokubo
  */
 @SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", 
-    "NP_UNWRITTEN_FIELD"}, justification = "JSON API")
+    "NP_UNWRITTEN_FIELD", "URF_UNREAD_FIELD"}, justification = "JSON API")
 public class GHBranch {
     private GitHub root;
     private GHRepository owner;
@@ -44,6 +49,43 @@ public class GHBranch {
     public String getSHA1() {
         return commit.sha;
     }
+
+    /**
+     * Disables branch protection and allows anyone with push access to push changes.
+     */
+    public void disableProtection() throws IOException {
+        BranchProtection bp = new BranchProtection();
+        bp.enabled = false;
+        setProtection(bp);
+    }
+
+    /**
+     * Enables branch protection to control what commit statuses are required to push.
+     *
+     * @see GHCommitStatus#getContext()
+     */
+    public void enableProtection(EnforcementLevel level, Collection<String> contexts) throws IOException {
+        BranchProtection bp = new BranchProtection();
+        bp.enabled = true;
+        bp.requiredStatusChecks = new RequiredStatusChecks();
+        bp.requiredStatusChecks.enforcement_level = level;
+        bp.requiredStatusChecks.contexts.addAll(contexts);
+        setProtection(bp);
+    }
+
+    public void enableProtection(EnforcementLevel level, String... contexts) throws IOException {
+        enableProtection(level, Arrays.asList(contexts));
+    }
+
+    private void setProtection(BranchProtection bp) throws IOException {
+        new Requester(root).method("PATCH")
+                .withHeader("Accept","application/vnd.github.loki-preview+json")
+                ._with("protection",bp).to(getApiRoute());
+    }
+
+    String getApiRoute() {
+        return owner.getApiTailUrl("/branches/"+name);
+    }
     
     @Override
     public String toString() {

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

@@ -1,8 +1,6 @@
 package org.kohsuke.github;
 
-import java.io.IOException;
 import java.net.URL;
-import java.util.Date;
 
 /**
  * Represents a status of a commit.
@@ -10,6 +8,7 @@ import java.util.Date;
  * @author Kohsuke Kawaguchi
  * @see GHRepository#getLastCommitStatus(String)
  * @see GHCommit#getLastStatus()
+ * @see GHRepository#createCommitStatus(String, GHCommitState, String, String)
  */
 public class GHCommitStatus extends GHObject {
     String state;

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

@@ -5,10 +5,9 @@ import java.util.Locale;
 /**
  * Hook event type.
  *
- * See http://developer.github.com/v3/events/types/
- *
  * @author Kohsuke Kawaguchi
  * @see GHEventInfo
+ * @see <a href="https://developer.github.com/v3/activity/events/types/">Event type reference</a>
  */
 public enum GHEvent {
     COMMIT_COMMENT,

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

@@ -54,6 +54,7 @@ public class GHIssue extends GHObject {
     protected int number;
     protected String closed_at;
     protected int comments;
+    @SkipFromToString
     protected String body;
     // for backward compatibility with < 1.63, this collection needs to hold instances of Label, not GHLabel
     protected List<Label> labels;

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

@@ -72,12 +72,19 @@ public class GHMilestone extends GHObject {
     }
 
     /**
-     * Closes this issue.
+     * Closes this milestone.
      */
     public void close() throws IOException {
         edit("state", "closed");
     }
 
+    /**
+     * Reopens this milestone.
+     */
+    public void reopen() throws IOException {
+        edit("state", "open");
+    }
+
     private void edit(String key, Object value) throws IOException {
         new Requester(root)._with(key, value).method("PATCH").to(getApiRoute());
     }

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

@@ -2,8 +2,13 @@ package org.kohsuke.github;
 
 import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import org.apache.commons.lang.builder.ReflectionToStringBuilder;
+import org.apache.commons.lang.builder.ToStringBuilder;
+import org.apache.commons.lang.builder.ToStringStyle;
+import org.apache.commons.lang.reflect.FieldUtils;
 
 import java.io.IOException;
+import java.lang.reflect.Field;
 import java.net.URL;
 import java.util.Date;
 
@@ -72,4 +77,39 @@ public abstract class GHObject {
     private Object urlToString(URL url, Class type) {
         return url==null ? null : url.toString();
     }
+
+    /**
+     * String representation to assist debugging and inspection. The output format of this string
+     * is not a committed part of the API and is subject to change.
+     */
+    @Override
+    public String toString() {
+        return new ReflectionToStringBuilder(this, TOSTRING_STYLE, null, null, false, false) {
+            @Override
+            protected boolean accept(Field field) {
+                return super.accept(field) && !field.isAnnotationPresent(SkipFromToString.class);
+            }
+        }.toString();
+    }
+
+    private static final ToStringStyle TOSTRING_STYLE = new ToStringStyle() {
+        {
+            this.setUseShortClassName(true);
+        }
+
+        @Override
+        public void append(StringBuffer buffer, String fieldName, Object value, Boolean fullDetail) {
+            // skip unimportant properties. '_' is a heuristics as important properties tend to have short names
+            if (fieldName.contains("_"))
+                return;
+            // avoid recursing other GHObject
+            if (value instanceof GHObject)
+                return;
+            // likewise no point in showing root
+            if (value instanceof GitHub)
+                return;
+
+            super.append(buffer,fieldName,value,fullDetail);
+        }
+    };
 }

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

@@ -93,6 +93,17 @@ public class GHOrganization extends GHPerson {
         return null;
     }
 
+    /**
+     * Finds a team that has the given slug in its {@link GHTeam#getSlug()}
+     */
+    public GHTeam getTeamBySlug(String slug) throws IOException {
+        for (GHTeam t : listTeams()) {
+            if(t.getSlug().equals(slug))
+                return t;
+        }
+        return null;
+    }
+
     /**
      * Checks if this organization has the specified user as a member.
      */

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

@@ -204,7 +204,7 @@ public abstract class GHPerson extends GHObject {
 
     public Date getUpdatedAt() throws IOException {
         populate();
-        return super.getCreatedAt();
+        return super.getUpdatedAt();
     }
 
     /**

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

@@ -77,6 +77,7 @@ public class GHRepository extends GHObject {
     private String default_branch,language;
     private Map<String,GHCommit> commits = new HashMap<String, GHCommit>();
 
+    @SkipFromToString
     private GHRepoPermission permissions;
 
     private GHRepository source, parent;
@@ -586,7 +587,19 @@ public class GHRepository extends GHObject {
      *      Newly forked repository that belong to you.
      */
     public GHRepository fork() throws IOException {
-        return new Requester(root).method("POST").to(getApiTailUrl("forks"), GHRepository.class).wrap(root);
+        new Requester(root).method("POST").to(getApiTailUrl("forks"), null);
+
+        // this API is asynchronous. we need to wait for a bit
+        for (int i=0; i<10; i++) {
+            GHRepository r = root.getMyself().getRepository(name);
+            if (r!=null)    return r;
+            try {
+                Thread.sleep(3000);
+            } catch (InterruptedException e) {
+                throw (IOException)new InterruptedIOException().initCause(e);
+            }
+        }
+        throw new IOException(this+" was forked but can't find the new repository");
     }
 
     /**
@@ -935,12 +948,36 @@ public class GHRepository extends GHObject {
     }
 
     /**
-     * Lists all the users who have starred this repo.
+     * Lists all the users who have starred this repo based on the old version of the API. For
+     * additional information, like date when the repository was starred, see {@link #listStargazers2()}
      */
     public PagedIterable<GHUser> listStargazers() {
         return listUsers("stargazers");
     }
 
+    /**
+     * Lists all the users who have starred this repo based on new version of the API, having extended
+     * information like the time when the repository was starred. For compatibility with the old API
+     * see {@link #listStargazers()}
+     */
+    public PagedIterable<GHStargazer> listStargazers2() {
+        return new PagedIterable<GHStargazer>() {
+            @Override
+            public PagedIterator<GHStargazer> _iterator(int pageSize) {
+                Requester requester = root.retrieve();
+                requester.setHeader("Accept", "application/vnd.github.v3.star+json");
+                return new PagedIterator<GHStargazer>(requester.asIterator(getApiTailUrl("stargazers"), GHStargazer[].class, pageSize)) {
+                    @Override
+                    protected void wrapUp(GHStargazer[] page) {
+                        for (GHStargazer c : page) {
+                            c.wrapUp(GHRepository.this);
+                        }
+                    }
+                };
+            }
+        };
+    }
+
     private PagedIterable<GHUser> listUsers(final String suffix) {
         return new PagedIterable<GHUser>() {
             public PagedIterator<GHUser> _iterator(int pageSize) {
@@ -1009,6 +1046,7 @@ public class GHRepository extends GHObject {
      */
     @SuppressFBWarnings(value = "DMI_COLLECTION_OF_URLS", 
             justification = "It causes a performance degradation, but we have already exposed it to the API")
+    @SkipFromToString
     private final Set<URL> postCommitHooks = new AbstractSet<URL>() {
         private List<URL> getPostCommitHooks() {
             try {
@@ -1078,6 +1116,10 @@ public class GHRepository extends GHObject {
         return r;
     }
 
+    public GHBranch getBranch(String name) throws IOException {
+        return root.retrieve().to(getApiTailUrl("branches/"+name),GHBranch.class).wrap(this);
+    }
+
     /**
      * @deprecated
      *      Use {@link #listMilestones(GHIssueState)}
@@ -1326,14 +1368,9 @@ public class GHRepository extends GHObject {
     }
 
 
-    @Override
-    public String toString() {
-        return "Repository:"+owner.login+":"+name;
-    }
-
     @Override
     public int hashCode() {
-        return toString().hashCode();
+        return ("Repository:"+owner.login+":"+name).hashCode();
     }
 
     @Override

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

@@ -0,0 +1,51 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import java.util.Date;
+
+/**
+ * A stargazer at a repository on GitHub.
+ *
+ * @author noctarius
+ */
+@SuppressFBWarnings(value = {"UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD"}, justification = "JSON API")
+public class GHStargazer {
+
+    private GHRepository repository;
+    private String starred_at;
+    private GHUser user;
+
+    /**
+     * Gets the repository that is stargazed
+     *
+     * @return the starred repository
+     */
+    public GHRepository getRepository() {
+        return repository;
+    }
+
+    /**
+     * Gets the date when the repository was starred, however old stars before
+     * August 2012, will all show the date the API was changed to support starred_at.
+     *
+     * @return the date the stargazer was added
+     */
+    public Date getStarredAt() {
+        return GitHub.parseDate(starred_at);
+    }
+
+    /**
+     * Gets the user that starred the repository
+     *
+     * @return the stargazer user
+     */
+    public GHUser getUser() {
+        return user;
+    }
+
+    void wrapUp(GHRepository repository) {
+        this.repository = repository;
+        user.wrapUp(repository.root);
+    }
+}

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

@@ -12,7 +12,7 @@ import java.util.TreeMap;
  * @author Kohsuke Kawaguchi
  */
 public class GHTeam {
-    private String name,permission;
+    private String name,permission,slug;
     private int id;
     private GHOrganization organization; // populated by GET /user/teams where Teams+Orgs are returned together
 
@@ -43,6 +43,10 @@ public class GHTeam {
         return permission;
     }
 
+    public String getSlug() {
+        return slug;
+    }
+
     public int getId() {
         return id;
     }
@@ -126,6 +130,13 @@ public class GHTeam {
     public void remove(GHRepository r) throws IOException {
         org.root.retrieve().method("DELETE").to(api("/repos/" + r.getOwnerName() + '/' + r.getName()), null);
     }
+    
+    /**
+     * Deletes this team.
+     */
+    public void delete() throws IOException {
+        org.root.retrieve().method("DELETE").to(api(""));
+    }
 
     private String api(String tail) {
         return "/teams/"+id+tail;

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

@@ -196,11 +196,6 @@ public class GHUser extends GHPerson {
         };
     }
 
-    @Override
-    public String toString() {
-        return "User:"+login;
-    }
-
     @Override
     public int hashCode() {
         return login.hashCode();

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

@@ -46,7 +46,6 @@ import java.util.HashMap;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.ListIterator;
 import java.util.Locale;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -106,6 +105,11 @@ class Requester {
         headers.put(name,value);
     }
 
+    public Requester withHeader(String name, String value) {
+        setHeader(name,value);
+        return this;
+    }
+
     /**
      * Makes a request with authentication credential.
      */
@@ -463,6 +467,11 @@ class Requester {
                 uc.setRequestProperty(e.getKey(), v);
         }
 
+        setRequestMethod(uc);
+        uc.setRequestProperty("Accept-Encoding", "gzip");
+    }
+
+    private void setRequestMethod(HttpURLConnection uc) throws IOException {
         try {
             uc.setRequestMethod(method);
         } catch (ProtocolException e) {
@@ -474,8 +483,23 @@ class Requester {
             } catch (Exception x) {
                 throw (IOException)new IOException("Failed to set the custom verb").initCause(x);
             }
+            // sun.net.www.protocol.https.DelegatingHttpsURLConnection delegates to another HttpURLConnection
+            try {
+                Field $delegate = uc.getClass().getDeclaredField("delegate");
+                $delegate.setAccessible(true);
+                Object delegate = $delegate.get(uc);
+                if (delegate instanceof HttpURLConnection) {
+                    HttpURLConnection nested = (HttpURLConnection) delegate;
+                    setRequestMethod(nested);
+                }
+            } catch (NoSuchFieldException x) {
+                // no problem
+            } catch (IllegalAccessException x) {
+                throw (IOException)new IOException("Failed to set the custom verb").initCause(x);
+            }
         }
-        uc.setRequestProperty("Accept-Encoding", "gzip");
+        if (!uc.getRequestMethod().equals(method))
+            throw new IllegalStateException("Failed to set the request method to "+method);
     }
 
     private <T> T parse(Class<T> type, T instance) throws IOException {

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

@@ -0,0 +1,16 @@
+package org.kohsuke.github;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Ignores this field for {@link GHObject#toString()}
+ *
+ * @author Kohsuke Kawaguchi
+ */
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@interface SkipFromToString {
+}

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

@@ -14,6 +14,7 @@ import java.io.IOException;
 import java.net.URL;
 import java.util.*;
 import java.util.Map.Entry;
+import java.util.concurrent.ExecutionException;
 import java.util.regex.Pattern;
 
 /**
@@ -39,7 +40,7 @@ public class AppTest extends AbstractGitHubApiTestBase {
     }
 
     @Test
-    public void testRepositoryWithAutoInitializationCRUD() throws IOException {
+    public void testRepositoryWithAutoInitializationCRUD() throws Exception {
         String name = "github-api-test-autoinit";
         deleteRepository(name);
         GHRepository r = gitHub.createRepository(name)
@@ -49,6 +50,7 @@ public class AppTest extends AbstractGitHubApiTestBase {
         r.enableIssueTracker(false);
         r.enableDownloads(false);
         r.enableWiki(false);
+        Thread.sleep(3000);
         assertNotNull(r.getReadme());
         getUser().getRepository(name).delete();
     }
@@ -221,10 +223,12 @@ public class AppTest extends AbstractGitHubApiTestBase {
     }
 
     @Test
-    public void testMyTeamsContainsAllMyOrganizations() throws IOException {
+    public void testMyOrganizationsContainMyTeams() throws IOException {
         Map<String, Set<GHTeam>> teams = gitHub.getMyTeams();
         Map<String, GHOrganization> myOrganizations = gitHub.getMyOrganizations();
-        assertEquals(teams.keySet(), myOrganizations.keySet());
+        //GitHub no longer has default 'owners' team, so there may be organization memberships without a team
+        //https://help.github.com/articles/about-improved-organization-permissions/
+        assertTrue(myOrganizations.keySet().containsAll(teams.keySet()));
     }
     
     @Test
@@ -335,6 +339,13 @@ public class AppTest extends AbstractGitHubApiTestBase {
         assertNotNull(e);
     }
 
+    @Test
+    public void testOrgTeamBySlug() throws Exception {
+        kohsuke();
+        GHTeam e = gitHub.getOrganization("github-api-test-org").getTeamBySlug("core-developers");
+        assertNotNull(e);
+    }
+
     @Test
     public void testCommit() throws Exception {
         GHCommit commit = gitHub.getUser("jenkinsci").getRepository("jenkins").getCommit("08c1c9970af4d609ae754fbe803e06186e3206f7");
@@ -592,6 +603,8 @@ public class AppTest extends AbstractGitHubApiTestBase {
                 .prerelease(false)
                 .create();
 
+        Thread.sleep(3000);
+
         try {
 
             for (GHTag tag : r.listTags()) {
@@ -845,6 +858,18 @@ public class AppTest extends AbstractGitHubApiTestBase {
         gitHub.listNotifications().markAsRead();
     }
 
+    /**
+     * Just basic code coverage to make sure toString() doesn't blow up
+     */
+    @Test
+    public void checkToString() throws Exception {
+        GHUser u = gitHub.getUser("rails");
+        System.out.println(u);
+        GHRepository r = u.getRepository("rails");
+        System.out.println(r);
+        System.out.println(r.getIssue(1));
+    }
+
     private void kohsuke() {
         String login = getUser().getLogin();
         Assume.assumeTrue(login.equals("kohsuke") || login.equals("kohsuke2"));

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

@@ -20,6 +20,13 @@ public class GHContentIntegrationTest extends AbstractGitHubApiTestBase {
         repo = gitHub.getRepository("github-api-test-org/GHContentIntegrationTest").fork();
     }
 
+    @Test
+    public void testBranchProtection() throws Exception {
+        GHBranch b = repo.getBranch("master");
+        b.enableProtection(EnforcementLevel.NON_ADMINS, "foo/bar");
+        b.disableProtection();
+    }
+
     @Test
     public void testGetFileContent() throws Exception {
         GHContent content = repo.getFileContent("ghcontent-ro/a-file-with-content");