Merge pull request #157 from amadeus4dev/city-search

Add support for City Search API

Author: tsolakoua

README.rst

@@ -243,6 +243,9 @@ List of supported endpoints
     # Get a specific city or airport based on its id
     amadeus.reference_data.location('ALHR').get()
 
+    # City Search
+    amadeus.reference_data.locations.cities.get(keyword='PAR')
+
     # Airport Nearest Relevant Airport (for London)
     amadeus.reference_data.locations.airports.get(longitude=0.1278, latitude=51.5074)
 

amadeus/reference_data/_locations.py

@@ -4,6 +4,7 @@
 from amadeus.reference_data.locations._point_of_interest import PointOfInterest
 from amadeus.reference_data.locations._hotels import Hotels
 from amadeus.reference_data.locations._hotel import Hotel
+from amadeus.reference_data.locations._cities import Cities
 
 
 class Locations(Decorator, object):
@@ -13,6 +14,7 @@ def __init__(self, client):
         self.points_of_interest = PointsOfInterest(client)
         self.hotels = Hotels(client)
         self.hotel = Hotel(client)
+        self.cities = Cities(client)
 
     def point_of_interest(self, poi_id):
         return PointOfInterest(self.client, poi_id)

amadeus/reference_data/locations/__init__.py

@@ -1,5 +1,6 @@
 from ._airports import Airports
 from ._points_of_interest import PointsOfInterest
 from ._hotel import Hotel
+from ._cities import Cities
 
-__all__ = ['Airports', 'PointsOfInterest', 'Hotel']
+__all__ = ['Airports', 'PointsOfInterest', 'Hotel', 'Cities']

amadeus/reference_data/locations/_cities.py

@@ -0,0 +1,23 @@
+from amadeus.client.decorator import Decorator
+
+
+class Cities(Decorator, object):
+    def get(self, **params):
+        '''
+        Returns cities that match a specific word or letters.
+
+        .. code-block:: python
+
+
+            amadeus.reference_data.locations.cities.get(
+                keyword='PARI'
+            )
+
+        :param keyword: location query keyword.
+            For example: ``PARI``
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get(
+            '/v1/reference-data/locations/cities', **params)

docs/index.rst

@@ -185,6 +185,12 @@ ReferenceData/Locations/Hotel
 .. autoclass:: amadeus.reference_data.locations.Hotel
   :members: get
 
+ReferenceData/Locations/Cities
+=======================
+
+.. autoclass:: amadeus.reference_data.locations.Cities
+  :members: get
+
 Helper/Location
 ==================
 

specs/namespaces/namespaces_spec.py

@@ -29,6 +29,7 @@
         expect(client.reference_data.locations.hotels.by_city).not_to(be_none)
         expect(client.reference_data.locations.hotels.by_geocode).not_to(be_none)
         expect(client.reference_data.locations.hotel).not_to(be_none)
+        expect(client.reference_data.locations.cities).not_to(be_none)
         expect(client.travel).not_to(be_none)
         expect(client.travel.analytics).not_to(be_none)
         expect(client.travel.analytics.air_traffic.traveled).not_to(be_none)
@@ -563,3 +564,9 @@
             expect(self.client.get).to(have_been_called_with(
                 '/v1/reference-data/locations/hotel', a='b'
             ))
+
+        with it('.reference_data.locations.cities.get'):
+            self.client.reference_data.locations.cities.get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/reference-data/locations/cities', a='b'
+            ))