expedia_api 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b2e963a92b9fb5748913fa71a88baeb90a09cac
-  data.tar.gz: eff17ac196c142285af7d1c0fe03ebccfc5a532f
+  metadata.gz: 00c0cba3e1f70e0d30b927589783bf263ec9e4c8
+  data.tar.gz: 8bc3717b0d80eae5ebb27494ab4f1af29d47a0b6
 SHA512:
-  metadata.gz: 2e86a0518e2c89db58511d7dd372acc777ef857dfbbe6bfba73effb04b17b3e8ff7c2d1053a02aa150ba96e6f204133be0bd7ebcc6087f4ad850936b20b9ed11
-  data.tar.gz: 6d607f38dd76980073eb06bfbe6ba83b4c415d6fdec3dae7283739893ee5b480919ad85f646b801039b0b6ecb4f89d3f9e723ac2ee54e75d25844646ede90fce
+  metadata.gz: 69e61b3e88dbee6ec9aafea1224e6d17b75099c5dbd113fb04c85ee86807637c1d595b7f646691fd0753294c7693cd11a6548c7ad770b0142210c3b821bad219
+  data.tar.gz: 371056c4370c0216119f7ffa2d5167d865e0ae7a10a30026497147f4a63ce8e1b285f8e4e4aca9f6ceb7403125870311665ad0fd06a459b1c693b4493104278f

data/lib/expedia_api/entities/package.rb

@@ -33,6 +33,11 @@ module ExpediaApi
           nil
         end
       end
+
+      # returns the details url for the package
+      def details_url
+        raw_data[:DetailsUrl]
+      end
     end
   end
 end

data/lib/expedia_api/entities/package_flight.rb

@@ -1,47 +1,27 @@
 module ExpediaApi
   module Entities
     class PackageFlight
-      attr_reader :raw_data
-
       def initialize(raw_data)
         @raw_data = raw_data || {}
       end
 
+      # returns the flight identifier for the given flight.
       def index
-        raw_data[:FlightIndex].to_i
+        @raw_data[:FlightIndex].to_i
       end
 
+      # returns an array of flight legs for the given flight
       def flight_legs
         extract_flightlegs.map do |leg|
-          FlightLeg.new(leg)
+          PackageFlightLeg.new(leg)
         end
       end
 
+      # extracts the json of the flight legs from the data.
       def extract_flightlegs
-        raw_data.fetch(:FlightItinerary, {}).fetch(:FlightLeg, {})
-      end
-
-      class FlightLeg
-        def initialize(raw_data)
-          @raw_data = raw_data || {}
-        end
-
-        def segments
-          extract_segments.map do |segment|
-            FlightLegSegment.new(segment)
-          end
-        end
-
-        def extract_segments
-          @raw_data[:FlightSegment] || []
-        end
+        @raw_data.fetch(:FlightItinerary, {}).fetch(:FlightLeg, {})
       end
 
-      class FlightLegSegment
-        def initialize(raw_data)
-          @raw_data = raw_data || {}
-        end
-      end
     end
   end
 end

data/lib/expedia_api/entities/package_flight_leg.rb

@@ -0,0 +1,111 @@
+module ExpediaApi
+  module Entities
+    # wrapper class for each of the flight legs
+    class PackageFlightLeg
+
+      # The raw data by the API looks like this:
+      #
+      # {
+      #   "FlightDuration": "PT21H50M",
+      #   "FlightLegIndex": "1",
+      #   "FlightSegment": [
+      #     {
+      #       "ArrivalAirportCode": "DUS",
+      #       "ArrivalDateTime": "2016-09-07T08:30:00",
+      #       "CarrierCode": "AB",
+      #       "DepartureAirportCode": "HAM",
+      #       "DepartureDateTime": "2016-09-07T07:30:00",
+      #       "FlightDuration": "PT1H0M",
+      #       "FlightNumber": "6743",
+      #       "FlightSegmentIndex": "1"
+      #     },
+      #     {
+      #       "ArrivalAirportCode": "AUH",
+      #       "ArrivalDateTime": "2016-09-07T20:20:00",
+      #       "CarrierCode": "AB",
+      #       "DepartureAirportCode": "DUS",
+      #       "DepartureDateTime": "2016-09-07T11:30:00",
+      #       "FlightDuration": "PT6H50M",
+      #       "FlightNumber": "4008",
+      #       "FlightSegmentIndex": "2"
+      #     },
+      #     {
+      #       "ArrivalAirportCode": "SYD",
+      #       "ArrivalDateTime": "2016-09-08T17:55:00",
+      #       "CarrierCode": "AB",
+      #       "DepartureAirportCode": "AUH",
+      #       "DepartureDateTime": "2016-09-07T21:55:00",
+      #       "FlightDuration": "PT14H0M",
+      #       "FlightNumber": "4070",
+      #       "FlightSegmentIndex": "3"
+      #     }
+      #   ]
+      # }
+      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|
+            PackageFlightLegSegment.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[:FlightSegment] || []
+      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[:FlightLegIndex].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/package_flight_leg_segment.rb

@@ -0,0 +1,126 @@
+module ExpediaApi
+  module Entities
+    # class handling each of the flight legs segments
+    #
+    # receives data in this format:
+    # {
+    #   "FlightSegmentIndex"=>"2",
+    #   "DepartureAirportCode"=>"SAW",
+    #   "ArrivalAirportCode"=>"DXB",
+    #   "DepartureDateTime"=>"2016-05-31T21:45:00",
+    #   "ArrivalDateTime"=>"2016-06-01T03:20:00",
+    #   "CarrierCode"=>"PC",
+    #   "FlightNumber"=>"5660",
+    #   "FlightDuration"=>"PT4H35M"
+    # }
+    class PackageFlightLegSegment
+
+      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[:FlightSegmentIndex].to_i
+      end
+
+      # returns the carrier code of the segment
+      def carrier_code
+        @raw_data[:CarrierCode]
+      end
+
+      # returns the departure airport code of the segment
+      def departure_airport_code
+        @raw_data[:DepartureAirportCode]
+      end
+
+      # returns the arrival airport code of the segment
+      def arrival_airport_code
+        @raw_data[:ArrivalAirportCode]
+      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/entities/package_hotel.rb

@@ -10,6 +10,16 @@ module ExpediaApi
       def index
         raw_data[:HotelIndex].to_i
       end
+
+      # returns the hotel id
+      def id
+        raw_data[:HotelID].to_i
+      end
+
+      # returns the name of the hotel
+      def name
+        raw_data[:Name]
+      end
     end
   end
 end

data/lib/expedia_api/version.rb

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

data/lib/expedia_api.rb

@@ -11,6 +11,8 @@ require "expedia_api/entities"
 require "expedia_api/entities/search_entity"
 require "expedia_api/entities/package"
 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/response_lists"
 require "expedia_api/response_lists/base_response_list"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expedia_api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Hendrik Kleinwaechter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,6 +158,8 @@ files:
 - lib/expedia_api/entities.rb
 - lib/expedia_api/entities/package.rb
 - lib/expedia_api/entities/package_flight.rb
+- lib/expedia_api/entities/package_flight_leg.rb
+- lib/expedia_api/entities/package_flight_leg_segment.rb
 - lib/expedia_api/entities/package_hotel.rb
 - lib/expedia_api/entities/search_entity.rb
 - lib/expedia_api/http_service.rb