expedia_api 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00c0cba3e1f70e0d30b927589783bf263ec9e4c8
-  data.tar.gz: 8bc3717b0d80eae5ebb27494ab4f1af29d47a0b6
+  metadata.gz: 5e6ebd0c3a9096821ea7f7af3733dc9e581979a5
+  data.tar.gz: 640d4ed2e77bce8a2a5bb211074a9ab211457886
 SHA512:
-  metadata.gz: 69e61b3e88dbee6ec9aafea1224e6d17b75099c5dbd113fb04c85ee86807637c1d595b7f646691fd0753294c7693cd11a6548c7ad770b0142210c3b821bad219
-  data.tar.gz: 371056c4370c0216119f7ffa2d5167d865e0ae7a10a30026497147f4a63ce8e1b285f8e4e4aca9f6ceb7403125870311665ad0fd06a459b1c693b4493104278f
+  metadata.gz: 7f7de3574914acf821fbf26221cf4e1bc80c84a3228b5e9bf6d3a43ff4cf09d7a1ecb5c208ecc89c1604a8bda27da93baa37c33501f574f431aa0f9a00a49dfb
+  data.tar.gz: 11ff20b25f339faf3c5f0e479707322b1c42c76655ccd51d951b6c5b7c4b956f152fabb57609f35990467393dd6a0421ae550806e6d4a05043d79b0dac15c4e3

data/lib/expedia_api/client.rb

@@ -90,6 +90,21 @@ module ExpediaApi
       ExpediaApi::ResponseLists::Hotels.new(exception: e)
     end
 
+    def search_flights(from_date:, to_date:, from_airport:, to_airport:, other_options: {})
+      parameters = {adult:1}.merge(other_options)
+      path_uri = build_package_search_request_path(from_airport: from_airport, to_airport: to_airport, from_date: from_date, to_date: to_date)
+      # build the url for the request to match the specifications
+      path_uri = build_flight_search_request_path(from_airport: from_airport, to_airport: to_airport, from_date: from_date, to_date: to_date)
+      base_uri = "/xmlapi/rest/air/v2/airsearch"
+      full_uri = "#{base_uri}/#{path_uri}"
+      data = request(parameters: parameters, uri: full_uri)
+      ExpediaApi::ResponseLists::Flights.new(response: data)
+    rescue Faraday::ParsingError => e
+      ExpediaApi::ResponseLists::Flights.new(exception: e)
+    rescue Faraday::ConnectionFailed => e
+      ExpediaApi::ResponseLists::Flights.new(exception: e)
+    end
+
     def search_packages(hotel_ids: [], region_ids: [], from_date:, to_date:, from_airport:, to_airport:, other_options: {})
       # convert/validate the parameters. the api expects a comma separated
       # string.
@@ -130,5 +145,10 @@ module ExpediaApi
       "#{from_date}/#{from_airport}/#{to_airport}/#{to_date}/#{to_airport}/#{from_airport}"
     end
 
+    def build_flight_search_request_path(from_airport:, to_airport:, from_date:, to_date:)
+      from_date = from_date.strftime("%F")
+      to_date   = to_date.strftime("%F")
+      "#{from_date}/#{from_airport}/#{to_airport}/#{to_date}/#{to_airport}/#{from_airport}"
+    end
   end
 end

data/lib/expedia_api/entities/flight_combination.rb

@@ -0,0 +1,31 @@
+module ExpediaApi
+  module Entities
+    class FlightCombination
+      attr_accessor :outbound_leg, :return_leg, :cheapest_combination_price
+      attr_reader :raw_data
+
+      def initialize(raw_data)
+        @raw_data = raw_data || {}
+      end
+
+      def piid
+        @raw_data[:PIID]
+      end
+
+      #returns a money object including the price. returns nil if there is no price
+      def total_price
+        if raw_data[:PriceInformation] && raw_data[:PriceInformation][:TotalPrice]
+          Money.new(raw_data[:PriceInformation][:TotalPrice][:Value].to_f * 100, raw_data[:PriceInformation][:TotalPrice][:CurrencyCode])
+        else
+          nil
+        end
+      end
+
+      def price_difference_to_cheapest_combination
+        return nil unless total_price && cheapest_combination_price
+        total_price - Money.new(cheapest_combination_price[:Value].to_f * 100, cheapest_combination_price[:CurrencyCode])
+      end
+
+    end
+  end
+end

data/lib/expedia_api/entities/flight_combination_leg.rb

@@ -0,0 +1,157 @@
+module ExpediaApi
+  module Entities
+    # wrapper class for each of the flight legs
+    class FlightCombinationLeg
+
+      # The raw data by the API looks like this:
+      #
+      # {
+      #   "AirLegIndex":1,
+      #   "AirSegmentList":{
+      #     "AirSegment":[
+      #       {
+      #         "AirCarrierCode": "AF",
+      #         "AirProviderCode": "1",
+      #         "AirSegmentIndex":1,
+      #         "ArrivalDateTime": "2016-09-07T08:50:00+02:00",
+      #         "ArrivalLocationCode": "CDG",
+      #         "DepartureDateTime": "2016-09-07T07:00:00+02:00",
+      #         "DepartureLocationCode": "TXL",
+      #         "FlightDuration": "PT1H50M",
+      #         "FlightNumber": "1135",
+      #         "OperationSegmentList":{
+      #           "OperationSegment":[
+      #             {
+      #               "AircraftCode": "320",
+      #               "ArrivalDateTime": "2016-09-07T08:50:00+02:00",
+      #               "ArrivalLocationCode": "CDG",
+      #               "DepartureDateTime": "2016-09-07T07:00:00+02:00",
+      #               "DepartureLocationCode": "TXL",
+      #               "FlightDuration": "PT1H50M",
+      #               "OperationSegmentIndex":1
+      #             }
+      #           ]
+      #         }
+      #       },
+      #       {
+      #         "AirCarrierCode": "TN",
+      #         "AirProviderCode": "1",
+      #         "AirSegmentIndex":2,
+      #         "ArrivalDateTime": "2016-09-07T22:00:00-10:00",
+      #         "ArrivalLocationCode": "PPT",
+      #         "DepartureDateTime": "2016-09-07T11:30:00+02:00",
+      #         "DepartureLocationCode": "CDG",
+      #         "FlightDuration": "PT22H30M",
+      #         "FlightNumber": "7",
+      #         "OperationSegmentList":{
+      #           "OperationSegment":[
+      #             {
+      #               "AircraftCode": "343",
+      #               "ArrivalDateTime": "2016-09-07T22:00:00-10:00",
+      #               "ArrivalLocationCode": "PPT",
+      #               "DepartureDateTime": "2016-09-07T11:30:00+02:00",
+      #               "DepartureLocationCode": "CDG",
+      #               "FlightDuration": "PT22H30M",
+      #               "OperationSegmentIndex":1
+      #             }
+      #           ]
+      #         }
+      #       },
+      #       {
+      #         "AirCarrierCode": "VT",
+      #         "AirProviderCode": "1",
+      #         "AirSegmentIndex":3,
+      #         "ArrivalDateTime": "2016-09-08T07:35:00-10:00",
+      #         "ArrivalLocationCode": "BOB",
+      #         "DepartureDateTime": "2016-09-08T06:45:00-10:00",
+      #         "DepartureLocationCode": "PPT",
+      #         "FlightDuration": "PT50M",
+      #         "FlightNumber": "487",
+      #         "OperationSegmentList":{
+      #           "OperationSegment":[
+      #             {
+      #               "AircraftCode": "AT7",
+      #               "ArrivalDateTime": "2016-09-08T07:35:00-10:00",
+      #               "ArrivalLocationCode": "BOB",
+      #               "DepartureDateTime": "2016-09-08T06:45:00-10:00",
+      #               "DepartureLocationCode": "PPT",
+      #               "FlightDuration": "PT50M",
+      #               "OperationSegmentIndex":1
+      #             }
+      #           ]
+      #         }
+      #       }
+      #     ]
+      #   },
+      #   "FlightDuration": "PT36H35M0S",
+      #   "TotalStops":2
+      # }
+
+      def initialize(raw_data)
+        @raw_data = raw_data || {}
+      end
+
+      # returns the flight segments of the flight
+      def segments
+        @segments ||= begin
+          segments = extract_segments.map do |segment|
+            FlightCombinationLegSegment.new(segment)
+          end
+          segments.each do |segment|
+            segment.sibling_segments = segments
+          end
+          segments
+        end
+      end
+
+      # extracts the segments of the flight from the json
+      def extract_segments
+        @raw_data[:AirSegmentList][:AirSegment] || []
+      end
+
+      # returns the total time it will in seconds.
+      #
+      # format by expedia: "PT21H50M"
+      def total_duration_seconds
+        hours   = hours_all_segments
+        minutes = minutes_all_segments
+        if hours && minutes
+          hours * 3600 + minutes * 60
+        else
+          0
+        end
+      end
+
+      # returns the hours of the flight, if nor parsable, returns nil
+      def hours_all_segments
+        stamp = @raw_data[:FlightDuration].split("PT")[1]
+        stamp.split("H")[0].to_i
+      rescue
+        nil
+      end
+
+      # returns the minutes of the flight, if nor parsable, returns nil
+      def minutes_all_segments
+        stamp = @raw_data[:FlightDuration].split("PT")[1]
+        stamp.split("H")[1].split("M")[0].to_i
+      rescue
+        nil
+      end
+
+      # returns the index of the flight leg
+      def index
+        @raw_data[:AirLegIndex].to_i
+      end
+
+      # returns true if we have a to flight
+      def is_to_flight?
+        index == 1
+      end
+
+      # returns true if we have a return flight leg.
+      def is_return_flight?
+        index == 2
+      end
+    end
+  end
+end

data/lib/expedia_api/entities/flight_combination_leg_segment.rb

@@ -0,0 +1,140 @@
+module ExpediaApi
+  module Entities
+    # class handling each of the flight legs segments
+    #
+    # receives data in this format:
+    # {
+    #   "AirCarrierCode": "AF",
+    #   "AirProviderCode": "1",
+    #   "AirSegmentIndex":1,
+    #   "ArrivalDateTime": "2016-09-07T08:50:00+02:00",
+    #   "ArrivalLocationCode": "CDG",
+    #   "DepartureDateTime": "2016-09-07T07:00:00+02:00",
+    #   "DepartureLocationCode": "TXL",
+    #   "FlightDuration": "PT1H50M",
+    #   "FlightNumber": "1135",
+    #   "OperationSegmentList":{
+    #     "OperationSegment":[
+    #       {
+    #         "AircraftCode": "320",
+    #         "ArrivalDateTime": "2016-09-07T08:50:00+02:00",
+    #         "ArrivalLocationCode": "CDG",
+    #         "DepartureDateTime": "2016-09-07T07:00:00+02:00",
+    #         "DepartureLocationCode": "TXL",
+    #         "FlightDuration": "PT1H50M",
+    #         "OperationSegmentIndex":1
+    #       }
+    #     ]
+    #   }
+    # }
+    class FlightCombinationLegSegment
+
+      attr_accessor :sibling_segments
+
+      def initialize(raw_data)
+        @raw_data         = raw_data || {}
+        @sibling_segments = []
+      end
+
+      # returns a departure datetime for the departure time of the segment
+      def departure_time
+        DateTime.parse(@raw_data[:DepartureDateTime])
+      end
+
+      # returns a datetime for the arrival date of the segment
+      def arrival_time
+        DateTime.parse(@raw_data[:ArrivalDateTime])
+      end
+
+      # returns the index of the segment
+      def index
+        @raw_data[:AirSegmentIndex]
+      end
+
+      # returns the carrier code of the segment
+      def carrier_code
+        @raw_data[:AirCarrierCode]
+      end
+
+      # returns the departure airport code of the segment
+      def departure_airport_code
+        @raw_data[:DepartureLocationCode]
+      end
+
+      # returns the arrival airport code of the segment
+      def arrival_airport_code
+        @raw_data[:ArrivalLocationCode]
+      end
+
+      # returns the time between this segment and the next one.
+      def stay_duration_seconds
+        return 0 unless next_segment
+        # when we arrive at the next airport, minus when we arrived at this
+        # airport.
+        (next_segment.departure_time.to_time - arrival_time.to_time).to_i
+      end
+
+      # returns the duration how long the segment takes. returns 0 if it can
+      # not be identified.
+      def duration_seconds
+        hours   = hours_flight
+        minutes = minutes_flight
+        if hours && minutes
+          hours * 3600 + minutes * 60
+        else
+          0
+        end
+      end
+
+      # returns the hours of the flight, if nor parsable, returns nil
+      def hours_flight
+        stamp = @raw_data[:FlightDuration].split("PT")[1]
+        stamp.split("H")[0].to_i
+      rescue
+        nil
+      end
+
+      # returns the minutes of the flight, if nor parsable, returns nil
+      def minutes_flight
+        stamp = @raw_data[:FlightDuration].split("PT")[1]
+        stamp.split("H")[1].split("M")[0].to_i
+      rescue
+        nil
+      end
+
+      # returns the flight number of the flight
+      def flight_number
+        @raw_data[:FlightNumber]
+      end
+
+      # returns true if it is the last segment of the flight
+      def is_last_segment_of_flight?
+        return true if sibling_segments.empty?
+        sibling_segments.sort_by {|segment| segment.index }.reverse.first == self
+      end
+
+      # returns true if it is the first segment of the flight
+      def is_first_segment_of_flight?
+        return true if sibling_segments.empty?
+        sibling_segments.sort_by {|segment| segment.index }.first == self
+      end
+
+      # returns the next segment followed by this segment
+      def next_segment
+        return nil if sibling_segments.empty?
+        sibling_segments[sibling_segments.sort_by(&:index).index(self) + 1]
+      end
+
+      # returns the previous segment preceeded by this segment
+      def previous_segment
+        return nil if sibling_segments.empty?
+        index = sibling_segments.sort_by(&:index).index(self)
+        if index && index >= 1
+          sibling_segments[index - 1]
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/expedia_api/response_lists/flights.rb

@@ -0,0 +1,54 @@
+module ExpediaApi
+  module ResponseLists
+    class Flights < BaseResponseList
+      def entries=(entries)
+        @entries = entries
+      end
+
+      def extract_entries_from_response(response)
+        json = extract_data_from_response(response).with_indifferent_access
+        return [] if json.empty?
+        # dup?
+        json = json.with_indifferent_access
+        outbound_legs_json = json["AirLegListCollection"]["AirLegList"][0]["AirLeg"]
+        return_legs_json   = json["AirLegListCollection"]["AirLegList"][1]["AirLeg"]
+        products_json      = JSON.parse(response.body).with_indifferent_access[:AirProductList][:AirProduct]
+        outbound_legs      = extract_legs(outbound_legs_json)
+        return_legs        = extract_legs(return_legs_json)
+        combinations       = extract_combinations(products_json, outbound_legs:outbound_legs, return_legs:return_legs)
+        combinations
+      end
+
+      # returns legs for each of the entries
+      def extract_legs(legs_json)
+        legs_json.map do |json|
+          ExpediaApi::Entities::FlightCombinationLeg.new(json)
+        end
+      end
+
+      # returns packages for each of the json data
+      def extract_combinations(products_json, outbound_legs:, return_legs:)
+        # combination_pairs, [outbound_leg_id, return_leg_id, raw_data]
+        combination_pairs = products_json.map do |json|
+          reference_json = json[:AirLegReferenceList][:AirLegReference]
+          [reference_json[0]["AirLegIndex"], reference_json[1]["AirLegIndex"], json]
+        end
+        outbound_legs_by_index = outbound_legs.map{|leg| [leg.index, leg]}.to_h
+        return_legs_by_index   = return_legs.map{|leg| [leg.index, leg]}.to_h
+        cheapest_price = cheapest_combination_price(products_json)
+        combination_pairs.map do |outbound_leg_id, return_leg_id, raw_data|
+          entity = ExpediaApi::Entities::FlightCombination.new(raw_data)
+          entity.outbound_leg = outbound_legs_by_index[outbound_leg_id]
+          entity.return_leg   = return_legs_by_index[return_leg_id]
+          entity.cheapest_combination_price = cheapest_price
+          entity
+        end
+      end
+
+      def cheapest_combination_price(products_json)
+        products_json.min{|p| p[:PriceInformation][:TotalPrice][:Value].to_f}[:PriceInformation][:TotalPrice]
+      end
+
+    end
+  end
+end

data/lib/expedia_api/response_lists/packages.rb

@@ -7,12 +7,12 @@ module ExpediaApi
       end
 
       def extract_entries_from_response(response)
-        json = extract_data_from_response(response).with_indifferent_access
-        return [] if json.empty?
-        json = json.with_indifferent_access
-        flights  = extract_flights(json[:FlightList][:Flight])
-        hotels   = extract_hotels(json[:HotelList][:Hotel])
-        packages = extract_packages(json["PackageSearchResultList"]["PackageSearchResult"], hotels: hotels, flights: flights)
+        json     = extract_data_from_response(response)
+        return   [] if json.is_a?(Array) || json.empty?
+        json     = json.with_indifferent_access
+        flights  = extract_flights(extract_raw_flights_from_json(json))
+        hotels   = extract_hotels(extract_raw_hotels_from_json(json))
+        packages = extract_packages(extract_raw_packages_from_json(json), hotels: hotels, flights: flights)
         packages
       end
 
@@ -46,6 +46,33 @@ module ExpediaApi
           entity
         end
       end
+
+      # returns the flight data extracted from the json
+      def extract_raw_flights_from_json(json)
+        if json[:FlightList] && json[:FlightList][:Flight]
+          json[:FlightList][:Flight]
+        else
+          []
+        end
+      end
+
+      # returns the hotel data extracted fron the json
+      def extract_raw_hotels_from_json(json)
+        if json[:HotelList] && json[:HotelList][:Hotel]
+          json[:HotelList][:Hotel]
+        else
+          []
+        end
+      end
+
+      # returns the package data extracted from the json
+      def extract_raw_packages_from_json(json)
+        if json[:PackageSearchResultList] && json[:PackageSearchResultList][:PackageSearchResult]
+          json[:PackageSearchResultList][:PackageSearchResult]
+        else
+          []
+        end
+      end
     end
 
   end

data/lib/expedia_api/version.rb

@@ -1,3 +1,3 @@
 module ExpediaApi
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/expedia_api.rb

@@ -14,10 +14,14 @@ require "expedia_api/entities/package_flight"
 require "expedia_api/entities/package_flight_leg"
 require "expedia_api/entities/package_flight_leg_segment"
 require "expedia_api/entities/package_hotel"
+require "expedia_api/entities/flight_combination"
+require "expedia_api/entities/flight_combination_leg"
+require "expedia_api/entities/flight_combination_leg_segment"
 require "expedia_api/response_lists"
 require "expedia_api/response_lists/base_response_list"
 require "expedia_api/response_lists/packages"
 require "expedia_api/response_lists/hotels"
+require "expedia_api/response_lists/flights"
 
 module ExpediaApi
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expedia_api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Hendrik Kleinwaechter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,9 @@ files:
 - lib/expedia_api.rb
 - lib/expedia_api/client.rb
 - lib/expedia_api/entities.rb
+- lib/expedia_api/entities/flight_combination.rb
+- lib/expedia_api/entities/flight_combination_leg.rb
+- lib/expedia_api/entities/flight_combination_leg_segment.rb
 - lib/expedia_api/entities/package.rb
 - lib/expedia_api/entities/package_flight.rb
 - lib/expedia_api/entities/package_flight_leg.rb
@@ -165,6 +168,7 @@ files:
 - lib/expedia_api/http_service.rb
 - lib/expedia_api/response_lists.rb
 - lib/expedia_api/response_lists/base_response_list.rb
+- lib/expedia_api/response_lists/flights.rb
 - lib/expedia_api/response_lists/hotels.rb
 - lib/expedia_api/response_lists/packages.rb
 - lib/expedia_api/version.rb