Skip to content

Commit fb47067

Browse files
kohsukekohsuke
committed
Naming changes to emphasize that these are just traffic info
1 parent 2c80ef1 commit fb47067

6 files changed

Lines changed: 135 additions & 134 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1484,15 +1484,15 @@ public GHNotificationStream listNotifications() {
14841484
/**
14851485
* <a href="https://developer.github.com/v3/repos/traffic/#views">https://developer.github.com/v3/repos/traffic/#views</a>
14861486
*/
1487-
public GHRepositoryViews getViews() throws IOException{
1488-
return root.retrieve().to(getApiTailUrl("/traffic/views"), GHRepositoryViews.class);
1487+
public GHRepositoryViewTraffic getViewTraffic() throws IOException{
1488+
return root.retrieve().to(getApiTailUrl("/traffic/views"), GHRepositoryViewTraffic.class);
14891489
}
14901490

14911491
/**
14921492
* <a href="https://developer.github.com/v3/repos/traffic/#clones">https://developer.github.com/v3/repos/traffic/#clones</a>
14931493
*/
1494-
public GHRepositoryClones getClones() throws IOException{
1495-
return root.retrieve().to(getApiTailUrl("/traffic/clones"), GHRepositoryClones.class);
1494+
public GHRepositoryCloneTraffic getCloneTraffic() throws IOException{
1495+
return root.retrieve().to(getApiTailUrl("/traffic/clones"), GHRepositoryCloneTraffic.class);
14961496
}
14971497

14981498
@Override

‎src/main/java/org/kohsuke/github/GHRepositoryCloneTraffic.java‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package org.kohsuke.github;
2+
3+
import java.util.Date;
4+
import java.util.List;
5+
6+
/**
7+
* Repository clone statistics.
8+
*
9+
* @see GHRepository#getCloneTraffic()
10+
*/
11+
public class GHRepositoryCloneTraffic extends GHRepositoryTrafficInfo {
12+
private List<DayInfo> clones;
13+
14+
/*package*/ GHRepositoryCloneTraffic() {
15+
}
16+
17+
/*package*/ GHRepositoryCloneTraffic(Integer count, Integer uniques, List<DayInfo> clones) {
18+
super(count, uniques);
19+
this.clones = clones;
20+
}
21+
22+
public List<DayInfo> getClones() {
23+
return clones;
24+
}
25+
26+
public List<DayInfo> getDailyInfo() {
27+
return getClones();
28+
}
29+
30+
public static class DayInfo extends GHRepositoryTrafficInfo.DayInfo {
31+
/*package*/ DayInfo() {
32+
}
33+
34+
/*package*/ DayInfo(String timestamp, int count, int uniques) {
35+
super(timestamp, count, uniques);
36+
}
37+
38+
/*package*/ DayInfo(Date timestamp, int count, int uniques) {
39+
super(timestamp, count, uniques);
40+
}
41+
}
42+
}

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

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎src/main/java/org/kohsuke/github/GHRepositoryViewTraffic.java‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package org.kohsuke.github;
2+
3+
import java.util.Date;
4+
import java.util.List;
5+
6+
/**
7+
* Repository view statistics.
8+
*
9+
* @see GHRepository#getViewTraffic()
10+
*/
11+
public class GHRepositoryViewTraffic extends GHRepositoryTrafficInfo {
12+
private List<Daily> views;
13+
14+
/*package*/ GHRepositoryViewTraffic() {
15+
}
16+
17+
/*package*/ GHRepositoryViewTraffic(int count, int uniques, List<Daily> views) {
18+
super(count, uniques);
19+
this.views = views;
20+
}
21+
22+
public List<Daily> getViews() {
23+
return views;
24+
}
25+
26+
public List<Daily> getDailyInfo() {
27+
return getViews();
28+
}
29+
30+
public static class Daily extends GHRepositoryTrafficInfo.DayInfo {
31+
/*package*/ Daily() {
32+
}
33+
34+
/*package*/ Daily(String timestamp, int count, int uniques) {
35+
super(timestamp, count, uniques);
36+
}
37+
38+
/*package*/ Daily(Date timestamp, int count, int uniques) {
39+
super(timestamp, count, uniques);
40+
}
41+
}
42+
}

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

Lines changed: 0 additions & 42 deletions
This file was deleted.

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

Lines changed: 47 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
import org.apache.commons.io.IOUtils;
55
import org.junit.Assert;
66
import org.junit.Test;
7-
import org.kohsuke.github.GHRepositoryTrafficInfo.DayInfo;
7+
import org.kohsuke.github.GHRepositoryCloneTraffic.DayInfo;
8+
import org.kohsuke.github.GHRepositoryViewTraffic.Daily;
89
import org.mockito.Mockito;
910

1011
import java.io.IOException;
@@ -25,18 +26,18 @@ private <T extends GHRepositoryTrafficInfo> void checkResponse(T expected, T act
2526
Assert.assertEquals(expected.getCount(), actual.getCount());
2627
Assert.assertEquals(expected.getUniques(), actual.getUniques());
2728

28-
List<? extends DayInfo> expectedList = expected.getDailyInfo();
29-
List<? extends DayInfo> actualList = actual.getDailyInfo();
30-
Iterator<? extends DayInfo> expectedIt;
31-
Iterator<? extends DayInfo> actualIt;
29+
List<? extends GHRepositoryTrafficInfo.DayInfo> expectedList = expected.getDailyInfo();
30+
List<? extends GHRepositoryTrafficInfo.DayInfo> actualList = actual.getDailyInfo();
31+
Iterator<? extends GHRepositoryTrafficInfo.DayInfo> expectedIt;
32+
Iterator<? extends GHRepositoryTrafficInfo.DayInfo> actualIt;
3233

3334
Assert.assertEquals(expectedList.size(), actualList.size());
3435
expectedIt = expectedList.iterator();
3536
actualIt = actualList.iterator();
3637

3738
while(expectedIt.hasNext() && actualIt.hasNext()) {
38-
DayInfo expectedDayInfo = expectedIt.next();
39-
DayInfo actualDayInfo = actualIt.next();
39+
GHRepositoryTrafficInfo.DayInfo expectedDayInfo = expectedIt.next();
40+
GHRepositoryTrafficInfo.DayInfo actualDayInfo = actualIt.next();
4041
Assert.assertEquals(expectedDayInfo.getCount(), actualDayInfo.getCount());
4142
Assert.assertEquals(expectedDayInfo.getUniques(), actualDayInfo.getUniques());
4243
Assert.assertEquals(expectedDayInfo.getTimestamp(), actualDayInfo.getTimestamp());
@@ -73,7 +74,7 @@ private <T extends GHRepositoryTrafficInfo> void testTraffic(T expectedResult) t
7374
// this covers calls on "uc" in Requester.setupConnection and Requester.buildRequest
7475
URL trafficURL = new URL(
7576
"https://api.github.com/repos/"+login+"/"+repositoryName+"/traffic/" +
76-
((expectedResult instanceof GHRepositoryViews) ? "views" : "clones")
77+
((expectedResult instanceof GHRepositoryViewTraffic) ? "views" : "clones")
7778
);
7879
Mockito.doReturn(mockHttpURLConnection).when(connectorSpy).connect(Mockito.eq(trafficURL));
7980

@@ -84,63 +85,63 @@ private <T extends GHRepositoryTrafficInfo> void testTraffic(T expectedResult) t
8485
InputStream stubInputStream = IOUtils.toInputStream(mockedResponse, "UTF-8");
8586
Mockito.doReturn(stubInputStream).when(mockHttpURLConnection).getInputStream();
8687

87-
if(expectedResult instanceof GHRepositoryViews){
88-
GHRepositoryViews views = repo.getViews();
88+
if(expectedResult instanceof GHRepositoryViewTraffic){
89+
GHRepositoryViewTraffic views = repo.getViewTraffic();
8990
checkResponse(expectedResult, views);
9091
}
91-
else if(expectedResult instanceof GHRepositoryClones) {
92-
GHRepositoryClones clones = repo.getClones();
92+
else if(expectedResult instanceof GHRepositoryCloneTraffic) {
93+
GHRepositoryCloneTraffic clones = repo.getCloneTraffic();
9394
checkResponse(expectedResult, clones);
9495
}
9596
}
9697

9798
@Test
9899
public void testGetViews() throws IOException{
99-
GHRepositoryViews expectedResult = new GHRepositoryViews(
100+
GHRepositoryViewTraffic expectedResult = new GHRepositoryViewTraffic(
100101
21523359,
101102
65534,
102103
Arrays.asList(
103-
new GHRepositoryViews.DayViews("2016-10-10T00:00:00Z", 3, 2),
104-
new GHRepositoryViews.DayViews("2016-10-11T00:00:00Z", 9, 4),
105-
new GHRepositoryViews.DayViews("2016-10-12T00:00:00Z", 27, 8),
106-
new GHRepositoryViews.DayViews("2016-10-13T00:00:00Z", 81, 16),
107-
new GHRepositoryViews.DayViews("2016-10-14T00:00:00Z", 243, 32),
108-
new GHRepositoryViews.DayViews("2016-10-15T00:00:00Z", 729, 64),
109-
new GHRepositoryViews.DayViews("2016-10-16T00:00:00Z", 2187, 128),
110-
new GHRepositoryViews.DayViews("2016-10-17T00:00:00Z", 6561, 256),
111-
new GHRepositoryViews.DayViews("2016-10-18T00:00:00Z", 19683, 512),
112-
new GHRepositoryViews.DayViews("2016-10-19T00:00:00Z", 59049, 1024),
113-
new GHRepositoryViews.DayViews("2016-10-20T00:00:00Z", 177147, 2048),
114-
new GHRepositoryViews.DayViews("2016-10-21T00:00:00Z", 531441, 4096),
115-
new GHRepositoryViews.DayViews("2016-10-22T00:00:00Z", 1594323, 8192),
116-
new GHRepositoryViews.DayViews("2016-10-23T00:00:00Z", 4782969, 16384),
117-
new GHRepositoryViews.DayViews("2016-10-24T00:00:00Z", 14348907, 32768)
104+
new Daily("2016-10-10T00:00:00Z", 3, 2),
105+
new Daily("2016-10-11T00:00:00Z", 9, 4),
106+
new Daily("2016-10-12T00:00:00Z", 27, 8),
107+
new Daily("2016-10-13T00:00:00Z", 81, 16),
108+
new Daily("2016-10-14T00:00:00Z", 243, 32),
109+
new Daily("2016-10-15T00:00:00Z", 729, 64),
110+
new Daily("2016-10-16T00:00:00Z", 2187, 128),
111+
new Daily("2016-10-17T00:00:00Z", 6561, 256),
112+
new Daily("2016-10-18T00:00:00Z", 19683, 512),
113+
new Daily("2016-10-19T00:00:00Z", 59049, 1024),
114+
new Daily("2016-10-20T00:00:00Z", 177147, 2048),
115+
new Daily("2016-10-21T00:00:00Z", 531441, 4096),
116+
new Daily("2016-10-22T00:00:00Z", 1594323, 8192),
117+
new Daily("2016-10-23T00:00:00Z", 4782969, 16384),
118+
new Daily("2016-10-24T00:00:00Z", 14348907, 32768)
118119
)
119120
);
120121
testTraffic(expectedResult);
121122
}
122123

123124
@Test
124125
public void testGetClones() throws IOException{
125-
GHRepositoryClones expectedResult = new GHRepositoryClones(
126+
GHRepositoryCloneTraffic expectedResult = new GHRepositoryCloneTraffic(
126127
1500,
127128
455,
128129
Arrays.asList(
129-
new GHRepositoryClones.DayClones("2016-10-10T00:00:00Z", 10,3),
130-
new GHRepositoryClones.DayClones("2016-10-11T00:00:00Z", 20,6),
131-
new GHRepositoryClones.DayClones("2016-10-12T00:00:00Z", 30,5),
132-
new GHRepositoryClones.DayClones("2016-10-13T00:00:00Z", 40,7),
133-
new GHRepositoryClones.DayClones("2016-10-14T00:00:00Z", 50,11),
134-
new GHRepositoryClones.DayClones("2016-10-15T00:00:00Z", 60,12),
135-
new GHRepositoryClones.DayClones("2016-10-16T00:00:00Z", 70,19),
136-
new GHRepositoryClones.DayClones("2016-10-17T00:00:00Z", 170,111),
137-
new GHRepositoryClones.DayClones("2016-10-18T00:00:00Z", 180,70),
138-
new GHRepositoryClones.DayClones("2016-10-19T00:00:00Z", 190,10),
139-
new GHRepositoryClones.DayClones("2016-10-20T00:00:00Z", 200,18),
140-
new GHRepositoryClones.DayClones("2016-10-21T00:00:00Z", 210,8),
141-
new GHRepositoryClones.DayClones("2016-10-22T00:00:00Z", 220,168),
142-
new GHRepositoryClones.DayClones("2016-10-23T00:00:00Z", 5,2),
143-
new GHRepositoryClones.DayClones("2016-10-24T00:00:00Z", 45,5)
130+
new DayInfo("2016-10-10T00:00:00Z", 10,3),
131+
new DayInfo("2016-10-11T00:00:00Z", 20,6),
132+
new DayInfo("2016-10-12T00:00:00Z", 30,5),
133+
new DayInfo("2016-10-13T00:00:00Z", 40,7),
134+
new DayInfo("2016-10-14T00:00:00Z", 50,11),
135+
new DayInfo("2016-10-15T00:00:00Z", 60,12),
136+
new DayInfo("2016-10-16T00:00:00Z", 70,19),
137+
new DayInfo("2016-10-17T00:00:00Z", 170,111),
138+
new DayInfo("2016-10-18T00:00:00Z", 180,70),
139+
new DayInfo("2016-10-19T00:00:00Z", 190,10),
140+
new DayInfo("2016-10-20T00:00:00Z", 200,18),
141+
new DayInfo("2016-10-21T00:00:00Z", 210,8),
142+
new DayInfo("2016-10-22T00:00:00Z", 220,168),
143+
new DayInfo("2016-10-23T00:00:00Z", 5,2),
144+
new DayInfo("2016-10-24T00:00:00Z", 45,5)
144145
)
145146
);
146147
testTraffic(expectedResult);
@@ -152,13 +153,13 @@ public void testGetTrafficStatsAccessFailureDueToInsufficientPermissions() throw
152153
GitHub gitHub = GitHub.connect(login, null);
153154
GHRepository repo = gitHub.getUser(login).getRepository(repositoryName);
154155
try {
155-
repo.getViews();
156+
repo.getViewTraffic();
156157
Assert.fail(errorMsg);
157158
}
158159
catch (HttpException ex){
159160
}
160161
try {
161-
repo.getClones();
162+
repo.getCloneTraffic();
162163
Assert.fail(errorMsg);
163164
}
164165
catch (HttpException ex){

0 commit comments

Comments
 (0)