Merge pull request #90 from amadeus4dev/on-demand

Add on demand flight status support

Author: tsolakoua

README.md

@@ -356,6 +356,12 @@ Prediction tripPurpose = amadeus.travel.predictions.tripPurpose.get(Params
 Location destinations = amadeus.referenceData.recommendedLocations.get(Params
     .with("cityCodes", "PAR")
     .and("travelerCountryCode", "FR"));
+
+// On Demand Flight Status
+DatedFlight[] flightStatus = amadeus.schedule.flights.get(Params
+    .with("carrierCode", "AZ")
+    .and("flightNumber", "319")
+    .and("scheduledDepartureDate", "2021-03-13"));
 ```
 
 ## Development & Contributing

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

@@ -83,6 +83,13 @@ public class Amadeus extends HTTPClient {
    */
   public Safety safety;
 
+  /**
+   * <p>
+   * A namespaced client for the <code>/v2/schedule</code> endpoints.
+   * </p>
+   */
+  public Schedule schedule;
+
   protected Amadeus(Configuration configuration) {
     super(configuration);
     this.referenceData = new ReferenceData(this);
@@ -93,6 +100,7 @@ protected Amadeus(Configuration configuration) {
     this.booking = new Booking(this);
     this.media = new Media(this);
     this.safety = new Safety(this);
+    this.schedule = new Schedule(this);
 
   }
 

src/main/java/com/amadeus/Schedule.java

@@ -0,0 +1,37 @@
+package com.amadeus;
+
+import com.amadeus.schedule.Flights;
+
+/**
+ * <p>
+ *   A namespaced client for the
+ *   <code>/v2/schedule</code> endpoints.
+ * </p>
+ *
+ * <p>
+ *   Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.schedule;</pre>
+ *
+ * @hide
+ */
+public class Schedule {
+  /**
+   * <p>
+   *   A namespaced client for the
+   *   <code>/v2/schedule/flights</code> endpoints.
+   * </p>
+   */
+  public Flights flights;
+
+  /**
+   * Constructor.
+   * @hide
+   */
+  public Schedule(Amadeus client) {
+    this.flights = new Flights(client);
+  }
+}

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

@@ -0,0 +1,134 @@
+package com.amadeus.resources;
+
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * An DatedFlight object as returned by the On Flight Status Demand API.
+ * @see com.amadeus.schedule.Flights#get()
+ */
+@ToString
+public class DatedFlight extends Resource {
+  protected DatedFlight() {}
+
+  private @Getter String type;
+  private @Getter String scheduledDepartureDate;
+  private @Getter FlightDesignator flightDesignator;
+  private @Getter FlightPoint[] flightPoints;
+  private @Getter Segment[] segments;
+  private @Getter Leg[] legs;
+
+  @ToString
+  public class FlightDesignator {
+    protected FlightDesignator() {
+    }
+
+    private @Getter String carrierCode;
+    private @Getter int flightNumber;
+    private @Getter String operationalSuffix;
+
+  }
+
+  @ToString
+  public class FlightPoint {
+    protected FlightPoint() {
+    }
+
+    private @Getter String iataCode;
+    private @Getter Departure departure;
+    private @Getter Arrival arrival;
+  }
+
+  @ToString
+  public class Departure {
+    protected Departure() {
+    }
+
+    private @Getter Timing[] timings;
+    private @Getter Terminal[] terminal;
+    private @Getter Gate[] gate;
+  }
+
+  @ToString
+  public class Arrival {
+    protected Arrival() {
+    }
+
+    private @Getter Timing[] timings;
+    private @Getter Terminal[] terminal;
+    private @Getter Gate[] gate;
+  }
+
+  @ToString
+  public class Timing {
+    protected Timing() {
+    }
+
+    private @Getter String qualifier;
+    private @Getter String value;
+    private @Getter Delay delays;
+  }
+
+  @ToString
+  public class Delay {
+    protected Delay() {
+    }
+
+    private @Getter String duration;
+  }
+
+  @ToString
+  public class Gate {
+    protected Gate() {
+    }
+
+    private @Getter String mainGate;
+  }
+
+  @ToString
+  public class Terminal {
+    protected Terminal() {
+    }
+
+    private @Getter String code;
+  }
+
+  @ToString
+  public class Segment {
+    protected Segment() {
+    }
+
+    private @Getter String boardPointIataCode;
+    private @Getter String offPointIataCode;
+    private @Getter String scheduledSegmentDuration;
+    private @Getter Partnership partnership;
+  }
+
+  @ToString
+  public class Partnership {
+    protected Partnership() {
+    }
+
+    private @Getter FlightDesignator operatingFlight;
+  }
+
+  @ToString
+  public class Leg {
+    protected Leg() {
+    }
+
+    private @Getter String boardPointIataCode;
+    private @Getter String offPointIataCode;
+    private @Getter AircraftEquipment aircraftEquipment;
+    private @Getter String scheduledLegDuration;
+  }
+
+  @ToString
+  public class AircraftEquipment {
+    protected AircraftEquipment() {
+    }
+
+    private @Getter String aircraftType;
+  }
+
+}

src/main/java/com/amadeus/schedule/Flights.java

@@ -0,0 +1,62 @@
+package com.amadeus.schedule;
+
+import com.amadeus.Amadeus;
+import com.amadeus.Params;
+import com.amadeus.Response;
+import com.amadeus.exceptions.ResponseException;
+import com.amadeus.resources.DatedFlight;
+import com.amadeus.resources.Resource;
+
+/**
+ * <p>
+ *   A namespaced client for the
+ *   <code>/v2/schedule/flights</code> endpoints.
+ * </p>
+ *
+ * <p>
+ *   Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.schedule.flights;</pre>
+ */
+public class Flights {
+  private Amadeus client;
+
+  /**
+   * Constructor.
+   * @hide
+   */
+  public Flights(Amadeus client) {
+    this.client = client;
+  }
+
+  /**
+   * <p>
+   *   Retrieves status of a given flight.
+   * </p>
+   *
+   * <pre>
+   * amadeus.schedule.flights.get(Params
+   *     .with("carrierCode", "AZ")
+   *     .and("flightNumber", "319")
+   *     .and("scheduledDepartureDate", "2021-03-13"));</pre>
+   *
+   * @param params the parameters to send to the API
+   * @return an API response object
+   * @throws ResponseException when an exception occurs
+   */
+  public DatedFlight[] get(Params params) throws ResponseException {
+    Response response = client.get("/v2/schedule/flights", params);
+    return (DatedFlight[]) Resource.fromArray(response, DatedFlight[].class);
+  }
+
+  /**
+   * Convenience method for calling <code>get</code> without any parameters.
+   * @see DatedFlight#get()
+   */
+  public DatedFlight[] get() throws ResponseException {
+    return get(null);
+  }
+}

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

@@ -15,6 +15,7 @@
 import com.amadeus.referenceData.locations.PointsOfInterest;
 import com.amadeus.referenceData.urls.CheckinLinks;
 import com.amadeus.safety.SafetyRatedLocations;
+import com.amadeus.schedule.Flights;
 import com.amadeus.shopping.FlightDates;
 import com.amadeus.shopping.FlightDestinations;
 import com.amadeus.shopping.FlightOffers;
@@ -79,6 +80,7 @@ public void testAllNamespacesExist() {
     TestCase.assertNotNull(client.safety.safetyRatedLocations);
     TestCase.assertNotNull(client.safety.safetyRatedLocations.bySquare);
     TestCase.assertNotNull(client.safety.safetyRatedLocation("XXX"));
+    TestCase.assertNotNull(client.schedule.flights);
   }
 
   @Before
@@ -369,6 +371,16 @@ public void testGetMethods() throws ResponseException {
     GeneratedPhotos photo = new GeneratedPhotos(client);
     TestCase.assertNotNull(photo.get());
     TestCase.assertNotNull(photo.get(params));
+
+    // Testing on demand flight status
+    Mockito.when(client.get("/v2/schedule/flights", null))
+        .thenReturn(multiResponse);
+    Mockito.when(client.get("/v2/schedule/flights", params))
+        .thenReturn(multiResponse);
+    Flights flightStatus = new Flights(client);
+    TestCase.assertNotNull(flightStatus.get());
+    TestCase.assertNotNull(flightStatus.get(params));
+    TestCase.assertEquals(flightStatus.get().length, 2);
   }
 
   @Test