suitcase 1.2.0.pre → 1.2.0

data/README.md

@@ -16,6 +16,7 @@ First, configure the library:
       Suitcase::Configuration.hotel_api_key = "..." # set the Hotel API key from developer.ean.com
       Suitcase::Configuration.cid = "..." # set the CID from developer.ean.com
       Suitcase::Configuration.cache = Hash.new # set the caching mechanism (see below)
+      Suitcase::Configuration.session_cache = Hash.new # set the session caching store (see below)
 
 Find nearby hotels:
 
@@ -25,8 +26,14 @@ Find nearby hotels:
 
 ### Caching
 
+#### Requests
+
 You can setup a cache to store all API requests that do not contain secure information (i.e. anything but booking requests). A cache needs to be able store deeply nested Hashes and have a method called [] to access them. An example of setting the cache is given above.
 
+#### Sessions
+
+You **must** also set up a cache to store user sessions. A session object simply stores the internal ID used by Expedia, the user agent, the IP address of the user, the user's locale, and the user's currency code. The store is configured similarly to the query store, and have the same requirements.
+
 Contributing
 ------------
 Please submit any useful pull requests through GitHub. If you find any bugs, please report them with the issue tracker! Thanks.

data/lib/suitcase.rb

@@ -3,11 +3,14 @@ require 'json'
 require 'net/http'
 require 'date/format'
 require 'time'
+require 'suitcase/session'
 require 'suitcase/core_ext/string'
 require 'suitcase/version'
 require 'suitcase/configuration'
+require 'suitcase/session_cache'
 require 'suitcase/cache'
 require 'suitcase/helpers'
+require 'suitcase/hotel/amenity'
 require 'suitcase/hotel/reservation'
 require 'suitcase/hotel/nightly_rate'
 require 'suitcase/hotel/room'

data/lib/suitcase/configuration.rb

@@ -6,7 +6,6 @@ module Suitcase
 
     def self.cache
       return @@cache if cache?
-      nil
     end
 
     def self.cache?
@@ -28,5 +27,17 @@ module Suitcase
     def self.hotel_cid
       @@hotel_cid if defined? @@hotel_cid
     end
+
+    def self.session_cache=(store)
+      @@session_cache = Suitcase::SessionCache.new(store)
+    end
+    
+    def self.session_cache
+      return @@session_cache if session_cache?
+    end
+
+    def self.session_cache?
+      defined? @@session_cache
+    end
   end
 end

data/lib/suitcase/hotel/amenity.rb

@@ -0,0 +1,9 @@
+module Suitcase
+  class Amenity
+    attr_accessor :id, :description
+    
+    def initialize(info)
+      @id, @description = info[:id], info[:description]
+    end
+  end
+end

data/lib/suitcase/hotel/hotel.rb

@@ -5,6 +5,7 @@ module Suitcase
     end
   end
 
+  # Used for organizing Bed options
   class BedType
     attr_accessor :id, :description
 
@@ -13,6 +14,10 @@ module Suitcase
     end
   end
 
+  # A Class representing a Hotel that stores information
+  # about the hotel. It provides methods for checking
+  # room availability, fetching images and just general
+  # information providing.
   class Hotel
     extend Suitcase::Helpers
 
@@ -26,14 +31,25 @@ module Suitcase
                   wheelchair_accessible: 8,
                   kitchen: 9 }
 
-    attr_accessor :id, :name, :address, :city, :min_rate, :max_rate, :amenities, :country_code, :high_rate, :low_rate, :longitude, :latitude, :rating, :postal_code, :supplier_type, :images, :nightly_rate_total
+    attr_accessor :id, :name, :address, :city, :province, :min_rate, :max_rate, :amenities, :country_code, :high_rate, :low_rate, :longitude, :latitude, :rating, :postal_code, :supplier_type, :images, :nightly_rate_total, :airport_code, :property_category, :confidence_rating, :amenity_mask, :location_description, :short_description, :hotel_in_destination, :proximity_distance
 
+    # Public: Initialize a new hotel
+    #
+    # info - a Hash of the options listed in attr_accesor.
+    #
+    # Returns a new Hotel object with the passed-in attributes.
     def initialize(info)
       info.each do |k, v|
         send (k.to_s + "=").to_sym, v
       end
     end
 
+    # Public: Find a Hotel based on known information
+    #
+    # info - a Hash of known information
+    #
+    # Returns a single Hotel if an id is passed in, otherwise
+    # an Array of Hotels.
     def self.find(info)
       if info[:id]
         find_by_id(info[:id])
@@ -42,6 +58,12 @@ module Suitcase
       end
     end
 
+    # Public: Find a Hotel by it's id.
+    #
+    # id - an Integer or String representation of the Hotel's
+    #      id.
+    #
+    # Returns a single Hotel object.
     def self.find_by_id(id)
       params = { hotelId: id }
       if Configuration.cache? and Configuration.cache.cached?(:info, params)
@@ -55,44 +77,57 @@ module Suitcase
       Hotel.new(hotel_data)
     end
 
+    # Public: Find a hotel by info other than it's id.
+    #
+    # info - a Hash of options described in the Hotel
+    #        accessors, excluding the id.
+    #
+    # Returns an Array of Hotels.
     def self.find_by_info(info)
       params = info
       params["numberOfResults"] = params[:results] ? params[:results] : 10
       params.delete(:results)
       params["destinationString"] = params[:location]
       params.delete(:location)
-      if params[:amenities]
-        params[:amenities].inject("") { |old, new| old + AMENITIES[new].to_s + "," }
-        amenities =~ /^(.+),$/
-        amenities = $1
-      end
+      amenities = params[:amenities] ? params[:amenities].map { |amenity| old + AMENITIES[amenity] }.join(",") : nil
       params["minRate"] = params[:min_rate] if params[:min_rate]
       params["maxRate"] = params[:max_rate] if params[:max_rate]
-      params[:amenities] = amenities
+      params[:amenities] = amenities if amenities
       hotels = []
       parsed = parse_response(url(:list, params))
       handle_errors(parsed)
       split(parsed).each do |hotel_data|
         hotels.push Hotel.new(parse_information(hotel_data))
       end
-      hotels
+      params[:results] ? hotels[0..params[:results]-1] : hotels
     end
 
+    # Public: Parse the information returned by a search request
+    #
+    # parsed - a Hash representing the parsed JSON
+    #
+    # Returns a reformatted Hash with the specified accessors.
     def self.parse_information(parsed)
       handle_errors(parsed)
       summary = parsed["hotelId"] ? parsed : parsed["HotelInformationResponse"]["HotelSummary"]
-      parsed_info = { id: summary["hotelId"], name: summary["name"], address: summary["address1"], city: summary["city"], postal_code: summary["postalCode"], country_code: summary["countryCode"], rating: summary["hotelRating"], high_rate: summary["highRate"], low_rate: summary["lowRate"], latitude: summary["latitude"].to_f, longitude: summary["longitude"].to_f }
+      parsed_info = { id: summary["hotelId"], name: summary["name"], address: summary["address1"], city: summary["city"], postal_code: summary["postalCode"], country_code: summary["countryCode"], rating: summary["hotelRating"], high_rate: summary["highRate"], low_rate: summary["lowRate"], latitude: summary["latitude"].to_f, longitude: summary["longitude"].to_f, province: summary["stateProvinceCode"], airport_code: summary["airportCode"], property_category: summary["propertyCategory"].to_i, proximity_distance: summary["proximityDistance"].to_s + summary["proximityUnit"].to_s }
+      parsed_info[:amenities] = parsed["HotelInformationResponse"]["PropertyAmenities"]["PropertyAmenity"].map { |x| Amenity.new(id: x["amenityId"], description: x["amenity"]) } if parsed["HotelInformationResponse"]
       parsed_info[:images] = images(parsed) if images(parsed)
       parsed_info
     end
 
+    # Public: Get images from a parsed object
+    #
+    # parsed - a Hash representing the parsed JSON
+    #
+    # Returns an Array of Suitcase::Images.
     def self.images(parsed)
-      return parsed["HotelInformationResponse"]["HotelImages"]["HotelImage"].map { |image_data| Suitcase::Image.new(image_data) } if parsed["HotelInformationResponse"] && parsed["HotelInformationResponse"]["HotelImages"] && parsed["HotelInformationResponse"]["HotelImages"]["HotelImage"]
-      return [Suitcase::Image.new("thumbnailURL" => "http://images.travelnow.com" + parsed["thumbNailUrl"])] unless parsed["thumbnailUrl"].nil? or parsed["thumbNailUrl"].empty?
-      return []
+      images = parsed["HotelInformationResponse"]["HotelImages"]["HotelImage"].map { |image_data| Suitcase::Image.new(image_data) } if parsed["HotelInformationResponse"] && parsed["HotelInformationResponse"]["HotelImages"] && parsed["HotelInformationResponse"]["HotelImages"]["HotelImage"]
+      images = [Suitcase::Image.new("thumbnailURL" => "http://images.travelnow.com" + parsed["thumbNailUrl"])] unless parsed["thumbNailUrl"].nil? or parsed["thumbNailUrl"].empty?
+      return images ? images : []
     end
 
-    # Bleghh. so ugly. #needsfixing
+    # Handle the errors from the response.
     def self.handle_errors(info)
       if info["HotelRoomAvailabilityResponse"] && info["HotelRoomAvailabilityResponse"]["EanWsError"]
         message = info["HotelRoomAvailabilityResponse"]["EanWsError"]["presentationMessage"]
@@ -114,6 +149,12 @@ module Suitcase
       first_image.thumbnail_url if first_image
     end
 
+    # Public: Fetch possible rooms from a Hotel.
+    #
+    # info - a Hash of options described as the accessors in
+    #        the Suitcase::Room class
+    #
+    # Returns an Array of Suitcase::Rooms.
     def rooms(info)
       params = { rooms: [{adults: 1, children_ages: []}] }.merge(info)
       params[:rooms].each_with_index do |room, n|

data/lib/suitcase/session.rb

@@ -0,0 +1,34 @@
+module Suitcase
+  class Session
+    attr_accessor :locale, :currency_code, :session_id, :ip_address, :user_agent
+
+    # Public: Instantiate a new session
+    #
+    # info -  a Hash of the attributes:
+    #         - locale: the user's locale
+    #         - currency_code: the user's currency code
+    #         - session_id: the session_id
+    #         - ip_address: the user's IP address (request.remote_ip)
+    #         - user_agent: the user's user agent
+    def initialize(info={})
+      %w(locale currency_code session_id ip_address user_agent).each do |attr|
+        send (attr + "=").to_sym, info[attr.to_sym]
+      end
+      Suitcase::Configuration.session_cache.push self
+    end
+
+    def delete(session_id)
+      Session.store.delete Session.store.find { |session| session.session_id == session_id }
+    end
+
+    def find_or_create(info)
+      session = Session.store.find { |session| session.session_id == session_id }
+      session = Session.new(info) unless session
+      session
+    end
+    
+    def self.store
+      Suitcase::Configuration.session_store
+    end
+  end
+end

data/lib/suitcase/session_cache.rb

@@ -0,0 +1,27 @@
+module Suitcase
+  class SessionCache
+    def initialize(store)
+      @store = store
+    end
+
+    def save_session(session)
+      @store.push session
+    end
+
+    def get_session(session_id)
+      @store.find { |session| session.session_id == session_id }
+    end
+
+    def delete_session(session_id)
+      @store.delete get_session(session_id)
+    end
+
+    def count
+      @store.count
+    end
+
+    def push(item)
+      @store.push item
+    end
+  end
+end

data/lib/suitcase/version.rb

@@ -1,3 +1,3 @@
 module Suitcase
-  VERSION = "1.2.0.pre"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: suitcase
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre
-  prerelease: 6
+  version: 1.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Walter Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-06 00:00:00.000000000 Z
+date: 2012-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16614460 !ruby/object:Gem::Requirement
+  requirement: &17296680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16614460
+  version_requirements: *17296680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16613580 !ruby/object:Gem::Requirement
+  requirement: &17294880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16613580
+  version_requirements: *17294880
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &16612360 !ruby/object:Gem::Requirement
+  requirement: &17293140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16612360
+  version_requirements: *17293140
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &16611740 !ruby/object:Gem::Requirement
+  requirement: &17308720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16611740
+  version_requirements: *17308720
 - !ruby/object:Gem::Dependency
   name: patron
-  requirement: &16611300 !ruby/object:Gem::Requirement
+  requirement: &17307560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16611300
+  version_requirements: *17307560
 description: Suitcase utilizes the EAN (Expedia.com) API for locating info about hotels,
   rental cars, and flights.
 email:
@@ -87,12 +87,15 @@ files:
 - lib/suitcase/core_ext/string.rb
 - lib/suitcase/country_codes.rb
 - lib/suitcase/helpers.rb
+- lib/suitcase/hotel/amenity.rb
 - lib/suitcase/hotel/hotel.rb
 - lib/suitcase/hotel/image.rb
 - lib/suitcase/hotel/nightly_rate.rb
 - lib/suitcase/hotel/payment_option.rb
 - lib/suitcase/hotel/reservation.rb
 - lib/suitcase/hotel/room.rb
+- lib/suitcase/session.rb
+- lib/suitcase/session_cache.rb
 - lib/suitcase/version.rb
 - spec/caching_spec.rb
 - spec/helpers_spec.rb
@@ -117,13 +120,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3770284806370543423
+      hash: 2063899818244561137
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 2063899818244561137
 requirements: []
 rubyforge_project: suitcase
 rubygems_version: 1.8.10