Removed fallback code from web service client

Author: oschwald

CHANGELOG.md

@@ -12,9 +12,6 @@ CHANGELOG
   `WebServiceException`.
 * A `DatabaseReader` class was added to the distribution. This reads GeoIP2
   databases and returns similar product object to `WebServiceClient`.
-* A `fallbackDatabase` option was added to `WebServiceClient.Builder`.
-  This allows you to specify a database to fall back to if the web service
-  request fails.
 
 0.2.0 (2013-06-13)
 ------------------

README.md

@@ -50,22 +50,38 @@ which represents part of the data returned by the web service.
 
 See the API documentation for more details.
 
-## Example ##
+## Web Service Example ##
 
 ```java
 
 WebServiceClient client = new WebServiceClient.Builder(42, "abcfe12345").build();
 
 Omni omni = client.omni(InetAddress.getByName("24.24.24.24"));
 
-CityRecord city = omni.getCity();
-System.out.println(city.getName());
+CountryRecord countryRecord = omni.getCountry();
+System.out.println(countryRecord.getName());
 
-PostalRecord postal = omni.getPostal();
-System.out.println(postal.getCode());
+PostalRecord postalRecord = omni.getPostal();
+System.out.println(postalRecord.getCode());
 
 ```
 
+## Database Example ##
+
+```java
+
+DatabaseReader reader = new DatabaseReader(new File("/path/to/GeoIP2-City.mmdb");
+
+City city = reader.get(InetAddress.getByName("24.24.24.24"));
+
+System.out.println(city.getCountry().getName());
+
+PostalRecord postalRecord = city.getPostal();
+System.out.println(postalRecord.getCode());
+
+```
+
+
 ## Exceptions ##
 
 For details on the possible errors returned by the web service itself, [see

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

@@ -1,7 +1,5 @@
 package com.maxmind.geoip2;
 
-import java.io.Closeable;
-import java.io.File;
 import java.io.IOException;
 import java.net.InetAddress;
 import java.util.Arrays;
@@ -26,8 +24,8 @@
 import com.maxmind.geoip2.exception.HttpException;
 import com.maxmind.geoip2.exception.InvalidRequestException;
 import com.maxmind.geoip2.exception.OutOfQueriesException;
-import com.maxmind.geoip2.model.CityIspOrg;
 import com.maxmind.geoip2.model.City;
+import com.maxmind.geoip2.model.CityIspOrg;
 import com.maxmind.geoip2.model.Country;
 import com.maxmind.geoip2.model.Omni;
 
@@ -101,18 +99,16 @@
  * throws a {@link GeoIp2Exception}.
  * </p>
  */
-public class WebServiceClient implements Closeable {
+public class WebServiceClient {
     private final String host;
     private final List<String> languages;
     private final String licenseKey;
     private final int timeout;
     private final HttpTransport transport;
     private final int userId;
-    private final DatabaseReader fallbackDatabase;
 
     @SuppressWarnings("synthetic-access")
     private WebServiceClient(Builder builder) {
-        this.fallbackDatabase = builder.fallbackDatabase;
         this.host = builder.host;
         this.languages = builder.languages;
         this.licenseKey = builder.licenseKey;
@@ -125,11 +121,12 @@ private WebServiceClient(Builder builder) {
      * <code>Builder</code> creates instances of
      * <code>WebServiceClient</client> from values set by the methods.
      *  
-     *  This example shows how to create a <code>WebServiceClient</code> object with the
-     * <code>Builder</code>:
+     *  This example shows how to create a <code>WebServiceClient</code> object
+     * with the <code>Builder</code>:
      * 
      * WebServiceClient client = new
-     * WebServiceClient.Builder(12,"licensekey").host("geoip.maxmind.com").build();
+     * WebServiceClient.Builder(12,"licensekey").host
+     * ("geoip.maxmind.com").build();
      * 
      * Only the values set in the <code>Builder</code> constructor are required.
      */
@@ -141,7 +138,6 @@ public static class Builder {
         private List<String> languages = Arrays.asList("en");
         private int timeout = 3000;
         private HttpTransport transport = new NetHttpTransport();
-        private DatabaseReader fallbackDatabase;
 
         /**
          * @param userId
@@ -154,17 +150,6 @@ public Builder(int userId, String licenseKey) {
             this.licenseKey = licenseKey;
         }
 
-        /**
-         * @param val
-         *            A fallback GeoIP2 database to use if the the web service
-         *            query fails.
-         * @throws IOException
-         */
-        public Builder fallbackDatabase(File val) throws IOException {
-            this.fallbackDatabase = new DatabaseReader(val);
-            return this;
-        }
-
         /**
          * @param val
          *            The host to use.
@@ -201,8 +186,8 @@ Builder transport(HttpTransport val) {
         }
 
         /**
-         * @return an instance of <code>WebServiceClient</code> created from the fields
-         *         set on this builder.
+         * @return an instance of <code>WebServiceClient</code> created from the
+         *         fields set on this builder.
          */
         @SuppressWarnings("synthetic-access")
         public WebServiceClient build() {
@@ -247,8 +232,7 @@ public City city() throws IOException, GeoIp2Exception {
      * @throws GeoIp2Exception
      * @throws IOException
      */
-    public City city(InetAddress ipAddress) throws IOException,
-            GeoIp2Exception {
+    public City city(InetAddress ipAddress) throws IOException, GeoIp2Exception {
         return this.responseFor("city", ipAddress, City.class);
     }
 
@@ -268,10 +252,9 @@ public CityIspOrg cityIspOrg() throws IOException, GeoIp2Exception {
      * @throws GeoIp2Exception
      * @throws IOException
      */
-    public CityIspOrg cityIspOrg(InetAddress ipAddress)
-            throws IOException, GeoIp2Exception {
-        return this.responseFor("city_isp_org", ipAddress,
-                CityIspOrg.class);
+    public CityIspOrg cityIspOrg(InetAddress ipAddress) throws IOException,
+            GeoIp2Exception {
+        return this.responseFor("city_isp_org", ipAddress, CityIspOrg.class);
     }
 
     /**
@@ -290,25 +273,11 @@ public Omni omni() throws IOException, GeoIp2Exception {
      * @throws GeoIp2Exception
      * @throws IOException
      */
-    public Omni omni(InetAddress ipAddress) throws IOException,
-            GeoIp2Exception {
+    public Omni omni(InetAddress ipAddress) throws IOException, GeoIp2Exception {
         return this.responseFor("omni", ipAddress, Omni.class);
     }
 
     private <T extends Country> T responseFor(String path,
-            InetAddress ipAddress, Class<T> cls) throws IOException,
-            GeoIp2Exception {
-        try {
-            return this.webServiceResponseFor(path, ipAddress, cls);
-        } catch (GeoIp2Exception e) {
-            if (this.fallbackDatabase != null) {
-                return this.fallbackDatabase.get(ipAddress);
-            }
-            throw e;
-        }
-    }
-
-    private <T extends Country> T webServiceResponseFor(String path,
             InetAddress ipAddress, Class<T> cls) throws GeoIp2Exception,
             AddressNotFoundException {
         GenericUrl uri = this.createUri(path, ipAddress);
@@ -357,7 +326,8 @@ private HttpResponse getResponse(GenericUrl uri) throws GeoIp2Exception,
         try {
             return request.execute();
         } catch (HttpResponseException e) {
-            WebServiceClient.handleErrorStatus(e.getContent(), e.getStatusCode(), uri);
+            WebServiceClient.handleErrorStatus(e.getContent(),
+                    e.getStatusCode(), uri);
             throw new AssertionError(
                     "Something very strange happened. This code should be unreachable.");
         } catch (IOException e) {
@@ -455,17 +425,4 @@ private GenericUrl createUri(String path, InetAddress ipAddress) {
                 + "/" + (ipAddress == null ? "me" : ipAddress.getHostAddress()));
 
     }
-
-    /**
-     * Closes the GeoIP2 fallback database and returns resources to the system.
-     * 
-     * @throws IOException
-     *             if an I/O error occurs.
-     */
-    @Override
-    public void close() throws IOException {
-        if (this.fallbackDatabase != null) {
-            this.fallbackDatabase.close();
-        }
-    }
 }

…/maxmind/geoip2/database/ReaderTest.java …m/maxmind/geoip2/DatabaseReaderTest.javasrc/test/java/com/maxmind/geoip2/database/ReaderTest.java renamed to src/test/java/com/maxmind/geoip2/DatabaseReaderTest.java src/test/java/com/maxmind/geoip2/database/ReaderTest.java renamed to src/test/java/com/maxmind/geoip2/DatabaseReaderTest.java

@@ -1,4 +1,4 @@
-package com.maxmind.geoip2.database;
+package com.maxmind.geoip2;
 
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.junit.Assert.assertEquals;
@@ -12,41 +12,41 @@
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 
-import com.maxmind.geoip2.DatabaseReader;
 import com.maxmind.geoip2.exception.AddressNotFoundException;
-import com.maxmind.geoip2.exception.GeoIp2Exception;
 import com.maxmind.geoip2.model.City;
 import com.maxmind.geoip2.model.Omni;
 
 @SuppressWarnings("static-method")
-public class ReaderTest {
+public class DatabaseReaderTest {
 
     @Rule
     public ExpectedException exception = ExpectedException.none();
 
     @Test
     public void testDefaultLanguage() throws IOException,
             AddressNotFoundException {
-        DatabaseReader reader = new DatabaseReader(new File("test-data/GeoIP2-City.mmdb"));
+        DatabaseReader reader = new DatabaseReader(new File(
+                "test-data/GeoIP2-City.mmdb"));
         City city = reader.get(InetAddress.getByName("81.2.69.160"));
         assertEquals("London", city.getCity().getName());
         reader.close();
     }
 
     @Test
     public void testLanguageList() throws IOException, AddressNotFoundException {
-        DatabaseReader reader = new DatabaseReader(new File("test-data/GeoIP2-City.mmdb"),
-                Arrays.asList("xx", "ru", "pt-BR", "es", "en"));
+        DatabaseReader reader = new DatabaseReader(new File(
+                "test-data/GeoIP2-City.mmdb"), Arrays.asList("xx", "ru",
+                "pt-BR", "es", "en"));
         Omni city = reader.get(InetAddress.getByName("81.2.69.160"));
         assertEquals("Лондон", city.getCity().getName());
-        System.out.println(city.getTraits().getIpAddress());
         reader.close();
 
     }
 
     @Test
     public void hasIpAddress() throws IOException, AddressNotFoundException {
-        DatabaseReader reader = new DatabaseReader(new File("test-data/GeoIP2-City.mmdb"));
+        DatabaseReader reader = new DatabaseReader(new File(
+                "test-data/GeoIP2-City.mmdb"));
         City city = reader.get(InetAddress.getByName("81.2.69.160"));
         assertEquals("81.2.69.160", city.getTraits().getIpAddress());
         reader.close();
@@ -58,7 +58,8 @@ public void unknownAddress() throws IOException, AddressNotFoundException {
         this.exception
                 .expectMessage(containsString("The address 10.10.10.10 is not in the database."));
 
-        DatabaseReader reader = new DatabaseReader(new File("test-data/GeoIP2-City.mmdb"));
+        DatabaseReader reader = new DatabaseReader(new File(
+                "test-data/GeoIP2-City.mmdb"));
         @SuppressWarnings("unused")
         City city = reader.get(InetAddress.getByName("10.10.10.10"));
         reader.close();