Delete - Flight Order Management (#81)

* initial commit

* update tests

* fix line errors

* add test for delete

* update request to accept delete

* add delete example

* var name update

Author: tsolakoua

README.rst

@@ -230,8 +230,11 @@ List of supported endpoints
 
     # Flight Order Management
     # The flight ID comes from the Flight Create Orders (in test environment it's temporary)
+    # Retrieve the order based on it's ID
     flight_booking = amadeus.booking.flight_orders.post(body).data
     amadeus.booking.flight_order(flight_booking['id']).get()
+    # Delete the order based on it's ID
+    amadeus.booking.flight_order(flight_booking['id']).delete()
 
     # Flight SeatMap Display GET
     amadeus.shopping.seatmaps.get(**{"flight-orderId": "orderid"})

amadeus/booking/_flight_order.py

@@ -19,3 +19,17 @@ def get(self, **params):
         '''
         return self.client.get('/v1/booking/flight-orders/{0}'
                                .format(self.flight_order_id), **params)
+
+    def delete(self, **params):
+        '''
+        Deletes a flight order based on its ID.
+
+        .. code-block:: python
+
+            amadeus.booking.flight_order('eJzTd9f3NjIJdzUGAAp%2fAiY=').delete()
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.delete('/v1/booking/flight-orders/{0}'
+                                  .format(self.flight_order_id), **params)

amadeus/client/request.py

@@ -101,7 +101,7 @@ def __build_http_request(self):
         # Adds the authentication header since the bearer token has been set
         self.headers['Authorization'] = self.bearer_token
 
-        if (self.verb == 'GET'):
+        if (self.verb == 'GET' or self.verb == 'DELETE'):
             return HTTPRequest(self.url, headers=self.headers)
         else:
             return HTTPRequest(self.url,

amadeus/mixins/http.py

@@ -65,6 +65,29 @@ def post(self, path, params={}):
         '''
         return self.request('POST', path, params)
 
+    def delete(self, path, **params):
+        '''
+        A helper function for making generic DELETE requests calls. It is used by
+        every namespaced API DELETE method.
+
+        It can be used to make any generic API call that is automatically
+        authenticated using your API credentials:
+
+        .. code-block:: python
+
+            amadeus.delete('/foo/bar', airline='1X')
+
+        :param path: path the full path for the API call
+        :paramtype path: str
+
+        :param params: (optional) params to pass to the API
+        :paramtype params: dict
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: when the request fails
+        '''
+        return self.request('DELETE', path, params)
+
     def request(self, verb, path, params):
         '''
         A helper function for making generic POST requests calls. It is used by

docs/index.rst

@@ -148,5 +148,8 @@ Booking
 .. autoclass:: amadeus.booking.FlightOrder
   :members: get
 
+.. autoclass:: amadeus.booking.FlightOrder
+  :members: delete
+
 .. autoclass:: amadeus.booking.HotelBookings
   :members: post

examples/flight_create_orders/flight_create_orders.py

@@ -48,6 +48,7 @@
     # Flight Order Management returns the last-updated version of the booking
     # print('Flight Order Management')
     updated_booking = amadeus.booking.flight_order(booked_flight['id']).get()
+    cancelled_booking = amadeus.booking.flight_order(booked_flight['id']).delete()
 except ResponseError as error:
     # print(error.response.body)
     pass

specs/mixins/http_spec.py

@@ -29,6 +29,15 @@
                 have_been_called_with('GET', '/foo', {'foo': 'bar'})
             )
 
+    with context('Client.delete'):
+        with it('should pass all details to the request method'):
+            self.client.request = self.request_method
+            response = self.client.delete('/foo', foo='bar')
+            expect(response).to(equal(self.response))
+            expect(self.client.request).to(
+                have_been_called_with('DELETE', '/foo', {'foo': 'bar'})
+            )
+
     with context('Client.post'):
         with it('should pass all details to the request method'):
             self.client.request = self.request_method

specs/namespaces/namespaces_spec.py

@@ -111,6 +111,11 @@
         expect(client.travel.trip_parser_jobs.result('123').get).not_to(be_none)
 
         expect(client.booking.flight_order('123').get).not_to(be_none)
+        expect(client.booking.flight_order('123').delete).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)
 
     with it('should define all expected .post methods'):
         client = self.client
@@ -120,6 +125,7 @@
         with before.each:
             self.client.get = method_returning(None)
             self.client.post = method_returning(None)
+            self.client.delete = method_returning(None)
 
         with it('.reference_data.urls.checkin_links.get'):
             self.client.reference_data.urls.checkin_links.get(a='b')
@@ -357,6 +363,12 @@
                 '/v1/booking/flight-orders/123', a='b'
             ))
 
+        with it('.booking.flight_order().delete'):
+            self.client.booking.flight_order('123').delete(a='b')
+            expect(self.client.delete).to(have_been_called_with(
+                '/v1/booking/flight-orders/123', a='b'
+            ))
+
         with it('.shopping.booking.hotel_bookings.post'):
             self.client.booking.hotel_bookings.post('123',
                                                     {'foo': 'bar'},