Add support for Flight Offers Search POST (#35)

#35 Add support for Flight Offers Search POST

Author: anthonyroux

README.md

@@ -225,15 +225,18 @@ FlightOffer[] flightOffers = amadeus.shopping.flightOffers.get(Params
   .and("destination", "MAD")
   .and("departureDate", "2019-08-01"));
 
-// Flight Offer Search v2
+// Flight Offer Search v2 GET
 FlightOfferSearch[] flightOffersSearches = amadeus.shopping.flightOffersSearch.get(
               Params.with("originLocationCode", "SYD")
                       .and("destinationLocationCode", "BKK")
                       .and("departureDate", "2020-01-01")
                       .and("returnDate", "2020-01-05")
                       .and("adults", 2)
-                      .and("max", 3)
-      );
+                      .and("max", 3));
+
+// Flight Offer Search v2 POST
+// body can be a String version of your JSON or a JsonObject
+FlightOfferSearch[] flightOffersSearches = amadeus.shopping.flightOffersSearch.post(body);
 
 // Flight Choice Prediction
 // Note that the example calls 2 APIs: Flight Low-fare Search & Flight Choice Prediction

gradle.properties

@@ -1,5 +1,5 @@
 GROUP=com.amadeus
-VERSION_NAME=3.2.0
+VERSION_NAME=3.3.0
 
 POM_URL=https://github.com/amadeus4dev/amadeus-java
 POM_SCM_URL[email protected]:amadeus4dev/amadeus-java.git

src/main/java/com/amadeus/Amadeus.java

@@ -25,7 +25,7 @@ public class Amadeus extends HTTPClient {
   /**
    * The API version.
    */
-  public static final String VERSION = "3.2.0";
+  public static final String VERSION = "3.3.0";
 
   /**
    * <p>

src/main/java/com/amadeus/Request.java

@@ -139,6 +139,8 @@ private void prepareHeaders() {
 
     if (bearerToken != null) {
       headers.put(Constants.AUTHORIZATION, bearerToken);
+      headers.put(Constants.CONTENT_TYPE, "application/vnd.amadeus+json");
+
     }
   }
 

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

@@ -5,7 +5,10 @@
 import lombok.Getter;
 import lombok.ToString;
 
-
+/**
+ * An Airline object as returned by the Airline Code LookUp API.
+ * @see com.amadeus.shopping.flightOffersSearch#get()
+ */
 @ToString
 public class FlightOfferSearch extends Resource {
   protected FlightOfferSearch() {}

src/main/java/com/amadeus/shopping/FlightOffersSearch.java

@@ -6,16 +6,111 @@
 import com.amadeus.exceptions.ResponseException;
 import com.amadeus.resources.FlightOfferSearch;
 import com.amadeus.resources.Resource;
+import com.google.gson.JsonObject;
 
+/**
+ * <p>
+ * A namespaced client for the
+ * <code>/v2/shopping/flight-offers</code> endpoints.
+ * </p>
+ *
+ * <p>
+ * Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder(API_KEY, API_SECRET).build();
+ * amadeus.shopping.flightOffersSearch;</pre>
+ */
 public class FlightOffersSearch {
   private Amadeus client;
 
+  /**
+   * Constructor.
+   *
+   * @hide
+   */
   public FlightOffersSearch(Amadeus client) {
     this.client = client;
   }
 
+  /**
+   * <p>
+   * The Flight Offers Search API allows to get cheapest flight recommendations on a given journey.
+   * It provides a list of flight recommendations and fares from a given origin,
+   * for a given date and for a given list of passengers.
+   * Additional information such as bag allowance,
+   * first ancillary bag prices or fare details are also provided.
+   * </p>
+   *
+   * <pre>
+   * amadeus.shopping.flightOffersSearch.get(params);</pre>
+   *
+   * @param params the parameters to send to the API
+   * @return an API resource
+   * @throws ResponseException when an exception occurs
+   */
   public FlightOfferSearch[] get(Params params) throws ResponseException {
     Response response = client.get("/v2/shopping/flight-offers", params);
     return (FlightOfferSearch[]) Resource.fromArray(response, FlightOfferSearch[].class);
   }
+
+  /**
+   * Convenience method for calling <code>get</code> without any parameters.
+   * @see FlightOffersSearch#get()
+   */
+  public FlightOfferSearch[] get() throws ResponseException {
+    return get(null);
+  }
+
+  /**
+   * <p>
+   * The Flight Offers Search API allows to get cheapest flight recommendations on a given journey.
+   * It provides a list of flight recommendations and fares from a given origin,
+   * for a given date and for a given list of passengers.
+   * Additional information such as bag allowance,
+   * first ancillary bag prices or fare details are also provided.
+   * </p>
+   *
+   * <pre>
+   * amadeus.shopping.flightOffersSearch.post(body);</pre>
+   *
+   * @param body the parameters to send to the API as a JSonObject
+   * @return an API resource
+   * @throws ResponseException when an exception occurs
+   */
+  public FlightOfferSearch[] post(JsonObject body) throws ResponseException {
+    Response response = client.post("/v2/shopping/flight-offers", body);
+    return (FlightOfferSearch[]) Resource.fromArray(response, FlightOfferSearch[].class);
+  }
+
+  /**
+   * <p>
+   * The Flight Offers Search API allows to get cheapest flight recommendations on a given journey.
+   * It provides a list of flight recommendations and fares from a given origin,
+   * for a given date and for a given list of passengers.
+   * Additional information such as bag allowance,
+   * first ancillary bag prices or fare details are also provided.
+   * </p>
+   *
+   * <pre>
+   * amadeus.shopping.flightOffers.prediction.post(body);</pre>
+   *
+   * @param body the parameters to send to the API as a String
+   * @return an API resource
+   * @throws ResponseException when an exception occurs
+   */
+  public FlightOfferSearch[] post(String body) throws ResponseException {
+    Response response = client.post("/v2/shopping/flight-offers", body);
+    return (FlightOfferSearch[]) Resource.fromArray(response, FlightOfferSearch[].class);
+  }
+
+  /**
+   * Convenience method for calling <code>post</code> without any parameters.
+   *
+   * @see FlightOffersSearch#post()
+   */
+  public FlightOfferSearch[] post() throws ResponseException {
+    return post((String) null);
+  }
 }

src/test/java/com/amadeus/AmadeusTest.java

@@ -52,7 +52,7 @@ public void testBuilderWithInvalidEnvironment() {
   }*/
 
   @Test public void testVersion() {
-    assertEquals("should have a version number", Amadeus.VERSION, "3.2.0");
+    assertEquals("should have a version number", Amadeus.VERSION, "3.3.0");
   }
 
 }

src/test/java/com/amadeus/NamespaceTest.java

@@ -35,6 +35,7 @@ public class NamespaceTest {
   private Response singleResponse;
   private Response multiResponse;
   private String body;
+  private JsonObject jsonObject;
 
   @Test
   public void testAllNamespacesExist() {
@@ -75,7 +76,7 @@ public void setup() {
     Mockito.when(multiResponse.getData()).thenReturn(jsonArray);
 
     // Prepare a single response
-    JsonObject jsonObject = new JsonObject();
+    jsonObject = new JsonObject();
     jsonObject.addProperty("foo", "bar");
     singleResponse = Mockito.mock(Response.class);
     Mockito.when(singleResponse.isParsed()).thenReturn(true);
@@ -261,7 +262,7 @@ public void testGetMethods() throws ResponseException {
     TestCase.assertNotNull(hotelOffer.get());
     TestCase.assertNotNull(hotelOffer.get(params));
 
-    // Test flight offer search v2
+    // Test flight offers search get
     Mockito.when(client.get("/v2/shopping/flight-offers", null))
         .thenReturn(multiResponse);
     Mockito.when(client.get("/v2/shopping/flight-offers", params))
@@ -276,7 +277,6 @@ public void testGetMethods() throws ResponseException {
             .thenReturn(multiResponse);
     HotelSentiments hotelSentiments = new HotelSentiments(client);
     TestCase.assertNotNull(hotelSentiments.get(params));
-
   }
 
   @Test
@@ -290,5 +290,17 @@ public void testPostMethods() throws ResponseException {
     TestCase.assertNotNull(flightOffersPrediction.post());
     TestCase.assertNotNull(flightOffersPrediction.post(body));
     TestCase.assertEquals(flightOffersPrediction.post().length, 2);
+
+    // Test flight offers search post
+    Mockito.when(client.post("/v2/shopping/flight-offers", (String) null))
+            .thenReturn(multiResponse);
+    Mockito.when(client.post("/v2/shopping/flight-offers", body))
+            .thenReturn(multiResponse);
+    Mockito.when(client.post("/v2/shopping/flight-offers", jsonObject))
+            .thenReturn(multiResponse);
+    FlightOffersSearch flightOfferSearch = new FlightOffersSearch(client);
+    TestCase.assertNotNull(flightOfferSearch.post());
+    TestCase.assertNotNull(flightOfferSearch.post(body));
+    TestCase.assertEquals(flightOfferSearch.post().length, 2);
   }
 }

src/test/java/com/amadeus/RequestTest.java

@@ -5,6 +5,7 @@
 import static org.junit.Assert.assertTrue;
 
 import java.io.IOException;
+
 import org.junit.Test;
 
 public class RequestTest {
@@ -25,11 +26,13 @@ public class RequestTest {
     assertEquals(request.getPort(), 443);
     assertEquals(request.isSsl(), true);
     assertEquals(request.getScheme(), "https");
-    assertEquals(request.getHeaders().size(), 3);
+    assertEquals(request.getHeaders().size(), 4);
+    assertEquals(request.getHeaders()
+            .get(Constants.ACCEPT), "application/json, application/vnd.amadeus+json");
     assertEquals(request.getHeaders()
-            .get("Accept"), "application/json, application/vnd.amadeus+json");
-    assertEquals(request.getHeaders().get("Authorization"), "token");
-    assertTrue(request.getHeaders().get("User-Agent").matches("amadeus-java/.* java/.*"));
+            .get(Constants.CONTENT_TYPE), "application/vnd.amadeus+json");
+    assertEquals(request.getHeaders().get(Constants.AUTHORIZATION), "token");
+    assertTrue(request.getHeaders().get(Constants.USER_AGENT).matches("amadeus-java/.* java/.*"));
   }
 
   @Test public void testInitializerWithoutBearerToken() {