Merge pull request #16 from maxmind/greg/new-dbs

Greg/new dbs

Author: borisz

README.md

@@ -99,6 +99,7 @@ See the API documentation for more details.
 
 ## Database Example ##
 
+### City ###
 ```java
 
 // A File object pointing to your GeoIP2 or GeoLite2 database
@@ -128,6 +129,66 @@ System.out.println(response.getLocation().getLongitude()); // -93.2323
 
 ```
 
+### Connection-Type ###
+
+```java
+
+// A File object pointing to your GeoIP2 Connection-Type database
+File database = new File("/path/to/GeoIP2-Connection-Type.mmdb");
+
+// This creates the DatabaseReader object, which should be reused across
+// lookups.
+DatabaseReader reader = new DatabaseReader.Builder(database).build();
+
+
+ConnectionTypeResponse response = reader.connectionType(
+        InetAddress.getByName("128.101.101.101"));
+
+// getConnectionType() returns a ConnectionType enum
+ConnectionType type = response.getConnectionType();
+
+System.out.println(type); // 'Corporate'
+```
+
+### Domain ###
+
+```java
+
+// A File object pointing to your GeoIP2 Domain database
+File database = new File("/path/to/GeoIP2-Domain.mmdb");
+
+// This creates the DatabaseReader object, which should be reused across
+// lookups.
+DatabaseReader reader = new DatabaseReader.Builder(database).build();
+
+
+DomainResponse response = reader.domain(
+        InetAddress.getByName("128.101.101.101"));
+
+System.out.println(response.getDomain()); // 'Corporate'
+```
+
+### ISP ###
+
+```java
+
+// A File object pointing to your GeoIP2 ISP database
+File database = new File("/path/to/GeoIP2-ISP.mmdb");
+
+// This creates the DatabaseReader object, which should be reused across
+// lookups.
+DatabaseReader reader = new DatabaseReader.Builder(database).build();
+
+
+IspResponse response = reader.isp(InetAddress.getByName("128.101.101.101"));
+
+System.out.println(response.getAutonomousSystemNumber()); // 217
+System.out.println(response.getAutonomousSystemOrganization()); // 'University of Minnesota'
+System.out.println(response.getIsp()); // 'University of Minnesota'
+System.out.println(response.getOrganization()); // 'University of Minnesota'
+
+```
+
 ## Exceptions ##
 
 For details on the possible errors returned by the web service itself, [see

src/main/java/com/maxmind/geoip2/DatabaseReader.java

@@ -18,7 +18,10 @@
 import com.maxmind.geoip2.exception.GeoIp2Exception;
 import com.maxmind.geoip2.model.CityIspOrgResponse;
 import com.maxmind.geoip2.model.CityResponse;
+import com.maxmind.geoip2.model.ConnectionTypeResponse;
 import com.maxmind.geoip2.model.CountryResponse;
+import com.maxmind.geoip2.model.DomainResponse;
+import com.maxmind.geoip2.model.IspResponse;
 import com.maxmind.geoip2.model.OmniResponse;
 
 /**
@@ -45,6 +48,8 @@ public class DatabaseReader implements GeoIp2Provider, Closeable {
         this.om = new ObjectMapper();
         this.om.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,
                 false);
+        this.om.configure(
+                DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, true);
         InjectableValues inject = new InjectableValues.Std().addValue(
                 "locales", builder.locales);
         this.om.setInjectableValues(inject);
@@ -54,11 +59,10 @@ public class DatabaseReader implements GeoIp2Provider, Closeable {
      * Constructs a Builder for the DatabaseReader. The file passed to it must
      * be a valid GeoIP2 database file.
      *
-     * <code>Builder</code> creates instances of
-     * <code>DatabaseReader</code> from values set by the methods.
+     * <code>Builder</code> creates instances of <code>DatabaseReader</code>
+     * from values set by the methods.
      *
-     * Only the values set in the <code>Builder</code> constructor are
-     * required.
+     * Only the values set in the <code>Builder</code> constructor are required.
      */
     public final static class Builder {
         final File database;
@@ -117,7 +121,8 @@ public Builder fileMode(FileMode val) {
         /**
          * @return an instance of <code>DatabaseReader</code> created from the
          *         fields set on this builder.
-         * @throws IOException if there is an error reading the database
+         * @throws IOException
+         *             if there is an error reading the database
          */
         public DatabaseReader build() throws IOException {
             return new DatabaseReader(this);
@@ -135,6 +140,11 @@ public DatabaseReader build() throws IOException {
      */
     private <T> T get(InetAddress ipAddress, Class<T> cls) throws IOException,
             AddressNotFoundException {
+        return this.get(ipAddress, cls, true);
+    }
+
+    private <T> T get(InetAddress ipAddress, Class<T> cls, boolean hasTraits)
+            throws IOException, AddressNotFoundException {
         ObjectNode node = (ObjectNode) this.reader.get(ipAddress);
 
         // We throw the same exception as the web service when an IP is not in
@@ -144,11 +154,16 @@ private <T> T get(InetAddress ipAddress, Class<T> cls) throws IOException,
                     + ipAddress.getHostAddress() + " is not in the database.");
         }
 
-        if (!node.has("traits")) {
-            node.put("traits", this.om.createObjectNode());
+        ObjectNode ipNode;
+        if (hasTraits) {
+            if (!node.has("traits")) {
+                node.put("traits", this.om.createObjectNode());
+            }
+            ipNode = (ObjectNode) node.get("traits");
+        } else {
+            ipNode = node;
         }
-        ObjectNode traits = (ObjectNode) node.get("traits");
-        traits.put("ip_address", ipAddress.getHostAddress());
+        ipNode.put("ip_address", ipAddress.getHostAddress());
 
         // The cast and the Omni.class are sort of ugly. There might be a
         // better way
@@ -189,4 +204,19 @@ public OmniResponse omni(InetAddress ipAddress) throws IOException,
             GeoIp2Exception {
         return this.get(ipAddress, OmniResponse.class);
     }
+
+    public ConnectionTypeResponse connectionType(InetAddress ipAddress)
+            throws IOException, GeoIp2Exception {
+        return this.get(ipAddress, ConnectionTypeResponse.class, false);
+    }
+
+    public DomainResponse domain(InetAddress ipAddress) throws IOException,
+            GeoIp2Exception {
+        return this.get(ipAddress, DomainResponse.class, false);
+    }
+
+    public IspResponse isp(InetAddress ipAddress) throws IOException,
+            GeoIp2Exception {
+        return this.get(ipAddress, IspResponse.class, false);
+    }
 }

src/main/java/com/maxmind/geoip2/GeoIp2Provider.java

@@ -15,8 +15,10 @@ public interface GeoIp2Provider {
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return A Country model for the requested IP address.
-     * @throws GeoIp2Exception if there is an error looking up the IP
-     * @throws IOException if there is an IO error
+     * @throws GeoIp2Exception
+     *             if there is an error looking up the IP
+     * @throws IOException
+     *             if there is an IO error
      */
     public CountryResponse country(InetAddress ipAddress) throws IOException,
             GeoIp2Exception;
@@ -25,8 +27,10 @@ public CountryResponse country(InetAddress ipAddress) throws IOException,
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return A City model for the requested IP address.
-     * @throws GeoIp2Exception if there is an error looking up the IP
-     * @throws IOException if there is an IO error
+     * @throws GeoIp2Exception
+     *             if there is an error looking up the IP
+     * @throws IOException
+     *             if there is an IO error
      */
     public CityResponse city(InetAddress ipAddress) throws IOException,
             GeoIp2Exception;
@@ -35,8 +39,10 @@ public CityResponse city(InetAddress ipAddress) throws IOException,
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return A CityIspOrg model for the requested IP address.
-     * @throws GeoIp2Exception if there is an error looking up the IP
-     * @throws IOException if there is an IO error
+     * @throws GeoIp2Exception
+     *             if there is an error looking up the IP
+     * @throws IOException
+     *             if there is an IO error
      */
     public CityIspOrgResponse cityIspOrg(InetAddress ipAddress)
             throws IOException, GeoIp2Exception;
@@ -45,8 +51,10 @@ public CityIspOrgResponse cityIspOrg(InetAddress ipAddress)
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return An Omni model for the requested IP address.
-     * @throws GeoIp2Exception if there is an error looking up the IP
-     * @throws IOException if there is an IO error
+     * @throws GeoIp2Exception
+     *             if there is an error looking up the IP
+     * @throws IOException
+     *             if there is an IO error
      */
     public OmniResponse omni(InetAddress ipAddress) throws IOException,
             GeoIp2Exception;

src/main/java/com/maxmind/geoip2/WebServiceClient.java

@@ -118,10 +118,10 @@ public class WebServiceClient implements GeoIp2Provider {
     }
 
     /**
-     * <code>Builder</code> creates instances of
-     * <code>WebServiceClient</code> from values set by the methods.
+     * <code>Builder</code> creates instances of <code>WebServiceClient</code>
+     * from values set by the methods.
      *
-     *  This example shows how to create a <code>WebServiceClient</code> object
+     * This example shows how to create a <code>WebServiceClient</code> object
      * with the <code>Builder</code>:
      *
      * WebServiceClient client = new
@@ -183,7 +183,8 @@ public Builder timeout(int val) {
         }
 
         /**
-         * @param val Transport for unit testing.
+         * @param val
+         *            Transport for unit testing.
          * @return Builder object
          */
         Builder testTransport(HttpTransport val) {
@@ -202,8 +203,10 @@ public WebServiceClient build() {
 
     /**
      * @return A Country model for the requesting IP address
-     * @throws GeoIp2Exception if there is an error from the web service
-     * @throws IOException if an IO error happens during the request
+     * @throws GeoIp2Exception
+     *             if there is an error from the web service
+     * @throws IOException
+     *             if an IO error happens during the request
      */
     public CountryResponse country() throws IOException, GeoIp2Exception {
         return this.country(null);
@@ -217,8 +220,10 @@ public CountryResponse country(InetAddress ipAddress) throws IOException,
 
     /**
      * @return A City model for the requesting IP address
-     * @throws GeoIp2Exception if there is an error from the web service
-     * @throws IOException if an IO error happens during the request
+     * @throws GeoIp2Exception
+     *             if there is an error from the web service
+     * @throws IOException
+     *             if an IO error happens during the request
      */
     public CityResponse city() throws IOException, GeoIp2Exception {
         return this.city(null);
@@ -232,8 +237,10 @@ public CityResponse city(InetAddress ipAddress) throws IOException,
 
     /**
      * @return A City/ISP/Org model for the requesting IP address
-     * @throws GeoIp2Exception if there is an error from the web service
-     * @throws IOException if an IO error happens during the request
+     * @throws GeoIp2Exception
+     *             if there is an error from the web service
+     * @throws IOException
+     *             if an IO error happens during the request
      */
     public CityIspOrgResponse cityIspOrg() throws IOException, GeoIp2Exception {
         return this.cityIspOrg(null);
@@ -248,8 +255,10 @@ public CityIspOrgResponse cityIspOrg(InetAddress ipAddress)
 
     /**
      * @return An Omni model for the requesting IP address
-     * @throws GeoIp2Exception if there is an error from the web service
-     * @throws IOException if an IO error happens during the request
+     * @throws GeoIp2Exception
+     *             if there is an error from the web service
+     * @throws IOException
+     *             if an IO error happens during the request
      */
     public OmniResponse omni() throws IOException, GeoIp2Exception {
         return this.omni(null);
@@ -291,9 +300,11 @@ private <T> T responseFor(String path, InetAddress ipAddress, Class<T> cls)
 
     private HttpResponse getResponse(GenericUrl uri) throws GeoIp2Exception,
             IOException {
-        // We only use a instance variable for HttpTransport when unit testing as
+        // We only use a instance variable for HttpTransport when unit testing
+        // as
         // HttpTransport is not thread safe.
-        HttpTransport transport = this.testTransport == null ? new NetHttpTransport() : this.testTransport;
+        HttpTransport transport = this.testTransport == null ? new NetHttpTransport()
+                : this.testTransport;
         HttpRequestFactory requestFactory = transport.createRequestFactory();
         HttpRequest request;
         try {

src/main/java/com/maxmind/geoip2/model/AbstractCityResponse.java

@@ -79,8 +79,7 @@ public String toString() {
                 + (this.getPostal() != null ? "getPostal()=" + this.getPostal()
                         + ", " : "")
                 + (this.getSubdivisions() != null ? "getSubdivisionsList()="
-                        + this.getSubdivisions() + ", "
-                        : "")
+                        + this.getSubdivisions() + ", " : "")
                 + (this.getContinent() != null ? "getContinent()="
                         + this.getContinent() + ", " : "")
                 + (this.getCountry() != null ? "getCountry()="

src/main/java/com/maxmind/geoip2/model/AbstractCountryResponse.java

@@ -1,17 +1,13 @@
 package com.maxmind.geoip2.model;
 
-import java.io.IOException;
-
-import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.maxmind.geoip2.record.Continent;
 import com.maxmind.geoip2.record.Country;
 import com.maxmind.geoip2.record.MaxMind;
 import com.maxmind.geoip2.record.RepresentedCountry;
 import com.maxmind.geoip2.record.Traits;
 
-abstract class AbstractCountryResponse {
+abstract class AbstractCountryResponse extends AbstractResponse {
     @JsonProperty
     private Continent continent = new Continent();
 
@@ -80,19 +76,6 @@ public Traits getTraits() {
         return this.traits;
     }
 
-    /**
-     * @return JSON representation of this object. The structure is the same as
-     *         the JSON provided by the GeoIP2 web service.
-     * @throws IOException
-     *             if there is an error serializing the object to JSON.
-     */
-    public String toJson() throws IOException {
-        ObjectMapper mapper = new ObjectMapper();
-        mapper.setSerializationInclusion(Include.NON_NULL);
-        mapper.setSerializationInclusion(Include.NON_EMPTY);
-        return mapper.writeValueAsString(this);
-    }
-
     /*
      * (non-Javadoc)
      *

src/main/java/com/maxmind/geoip2/model/AbstractResponse.java

@@ -0,0 +1,23 @@
+package com.maxmind.geoip2.model;
+
+import java.io.IOException;
+
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class AbstractResponse {
+
+    /**
+     * @return JSON representation of this object. The structure is the same as
+     *         the JSON provided by the GeoIP2 web service.
+     * @throws IOException
+     *             if there is an error serializing the object to JSON.
+     */
+    public String toJson() throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.setSerializationInclusion(Include.NON_NULL);
+        mapper.setSerializationInclusion(Include.NON_EMPTY);
+        return mapper.writeValueAsString(this);
+    }
+
+}