Merge pull request #146 from loonydevil/master

added X-RateLimit* fields to RateLimit exception

Author: brianw

intercom-java/src/main/java/io/intercom/api/HttpClient.java

@@ -6,6 +6,9 @@
 import com.google.common.collect.Lists;
 import com.google.common.collect.Maps;
 import com.google.common.io.CharStreams;
+import com.google.common.primitives.Ints;
+import com.google.common.primitives.Longs;
+
 import org.apache.commons.codec.binary.Base64;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -34,6 +37,10 @@ class HttpClient {
 
     private static final String APPLICATION_JSON = "application/json";
 
+    public static final String RATE_LIMIT_HEADER = "X-RateLimit-Limit";
+    public static final String RATE_LIMIT_REMAINING_HEADER = "X-RateLimit-Remaining";
+    public static final String RATE_LIMIT_RESET_HEADER = "X-RateLimit-Reset";
+
     private static String clientAgentDetails() {
         final HashMap<String, String> map = Maps.newHashMap();
         final ArrayList<String> propKeys = Lists.newArrayList(
@@ -159,7 +166,7 @@ private <T> T handleError(URI uri, HttpURLConnection conn, int responseCode) thr
         if (logger.isDebugEnabled()) {
             logger.debug("error json follows --\n{}\n-- ", objectMapper.writeValueAsString(errors));
         }
-        return throwException(responseCode, errors);
+        return throwException(responseCode, errors, conn);
     }
 
     private <T> T handleSuccess(JavaType javaType, HttpURLConnection conn, int responseCode) throws IOException {
@@ -189,12 +196,14 @@ private <T> T readEntity(HttpURLConnection conn, int responseCode, JavaType java
         }
     }
 
-    private <T> T throwException(int responseCode, ErrorCollection errors) {
+    private <T> T throwException(int responseCode, ErrorCollection errors, HttpURLConnection conn) {
         // bind some well known response codes to exceptions
         if (responseCode == 403 || responseCode == 401) {
             throw new AuthorizationException(errors);
         } else if (responseCode == 429) {
-            throw new RateLimitException(errors);
+            throw new RateLimitException(errors, Ints.tryParse(conn.getHeaderField(RATE_LIMIT_HEADER)),
+                    Ints.tryParse(conn.getHeaderField(RATE_LIMIT_REMAINING_HEADER)),
+                    Longs.tryParse(conn.getHeaderField(RATE_LIMIT_RESET_HEADER)));
         } else if (responseCode == 404) {
             throw new NotFoundException(errors);
         } else if (responseCode == 422) {

intercom-java/src/main/java/io/intercom/api/RateLimitException.java

@@ -4,6 +4,12 @@ public class RateLimitException extends IntercomException {
 
     private static final long serialVersionUID = -6100754169056165622L;
 
+    private int rateLimit;
+
+    private int remainingRequests;
+
+    private long resetTime;
+
     public RateLimitException(String message) {
         super(message);
     }
@@ -16,7 +22,39 @@ public RateLimitException(ErrorCollection errorCollection) {
         super(errorCollection);
     }
 
+    public RateLimitException(ErrorCollection errorCollection, int rateLimit,
+            int remainingRequests, long resetTime) {
+        super(errorCollection);
+        this.rateLimit = rateLimit;
+        this.remainingRequests = remainingRequests;
+        this.resetTime = resetTime;
+    }
+
     public RateLimitException(ErrorCollection errorCollection, Throwable cause) {
         super(errorCollection, cause);
     }
+
+    public int getRateLimit() {
+        return rateLimit;
+    }
+
+    public void setRateLimit(int rateLimit) {
+        this.rateLimit = rateLimit;
+    }
+
+    public int getRemainingRequests() {
+        return remainingRequests;
+    }
+
+    public void setRemainingRequests(int remainingRequests) {
+        this.remainingRequests = remainingRequests;
+    }
+
+    public long getResetTime() {
+        return resetTime;
+    }
+
+    public void setResetTime(long resetTime) {
+        this.resetTime = resetTime;
+    }
 }