Merge pull request #102 from amadeus4dev/flight-status-on-demand

Add support for On-Demand Flight Status

Author: tsolakoua

README.rst

@@ -313,6 +313,9 @@ List of supported endpoints
     # Travel Recommendations
     amadeus.reference_data.recommended_locations.get(cityCodes='PAR', travelerCountryCode='FR')
 
+    # Retrieve status of a given flight
+    amadeus.schedule.flights.get(carrierCode='AZ', flightNumber='319', scheduledDepartureDate='2021-03-13')
+
 Development & Contributing
 --------------------------
 

amadeus/namespaces/_schedule.py

@@ -0,0 +1,8 @@
+from amadeus.client.decorator import Decorator
+from amadeus.schedule._flights import Flights
+
+
+class Schedule(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+        self.flights = Flights(client)

amadeus/namespaces/core.py

@@ -6,6 +6,7 @@
 from amadeus.namespaces._media import Media
 from amadeus.namespaces._booking import Booking
 from amadeus.namespaces._safety import Safety
+from amadeus.namespaces._schedule import Schedule
 
 
 class Core(object):
@@ -18,3 +19,4 @@ def __init__(self):
         self.media = Media(self)
         self.booking = Booking(self)
         self.safety = Safety(self)
+        self.schedule = Schedule(self)

amadeus/schedule/__init__.py

@@ -0,0 +1,3 @@
+from ._flights import Flights
+
+__all__ = ['Flights']

amadeus/schedule/_flights.py

@@ -0,0 +1,27 @@
+from amadeus.client.decorator import Decorator
+
+
+class Flights(Decorator, object):
+
+    def get(self, **params):
+        '''
+        Retrieves a unique flight status by search criteria
+
+        .. code-block:: python
+
+            amadeus.schedule.flights.get(
+                            carrierCode='AZ',
+                            flightNumber='319',
+                            scheduledDepartureDate='2021-03-13')
+
+        :param carrierCode: the IATA carrier code
+
+        :param flightNumber: flight number as assigned by the carrier
+
+        :param scheduledDepartureDate: scheduled departure date of the flight,
+            local to the departure airport, format YYYY-MM-DD
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get('/v2/schedule/flights', **params)

docs/index.rst

@@ -179,4 +179,10 @@ Safety/SafetyRatedLocations
   :members: get
 
 .. autoclass:: amadeus.safety.safety_rated_locations.SafetyRatedLocation
+  :members: get
+
+Schedule/Flights
+================
+
+.. autoclass:: amadeus.schedule.flights
   :members: get

specs/namespaces/namespaces_spec.py

@@ -72,6 +72,9 @@
         expect(client.safety.safety_rated_locations.by_square).not_to(be_none)
         expect(client.safety.safety_rated_location).not_to(be_none)
 
+        expect(client.schedule).not_to(be_none)
+        expect(client.schedule.flights).not_to(be_none)
+
     with it('should define all expected .get methods'):
         client = self.client
         expect(client.reference_data.urls.checkin_links.get).not_to(be_none)
@@ -123,6 +126,8 @@
         expect(client.safety.safety_rated_location('Q930402719').get).not_to(
             be_none)
 
+        expect(client.schedule.flights.get).not_to(be_none)
+
     with it('should define all expected .delete methods'):
         client = self.client
         expect(client.booking.flight_order('123').delete).not_to(be_none)
@@ -427,3 +432,9 @@
             expect(self.client.get).to(have_been_called_with(
                 '/v1/safety/safety-rated-locations/XXX', a='b'
             ))
+
+        with it('.schedule.flights().get'):
+            self.client.schedule.flights.get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v2/schedule/flights', a='b'
+            ))