isotope11-suitcase 1.7.6

data/test/hotels/helpers_test.rb

@@ -0,0 +1,60 @@
+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
+
+  describe "#parameterize_rooms" do
+    it "returns a hash of room parameters" do
+      rooms = [{adults: 1}, {adults: 2, children_ages: [3, 5]}]
+      params = Dummy.parameterize_rooms(rooms)
+      params.must_equal({ "room1" => "1", "room2" => "2,3,5" })
+    end
+  end
+end

data/test/hotels/hotel_location_test.rb

@@ -0,0 +1,23 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::Location do
+  before :each do
+    @location = Suitcase::Hotel::Location.new({})
+  end
+  
+  [:destination_id, :province, :country, :country_code, :city, :type,
+  :active].each do |accessor|
+    it "has an accessor for #{accessor}" do
+      @location.must_respond_to(accessor)
+      @location.must_respond_to((accessor.to_s + "=").to_sym)
+    end
+  end
+
+  describe ".find" do
+    it "returns an Array of Locations" do
+      locations = Suitcase::Hotel::Location.find(destination_string: "Lond")
+      locations.must_be_kind_of(Array)
+      locations.first.must_be_kind_of(Suitcase::Hotel::Location)
+    end
+  end
+end

data/test/hotels/hotel_test.rb

@@ -0,0 +1,122 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel do
+  before :each do
+    @hotel = Suitcase::Hotel.find(id: 123904)
+  end
+
+  [:id, :name, :address, :city, :amenities, :masked_amenities, :country_code,
+  :high_rate, :low_rate, :longitude, :latitude, :rating, :postal_code,
+  :images, :nightly_rate_total, :property_description, :number_of_floors,
+  :number_of_rooms, :deep_link, :tripadvisor_rating].each do |attribute|
+    it "has an attr_accessor for #{attribute}" do
+      @hotel.must_respond_to(attribute)
+      @hotel.must_respond_to((attribute.to_s + "=").to_sym)
+    end
+  end
+
+  describe ".find" do
+    it "returns a single Hotel if passed an ID" do
+      @hotel.must_be_kind_of(Suitcase::Hotel)
+    end
+
+    it "returns available hotels if arrival and departure are passed in" do
+      hotels = Suitcase::Hotel.find(location: "London, UK",
+                                    arrival: "10/13/2013",
+                                    departure: "10/15/2013",
+                                    results: 1)
+      hotels.must_be_kind_of(Array)
+      hotels.first.must_be_kind_of(Suitcase::Hotel)
+      hotels.first.raw["HotelListResponse"]["moreResultsAvailable"].must_equal(true)
+    end
+
+    it "returns multiple Hotels if a location is passed in" do
+      hotels = Suitcase::Hotel.find(location: "London, UK")
+      hotels.must_be_kind_of(Array)
+      hotels.first.must_be_kind_of(Suitcase::Hotel)
+    end
+    
+    it "returns multiple Hotels if a destination ID is passed in" do
+      hotels = Suitcase::Hotel.find(destination_id: "58870F43-9215-4662-BAA1-CC9A20FEC4F1")
+      hotels.must_be_kind_of(Array)
+      hotels.first.must_be_kind_of(Suitcase::Hotel)
+    end
+
+    it "returns multiple Hotels if multiple ID's are passed in" do
+      hotels = Suitcase::Hotel.find(ids: [123904, 191937, 220166])
+      hotels.must_be_kind_of(Array)
+      hotels.first.must_be_kind_of(Suitcase::Hotel)
+    end
+
+    it "returns an Array with a single Hotel if an Array with a single ID is passed in" do
+      hotels = Suitcase::Hotel.find(ids: [123904])
+      hotels.count.must_equal(1)
+      hotels.first.must_be_kind_of(Suitcase::Hotel)
+    end
+
+    it "sets a recovery attribute on the raised error when the location is not specific enough" do
+      begin
+        Suitcase::Hotel.find(location: "Mexico")
+      rescue Suitcase::Hotel::EANException => e
+        e.recoverable?.must_equal(true) if e.type == :multiple_locations
+      end
+    end
+
+    it "sets the error type when the location is not specific enough" do
+      begin
+        Suitcase::Hotel.find(location: "Mexico")
+      rescue Suitcase::Hotel::EANException => e
+        e.type.must_equal(:multiple_locations)
+        e.recovery.must_be_kind_of(Hash)
+        e.recovery[:alternate_locations].must_be_kind_of(Array)
+        e.recovery[:alternate_locations].first.must_be_kind_of(Suitcase::Hotel::Location)
+      end
+    end
+  end
+
+  describe "#images" do
+    it "correctly gets the URLs of the images" do
+      images = @hotel.images
+      images.must_be_kind_of(Array)
+      images.map { |image| URI.parse(image.url) }
+    end
+  end
+
+  describe "#thumbnail_url" do
+    it "returns the first image's thumbnail URL" do
+      @hotel.thumbnail_url.must_equal @hotel.images.first.thumbnail_url
+    end
+  end
+
+  describe "#rooms" do
+    before do
+      @info = {
+        arrival: "1/1/2013",
+        departure: "1/8/2013"
+      }
+      @rooms = @hotel.rooms(@info)
+    end
+
+    it "returns an Array of available Rooms" do
+      @rooms.must_be_kind_of(Array)
+    end
+
+    it "each room must contain a cancellation policy" do
+      @rooms.each do |r|
+        r.cancellation_policy.wont_be_nil
+      end
+    end
+
+    it "each room must contain the non_refundable option" do
+      @rooms.each do |r|
+        r.non_refundable.wont_be_nil
+      end
+    end
+
+    it "each room must contain the deposit_required" do
+      @rooms.each do |r|
+        r.deposit_required.wont_be_nil
+      end
+    end
+  end
+end

data/test/hotels/image_test.rb

@@ -0,0 +1,20 @@
+require "minitest_helper"
+
+describe Suitcase::Image do
+  before :each do
+    @image = Suitcase::Hotel.find(id: 123904).images.first
+  end
+  
+  [:url, :id, :caption, :height, :width, :thumbnail_url, :name].each do |meth|
+    it "has an accessor for #{meth}" do
+      @image.must_respond_to(meth)
+      @image.must_respond_to((meth.to_s + "=").to_sym)
+    end
+  end
+  
+  describe "#url" do
+    it "returns a valid URL" do
+      URI.parse(@image.url).must_be_kind_of(URI)
+    end
+  end
+end

data/test/hotels/payment_option_test.rb

@@ -0,0 +1,15 @@
+require "minitest_helper"
+
+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::Hotel::PaymentOption.find(@info)
+      options.must_be_kind_of(Array)
+      options.first.must_be_kind_of(Suitcase::Hotel::PaymentOption)
+    end
+  end
+end

data/test/hotels/reservation_test.rb

@@ -0,0 +1,15 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::Reservation do
+  before :each do
+    @reservation = Suitcase::Hotel::Reservation.new({})
+  end
+  
+  it "has a reader for itinerary_id" do
+    @reservation.must_respond_to :itinerary_id
+  end
+  
+  it "has a reader for confirmation_numbers" do
+    @reservation.must_respond_to :confirmation_numbers
+  end
+end

data/test/hotels/room_test.rb

@@ -0,0 +1,53 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::Room do
+  before :each do
+    @room = Suitcase::Hotel.find(id: 123904).rooms(arrival: Keys::RESERVATION_START_TIME, departure: Keys::RESERVATION_END_TIME).first
+  end
+
+  %w(arrival departure rate_code room_type_code supplier_type tax_rate
+  non_refundable occupancy quoted_occupancy min_guest_age total surcharge_total
+  average_base_rate average_base_rate average_rate max_nightly_rate
+  currency_code value_adds room_type_description price_breakdown total_price
+  average_nightly_rate promo promo_description rate_key hotel_id
+  supplier_type bed_types rooms).each do |attribute|
+    it "has an attr_accessor for #{attribute}" do
+      @room.must_respond_to attribute.to_sym
+      @room.must_respond_to (attribute + "=").to_sym
+    end
+  end
+
+  describe "#reserve!" do
+    before :each do
+      @info = { email: Keys::SENDING_EMAIL,
+                first_name: "Walter",
+                last_name: "Nelson",
+                home_phone: "3831039402",
+                payment_option: Keys::SUITCASE_PAYMENT_OPTION, # Visa
+                credit_card_number: Keys::CREDIT_CARD_NUMBER_TESTING,
+                credit_card_verification_code: Keys::CREDIT_CARD_CVV_TESTING, # CVV
+                credit_card_expiration_date: Keys::CREDIT_CARD_EXPIRATION_DATE_TESTING,
+                address1: "travelnow", # for testing
+                address2: "Apt. 4A",
+                city: "Boston",
+                province: "MA",
+                country: "US",
+                postal_code: "02111" }
+      @room.rooms = [{}]
+      @room.rooms[0][:adults] = 1
+      @room.rooms[0][:children_ages] = [5, 3]
+      # @room.rooms[0][:bed_type] = @room.bed_types[0]
+      @room.rooms[0][:smoking_preference] = "NS"
+    end
+
+    it "returns a Suitcase::Reservation" do
+      reservation = @room.reserve!(@info)
+      reservation.must_be_kind_of(Suitcase::Hotel::Reservation)
+    end
+
+    it "raises errors on invalid info" do
+      lambda { @room.reserve!(@info.merge(credit_card_number: "")) }.must_raise Suitcase::Hotel::EANException
+    end
+  end
+end
+

data/test/hotels/session_test.rb

@@ -0,0 +1,14 @@
+require "minitest_helper"
+
+describe Suitcase::Hotel::Session do
+  before :each do
+    @session = Suitcase::Hotel::Session.new
+  end
+  
+  [:id, :ip_address, :user_agent, :locale, :currency_code].each do |accessor|
+    it "has an accessor for #{accessor}" do
+      @session.must_respond_to(accessor)
+      @session.must_respond_to((accessor.to_s + "=").to_sym)
+    end
+  end
+end

data/test/keys.rb

@@ -0,0 +1,43 @@
+# Suitcase::Configuration.hotel_api_key = "your_api_key_here"
+# Suitcase::Configuration.hotel_cid = "your_cid_here"
+# Suitcase::Configuration.hotel_shared_secret = "your_shared_secret_here"
+# Suitcase::Configuration.use_signature_auth = true
+
+# Or configure with a block:
+
+Suitcase.configure do |config|
+  config.hotel_api_key = ENV['EAN_KEY']
+  config.hotel_cid = ENV['EAN_CID']
+  
+  config.hotwire_api_key = ""
+  # config.hotel_shared_secret = "none"
+  # config.use_signature_auth = false
+end
+
+module Keys
+  RESERVATION_START_TIME = Chronic.parse("1 week from now").strftime("%m/%d/%Y")
+  RESERVATION_END_TIME = Chronic.parse("2 weeks from now").strftime("%m/%d/%Y")
+
+  SUITCASE_PAYMENT_OPTION = Suitcase::Hotel::PaymentOption.find(currency_code: "USD").find { |po| po.name =~ /Master/ }
+  CREDIT_CARD_NUMBER_TESTING = "5401999999999999"
+  CREDIT_CARD_CVV_TESTING = "123"
+  CREDIT_CARD_EXPIRATION_DATE_TESTING = "2014/03/01"
+
+  SENDING_EMAIL = "testemail@gmail.com"
+
+  VALID_RESERVATION_INFO = {
+    email: "testemail@gmail.com",
+    first_name: "Test Booking",
+    last_name: "Test Booking",
+    home_phone: "1231231234",
+    payment_option: SUITCASE_PAYMENT_OPTION,
+    credit_card_number: CREDIT_CARD_NUMBER_TESTING, 
+    credit_card_verification_code: CREDIT_CARD_CVV_TESTING,
+    credit_card_expiration_date: CREDIT_CARD_EXPIRATION_DATE_TESTING,
+    address1: "travelnow",
+    city: "Boston",
+    province: "MA",
+    country: "US",
+    postal_code: "01234",
+  }
+end

data/test/minitest_helper.rb

@@ -0,0 +1,29 @@
+# Testing frameworks
+require "turn"
+require "minitest/spec"
+require "minitest/autorun"
+require "mocha"
+
+# For making sure the dates will be valid
+require "chronic"
+
+# Debugger
+require "pry"
+
+# The gem
+$: << File.dirname(__FILE__) + "/../lib"
+$: << File.dirname(__FILE__)
+require "suitcase"
+
+# API keys
+require "keys"
+
+# Support files
+require "support/fake_response"
+
+# Turn configuration
+Turn.config do |config|
+  config.format = :pretty
+  # config.trace = true
+  config.natural = true
+end

data/test/support/fake_response.rb

@@ -0,0 +1,13 @@
+class FakeResponse
+  def initialize(options = {})
+    options.each { |k, v| instance_variable_set("@#{k}", v) }
+  end
+
+  def method_missing(meth, *args, &blk)
+    if args.empty?
+      instance_variable_get("@#{meth}")
+    else
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: isotope11-suitcase
+version: !ruby/object:Gem::Version
+  version: 1.7.6
+  prerelease: 
+platform: ruby
+authors:
+- Walter Nelson
+- Tad Hosford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &18584740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18584740
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &18584280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18584280
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &18583800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18583800
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: &18583220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18583220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &18582720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18582720
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &18581580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18581580
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &18581080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18581080
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: &18580500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18580500
+description: Ruby library that utilizes the EAN (Expedia.com) API for locating available
+  hotels and the Hotwire API for rental cars.
+email:
+- tad@isotope11.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- examples/hash_adapter.rb
+- examples/hotel_image_db.rb
+- examples/redis_adapter.rb
+- isotope11-suitcase.gemspec
+- lib/suitcase.rb
+- lib/suitcase/car_rental.rb
+- lib/suitcase/codes.rb
+- lib/suitcase/configuration.rb
+- lib/suitcase/core_ext/string.rb
+- lib/suitcase/hotel.rb
+- lib/suitcase/hotel/amenity.rb
+- lib/suitcase/hotel/bed_type.rb
+- lib/suitcase/hotel/cache.rb
+- lib/suitcase/hotel/cancellation.rb
+- lib/suitcase/hotel/ean_exception.rb
+- lib/suitcase/hotel/helpers.rb
+- lib/suitcase/hotel/image.rb
+- lib/suitcase/hotel/location.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/hotel/session.rb
+- lib/suitcase/hotel/surcharge.rb
+- lib/suitcase/version.rb
+- test/car_rentals/car_rental_test.rb
+- test/hotels/amenity_test.rb
+- test/hotels/caching_test.rb
+- test/hotels/ean_exception_test.rb
+- test/hotels/helpers_test.rb
+- test/hotels/hotel_location_test.rb
+- test/hotels/hotel_test.rb
+- test/hotels/image_test.rb
+- test/hotels/payment_option_test.rb
+- test/hotels/reservation_test.rb
+- test/hotels/room_test.rb
+- test/hotels/session_test.rb
+- test/keys.rb
+- test/minitest_helper.rb
+- test/support/fake_response.rb
+homepage: http://github.com/isotope11/suitcase
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1403295208779248586
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1403295208779248586
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Locates available hotels and rental cars through Expedia and Hotwire.  This
+  is a fork of Walter Nelson's gem - suitcase
+test_files: []