amadeus 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d85348bf45e54be187cc91e512d1958c1a1162ae22d1bdeb3d7171ac78f4272
-  data.tar.gz: 06020e4f010c2512ac639e44fcdf36cfbd0492cf6cba07111a6ddb2167b9035d
+  metadata.gz: 1b5f631649abaae86acd4e45d35507a0863bcc1f60766d81f2264307c4e10a1a
+  data.tar.gz: c93ab739e245d2ab52ee50e5e2cde0700a7d2ac6a809cbcead2918f9c22987cf
 SHA512:
-  metadata.gz: 6f775996bc4b672820ac34c79296fca9a8b586a007c067af46335d9f3d9793cff5597c26845171cce8cf81dfc63a836f5a9951f9c18c6864a6d733270764ae10
-  data.tar.gz: 0bfa4b4bdc56a8e19b052e95587c96026d9eeda00211e932e2e40bf133c689059432cdb91430721bdbe732742a481f6b924decfe552259b8e1795efa3c0543be
+  metadata.gz: 1756d0de031d1c00f217d6483fa319810669850b500b95ee4a734255c59dca1368da89d02dc0b4fb74f8c4cb5183ca9ef43607696be2547cb73f8ae10e752918
+  data.tar.gz: 6d17996db303020e08566b6f38ba3b5e82005a616651a3688f39395b8e5779cc30778214de5b49f3b94592cc3512912fa902f3e1dbdf15780c4434ec22c05de4

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+## 5.2.0 - 2021-03-20
+
+Add support for Flight Price Analysis. Thanks [@developius](https://github.com/developius) for the contribution.
 ## 5.1.0 - 2020-11-26
 
 Add support for Safe Place API.

data/README.md

@@ -11,7 +11,7 @@ Amadeus provides a rich set of APIs for the travel industry. For more details, c
 
 ## Installation
 
-This gem requires Ruby 2.4+. You can install it directly or via bundler.
+This gem requires Ruby 2.5+. You can install it directly or via bundler.
 #### Command line
 ```bash
 gem install amadeus
@@ -34,7 +34,7 @@ amadeus = Amadeus::Client.new({
 })
 
 begin
-  puts amadeus.reference_data.urls.checkin_links.get({ airlineCode: 'BA' })
+  puts amadeus.shopping.flight_offers_search.get(originLocationCode: 'NYC', destinationLocationCode: 'MAD', departureDate: '2021-05-01', adults: 1, max: 1).body
 rescue Amadeus::ResponseError => error
   puts error
 end
@@ -158,14 +158,14 @@ amadeus.shopping.flight_destinations.get(origin: 'MAD')
 amadeus.shopping.flight_dates.get(origin: 'MAD', destination: 'MUC')
 
 # Flight Offers Search
-amadeus.shopping.flight_offers_search.get(originLocationCode: 'NYC', destinationLocationCode: 'MAD', departureDate: '2020-10-01', adults: 1)
+amadeus.shopping.flight_offers_search.get(originLocationCode: 'NYC', destinationLocationCode: 'MAD', departureDate: '2021-05-01', adults: 1)
 
 # Flight Choice Prediction / Be careful, this example combines 2 API calls: 1. Flight Offers Search then Flight Choice Prediction
-flight_offers = amadeus.shopping.flight_offers_search.get(originLocationCode: 'NYC', destinationLocationCode: 'MAD', departureDate: '2020-10-01', adults: 1, max: 1).body
+flight_offers = amadeus.shopping.flight_offers_search.get(originLocationCode: 'NYC', destinationLocationCode: 'MAD', departureDate: '2021-05-01', adults: 1, max: 1).body
 amadeus.shopping.flight_offers_search.prediction.post(flight_offers)
 
 # Flight Delay Prediction
-amadeus.travel.predictions.flight_delay.get(originLocationCod: 'NCE', destinationLocationCod: 'IST', departureDat: '2020-08-01', departureTim: '18:20:00', arrivalDat: '2020-08-01', arrivalTim: '22:15:00', aircraftCod: '321', carrierCod: 'TK', flightNumber: '1816', duration: 'PT31H10M')
+amadeus.travel.predictions.flight_delay.get(originLocationCod: 'NCE', destinationLocationCod: 'IST', departureDat: '2021-05-01', departureTim: '18:20:00', arrivalDat: '2020-08-01', arrivalTim: '22:15:00', aircraftCod: '321', carrierCod: 'TK', flightNumber: '1816', duration: 'PT31H10M')
 # Flight Check-in Links
 amadeus.reference_data.urls.checkin_links.get(airlineCode: 'BA')
 
@@ -221,7 +221,6 @@ amadeus.reference_data.locations.points_of_interest.by_square.get(north: 41.3971
 # 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)
@@ -233,6 +232,9 @@ amadeus.safety.safety_rated_location('Q930402753').get()
 # Airport On-Time Performance
 amadeus.airport.predictions.on_time.get(airportCode: 'JFK', date: '2020-08-01')
 
+# Flight Price Analysis
+amadeus.analytics.itinerary_price_metrics.get(originIataCode: 'AMS', destinationIataCode: 'CDG', departureDate: '2021-08-18')
+
 # 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')
 ```

data/amadeus.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_development_dependency 'awesome_print', '~> 1.8'
-  spec.add_development_dependency 'bundler', '~> 2.1.2'
+  spec.add_development_dependency 'bundler', '~> 2.2.14'
   spec.add_development_dependency 'guard', '~> 2.16'
   spec.add_development_dependency 'guard-rake', '~> 1.0'
   spec.add_development_dependency 'guard-yard', '~> 2.2'

data/lib/amadeus.rb

@@ -16,6 +16,7 @@ require 'amadeus/namespaces/e_reputation'
 require 'amadeus/namespaces/booking'
 require 'amadeus/namespaces/airport'
 require 'amadeus/namespaces/safety'
+require 'amadeus/namespaces/analytics'
 require 'amadeus/namespaces/airport/predictions'
 require 'amadeus/namespaces/airport/predictions/on_time'
 require 'amadeus/namespaces/e_reputation/hotel_sentiments'
@@ -32,6 +33,7 @@ require 'amadeus/namespaces/reference_data/locations/points_of_interest/by_squar
 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/analytics/itinerary_price_metrics'
 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/analytics.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    # A namespaced client for the
+    # +/v1/analytics+ endpoints
+    #
+    # Access via the +Amadeus::Client+ object
+    #
+    #   amadeus = Amadeus::Client.new
+    #   amadeus.analytics
+    #
+    class Analytics < Amadeus::Client::Decorator
+      # The namespace for the Analytics-ItineraryPriceMetrics API:
+      #
+      # @return [Amadeus::Namespaces::Analytics::ItineraryPriceMetrics]
+      # @example
+      #   amadeus.analytics.itinerary_price_metrics
+      #
+      def itinerary_price_metrics
+        Amadeus::Namespaces::Analytics::ItineraryPriceMetrics.new(client)
+      end
+    end
+  end
+end

data/lib/amadeus/namespaces/analytics/itinerary_price_metrics.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Analytics
+      # A namespaced client for the
+      # +/v1/analytics/itinerary-price-metrics+ endpoint
+      #
+      # Access via the +Amadeus::Client+ object
+      #
+      #   amadeus = Amadeus::Client.new
+      #   amadeus.analytics.itinerary_price_metrics
+      #
+      class ItineraryPriceMetrics < Amadeus::Client::Decorator
+        # Returns historical flight prices by date and route so you can see how current ticket
+        # prices stack up against the historical average
+        #
+        # @option params [String] :originIataCode IATA code of the airport to depart from
+        # @option params [String] :destinationIataCode IATA code of the airport to arrive at
+        # @option params [String] :departureDate date to depart on, formatted as YYYY-MM-DD
+        # @option params [String] :currencyCode the preferred currency (ISO 4217) - optional
+        # @option params [Boolean] :oneWay retrieve prices for one-way only - optional
+        # @return [Amadeus::Response] a parsed response
+        # @raise [Amadeus::Base] an exception if the call failed
+        # @example
+        #   amadeus.analytics.itinerary_price_metrics.get(
+        #     originIataCode: 'AMS',
+        #     destinationIataCode: 'CDG',
+        #     departureDate: '2021-06-18'
+        #   )
+        #
+        def get(params = {})
+          client.get('/v1/analytics/itinerary-price-metrics', params)
+        end
+      end
+    end
+  end
+end

data/lib/amadeus/namespaces/core.rb

@@ -87,5 +87,15 @@ module Amadeus
     def safety
       Safety.new(self)
     end
+
+    # The namespace for the Analytics related APIs:
+    #
+    # @return [Amadeus::Namespaces::Analytics]
+    # @example Some of the further namespaces available
+    #   amadeus.analytics.itinerary_price_metrics
+    #
+    def analytics
+      Analytics.new(self)
+    end
   end
 end

data/lib/amadeus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amadeus
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Amadeus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2021-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.2.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.2.14
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -227,6 +227,8 @@ files:
 - lib/amadeus/namespaces/airport.rb
 - lib/amadeus/namespaces/airport/predictions.rb
 - lib/amadeus/namespaces/airport/predictions/on_time.rb
+- lib/amadeus/namespaces/analytics.rb
+- lib/amadeus/namespaces/analytics/itinerary_price_metrics.rb
 - lib/amadeus/namespaces/booking.rb
 - lib/amadeus/namespaces/booking/hotel_bookings.rb
 - lib/amadeus/namespaces/core.rb