Add DELETE support for Flight Order Management (#63)

* manipulate client to accept delete and add support for cancel flight order

* add tests for httpclient and delete method

* fix indentation errors

* fix docs

Author: tsolakoua

README.md

@@ -239,7 +239,10 @@ FlightOfferSearch[] flightOffersSearches = amadeus.shopping.flightOffersSearch.p
 
 // Flight Order Management
 // The flightOrderID comes from the Flight Create Orders (in test environment it's temporary)
+// Retrieve a flight order
 FlightOrder order = amadeus.booking.flightOrder("eJzTd9f3NjIJdzUGAAp%2fAiY=").get();
+// Cancel a flight order
+FlightOrder order = amadeus.booking.flightOrder("eJzTd9f3NjIJdzUGAAp%2fAiY=").delete();
 
 // Flight Offers price
 FlightPrice[] flightPricing = amadeus.shopping.flightOffersSearch.pricing.post(

src/main/java/com/amadeus/Constants.java

@@ -12,6 +12,7 @@ public final class Constants {
   public static final String GET = "GET";
   public static final String POST = "POST";
   public static final String PUT = "PUT";
+  public static final String DELETE = "DELETE";
 
 
   public static final String HTTPS = "https";

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

@@ -67,6 +67,43 @@ public Response get(String path, Params params) throws ResponseException {
     return request(Constants.GET, path, params, null);
   }
 
+  /**
+   * <p>
+   *   A helper module for making generic DELETE requests calls. It is used by
+   *   every namespaced API DELETE method.
+   * </p>
+   *
+   * <pre>
+   *   amadeus.booking.flightOrder("eJzTd9f3NjIJdzUGAAp%2fAiY=").delete();
+   * </pre>
+   *
+   * <p>
+   *   It can be used to make any generic API call that is automatically
+   *   authenticated using your API credentials:
+   * </p>
+   *
+   * <pre>
+   *    amadeus.delete("/v1/foo/bar", Params.with("airline", "1X"));
+   * </pre>
+   *
+   * @param path The full path for the API call
+   * @param params The optional DELETE params to pass to the API
+   * @return a Response object containing the status code, body, and parsed data.
+   */
+  public Response delete(String path, Params params) throws ResponseException {
+    return request(Constants.DELETE, path, params, null);
+  }
+
+  /**
+   * A helper module for making generic DELETE requests calls. It is used by
+   * every namespaced API DELETE method.
+   *
+   * @see Amadeus#delete(String, Params)
+   */
+  public Response delete(String path) throws ResponseException {
+    return request(Constants.DELETE, path, null,null);
+  }
+
   /**
    * A helper module for making generic POST requests calls. It is used by
    * every namespaced API POST method.

src/main/java/com/amadeus/booking/FlightOrder.java

@@ -55,12 +55,43 @@ public com.amadeus.resources.FlightOrder get(Params params) throws ResponseExcep
     return (com.amadeus.resources.FlightOrder) Resource.fromObject(
         response, com.amadeus.resources.FlightOrder.class);
   }
-  
+
   /**
    * Convenience method for calling <code>get</code> without any parameters.
    * @see com.amadeus.booking.FlightOrder#get()
    */
   public com.amadeus.resources.FlightOrder get() throws ResponseException {
     return get(null);
   }
+
+  /**
+   * <p>
+   *   Allows you to cancel a flight order. The flightOfferId
+   *   used is an example for educational purposes. In test enviromnent 
+   *   it's temporary.
+   * </p>
+   *
+   * <pre>
+   * FlightOrder order = amadeus.booking.flightOrder.(
+   * "eJzTd9f3NjIJdzUGAAp%2fAiY=").delete();
+   * </pre>
+   * @param params the parameters to send to the API
+   * @return an API response object
+   * @throws ResponseException when an exception occurs
+   */
+
+  public com.amadeus.resources.FlightOrder delete(Params params) throws ResponseException {
+    String path = String.format("/v1/booking/flight-orders/%s", flightOfferId);
+    Response response = client.delete(path, params);
+    return (com.amadeus.resources.FlightOrder) Resource.fromObject(
+        response, com.amadeus.resources.FlightOrder.class);
+  }
+  
+  /**
+   * Convenience method for calling <code>delete</code> without any parameters.
+   * @see com.amadeus.booking.FlightOrder#delete()
+   */
+  public com.amadeus.resources.FlightOrder delete() throws ResponseException {
+    return delete(null);
+  }
 }

src/test/java/com/amadeus/HTTPClientTest.java

@@ -64,6 +64,18 @@ public class HTTPClientTest {
     verify(client, times(1)).request("GET", "/foo", params, null);
   }
 
+  @Test public void testDeleteWithoutParams() throws ResponseException {
+    when(client.delete(anyString())).thenCallRealMethod();
+    client.delete("/foo");
+    verify(client, times(1)).request("DELETE", "/foo", null, null);
+  }
+
+  @Test public void testDeletetWithParams() throws ResponseException {
+    when(client.delete(anyString(), any(Params.class))).thenCallRealMethod();
+    client.delete("/foo", params);
+    verify(client, times(1)).request("DELETE", "/foo", params, null);
+  }
+
   @Test public void testPostWithoutParamsWithoutBody() throws ResponseException {
     when(client.post(anyString())).thenCallRealMethod();
     client.post("/foo");
@@ -111,6 +123,26 @@ public class HTTPClientTest {
     assertEquals(((JsonArray) response.getData()).size(), 1);
   }
 
+  @Test public void testUnauthenticatedDeleteRequest() throws ResponseException, IOException {
+    when(request.getVerb()).thenReturn("DELETE");
+    when(request.getParams()).thenReturn(params);
+    when(request.getConnection()).thenReturn(connection);
+
+    when(connection.getResponseCode()).thenReturn(200);
+    when(connection.getHeaderField("Content-Type")).thenReturn(
+            "application/json");
+    when(connection.getInputStream()).thenReturn(
+            new ByteArrayInputStream("{ \"data\": [{}]}".getBytes()));
+
+    when(client.buildRequest("DELETE", "/foo", params, null,null)).thenReturn(request);
+    when(client.unauthenticatedRequest("DELETE", "/foo", params, null,null)).thenCallRealMethod();
+
+    Response response = client.unauthenticatedRequest("DELETE", "/foo", params, null, null);
+
+    assertTrue(response.isParsed());
+    assertEquals(((JsonArray) response.getData()).size(), 1);
+  }
+
   @Test public void testUnauthenticatedPostRequest() throws ResponseException, IOException {
     when(request.getVerb()).thenReturn("POST");
     when(request.getParams()).thenReturn(params);

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

@@ -377,4 +377,17 @@ public void testPostMethods() throws ResponseException {
     TestCase.assertNotNull(seatmap.post());
     TestCase.assertNotNull(seatmap.post(body));
   }
-}
+
+  @Test
+  public void testDeleteMethods() throws ResponseException {
+    // Test deleting a specific offer
+    Mockito.when(client.delete("/v1/booking/flight-orders/XXX", null))
+        .thenReturn(singleResponse);
+    Mockito.when(client.delete("/v1/booking/flight-orders/XXX", params))
+        .thenReturn(singleResponse);
+    FlightOrder flightOrder = new FlightOrder(client, "XXX");
+    TestCase.assertNotNull(flightOrder.delete());
+    TestCase.assertNotNull(flightOrder.delete(params));
+
+  }
+}