Adds support for Flight Offers Search (#57)

* add support docs and tests for flight offers search

* update readme

* remove init

* add test for post

Author: tsolakoua

README.rst

@@ -291,6 +291,11 @@ List of supported endpoints
     # Get the result of the process by jobId
     amadeus.travel.trip_parser_jobs.result(response.data['id']).get()
 
+    # Flight Offers Search GET
+    amadeus.shopping.flight_offers_search.get(originLocationCode='SYD', destinationLocationCode='BKK', departureDate='2020-05-01', adults=1)
+    # Flight Offers Search POST
+    amadeus.shopping.flight_offers_search.post(body)
+
 Development & Contributing
 --------------------------
 

amadeus/namespaces/_shopping.py

@@ -2,6 +2,7 @@
 from amadeus.shopping._flight_dates import FlightDates
 from amadeus.shopping._flight_destinations import FlightDestinations
 from amadeus.shopping._flight_offers import FlightOffers
+from amadeus.shopping._flight_offers_search import FlightOffersSearch
 from amadeus.shopping._hotel_offers import HotelOffers
 from amadeus.shopping._hotel_offers_by_hotel import HotelOffersByHotel
 from amadeus.shopping._hotel_offer import HotelOffer
@@ -15,9 +16,11 @@ def __init__(self, client):
         self.flight_offers = FlightOffers(client)
         self.hotel_offers = HotelOffers(client)
         self.hotel_offers_by_hotel = HotelOffersByHotel(client)
+        self.flight_offers_search = FlightOffersSearch(client)
 
     def hotel_offer(self, offer_id):
         return HotelOffer(self.client, offer_id)
 
 
-__all__ = ['FlightDates', 'FlightDestinations', 'FlightOffers']
+__all__ = ['FlightDates', 'FlightDestinations', 'FlightOffers',
+           'FlightOffersSearch']

amadeus/shopping/__init__.py

@@ -1,9 +1,11 @@
 from ._flight_offers import FlightOffers
 from ._flight_dates import FlightDates
 from ._flight_destinations import FlightDestinations
+from ._flight_offers_search import FlightOffersSearch
 from ._hotel_offers import HotelOffers
 from ._hotel_offers_by_hotel import HotelOffersByHotel
 from ._hotel_offer import HotelOffer
 
-__all__ = ['FlightOffers', 'FlightDates', 'FlightDestinations',
+__all__ = ['FlightOffers', 'FlightDates',
+           'FlightDestinations', 'FlightOffersSearch',
            'HotelOffers', 'HotelOffersByHotel', 'HotelOffer']

amadeus/shopping/_flight_offers_search.py

@@ -0,0 +1,47 @@
+from amadeus.client.decorator import Decorator
+
+
+class FlightOffersSearch(Decorator, object):
+    def get(self, **params):
+        '''
+        Get the cheapest flights on a given journey
+
+        .. code-block:: python
+
+            amadeus.shopping.flight_offers_search.get(
+                origin='MAD',
+                destination='NYC',
+                departureDate='2019-08-01',
+                adults='1'
+            )
+
+        :param origin: the City/Airport IATA code from which the flight will
+            depart. ``"MAD"``, for example for Madrid.
+
+        :param destination: the City/Airport IATA code to which the flight is
+            going. ``"BOS"``, for example for Boston.
+
+        :param departureDate: the date on which to fly out, in `YYYY-MM-DD`
+            format
+
+        :param adults: the number of adult passengers with age 12 or older
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get('/v2/shopping/flight-offers', **params)
+
+    def post(self, body):
+        '''
+        Get the cheapest flights on a given journey.
+
+        .. code-block:: python
+
+            amadeus.shopping.flight_offers_search.post(body)
+
+        :param body: the parameters to send to the API
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.post('/v2/shopping/flight-offers', body)

docs/index.rst

@@ -47,6 +47,12 @@ Shopping/Flights
 .. autoclass:: amadeus.shopping.FlightOffers
   :members: get
 
+.. autoclass:: amadeus.shopping.FlightOffersSearch
+  :members: get
+
+.. autoclass:: amadeus.shopping.FlightOffersSearch
+  :members: post
+
 Shopping/Hotels
 ===============
 

specs/namespaces/namespaces_spec.py

@@ -43,6 +43,7 @@
         expect(client.shopping.flight_dates).not_to(be_none)
         expect(client.shopping.flight_destinations).not_to(be_none)
         expect(client.shopping.flight_offers).not_to(be_none)
+        expect(client.shopping.flight_offers_search).not_to(be_none)
 
         expect(client.shopping.hotel_offers).not_to(be_none)
         expect(client.shopping.hotel_offer).not_to(be_none)
@@ -95,6 +96,7 @@
         expect(client.shopping.flight_dates.get).not_to(be_none)
         expect(client.shopping.flight_destinations.get).not_to(be_none)
         expect(client.shopping.flight_offers.get).not_to(be_none)
+        expect(client.shopping.flight_offers_search.get).not_to(be_none)
 
         expect(client.shopping.hotel_offers.get).not_to(be_none)
         expect(client.shopping.hotel_offers_by_hotel.get).not_to(be_none)
@@ -224,6 +226,12 @@
                 '/v1/shopping/flight-offers', a='b'
             ))
 
+        with it('.shopping.flight_offers_search.get'):
+            self.client.shopping.flight_offers_search.get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v2/shopping/flight-offers', a='b'
+            ))
+
         with it('.shopping.hotel_offers.get'):
             self.client.shopping.hotel_offers.get(cityCode='MAD')
             expect(self.client.get).to(have_been_called_with(
@@ -283,3 +291,9 @@
             expect(self.client.post).to(have_been_called_with(
                 '/v2/travel/trip-parser-jobs', {'foo': 'bar'}
             ))
+
+        with it('.shopping.flight_offers_search.post'):
+            self.client.shopping.flight_offers_search.post({'foo': 'bar'})
+            expect(self.client.post).to(have_been_called_with(
+                '/v2/shopping/flight-offers', {'foo': 'bar'}
+            ))