amadeus 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a30ea6344ae22d11df337a484c13e074a60e59e60807d00841987be4b6172d91
-  data.tar.gz: ab8c30fcc9ae6da0b7fb4e999fa2d4ae422027835776f2fb9cdcb4d37d60846c
+  metadata.gz: ffd090d42d800bbfae01e30b095e6907ee66922875eb38e81e83d0dfcf93688c
+  data.tar.gz: 1d34a30f43448bae789456f43fb2e96ce89abd63561b7318aec8086dc3b9bf0f
 SHA512:
-  metadata.gz: bc4ca3df59611e1d592a16f13f81496bd54fc6c381777f24ce148a4f077abb523e1363e14940dd727746ce74c4e310af59b66903f822d46ea9fe268d29ddc870
-  data.tar.gz: 331719a2fb0cb21758e86efefbfd2a541c3ce04d16767b875734d1bcab62dc40e683a02d36a2a4ce567165d85d75924e642954ec5175b156bca48581cdbf92b9
+  metadata.gz: 3005646311109b6551347efd3ebe559d6f091e9210a84d77666f898e1a12e3f4f7c5166b2d49ddc9af8c67c859c1d7ae45b156656b917d3fe081ee339de81cc9
+  data.tar.gz: 65046569d983b9a988de5fee812b5a38e85311963161f9b9e94841b8f9cb98e524cb2c7e2e162b8f64dd27fdc085213d2a3d65a54ae93f872d40fd4f73082d6a

data/CHANGELOG.md

@@ -1,4 +1,20 @@
 # Changelog
+## 3.0.0 - 2019-01-22
+
+## Hotel Search v2 has been deployed (Hotel Search v1 is now deprecated)
+
+### General
+* URLs for all three endpoints have been simplified for ease-of-use and consistency
+### Find Hotels - 1st endpoint
+* The parameter `hotels` has been renamed to `hotelIds`
+### View Hotel Rooms - 2nd endpoint
+* Update from `amadeus.shopping.hotel('IALONCHO').hotel_offers.get` to `amadeus.shopping.hotel_offers_by_hotel.get(hotelId: 'IALONCHO')`
+* Now get all images in ‘View Hotels Rooms’ endpoint using the view parameter as               `FULL_ALL_IMAGES`
+### View Room Details - 3rd endpoint
+* Updated from `amadeus.shopping.hotel('IALONCHO').offer('XXX').get` to `amadeus.shopping.hotel_offer('XXX').get`
+* Image category added under Media in the response
+* Hotel distance added in the response
+* Response now refers to the common HotelOffer object model
 
 ## 2.0.0 - 2018-10-12
 
@@ -6,7 +22,7 @@
 * 1st endpoint to find the most searched destinations
 * 2nd endpoint to have more data about a dedicated origin & destination
 
-[Flight Most Booked Destinations](https://developers.amadeus.com/self-service/category/203/api-doc/6):
+[Flight Most Booked Destinations](https://developers.amadeus.com/self-service/category/203/api-doc/27):
 * Rename origin to originCityCode
 
 [Flight Most Traveled Destinations](https://developers.amadeus.com/self-service/category/203/api-doc/7):

data/README.md

@@ -14,7 +14,7 @@ documentation](https://amadeus4dev.github.io/amadeus-ruby/) on
 
 ## Installation
 
-This gem requires Ruby 2.2+. You can install install it directly or via bundler.
+This gem requires Ruby 2.3+. You can install install it directly or via bundler.
 #### Command line
 ```bash
 gem install amadeus
@@ -39,7 +39,7 @@ amadeus = Amadeus::Client.new({
 })
 
 begin
-  puts amadeus.reference_data.urls.checkin_links.get({ airline: 'BA' })
+  puts amadeus.reference_data.urls.checkin_links.get({ airlineCode: 'BA' })
 rescue Amadeus::ResponseError => error
   puts error
 end
@@ -90,24 +90,24 @@ in-depth information about every SDK method, its arguments and return types.
 
 This library conveniently maps every API path to a similar path.
 
-For example, `GET /v2/reference-data/urls/checkin-links?airline=BA` would be:
+For example, `GET /v2/reference-data/urls/checkin-links?airlineCode=BA` would be:
 
 ```rb
-amadeus.reference_data.urls.checkin_links.get(airline: 'BA')
+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 /v1/shopping/hotel/123/offers/234` would be:
+For example,  `GET /v2/shopping/hotel-offers/XZY` would be:
 
 ```rb
-amadeus.hotel(123).offer(234).get(...)
+amadeus.shopping.hotel_offer('D5BEE9D0D08B6678C2F5FAD910DC110BCDA187D21D4FCE68ED423426D0A246BB').get
 ```
 
 You can make any arbitrary API call as well directly with the `.get` method:
 
 ```rb
-amadeus.get('/v2/reference-data/urls/checkin-links', airline: 'BA')
+amadeus.get('/v2/reference-data/urls/checkin-links', airlineCode: 'BA')
 ```
 
 ## Response
@@ -184,10 +184,10 @@ amadeus.shopping.flight_dates.get(origin: 'NYC', destination: 'MAD')
 amadeus.shopping.flight_offers.get(origin: 'NYC', destination: 'MAD', departureDate: '2019-08-01')
 
 # Flight Check-in Links
-amadeus.reference_data.urls.checkin_links.get({ airlineCode: 'BA' })
+amadeus.reference_data.urls.checkin_links.get(airlineCode: 'BA')
 
 # Airline Code Lookup
-amadeus.reference_data.airlines.get({ airlineCodes: 'U2' })
+amadeus.reference_data.airlines.get(airlineCodes: 'U2')
 
 # Airport & City Search (autocomplete)
 # Find all the cities and airports starting by the keyword 'LON'
@@ -198,8 +198,8 @@ amadeus.reference_data.locations.get(
 # Get a specific city or airport based on its id
 amadeus.reference_data.location('ALHR').get
 
-# Airport Nearest Relevant
-amadeus.reference_data.locations.airports.get(longitude: 49.0000, latitude: 2.55)
+# 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
@@ -224,9 +224,9 @@ amadeus.travel.analytics.air_traffic.busiest_period.get(
 # Get list of hotels by cityCode
 amadeus.shopping.hotel_offers.get(cityCode: 'MAD')
 # Get list of offers for a specific hotel
-amadeus.shopping.hotel('SMPARCOL').hotel_offers.get
-# Confirm the availability of a specific offer for a specific hotel
-amadeus.shopping.hotel('SMPARCOL').offer('4BA070CE929E135B3268A9F2D0C51E9D4A6CF318BA10485322FA2C7E78C7852E').get
+amadeus.shopping.hotel_offers_by_hotel.get(hotelId: 'IALONCHO')
+# Confirm the availability of a specific offer
+amadeus.shopping.hotel_offer('D5BEE9D0D08B6678C2F5FAD910DC110BCDA187D21D4FCE68ED423426D0A246BB').get
 ```
 ## Development & Contributing
 
@@ -248,4 +248,4 @@ to help you. You can find us on
 [gem]: https://rubygems.org/gems/amadeus
 [travis]: http://travis-ci.org/amadeus4dev/amadeus-ruby
 [support]: http://developers.amadeus.com/support
-[codeclimate]: https://codeclimate.com/github/amadeus4dev/amadeus-ruby
+[codeclimate]: https://codeclimate.com/github/amadeus4dev/amadeus-ruby

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', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
   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

@@ -22,9 +22,8 @@ require 'amadeus/namespaces/shopping/flight_destinations'
 require 'amadeus/namespaces/shopping/flight_offers'
 require 'amadeus/namespaces/shopping/flight_dates'
 require 'amadeus/namespaces/shopping/hotel_offers'
-require 'amadeus/namespaces/shopping/hotel'
-require 'amadeus/namespaces/shopping/hotel/offer'
-require 'amadeus/namespaces/shopping/hotel/hotel_offers'
+require 'amadeus/namespaces/shopping/hotel_offer'
+require 'amadeus/namespaces/shopping/hotel_offers_by_hotel'
 require 'amadeus/namespaces/travel/analytics'
 require 'amadeus/namespaces/travel/analytics/air_traffic'
 require 'amadeus/namespaces/travel/analytics/air_traffic/traveled'

data/lib/amadeus/namespaces/reference_data.rb

@@ -45,7 +45,6 @@ module Amadeus
 
       # The namespace for the Airline Code APIs - accessing a specific airline
       #
-      # @param [Number] airline_id The IATA ID for the airline
       # @return [Amadeus::Namespaces::ReferenceData::Airlines]
       # @example
       #   amadeus.reference_data.airlines('U2')

data/lib/amadeus/namespaces/shopping.rb

@@ -51,15 +51,25 @@ module Amadeus
         Amadeus::Namespaces::Shopping::HotelOffers.new(client)
       end
 
-      # The namespace for the Hotels API:
+      # The namespace for the HotelOffersByHotel API:
       #
-      # @param [Number] hotel_id The ID for the hotel to find offers for
-      # @return [Amadeus::Namespaces::Shopping::Hotel]
+      # @return [Amadeus::Namespaces::Shopping::HotelOffersByHotel]
       # @example
-      #   amadeus.shopping.hotel(hotel_id)
+      #   amadeus.shopping.hotel_offers_by_hotel
       #
-      def hotel(hotel_id)
-        Amadeus::Namespaces::Shopping::Hotel.new(client, hotel_id)
+      def hotel_offers_by_hotel
+        Amadeus::Namespaces::Shopping::HotelOffersByHotel.new(client)
+      end
+
+      # The namespace for the HotelOffers API:
+      #
+      # @param [Number] offer_id The ID for the offer for a specific hotel
+      # @return [Amadeus::Namespaces::Shopping::HotelOffer]
+      # @example
+      #   amadeus.shopping.hotel_offer(offer_id)
+      #
+      def hotel_offer(offer_id)
+        Amadeus::Namespaces::Shopping::HotelOffer.new(client, offer_id)
       end
     end
   end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Shopping
+      # A namespaced client for the
+      # +/v2/shopping/hotel-offers/:offer_id+ endpoints
+      #
+      # Access via the +Amadeus::Client+ object
+      #
+      #   amadeus = Amadeus::Client.new
+      #   amadeus.shopping.hotel_offer('XXXX')
+      #
+      class HotelOffer < Amadeus::Client::Decorator
+        # the Offer ID
+        attr_reader :offer_id
+
+        # Initialize this namespaced client with an
+        # {Amadeus::Client} instance and an Offer ID
+        #
+        # @param [Amadeus::Client] client
+        # @param [Number] offer_id
+        #
+        def initialize(client, offer_id)
+          super(client)
+          @offer_id = offer_id
+        end
+
+        # Return all available details of a specific hotel offer
+        #
+        # @return [Amadeus::Response] a parsed response
+        # @raise [Amadeus::Base] an exception if the call failed
+        # @example
+        #   amadeus.shopping.hotel_offer('XXXX').get
+        #
+        def get(params = {})
+          client.get("/v2/shopping/hotel-offers/#{@offer_id}", params)
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Amadeus
   module Namespaces
     class Shopping
       # A namespaced client for the
-      # +/v1/shopping/hotel-offers+ endpoints
+      # +/v2/shopping/hotel-offers+ endpoints
       #
       # Access via the +Amadeus::Client+ object
       #
@@ -19,7 +19,7 @@ module Amadeus
         #   search around. Example: 52.5238
         # @option params [Double] :longitude Longitude of geographic location to
         #   search around. Example: 13.3835
-        # @option params [String] :hotels Comma separated list of Amadeus hotel
+        # @option params [String] :hotelIds Comma separated list of Amadeus hotel
         #   codes to request. Example: RTPAR001
         # @return [Amadeus::Response] a parsed response
         # @raise [Amadeus::Base] an exception if the call failed
@@ -29,7 +29,7 @@ module Amadeus
         #   )
         #
         def get(params = {})
-          client.get('/v1/shopping/hotel-offers', params)
+          client.get('/v2/shopping/hotel-offers', params)
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Shopping
+      # A namespaced client for the
+      # +/v2/shopping/hotel-offers/by-hotel+ endpoints
+      #
+      # Access via the +Amadeus::Client+ object
+      #
+      #   amadeus = Amadeus::Client.new
+      #   amadeus.shopping.hotel_offers
+      #
+      class HotelOffersByHotel < Amadeus::Client::Decorator
+        # Get the different offers for a dedicated hotel
+        #
+        # @option params [String] :hotelId Amadeus Property Code (8 chars)
+        # @return [Amadeus::Response] a parsed response
+        # @raise [Amadeus::Base] an exception if the call failed
+        # @example Get all offers for Holiday Inn Paris Notre Dame
+        #   amadeus.shopping.hotel_offers_by_hotel.get(
+        #     hotelId: 'XKPARC12'
+        #   )
+        #
+        def get(params = {})
+          client.get('/v2/shopping/hotel-offers/by-hotel', params)
+        end
+      end
+    end
+  end
+end

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

@@ -31,13 +31,13 @@ module Amadeus
             #   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 France searched for a trip
-            # from Nice to Paris in September 2015?
+            # @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: 'NCE',
-            #     destinationCityCode: 'PAR',
-            #     searchPeriod: '2015-09',
-            #     marketCountryCode: 'FR'
+            #     originCityCode: 'MAD',
+            #     destinationCityCode: 'NYC',
+            #     searchPeriod: '2017-08',
+            #     marketCountryCode: 'ES'
             #   )
             #
             def get(params = {})

data/lib/amadeus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amadeus
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Amadeus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2019-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -222,10 +222,9 @@ files:
 - lib/amadeus/namespaces/shopping/flight_dates.rb
 - lib/amadeus/namespaces/shopping/flight_destinations.rb
 - lib/amadeus/namespaces/shopping/flight_offers.rb
-- lib/amadeus/namespaces/shopping/hotel.rb
-- lib/amadeus/namespaces/shopping/hotel/hotel_offers.rb
-- lib/amadeus/namespaces/shopping/hotel/offer.rb
+- lib/amadeus/namespaces/shopping/hotel_offer.rb
 - lib/amadeus/namespaces/shopping/hotel_offers.rb
+- lib/amadeus/namespaces/shopping/hotel_offers_by_hotel.rb
 - lib/amadeus/namespaces/travel.rb
 - lib/amadeus/namespaces/travel/analytics.rb
 - lib/amadeus/namespaces/travel/analytics/air_traffic.rb
@@ -254,8 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Amadeus travel APIs

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Amadeus
-  module Namespaces
-    class Shopping
-      # A namespaced client for the
-      # +/v1/shopping/hotels+ endpoints
-      #
-      # Access via the +Amadeus::Client+ object
-      #
-      #   amadeus = Amadeus::Client.new
-      #   amadeus.shopping.hotels(123)
-      #
-      class Hotel < Amadeus::Client::Decorator
-        # the Hotel ID
-        attr_reader :hotel_id
-
-        # Initialize this namespaced client with an
-        # {Amadeus::Client} instance and a Hotel ID
-        #
-        # @param [Amadeus::Client] client
-        # @param [Number] hotel_id
-        #
-        def initialize(client, hotel_id)
-          super(client)
-          @hotel_id = hotel_id
-        end
-
-        # The namespace for the Hotels::Offers API:
-        #
-        # @param [Number] offer_id The ID for the offer to find details for
-        # @return [Amadeus::Namespaces::Shopping::Hotels::Offers]
-        # @example
-        #   amadeus.shopping.hotel('SMPARCOL').offer(234)
-        #
-        def offer(offer_id)
-          Amadeus::Namespaces::Shopping::Hotel::Offer.new(
-            client, @hotel_id, offer_id
-          )
-        end
-
-        # The namespace for the Hotels::HotelOffers API:
-        #
-        # @return [Amadeus::Namespaces::Shopping::Hotels::HotelOffers]
-        # @example
-        #   amadeus.shopping.hotel('SMPARCOL').hotel_offers
-        #
-        def hotel_offers
-          Amadeus::Namespaces::Shopping::Hotel::HotelOffers.new(
-            client, @hotel_id
-          )
-        end
-      end
-    end
-  end
-end

data/lib/amadeus/namespaces/shopping/hotel/hotel_offers.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Amadeus
-  module Namespaces
-    class Shopping
-      class Hotel
-        # A namespaced client for the
-        # +/v1/shopping/hotels/:id/hotel-offers+ endpoints
-        #
-        # Access via the +Amadeus::Client+ object
-        #
-        #   amadeus = Amadeus::Client.new
-        #   amadeus.shopping.hotels.hotel_offers
-        #
-        class HotelOffers < Amadeus::Client::Decorator
-          # the Hotel ID
-          attr_reader :hotel_id
-
-          # Initialize this namespaced client with an
-          # {Amadeus::Client} instance and a Hotel ID
-          #
-          # @param [Amadeus::Client] client
-          # @param [Number] hotel_id
-          #
-          def initialize(client, hotel_id)
-            super(client)
-            @hotel_id = hotel_id
-          end
-
-          # Get one hotel and its available offers
-          #
-          # @return [Amadeus::Response] a parsed response
-          # @raise [Amadeus::Base] an exception if the call failed
-          # @example Search for hotels in London
-          #   amadeus.shopping.hotel('SMPARCOL').hotel_offers.get
-          #
-          def get(params = {})
-            client.get("/v1/shopping/hotels/#{@hotel_id}/hotel-offers", params)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/amadeus/namespaces/shopping/hotel/offer.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Amadeus
-  module Namespaces
-    class Shopping
-      class Hotel
-        # A namespaced client for the
-        # +/v1/shopping/hotels/:id/offers+ endpoints
-        #
-        # Access via the +Amadeus::Client+ object
-        #
-        #   amadeus = Amadeus::Client.new
-        #   amadeus.shopping.hotels.offers
-        #
-        class Offer < Amadeus::Client::Decorator
-          # the Hotel ID
-          attr_reader :hotel_id
-          # the Offer ID
-          attr_reader :offer_id
-
-          # Initialize this namespaced client with an
-          # {Amadeus::Client} instance, a Hotel ID, and an Offer ID
-          #
-          # @param [Amadeus::Client] client
-          # @param [Number] hotel_id
-          # @param [Number] offer_id
-          #
-          def initialize(client, hotel_id, offer_id)
-            super(client)
-            @hotel_id = hotel_id
-            @offer_id = offer_id
-          end
-
-          # Get room and rate details
-          #
-          # @return [Amadeus::Response] a parsed response
-          # @raise [Amadeus::Base] an exception if the call failed
-          # @example Search for hotels in London
-          #   amadeus.shopping.hotel('SMPARCOL')
-          #     .offers('AC7D4DA2C322A73AF0824318A4965DA2805A3FC2').get
-          #
-          def get(params = {})
-            client.get(
-              "/v1/shopping/hotels/#{@hotel_id}/offers/#{@offer_id}", params
-            )
-          end
-        end
-      end
-    end
-  end
-end