Add pagination

Author: cbetta

src/main/java/com/amadeus/HTTPClient.java

@@ -3,6 +3,7 @@
 import com.amadeus.client.AccessToken;
 import com.amadeus.exceptions.NetworkException;
 import com.amadeus.exceptions.ResponseException;
+import com.amadeus.resources.Resource;
 import java.io.BufferedWriter;
 import java.io.IOException;
 import java.io.OutputStream;
@@ -101,15 +102,6 @@ public Response post(String path, Params params) throws ResponseException {
     return request("POST", path, params);
   }
 
-  // A generic method for making requests of any verb.
-  protected Response request(String verb, String path, Params params) throws ResponseException {
-    return unauthenticatedRequest(verb, path, params, accessToken.getBearerToken());
-  }
-
-  // A generic method for making any authenticated or unauthenticated request,
-  // passing in the bearer token explicitly. Used primarily by the
-  // AccessToken to get the first AccessToken.
-
   /**
    * A generic method for making any authenticated or unauthenticated request,
    * passing in the bearer token explicitly. Used primarily by the
@@ -124,6 +116,91 @@ public Response unauthenticatedRequest(String verb, String path, Params params,
     return execute(request);
   }
 
+  /**
+   * Fetches the previous page for a given response.
+   * @param response a response object previously received for which includes an array of data
+   * @return a new response of data
+   * @throws ResponseException if the page could not be found
+   */
+  public Response previous(Response response) throws ResponseException {
+    return page("previous", response);
+  }
+
+  /**
+   * Fetches the previous page for a given response.
+   * @param resource one of the responses previously received from an API call
+   * @return a new array of resources of the same type
+   * @throws ResponseException if the page could not be found
+   */
+  public Resource[] previous(Resource resource) throws ResponseException {
+    return page("previous", resource);
+  }
+
+  /**
+   * Fetches the next page for a given response.
+   * @param response a response object previously received for which includes an array of data
+   * @return a new response of data
+   * @throws ResponseException if the page could not be found
+   */
+  public Response next(Response response) throws ResponseException {
+    return page("next", response);
+  }
+
+  /**
+   * Fetches the next page for a given response.
+   * @param resource one of the responses previously received from an API call
+   * @return a new array of resources of the same type
+   * @throws ResponseException if the page could not be found
+   */
+  public Resource[] next(Resource resource) throws ResponseException {
+    return page("next", resource);
+  }
+
+  /**
+   * Fetches the first page for a given response.
+   * @param response a response object previously received for which includes an array of data
+   * @return a new response of data
+   * @throws ResponseException if the page could not be found
+   */
+  public Response first(Response response) throws ResponseException {
+    return page("first", response);
+  }
+
+  /**
+   * Fetches the first page for a given response.
+   * @param resource one of the responses previously received from an API call
+   * @return a new array of resources of the same type
+   * @throws ResponseException if the page could not be found
+   */
+  public Resource[] first(Resource resource) throws ResponseException {
+    return page("first", resource);
+  }
+
+  /**
+   * Fetches the last page for a given response.
+   * @param response a response object previously received for which includes an array of data
+   * @return a new response of data
+   * @throws ResponseException if the page could not be found
+   */
+  public Response last(Response response) throws ResponseException {
+    return page("last", response);
+  }
+
+  /**
+   * Fetches the last page for a given response.
+   * @param resource one of the responses previously received from an API call
+   * @return a new array of resources of the same type
+   * @throws ResponseException if the page could not be found
+   */
+  public Resource[] last(Resource resource) throws ResponseException {
+    return page("last", resource);
+  }
+
+  // A generic method for making requests of any verb.
+  protected Response request(String verb, String path, Params params) throws ResponseException {
+    return unauthenticatedRequest(verb, path, params, accessToken.getBearerToken());
+  }
+
   // Builds a request
   protected Request buildRequest(String verb, String path, Params params, String bearerToken) {
     return new Request(verb, path, params, bearerToken, this);
@@ -169,4 +246,34 @@ private void write(Request request) throws IOException {
       os.close();
     }
   }
+
+  /**
+   * Fetches the response for another page.
+   * @hide as ony used internally
+   */
+  protected Response page(String pageName, Response response) throws ResponseException {
+    try {
+      String[] parts = response.getResult().get("meta").getAsJsonObject()
+              .get("links").getAsJsonObject().get(pageName).getAsString().split("=");
+
+      String pageNumber = parts[parts.length - 1];
+
+      Request request = response.getRequest();
+      Params params = (Params) request.getParams().clone();
+      params.put("page[offset]", pageNumber);
+
+      return request(request.getVerb(), request.getPath(), params);
+    } catch (NullPointerException e) {
+      return null;
+    }
+  }
+
+  /**
+   * Fetches the response for another page.
+   * @hide as ony used internally
+   */
+  protected Resource[] page(String pageName, Resource resource) throws ResponseException {
+    Response response = page(pageName, resource.getResponse());
+    return Resource.fromArray(response, resource.getDeSerializationClass());
+  }
 }

src/main/java/com/amadeus/Response.java

@@ -6,7 +6,6 @@
 import com.amadeus.exceptions.ParserException;
 import com.amadeus.exceptions.ResponseException;
 import com.amadeus.exceptions.ServerException;
-import com.google.gson.Gson;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;

src/main/java/com/amadeus/exceptions/ResponseException.java

@@ -62,7 +62,7 @@ private static StringBuffer determineLongDescription(Response response) {
       if (response.getResult().has("error_description")) {
         description.append(getErrorDescription(response));
       }
-      if (response.getResult().has("exceptions")) {
+      if (response.getResult().has("errors")) {
         description.append(getErrorsDescription(response));
       }
     }
@@ -81,7 +81,7 @@ private static StringBuffer getErrorDescription(Response response) {
 
   private static StringBuffer getErrorsDescription(Response response) {
     StringBuffer message = new StringBuffer();
-    for (JsonElement error : response.getResult().get("exceptions").getAsJsonArray()) {
+    for (JsonElement error : response.getResult().get("errors").getAsJsonArray()) {
       JsonObject json = error.getAsJsonObject();
       message.append("\n");
       if (json.has("source")) {

src/main/java/com/amadeus/resources/AirTraffic.java

@@ -1,27 +1,52 @@
 package com.amadeus.resources;
 
+import com.amadeus.travel.analytics.airTraffic.Traveled;
 import lombok.Getter;
 import lombok.ToString;
 
+/**
+ * An AirTraffic object as returned by the AirTraffic API.
+ * @see Traveled#get()
+ */
 @ToString
 public class AirTraffic extends Resource {
+  protected AirTraffic() {}
+
   private @Getter String type;
   private @Getter String subType;
   private @Getter String destination;
   private @Getter Analytics analytics;
 
+  /**
+   * An AirTraffic-related object as returned by the AirTraffic API.
+   * @see Traveled#get()
+   */
   @ToString
-  private class Analytics {
+  public class Analytics {
+    protected Analytics() {}
+
     private @Getter Flights flights;
     private @Getter Travellers travellers;
 
+    /**
+     * An AirTraffic-related object as returned by the AirTraffic API.
+     * @see Traveled#get()
+     */
     @ToString
-    private class Flights {
+    public class Flights {
+      protected Flights() {}
+
       private @Getter Double score;
     }
 
+    /**
+     * An AirTraffic-related object as returned by the AirTraffic API.
+     * @see Traveled#get()
+     */
     @ToString
-    private class Travellers {
+    public class Travellers {
+      protected Travellers() {}
+
       private @Getter Double score;
     }
   }

src/main/java/com/amadeus/resources/CheckinLink.java

@@ -3,8 +3,14 @@
 import lombok.Getter;
 import lombok.ToString;
 
+/**
+ * An CheckinLink object as returned by the CheckinLink API.
+ * @see com.amadeus.referenceData.urls.CheckinLinks#get()
+ */
 @ToString
 public class CheckinLink extends Resource {
+  protected CheckinLink() {}
+
   private @Getter String type;
   private @Getter String id;
   private @Getter String href;

src/main/java/com/amadeus/resources/FareSearch.java

@@ -4,16 +4,28 @@
 import lombok.Getter;
 import lombok.ToString;
 
+/**
+ * An FareSearch object as returned by the FareSearch API.
+ * @see com.amadeus.travel.analytics.FareSearches#get()
+ */
 @ToString
 public class FareSearch extends Resource {
+  protected FareSearch() {}
+
   private @Getter String type;
   private @Getter String period;
   private @Getter String origin;
   private @Getter String sourceCountry;
   private @Getter NumberOfSearches numberOfSearches;
 
+  /**
+   * An FareSearch-related object as returned by the FareSearch API.
+   * @see com.amadeus.travel.analytics.FareSearches#get()
+   */
   @ToString
-  private class NumberOfSearches {
+  public class NumberOfSearches {
+    protected NumberOfSearches() {}
+
     private @Getter HashMap<String, String> perDestination;
     private @Getter HashMap<String, Integer> perTripDuration;
     private @Getter HashMap<String, Integer> perDaysInAdvance;

src/main/java/com/amadeus/resources/FlightDate.java

@@ -4,17 +4,29 @@
 import lombok.Getter;
 import lombok.ToString;
 
+/**
+ * An FlightDate object as returned by the FlightDates API.
+ * @see com.amadeus.shopping.FlightDates#get()
+ */
 @ToString
 public class FlightDate extends Resource {
+  protected FlightDate() {}
+
   private @Getter String type;
   private @Getter String origin;
   private @Getter String destination;
   private @Getter Date departureDate;
   private @Getter Date returnDate;
   private @Getter Price price;
 
+  /**
+   * An FlightDate-related object as returned by the FlightDates API.
+   * @see com.amadeus.shopping.FlightDates#get()
+   */
   @ToString
-  private class Price {
+  public class Price {
+    protected Price() {}
+
     private @Getter double total;
   }
 }

src/main/java/com/amadeus/resources/FlightDestination.java

@@ -4,17 +4,29 @@
 import lombok.Getter;
 import lombok.ToString;
 
+/**
+ * An FlightDestination object as returned by the FlightDestinations API.
+ * @see com.amadeus.shopping.FlightDestinations#get()
+ */
 @ToString
 public class FlightDestination extends Resource {
+  protected FlightDestination() {}
+
   private @Getter String type;
   private @Getter String origin;
   private @Getter String destination;
   private @Getter Date departureDate;
   private @Getter Date returnDate;
   private @Getter Price price;
 
+  /**
+   * An FlightDestination-related object as returned by the FlightDestinations API.
+   * @see com.amadeus.shopping.FlightDestinations#get()
+   */
   @ToString
-  private class Price {
+  public class Price {
+    protected Price() {}
+
     private @Getter double total;
   }
 }