Merge pull request #24 from ipinfo/uman/updates

Batch ops, new types & map integration

Author: UmanShahzad

CHANGELOG.md

@@ -0,0 +1,22 @@
+# 2.0.0
+
+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:
+
+- `getBatch`, `getBatchIps` and `getBatchAsns` allow you to do lookups of
+  multiple entities at once. There is no limit to the size of inputs on these
+  library calls as long as your token has quota.
+- `getMap` will give you a map URL for https://ipinfo.io/tools/map given a list
+  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.

README.md

@@ -4,6 +4,7 @@
 [![Travis](https://travis-ci.com/ipinfo/java.svg?branch=master&style=flat-square)](https://travis-ci.com/ipinfo/java)
 
 This is the official Java client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
+
  - [IP geolocation data](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude and longitude)
  - [ASN information](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting or company)
  - [Company data](https://ipinfo.io/ip-company-api) (the name and domain of the business that uses the IP address)
@@ -13,13 +14,14 @@ Check all the data we have for your IP address [here](https://ipinfo.io/what-is-
 
 ### Getting Started
 
-You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup). 
+You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup).
 
 The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing)
 
 #### Installation
 
 ##### Maven
+
 Add these values to your pom.xml file:
 
 Dependency:
@@ -29,7 +31,7 @@ Dependency:
     <dependency>
         <groupId>io.ipinfo</groupId>
         <artifactId>ipinfo-api</artifactId>
-        <version>1.0</version>
+        <version>2.0</version>
         <scope>compile</scope>
     </dependency>
 </dependencies>
@@ -39,16 +41,16 @@ Dependency:
 
 ##### IP Information
 
-
 ````java
-import io.ipinfo.api.IPInfo;
+import io.ipinfo.api.IPinfo;
 import io.ipinfo.api.errors.RateLimitedException;
 import io.ipinfo.api.model.IPResponse;
 
 public class Main {
-
     public static void main(String... args) {
-        IPInfo ipInfo = IPInfo.builder().setToken("YOUR TOKEN").build();
+        IPinfo ipInfo = new IPinfo.Builder()
+                .setToken("YOUR TOKEN")
+                .build();
 
         try {
             IPResponse response = ipInfo.lookupIP("8.8.8.8");
@@ -62,18 +64,18 @@ public class Main {
 }
 ````
 
-
 ##### ASN Information
 
 ````java
-import io.ipinfo.api.IPInfo;
+import io.ipinfo.api.IPinfo;
 import io.ipinfo.api.errors.RateLimitedException;
 import io.ipinfo.api.model.IPResponse;
 
 public class Main {
-
     public static void main(String... args) {
-        IPInfo ipInfo = IPInfo.builder().setToken("YOUR TOKEN").build();
+        IPinfo ipInfo = new IPinfo.Builder()
+                .setToken("YOUR TOKEN")
+                .build();
 
         try {
             ASNResponse response = ipInfo.lookupASN("AS7922");
@@ -89,29 +91,36 @@ public class Main {
 
 #### Errors
 
-- ErrorResponseException: A runtime exception accessible through the ExecutionException of a future. This exception signals that something went wrong when mapping the API response to the wrapper. You probably can't recover from this exception.
-
-- RateLimitedException An exception signalling that you've been rate limited.
+- `ErrorResponseException`: A runtime exception accessible through the
+  `ExecutionException` of a future. This exception signals that something went
+  wrong when mapping the API response to the wrapper. You probably can't
+  recover from this exception.
+- `RateLimitedException` An exception signalling that you've been rate limited.
 
 #### Caching
 
-This library provides a very simple caching system accessible in `SimpleCache`. Simple cache is an in memory caching system that resets every time you restart your code.
-
-If you prefer a different caching methodology, you may use the `Cache` interface and implement your own caching system around your own infrastructure.
+This library provides a very simple caching system accessible in `SimpleCache`.
+Simple cache is an in memory caching system that resets every time you restart
+your code.
 
-The default cache length is 1 day, this can be changed by calling the SimpleCache constructor yourself.
+If you prefer a different caching methodology, you may use the `Cache`
+interface and implement your own caching system around your own infrastructure.
 
+The default cache length is 1 day, this can be changed by calling the
+SimpleCache constructor yourself.
 
 ```java
-import io.ipinfo.api.IPInfo;
+import io.ipinfo.api.IPinfo;
 import io.ipinfo.api.errors.RateLimitedException;
 import io.ipinfo.api.model.IPResponse;
 
 public class Main {
-
     public static void main(String... args) {
         // 5 Day Cache
-        IPInfo ipInfo = IPInfo.builder().setToken("YOUR TOKEN").setCache(new SimpleCache(Duration.ofDays(5))).build();
+        IPinfo ipInfo = new IPinfo.Builder()
+                .setToken("YOUR TOKEN")
+                .setCache(new SimpleCache(Duration.ofDays(5)))
+                .build();
 
         try {
             IPResponse response = ipInfo.lookupIP("8.8.8.8");
@@ -127,19 +136,24 @@ public class Main {
 
 #### Country Name Lookup
 
-This library provides a system to lookup country names through ISO2 country codes.
+This library provides a system to lookup country names through ISO2 country
+codes.
 
-By default, this translation exists for English (United States). If you wish to provide a different language mapping, just use the following system in the builder:
+By default, this translation exists for English (United States). If you wish to
+provide a different language mapping, just use the following system in the
+builder:
 
 ```java
-import io.ipinfo.api.IPInfo;
+import io.ipinfo.api.IPinfo;
 import io.ipinfo.api.errors.RateLimitedException;
 import io.ipinfo.api.model.IPResponse;
 
 public class Main {
-
     public static void main(String... args) {
-        IPInfo ipInfo = IPInfo.builder().setToken("YOUR TOKEN").setCountryFile(new File("path/to/file.json")).build();
+        IPinfo ipInfo = new IPinfo.Builder()
+                .setToken("YOUR TOKEN")
+                .setCountryFile(new File("path/to/file.json"))
+                .build();
 
         try {
             IPResponse response = ipInfo.lookupIP("8.8.8.8");
@@ -165,14 +179,16 @@ More language files can be found [here](https://country.io/data)
 This library provides an easy way to get the latitude and longitude of an IP Address:
 
 ```java
-import io.ipinfo.api.IPInfo;
+import io.ipinfo.api.IPinfo;
 import io.ipinfo.api.errors.RateLimitedException;
 import io.ipinfo.api.model.IPResponse;
 
 public class Main {
-
     public static void main(String... args) {
-        IPInfo ipInfo = IPInfo.builder().setToken("YOUR TOKEN").setCountryFile(new File("path/to/file.json")).build();
+        IPinfo ipInfo = new IPinfo.Builder()
+                .setToken("YOUR TOKEN")
+                .setCountryFile(new File("path/to/file.json"))
+                .build();
 
         try {
             IPResponse response = ipInfo.lookupIP("8.8.8.8");
@@ -190,13 +206,14 @@ public class Main {
 
 #### Extra Information
 
-- This library is thread safe. Feel free to call the different endpoints from different threads.
-- This library uses square's http client. Please refer to their documentation to get information on more functionality you can use.
-
+- This library is thread safe. Feel free to call the different endpoints from
+  different threads.
+- This library uses square's http client. Please refer to their documentation
+  to get information on more functionality you can use.
 
 ### Other Libraries
 
-There are official [IPinfo client libraries](https://ipinfo.io/developers/libraries) available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API. 
+There are official [IPinfo client libraries](https://ipinfo.io/developers/libraries) available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.
 
 ### About IPinfo
 

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>io.ipinfo</groupId>
     <artifactId>ipinfo-api</artifactId>
-    <version>1.2-SNAPSHOT</version>
+    <version>2.0</version>
     <packaging>jar</packaging>
 
     <parent>
@@ -42,25 +42,25 @@
     </scm>
 
     <developers>
-        <developer>
-            <id>aaomidi</id>
-            <name>Amir Omidi</name>
-            <email>[email protected]</email>
-            <organization>IPinfo</organization>
-        </developer>
         <developer>
             <id>ipinfo</id>
             <name>IPinfo</name>
             <email>[email protected]</email>
             <organization>IPinfo</organization>
         </developer>
+        <developer>
+            <id>aaomidi</id>
+            <name>Amir Omidi</name>
+            <email>[email protected]</email>
+            <organization>IPinfo</organization>
+        </developer>
     </developers>
 
     <dependencies>
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.8.2</version>
+            <version>2.8.7</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -69,6 +69,12 @@
             <version>3.9.0</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>30.1.1-jre</version>
+            <scope>compile</scope>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>