Added support for traffic statistics (number of views and clones)

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

@@ -1481,6 +1481,19 @@ public GHNotificationStream listNotifications() {
         return new GHNotificationStream(root,getApiTailUrl("/notifications"));
     }
 
+    /**
+     * <a href="https://developer.github.com/v3/repos/traffic/#views">https://developer.github.com/v3/repos/traffic/#views</a>
+     */
+    public GHRepositoryViews getViews() throws IOException{
+        return root.retrieve().to(getApiTailUrl("/traffic/views"), GHRepositoryViews.class);
+    }
+
+    /**
+     * <a href="https://developer.github.com/v3/repos/traffic/#clones">https://developer.github.com/v3/repos/traffic/#clones</a>
+     */
+    public GHRepositoryClones getClones() throws IOException{
+        return root.retrieve().to(getApiTailUrl("/traffic/clones"), GHRepositoryClones.class);
+    }
 
     @Override
     public int hashCode() {

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

@@ -0,0 +1,33 @@
+package org.kohsuke.github;
+
+import java.util.Date;
+import java.util.List;
+
+public class GHRepositoryClones extends GHRepositoryTrafficInfo {
+    private List<DayClones> clones;
+
+    public GHRepositoryClones() {
+    }
+
+    public GHRepositoryClones(Integer count, Integer uniques, List<DayClones> clones) {
+        super(count, uniques);
+        this.clones = clones;
+    }
+
+    public List<DayClones> getClones() {
+        return clones;
+    }
+
+    public static class DayClones extends GHRepositoryTrafficInfo.DayInfo {
+        public DayClones() {
+        }
+
+        public DayClones(String timestamp, Integer count, Integer uniques) {
+            super(timestamp, count, uniques);
+        }
+
+        public DayClones(Date timestamp, Integer count, Integer uniques) {
+            super(timestamp, count, uniques);
+        }
+    }
+}

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

@@ -0,0 +1,57 @@
+package org.kohsuke.github;
+
+import java.util.Date;
+
+public abstract class GHRepositoryTrafficInfo {
+    private Integer count;
+    private Integer uniques;
+
+    public GHRepositoryTrafficInfo() {
+    }
+
+    public GHRepositoryTrafficInfo(Integer count, Integer uniques) {
+        this.count = count;
+        this.uniques = uniques;
+    }
+
+    public Integer getCount() {
+        return count;
+    }
+
+    public Integer getUniques() {
+        return uniques;
+    }
+
+    public static abstract class DayInfo {
+        private Date timestamp;
+        private Integer count;
+        private Integer uniques;
+
+        public Date getTimestamp() {
+            return timestamp;
+        }
+
+        public Integer getCount() {
+            return count;
+        }
+
+        public Integer getUniques() {
+            return uniques;
+        }
+
+        public DayInfo() {
+        }
+
+        public DayInfo(String timestamp, Integer count, Integer uniques) {
+            this.timestamp = GitHub.parseDate(timestamp);
+            this.count = count;
+            this.uniques = uniques;
+        }
+
+        public DayInfo(Date timestamp, Integer count, Integer uniques) {
+            this.timestamp = timestamp;
+            this.count = count;
+            this.uniques = uniques;
+        }
+    }
+}

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

@@ -0,0 +1,33 @@
+package org.kohsuke.github;
+
+import java.util.Date;
+import java.util.List;
+
+public class GHRepositoryViews extends GHRepositoryTrafficInfo {
+    private List<DayViews> views;
+
+    public GHRepositoryViews() {
+    }
+
+    public GHRepositoryViews(Integer count, Integer uniques, List<DayViews> views) {
+        super(count, uniques);
+        this.views = views;
+    }
+
+    public List<DayViews> getViews() {
+        return views;
+    }
+
+    public static class DayViews extends GHRepositoryTrafficInfo.DayInfo {
+        public DayViews() {
+        }
+
+        public DayViews(String timestamp, Integer count, Integer uniques) {
+            super(timestamp, count, uniques);
+        }
+
+        public DayViews(Date timestamp, Integer count, Integer uniques) {
+            super(timestamp, count, uniques);
+        }
+    }
+}

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

@@ -0,0 +1,175 @@
+package org.kohsuke.github;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.commons.io.IOUtils;
+import org.junit.Assert;
+import org.junit.Test;
+import org.mockito.Mockito;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.text.SimpleDateFormat;
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.List;
+import java.util.TimeZone;
+
+public class RepositoryTrafficTest {
+    final private String login = "kohsuke", repositoryName = "github-api";
+
+    @SuppressWarnings("unchecked")
+    private <T extends GHRepositoryTrafficInfo> void checkResponse(T expected, T actual){
+        Assert.assertEquals(expected.getCount(), actual.getCount());
+        Assert.assertEquals(expected.getUniques(), actual.getUniques());
+
+        List<T.DayInfo> expectedList = null;
+        List<T.DayInfo> actualList = null;
+        Iterator<T.DayInfo> expectedIt;
+        Iterator<T.DayInfo> actualIt;
+
+        if(expected instanceof GHRepositoryViews){
+            expectedList = (List<T.DayInfo>)((List<?>)((GHRepositoryViews) expected).getViews());
+            actualList = (List<T.DayInfo>)((List<?>)((GHRepositoryViews) actual).getViews());
+        }
+        else if(expected instanceof GHRepositoryClones){
+            expectedList = (List<T.DayInfo>)((List<?>)((GHRepositoryClones) expected).getClones());
+            actualList = (List<T.DayInfo>)((List<?>)((GHRepositoryClones) actual).getClones());
+        }
+
+        Assert.assertEquals(expectedList.size(), actualList.size());
+        expectedIt = expectedList.iterator();
+        actualIt = actualList.iterator();
+
+        while(expectedIt.hasNext() && actualIt.hasNext()) {
+            T.DayInfo expectedDayInfo = expectedIt.next();
+            T.DayInfo actualDayInfo = actualIt.next();
+            Assert.assertEquals(expectedDayInfo.getCount(), actualDayInfo.getCount());
+            Assert.assertEquals(expectedDayInfo.getUniques(), actualDayInfo.getUniques());
+            Assert.assertEquals(expectedDayInfo.getTimestamp(), actualDayInfo.getTimestamp());
+        }
+    }
+
+    private <T extends GHRepositoryTrafficInfo> void testTraffic(T expectedResult) throws IOException{
+        SimpleDateFormat dateFormat=new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
+        dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
+        ObjectMapper mapper = new ObjectMapper().setDateFormat(dateFormat);
+        String mockedResponse = mapper.writeValueAsString(expectedResult);
+
+
+        GitHub gitHub = GitHub.connect(login, null);
+        GitHub gitHubSpy = Mockito.spy(gitHub);
+        GHRepository repo = gitHubSpy.getUser(login).getRepository(repositoryName);
+
+
+        // accessing traffic info requires push access to the repo
+        // since we don't have that, let the mocking begin...
+
+        HttpConnector connectorSpy = Mockito.spy(gitHubSpy.getConnector());
+        Mockito.doReturn(connectorSpy).when(gitHubSpy).getConnector();
+
+
+        // also known as the "uc" in the Requester class
+        HttpURLConnection mockHttpURLConnection = Mockito.mock(HttpURLConnection.class);
+
+
+        // needed for Requester.setRequestMethod
+        Mockito.doReturn("GET").when(mockHttpURLConnection).getRequestMethod();
+
+
+        // this covers calls on "uc" in Requester.setupConnection and Requester.buildRequest
+        URL trafficURL = new URL(
+                "https://api.github.com/repos/"+login+"/"+repositoryName+"/traffic/" +
+                ((expectedResult instanceof GHRepositoryViews) ? "views" : "clones")
+        );
+        Mockito.doReturn(mockHttpURLConnection).when(connectorSpy).connect(Mockito.eq(trafficURL));
+
+
+        // make Requester.parse work
+        Mockito.doReturn(200).when(mockHttpURLConnection).getResponseCode();
+        Mockito.doReturn("OK").when(mockHttpURLConnection).getResponseMessage();
+        InputStream stubInputStream = IOUtils.toInputStream(mockedResponse, "UTF-8");
+        Mockito.doReturn(stubInputStream).when(mockHttpURLConnection).getInputStream();
+
+        if(expectedResult instanceof GHRepositoryViews){
+            GHRepositoryViews views = repo.getViews();
+            checkResponse(expectedResult, views);
+        }
+        else if(expectedResult instanceof GHRepositoryClones) {
+            GHRepositoryClones clones = repo.getClones();
+            checkResponse(expectedResult, clones);
+        }
+    }
+
+    @Test
+    public void testGetViews() throws IOException{
+        GHRepositoryViews expectedResult = new GHRepositoryViews(
+                21523359,
+                65534,
+                Arrays.asList(
+                        new GHRepositoryViews.DayViews("2016-10-10T00:00:00Z", 3, 2),
+                        new GHRepositoryViews.DayViews("2016-10-11T00:00:00Z", 9, 4),
+                        new GHRepositoryViews.DayViews("2016-10-12T00:00:00Z", 27, 8),
+                        new GHRepositoryViews.DayViews("2016-10-13T00:00:00Z", 81, 16),
+                        new GHRepositoryViews.DayViews("2016-10-14T00:00:00Z", 243, 32),
+                        new GHRepositoryViews.DayViews("2016-10-15T00:00:00Z", 729, 64),
+                        new GHRepositoryViews.DayViews("2016-10-16T00:00:00Z", 2187, 128),
+                        new GHRepositoryViews.DayViews("2016-10-17T00:00:00Z", 6561, 256),
+                        new GHRepositoryViews.DayViews("2016-10-18T00:00:00Z", 19683, 512),
+                        new GHRepositoryViews.DayViews("2016-10-19T00:00:00Z", 59049, 1024),
+                        new GHRepositoryViews.DayViews("2016-10-20T00:00:00Z", 177147, 2048),
+                        new GHRepositoryViews.DayViews("2016-10-21T00:00:00Z", 531441, 4096),
+                        new GHRepositoryViews.DayViews("2016-10-22T00:00:00Z", 1594323, 8192),
+                        new GHRepositoryViews.DayViews("2016-10-23T00:00:00Z", 4782969, 16384),
+                        new GHRepositoryViews.DayViews("2016-10-24T00:00:00Z", 14348907, 32768)
+                )
+        );
+        testTraffic(expectedResult);
+    }
+
+    @Test
+    public void testGetClones() throws IOException{
+        GHRepositoryClones expectedResult = new GHRepositoryClones(
+                1500,
+                455,
+                Arrays.asList(
+                        new GHRepositoryClones.DayClones("2016-10-10T00:00:00Z", 10,3),
+                        new GHRepositoryClones.DayClones("2016-10-11T00:00:00Z", 20,6),
+                        new GHRepositoryClones.DayClones("2016-10-12T00:00:00Z", 30,5),
+                        new GHRepositoryClones.DayClones("2016-10-13T00:00:00Z", 40,7),
+                        new GHRepositoryClones.DayClones("2016-10-14T00:00:00Z", 50,11),
+                        new GHRepositoryClones.DayClones("2016-10-15T00:00:00Z", 60,12),
+                        new GHRepositoryClones.DayClones("2016-10-16T00:00:00Z", 70,19),
+                        new GHRepositoryClones.DayClones("2016-10-17T00:00:00Z", 170,111),
+                        new GHRepositoryClones.DayClones("2016-10-18T00:00:00Z", 180,70),
+                        new GHRepositoryClones.DayClones("2016-10-19T00:00:00Z", 190,10),
+                        new GHRepositoryClones.DayClones("2016-10-20T00:00:00Z", 200,18),
+                        new GHRepositoryClones.DayClones("2016-10-21T00:00:00Z", 210,8),
+                        new GHRepositoryClones.DayClones("2016-10-22T00:00:00Z", 220,168),
+                        new GHRepositoryClones.DayClones("2016-10-23T00:00:00Z", 5,2),
+                        new GHRepositoryClones.DayClones("2016-10-24T00:00:00Z", 45,5)
+                )
+        );
+        testTraffic(expectedResult);
+    }
+
+    @Test
+    public void testGetTrafficStatsAccessFailureDueToInsufficientPermissions() throws IOException {
+        String errorMsg = "Exception should be thrown, since we don't have permission to access repo traffic info.";
+        GitHub gitHub = GitHub.connect(login, null);
+        GHRepository repo = gitHub.getUser(login).getRepository(repositoryName);
+        try {
+            repo.getViews();
+            Assert.fail(errorMsg);
+        }
+        catch (HttpException ex){
+        }
+        try {
+            repo.getClones();
+            Assert.fail(errorMsg);
+        }
+        catch (HttpException ex){
+        }
+    }
+}