Merge pull request cloudbees-oss#135 from matthewtckr/issue43

Add Rate Limit Exception

Author: stephenc

src/main/java/org/zendesk/client/v2/Zendesk.java

@@ -1684,6 +1684,8 @@ public Void onCompleted(Response response) throws Exception {
                 logResponse(response);
                 if (isStatus2xx(response)) {
                     return null;
+                } else if (isRateLimitResponse(response)) {
+                    throw new ZendeskResponseRateLimitException(response);
                 }
                 throw new ZendeskResponseException(response);
             }
@@ -1698,6 +1700,8 @@ public T onCompleted(Response response) throws Exception {
                 logResponse(response);
                 if (isStatus2xx(response)) {
                     return (T) mapper.reader(clazz).readValue(response.getResponseBodyAsStream());
+                } else if (isRateLimitResponse(response)) {
+                    throw new ZendeskResponseRateLimitException(response);
                 }
                 if (response.getStatusCode() == 404) {
                     return null;
@@ -1727,6 +1731,8 @@ public T onCompleted(Response response) throws Exception {
                     return mapper.convertValue(mapper.readTree(response.getResponseBodyAsStream()).get(name), type);
                 }
                 return mapper.convertValue(mapper.readTree(response.getResponseBodyAsStream()).get(name), clazz);
+            } else if (isRateLimitResponse(response)) {
+                throw new ZendeskResponseRateLimitException(response);
             }
             if (response.getStatusCode() == 404) {
                 return null;
@@ -1799,6 +1805,8 @@ public List<T> onCompleted(Response response) throws Exception {
                     values.add(mapper.convertValue(node, clazz));
                 }
                 return values;
+            } else if (isRateLimitResponse(response)) {
+                throw new ZendeskResponseRateLimitException(response);
             }
             throw new ZendeskResponseException(response);
         }
@@ -1876,6 +1884,8 @@ public List<SearchResultEntity> onCompleted(Response response) throws Exception
                         }
                     }
                     return values;
+                } else if (isRateLimitResponse(response)) {
+                    throw new ZendeskResponseRateLimitException(response);
                 }
                 throw new ZendeskResponseException(response);
             }
@@ -1898,6 +1908,8 @@ public List<Target> onCompleted(Response response) throws Exception {
                         }
                     }
                     return values;
+                } else if (isRateLimitResponse(response)) {
+                    throw new ZendeskResponseRateLimitException(response);
                 }
                 throw new ZendeskResponseException(response);
             }
@@ -1917,6 +1929,8 @@ public List<ArticleAttachments> onCompleted(Response response) throws Exception
                         values.add(mapper.convertValue(node, ArticleAttachments.class));
                     }
                     return values;
+                } else if (isRateLimitResponse(response)) {
+                    throw new ZendeskResponseRateLimitException(response);
                 }
                 throw new ZendeskResponseException(response);
             }
@@ -1959,6 +1973,10 @@ private boolean isStatus2xx(Response response) {
         return response.getStatusCode() / 100 == 2;
     }
 
+    private boolean isRateLimitResponse(Response response) {
+        return response.getStatusCode() == 429;
+    }
+
     //////////////////////////////////////////////////////////////////////
     // Static helper methods
     //////////////////////////////////////////////////////////////////////

src/main/java/org/zendesk/client/v2/ZendeskResponseRateLimitException.java

@@ -0,0 +1,27 @@
+package org.zendesk.client.v2;
+
+import java.io.IOException;
+
+import com.ning.http.client.Response;
+
+public class ZendeskResponseRateLimitException extends ZendeskResponseException {
+
+    private static final long serialVersionUID = 1L;
+    private static final String RETRY_AFTER_HEADER = "Retry-After";
+    private static final long DEFAULT_RETRY_AFTER = 60L;
+
+    private Long retryAfter = DEFAULT_RETRY_AFTER;
+
+    public ZendeskResponseRateLimitException(Response resp) throws IOException {
+        super(resp);
+        try {
+            this.retryAfter = Long.valueOf(resp.getHeader(RETRY_AFTER_HEADER));
+        } catch (NumberFormatException e) {
+            // Ignore, use the default value already set
+        }
+    }
+
+    public Long getRetryAfter() {
+        return retryAfter;
+    }
+}