suitcase 1.3.0 → 1.3.1

data/README.md

@@ -43,7 +43,7 @@ room.reserve!(reservation_hash)
 
 #### 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. Check the `examples/hash_adapter.rb` for a trivial example of the required methods. A Redis adapter should be coming soon.
+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 is also in the examples directory.
 
 
 ### Car rentals
@@ -66,6 +66,8 @@ rentals = Suitcase::CarRental.find(destination: "LAX", start_date: "7/14/2012",
 # => [#<Suitcase::CarRental ...>, ...]
 ```
 
+Caching is not recommended for car rentals, because they all change so quickly.
+
 Contributing
 ------------
 
@@ -75,4 +77,4 @@ To set up for the specs, you need to edit the file `spec/keys.rb` with the prope
 
 ### Pull requests/issues
 
-Please submit any useful pull requests through GitHub. If you find any bugs, please report them with the issue tracker! Thanks.
+Please submit any useful pull requests through GitHub, preferably to the `develop` branch in the repo. If you find any bugs, please report them with the issue tracker! Thanks.

data/lib/suitcase/hotel/amenity.rb

@@ -1,9 +1,43 @@
 module Suitcase
   class Amenity
     attr_accessor :id, :description
-    
+
+    BITS = { :business_services => 1,
+      :fitness_center => 2,
+      :hot_tub => 4,
+      :internet_access => 8,
+      :kids_activities => 16,
+      :kitchen => 32,
+      :pets_allowed => 64,
+      :swimming_pool => 128,
+      :restaurant => 256,
+      :whirlpool_bath => 1024,
+      :breakfast => 2048,
+      :babysitting => 4096,
+      :jacuzzi => 8192,
+      :parking => 16384,
+      :room_service => 32768,
+      :accessible_path => 65536,
+      :accessible_bathroom => 131072,
+      :roll_in_shower => 262144,
+      :handicapped_parking => 524288,
+      :in_room_accessibility => 1048576,
+      :deaf_accessiblity => 2097152,
+      :braille_or_signage => 4194304,
+      :free_airport_shuttle => 8388608,
+      :indoor_pool => 16777216,
+      :outdoor_pool => 33554432,
+      :extended_parking => 67108864,
+      :free_parking => 134217728 }
+
     def initialize(info)
       @id, @description = info[:id], info[:description]
     end
+
+    def self.parse_mask(bitmask)
+      return nil unless bitmask
+
+      BITS.select {|amenity, bit| (bitmask & bit) > 0 }.keys
+    end
   end
 end

data/lib/suitcase/hotel/hotel.rb

@@ -30,8 +30,8 @@ module Suitcase
       pets: 7,
       wheelchair_accessible: 8,
       kitchen: 9 }
-
-    attr_accessor :id, :name, :address, :city, :province, :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, :property_description, :number_of_floors, :number_of_rooms, :deep_link, :tripadvisor_rating
+    
+    attr_accessor :id, :name, :address, :city, :province, :amenities, :masked_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, :property_description, :number_of_floors, :number_of_rooms, :deep_link, :tripadvisor_rating
 
     # Public: Initialize a new hotel
     #
@@ -111,10 +111,14 @@ module Suitcase
       params.delete(:results)
       params["destinationString"] = params[:location]
       params.delete(:location)
-      amenities = params[:amenities] ? params[:amenities].map { |amenity| AMENITIES[amenity] }.join(",") : nil
+
+      amenities = params[:amenities] ? params[:amenities].map {|amenity| 
+        AMENITIES[amenity] 
+      }.join(",") : nil
+      params[:amenities] = amenities if amenities
+
       params["minRate"] = params[:min_rate] if params[:min_rate]
       params["maxRate"] = params[:max_rate] if params[:max_rate]
-      params[:amenities] = amenities if amenities
       hotels = []
       if Configuration.cache? and Configuration.cache.cached?(:list, params)
         parsed = Configuration.cache.get_query(:list, params)
@@ -146,6 +150,8 @@ module Suitcase
       parsed_info[:number_of_rooms] = parsed["HotelInformationResponse"]["HotelDetails"]["numberOfRooms"] if parsed["HotelInformationResponse"]
       parsed_info[:number_of_floors] = parsed["HotelInformationResponse"]["HotelDetails"]["numberOfFloors"] if parsed["HotelInformationResponse"]
       parsed_info[:short_description] = summary["shortDescription"]
+      parsed_info[:amenity_mask] = summary["amenityMask"]
+      parsed_info[:masked_amenities] = Amenity.parse_mask(parsed_info[:amenity_mask])
       parsed_info
     end
 

data/lib/suitcase/hotel/room.rb

@@ -52,6 +52,7 @@ module Suitcase
       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

data/lib/suitcase/version.rb

@@ -1,3 +1,3 @@
 module Suitcase
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/spec/amenity_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Suitcase
+  describe Amenity do
+    describe ".parse_mask" do
+      context "when provided bitmask is not nil or 0" do
+        it "returns an array of symbols representing given amenities" do
+          Amenity.parse_mask(5).should == [:business_services, :hot_tub]
+        end
+      end
+
+      context "when provided bitmask is 0" do
+        it "returns an empty array" do
+          Amenity.parse_mask(0).should == []
+        end
+      end
+
+      context "when provided bitmask is nil" do
+        it "returns nil" do
+          Amenity.parse_mask(nil).should == nil
+        end
+      end
+    end
+  end
+end

data/spec/{hotels_spec.rb → hotels/hotels_spec.rb}

@@ -38,6 +38,7 @@ describe Suitcase::Hotel do
   it { should respond_to :address }
   it { should respond_to :city }
   it { should respond_to :amenities }
+  it { should respond_to :masked_amenities }
   it { should respond_to :country_code }
   it { should respond_to :high_rate }
   it { should respond_to :low_rate }

data/suitcase.gemspec

@@ -8,10 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Walter Nelson"]
   s.email       = ["walter.john.nelson@gmail.com"]
   s.homepage    = "http://github.com/thoughtfusion/suitcase"
-  s.summary     = %q{Locates available hotels with the Expedia API}
-  s.description = %q{Ruby library that utilizes the EAN (Expedia.com) API for locating available hotels (and maybe rental cars and flights someday, too).}
-
-  s.rubyforge_project = "suitcase"
+  s.summary     = %q{Locates available hotels and rental cars through Expedia and Hotwire}
+  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")
@@ -22,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "factory_girl"
   s.add_development_dependency "pry"
+
   s.add_runtime_dependency "json"
   s.add_runtime_dependency "patron"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suitcase
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby library that utilizes the EAN (Expedia.com) API for locating available
-  hotels (and maybe rental cars and flights someday, too).
+  hotels and the Hotwire API for rental cars.
 email:
 - walter.john.nelson@gmail.com
 executables: []
@@ -141,17 +141,18 @@ files:
 - lib/suitcase/hotel/room.rb
 - lib/suitcase/session.rb
 - lib/suitcase/version.rb
-- spec/caching_spec.rb
-- spec/car_rental_spec.rb
-- spec/helpers_spec.rb
-- spec/hotel_location_spec.rb
-- spec/hotels_spec.rb
-- spec/images_spec.rb
+- spec/amenity_spec.rb
+- spec/car_rentals/car_rental_spec.rb
+- spec/hotels/caching_spec.rb
+- spec/hotels/helpers_spec.rb
+- spec/hotels/hotel_location_spec.rb
+- spec/hotels/hotels_spec.rb
+- spec/hotels/images_spec.rb
+- spec/hotels/payment_options_spec.rb
+- spec/hotels/reservation_spec.rb
+- spec/hotels/rooms_spec.rb
+- spec/hotels/sessions_spec.rb
 - spec/keys.rb
-- 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
@@ -173,21 +174,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: suitcase
-rubygems_version: 1.8.21
+rubyforge_project: 
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: Locates available hotels with the Expedia API
+summary: Locates available hotels and rental cars through Expedia and Hotwire
 test_files:
-- spec/caching_spec.rb
-- spec/car_rental_spec.rb
-- spec/helpers_spec.rb
-- spec/hotel_location_spec.rb
-- spec/hotels_spec.rb
-- spec/images_spec.rb
+- spec/amenity_spec.rb
+- spec/car_rentals/car_rental_spec.rb
+- spec/hotels/caching_spec.rb
+- spec/hotels/helpers_spec.rb
+- spec/hotels/hotel_location_spec.rb
+- spec/hotels/hotels_spec.rb
+- spec/hotels/images_spec.rb
+- spec/hotels/payment_options_spec.rb
+- spec/hotels/reservation_spec.rb
+- spec/hotels/rooms_spec.rb
+- spec/hotels/sessions_spec.rb
 - spec/keys.rb
-- spec/payment_options_spec.rb
-- spec/reservation_spec.rb
-- spec/rooms_spec.rb
-- spec/sessions_spec.rb
 - spec/spec_helper.rb
+has_rdoc: