amadeus 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa2f88d0dd02caa16558d86e65df76459220e0e9cdc9f12c4f3345e29bb4be2
-  data.tar.gz: 6a8c25052107c18810dd9b7d0a22bc2fc489828e88b24aab0f842937794dd43b
+  metadata.gz: 3d85348bf45e54be187cc91e512d1958c1a1162ae22d1bdeb3d7171ac78f4272
+  data.tar.gz: 06020e4f010c2512ac639e44fcdf36cfbd0492cf6cba07111a6ddb2167b9035d
 SHA512:
-  metadata.gz: ce3a0e248e96a067e56172a0fda8a6b614c3dde2e61905130e5ccd86658e96f1e28786b686171d5447bcc1e46e137fb87e6c93c11ec74c132f31233de5471def
-  data.tar.gz: 72dd837abaee061718587382bd0a81cdf67fd1f6545be39c45d76ed8803f0cffa55bfcba93fe4f4462ad9872d21b1f9d2c1609eeca3d7f3e6529424e0b16c73d
+  metadata.gz: 6f775996bc4b672820ac34c79296fca9a8b586a007c067af46335d9f3d9793cff5597c26845171cce8cf81dfc63a836f5a9951f9c18c6864a6d733270764ae10
+  data.tar.gz: 0bfa4b4bdc56a8e19b052e95587c96026d9eeda00211e932e2e40bf133c689059432cdb91430721bdbe732742a481f6b924decfe552259b8e1795efa3c0543be

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## 5.1.0 - 2020-11-26
+
+Add support for Safe Place API.
+Add support for retrieve by id for Points Of Interest API
 ## 5.0.0 - 2020-05-14
 Release of the Flight Offers Search API.
 

data/README.md

@@ -5,16 +5,13 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/d2e15221a502a7d71144/maintainability)](https://codeclimate.com/github/amadeus4dev/amadeus-ruby/maintainability)
 [![Dependencies](https://github.com/amadeus4dev/amadeus-ruby/raw/master/.github/images/dependencies.svg?sanitize=true)](gem)
 [![Contact Support](https://github.com/amadeus4dev/amadeus-ruby/raw/master/.github/images/support.svg?sanitize=true)][support]
+[![Discord](https://img.shields.io/discord/696822960023011329?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/cVrFBqx)
 
-Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more.
-
-For more details see the [Ruby
-documentation](https://amadeus4dev.github.io/amadeus-ruby/) on
-[Amadeus.com](https://developers.amadeus.com).
+Amadeus provides a rich set of APIs for the travel industry. For more details, check out the [Amadeus for Developers Portal](https://developers.amadeus.com) or the [SDK class reference](https://amadeus4dev.github.io/amadeus-ruby/).
 
 ## Installation
 
-This gem requires Ruby 2.4+. You can install install it directly or via bundler.
+This gem requires Ruby 2.4+. You can install it directly or via bundler.
 #### Command line
 ```bash
 gem install amadeus
@@ -26,9 +23,7 @@ gem 'amadeus'
 
 ## Getting Started
 
-To make your first API call you will need to [register for an Amadeus
-Developer Account](https://developers.amadeus.com/create-account) and set up
-your first application.
+To make your first API call, you will need to [register](https://developers.amadeus.com/register) for an Amadeus Developer Account and [set up your first application](https://developers.amadeus.com/my-apps).
 
 ```rb
 require 'amadeus'
@@ -54,19 +49,15 @@ The client can be initialized directly.
 amadeus = Amadeus::Client.new(client_id: 'REPLACE_BY_YOUR_API_KEY', client_secret: 'REPLACE_BY_YOUR_API_SECRET')
 ```
 
-Alternatively it can be initialized without any parameters if the environment
-variables `AMADEUS_CLIENT_ID` and `AMADEUS_CLIENT_SECRET` are present.
+Alternatively, it can be initialized without any parameters if the environment variables `AMADEUS_CLIENT_ID` and `AMADEUS_CLIENT_SECRET` are present.
 
 ```rb
 amadeus = Amadeus::Client.new
 ```
 
-Your credentials can be found on the [Amadeus
-dashboard](https://developers.amadeus.com/my-apps). [Sign
-up](https://developers.amadeus.com/create-account) for an account today.
+Your credentials can be found on the [Amadeus dashboard](https://developers.amadeus.com/my-apps).
 
-By default the environment for the SDK is the `:test` environment. To switch to
-a production (paid-for) environment please switch the hostname as follows:
+By default, the environment for the SDK is the `:test` environment. To switch to a production (pay-as-you-go) environment please switch the hostname as follows:
 
 ```rb
 amadeus = Amadeus::Client.new(hostname: :production)
@@ -74,34 +65,26 @@ amadeus = Amadeus::Client.new(hostname: :production)
 
 ## Documentation
 
-Amadeus has a large set of APIs, and our documentation is here to get you
-started today. Head over to our
-[Reference](https://amadeus4dev.github.io/amadeus-ruby/) documentation for
-in-depth information about every SDK method, its arguments and return types.
+Amadeus has a large set of APIs, and our documentation is here to get you started today. Head over to our [reference documentation](https://amadeus4dev.github.io/amadeus-ruby/) for in-depth information about every SDK method, its arguments and return types.
 
 
-* [Get Started](https://amadeus4dev.github.io/amadeus-ruby/) documentation
-  * [Initialize the SDK](https://amadeus4dev.github.io/amadeus-ruby/)
+  * [Get Started](https://amadeus4dev.github.io/amadeus-ruby/)
   * [Find an Airport](https://amadeus4dev.github.io/amadeus-ruby/Amadeus/Namespaces/ReferenceData/Locations/Airports.html)
-  * [Find a Flight](https://amadeus4dev.github.io/amadeus-ruby/Amadeus/Namespaces/Shopping/FlightOffers.html)
+  * [Find a Flight](https://amadeus4dev.github.io/amadeus-ruby/Amadeus/Namespaces/Shopping/FlightOffersSearch.html)
   * [Get Flight Inspiration](https://amadeus4dev.github.io/amadeus-ruby/Amadeus/Namespaces/Shopping/FlightDestinations.html)
 
 ## Making API calls
 
-This library conveniently maps every API path to a similar path.
-
-For example, `GET /v2/reference-data/urls/checkin-links?airlineCode=BA` would be:
+This library conveniently maps every API path to a similar path. For example, `GET /v2/reference-data/urls/checkin-links?airlineCode=BA` would be:
 
 ```rb
 amadeus.reference_data.urls.checkin_links.get(airlineCode: 'BA')
 ```
 
-Similarly, to select a resource by ID, you can pass in the ID to the **singular** path.
-
-For example,  `GET /v2/shopping/hotel-offers/XZY` would be:
+Similarly, to select a resource by ID, you can pass in the ID to the **singular** path. For example,  `GET /v2/shopping/hotel-offers/XZY` would be:
 
 ```rb
-amadeus.shopping.hotel_offer('D5BEE9D0D08B6678C2F5FAD910DC110BCDA187D21D4FCE68ED423426D0A246BB').get
+amadeus.shopping.hotel_offer('XZY').get
 ```
 
 You can make any arbitrary API call as well directly with the `.get` method:
@@ -112,10 +95,7 @@ amadeus.get('/v2/reference-data/urls/checkin-links', airlineCode: 'BA')
 
 ## Response
 
-Every API call returns a `Amadeus::Response` object. If the API call contained
-a JSON response it will parse the JSON into the `.result` attribute. If this data
-also contains a `data` key, it will make that available as the `.data`
-attribute. The raw body of the response is always avaulable as the `.body` attribute.
+Every API call returns a `Amadeus::Response` object. If the API call contained a JSON response, it will parse the JSON into `.result` attribute. If this data also contains a `data` key, that will be made available in `.data` attribute. The raw body of the response is always available in `.body` attribute.
 
 ```rb
 response = amadeus.reference_data.locations.get(
@@ -158,10 +138,7 @@ amadeus = Amadeus::Client.new(
 )
 ```
 
-Additionally, to enable more verbose logging, you can set the appropriate level
-on your own logger, though the easiest way would be to enable debugging via a
-parameter on initialization, or using the `AMADEUS_LOG_LEVEL` environment
-variable.
+Additionally, to enable more verbose logging, you can set the appropriate level on your own logger. The easiest way would be to enable debugging via a parameter on initialization, or using the `AMADEUS_LOG_LEVEL` environment variable.
 
 ```rb
 require 'logger'
@@ -236,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')

data/lib/amadeus.rb

@@ -15,6 +15,7 @@ require 'amadeus/namespaces/reference_data'
 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/urls/checkin_links'
 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'

data/lib/amadeus/namespaces/core.rb

@@ -77,5 +77,15 @@ module Amadeus
     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

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

@@ -22,7 +22,7 @@ module Amadeus
           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 @@ module Amadeus
           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

data/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

data/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

data/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

data/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

data/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

data/lib/amadeus/version.rb

@@ -2,5 +2,5 @@
 
 module Amadeus
   # The current client version
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amadeus
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Amadeus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -237,10 +237,15 @@ files:
 - lib/amadeus/namespaces/reference_data/location.rb
 - lib/amadeus/namespaces/reference_data/locations.rb
 - lib/amadeus/namespaces/reference_data/locations/airports.rb
+- lib/amadeus/namespaces/reference_data/locations/point_of_interest.rb
 - lib/amadeus/namespaces/reference_data/locations/points_of_interest.rb
 - lib/amadeus/namespaces/reference_data/locations/points_of_interest/by_square.rb
 - lib/amadeus/namespaces/reference_data/urls.rb
 - lib/amadeus/namespaces/reference_data/urls/checkin_links.rb
+- lib/amadeus/namespaces/safety.rb
+- lib/amadeus/namespaces/safety/safety_rated_location.rb
+- lib/amadeus/namespaces/safety/safety_rated_locations.rb
+- lib/amadeus/namespaces/safety/safety_rated_locations/by_square.rb
 - lib/amadeus/namespaces/shopping.rb
 - lib/amadeus/namespaces/shopping/flight_dates.rb
 - lib/amadeus/namespaces/shopping/flight_destinations.rb
@@ -278,8 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Amadeus travel APIs