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

Get all orgs/teams/permissions in a single GitHub API call

pom.xml

@@ -3,11 +3,11 @@
   <parent>
     <groupId>org.kohsuke</groupId>
     <artifactId>pom</artifactId>
-    <version>8</version>
+    <version>9</version>
   </parent>
 
   <artifactId>github-api</artifactId>
-  <version>1.55</version>
+  <version>1.57</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.55</tag>
+    <tag>HEAD</tag>
   </scm>
 
   <distributionManagement>
@@ -93,8 +93,8 @@
     </dependency>
     <dependency>
       <groupId>com.squareup.okhttp</groupId>
-      <artifactId>okhttp</artifactId>
-      <version>1.5.3</version>
+      <artifactId>okhttp-urlconnection</artifactId>
+      <version>2.0.0</version>
       <optional>true</optional>
     </dependency>
     <dependency>
@@ -103,6 +103,11 @@
       <version>1.2</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-all</artifactId>
+      <version>1.9.5</version>
+    </dependency>
   </dependencies>
   <repositories>
     <repository>

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

@@ -4,7 +4,7 @@ package org.kohsuke.github;
  * The response that is returned when updating
  * repository content.
 **/
-public final class GHContentUpdateResponse {
+public class GHContentUpdateResponse {
     private GHContent content;
     private GHCommit commit;
 

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

@@ -17,7 +17,7 @@ import java.util.Map.Entry;
  * @see GitHub#getGist(String)
  * @see GitHub#createGist()
  */
-public final class GHGist {
+public class GHGist {
     /*package almost final*/ GHUser owner;
     /*package almost final*/ GitHub root;
 

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

@@ -10,7 +10,7 @@ import java.util.Map;
 /**
  * @author Kohsuke Kawaguchi
  */
-public final class GHHook {
+public class GHHook {
     /**
      * Repository that the hook belongs to.
      */

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

@@ -101,12 +101,24 @@ public class GHMyself extends GHUser {
      * Lists up all repositories this user owns (public and private).
      *
      * Unlike {@link #getAllRepositories()}, this does not wait until all the repositories are returned.
+     * Repositories are returned by GitHub API with a 30 items per page.
      */
     @Override
     public PagedIterable<GHRepository> listRepositories() {
+      return listRepositories(30);
+    }
+
+    /**
+     * Lists up all the repositories this user owns (public and private) using the specified page size.
+     *
+     * @param pageSize size for each page of items returned by GitHub. Maximum page size is 100.
+     *
+     * Unlike {@link #getRepositories()}, this does not wait until all the repositories are returned.
+     */
+    public PagedIterable<GHRepository> listRepositories(final int pageSize) {
         return new PagedIterable<GHRepository>() {
             public PagedIterator<GHRepository> iterator() {
-                return new PagedIterator<GHRepository>(root.retrieve().asIterator("/user/repos", GHRepository[].class)) {
+                return new PagedIterator<GHRepository>(root.retrieve().asIterator("/user/repos?per_page=" + pageSize, GHRepository[].class)) {
                     @Override
                     protected void wrapUp(GHRepository[] page) {
                         for (GHRepository c : page)

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

@@ -9,7 +9,7 @@ import java.util.HashSet;
  * 
  * @author Kohsuke Kawaguchi
  */
-public final class GHPersonSet<T extends GHPerson> extends HashSet<T> {
+public class GHPersonSet<T extends GHPerson> extends HashSet<T> {
     public GHPersonSet() {
     }
 

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

@@ -25,6 +25,7 @@ package org.kohsuke.github;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
+import java.io.FileNotFoundException;
 
 import javax.xml.bind.DatatypeConverter;
 import java.io.IOException;
@@ -321,7 +322,32 @@ public class GHRepository {
      */
     @WithBridgeMethods(Set.class)
     public GHPersonSet<GHUser> getCollaborators() throws IOException {
-        return new GHPersonSet<GHUser>(GHUser.wrap(root.retrieve().to("/repos/" + owner.login + "/" + name + "/collaborators", GHUser[].class),root));
+        return new GHPersonSet<GHUser>(listCollaborators().asList());
+    }
+
+    /**
+     * Lists up the collaborators on this repository.
+     *
+     * @return Users
+     * @throws IOException
+     */
+    public PagedIterable<GHUser> listCollaborators() throws IOException {
+        return new PagedIterable<GHUser>() {
+            public PagedIterator<GHUser> iterator() {
+
+                return new PagedIterator<GHUser>(root.retrieve().asIterator("/repos/" + owner.login + "/" + name + "/collaborators", GHUser[].class)) {
+
+                    @Override
+                    protected void wrapUp(GHUser[] users) {
+                        for (GHUser user : users) {
+                            user.wrapUp(root);
+                        }
+                    }
+                };
+
+            }
+        };
+
     }
 
     /**
@@ -416,7 +442,11 @@ public class GHRepository {
      * Deletes this repository.
      */
     public void delete() throws IOException {
-        new Requester(root).method("DELETE").to("/repos/" + owner.login + "/" + name);
+        try {
+            new Requester(root).method("DELETE").to("/repos/" + owner.login + "/" + name);
+        } catch (FileNotFoundException x) {
+            throw (FileNotFoundException) new FileNotFoundException("Failed to delete " + owner.login + "/" + name + "; might not exist, or you might need the delete_repo scope in your token: http://stackoverflow.com/a/19327004/12916").initCause(x);
+        }
     }
 
     /**

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

@@ -15,6 +15,7 @@ import java.util.TreeMap;
 public class GHTeam {
     private String name,permission;
     private int id;
+    private GHOrganization organization; // populated by GET /user/teams where Teams+Orgs are returned together
 
     protected /*final*/ GHOrganization org;
 
@@ -23,6 +24,11 @@ public class GHTeam {
         return this;
     }
 
+    /*package*/ GHTeam wrapUp(GitHub root) { // auto-wrapUp when organization is known from GET /user/teams
+      this.organization.wrapUp(root);
+      return wrapUp(organization);
+    }
+
     /*package*/ static GHTeam[] wrapUp(GHTeam[] teams, GHOrganization owner) {
         for (GHTeam t : teams) {
             t.wrapUp(owner);
@@ -95,4 +101,8 @@ public class GHTeam {
     private String api(String tail) {
         return "/teams/"+id+tail;
     }
+
+    public GHOrganization getOrganization() {
+      return org;
+    }
 }

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

@@ -23,7 +23,8 @@
  */
 package org.kohsuke.github;
 
-import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.*;
+import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.ANY;
+import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE;
 
 import java.io.File;
 import java.io.FileInputStream;
@@ -38,9 +39,11 @@ import java.util.Arrays;
 import java.util.Collection;
 import java.util.Date;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.Set;
 import java.util.TimeZone;
 
 import org.apache.commons.codec.binary.Base64;
@@ -328,6 +331,28 @@ public class GitHub {
         return r;
     }
 
+  /**
+   * Gets complete map of organizations/teams that current user belongs to.
+   *
+   * Leverages the new GitHub API /user/teams made available recently to
+   * get in a single call the complete set of organizations, teams and permissions
+   * in a single call.
+   */
+  public Map<String, Set<GHTeam>> getMyTeams() throws IOException {
+    Map<String, Set<GHTeam>> allMyTeams = new HashMap<String, Set<GHTeam>>();
+    for (GHTeam team : retrieve().to("/user/teams", GHTeam[].class)) {
+      team.wrapUp(this);
+      String orgLogin = team.getOrganization().getLogin();
+      Set<GHTeam> teamsPerOrg = allMyTeams.get(orgLogin);
+      if (teamsPerOrg == null) {
+        teamsPerOrg = new HashSet<GHTeam>();
+      }
+      teamsPerOrg.add(team);
+      allMyTeams.put(orgLogin, teamsPerOrg);
+    }
+    return allMyTeams;
+  }
+
     /**
      * Public events visible to you. Equivalent of what's displayed on https://github.com/
      */

src/main/java/org/kohsuke/github/extras/OkHttpConnector.java

@@ -1,6 +1,7 @@
 package org.kohsuke.github.extras;
 
 import com.squareup.okhttp.OkHttpClient;
+import com.squareup.okhttp.OkUrlFactory;
 import org.kohsuke.github.HttpConnector;
 
 import java.io.IOException;
@@ -19,13 +20,13 @@ import java.net.URL;
  * @author Kohsuke Kawaguchi
  */
 public class OkHttpConnector implements HttpConnector {
-    private final OkHttpClient client;
+    private final OkUrlFactory urlFactory;
 
-    public OkHttpConnector(OkHttpClient client) {
-        this.client = client;
+    public OkHttpConnector(OkUrlFactory urlFactory) {
+        this.urlFactory = urlFactory;
     }
 
     public HttpURLConnection connect(URL url) throws IOException {
-        return client.open(url);
+        return urlFactory.open(url);
     }
 }

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

@@ -3,19 +3,13 @@ package org.kohsuke.github;
 import java.io.IOException;
 import java.net.URL;
 import java.util.ArrayList;
-import java.util.Collection;
+import java.util.Date;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Set;
 import java.util.UUID;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertSame;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-
 import org.junit.Assume;
 import org.junit.Test;
 import org.kohsuke.github.GHCommit.File;
@@ -24,8 +18,6 @@ import org.kohsuke.github.GHOrganization.Permission;
 import com.google.common.base.Predicate;
 import com.google.common.collect.Iterables;
 
-import java.util.Date;
-
 /**
  * Unit test for simple App.
  */
@@ -170,6 +162,35 @@ public class AppTest extends AbstractGitHubApiTestBase {
         System.out.println(org);
     }
 
+    @Test
+    public void testMyTeamsContainsAllMyOrganizations() throws IOException {
+      Map<String, Set<GHTeam>> teams = gitHub.getMyTeams();
+      Map<String, GHOrganization> myOrganizations = gitHub.getMyOrganizations();
+      assertEquals(teams.keySet(), myOrganizations.keySet());
+    }
+    
+    @Test
+    public void testMyTeamsShouldIncludeMyself() throws IOException {
+      Map<String, Set<GHTeam>> teams = gitHub.getMyTeams();
+      for (Entry<String, Set<GHTeam>> teamsPerOrg : teams.entrySet()) {
+        String organizationName = teamsPerOrg.getKey();
+        for (GHTeam team : teamsPerOrg.getValue()) {
+          String teamName = team.getName();
+        assertTrue("Team " + teamName + " in organization " + organizationName
+            + " does not contain myself",
+            shouldBelongToTeam(organizationName, teamName));
+        }
+      }
+    }
+
+    private boolean shouldBelongToTeam(String organizationName, String teamName) throws IOException {
+      GHOrganization org = gitHub.getOrganization(organizationName);
+      assertNotNull(org);
+      GHTeam team = org.getTeamByName(teamName);
+      assertNotNull(team);
+      return team.hasMember(gitHub.getMyself());
+    }
+
     @Test
     public void testFetchPullRequest() throws Exception {
         GHRepository r = gitHub.getOrganization("jenkinsci").getRepository("jenkins");

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

@@ -0,0 +1,91 @@
+package org.kohsuke.github;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+
+import java.util.Iterator;
+
+import static org.mockito.Mockito.when;
+
+/**
+ * @author Luciano P. Sabenca (luciano.sabenca [at] movile [com] | lucianosabenca [at] gmail [dot] com
+ */
+public class RepositoryTest {
+
+    @Mock
+    GitHub mockGitHub;
+
+    @Mock
+    Iterator<GHUser[]> iterator;
+
+    @Mock
+    GHRepository mockRepository;
+
+
+    @Before
+    public void setUp() {
+        MockitoAnnotations.initMocks(this);
+    }
+
+    @Test
+    public void listCollaborators() throws Exception {
+        GHUser user1 = new GHUser();
+        user1.login = "login1";
+
+        GHUser user2 = new GHUser();
+        user2.login = "login2";
+
+
+        when(iterator.hasNext()).thenReturn(true, false, true);
+        when(iterator.next()).thenReturn(new GHUser[]{user1}, new GHUser[]{user2});
+
+        Requester requester = Mockito.mock(Requester.class);
+        when(mockGitHub.retrieve()).thenReturn(requester);
+
+
+        when(requester.asIterator("/repos/*/*/collaborators",
+                GHUser[].class)).thenReturn(iterator, iterator);
+
+
+        PagedIterable<GHUser> pagedIterable = Mockito.mock(PagedIterable.class);
+        when(mockRepository.listCollaborators()).thenReturn(pagedIterable);
+
+        PagedIterator<GHUser> userPagedIterator = new PagedIterator<GHUser>(iterator) {
+            @Override
+            protected void wrapUp(GHUser[] page) {
+
+            }
+        };
+        PagedIterator<GHUser> userPagedIterator2 = new PagedIterator<GHUser>(iterator) {
+            @Override
+            protected void wrapUp(GHUser[] page) {
+
+            }
+        };
+
+
+        when(pagedIterable.iterator()).thenReturn(userPagedIterator, userPagedIterator2);
+
+        Iterator<GHUser> returnIterator1 = mockRepository.listCollaborators().iterator();
+
+
+        Assert.assertTrue(returnIterator1.hasNext());
+        GHUser user = returnIterator1.next();
+        Assert.assertEquals(user, user1);
+        Assert.assertFalse(returnIterator1.hasNext());
+
+
+        Iterator returnIterator2 = mockRepository.listCollaborators().iterator();
+
+
+        Assert.assertTrue(returnIterator2.hasNext());
+        user = returnIterator1.next();
+        Assert.assertEquals(user, user2);
+
+
+    }
+}