amadeus 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec95cf5f3ba9c2cc68cca517f1feb2f9c2ab97ab61b8220338c619a3ca071b88
-  data.tar.gz: 3c499ba802220e9e4b89e99276c6ff5481b6eaa4a7f7df4eaca73f18dfdcb07b
+  metadata.gz: 6de12964b5fc9ba2acc621f7c6cba612176f5a510d762c176a20bbaff97b696c
+  data.tar.gz: 7feadab2cb09cfcfb400a68d5b0e3574d7e26704cbf3b110675578116eb5bee1
 SHA512:
-  metadata.gz: 7a10be7c20276302a2571a504f7724dc633b1bc9739bbbe0c8b63bcee3e1bf6011ec347cc9b83b4164dfdc41541b81b9dba89e2b0cc294d5c328723728e2ac34
-  data.tar.gz: e7e802567729d52e770defbfa597a601bee86593b214798bee8cc201f9002e9333bbe7c9f05d8605083fc8ec8e3162acd43478a983ba96600361e99ecaf620fd
+  metadata.gz: eda4f4a0e74f46ab1ff6a7fd50943c98f25f3ab7cb09bfb2f9b9545fd36f906c658830ef38a1a3c8ce9129900226a9e303692156f3e12020effe5cc8499b8184
+  data.tar.gz: 335ede21e566eaa2d136c91f5a0408c9d22dbb53a8af7df05312645e0d3da3f4fa039ba65ec38b01e30d445c7861c8280dd438713476447de12c7abe8bcb27a8

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+## 4.0.0 - 2020-02-12
+Release of the [Hotel Booking API](https://developers.amadeus.com/self-service/category/hotel/api-doc/hotel-booking)
+
+> The Amadeus Hotel Booking API lets you complete bookings at over 150,000 hotels and accommodations around the world. To complete bookings, you must first use the Amadeus Hotel Search API to search for hotel deals, select the desired offer and confirm the final price and availability. You can then use the Hotel Booking API to complete the reservation by providing an offer id, guest information and payment information.
+
+Decommissioning of the `Flight Most Searched Destination API`
+
 ## 3.3.0 - 2019-11-12
 Release of the [Hotel Ratings](https://developers.amadeus.com/self-service/category/hotel/api-doc/hotel-ratings)
 

data/README.md

@@ -14,7 +14,7 @@ documentation](https://amadeus4dev.github.io/amadeus-ruby/) on
 
 ## Installation
 
-This gem requires Ruby 2.3+. You can install install it directly or via bundler.
+This gem requires Ruby 2.4+. You can install install it directly or via bundler.
 #### Command line
 ```bash
 gem install amadeus
@@ -181,10 +181,10 @@ amadeus.shopping.flight_destinations.get(origin: 'MAD')
 amadeus.shopping.flight_dates.get(origin: 'MAD', destination: 'MUC')
 
 # Flight Low-fare Search
-amadeus.shopping.flight_offers.get(origin: 'NYC', destination: 'MAD', departureDate: '2019-08-01')
+amadeus.shopping.flight_offers.get(origin: 'NYC', destination: 'MAD', departureDate: '2020-08-01')
 
 # Flight Choice Prediction / Be careful, this example combines 2 API calls: 1. Flight Low-fare Search then Flight Choice Prediction
-amadeus.shopping.flight_offers.prediction.post(amadeus.shopping.flight_offers.get(origin: 'NYC', destination: 'MAD', departureDate: '2020-01-01').body)
+amadeus.shopping.flight_offers.prediction.post(amadeus.shopping.flight_offers.get(origin: 'NYC', destination: 'MAD', departureDate: '2020-11-01').body)
 
 # Flight Check-in Links
 amadeus.reference_data.urls.checkin_links.get(airlineCode: 'BA')
@@ -204,12 +204,6 @@ amadeus.reference_data.location('ALHR').get
 # Airport Nearest Relevant (for London)
 amadeus.reference_data.locations.airports.get(longitude: 0.1278, latitude: 51.5074)
 
-# Flight Most Searched Destinations
-# Get the most searched destinations from an origin
-amadeus.travel.analytics.air_traffic.searched.get(originCityCode: 'MAD', searchPeriod: '2017-08', marketCountryCode: 'ES')
-# How many people in Spain searched for a trip from Madrid to New-York in August 2017?
-amadeus.travel.analytics.air_traffic.searched_by_destination.get(originCityCode: 'MAD', destinationCityCode: 'NYC', searchPeriod: '2017-08', marketCountryCode: 'ES')
-
 # Flight Most Booked Destinations
 amadeus.travel.analytics.air_traffic.booked.get(originCityCode: 'MAD', period: '2017-08')
 
@@ -231,6 +225,10 @@ amadeus.shopping.hotel_offers_by_hotel.get(hotelId: 'IALONCHO')
 # Confirm the availability of a specific offer
 amadeus.shopping.hotel_offer('D5BEE9D0D08B6678C2F5FAD910DC110BCDA187D21D4FCE68ED423426D0A246BB').get
 
+# Hotel Booking
+# The offerId comes from the hotel_offer above
+amadeus.booking.hotel_bookings.post(offerId, guests, payments)
+
 # Hotel Ratings
 # What are the reviews for the Holiday INN Manhattan and the Hilton London Paddington
 amadeus.e_reputation.hotel_sentiments.get(hotelIds: 'SJNYCAJA,TELONMFS')

data/amadeus.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2.0'
 
   spec.add_development_dependency 'awesome_print', '~> 1.8'
-  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'bundler', '~> 2.1.2'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rake', '~> 1.0'
   spec.add_development_dependency 'guard-yard', '~> 2.2'

data/lib/amadeus.rb

@@ -13,6 +13,7 @@ require 'amadeus/namespaces/travel'
 require 'amadeus/namespaces/shopping'
 require 'amadeus/namespaces/reference_data'
 require 'amadeus/namespaces/e_reputation'
+require 'amadeus/namespaces/booking'
 require 'amadeus/namespaces/e_reputation/hotel_sentiments'
 require 'amadeus/namespaces/reference_data/airlines'
 require 'amadeus/namespaces/reference_data/urls'
@@ -33,9 +34,8 @@ require 'amadeus/namespaces/travel/analytics'
 require 'amadeus/namespaces/travel/analytics/air_traffic'
 require 'amadeus/namespaces/travel/analytics/air_traffic/traveled'
 require 'amadeus/namespaces/travel/analytics/air_traffic/booked'
-require 'amadeus/namespaces/travel/analytics/air_traffic/searched'
-require 'amadeus/namespaces/travel/analytics/air_traffic/searched_by_destination'
 require 'amadeus/namespaces/travel/analytics/air_traffic/busiest_period'
+require 'amadeus/namespaces/booking/hotel_bookings'
 
 # The namespace for the files used to make API
 # calls to the Amadeus travel APIs

data/lib/amadeus/namespaces/booking.rb

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

data/lib/amadeus/namespaces/booking/hotel_bookings.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Booking
+      # A namespaced client for the
+      # +/v1/booking/hotel_bookings+ endpoints
+      #
+      # Access via the +Amadeus::Client+ object
+      #
+      #   amadeus = Amadeus::Client.new
+      #   amadeus.booking.hotel_bookings
+      #
+      class HotelBookings < Amadeus::Client::Decorator
+        # Book a specific room
+        #
+        # The parameters guests and payments can be passed as dictionary
+        # or list of dictionaries. If they are dictionary in this method they are
+        # converted to a list of dictionaries.
+        #
+        # @option params [String] :hotelIds list of hotel ids separated by comas
+        # @return [Amadeus:Response] a parsed response
+        # @raise [Amadeus:Base] an exception if the call failed
+        # @example book for a hotel offer
+        #  amadeus.booking.hotel_bookings.post(
+        #     hotel_offer_id, guests, payments
+        #   )
+        #
+        def post(hotel_offer_id, guests, payments)
+          body = prepare_body(hotel_offer_id, guests, payments)
+
+          client.post('/v1/booking/hotel-bookings', body.to_json)
+        end
+
+        def prepare_body(hotel_offer_id, guests, payments)
+          guests_info = [], pay_info = []
+
+          guests.is_a?(Array) ? guests_info.push(guests).flatten! : guests_info.push(guests)
+          payments.is_a?(Array) ? pay_info.push(payments).flatten! : pay_info.push(payments)
+
+          {
+            'data' => {
+              'offerId' => hotel_offer_id,
+              'guests' => guests_info,
+              'payments' => pay_info
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/amadeus/namespaces/core.rb

@@ -37,6 +37,16 @@ module Amadeus
       Shopping.new(self)
     end
 
+    # The namespace for the booking APIs:
+    #
+    # @return [Amadeus::Namespaces::Booking]
+    # @example Some of the further namespaces available
+    #   amadeus.booking.hotel_bookings
+    #
+    def booking
+      Booking.new(self)
+    end
+
     # The namespace for the travel analytics APIs:
     #
     # @return [Amadeus::Namespaces::Travel]

data/lib/amadeus/namespaces/shopping/flight_offers.rb

@@ -30,11 +30,11 @@ module Amadeus
         # @return [Amadeus::Response] a parsed response
         # @raise [Amadeus::Base] an exception if the call failed
         # @example Find the cheapest flight offers from New-York to Madrid,
-        #   for the first of August 2019
+        #   for the first of August 2020
         #   amadeus.shopping.flight_offers.get(
         #     origin: 'NYC',
         #     destination: 'MAD',
-        #     departureDate: '2019-08-01'
+        #     departureDate: '2020-08-01'
         #   )
         #
 

data/lib/amadeus/namespaces/travel/analytics/air_traffic.rb

@@ -37,29 +37,6 @@ module Amadeus
             )
           end
 
-          # The namespace for the Searched API:
-          #
-          # @return
-          #  [Amadeus::Namespaces::Travel::Analytics::AirTraffic::Searched]
-          # @example
-          #   amadeus.travel.analytics.air_traffic.searched
-          def searched
-            Amadeus::Namespaces::Travel::Analytics::AirTraffic::Searched.new(
-              client
-            )
-          end
-
-          # The namespace for the SearchedByDestination API:
-          #
-          # @return
-          #  [Amadeus::Namespaces::Travel::Analytics::AirTraffic::SearchedByDestination]
-          # @example
-          #   amadeus.travel.analytics.air_traffic.searched_by_destination
-          def searched_by_destination
-            Amadeus::Namespaces::Travel::Analytics::AirTraffic::SearchedByDestination
-              .new(client)
-          end
-
           # The namespace for the Busiest Period API:
           #
           # @return

data/lib/amadeus/version.rb

@@ -2,5 +2,5 @@
 
 module Amadeus
   # The current client version
-  VERSION = '3.3.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amadeus
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Amadeus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-02-14 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.0.1
+        version: 2.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +224,8 @@ files:
 - lib/amadeus/client/response.rb
 - lib/amadeus/client/response/parser.rb
 - lib/amadeus/client/validator.rb
+- lib/amadeus/namespaces/booking.rb
+- lib/amadeus/namespaces/booking/hotel_bookings.rb
 - lib/amadeus/namespaces/core.rb
 - lib/amadeus/namespaces/e_reputation.rb
 - lib/amadeus/namespaces/e_reputation/hotel_sentiments.rb
@@ -249,8 +251,6 @@ files:
 - lib/amadeus/namespaces/travel/analytics/air_traffic.rb
 - lib/amadeus/namespaces/travel/analytics/air_traffic/booked.rb
 - lib/amadeus/namespaces/travel/analytics/air_traffic/busiest_period.rb
-- lib/amadeus/namespaces/travel/analytics/air_traffic/searched.rb
-- lib/amadeus/namespaces/travel/analytics/air_traffic/searched_by_destination.rb
 - lib/amadeus/namespaces/travel/analytics/air_traffic/traveled.rb
 - lib/amadeus/version.rb
 homepage: https://github.com/amadeus4dev/amadeus-ruby

data/lib/amadeus/namespaces/travel/analytics/air_traffic/searched.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Amadeus
-  module Namespaces
-    class Travel
-      class Analytics
-        class AirTraffic
-          # A namespaced client for the
-          # +/v1/travel/analytics/air-traffic/searched+ endpoints
-          #
-          # Access via the +Amadeus::Client+ object
-          #
-          #   amadeus = Amadeus::Client.new
-          #   amadeus.travel.analytics.air_traffic.searched
-          #
-          class Searched < Amadeus::Client::Decorator
-            # Returns a list of air traffic reports, based on searches.
-            #
-            # @option params [String] :originCityCode
-            # IATA code of the origin city -
-            #   e.g. MAD for Madrid - required
-            # @option params [String] :marketCountryCode
-            # IATA code of the country from which the searches were made -
-            #   e.g. ES for Spain - required
-            # @option params [String] :searchPeriod when consumers
-            # are searching -
-            #   in YYYY-MM format - required
-            # @return [Amadeus::Response] a parsed response
-            # @raise [Amadeus::Base] an exception if the call failed
-            # @example Which were the most searched flight destinations
-            # from Madrid in August 2017?
-            #   amadeus.travel.analytics.air_traffic.searched.get(
-            #     originCityCode: 'MAD',
-            #     searchPeriod: '2017-08',
-            #     marketCountryCode: 'ES'
-            #   )
-            #
-            def get(params = {})
-              client.get('/v1/travel/analytics/air-traffic/searched', params)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/amadeus/namespaces/travel/analytics/air_traffic/searched_by_destination.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Amadeus
-  module Namespaces
-    class Travel
-      class Analytics
-        class AirTraffic
-          # A namespaced client for the
-          # +/v1/travel/analytics/air-traffic/searched_by_destination+ endpoints
-          #
-          # Access via the +Amadeus::Client+ object
-          #
-          #   amadeus = Amadeus::Client.new
-          #   amadeus.travel.analytics.air_traffic.searched_by_destination
-          #
-          class SearchedByDestination < Amadeus::Client::Decorator
-            # Returns a list of air traffic reports,
-            # based on searches for a dedicated destination.
-            #
-            # @option params [String] :originCityCode
-            # IATA code of the origin city -
-            #   e.g. NCE for Nice - required
-            # @option params [String] :destinationCityCode
-            # IATA code of the destinaton city -
-            #   e.g. PAR for Paris - required
-            # @option params [String] :marketCountryCode
-            # IATA code of the country from which the searches were made -
-            #   e.g. FR for France - required
-            # @option params [String] :searchPeriod when consumers
-            # are searching -
-            #   in YYYY-MM format - required
-            # @return [Amadeus::Response] a parsed response
-            # @raise [Amadeus::Base] an exception if the call failed
-            # @example How many people in Spain searched for a trip
-            # from Madrid to New-York in August 2017?
-            #  amadeus.travel.analytics.air_traffic.searched_by_destination.get(
-            #     originCityCode: 'MAD',
-            #     destinationCityCode: 'NYC',
-            #     searchPeriod: '2017-08',
-            #     marketCountryCode: 'ES'
-            #   )
-            #
-            def get(params = {})
-              client.get(
-                '/v1/travel/analytics/air-traffic/searched/by-destination',
-                params
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end