Add unit tests for APILimitUtils.

Add more information on Javadoc.
sachin-handiekar · Apr 4, 2014 · 33c80ed · 33c80ed
1 parent 7cf04aa
commit 33c80ed
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 8 deletions.
diff --git a/src/main/java/org/jinstagram/InstagramResponse.java b/src/main/java/org/jinstagram/InstagramResponse.java
@@ -11,14 +11,14 @@ public interface InstagramResponse {
      * Get the available API limit. It correspond to the value of 
      * X-Ratelimit-Limit key in HTTP response headers. For Instagram 
      * v1 API, this method should return 5000.
-     * @return Available API limit
+     * @return Available API limit. -1 if headers invalid.
      */
     public int getAPILimitStatus();
 
     /**
      * Get the remaining API limit. It correspond to the value of 
      * X-Ratelimit-Remaining key in HTTP response headers.
-     * @return Remaining API limit
+     * @return Remaining API limit. -1 if headers invalid.
      */
     public int getRemainingLimitStatus();
 }
diff --git a/src/main/java/org/jinstagram/http/APILimitUtils.java b/src/main/java/org/jinstagram/http/APILimitUtils.java
@@ -8,17 +8,18 @@
  * @author Arinto Murdopo
  *
  */
-public class APILimitUtils {
+public final class APILimitUtils {
 
-	private static final String LIMIT_HEADER_KEY = "X-Ratelimit-Limit";
-	private static final String REMAINING_HEADER_KEY = "X-Ratelimit-Remaining";
+	protected static final String LIMIT_HEADER_KEY = "X-Ratelimit-Limit";
+	protected static final String REMAINING_HEADER_KEY = "X-Ratelimit-Remaining";
 
 	/**
 	 * Get the available API limit. It correspond to the value of 
 	 * X-Ratelimit-Limit key in HTTP response headers. For Instagram 
 	 * v1 API, this method should return 5000.
 	 * @param headers HTTP headers from a Response object
-	 * @return Available API limit
+	 * @return Available API limit. -1 if response header is invalid or does not contains the API 
+     * limit information
 	 */
 	public static int getAPILimitStatus(Map<String, String> headers){
 		return APILimitUtils.getIntegerValue(headers, LIMIT_HEADER_KEY);
@@ -28,7 +29,8 @@ public static int getAPILimitStatus(Map<String, String> headers){
 	 * Get the remaining API limit. It correspond to the value of 
 	 * X-Ratelimit-Remaining key in HTTP response headers.
 	 * @param headers HTTP headers from a Response object
-	 * @return Remaining API limit
+	 * @return Remaining API limit. -1 if response header is invalid or does not contains the remaining 
+	 * limit information
 	 */
 	public static int getRemainingLimitStatus(Map<String, String> headers){
 		return APILimitUtils.getIntegerValue(headers, REMAINING_HEADER_KEY);
@@ -41,7 +43,7 @@ private static int getIntegerValue(Map<String, String> header, String key){
 		try {
 			value = Integer.valueOf(intValueStr);
 		} catch (NumberFormatException e) {
-			System.out.printf("Invalid Integer value for key: %s, value %s%n", key, intValueStr);
+			System.err.printf("Invalid Integer value for key: %s, value %s%n", key, intValueStr);
 		}
 		return value;
 	}

diff --git a/src/test/java/org/jinstagram/http/APILimitUtilsTest.java b/src/test/java/org/jinstagram/http/APILimitUtilsTest.java
@@ -0,0 +1,59 @@
+package org.jinstagram.http;
+
+import static org.junit.Assert.*;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.Test;
+
+public class APILimitUtilsTest {
+
+    @Test
+    public void remainingBetweenMinAndMax() {
+        int limitValue = 5000;
+        int remainingValue = 3999;
+
+        Map<String, String> headers = new HashMap<String, String>();
+        headers.put(APILimitUtils.LIMIT_HEADER_KEY, String.valueOf(limitValue));
+        headers.put(APILimitUtils.REMAINING_HEADER_KEY, String.valueOf(remainingValue));
+
+        assertTrue(limitValue == Integer.valueOf(APILimitUtils.getAPILimitStatus(headers)));
+        assertTrue(remainingValue == Integer.valueOf(APILimitUtils.getRemainingLimitStatus(headers)));
+    }
+
+    @Test
+    public void remainingBetweenMax() {
+        int limitValue = 5000;
+        int remainingValue = limitValue;
+
+        Map<String, String> headers = new HashMap<String, String>();
+        headers.put(APILimitUtils.LIMIT_HEADER_KEY, String.valueOf(limitValue));
+        headers.put(APILimitUtils.REMAINING_HEADER_KEY, String.valueOf(remainingValue));
+
+        assertTrue(limitValue == APILimitUtils.getAPILimitStatus(headers));
+        assertTrue(remainingValue == APILimitUtils.getRemainingLimitStatus(headers)); 
+    }
+
+    @Test
+    public void remainingZero() {
+        int limitValue = 5000;
+        int remainingValue = 0;
+
+        Map<String, String> headers = new HashMap<String, String>();
+        headers.put(APILimitUtils.LIMIT_HEADER_KEY, String.valueOf(limitValue));
+        headers.put(APILimitUtils.REMAINING_HEADER_KEY, String.valueOf(remainingValue));
+
+        assertTrue(limitValue == APILimitUtils.getAPILimitStatus(headers));
+        assertTrue(remainingValue == APILimitUtils.getRemainingLimitStatus(headers)); 
+    }
+
+    @Test
+    public void emptyHeader() {
+        int defaultErrorValue = -1;
+        Map<String, String> headers = new HashMap<String, String>();
+
+        assertTrue(defaultErrorValue == APILimitUtils.getAPILimitStatus(headers));
+        assertTrue(defaultErrorValue == APILimitUtils.getRemainingLimitStatus(headers)); 
+    }
+}