Flight offers search and flight choice prediction v2 (#48)

* Add support for Flight Offers Search and Flight Choice Prediction v2

Author: anthonyroux

README.md

@@ -180,11 +180,12 @@ amadeus.shopping.flight_destinations.get(origin: 'MAD')
 # Flight Cheapest Date Search
 amadeus.shopping.flight_dates.get(origin: 'MAD', destination: 'MUC')
 
-# Flight Low-fare Search
-amadeus.shopping.flight_offers.get(origin: 'NYC', destination: 'MAD', departureDate: '2020-08-01')
+# Flight Offers Search
+amadeus.shopping.flight_offers_search.get(originLocationCode: 'NYC', destinationLocationCode: 'MAD', departureDate: '2020-10-01', adults: 1)
 
-# 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-11-01').body)
+# 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
+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')

lib/amadeus.rb

@@ -28,8 +28,8 @@
 require 'amadeus/namespaces/reference_data/locations/points_of_interest'
 require 'amadeus/namespaces/reference_data/locations/points_of_interest/by_square'
 require 'amadeus/namespaces/shopping/flight_destinations'
-require 'amadeus/namespaces/shopping/flight_offers'
-require 'amadeus/namespaces/shopping/flight_offers/prediction'
+require 'amadeus/namespaces/shopping/flight_offers_search'
+require 'amadeus/namespaces/shopping/flight_offers_search/prediction'
 require 'amadeus/namespaces/shopping/flight_dates'
 require 'amadeus/namespaces/shopping/hotel_offers'
 require 'amadeus/namespaces/shopping/hotel_offer'

lib/amadeus/namespaces/shopping.rb

@@ -23,12 +23,12 @@ def flight_destinations
 
       # The namespace for the FlightOffers API:
       #
-      # @return [Amadeus::Namespaces::Shopping::FlightOffers]
+      # @return [Amadeus::Namespaces::Shopping::FlightOffersSearch]
       # @example
-      #   amadeus.shopping.flight_offers
+      #   amadeus.shopping.flight_offers_search
       #
-      def flight_offers
-        Amadeus::Namespaces::Shopping::FlightOffers.new(client)
+      def flight_offers_search
+        Amadeus::Namespaces::Shopping::FlightOffersSearch.new(client)
       end
 
       # The namespace for the FlightDates API:

lib/amadeus/namespaces/shopping/flight_offers.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Amadeus
+  module Namespaces
+    class Shopping
+      # A namespaced client for the
+      # +/v2/shopping/flight-offers+ endpoints
+      #
+      # Access via the +Amadeus::Client+ object
+      #
+      #   amadeus = Amadeus::Client.new
+      #   amadeus.shopping.flight_offers_search
+      #
+      class FlightOffersSearch < Amadeus::Client::Decorator
+        # The namespace for the Prediction API:
+        #
+        # @return [Amadeus::Namespaces::Shopping::FlightOffersSearch::Prediction]
+        # @example
+        #   amadeus.shopping.flight_offers_search.prediction
+        #
+        def prediction
+          Amadeus::Namespaces::Shopping::FlightOffersSearch::Prediction.new(client)
+        end
+        # Find the cheapest bookable flights.
+        #
+        # @option params [String] :origin City/Airport IATA code from which the
+        #   flight will depart. BOS, for example.
+        # @option params [String] :destination City/Airport IATA code to which
+        #   the traveler is going. PAR, for example
+        # @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 October 2020
+        #   amadeus.shopping.flight_offers_search.get(
+        #     originLocationCode: 'NYC',
+        #     destinationLocationCode: 'MAD',
+        #     departureDate: '2020-10-01',
+        #     adults: 1
+        #   )
+        #
+
+        def get(params = {})
+          client.get('/v2/shopping/flight-offers', params)
+        end
+
+        # Find the cheapest bookable flights.
+        #
+        # @option body [JSON] :body flight search parameters
+        # @return [Amadeus::Response] a parsed response
+        # @raise [Amadeus::Base] an exception if the call
+        #   failed
+        # @example
+        #   amadeus.shopping.flight_offers_search.post(body)
+        #
+        def post(params = {})
+          client.post('/v2/shopping/flight-offers', params)
+        end
+      end
+    end
+  end
+end

lib/amadeus/namespaces/shopping/flight_offers_search.rb

@@ -3,27 +3,28 @@
 module Amadeus
   module Namespaces
     class Shopping
-      class FlightOffers
+      class FlightOffersSearch
         # A namespaced client for the
-        # +/v1/shopping/flight-offers/prediction+ endpoints
+        # +/v2/shopping/flight-offers/prediction+ endpoints
         #
         # Access via the +Amadeus::Client+ object
         #
         #   amadeus = Amadeus::Client.new
-        #   amadeus.shopping.flight-offers.prediction
+        #   amadeus.shopping.flight_offers_search.prediction
         #
         class Prediction < Amadeus::Client::Decorator
           # Returns a list of flight offers including a choice prediction for each itineary.
           #
-          # @option body [JSON] :body JSON response of the Flight Low-fare Search API
+          # @option body [JSON] :body JSON response of the Flight Offers Search API
           # @return [Amadeus::Response] a parsed response
           # @raise [Amadeus::Base] an exception if the call
           #   failed
           # @example
-          #   amadeus.shopping.flight_offers.prediction.post(flight_offers_response.body)
+          #   amadeus.shopping.flight_offers_search.prediction.post(
+          #    flight_offers_search_response.body)
           #
           def post(params = {})
-            client.post('/v1/shopping/flight-offers/prediction', params)
+            client.post('/v2/shopping/flight-offers/prediction', params)
           end
         end
       end

lib/amadeus/namespaces/shopping/flight_offers/prediction.rb renamed to lib/amadeus/namespaces/shopping/flight_offers_search/prediction.rb

@@ -99,18 +99,18 @@
       end
     end
 
-    describe '.shopping.flight_offers' do
-      it 'should return a FlightOffers object' do
-        expect(@amadeus.shopping.flight_offers).to(
-          be_instance_of Amadeus::Namespaces::Shopping::FlightOffers
+    describe '.shopping.flight_offers_search' do
+      it 'should return a FlightOffersSearch object' do
+        expect(@amadeus.shopping.flight_offers_search).to(
+          be_instance_of Amadeus::Namespaces::Shopping::FlightOffersSearch
         )
       end
     end
 
-    describe '.shopping.flight_offers.prediction' do
+    describe '.shopping.flight_offers_search.prediction' do
       it 'should return a Prediction object' do
-        expect(@amadeus.shopping.flight_offers.prediction).to(
-          be_instance_of Amadeus::Namespaces::Shopping::FlightOffers::Prediction
+        expect(@amadeus.shopping.flight_offers_search.prediction).to(
+          be_instance_of Amadeus::Namespaces::Shopping::FlightOffersSearch::Prediction
         )
       end
     end

spec/namespaces/namespaces_spec.rb

@@ -2,26 +2,26 @@
 
 require 'spec_helper'
 
-RSpec.describe Amadeus::Namespaces::Shopping::FlightOffers::Prediction do
+RSpec.describe Amadeus::Namespaces::Shopping::FlightOffersSearch::Prediction do
   before do
     @client = double('Amadeus::Client')
-    @api = Amadeus::Namespaces::Shopping::FlightOffers::Prediction.new(@client)
+    @api = Amadeus::Namespaces::Shopping::FlightOffersSearch::Prediction.new(@client)
   end
 
   describe '.post' do
     it 'should call client.post with the right body' do
       body = { foo: :bar }
 
       expect(@client).to receive(:post).with(
-        '/v1/shopping/flight-offers/prediction', body
+        '/v2/shopping/flight-offers/prediction', body
       )
 
       @api.post(body)
     end
 
     it 'should default to an empty hash' do
       expect(@client).to receive(:post).with(
-        '/v1/shopping/flight-offers/prediction', {}
+        '/v2/shopping/flight-offers/prediction', {}
       )
 
       @api.post

spec/namespaces/shopping/flight_offers/prediction_spec.rb renamed to spec/namespaces/shopping/flight_offers_search/prediction_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Amadeus::Namespaces::Shopping::FlightOffersSearch do
+  before do
+    @client = double('Amadeus::Client')
+    @api = Amadeus::Namespaces::Shopping::FlightOffersSearch.new(@client)
+  end
+
+  describe '.get' do
+    it 'should call client.get with the right params' do
+      params = { originLocationCode: 'LHR',
+                 destinationLocationCode: 'LAX',
+                 departureDate: '202020-12-01' }
+
+      expect(@client).to receive(:get).with(
+        '/v2/shopping/flight-offers', params
+      )
+
+      @api.get(params)
+    end
+  end
+
+  describe '.post' do
+    it 'should call client.get with the right params' do
+      body = { foo: :bar }
+
+      expect(@client).to receive(:post).with(
+        '/v2/shopping/flight-offers', body
+      )
+
+      @api.post(body)
+    end
+
+    it 'should default to an empty hash' do
+      expect(@client).to receive(:get).with(
+        '/v2/shopping/flight-offers', {}
+      )
+
+      @api.get
+    end
+  end
+end