suitcase 1.4.1 → 1.5.0

data/lib/suitcase/hotel/hotel.rb

@@ -52,7 +52,7 @@
   # Public: A Class representing a single Hotel. It provides methods for
   #         all Hotel EAN-related queries in the gem.
   class Hotel
-    extend Suitcase::Helpers
+    extend Helpers
 
     # Public: The Amenities that can be passed in to searches, and are returned
     #         from many queries.

data/lib/suitcase/hotel/location.rb

@@ -1,9 +1,8 @@
 module Suitcase
   class Hotel
     class Location
-      extend Suitcase::Helpers
-
-      attr_accessor :destination_id, :type, :active, :city, :province, :country, :country_code
+      attr_accessor :destination_id, :type, :active, :city, :province,
+                    :country, :country_code
 
       def initialize(info)
         info.each do |k, v|
@@ -12,12 +11,22 @@ module Suitcase
       end
 
       class << self
+        include Helpers
+
+        # Public: Find a Location.
+        #
+        # info - A Hash of information to search by, including city & address.
+        #
+        # Returns an Array of Location's.
         def find(info)
           params = {}
           [:city, :address].each do |dup|
             params[dup] = info[dup] if info[dup]
           end
-          params[:destinationString] = info[:destination_string]
+          if info[:destination_string]
+            params[:destinationString] = info[:destination_string]
+          end
+
           if Configuration.cache? and Configuration.cache.cached?(:geoSearch, params)
             raw = Configuration.cache.get_query(:geoSearch, params)
           else
@@ -25,12 +34,22 @@ module Suitcase
             raw = parse_response(url)
             handle_errors(raw)
           end
+          
           parse(raw)
         end
 
         def parse(raw)
           [raw["LocationInfoResponse"]["LocationInfos"]["LocationInfo"]].flatten.map do |raw|
-            Location.new(:province => raw["stateProvinceCode"], :destination_id => raw["destinationId"], :type => raw["type"], :city => raw["city"], :active => raw["active"], :code => raw["code"], :country => raw["country"], :country_code => raw["countryCode"]) 
+            Location.new(
+              province: raw["stateProvinceCode"],
+              destination_id: raw["destinationId"],
+              type: raw["type"],
+              city: raw["city"],
+              active: raw["active"],
+              code: raw["code"],
+              country: raw["country"],
+              country_code: raw["countryCode"]
+            ) 
           end
         end
 
@@ -39,6 +58,7 @@ module Suitcase
           if info[key] && info[key]["EanWsError"]
             message = info[key]["EanWsError"]["presentationMessage"]
           end
+          
           raise EANException.new(message) if message
         end
       end

data/lib/suitcase/hotel/nightly_rate.rb

@@ -2,10 +2,13 @@ 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"]
-      promo = info["@rate"]
-      promo = info["@baseRate"]
+      @promo = info["@promo"]
+      @rate = info["@rate"]
+      @base_rate = info["@baseRate"]
     end
   end
 end

data/lib/suitcase/hotel/payment_option.rb

@@ -1,30 +1,41 @@
 module Suitcase
-  class PaymentOption
-   attr_accessor :code, :name
-   extend Suitcase::Helpers
+  class Hotel
+    class PaymentOption
+      attr_accessor :code, :name
 
-    def initialize(code, name)
-      @code = code
-      @name = name
-    end
+      extend Helpers
 
-    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?      
+      # 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
-      options = []
-      types_raw["HotelPaymentResponse"].each do |raw|
-        types = raw[0] != "PaymentType" ? [] : raw[1]
-        types.each do |type|
-          options.push PaymentOption.new(type["code"], type["name"])
+
+      # 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
-      update_session(types_raw, info[:session])
-      options
     end
   end
-end
+ end

data/lib/suitcase/hotel/reservation.rb

@@ -1,9 +1,14 @@
 module Suitcase
-  class Reservation
-    attr_accessor :itinerary_id, :confirmation_numbers
+  class Hotel
+    class Reservation
+      attr_accessor :itinerary_id, :confirmation_numbers
 
-    def initialize(info)
-      @itinerary_id, @confirmation_numbers = info[:itinerary_id], [info[:confirmation_numbers]].flatten
+      # 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
+      end
     end
   end
 end

data/lib/suitcase/hotel/room.rb

@@ -1,77 +1,94 @@
 module Suitcase
-  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
+  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
 
-    extend Suitcase::Helpers
+      extend Helpers
 
-    def initialize(info)
-      info.each do |k, v|
-        instance_variable_set("@" + k.to_s, v)
+      # 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
-    end
 
-    def reserve!(info)
-      params = {}
-      params["hotelId"] = @hotel_id
-      params["arrivalDate"] = @arrival
-      params["departureDate"] = @departure
-      params["supplierType"] = @supplier_type
-      params["rateKey"] = @rate_key
-      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]
-      params["emailIntineraryList"] = info[:additional_emails].join(",") if info[:additional_emails]
-      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"] = (expiration_date[:mon].to_s.length == 1 ? "0" + expiration_date[:mon].to_s : expiration_date[:mon].to_s)
-      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
-        params["room#{index}SmokingPreference"] = room[:smoking_preference] or "E"
+      # 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
+        params["rateKey"] = @rate_key
+        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]
+        params["emailIntineraryList"] = info[:additional_emails].join(",") if info[:additional_emails]
+        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"] = (expiration_date[:mon].to_s.length == 1 ? "0" + expiration_date[:mon].to_s : expiration_date[:mon].to_s)
+        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
+          params["room#{index}SmokingPreference"] = room[:smoking_preference] or "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.new(itinerary_id: parsed["HotelRoomReservationResponse"]["itineraryId"], confirmation_numbers: parsed["HotelRoomReservationResponse"]["confirmationNumbers"])
       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.new(itinerary_id: parsed["HotelRoomReservationResponse"]["itineraryId"], confirmation_numbers: parsed["HotelRoomReservationResponse"]["confirmationNumbers"])
-    end
 
-    def chargeable_rate
-      if @supplier_type == "E"
-        @total_price
-      else
-        @max_nightly_rate
+      # 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
     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/version.rb

@@ -1,3 +1,3 @@
 module Suitcase
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/test/hotels/amenity_test.rb

@@ -1,23 +1,23 @@
 require "minitest_helper"
 
-describe Suitcase::Amenity do
+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::Amenity.parse_mask(5).must_equal [:business_services, :hot_tub]
+        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::Amenity.parse_mask(0).must_equal []
+        Suitcase::Hotel::Amenity.parse_mask(0).must_equal []
       end
     end
 
     describe "when provided bitmask is nil" do
       it "returns nil" do
-        Suitcase::Amenity.parse_mask(nil).must_equal nil
+        Suitcase::Hotel::Amenity.parse_mask(nil).must_equal nil
       end
     end
   end  
-end
+end

data/test/hotels/caching_test.rb

@@ -16,7 +16,7 @@ describe Suitcase do
     room = hotel.rooms(arrival: "6/23/2012", departure: "6/30/2012").first
     
     # Query 4
-    Suitcase::PaymentOption.find currency_code: "USD"
+    Suitcase::Hotel::PaymentOption.find currency_code: "USD"
     
     # Query 5, don't cache though
     room.rooms[0][:bed_type] = room.bed_types[0]
@@ -30,13 +30,13 @@ describe Suitcase do
     hotel = Suitcase::Hotel.find(id: 123904)
     Suitcase::Hotel.find(location: "Boston, US")
     hotel.rooms(arrival: "6/23/2012", departure: "6/30/2012")
-    Suitcase::PaymentOption.find currency_code: "USD"
+    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: "6/23/2012", departure: "6/30/2012")
-    Suitcase::PaymentOption.find currency_code: "USD"
+    Suitcase::Hotel::PaymentOption.find currency_code: "USD"
   end
-end
+end

data/test/hotels/helpers_test.rb

@@ -1,8 +1,8 @@
 require "minitest_helper"
 
-describe Suitcase::Helpers do
+describe Suitcase::Hotel::Helpers do
   before :each do
-    class Dummy; extend Suitcase::Helpers; end
+    class Dummy; extend Suitcase::Hotel::Helpers; end
   end
 
   describe "#url" do
@@ -41,4 +41,4 @@ describe Suitcase::Helpers do
       signature.must_equal(Digest::MD5.hexdigest("abc12310"))
     end
   end
-end
+end

data/test/hotels/payment_option_test.rb

@@ -1,15 +1,15 @@
 require "minitest_helper"
 
-describe Suitcase::PaymentOption do
+describe Suitcase::Hotel::PaymentOption do
   before :each do
     @info = { currency_code: "USD" }
   end
   
   describe ".find" do
     it "returns an Array of PaymentOption's" do
-      options = Suitcase::PaymentOption.find(@info)
+      options = Suitcase::Hotel::PaymentOption.find(@info)
       options.must_be_kind_of(Array)
-      options.first.must_be_kind_of(Suitcase::PaymentOption)
+      options.first.must_be_kind_of(Suitcase::Hotel::PaymentOption)
     end
   end
 end