expedia_api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2087ea6d06f80910b08422290767099664c7025e
-  data.tar.gz: a16cde4dc03bf5dfbc040cc51682edbd8e4a4156
+  metadata.gz: b1fe7e96bee4a14c1f2667b22eb9da9f5445e5b8
+  data.tar.gz: 2d5f8165948ef02e8de35ce24698b2c4126829fa
 SHA512:
-  metadata.gz: ebb4d56de697d4dd04579880706b959a30e99737f5b23a6085475a003a0a6eb4ec97319c71ed68f187e41fad347834b8b34d3f1339cb1824db11175b6727793a
-  data.tar.gz: 8a559770123d2617f5d70518c41920ce16e4137c2b860b57ffa2f999cdea16fcc43b081d0caa972fbea7ca95d0a55dd9b0ca9ba78b448b7faced03bde316d9ba
+  metadata.gz: d04cde9d1f73bbadc2d939339a4393eccf50ce33fca9504b0b129588ad2ef6691878339e70e83ad918234e27bdea3231f867ea44bdb2497fc44ec87fadd8d458
+  data.tar.gz: d1d264980a237298402a4901d1dc2b2089396887338fbcac11a0b490c2c0b2d51f69cffe5dcb4f005ce3f25f881cc8fc41f2ba67ae15ab031bb7294ec5f03cba

data/README.md

@@ -1,5 +1,7 @@
 # Expedia Api
 
+[![Build Status](https://travis-ci.org/hendricius/expedia_api.svg?branch=master)](https://travis-ci.org/hendricius/expedia_api)
+
 This is a ruby wrapper for the official Expedia.com API. Please note that the Expedia.com API is a different than the one provided by the Expedia Affiliate Network. They are different companies. If you want to use the EAN Api please use [expedia gem](https://github.com/zaidakram/expedia).
 
 
@@ -39,9 +41,17 @@ Then when using the API create a new client object:
 
 ```
 client = ExpediaApi::Client.new
+```
+
+Search Hotels:
+```
 client.get_list({})
+```
 
+Search Packages:
 
+```
+client.search_packages({})
 ```
 
 The parameters you can pass to `get_list` are the following:

data/expedia_api.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.description       = "Expediacom is a lightweight flexible Ruby SDK for the official Expedia.com API"
   spec.summary           = "Wrapper for the Expedia.com API"
-  spec.homepage          = "https://github.com/hendricius/expediacom"
+  spec.homepage          = "https://github.com/hendricius/expedia_api"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency(%q<faraday>,       ["~> 0.8"])
   spec.add_runtime_dependency "faraday_middleware"
   spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "money", '~> 6'
 
 end

data/lib/expedia_api.rb

@@ -2,13 +2,20 @@ require 'json'
 require 'faraday'
 require 'faraday_middleware'
 require 'active_support/core_ext/hash/indifferent_access'
+require 'money'
 
 require "expedia_api/version"
 require "expedia_api/http_service"
 require "expedia_api/client"
-require "expedia_api/hotel_response_list"
 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_hotel"
+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"
 
 module ExpediaApi
   class << self

data/lib/expedia_api/client.rb

@@ -81,19 +81,48 @@ module ExpediaApi
     #     true
     #   description:
     #     return available hotels only. default: true
-    def get_list(parameters = {})
-      data = request(parameters: parameters)
-      ExpediaApi::HotelResponseList.new(response: data)
+    def search_hotels(parameters = {})
+      data = request(parameters: parameters, uri: 'wsapi/rest/hotel/v1/search')
+      ExpediaApi::ResponseLists::Hotels.new(response: data)
     rescue Faraday::ParsingError => e
-      ExpediaApi::HotelResponseList.new(exception: e)
+      ExpediaApi::ResponseLists::Hotels.new(exception: e)
     rescue Faraday::ConnectionFailed => e
-      ExpediaApi::HotelResponseList.new(exception: e)
+      ExpediaApi::ResponseLists::Hotels.new(exception: e)
+    end
+
+    def search_packages(hotel_ids: [], region_ids: [], from_date:, to_date:, from_airport:, to_airport:, other_options: {})
+      validate_package_arguments({hotel_ids: hotel_ids, region_ids: region_ids})
+      parameters = {}
+      parameters[:hotelids]  = hotel_ids   if hotel_ids.length
+      parameters[:regionids] = region_ids  if region_ids.length
+      path_uri = build_package_search_request_path(from_airport: from_airport, to_airport: to_airport, from_date: from_date, to_date: to_date)
+      base_uri = "/wsapi/rest/package/v1/search"
+      full_uri = "#{base_uri}/#{path_uri}"
+      data = request(parameters: parameters, uri: full_uri)
+      ExpediaApi::ResponseLists::Packages.new(response: data)
+    rescue Faraday::ParsingError => e
+      ExpediaApi::PackageResponseList.new(exception: e)
+    rescue Faraday::ConnectionFailed => e
+      ExpediaApi::PackageResponseList.new(exception: e)
     end
 
     private
 
-    def request(request_options: {}, parameters: {})
-      HTTPService.perform_request(request_options: request_options, parameters: parameters)
+    def request(request_options: {}, parameters: {}, uri:)
+      HTTPService.perform_request(request_options: request_options, parameters: parameters, uri: uri)
+    end
+
+    def validate_package_arguments(args)
+      if args[:hotel_ids].empty? && args[:region_ids].empty?
+        raise ArgumentError
+      end
+      true
+    end
+
+    def build_package_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

data/lib/expedia_api/entities/package.rb

@@ -0,0 +1,38 @@
+module ExpediaApi
+  module Entities
+    class Package
+      attr_accessor :flight, :hotel
+      attr_reader :raw_data
+
+      def initialize(raw_data)
+        @raw_data = raw_data || {}
+      end
+
+      def flight_index
+        raw_data[:FlightReferenceIndex].to_i
+      end
+
+      def hotel_index
+        raw_data[:HotelReferenceIndex].to_i
+      end
+
+      # returns a money object including the price. returns nil if there is no price
+      def price
+        if raw_data[:PackagePrice] && raw_data[:PackagePrice][:TotalPrice]
+          Money.new(raw_data[:PackagePrice][:TotalPrice][:Value].to_f * 100, raw_data[:PackagePrice][:TotalPrice][:Currency])
+        else
+          nil
+        end
+      end
+
+      # returns a money object with the savings, nil if there are no savings.
+      def savings
+        if raw_data[:PackagePrice] && raw_data[:PackagePrice][:TotalSavings]
+          Money.new(raw_data[:PackagePrice][:TotalSavings][:Value].to_f * 100, raw_data[:PackagePrice][:TotalSavings][:Currency])
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/expedia_api/entities/package_flight.rb

@@ -0,0 +1,47 @@
+module ExpediaApi
+  module Entities
+    class PackageFlight
+      attr_reader :raw_data
+
+      def initialize(raw_data)
+        @raw_data = raw_data || {}
+      end
+
+      def index
+        raw_data[:FlightIndex].to_i
+      end
+
+      def flight_legs
+        extract_flightlegs.map do |leg|
+          FlightLeg.new(leg)
+        end
+      end
+
+      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
+      end
+
+      class FlightLegSegment
+        def initialize(raw_data)
+          @raw_data = raw_data || {}
+        end
+      end
+    end
+  end
+end

data/lib/expedia_api/entities/package_hotel.rb

@@ -0,0 +1,15 @@
+module ExpediaApi
+  module Entities
+    class PackageHotel
+      attr_reader :raw_data
+
+      def initialize(raw_data)
+        @raw_data = raw_data || {}
+      end
+
+      def index
+        raw_data[:HotelIndex].to_i
+      end
+    end
+  end
+end

data/lib/expedia_api/http_service.rb

@@ -2,7 +2,6 @@ module ExpediaApi
   module HTTPService
 
     API_SERVER = 'ews.expedia.com'
-    API_PATH   = 'wsapi/rest/hotel/v1/search'
 
     class << self
 
@@ -24,14 +23,14 @@ module ExpediaApi
         options
       end
 
-      def perform_request(request_options: {}, parameters: {})
+      def perform_request(request_options: {}, parameters: {}, uri:)
         args = common_parameters.merge(parameters)
         # figure out our options for this request
         # set up our Faraday connection
         connection = Faraday.new(faraday_options) do |faraday|
           faraday.adapter  Faraday.default_adapter
         end
-        connection.get(API_PATH, args)
+        connection.get(uri, args)
       end
 
       def use_proxy?

data/lib/expedia_api/response_lists.rb

@@ -0,0 +1,4 @@
+module ExpediaApi
+  module ResponseLists
+  end
+end

data/lib/expedia_api/response_lists/base_response_list.rb

@@ -0,0 +1,75 @@
+module ExpediaApi
+  module ResponseLists
+    class BaseResponseList
+      include Enumerable
+      attr_reader :response, :exception
+
+      def initialize(entries: [], response: nil, exception: nil)
+        @response    = response
+        @exception   = exception
+      end
+
+      def each(&block)
+        entries.each(&:block)
+      end
+
+      def map(&block)
+        entries.map(&:block)
+      end
+
+      def first
+        entries.first
+      end
+
+      def last
+        entries.last
+      end
+
+      def entries
+        @entries ||= begin
+          self.entries = extract_entries_from_response(@response)
+          self.entries
+        end
+      end
+
+      def entries=(entries)
+        raise ArgumentError, "implement me"
+      end
+
+      def success?
+        exception.nil?
+      end
+
+      def error?
+        !!exception
+      end
+
+      def extract_entries_from_response(response)
+        raise ArgumentError, "implement me"
+      end
+
+      private
+
+      # extracts an array of data from the response
+      #
+      # returns an array.
+      def extract_data_from_response(response)
+        if response.nil?
+          return []
+        end
+        body = nil
+        begin
+          body = JSON.parse(response.body)
+        rescue JSON::ParserError => e
+          @exception = e
+          return []
+        end
+        if !body.is_a?(Hash) || body.nil?
+          return []
+        end
+        body
+      end
+
+    end
+  end
+end

data/lib/expedia_api/response_lists/hotels.rb

@@ -0,0 +1,28 @@
+module ExpediaApi
+  module ResponseLists
+    class Hotels < BaseResponseList
+
+      def entries=(entries)
+        if entries
+          @entries = entries.map {|e| ExpediaApi::Entities::SearchEntity.new(e.with_indifferent_access) }
+        else
+          @entries = []
+        end
+      end
+
+      def extract_entries_from_response(response)
+        body = extract_data_from_response(response)
+        return [] if body.empty?
+        hotel_count = body["HotelCount"].to_i
+        if hotel_count == 1
+          [body["HotelInfoList"]["HotelInfo"]]
+        elsif hotel_count > 1
+          body["HotelInfoList"]["HotelInfo"]
+        else
+          []
+        end
+      end
+
+    end
+  end
+end

data/lib/expedia_api/response_lists/packages.rb

@@ -0,0 +1,46 @@
+module ExpediaApi
+  module ResponseLists
+    class Packages < 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?
+        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)
+        packages
+      end
+
+      # returns flights for each of the entries
+      def extract_flights(flights_json)
+        # right now only 1 flight
+        [ExpediaApi::Entities::PackageFlight.new(flights_json)]
+      end
+
+      # returns hotels for each hotel in the json
+      def extract_hotels(hotels_json)
+        hotels_json.map do |hotel|
+          ExpediaApi::Entities::PackageHotel.new(hotel)
+        end
+      end
+
+      # returns packages for each of the json data
+      def extract_packages(json, flights:, hotels:)
+        flights_by_index = flights.map {|flight| [flight.index, flight]}.to_h
+        hotels_by_index  = hotels.map {|hotel| [hotel.index, hotel]}.to_h
+        json.map do |package|
+          entity = ExpediaApi::Entities::Package.new(package)
+          entity.flight = flights_by_index[entity.flight_index]
+          entity.hotel  = hotels_by_index[entity.hotel_index]
+          entity
+        end
+      end
+    end
+
+  end
+end

data/lib/expedia_api/version.rb

@@ -1,3 +1,3 @@
 module ExpediaApi
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expedia_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Hendrik Kleinwaechter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
 description: Expediacom is a lightweight flexible Ruby SDK for the official Expedia.com
   API
 email:
@@ -142,11 +156,17 @@ files:
 - lib/expedia_api.rb
 - lib/expedia_api/client.rb
 - lib/expedia_api/entities.rb
+- lib/expedia_api/entities/package.rb
+- lib/expedia_api/entities/package_flight.rb
+- lib/expedia_api/entities/package_hotel.rb
 - lib/expedia_api/entities/search_entity.rb
-- lib/expedia_api/hotel_response_list.rb
 - 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/hotels.rb
+- lib/expedia_api/response_lists/packages.rb
 - lib/expedia_api/version.rb
-homepage: https://github.com/hendricius/expediacom
+homepage: https://github.com/hendricius/expedia_api
 licenses: []
 metadata: {}
 post_install_message: 

data/lib/expedia_api/hotel_response_list.rb

@@ -1,73 +0,0 @@
-module ExpediaApi
-  class HotelResponseList
-    include Enumerable
-    attr_reader :response, :exception
-
-    def initialize(entries: [], response: nil, exception: nil)
-      @response = response
-      self.entries = extract_entries_from_response(response)
-      @exception = exception
-    end
-
-    def each(&block)
-      @entries.each(&:block)
-    end
-
-    def map(&block)
-      @entries.map(&:block)
-    end
-
-    def first
-      @entries.first
-    end
-
-    def last
-      @entries.last
-    end
-
-    def entries
-      @entries
-    end
-
-    def entries=(entries)
-      @entries = entries.map {|e| ExpediaApi::Entities::SearchEntity.new(e.with_indifferent_access) }
-    end
-
-    def success?
-      exception.nil?
-    end
-
-    def error?
-      !!exception
-    end
-
-    def response_body
-    end
-
-    def extract_entries_from_response(response)
-      # probably an error ocurred connecting
-      if response.nil?
-        return []
-      end
-      body = nil
-      begin
-        body = JSON.parse(response.body)
-      rescue JSON::ParserError => e
-        @exception = e
-        return []
-      end
-      if !body.is_a?(Hash) || body.nil?
-        return []
-      end
-      hotel_count = body["HotelCount"].to_i
-      if hotel_count == 1
-        [body["HotelInfoList"]["HotelInfo"]]
-      elsif hotel_count > 1
-        body["HotelInfoList"]["HotelInfo"]
-      else
-        []
-      end
-    end
-
-  end
-end