Merge pull request #93 from amadeus4dev/safe-place

Add support for Safe Place

Author: tsolakoua

README.rst

@@ -271,10 +271,20 @@ List of supported endpoints
     # 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)
+    amadeus.reference_data.locations.points_of_interest.by_square.get(north=41.397158, west=2.160873,
+                                                                      south=41.394582, east=2.177181)
     # Returns a single Point of Interest from a given id
     amadeus.reference_data.locations.point_of_interest('9CB40CB5D0').get()
 
+    # Safe Place
+    # How safe is Barcelona? (based a geo location and a radius)
+    amadeus.safety.safety_rated_locations.get(latitude=41.397158, longitude=2.160873)
+    # How safe is Barcelona? (based on a square)
+    amadeus.safety.safety_rated_locations.by_square.get(north=41.397158, west=2.160873,
+                                                        south=41.394582, east=2.177181)
+    # What is the safety information of a location based on it's Id?
+    amadeus.safety.safety_rated_location('Q930400801').get()
+
     # Trip Purpose Prediction
     amadeus.travel.predictions.trip_purpose.get(originLocationCode='ATH', destinationLocationCode='MAD', departureDate='2020-08-01', returnDate='2020-08-12', searchDate='2020-06-11')
 

amadeus/namespaces/_safety.py

@@ -0,0 +1,12 @@
+from amadeus.client.decorator import Decorator
+from amadeus.safety._safety_rated_locations import SafetyRatedLocations
+from amadeus.safety._safety_rated_location import SafetyRatedLocation
+
+
+class Safety(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+        self.safety_rated_locations = SafetyRatedLocations(client)
+
+    def safety_rated_location(self, safety_id):
+        return SafetyRatedLocation(self.client, safety_id)

amadeus/namespaces/core.py

@@ -5,6 +5,7 @@
 from amadeus.namespaces._airport import Airport
 from amadeus.namespaces._media import Media
 from amadeus.namespaces._booking import Booking
+from amadeus.namespaces._safety import Safety
 
 
 class Core(object):
@@ -16,3 +17,4 @@ def __init__(self):
         self.airport = Airport(self)
         self.media = Media(self)
         self.booking = Booking(self)
+        self.safety = Safety(self)

amadeus/safety/__init__.py

@@ -0,0 +1,4 @@
+from ._safety_rated_locations import SafetyRatedLocations
+from ._safety_rated_location import SafetyRatedLocation
+
+__all__ = ['SafetyRatedLocations', 'SafetyRatedLocation']

amadeus/safety/_safety_rated_location.py

@@ -0,0 +1,21 @@
+from amadeus.client.decorator import Decorator
+
+
+class SafetyRatedLocation(Decorator, object):
+    def __init__(self, client, safety_id):
+        Decorator.__init__(self, client)
+        self.safety_id = safety_id
+
+    def get(self, **params):
+        '''
+        Returns safety information of a location by its Id.
+
+        .. code-block:: python
+
+            amadeus.safety.safety_rated_location('Q930400801').get()
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get('/v1/safety/safety-rated-locations/{0}'
+                               .format(self.safety_id), **params)

amadeus/safety/_safety_rated_locations.py

@@ -0,0 +1,32 @@
+from amadeus.client.decorator import Decorator
+from amadeus.safety.safety_rated_locations._by_square import BySquare
+
+
+class SafetyRatedLocations(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+        self.by_square = BySquare(client)
+
+    def get(self, **params):
+        '''
+        Returns the overall safety ranking and a detailed safety
+            ranking of all the districts within the given radius.
+
+        .. code-block:: python
+
+
+            amadeus.safety.safety_rated_locations.get(
+                longitude=2.160873,
+                latitude=41.397158
+            )
+
+        :param latitude: latitude of the location to safety ranking search.
+            For example: ``41.397158``
+        :param longitude: longitude of the location to safety ranking search.
+            For example: ``2.160873``
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get(
+            '/v1/safety/safety-rated-locations', **params)

amadeus/safety/safety_rated_locations/__init__.py

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

amadeus/safety/safety_rated_locations/_by_square.py

@@ -0,0 +1,32 @@
+from amadeus.client.decorator import Decorator
+
+
+class BySquare(Decorator, object):
+    def get(self, **params):
+        '''
+        Returns detailed safety ranking of all the districts
+            within the designated area.
+
+        .. code-block:: python
+
+            amadeus.safety.safety_rated_locations.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/safety/safety-rated-locations/by-square', **params)

docs/index.rst

@@ -161,4 +161,16 @@ Booking
   :members: delete
 
 .. autoclass:: amadeus.booking.HotelBookings
-  :members: post
+  :members: post
+
+Safety/SafetyRatedLocations
+=======================
+
+.. autoclass:: amadeus.safety.SafetyRatedLocations
+  :members: get
+
+.. autoclass:: amadeus.safety.safety_rated_locations.BySquare
+  :members: get
+
+.. autoclass:: amadeus.safety.safety_rated_locations.SafetyRatedLocation
+  :members: get

specs/namespaces/namespaces_spec.py

@@ -68,6 +68,10 @@
         expect(client.booking.flight_orders).not_to(be_none)
         expect(client.booking.flight_order).not_to(be_none)
 
+        expect(client.safety.safety_rated_locations).not_to(be_none)
+        expect(client.safety.safety_rated_locations.by_square).not_to(be_none)
+        expect(client.safety.safety_rated_location).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)
@@ -114,6 +118,10 @@
         expect(client.booking.flight_order('123').get).not_to(be_none)
         expect(client.booking.flight_order('123').delete).not_to(be_none)
 
+        expect(client.safety.safety_rated_locations.by_square.get).not_to(be_none)
+        expect(client.safety.safety_rated_location('Q930402719').get).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)
@@ -393,3 +401,22 @@
                           'payments': [{'bar': 'foo'}]
                           }}
             ))
+
+        with it('.safety.safety_rated_locations.get'):
+            self.client.safety.safety_rated_locations.get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/safety/safety-rated-locations', a='b'
+            ))
+
+        with it('.safety.safety_rated_locations.by_square.get'):
+            self.client.safety.safety_rated_locations.by_square.get(
+                a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/safety/safety-rated-locations/by-square', a='b'
+            ))
+
+        with it('.safety.safety_rated_location().get'):
+            self.client.safety.safety_rated_location('XXX').get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/safety/safety-rated-locations/XXX', a='b'
+            ))