Add support for Safe Place API (#51)

Add support for Safe Place API and for the last endpoint of Points of Interest

Author: anthonyroux

README.md

@@ -213,11 +213,22 @@ amadeus.booking.hotel_bookings.post(offerId, guests, payments)
 # What are the reviews for the Holiday INN Manhattan and the Hilton London Paddington
 amadeus.e_reputation.hotel_sentiments.get(hotelIds: 'SJNYCAJA,TELONMFS')
 
-# Point of Interest
+# Points 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)
+# 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('Q930402753').get()
 
 # Airport On-Time Performance
 amadeus.airport.predictions.on_time.get(airportCode: 'JFK', date: '2020-08-01')

lib/amadeus.rb

@@ -15,6 +15,7 @@
 require 'amadeus/namespaces/e_reputation'
 require 'amadeus/namespaces/booking'
 require 'amadeus/namespaces/airport'
+require 'amadeus/namespaces/safety'
 require 'amadeus/namespaces/airport/predictions'
 require 'amadeus/namespaces/airport/predictions/on_time'
 require 'amadeus/namespaces/e_reputation/hotel_sentiments'
@@ -25,8 +26,12 @@
 require 'amadeus/namespaces/reference_data/location'
 require 'amadeus/namespaces/reference_data/locations'
 require 'amadeus/namespaces/reference_data/locations/airports'
+require 'amadeus/namespaces/reference_data/locations/point_of_interest'
 require 'amadeus/namespaces/reference_data/locations/points_of_interest'
 require 'amadeus/namespaces/reference_data/locations/points_of_interest/by_square'
+require 'amadeus/namespaces/safety/safety_rated_location'
+require 'amadeus/namespaces/safety/safety_rated_locations'
+require 'amadeus/namespaces/safety/safety_rated_locations/by_square'
 require 'amadeus/namespaces/shopping/flight_destinations'
 require 'amadeus/namespaces/shopping/flight_offers_search'
 require 'amadeus/namespaces/shopping/flight_offers_search/prediction'

lib/amadeus/namespaces/core.rb

@@ -77,5 +77,15 @@ def e_reputation
     def airport
       Airport.new(self)
     end
+
+    # The namespace for the Safety related APIs:
+    #
+    # @return [Amadeus::Namespaces::Safety]
+    # @example Some of the further namespaces available
+    #   amadeus.safety.safety_rated_locations
+    #
+    def safety
+      Safety.new(self)
+    end
   end
 end

lib/amadeus/namespaces/reference_data/locations.rb

@@ -22,7 +22,7 @@ def airports
           Amadeus::Namespaces::ReferenceData::Locations::Airports.new(client)
         end
 
-        # The namespace for the Point Of Interest API:
+        # The namespace for the Points Of Interest API:
         #
         # @return [Amadeus::Namespaces::ReferenceData::Locations::PointsOfInterest]
         # @example
@@ -32,6 +32,18 @@ def points_of_interest
           Amadeus::Namespaces::ReferenceData::Locations::PointsOfInterest.new(client)
         end
 
+        # The namespace for the Point Of Interest API:
+        #
+        # @return [Amadeus::Namespaces::ReferenceData::Locations::PointOfInterest]
+        # @example
+        #   amadeus.reference_data.locations.point_of_interest
+        #
+        def point_of_interest(location_id)
+          Amadeus::Namespaces::ReferenceData::Locations::PointOfInterest.new(
+            client, location_id
+          )
+        end
+
         # Returns a list of airports and cities matching a given keyword.
         #
         # @option params [String] :keyword keyword that should represent the

lib/amadeus/namespaces/reference_data/locations/point_of_interest.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class ReferenceData
+      class Locations
+        # A namespaced client for the
+        # +/v1/reference-data/locations/pois/:location_id+ endpoints
+        #
+        # Access via the +Amadeus::Client+ object
+        #
+        #   amadeus = Amadeus::Client.new
+        #   amadeus.reference_data.locations.point_of_interest('9CB40CB5D0')
+        #
+        class PointOfInterest < Amadeus::Client::Decorator
+          # the Location ID
+          attr_reader :poi_location_id
+
+          # Initialize this namespaced client with an
+          # {Amadeus::Client} instance and an optional Location ID
+          #
+          # @param [Amadeus::Client] client
+          # @param [Number] poi_location_id
+          #
+          def initialize(client, poi_location_id = nil)
+            super(client)
+            @poi_location_id = poi_location_id
+          end
+
+          # Returns details for a specific poi
+          #
+          # @return [Amadeus::Response] a parsed response
+          # @raise [Amadeus::Base] an exception if the call failed
+          # @example Retrieve poi information of '9CB40CB5D0'
+          #   amadeus.reference_data.locations.point_of_interest('9CB40CB5D0').get
+          #
+          def get(params = {})
+            client.get("/v1/reference-data/locations/pois/#{@poi_location_id}", params)
+          end
+        end
+      end
+    end
+  end
+end

lib/amadeus/namespaces/safety.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    # A namespaced client for the
+    # +/v1/safety+ endpoints
+    #
+    # Access via the +Amadeus::Client+ object
+    #
+    #   amadeus = Amadeus::Client.new
+    #   amadeus.safety
+    #
+    class Safety < Amadeus::Client::Decorator
+      # The namespace for the Safety APIs:
+      #
+      # @return [Amadeus::Namespaces::Safety::SafetyRetedLocations]
+      # @example
+      #   amadeus.safety.safety_rated_locations
+      #
+      def safety_rated_locations
+        Amadeus::Namespaces::Safety::SafetyRatedLocations.new(client)
+      end
+
+      #
+      # @return [Amadeus::Namespaces::Safety::SafetyRetedLocation]
+      # @example
+      #   amadeus.safety.safety_rated_location
+      #
+      def safety_rated_location(location_id)
+        Amadeus::Namespaces::Safety::SafetyRatedLocation.new(client, location_id)
+      end
+    end
+  end
+end

lib/amadeus/namespaces/safety/safety_rated_location.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Safety
+      # amadeus.safety.safety_rated_location('Q930400801').get()
+      class SafetyRatedLocation < Amadeus::Client::Decorator
+        attr_reader :safe_location_id
+
+        #
+        # @param [Amadeus::Client] client
+        # @param [Number] safe_location_id
+        #
+        def initialize(client, safe_location_id = nil)
+          super(client)
+          @safe_location_id = safe_location_id
+        end
+
+        # Returns details for a specific place
+        #
+        # @return [Amadeus::Response] a parsed response
+        # @raise [Amadeus::Base] an exception if the call failed
+        # @example Retrieve safety information of 'Q930402753'
+        #   amadeus.safety.safety_rated_location('Q930402753').get
+        #
+        def get(params = {})
+          client.get("/v1/safety/safety-rated-locations/#{@safe_location_id}", params)
+        end
+      end
+    end
+  end
+end

lib/amadeus/namespaces/safety/safety_rated_locations.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Safety
+      # A namespaced client for the
+      # +/v1/safety/safety_rated_locations/+ endpoints
+      #
+      # Access via the +Amadeus::Client+ object
+      #
+      #   amadeus = Amadeus::Client.new
+      #   amadeus.safety.safety_rated_locations
+      #
+      class SafetyRatedLocations < Amadeus::Client::Decorator
+        # The namespace for the Safe Place API:
+        #
+        # @return [Amadeus::Namespaces::Safety::SafetyRatedLocations]
+        # @example
+        #   amadeus.safety.safety_rated_locations.by_square
+        #
+        def by_square
+          Amadeus::Namespaces::Safety::SafetyRatedLocations::BySquare.new(client)
+        end
+
+        # Returns a list of relevant safety information near to a given point.
+        #
+        # @option params [Double] :latitude latitude location to be at the
+        #   center of the search circle - required
+        # @option params [Double] :longitude longitude location to be at the
+        #   center of the search circle - required
+        # @return [Amadeus::Response] a parsed response
+        # @raise [Amadeus::Base] an exception if the call
+        #   failed
+        # @example What are the different safety information in Barcelona
+        #   amadeus.safety.safety_rated_locations.get(
+        #     latitude: 41.397158,
+        #     longitude: 2.160873
+        #   )
+        #
+        def get(params = {})
+          client.get('/v1/safety/safety-rated-locations', params)
+        end
+      end
+    end
+  end
+end

lib/amadeus/namespaces/safety/safety_rated_locations/by_square.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Safety
+      class SafetyRatedLocations
+        # A namespaced client for the
+        # +/v1/safety/safety_rated_locations/by-square+ endpoints
+        #
+        # Access via the +Amadeus::Client+ object
+        #
+        #   amadeus = Amadeus::Client.new
+        #   amadeus.safety.safety_rated_locations.by_square
+        #
+        class BySquare < Amadeus::Client::Decorator
+          # Returns a list of relevant safety information
+          #  around a defined square (4 points).
+          #
+          # @option params [Double] :north Latitude north of bounding box - required
+          # @option params [Double] :west Longitude west of bounding box - required
+          # @option params [Double] :south Latitude south of bounding box - required
+          # @option params [Double] :east Longitude east of bounding box - required
+          # @return [Amadeus::Response] a parsed response
+          # @raise [Amadeus::Base] an exception if the call
+          #   failed
+          # @example How safe is Barcelona?
+          #   amadeus.safety.safety_rated_locations.by_square.get(
+          #     north: 41.397158,
+          #     west: 2.160873,
+          #     south: 41.394582,
+          #     east: 2.177181
+          #   )
+          #
+          def get(params = {})
+            client.get('/v1/safety/safety-rated-locations/by-square', params)
+          end
+        end
+      end
+    end
+  end
+end

spec/namespaces/namespaces_spec.rb

@@ -73,7 +73,7 @@
       end
     end
 
-    describe '.reference_data.locations..points_of_interest.by_square' do
+    describe '.reference_data.locations.points_of_interest.by_square' do
       it 'should return a PointsOfInterest::BySquare object' do
         expect(@amadeus.reference_data.locations.points_of_interest.by_square).to(
           be_instance_of(
@@ -83,6 +83,46 @@
       end
     end
 
+    describe '.reference_data.locations.point_of_interest' do
+      it 'should return a PointOfInterest object' do
+        expect(@amadeus.reference_data.locations.point_of_interest('9CB40CB5D0')).to(
+          be_instance_of Amadeus::Namespaces::ReferenceData::Locations::PointOfInterest
+        )
+      end
+    end
+
+    describe '.shopping' do
+      it 'should return a Safety object' do
+        expect(@amadeus.safety).to(
+          be_instance_of Amadeus::Namespaces::Safety
+        )
+      end
+    end
+
+    describe '.safety.safety_rated_locations' do
+      it 'should return a SafetyRatedLocations object' do
+        expect(@amadeus.safety.safety_rated_locations).to(
+          be_instance_of Amadeus::Namespaces::Safety::SafetyRatedLocations
+        )
+      end
+    end
+
+    describe '.safety.safety_rated_location' do
+      it 'should return a SafetyRatedLocation object' do
+        expect(@amadeus.safety.safety_rated_location('CXXXX')).to(
+          be_instance_of Amadeus::Namespaces::Safety::SafetyRatedLocation
+        )
+      end
+    end
+
+    describe '.safety.safety_rated_locations.by_square' do
+      it 'should return a BySquare object' do
+        expect(@amadeus.safety.safety_rated_locations.by_square).to(
+          be_instance_of Amadeus::Namespaces::Safety::SafetyRatedLocations::BySquare
+        )
+      end
+    end
+
     describe '.shopping' do
       it 'should return a Shopping object' do
         expect(@amadeus.shopping).to(

spec/namespaces/reference_data/locations/point_of_interest_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Amadeus::Namespaces::ReferenceData::Locations::PointOfInterest do
+  before do
+    @client = double('Amadeus::Client')
+    @location_id = '9CB40CB5D0'
+    @api = Amadeus::Namespaces::ReferenceData::Locations::PointOfInterest.new(
+      @client, @location_id
+    )
+  end
+
+  describe '.get' do
+    it 'should call client.get with the right params' do
+      params = {}
+
+      expect(@client).to receive(:get).with(
+        '/v1/reference-data/locations/pois/9CB40CB5D0', params
+      )
+
+      @api.get(params)
+    end
+
+    it 'should default to an empty hash' do
+      expect(@client).to receive(:get).with(
+        '/v1/reference-data/locations/pois/9CB40CB5D0', {}
+      )
+
+      @api.get
+    end
+  end
+end