Merge pull request #33 from anthonyroux/point_of_interests

Add new API: Point of Interest

Author: anthonyroux

CHANGELOG.rst

@@ -1,5 +1,11 @@
 Changelog
 =========
+3.1.0 - 2019-03-25
+-------------------- 
+Release of the `Point of Interest API <https://developers.amadeus.com/self-service/category/210/api-doc/55>`_
+
+The Points Of Interest API, powered by AVUXI TopPlace, is a search API that returns a list of popular places for a particular location. The location can be defined as area bound by four coordinates or as a geographical coordinate with a radius. The popularity of a place or 'point of interest' is determined by AVUXI's proprietary algorithm that considers factors such as ratings, check-ins, category scores among other factors from a host of online media sources.
+
 
 3.0.0 - 2019-01-22
 -------------------- 

README.rst

@@ -245,6 +245,11 @@ List of supported endpoints
     amadeus.shopping.hotel_offers_by_hotel.get(hotelId = 'IALONCHO')
     # Confirm the availability of a specific offer
     amadeus.shopping.hotel_offer('D5BEE9D0D08B6678C2F5FAD910DC110BCDA187D21D4FCE68ED423426D0A246BB').get()
+    # Point of Interest
+    # What are the popular places in Barcelona (based a geo location and a radius)
+    amadeus.reference_data.locations.points_of_interest.get(latitude=41.397158, longitude=2.160873)
+    # What are the popular places in Barcelona? (based on a square)
+    amadeus.reference_data.locations.points_of_interest.by_square.get(north=41.397158, west=2.160873, south=41.394582, east=2.177181)
 
 
 Development & Contributing

amadeus/amadeus.py

@@ -37,7 +37,7 @@ def __init__(self, **options):
         .. code-block:: python
 
 
-              amadeus = amadeus.Client()
+        amadeus = amadeus.Client()
 
         :param client_id: the API key used to authenticate the API
         :paramtype client_id: str

amadeus/reference_data/_locations.py

@@ -1,11 +1,13 @@
 from amadeus.client.decorator import Decorator
 from amadeus.reference_data.locations._airports import Airports
+from amadeus.reference_data.locations._points_of_interest import PointsOfInterest
 
 
 class Locations(Decorator, object):
     def __init__(self, client):
         Decorator.__init__(self, client)
         self.airports = Airports(client)
+        self.points_of_interest = PointsOfInterest(client)
 
     def get(self, **params):
         '''

amadeus/reference_data/locations/__init__.py

@@ -1,3 +1,3 @@
 from ._airports import Airports
-
-__all__ = ['Airports']
+from ._points_of_interest import PointsOfInterest
+__all__ = ['Airports', 'PointsOfInterest']

amadeus/reference_data/locations/_airports.py

@@ -9,7 +9,7 @@ def get(self, **params):
         .. code-block:: python
 
 
-            client.reference_data.locations.get(
+            client.reference_data.locations.airports.get(
                 longitude=49.0000,
                 latitude=2.55
             )

amadeus/reference_data/locations/_points_of_interest.py

@@ -0,0 +1,32 @@
+from amadeus.client.decorator import Decorator
+from amadeus.reference_data.locations.points_of_interest._by_square \
+    import BySquare
+
+
+class PointsOfInterest(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+        self.by_square = BySquare(client)
+
+    def get(self, **params):
+        '''
+        Returns a list of relevant point of interests near to a given point.
+
+        .. code-block:: python
+
+
+            client.reference_data.locations.points_of_interest.get(
+                longitude=2.160873,
+                latitude=41.397158
+            )
+
+        :param latitude: latitude of geographic location to search around.
+            For example: ``41.397158``
+        :param longitude: longitude of geographic location to search around.
+            For example: ``2.160873``
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get(
+            '/v1/reference-data/locations/pois', **params)

amadeus/reference_data/locations/points_of_interest/__init__.py

@@ -0,0 +1,2 @@
+from ._by_square import BySquare
+__all__ = ['BySquare']

amadeus/reference_data/locations/points_of_interest/_by_square.py

@@ -0,0 +1,33 @@
+from amadeus.client.decorator import Decorator
+
+
+class BySquare(Decorator, object):
+    def get(self, **params):
+        '''
+        Returns a list of relevant point of interests
+            around a defined square (4 points).
+
+        .. code-block:: python
+
+
+            client.reference_data.locations.points_of_interest.by_square.get(
+                north=41.397158,
+                west=2.160873,
+                south=41.394582,
+                east=2.177181
+            )
+
+        :param north: latitude north of bounding box.
+            For example: ``41.397158``
+        :param west: longitude west of bounding box.
+            For example: ``2.160873``
+        :param south: latitude south of bounding box.
+            For example: ``41.394582``
+        :param east: longitude east of bounding box.
+            For example: ``2.177181``
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get(
+            '/v1/reference-data/locations/pois/by-square', **params)

specs/namespaces/namespaces_spec.py

@@ -20,6 +20,10 @@
         expect(client.reference_data.location).not_to(be_none)
         expect(client.reference_data.locations).not_to(be_none)
         expect(client.reference_data.locations.airports).not_to(be_none)
+        expect(client.reference_data.locations.points_of_interest).not_to(be_none)
+        expect(
+            client.reference_data.locations.points_of_interest.by_square).not_to(
+            be_none)
 
         expect(client.travel).not_to(be_none)
         expect(client.travel.analytics).not_to(be_none)
@@ -46,6 +50,12 @@
         expect(client.reference_data.location('ALHR').get).not_to(be_none)
         expect(client.reference_data.locations.get).not_to(be_none)
         expect(client.reference_data.locations.airports.get).not_to(be_none)
+        expect(
+            client.reference_data.locations.points_of_interest.get).not_to(
+            be_none)
+        expect(
+            client.reference_data.locations.points_of_interest.by_square.get
+            ).not_to(be_none)
 
         expect(client.travel.analytics.air_traffic.traveled.get).not_to(be_none)
         expect(client.travel.analytics.air_traffic.booked.get).not_to(be_none)
@@ -100,6 +110,19 @@
                 '/v1/reference-data/locations/airports', a='b'
             ))
 
+        with it('.reference_data.locations.points_of_interest.get'):
+            self.client.reference_data.locations.points_of_interest.get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/reference-data/locations/pois', a='b'
+            ))
+
+        with it('.reference_data.locations.points_of_interest.by_square.get'):
+            self.client.reference_data.locations.points_of_interest.by_square.get(
+                a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/reference-data/locations/pois/by-square', a='b'
+            ))
+
         with it('.travel.analytics.air_traffic.traveled.get'):
             self.client.travel.analytics.air_traffic.traveled.get(a='b')
             expect(self.client.get).to(have_been_called_with(