suitcase 1.2.5 → 1.2.6

data/README.md

@@ -1,4 +1,4 @@
-Suitcase ![build status](https://secure.travis-ci.org/thoughtfusion/suitcase.png)
+Suitcase
 ========
 
 Suitcase is a Ruby library that utilizes the EAN (Expedia.com) API for locating available hotels, rental cars, and flights.
@@ -16,23 +16,19 @@ 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:
 
       hotels = Suitcase::Hotel.find(:location => 'Boston, MA', :results => 10) # Returns 10 closest hotels to Boston, MA
       room = hotels.first.rooms(arrival: "2/19/2012", departure: "2/26/2012", rooms: [{ children: 1, ages: [8] }, { children: 1, ages: [12] }] # Check the availability of two rooms at that hotel with 1 child in each room of ages 8 and 9
-      room.reserve!(info) # Not yet implemented
+      room.reserve!(info) # See wiki page "User flow" for options
 
 ### 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.
+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. Check the `examples/hash_adapter.rb` for a trivial example of the required methods. A Redis adapter should be coming soon.
 
-#### 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
 ------------

data/examples/hash_adapter.rb

@@ -0,0 +1,15 @@
+class HashAdapter
+  attr_accessor :hash
+
+  def [](key)
+    @hash[key]
+  end
+
+  def []=(key, value)
+    @hash[key] = value
+  end
+
+  def keys
+    @hash.keys
+  end
+end

data/lib/suitcase/cache.rb

@@ -1,12 +1,16 @@
 module Suitcase
   class Cache
+    attr_accessor :store
+
     def initialize(store)
       @store = store
     end
 
     def save_query(action, params, response)
-      params.delete("apiKey")
-      params.delete("cid")
+      %w(apiKey cid customerSessionId customerIpAddress locale customerUserAgent).each do |param|
+        params.delete(param)
+      end
+      params.delete("currencyCode") unless action == :paymentInfo
       @store[action] ||= {}
       @store[action][params] = response
     end

data/lib/suitcase/configuration.rb

@@ -27,17 +27,5 @@ 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/helpers.rb

@@ -1,10 +1,22 @@
 module Suitcase
   module Helpers
-    def url(method, params, include_key=true, include_cid=true, secure=false, as_form=false)
+    def url(builder)
+      builder[:include_key] ||= true
+      builder[:include_cid] ||= true
+      builder[:secure] ||= false
+      builder[:as_form] ||= false
+      builder[:session] ||= Suitcase::Session.new
+      method, params, include_key, include_cid = builder[:method], builder[:params], builder[:include_key], builder[:include_cid]
       params["apiKey"] = Configuration.hotel_api_key if include_key
       params["cid"] = (Configuration.hotel_cid ||= 55505) if include_cid
-      url = main_url(secure) + method.to_s + (as_form ? "" : "?")
-      url += params.map { |key, value| "#{key}=#{value}"}.join("&")
+      url = main_url(builder[:secure]) + method.to_s + (builder[:as_form] ? "" : "?")
+      session_info = {}
+      session_info["customerSessionId"] = builder[:session].id if builder[:session].id
+      session_info["customerIpAddress"] = builder[:session].ip_address if builder[:session].ip_address
+      session_info["locale"] = builder[:session].locale if builder[:session].locale
+      session_info["currencyCode"] = builder[:session].currency_code if builder[:session].currency_code
+      session_info["customerUserAgent"] = builder[:session].user_agent if builder[:session].user_agent
+      url += params.merge(session_info).map { |key, value| "#{key}=#{value}"}.join("&") unless builder[:as_form]
       URI.parse(URI.escape(url))
     end
 
@@ -23,5 +35,10 @@ module Suitcase
         URI.parse main_url(false)
       end
     end
+
+    def update_session(parsed, session)
+      session ||= Suitcase::Session.new
+      session.id = parsed[parsed.keys.first]["customerSessionId"] if parsed[parsed.keys.first]
+    end
   end
 end

data/lib/suitcase/hotel/hotel.rb

@@ -52,9 +52,9 @@ module Suitcase
     # an Array of Hotels.
     def self.find(info)
       if info[:ids]
-        info[:ids].map { |id| find_by_id(id) }
+        info[:ids].map { |id| find_by_id(id, info[:session]) }
       elsif info[:id]
-        find_by_id(info[:id])
+        find_by_id(info[:id], info[:session])
       else
         find_by_info(info)
       end
@@ -66,16 +66,17 @@ module Suitcase
     #      id.
     #
     # Returns a single Hotel object.
-    def self.find_by_id(id)
+    def self.find_by_id(id, session)
       params = { hotelId: id }
       if Configuration.cache? and Configuration.cache.cached?(:info, params)
         raw = Configuration.cache.get_query(:info, params)
       else
-        url = url(:info, params)
+        url = url(:method => "info", :params => params, :session => session)
         raw = parse_response(url)
         Configuration.cache.save_query(:info, params, raw) if Configuration.cache?
       end
       hotel_data = parse_information(raw)
+      update_session(raw, session)
       Hotel.new(hotel_data)
     end
 
@@ -96,11 +97,17 @@ module Suitcase
       params["maxRate"] = params[:max_rate] if params[:max_rate]
       params[:amenities] = amenities if amenities
       hotels = []
-      parsed = parse_response(url(:list, params))
-      handle_errors(parsed)
+      if Configuration.cache? and Configuration.cache.cached?(:list, params)
+        parsed = Configuration.cache.get_query(:list, params)
+      else
+        parsed = parse_response(url(:method => "list", :params => params, :session => info[:session]))
+        handle_errors(parsed)
+        Configuration.cache.save_query(:list, params, parsed) if Configuration.cache?
+      end
       split(parsed).each do |hotel_data|
         hotels.push Hotel.new(parse_information(hotel_data))
       end
+      update_session(parsed, info[:session])
       info[:results] ? hotels[0..(info[:results]-1)] : hotels
     end
 
@@ -172,11 +179,17 @@ module Suitcase
       params.delete(:arrival)
       params.delete(:departure)
       params["hotelId"] = @id
-      parsed = Hotel.parse_response(Hotel.url(:avail, params))
-      Hotel.handle_errors(parsed)
+      if Configuration.cache? and Configuration.cache.cached?(:avail, params)
+        parsed = Configuration.cache.get_query(:avail, params)
+      else
+        parsed = Hotel.parse_response(Hotel.url(:method => "avail", :params => params, :session => info[:session]))
+        Hotel.handle_errors(parsed)
+        Configuration.cache.save_query(:avail, params, parsed) if Configuration.cache?
+      end
       hotel_id = parsed["HotelRoomAvailabilityResponse"]["hotelId"]
       rate_key = parsed["HotelRoomAvailabilityResponse"]["rateKey"]
       supplier_type = parsed["HotelRoomAvailabilityResponse"]["HotelRoomResponse"][0]["supplierType"]
+      Hotel.update_session(parsed, info[:session])
       rooms = parsed["HotelRoomAvailabilityResponse"]["HotelRoomResponse"].map do |raw_data|
         room_data = {}
         room_data[:rate_code] = raw_data["rateCode"]

data/lib/suitcase/hotel/payment_option.rb

@@ -9,8 +9,13 @@ module Suitcase
     end
 
     def self.find(info)
-      currency_code = info[:currency_code]
-      types_raw = parse_response(url(:paymentInfo, { "currencyCode" => currency_code }))
+      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
       options = []
       types_raw["HotelPaymentResponse"].each do |raw|
         types = raw[0] != "PaymentType" ? [] : raw[1]
@@ -18,6 +23,7 @@ module Suitcase
           options.push PaymentOption.new(type["code"], type["name"])
         end
       end
+      update_session(types_raw, info[:session])
       options
     end
   end

data/lib/suitcase/hotel/room.rb

@@ -50,7 +50,7 @@ module Suitcase
       params["stateProvinceCode"] = info[:province]
       params["countryCode"] = info[:country]
       params["postalCode"] = info[:postal_code]
-      uri = Room.url :res, params, true, true, true
+      uri = Room.url :method => "res", :params => params, :include_key => true, :include_cid => true, :secure => true
       session = Patron::Session.new
       session.base_url = "https://" + uri.host
       res = session.post uri.request_uri, {}

data/lib/suitcase/session.rb

@@ -1,34 +1,5 @@
 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
+    attr_accessor :id, :user_agent, :ip_address, :locale, :currency_code
   end
 end

data/lib/suitcase/version.rb

@@ -1,3 +1,3 @@
 module Suitcase
-  VERSION = "1.2.5"
+  VERSION = "1.2.6"
 end

data/lib/suitcase.rb

@@ -7,7 +7,7 @@ require 'suitcase/session'
 require 'suitcase/core_ext/string'
 require 'suitcase/version'
 require 'suitcase/configuration'
-require 'suitcase/session_cache'
+# require 'suitcase/session_cache'
 require 'suitcase/cache'
 require 'suitcase/helpers'
 require 'suitcase/hotel/amenity'

data/spec/caching_spec.rb

@@ -6,14 +6,27 @@ describe Suitcase do
   end
 
   it "should cache all non-secure queries" do
-    Suitcase::Hotel.find(id: 123904)
-    Suitcase::Configuration.cache.keys.count.should eq(1)
+    hotel = Suitcase::Hotel.find(id: 123904)
+    Suitcase::Hotel.find(location: "Boston, US")
+    room = hotel.rooms(arrival: "6/23/2012", departure: "6/30/2012").first
+    Suitcase::PaymentOption.find currency_code: "USD"
+    room.rooms[0][:bed_type] = room.bed_types[0]
+    room.rooms[0][:smoking_preference] = "NS"
+    room.reserve!(Keys::VALID_RESERVATION_INFO) # We don't want to cache this
+    Suitcase::Configuration.cache.keys.count.should eq(4)
   end
 
   it "should retrieve from the cache if it's there" 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"
     lambda do
       Net::HTTP.stub!(:get_response).and_return nil # disable access to the API
-      Suitcase::Hotel.find(id: 123904)
+      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"
     end.should_not raise_error
   end
 end

data/spec/helpers_spec.rb

@@ -6,7 +6,7 @@ describe Suitcase::Helpers do
   end
 
   it "#url should return a URI with the correct base URL" do
-    returned = Dummy.url(:action, {})
+    returned = Dummy.url(:method => "action", :params => {})
     returned.should be_a(URI)
     returned.host.should match(/api.ean.com/)
   end

data/spec/sessions_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Suitcase::Session do
+  it { should respond_to :id }
+  it { should respond_to :ip_address }
+  it { should respond_to :user_agent }
+  it { should respond_to :locale }
+  it { should respond_to :currency_code }
+
+  before :each do
+    @s = Suitcase::Session.new
+  end
+
+  it "should be able to be passed in to a Hotel.find_by_id query" do
+    Suitcase::Hotel.find(id: 123904, session: @s)
+    @s.id.should_not be_nil
+  end
+
+  it "should be able to be passed in to a Hotel.find_by_info query" do
+    Suitcase::Hotel.find(location: "Boston, US", session: @s)
+    @s.id.should_not be_nil
+  end
+
+  it "should be able to be passed in to a Hotel#rooms query" do
+    hotel = Suitcase::Hotel.find(id: 123904, session: @s)
+    hotel.rooms(arrival: "6/23/2012", departure: "6/25/2012", session: @s)
+    @s.id.should_not be_nil
+  end
+
+  it "should be able to be passed in to a Room#reserve! query" do
+    hotel = Suitcase::Hotel.find(id: 123904, session: @s)
+    room = hotel.rooms(arrival: "6/23/2012", departure: "6/25/2012", session: @s).first
+    room.rooms[0][:bed_type] = room.bed_types[0]
+    room.rooms[0][:smoking_preference] = "NS"
+    room.reserve! Keys::VALID_RESERVATION_INFO
+    @s.id.should_not be_nil
+  end
+
+  it "should be able to be passed in to a PaymentOption.find query" do
+    payment_options = Suitcase::PaymentOption.find(currency_code: "USD", session: @s)
+    @s.id.should_not be_nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suitcase
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-14 00:00:00.000000000 Z
+date: 2012-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9333440 !ruby/object:Gem::Requirement
+  requirement: &22060760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9333440
+  version_requirements: *22060760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9332900 !ruby/object:Gem::Requirement
+  requirement: &22059980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9332900
+  version_requirements: *22059980
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &9332260 !ruby/object:Gem::Requirement
+  requirement: &22058860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9332260
+  version_requirements: *22058860
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &9331660 !ruby/object:Gem::Requirement
+  requirement: &22058320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9331660
+  version_requirements: *22058320
 - !ruby/object:Gem::Dependency
   name: patron
-  requirement: &9330780 !ruby/object:Gem::Requirement
+  requirement: &22057560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9330780
+  version_requirements: *22057560
 description: Suitcase utilizes the EAN (Expedia.com) API for locating info about hotels,
   rental cars, and flights.
 email:
@@ -76,10 +76,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
+- examples/hash_adapter.rb
 - lib/suitcase.rb
 - lib/suitcase/airport_codes.rb
 - lib/suitcase/cache.rb
@@ -95,7 +95,6 @@ files:
 - 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
@@ -104,6 +103,7 @@ files:
 - spec/payment_options_spec.rb
 - spec/reservation_spec.rb
 - spec/rooms_spec.rb
+- spec/sessions_spec.rb
 - spec/spec_helper.rb
 - suitcase.gemspec
 homepage: http://github.com/thoughtfusion/suitcase
@@ -120,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1373010167553481948
+      hash: -2601824217631768176
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1373010167553481948
+      hash: -2601824217631768176
 requirements: []
 rubyforge_project: suitcase
 rubygems_version: 1.8.10
@@ -144,4 +144,5 @@ test_files:
 - spec/payment_options_spec.rb
 - spec/reservation_spec.rb
 - spec/rooms_spec.rb
+- spec/sessions_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.2
-  - 1.9.3

data/lib/suitcase/session_cache.rb

@@ -1,27 +0,0 @@
-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