Skip to content

Commit c1a47cc

Browse files
SidneyAllenSidneyAllen
authored
Merge pull request #265 from lancedfr/feature/264-XeroRateLimitException
#264 add XeroRateLimitException subtypes
2 parents e104af5 + c1428dd commit c1a47cc

7 files changed

+328
-135
lines changed

‎README.md

+150-127
Large diffs are not rendered by default.

‎src/main/java/com/xero/api/XeroApiExceptionHandler.java

+25-3
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,31 @@ public void execute(HttpResponseException e) {
113113
throw new XeroNotFoundException(statusCode, message, e);
114114

115115
} else if (statusCode == 429) {
116-
String message = "You've exceeded the per " + e.getHeaders().get("x-rate-limit-problem") + " rate limit";
117-
throw new XeroRateLimitException(statusCode, message, e);
118-
116+
String minuteLimitRemainingStr = e.getHeaders().getFirstHeaderStringValue("X-MinLimit-Remaining");
117+
Integer minuteLimitRemaining = minuteLimitRemainingStr == null ? null : Integer.parseInt(minuteLimitRemainingStr);
118+
119+
String dayLimitRemainingStr = e.getHeaders().getFirstHeaderStringValue("X-DayLimit-Remaining");
120+
Integer dayLimitRemaining = dayLimitRemainingStr == null ? null : Integer.parseInt(dayLimitRemainingStr);
121+
122+
String appMinuteLimitRemainingStr = e.getHeaders().getFirstHeaderStringValue("X-AppMinLimit-Remaining");
123+
Integer appMinuteLimitRemaining = appMinuteLimitRemainingStr == null ? null : Integer.parseInt(appMinuteLimitRemainingStr);
124+
125+
String retryAfterSecondsStr = e.getHeaders().getRetryAfter();
126+
Long retryAfterSeconds = retryAfterSecondsStr == null ? null : Long.parseLong(retryAfterSecondsStr);
127+
128+
String rateLimitProblem = e.getHeaders().getFirstHeaderStringValue("X-Rate-Limit-Problem");
129+
String message = "You've exceeded the per " + rateLimitProblem + " rate limit";
130+
131+
if (minuteLimitRemaining != null && minuteLimitRemaining <= 0) {
132+
throw new XeroMinuteRateLimitException(statusCode, appMinuteLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
133+
} else if (dayLimitRemaining != null && dayLimitRemaining <= 0) {
134+
throw new XeroDailyRateLimitException(statusCode, appMinuteLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
135+
} else if (appMinuteLimitRemaining != null && appMinuteLimitRemaining <= 0) {
136+
throw new XeroAppMinuteRateLimitException(statusCode, appMinuteLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
137+
} else {
138+
throw new XeroRateLimitException(statusCode, appMinuteLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
139+
}
140+
119141
} else if (statusCode == 500) {
120142
String message = "An error occurred in Xero. Check the API Status page http://status.developer.xero.com for current service status.";
121143
throw new XeroServerErrorException(statusCode, message, e);

‎src/main/java/com/xero/api/XeroAppMinuteRateLimitException.java

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package com.xero.api;
2+
3+
public class XeroAppMinuteRateLimitException extends XeroRateLimitException {
4+
5+
private static final long serialVersionUID = 1L;
6+
7+
public XeroAppMinuteRateLimitException(final int statusCode, final Integer appLimitRemaining, final Integer dayLimitRemaining,
8+
final Integer minuteLimitRemaining,
9+
final Long retryAfterSeconds, final String message, final Exception e) {
10+
super(statusCode, appLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
11+
}
12+
}

‎src/main/java/com/xero/api/XeroDailyRateLimitException.java

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package com.xero.api;
2+
3+
public class XeroDailyRateLimitException extends XeroRateLimitException {
4+
5+
private static final long serialVersionUID = 1L;
6+
7+
public XeroDailyRateLimitException(final int statusCode, final Integer appLimitRemaining, final Integer dayLimitRemaining,
8+
final Integer minuteLimitRemaining,
9+
final Long retryAfterSeconds, final String message, final Exception e) {
10+
super(statusCode, appLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
11+
}
12+
}

‎src/main/java/com/xero/api/XeroMinuteRateLimitException.java

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package com.xero.api;
2+
3+
public class XeroMinuteRateLimitException extends XeroRateLimitException {
4+
5+
private static final long serialVersionUID = 1L;
6+
7+
public XeroMinuteRateLimitException(final int statusCode, final Integer appLimitRemaining, final Integer dayLimitRemaining,
8+
final Integer minuteLimitRemaining,
9+
final Long retryAfterSeconds, final String message, final Exception e) {
10+
super(statusCode, appLimitRemaining, dayLimitRemaining, minuteLimitRemaining, retryAfterSeconds, message, e);
11+
}
12+
}

‎src/main/java/com/xero/api/XeroRateLimitException.java

+47-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,45 @@
11
package com.xero.api;
22

3+
/**
4+
* Base application exception all other rate limit Xero exceptions should extend
5+
*/
36
public class XeroRateLimitException extends XeroException {
47

58
private static final long serialVersionUID = 1L;
69
private int statusCode = 0;
710
private String message;
8-
9-
public XeroRateLimitException(int statusCode, String message, Exception e) {
11+
12+
/**
13+
* The remaining app limit
14+
*/
15+
private final Integer appLimitRemaining;
16+
17+
/**
18+
* The remaining day limit
19+
*/
20+
private final Integer dayLimitRemaining;
21+
22+
/**
23+
* The remaining minute limit
24+
*/
25+
private final Integer minuteLimitRemaining;
26+
27+
/**
28+
* retryAfterSeconds that tells you how many seconds to wait before making another request.
29+
* Requests are counted against a fixed window which will reset at different times for each tenant.
30+
* It is important to use the Retry-After header to know when you can start making calls again.
31+
*/
32+
private final Long retryAfterSeconds;
33+
34+
public XeroRateLimitException(int statusCode, Integer appLimitRemaining, Integer dayLimitRemaining, Integer minuteLimitRemaining,
35+
Long retryAfterSeconds, String message, Exception e) {
1036
super(statusCode + " : " + message, e);
1137
this.statusCode = statusCode;
38+
this.appLimitRemaining = appLimitRemaining;
39+
this.dayLimitRemaining = dayLimitRemaining;
40+
this.minuteLimitRemaining = minuteLimitRemaining;
1241
this.message = message;
42+
this.retryAfterSeconds = retryAfterSeconds;
1343
}
1444

1545
public int getStatusCode() {
@@ -20,4 +50,19 @@ public String getMessage() {
2050
return message;
2151
}
2252

53+
public Integer getAppLimitRemaining() {
54+
return appLimitRemaining;
55+
}
56+
57+
public Integer getDayLimitRemaining() {
58+
return dayLimitRemaining;
59+
}
60+
61+
public Integer getMinuteLimitRemaining() {
62+
return minuteLimitRemaining;
63+
}
64+
65+
public long getRetryAfterSeconds() {
66+
return retryAfterSeconds;
67+
}
2368
}

‎src/test/java/com/xero/api/XeroExceptionsTest.java

+70-3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
import com.google.api.client.http.HttpHeaders;
77
import com.google.api.client.http.HttpResponseException;
8+
import org.junit.After;
89
import org.junit.Before;
910
import org.junit.Rule;
1011
import org.junit.Test;
@@ -15,6 +16,7 @@
1516

1617
public class XeroExceptionsTest {
1718

19+
private AutoCloseable closeable;
1820
@InjectMocks
1921
private static XeroApiExceptionHandler xeroApiExceptionHandler;
2022
@Rule
@@ -32,7 +34,12 @@ public class XeroExceptionsTest {
3234

3335
@Before
3436
public void setUp() {
35-
MockitoAnnotations.initMocks(this);
37+
closeable = MockitoAnnotations.openMocks(this);
38+
}
39+
40+
@After
41+
public void tearDown() throws Exception {
42+
closeable.close();
3643
}
3744

3845
@Test
@@ -102,7 +109,7 @@ public void testXeroNotFoundException() {
102109
@Test
103110
public void testXeroRateLimitException() {
104111
int statusCode = 429;
105-
String message = "You've exceeded the per 100 rate limit";
112+
String message = "You've exceeded the per [any] rate limit";
106113

107114
// XeroRateLimitException extends XeroException so we can catch either
108115
expectedException.expect(XeroException.class);
@@ -111,7 +118,67 @@ public void testXeroRateLimitException() {
111118

112119
when(httpResponseException.getStatusCode()).thenReturn(statusCode);
113120
when(httpResponseException.getHeaders()).thenReturn(httpHeaders);
114-
when(httpHeaders.get("x-rate-limit-problem")).thenReturn(100);
121+
when(httpHeaders.getFirstHeaderStringValue("X-Rate-Limit-Problem")).thenReturn("[any]");
122+
xeroApiExceptionHandler.execute(httpResponseException);
123+
}
124+
125+
@Test
126+
public void testXeroMinuteRateLimitException() {
127+
int statusCode = 429;
128+
String message = "You've exceeded the per [minute] rate limit";
129+
130+
// XeroMinuteRateLimitException extends XeroRateLimitException so we can catch either
131+
expectedException.expect(XeroException.class);
132+
expectedException.expect(XeroMinuteRateLimitException.class);
133+
expectedException.expect(XeroRateLimitException.class);
134+
expectedException.expectMessage(message);
135+
136+
when(httpResponseException.getStatusCode()).thenReturn(statusCode);
137+
when(httpResponseException.getHeaders()).thenReturn(httpHeaders);
138+
when(httpHeaders.getFirstHeaderStringValue("X-Rate-Limit-Problem")).thenReturn("[minute]");
139+
when(httpHeaders.getFirstHeaderStringValue("X-MinLimit-Remaining")).thenReturn("0");
140+
when(httpHeaders.getFirstHeaderStringValue("X-DayLimit-Remaining")).thenReturn("10");
141+
when(httpHeaders.getFirstHeaderStringValue("X-AppMinLimit-Remaining")).thenReturn("10");
142+
xeroApiExceptionHandler.execute(httpResponseException);
143+
}
144+
145+
@Test
146+
public void testXeroDailyRateLimitException() {
147+
int statusCode = 429;
148+
String message = "You've exceeded the per [day] rate limit";
149+
150+
// XeroDailyRateLimitException extends XeroRateLimitException so we can catch either
151+
expectedException.expect(XeroException.class);
152+
expectedException.expect(XeroDailyRateLimitException.class);
153+
expectedException.expect(XeroRateLimitException.class);
154+
expectedException.expectMessage(message);
155+
156+
when(httpResponseException.getStatusCode()).thenReturn(statusCode);
157+
when(httpResponseException.getHeaders()).thenReturn(httpHeaders);
158+
when(httpHeaders.getFirstHeaderStringValue("X-Rate-Limit-Problem")).thenReturn("[day]");
159+
when(httpHeaders.getFirstHeaderStringValue("X-MinLimit-Remaining")).thenReturn("10");
160+
when(httpHeaders.getFirstHeaderStringValue("X-DayLimit-Remaining")).thenReturn("0");
161+
when(httpHeaders.getFirstHeaderStringValue("X-AppMinLimit-Remaining")).thenReturn("10");
162+
xeroApiExceptionHandler.execute(httpResponseException);
163+
}
164+
165+
@Test
166+
public void testXeroAppMinuteRateLimitException() {
167+
int statusCode = 429;
168+
String message = "You've exceeded the per [app] rate limit";
169+
170+
// XeroAppMinuteRateLimitException extends XeroRateLimitException so we can catch either
171+
expectedException.expect(XeroException.class);
172+
expectedException.expect(XeroAppMinuteRateLimitException.class);
173+
expectedException.expect(XeroRateLimitException.class);
174+
expectedException.expectMessage(message);
175+
176+
when(httpResponseException.getStatusCode()).thenReturn(statusCode);
177+
when(httpResponseException.getHeaders()).thenReturn(httpHeaders);
178+
when(httpHeaders.getFirstHeaderStringValue("X-Rate-Limit-Problem")).thenReturn("[app]");
179+
when(httpHeaders.getFirstHeaderStringValue("X-MinLimit-Remaining")).thenReturn("10");
180+
when(httpHeaders.getFirstHeaderStringValue("X-DayLimit-Remaining")).thenReturn("10");
181+
when(httpHeaders.getFirstHeaderStringValue("X-AppMinLimit-Remaining")).thenReturn("0");
115182
xeroApiExceptionHandler.execute(httpResponseException);
116183
}
117184

0 commit comments

Comments
 (0)