rthbound-suitcase 1.7.1

data/lib/suitcase/hotel/nightly_rate.rb

@@ -0,0 +1,14 @@
+module Suitcase
+  class NightlyRate
+    attr_accessor :promo, :rate, :base_rate
+
+    # Internal: Create a NightlyRate from the API response.
+    #
+    # info - A Hash from the API response containing nightly rate information.
+    def initialize(info)
+      @promo = info["@promo"]
+      @rate = info["@rate"]
+      @base_rate = info["@baseRate"]
+    end
+  end
+end

data/lib/suitcase/hotel/payment_option.rb

@@ -0,0 +1,41 @@
+module Suitcase
+  class Hotel
+    class PaymentOption
+      attr_accessor :code, :name
+
+      extend Helpers
+
+      # Internal: Create a PaymentOption.
+      #
+      # code - The String code from the API response (e.g. "VI").
+      # name - The String name of the PaymentOption.
+      def initialize(code, name)
+        @code, @name = code, name
+      end
+
+      # Public: Find PaymentOptions for a specific currency.
+      #
+      # info - A Hash of information with one key: :currency_code.
+      #
+      # Returns an Array of PaymentOption's.
+      def self.find(info)
+        params = { "currencyCode" => info[:currency_code] }
+
+        if Configuration.cache? and Configuration.cache.cached?(:paymentInfo, params)
+          types_raw = Configuration.cache.get_query(:paymentInfo, params)
+        else
+          types_raw = parse_response(url(:method => "paymentInfo", :params => params, :session => info[:session]))
+          Configuration.cache.save_query(:paymentInfo, params, types_raw) if Configuration.cache?      
+        end
+        update_session(types_raw, info[:session])
+
+        types_raw["HotelPaymentResponse"].map do |raw|
+          types = raw[0] != "PaymentType" ? [] : raw[1]
+          types.map do |type|
+            PaymentOption.new(type["code"], type["name"])
+          end
+        end.flatten
+      end
+    end
+  end
+ end

data/lib/suitcase/hotel/reservation.rb

@@ -0,0 +1,15 @@
+module Suitcase
+  class Hotel
+    class Reservation
+      attr_accessor :itinerary_id, :confirmation_numbers, :raw, :surcharges
+
+      # Internal: Create a new Reservation from the API response.
+      #
+      # info - The Hash of information returned from the API.
+      def initialize(info)
+        @itinerary_id, @confirmation_numbers = info[:itinerary_id], [info[:confirmation_numbers]].flatten
+        @surcharges = info[:surcharges]
+      end
+    end
+  end
+end

data/lib/suitcase/hotel/room.rb

@@ -0,0 +1,138 @@
+module Suitcase
+  class Hotel
+    class Room
+      attr_accessor :rate_key, :hotel_id, :supplier_type, :rate_code,
+                    :room_type_code, :supplier_type, :tax_rate, :non_refundable,
+                    :occupancy, :quoted_occupancy, :min_guest_age, :total,
+                    :surcharge_total, :nightly_rate_total, :average_base_rate,
+                    :average_rate, :max_nightly_rate, :currency_code, :value_adds,
+                    :room_type_description, :price_breakdown, :total_price,
+                    :average_nightly_rate, :promo, :arrival, :departure, :rooms,
+                    :bed_types, :cancellation_policy, :non_refundable,
+                    :guarantee_required, :deposit_required, :surcharges,
+                    :rate_description, :raw, :rate_change, :guarantee_only
+
+      extend Helpers
+      include Helpers
+
+      # Internal: Create a new Room from within a Room search query.
+      #
+      # info  - A Hash of parsed information from the API, with any of the keys
+      #         from the attr_accessor's list.
+      def initialize(info)
+        info.each do |k, v|
+          instance_variable_set("@" + k.to_s, v)
+        end
+      end
+
+      # Public: Reserve a room.
+      #
+      # info - A Hash of the information described on the Suitcase
+      #       [wiki](http://github.com/thoughtfusion/suitcase/wiki/User-flow).
+      #
+      # Returns a Suitcase::Reservation.
+      def reserve!(info)
+        params = {}
+        params["hotelId"] = @hotel_id
+        params["arrivalDate"] = @arrival
+        params["departureDate"] = @departure
+        params["supplierType"] = @supplier_type
+        # Only submit the rateKey if it is a merchant hotel
+        params["rateKey"] = @rate_key if @supplier_type == "E"
+        params["rateTypeCode"] = @room_type_code
+        params["rateCode"] = @rate_code
+        params["roomTypeCode"] = @room_type_code
+        params["chargeableRate"] = chargeable_rate      
+        params["email"] = info[:email]
+        params["firstName"] = info[:first_name]
+        params["lastName"] = info[:last_name]
+        params["homePhone"] = info[:home_phone]
+        params["workPhone"] = info[:work_phone] if info[:work_phone]
+        params["extension"] = info[:work_phone_extension] if info[:work_phone_extension]
+        params["faxPhone"] = info[:fax_phone] if info[:fax_phone]
+        params["companyName"] = info[:company_name] if info[:company_name]
+        if info[:additional_emails]
+          params["emailIntineraryList"] = info[:additional_emails].join(",")
+        end
+        params["creditCardType"] = info[:payment_option].code
+        params["creditCardNumber"] = info[:credit_card_number]
+        params["creditCardIdentifier"] = info[:credit_card_verification_code]
+        expiration_date = Date._parse(info[:credit_card_expiration_date])
+        params["creditCardExpirationMonth"] = if expiration_date[:mon] < 10
+                                                "0" + expiration_date[:mon].to_s
+                                              else
+                                                expiration_date[:mon].to_s
+                                              end
+        params["creditCardExpirationYear"] = expiration_date[:year].to_s
+        params["address1"] = info[:address1]
+        params["address2"] = info[:address2] if info[:address2]
+        params["address3"] = info[:address3] if info[:address3]
+        params["city"] = info[:city]
+        @rooms.each_with_index do |room, index|
+          index += 1
+          params["room#{index}"] = "#{room[:adults].to_s},#{room[:children_ages].join(",")}"
+          params["room#{index}FirstName"] = room[:first_name] || params["firstName"] # defaults to the billing
+          params["room#{index}LastName"] = room[:last_name] || params["lastName"] # person's name
+          params["room#{index}BedTypeId"] = room[:bed_type].id if @supplier_type == "E"
+          params["room#{index}SmokingPreference"] = room[:smoking_preference] || "E"
+        end
+        params["stateProvinceCode"] = info[:province]
+        params["countryCode"] = info[:country]
+        params["postalCode"] = info[:postal_code]
+
+        uri = Room.url(
+          method: "res",
+          params: params,
+          include_key: true,
+          include_cid: true,
+          secure: true
+        )
+        session = Patron::Session.new
+        session.timeout = 30000
+        session.base_url = "https://" + uri.host
+        res = session.post uri.request_uri, {}
+        parsed = JSON.parse res.body
+
+        reservation_res = parsed["HotelRoomReservationResponse"]
+        handle_errors(parsed)
+        rate_info = reservation_res["RateInfos"]["RateInfo"]
+        surcharges = if @supplier_type == "E" && rate_info["ChargeableRateInfo"]["Surcharges"]
+          [rate_info["ChargeableRateInfo"]["Surcharges"]["Surcharge"]].
+            flatten.map { |s| Surcharge.parse(s) }
+        else
+          []
+        end
+        r = Reservation.new(
+          itinerary_id: reservation_res["itineraryId"],
+          confirmation_numbers: reservation_res["confirmationNumbers"],
+          surcharges: surcharges 
+        )
+        r.raw = parsed
+        r
+      end
+
+      # Public: The chargeable rate for the Hotel room.
+      #
+      # Returns the chargeable rate for the Room.
+      def chargeable_rate
+        if @supplier_type == "E"
+          @total_price
+        else
+          @max_nightly_rate
+        end
+      end
+      
+      # Public: The description of the displayed rate.
+      #
+      # Returns the rate description based on the `rate_change` attribute.
+      def room_rate_description
+        if @rate_change
+          "rate changes during the dates requested and the single nightly rate displayed is the highest nightly rate of the dates requested without taxes and fees."
+        else
+          "highest single night rate during the dates selected without taxes or fees"
+        end
+      end
+    end
+  end
+end
+

data/lib/suitcase/hotel/session.rb

@@ -0,0 +1,7 @@
+module Suitcase
+  class Hotel
+    # Public: Hold user session data. A simple Struct provided to be passed in
+    #         to some of the EAN methods.
+    Session = Struct.new(:id, :user_agent, :ip_address, :locale, :currency_code)
+  end
+end

data/lib/suitcase/hotel/surcharge.rb

@@ -0,0 +1,23 @@
+module Suitcase
+  class Hotel
+    # Public: A Surcharge represents a single surcharge on a Room.
+    class Surcharge
+      attr_accessor :amount, :type
+      # Internal: Create a new Surcharge.
+      #
+      # info - A Hash of parsed info from Surcharge.parse.
+      def initialize(info)
+        @amount, @type = info[:amount], info[:type]
+      end
+
+      # Internal: Parse a Surcharge from the room response.
+      #
+      # info - A Hash of the parsed JSON relevant to the surhcarge.
+      #
+      # Returns a Surcharge representing the info.
+      def self.parse(info)
+        new(amount: info["@amount"], type: info["@type"])
+      end
+    end
+  end
+end

data/lib/suitcase/version.rb

@@ -0,0 +1,3 @@
+module Suitcase
+  VERSION = "1.7.1"
+end

data/rthbound-suitcase.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "suitcase/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rthbound-suitcase"
+  s.version     = Suitcase::VERSION
+  s.authors     = ["Walter Nelson", "Tad Hosford"]
+  s.email       = ["tad@isotope11.com"]
+  s.homepage    = "http://github.com/rthbound/suitcase"
+  s.summary     = %q{Locates available hotels and rental cars through Expedia and Hotwire.  This is a fork of Walter Nelson's gem - suitcase}
+  s.description = %q{Ruby library that utilizes the EAN (Expedia.com) API for locating available hotels and the Hotwire API for rental cars.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "turn"
+
+  s.add_development_dependency "chronic"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+
+  s.add_runtime_dependency "json"
+  s.add_runtime_dependency "patron"
+end

data/test/car_rentals/car_rental_test.rb

@@ -0,0 +1,30 @@
+require "minitest_helper"
+
+describe Suitcase::CarRental do
+  before :each do
+    info = {
+      destination: "Seattle",
+      start_date: "07/04/2012",
+      end_date: "07/11/2012",
+      pickup_time: "07:30",
+      dropoff_time: "11:30"
+    }
+    @rentals = Suitcase::CarRental.find(info)
+    @rental = @rentals.first
+  end
+  
+  [:seating, :type_name, :type_code, :possible_features,
+  :possible_models].each do |accessor|
+    it "has an accessor #{accessor}" do
+      @rental.must_respond_to(accessor)
+      @rental.must_respond_to((accessor.to_s + "=").to_sym)
+    end
+  end
+  
+  describe ".find" do
+    it "returns an Array of CarRental's" do
+      @rentals.must_be_kind_of(Array)
+      @rental.must_be_kind_of(Suitcase::CarRental)
+    end
+  end
+end

data/test/hotels/amenity_test.rb

@@ -0,0 +1,23 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::Amenity do
+  describe ".parse_mask" do
+    describe "when provided bitmask is not nil or 0" do
+      it "returns an Array of Symbols representing given Amenities" do
+        Suitcase::Hotel::Amenity.parse_mask(5).must_equal [:business_services, :hot_tub]
+      end
+    end
+
+    describe "when bitmask is 0" do
+      it "returns an empty Array" do
+        Suitcase::Hotel::Amenity.parse_mask(0).must_equal []
+      end
+    end
+
+    describe "when provided bitmask is nil" do
+      it "returns nil" do
+        Suitcase::Hotel::Amenity.parse_mask(nil).must_equal nil
+      end
+    end
+  end  
+end

data/test/hotels/caching_test.rb

@@ -0,0 +1,42 @@
+require "minitest_helper"
+
+describe Suitcase do
+  before :each do
+    Suitcase::Configuration.cache = {}
+  end
+
+  it "caches all non-secure queries" do
+    # Query 1
+    hotel = Suitcase::Hotel.find(id: 123904)
+    
+    # Query 2
+    Suitcase::Hotel.find(location: "Boston, US")
+    
+    # Query 3
+    room = hotel.rooms(arrival: Keys::RESERVATION_START_TIME, departure: Keys::RESERVATION_END_TIME).first
+    
+    # Query 4
+    Suitcase::Hotel::PaymentOption.find currency_code: "USD"
+    
+    # Query 5, don't cache though
+    room.rooms[0][:bed_type] = room.bed_types[0]
+    room.rooms[0][:smoking_preference] = "NS"
+    room.reserve!(Keys::VALID_RESERVATION_INFO)
+
+    Suitcase::Configuration.cache.keys.count.must_equal 4
+  end
+
+  it "retrieves from the cache if it's there" do
+    hotel = Suitcase::Hotel.find(id: 123904)
+    Suitcase::Hotel.find(location: "Boston, US")
+    hotel.rooms(arrival: Keys::RESERVATION_START_TIME, departure: Keys::RESERVATION_END_TIME)
+    Suitcase::Hotel::PaymentOption.find currency_code: "USD"
+    
+    # Disable API access
+    Net::HTTP.expects(:get_response).never
+    hotel = Suitcase::Hotel.find(id: 123904)
+    Suitcase::Hotel.find(location: "Boston, US")
+    hotel.rooms(arrival: Keys::RESERVATION_START_TIME, departure: Keys::RESERVATION_END_TIME)
+    Suitcase::Hotel::PaymentOption.find currency_code: "USD"
+  end
+end

data/test/hotels/ean_exception_test.rb

@@ -0,0 +1,24 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::EANException do
+  before :each do
+    @exception = Suitcase::Hotel::EANException.new(nil)
+  end
+
+  it "has an accessor recovery" do
+    @exception.must_respond_to(:recovery)
+    @exception.must_respond_to(:recovery=)
+  end
+
+  describe "#recoverable" do
+    it "returns true if the recovery attribute is set" do
+      @exception.recovery = { locations: ["London", "New London"] }
+      @exception.recoverable?.must_equal(true)
+    end
+
+    it "returns false if the recovery attribute is not set" do
+      @exception.recovery = nil
+      @exception.recoverable?.must_equal(false)
+    end
+  end
+end

data/test/hotels/helpers_test.rb

@@ -0,0 +1,52 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::Helpers do
+  before :each do
+    class Dummy; extend Suitcase::Hotel::Helpers; end
+  end
+
+  describe "#url" do
+    it "returns a URI with the proper base URL" do
+      url = Dummy.url(method: "action", params: {})
+      url.must_be_kind_of(URI)
+      url.host.must_match(/api.ean.com/)
+    end
+
+    describe "when using digital signature authorization" do
+      it "adds a 'sig' parameter" do
+        Suitcase::Configuration.expects(:use_signature_auth?).returns(true)
+        Dummy.expects(:generate_signature).returns("test")
+
+        url = Dummy.url(method: "action", params: {})
+        url.query.must_match(/sig=test/)
+      end
+    end
+  end
+
+  describe "#parse_response" do
+    it "raises an exception when passed an invalid URI" do
+      proc do
+        Dummy.parse_response(URI.parse("http://google.com"))
+      end.must_raise JSON::ParserError
+    end
+
+    it "raises an error if a 403 code is received" do
+      proc do
+        response = FakeResponse.new(code: 403, body: "<h1>An error occurred.</h1>")
+        Net::HTTP.stubs(:get_response).returns(response)
+        Dummy.parse_response(URI.parse("http://fake.response.will.be.used"))
+      end.must_raise Suitcase::Hotel::EANException
+    end
+  end
+
+  describe "#generate_signature" do
+    it "returns the encrypted API key, shared secret, and timestamp" do
+      Suitcase::Configuration.expects(:hotel_api_key).returns("abc")
+      Suitcase::Configuration.expects(:hotel_shared_secret).returns("123")
+      Time.expects(:now).returns("10")
+
+      signature = Dummy.generate_signature
+      signature.must_equal(Digest::MD5.hexdigest("abc12310"))
+    end
+  end
+end