Support for Flight Create Orders & Order Management (#62)

* initial impl and add booking to namespaces

* update post body

* write test for post method

* add the new endpoint to readme

* update post and tests

* add support and tests for flight order management

* update readme and tests

* add FlightOrder to booking public objects

Author: tsolakoua

README.rst

@@ -301,6 +301,13 @@ List of supported endpoints
     amadeus.shopping.flight_offers.pricing.post(flights[0])
     amadeus.shopping.flight_offers.pricing.post(flights[0:2], include='credit-card-fees,other-services')
 
+    # Flight Create Orders
+    amadeus.booking.flight_orders.post(flights[0], traveler)
+
+    # Flight Order Management
+    # The flight ID comes from the Flight Create Orders (in test environment it's temporary)
+    flight_booking = amadeus.booking.flight_orders.post(body).data
+    amadeus.booking.flight_order(flight_booking['id']).get()
 
 Development & Contributing
 --------------------------

amadeus/booking/__init__.py

@@ -0,0 +1,4 @@
+from ._flight_orders import FlightOrders
+from ._flight_order import FlightOrder
+
+__all__ = ['FlightOrders', 'FlightOrder']

amadeus/booking/_flight_order.py

@@ -0,0 +1,21 @@
+from amadeus.client.decorator import Decorator
+
+
+class FlightOrder(Decorator, object):
+    def __init__(self, client, flight_order_id):
+        Decorator.__init__(self, client)
+        self.flight_order_id = flight_order_id
+
+    def get(self, **params):
+        '''
+        Retrieves a flight order based on its ID.
+
+        .. code-block:: python
+
+            amadeus.booking.flight_order('eJzTd9f3NjIJdzUGAAp%2fAiY=').get()
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get('/v1/booking/flight-orders/{0}'
+                               .format(self.flight_order_id), **params)

amadeus/booking/_flight_orders.py

@@ -0,0 +1,28 @@
+from amadeus.client.decorator import Decorator
+
+
+class FlightOrders(Decorator, object):
+    def post(self, flight, travelers):
+        '''
+        Books a flight
+
+        .. code-block:: python
+
+            amadeus.booking.flight_orders.post(flight, travelers)
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        flight_offers = []
+        if type(flight) is not list:
+            flight_offers.append(flight)
+        else:
+            flight_offers.extend(flight)
+        travelers_info = []
+        if type(travelers) is not list:
+            travelers_info.append(travelers)
+        else:
+            travelers_info.extend(travelers)
+        body = {'data': {'type': 'flight-order', 'flightOffers': flight_offers,
+                         'travelers': travelers_info}}
+        return self.client.post('/v1/booking/flight-orders', body)

amadeus/namespaces/_booking.py

@@ -0,0 +1,15 @@
+from amadeus.booking._flight_orders import FlightOrders
+from amadeus.booking._flight_order import FlightOrder
+from amadeus.client.decorator import Decorator
+
+
+class Booking(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+        self.flight_orders = FlightOrders(client)
+
+    def flight_order(self, flight_order_id):
+        return FlightOrder(self.client, flight_order_id)
+
+
+__all__ = ['FlightOrders', 'FlightOrder']

amadeus/namespaces/core.py

@@ -4,6 +4,7 @@
 from amadeus.namespaces._e_reputation import EReputation
 from amadeus.namespaces._airport import Airport
 from amadeus.namespaces._media import Media
+from amadeus.namespaces._booking import Booking
 
 
 class Core(object):
@@ -14,3 +15,4 @@ def __init__(self):
         self.e_reputation = EReputation(self)
         self.airport = Airport(self)
         self.media = Media(self)
+        self.booking = Booking(self)

docs/index.rst

@@ -138,3 +138,12 @@ Media/Files
 
 .. autoclass:: amadeus.media.files.GeneratedPhotos
   :members: get
+
+Booking
+================
+
+.. autoclass:: amadeus.booking.FlightOrders
+  :members: post
+
+.. autoclass:: amadeus.booking.FlightOrder
+  :members: get

specs/namespaces/namespaces_spec.py

@@ -67,6 +67,9 @@
         expect(client.travel.from_file).not_to(be_none)
         expect(client.travel.from_base64).not_to(be_none)
 
+        expect(client.booking.flight_orders).not_to(be_none)
+        expect(client.booking.flight_order).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)
@@ -112,6 +115,8 @@
         expect(client.travel.trip_parser_jobs.status('123').get).not_to(be_none)
         expect(client.travel.trip_parser_jobs.result('123').get).not_to(be_none)
 
+        expect(client.booking.flight_order('123').get).not_to(be_none)
+
     with it('should define all expected .post methods'):
         client = self.client
         expect(client.travel.trip_parser_jobs.post).not_to(be_none)
@@ -306,3 +311,19 @@
                 {'data': {'type': 'flight-offers-pricing',
                           'flightOffers': [{'foo': 'bar'}]}}
             ))
+
+        with it('.shopping.booking.flight_orders.post'):
+            self.client.booking.flight_orders.post({'foo': 'bar'}, {'bar': 'foo'})
+            expect(self.client.post).to(have_been_called_with(
+                '/v1/booking/flight-orders',
+                {'data': {'type': 'flight-order',
+                          'flightOffers': [{'foo': 'bar'}],
+                          'travelers': [{'bar': 'foo'}]
+                          }}
+            ))
+
+        with it('.booking.flight_order().get'):
+            self.client.booking.flight_order('123').get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/booking/flight-orders/123', a='b'
+            ))