suitcase 1.0.1 → 1.1.0

data/README.md

@@ -21,14 +21,14 @@ First, include the module in your code:
 Find nearby hotels:
 
       Hotel::API_KEY = "your_api_key_here"
-      Hotel.near('Boston, MA', 10) # Returns 10 closest hotels to Boston, MA
-      Hotel.near('Metropoliton Museum of Art') # Returns 50 closest hotels to the Met Museum in New York
+      Hotel.near(:location => 'Boston, MA', :results => 10) # Returns 10 closest hotels to Boston, MA
+      Hotel.near(:location => 'Metropoliton Museum of Art') # Returns 50 closest hotels to the Met Museum in New York
 
 Find available airline flights (not yet implemented):
 
       Flight:API_KEY = "your_api_key_here"
-      Flight.available('June 23 2012', :from => "BOS", :to => "LHR") # Return all flights flying from Boston to London (Heathrow) on June 23, 2012
+      Flight.available(:date => 'June 23 2012', :departs => "BOS", :arrives => "LHR") # Return all flights flying from Boston to London (Heathrow) on June 23, 2012
 
 Contributing
 ------------
-Please submit any useful pull requests through GitHub. If you find any bugs, please report them! Thanks.
+Please submit any useful pull requests through GitHub. If you find any bugs, please report them with the issue tracker! Thanks.

data/features/hotels.feature

@@ -0,0 +1,28 @@
+Feature: Hotels
+  As a developer
+  In order to use the EAN API in my application
+  I need to be able to manipulate hotel information
+
+  Scenario Outline: Listing available hotels
+    Given I have an API key
+    When I submit a request to find <number_of_results> hotels in <location>
+    Then I want to receive <number_of_results> hotels with their respective information
+
+    Examples:
+
+    | number_of_results | location             |
+    | 10                | Boston, USA          |
+    | 8                 | Dublin, Ireland      |
+    | 1                 | London, UK           |
+
+  Scenario Outline: Requesting more information about a given hotel
+    Given I have an API key
+    When I submit a request to find more information about a hotel with id <id>
+    Then I want to receive more information about that hotel
+
+    Examples:
+
+    | id      |
+    | 252897  |
+    | 273655  |
+    | 174272  |

data/features/step_definitions/hotels_steps.rb

@@ -0,0 +1,21 @@
+require 'suitcase'
+
+Given /^I have an API key$/ do
+  Suitcase::Hotel::API_KEY = "3kx2vhr7sjrgmsyddb2cg47j"
+end
+
+When /^I submit a request to find (\d+) hotels in (.+)$/ do |results, location|
+  @hotels = Suitcase::Hotel.find(:near => location, :results => results.to_i)
+end
+
+Then /^I want to receive (\d+) hotels with their respective information$/ do |results|
+  @hotels.count.should eq(results.to_i)
+end
+
+When /^I submit a request to find more information about a hotel with id (\d+)$/ do |id|
+  @hotel = Suitcase::Hotel.find_by_id(id)
+end
+
+Then /^I want to receive more information about that hotel$/ do
+  @hotel.should_not be_nil
+end

data/lib/suitcase/hotel.rb

@@ -0,0 +1,151 @@
+module Suitcase
+  class PaymentOption
+    attr_accessor :code, :name
+
+    def initialize(code, name)
+      @code = code
+      @name = name
+    end
+  end
+
+  class Room
+    attr_accessor :rate_key, :hotel_id, :supplier_type
+
+    def initialize(rate_key, hotel_id, supplier_type)
+      @rate_key = rate_key
+      @hotel_id = hotel_id
+      @supplier_type = supplier_type
+    end
+
+    def reserve!(info)
+      params = info
+      params["hotelId"] = @id
+      params["arrivalDate"] = info[:arrival]
+      params["departureDate"] = info[:departure]
+      params.delete(:arrival)
+      params.delete(:departure)
+      params["supplierType"] = supplier_type
+      params["rateKey"] = @rate_key
+      params["rateTypeCode"] = info[:room_type_code]
+      params["rateCode"] = info[:rate_code]
+      params.delete(:rate_code)
+      p Hotel.hit(Hotel.url(:res, true, true, params))
+    end
+  end
+
+  class Hotel
+    AMENITIES = { pool: 1,
+                  fitness_center: 2,
+                  restaurant: 3,
+                  children_activities: 4,
+                  breakfast: 5,
+                  meeting_facilities: 6,
+                  pets: 7,
+                  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
+
+    def initialize(info)
+      info.each do |k, v|
+        send (k.to_s + "=").to_sym, v
+      end
+    end
+
+    def self.url(action, include_key, include_cid, params)
+      url = "http://api.ean.com/ean-services/rs/hotel/v3/" + action.to_s + "?"
+      include_key ? params["apiKey"] = Suitcase::Hotel::API_KEY : nil
+      include_cid ? params["cid"] = "55505" : nil
+      params.each do |k, v|
+        url += k.to_s + "=" + v.to_s + "&"
+      end
+      if url =~ /^(.+)&$/
+        url = $1
+      end
+      URI.parse URI.escape(url)
+    end
+
+    def self.find(info)
+      if info[:id]
+        find_by_id(info[:id])
+      else
+        find_by_info(info)
+      end
+    end
+
+    def self.find_by_id(id)
+      Hotel.new(parse_hotel_information(hit(url(:info, true, true, { hotelId: id }))))
+    end
+
+    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]
+        amenities = ""
+        params[:amenities].each do |amenity|
+          amenities += AMENITIES[amenity].to_s + ","
+        end
+        if amenities =~ /^(.+),$/
+          amenities = $1
+        end
+      end
+      params["minRate"] = params[:min_rate] if params[:min_rate]
+      params["maxRate"] = params[:max_rate] if params[:max_rate]
+      params[:amenities] = amenities
+      hotels = []
+      split(hit(url(:list, true, true, params))).each do |hotel_data|
+        hotels.push Hotel.new(parse_hotel_information(hotel_data.to_json))
+      end
+      hotels
+    end
+
+    def self.hit(url)
+      Net::HTTP.get_response(url).body
+    end
+
+    def self.parse_hotel_information(json)
+      parsed = JSON.parse json
+      summary = parsed["hotelId"] ? parsed : parsed["HotelInformationResponse"]["HotelSummary"]
+      { 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 }
+    end
+
+    def self.split(data)
+      parsed = JSON.parse(data)
+      hotels = parsed["HotelListResponse"]["HotelList"]
+      hotels["HotelSummary"]
+    end
+
+    def rooms(info)
+      params = info
+      params[:rooms].each_with_index do |room, n|
+        params["room#{n+1}"] = (room[:children] == 0 ? "" : room[:children].to_s + ",").to_s + room[:ages].join(",").to_s
+      end
+      params["arrivalDate"] = info[:arrival]
+      params["departureDate"] = info[:departure]
+      params.delete(:arrival)
+      params.delete(:departure)
+      params["hotelId"] = @id
+      parsed = JSON.parse(Hotel.hit(Hotel.url(:avail, true, true, params)))
+      hotel_id = parsed["HotelRoomAvailabilityResponse"]["hotelId"]
+      rate_key = parsed["HotelRoomAvailabilityResponse"]["rateKey"]
+      supplier_type = parsed["HotelRoomAvailabilityResponse"]["supplierType"]
+      Room.new(rate_key, hotel_id, supplier_type)
+    end
+
+    def payment_options
+      options = []
+      types_raw = JSON.parse Hotel.hit(Hotel.url(:paymentInfo, true, true, {}))
+      types_raw["HotelPaymentResponse"].each do |raw|
+        p raw
+        types = raw[0] != "PaymentType" ? [] : raw[1]
+        types.each do |type|
+          options.push PaymentOption.new(type["code"], type["name"])
+        end
+      end
+      options
+    end
+  end
+end

data/lib/suitcase/version.rb

@@ -1,3 +1,3 @@
 module Suitcase
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/suitcase.rb

@@ -1,7 +1,4 @@
+require 'json'
+require 'net/http'
 require 'suitcase/version'
-require 'suitcase/hotel/hotel'
-require 'suitcase/air/air'
-
-module Suitcase
-  
-end
+require 'suitcase/hotel'

data/spec/api_key.rb

@@ -0,0 +1 @@
+HOTEL_API_KEY = "88m3ugkarmfzcq3z4syayymt"

data/spec/data_helpers_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Suitcase::DataHelpers do
+  before :each do
+    class Hotel
+      API_KEY = HOTEL_API_KEY
+      extend Suitcase::DataHelpers
+    end
+  end
+
+  it "#url should return a valid url" do
+    URI.parse(Hotel.url(:hotel, :list, true, { location: "London, UK" })).should be_a(URI)
+  end
+end

data/spec/hotels_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Suitcase::Hotel do
+  it "::find should return an Array if no ID is passed" do
+    Suitcase::Hotel.find(destination: "Boston, US").should be_a(Array)
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,2 @@
 require File.dirname(__FILE__) + '/../lib/suitcase'
 require 'api_key'
-
-Suitcase::Hotel::API_KEY = HOTEL_API_KEY

data/suitcase.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "rake"
   s.add_runtime_dependency "json"
   s.add_runtime_dependency "nokogiri"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suitcase
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000Z
+date: 2011-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11887140 !ruby/object:Gem::Requirement
+  requirement: &20325340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11887140
+  version_requirements: *20325340
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &20324640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20324640
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &20324160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20324160
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &11886720 !ruby/object:Gem::Requirement
+  requirement: &20323700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11886720
+  version_requirements: *20323700
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &11886300 !ruby/object:Gem::Requirement
+  requirement: &20323260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11886300
+  version_requirements: *20323260
 description: Suitcase utilizes the EAN API for locating available hotels, rental cars,
   and flights.
 email:
@@ -56,13 +78,16 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- features/hotels.feature
+- features/step_definitions/hotels_steps.rb
 - lib/suitcase.rb
-- lib/suitcase/air/air.rb
 - lib/suitcase/airport_codes.rb
 - lib/suitcase/country_codes.rb
-- lib/suitcase/hotel/hotel.rb
+- lib/suitcase/hotel.rb
 - lib/suitcase/version.rb
-- spec/hotel_spec.rb
+- spec/api_key.rb
+- spec/data_helpers_spec.rb
+- spec/hotels_spec.rb
 - spec/spec_helper.rb
 - suitcase.gemspec
 homepage: http://github.com/thoughtfusion/suitcase
@@ -77,16 +102,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1859999531224729447
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1859999531224729447
 requirements: []
 rubyforge_project: suitcase
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Locates available hotels, rental cars, and flights
-test_files: []
+test_files:
+- features/hotels.feature
+- features/step_definitions/hotels_steps.rb
+- spec/api_key.rb
+- spec/data_helpers_spec.rb
+- spec/hotels_spec.rb
+- spec/spec_helper.rb

data/lib/suitcase/air/air.rb

@@ -1,86 +0,0 @@
-require 'open-uri'
-require 'json'
-require 'nokogiri'
-require File.dirname(__FILE__) + '/../airport_codes'
-
-module Suitcase
-  class Flight
-    attr_accessor :flights, :key, :origin, :destination, :departure, :arrival, :adults, :children, :seniors, :fare, :direct, :round_trip, :currency, :search_window, :results, :airline, :airline_code, :price, :segments, :outgoing
-
-    def to_s
-      puts <<EOS
-----------
-FLIGHT:
-airline: #{airline} (#{airline_code})
-origin: #{origin}
-destination: #{destination}
-departure: #{departure}
-arrival: #{arrival}
-price: #{price} (#{currency})
-key: #{key}
-----------
-EOS
-    end
-
-    def self.available(data)
-      origin_city = data[:from]
-      destination_city = data[:to]
-      departure_date_time = data[:departs]
-      arrival_date_time = data[:arrives]
-      adult_passengers = data[:adults] ? data[:adults] : 0
-      child_passengers = data[:children] ? data[:children].inject("") { |result, element| result + "C" + (element < 10 ? "0" : "") + element.to_s + (data[:children].last == element ? "" : ",") } : "" # :children => [2, 9, 11] (ages of children) should yield "C02,C09,C11"
-      senior_passengers = data[:seniors] ? data[:seniors] : 0
-      fare_class = data[:fare] ? data[:fare] : "Y" # F: first class; Y: coach; B: business
-      direct_flight = data[:direct_only] ? data[:direct_only] : false
-      round_trip = data[:round_trip] ? data[:round_trip] : "O"
-      currency = data[:currency] ? data[:currency] : "USD"
-      search_window = data[:search_window] ? data[:search_window] : 2
-      number_of_results = data[:results] ? data[:results] : 50
-      xml_format = <<EOS
-<AirSessionRequest method="getAirAvailability">
-  <AirAvailabilityQuery>
-    <originCityCode>#{origin_city}</originCityCode>
-    <destinationCityCode>#{destination_city}</destinationCityCode>
-    <departureDateTime>#{departure_date_time}</departureDateTime>
-    <returnDateTime>#{arrival_date_time}</returnDateTime>
-    <fareClass>#{fare_class}</fareClass>
-    <tripType>#{round_trip}</tripType>
-    <Passengers>
-      <adultPassengers>#{adult_passengers}</adultPassengers>
-      <seniorPassengers>#{senior_passengers}</seniorPassengers>
-      <childCodes>#{child_passengers}</childCodes>
-    </Passengers>
-  </AirAvailabilityQuery>
-</AirSessionRequest>
-EOS
-      uri = URI.escape("http://api.ean.com/ean-services/rs/air/200919/xmlinterface.jsp?cid=#{CID}&resType=air&intfc=ws&apiKey=#{API_KEY}&xml=#{xml_format}")
-      xml = Nokogiri::XML(open(uri))
-      segments = []
-      xml.xpath('//Segment').each do |segment|
-        f = Flight.new
-        f.key = segment.xpath("@key")
-        f.origin = segment.xpath("//originCity") + segment.xpath("//originStateProvince") + segment.xpath("//originCountry")
-        f.destination = segment.xpath("//destinationCity")
-        f.airline = segment.xpath("//airline")
-        f.airline_code = segment.xpath("//airlineCode")
-        f.departure = segment.xpath("//departureDateTime")
-        f.arrival = segment.xpath("//arrivalDateTime")
-        segments.push(f)
-      end
-      flights = []
-      xml.xpath("//AirAvailabilityReply").each do |aar|
-        f = Flight.new
-        f.segments = []
-        f.price = aar.xpath("//nativeTotalPrice")
-        f.currency = aar.xpath("//displayCurrencyCode")
-        aar.xpath("//FlightSegment").each do |subseg|
-          fn = segments.find { |x| x.key == subseg.xpath("//segmentKey") }
-          f.segments.push(fn)
-          f.segments.compact!
-        end
-        flights.push(f)
-      end
-      flights
-    end
-  end
-end

data/lib/suitcase/hotel/hotel.rb

@@ -1,49 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'json'
-require File.dirname(__FILE__) + '/../country_codes'
-
-module Suitcase
-  class Hotel
-    attr_accessor :id, :name, :address, :city, :postal_code, :country, :airport_code, :rating, :confidence_rating, :description, :high_rate, :low_rate, :tripadvisor_rating, :currency_code, :latitude, :longitude
-
-    def self.find(hash)
-      hotels = []
-      json = JSON.parse Net::HTTP.get_response(URI.parse(URI.escape("http://api.ean.com/ean-services/rs/hotel/v3/list?apiKey=#{Suitcase::Hotel::API_KEY}&city=#{hash[:near]}&numberOfResults=#{hash[:results]}"))).body
-      if json["HotelListResponse"]["HotelList"]
-        json["HotelListResponse"]["HotelList"]["HotelSummary"].each do |hotel_data|
-          h = Hotel.new
-          h.id = hotel_data["hotelId"]
-          h.name = hotel_data["name"]
-          h.address = hotel_data["address1"]
-          h.city = hotel_data["city"]
-          h.postal_code = hotel_data["postalCode"]
-          h.country = COUNTRY_CODES[hotel_data["countryCode"]]
-          h.airport_code = hotel_data["airportCode"]
-          h.rating = hotel_data["hotelRating"]
-          h.confidence_rating = hotel_data["confidenceRating"]
-          h.tripadvisor_rating = hotel_data["tripAdvisorRating"]
-          h.currency_code = hotel_data["rateCurrencyCode"]
-          h.latitude = hotel_data["latitude"]
-          h.longitude = hotel_data["longitude"]
-          h.high_rate = hotel_data["highRate"]
-          h.low_rate = hotel_data["lowRate"]
-          hotels.push(h)
-        end
-        hotels[0..hash[:results]-1]
-      else
-        if json["HotelListResponse"]["EanWsError"]
-          raise "An error occured. Check data."
-        end
-      end
-    end
-
-    def geolocation
-      latitude + ", " + longitude
-    end
-
-    def complete_address
-      address + " " + city + ", " + country + " " + postal_code
-    end
-  end
-end

data/spec/hotel_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-include Suitcase
-
-describe Hotel do
-  before(:each) do
-    @attr = { :near => "Boston", :results => 50 }
-  end
-
-  describe "find method" do
-    it "should return the correct number of results" do
-      Hotel.find(@attr).count.should eq(50)
-    end
-
-    it "should return an array of hotels" do
-      Hotel.find(@attr).class.should eq(Array)
-    end
-
-    it "should return all hotels" do
-      Hotel.find(@attr).map { |x| x.class }.should eq([Hotel] * 50)
-    end
-  end
-end