simplify cache and use versioned cache keys.

Author: UmanShahzad

CHANGELOG.md

@@ -5,6 +5,9 @@ Breaking changes:
 - `IPInfo` is renamed to `IPinfo`.
 - `IPInfoBuilder` is moved into `IPinfo.Builder`.
 - `ASNResponse.numIps` is now an `Integer` instead of a `String`.
+- The cache implementation now only uses `get` and `set`, which accept
+  arbitrary strings, which may not necessarily be IP or ASN strings like
+  "1.2.3.4" and "AS123".
 
 Additions:
 
@@ -15,3 +18,5 @@ Additions:
   of IPs.
 - Many new pieces of data have been added that were previously missing. The new
   dataset reflects all the new data available via raw API calls.
+- The keys given to cache functions will now be versioned. `IPinfo.cacheKey`
+  must be used to derive the correct key if doing manual lookups.

src/main/java/io/ipinfo/api/IPinfo.java

@@ -54,7 +54,6 @@ public class IPinfo {
 
     public static void main(String... args) {
         System.out.println("This library is not meant to be run as a standalone jar.");
-
         System.exit(0);
     }
 
@@ -66,15 +65,15 @@ public static void main(String... args) {
      * @throws RateLimitedException an exception when your api key has been rate limited.
      */
     public IPResponse lookupIP(String ip) throws RateLimitedException {
-        IPResponse response = cache.getIp(ip);
+        IPResponse response = (IPResponse)cache.get(cacheKey(ip));
         if (response != null) {
             return response;
         }
 
         response = new IPRequest(client, token, ip).handle();
         response.setContext(context);
 
-        cache.setIp(ip, response);
+        cache.set(cacheKey(ip), response);
         return response;
     }
 
@@ -86,15 +85,15 @@ public IPResponse lookupIP(String ip) throws RateLimitedException {
      * @throws RateLimitedException an exception when your api key has been rate limited.
      */
     public ASNResponse lookupASN(String asn) throws RateLimitedException {
-        ASNResponse response = cache.getAsn(asn);
+        ASNResponse response = (ASNResponse)cache.get(cacheKey(asn));
         if (response != null) {
             return response;
         }
 
         response = new ASNRequest(client, token, asn).handle();
         response.setContext(context);
 
-        cache.setAsn(asn, response);
+        cache.set(cacheKey(asn), response);
         return response;
     }
 
@@ -208,7 +207,7 @@ private ConcurrentHashMap<String, Object> getBatchGeneric(
         if (this.cache != null) {
             lookupUrls = new ArrayList<>(urls.size()/2);
             for (String url : urls) {
-                Object val = cache.get(url);
+                Object val = cache.get(cacheKey(url));
                 if (val != null) {
                     result.put(url, val);
                 } else {
@@ -340,14 +339,24 @@ public void accept(String k, Object v) {
             for (String url : lookupUrls) {
                 Object v = result.get(url);
                 if (v != null) {
-                    cache.set(url, v);
+                    cache.set(cacheKey(url), v);
                 }
             }
         }
 
         return result;
     }
 
+    /**
+     * Converts a normal key into a versioned cache key.
+     *
+     * @param k the key to convert into a versioned cache key.
+     * @return the versioned cache key.
+     */
+    public static String cacheKey(String k) {
+        return k+":1";
+    }
+
     public static class Builder {
         private File countryFile =
                 new File(this.getClass().getClassLoader().getResource("en_US.json").getFile());

src/main/java/io/ipinfo/api/cache/Cache.java

@@ -4,22 +4,6 @@
 import io.ipinfo.api.model.IPResponse;
 
 public interface Cache {
-    /**
-     * Gets the IPResponse stored in cache.
-     *
-     * @param ip The ip string
-     * @return IPResponse Object - may be null.
-     */
-    IPResponse getIp(String ip);
-
-    /**
-     * Gets the ASNResponse stored in cache.
-     *
-     * @param asn The asn string
-     * @return ASNResponse Object - may be null.
-     */
-    ASNResponse getAsn(String asn);
-
     /**
      * Gets an arbitrary object stored in cache.
      *
@@ -28,24 +12,6 @@ public interface Cache {
      */
     Object get(String key);
 
-    /**
-     * Sets the IP in the cache.
-     *
-     * @param ip       The IP string.
-     * @param response The IPResponse object - may be null.
-     * @return if caching was successful
-     */
-    boolean setIp(String ip, IPResponse response);
-
-    /**
-     * Sets the ASN in the cache.
-     *
-     * @param asn      the ASN string.
-     * @param response the ASNResponse object - may be null.
-     * @return if caching was successful.
-     */
-    boolean setAsn(String asn, ASNResponse response);
-
     /**
      * Sets a key/value pair in the cache.
      *

src/main/java/io/ipinfo/api/cache/NoCache.java

@@ -1,35 +1,11 @@
 package io.ipinfo.api.cache;
 
-
-import io.ipinfo.api.model.ASNResponse;
-import io.ipinfo.api.model.IPResponse;
-
 public class NoCache implements Cache {
-    @Override
-    public IPResponse getIp(String ip) {
-        return null;
-    }
-
-    @Override
-    public ASNResponse getAsn(String asn) {
-        return null;
-    }
-
     @Override
     public Object get(String key) {
         return null;
     }
 
-    @Override
-    public boolean setIp(String ip, IPResponse response) {
-        return false;
-    }
-
-    @Override
-    public boolean setAsn(String asn, ASNResponse response) {
-        return false;
-    }
-
     @Override
     public boolean set(String key, Object val) {
         return false;

src/main/java/io/ipinfo/api/cache/SimpleCache.java

@@ -1,8 +1,5 @@
 package io.ipinfo.api.cache;
 
-import io.ipinfo.api.model.ASNResponse;
-import io.ipinfo.api.model.IPResponse;
-
 import java.time.Duration;
 import java.time.Instant;
 import java.time.temporal.ChronoField;
@@ -11,88 +8,54 @@
 
 public class SimpleCache implements Cache {
     private final Duration duration;
-    private final Map<String, Payload<ASNResponse>> asnCache = new HashMap<>();
-    private final Map<String, Payload<IPResponse>> ipCache = new HashMap<>();
-    private final Map<String, Payload<Object>> cache = new HashMap<>();
+    private final Map<String, Payload> cache = new HashMap<>();
 
     public SimpleCache(Duration duration) {
         this.duration = duration;
     }
 
-    @Override
-    public IPResponse getIp(String ip) {
-        Payload<IPResponse> payload = ipCache.get(ip);
-        if (payload == null || payload.hasExpired()) {
-            return null;
-        }
-
-        return payload.data;
-    }
-
-    @Override
-    public ASNResponse getAsn(String asn) {
-        Payload<ASNResponse> payload = asnCache.get(asn);
-        if (payload == null || payload.hasExpired()) {
-            return null;
-        }
-
-        return payload.data;
-    }
-
     @Override
     public Object get(String key) {
-        Payload<Object> payload = cache.get(key);
+        Payload payload = cache.get(key);
         if (payload == null || payload.hasExpired()) {
             return null;
         }
 
         return payload.data;
     }
 
-    @Override
-    public boolean setIp(String ip, IPResponse response) {
-        ipCache.put(ip, new Payload<>(response, duration));
-        return true;
-    }
-
-    @Override
-    public boolean setAsn(String asn, ASNResponse response) {
-        asnCache.put(asn, new Payload<>(response, duration));
-        return true;
-    }
-
     @Override
     public boolean set(String key, Object val) {
-        cache.put(key, new Payload<>(val, duration));
+        cache.put(key, new Payload(val, duration));
         return true;
     }
 
     @Override
     public boolean clear() {
-        ipCache.clear();
-        asnCache.clear();
         cache.clear();
         return true;
     }
 
-    private static class Payload<T> {
-        final T data;
+    private static class Payload {
+        final Object data;
         final Instant creation;
         final Duration expiration;
 
-        Payload(T data, Duration duration) {
+        Payload(Object data, Duration duration) {
             this.data = data;
             creation = Instant.now();
             this.expiration = duration;
         }
 
         public boolean hasExpired() {
-            long time = expiration.addTo(creation).getLong(ChronoField.INSTANT_SECONDS);
+            long time = expiration
+                    .addTo(creation)
+                    .getLong(ChronoField.INSTANT_SECONDS);
             long now = System.currentTimeMillis();
             return now <= time;
         }
 
-        public T getData() {
+        public Object getData() {
             return data;
         }
     }