kayak 0.0.1

data/History.txt

@@ -0,0 +1,2 @@
+== 0.0.1 2008-01-23
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,40 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+autotest/discover.rb
+autotest/testunit.rb
+config/hoe.rb
+config/requirements.rb
+init.rb
+lib/kayak.rb
+lib/kayak/flight_search.rb
+lib/kayak/hotel.rb
+lib/kayak/leg.rb
+lib/kayak/search.rb
+lib/kayak/search_results.rb
+lib/kayak/session.rb
+lib/kayak/trip.rb
+lib/kayak/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/fixtures/flight_results.xml
+test/fixtures/flight_start.xml
+test/fixtures/session.xml
+test/fixtures/token_invalid.xml
+test/kayak/search_results_test.rb
+test/kayak/search_test.rb
+test/kayak/session_test.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1 @@
+http://www.kayak.com/labs/api/search/

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/autotest/discover.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/testunit'
+
+Autotest.add_discovery do  
+  "testunit"
+end

data/autotest/testunit.rb

@@ -0,0 +1,28 @@
+require 'autotest'
+
+class Autotest::Testunit < Autotest
+
+  def initialize # :nodoc:
+    super
+    @exceptions = /^\.\/(?:db|doc|log|public|script|tmp|vendor\/rails)/
+
+    @test_mappings = {
+      %r%^test/.*\.rb$% => proc { |filename, _|
+        filename
+      },
+      %r%^lib/(.*)\.rb$% => proc { |_, m|
+        ["test/#{m[1]}_test.rb"]
+      },
+      %r%^test/test_helper.rb$% => proc {
+        files_matching %r%^test/.*_test\.rb$%
+      },
+    }
+  end
+
+  # Given the string filename as the path, determine
+  # the corresponding tests for it, in an array.
+  def tests_for_file(filename)
+    super.select { |f| @files.has_key? f }
+  end
+
+end

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'kayak/version'
+
+AUTHOR = 'Brandon Keepers'
+EMAIL = "brandon@opensoul.org"
+DESCRIPTION = "Ruby wrapper for Kayak.com's API for searching flights and hotels"
+GEM_NAME = 'kayak'
+RUBYFORGE_PROJECT = 'kayak'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "brandon"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Kayak::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'kayak documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'kayak'

data/init.rb

@@ -0,0 +1 @@
+require 'kayak'

data/lib/kayak.rb

@@ -0,0 +1,27 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'hpricot'
+require 'active_support'
+
+require 'kayak/version'
+require 'kayak/session'
+require 'kayak/search'
+require 'kayak/flight_search'
+require 'kayak/search_results'
+require 'kayak/trip'
+require 'kayak/leg'
+require 'kayak/hotel'
+
+Date::DATE_FORMATS[:kayak] = "%m/%d/%Y"
+
+class Hash
+  def to_date
+    date = symbolize_keys
+    [:year, :month, :day].each do |key| 
+      raise ArgumentError, "Cannot convert to Date, missing #{key}" if !date.has_key?(key)
+      date[key] = date[key].to_i
+    end
+    Date.new(date[:year], date[:month], date[:day])
+  end
+end

data/lib/kayak/flight_search.rb

@@ -0,0 +1,25 @@
+module Kayak
+  class FlightSearch < Search
+    attribute :oneway, :value => %w(y n) do |value|
+      ['y', '1', true].include?(value) ? 'y' : 'n'
+    end
+    attribute :origin, :destination, :value => /\w{3}/
+    attribute :depart_date, :return_date, :value => /\d{2}\/\d{2}\/\d{4}/ do |value|
+      value.to_date.to_s(:kayak) unless value.blank?
+    end
+    attribute :depart_time, :return_time, :values => %w(a r m 12 n e l)
+    attribute :travelers, :value => (1..8) do |value|
+      value.blank? ? 1 : value.to_i
+    end
+    attribute :cabin, :values => %w(f b e)
+    
+    def initialize(attrs = {})
+      super({:oneway => false, :travelers => 1, :cabin => 'e'}.merge(attrs))
+    end
+    
+    def to_search_params
+      attributes.merge(:action => 'doFlights')
+    end
+    
+  end
+end

data/lib/kayak/hotel.rb

@@ -0,0 +1,6 @@
+module Kayak
+  class Hotel
+    attr_accessor :name, :stars, :price, :hiprice, :loprice, :url, :phone,
+      :address, :city, :region, :country
+  end
+end

data/lib/kayak/leg.rb

@@ -0,0 +1,11 @@
+module Kayak
+  class Leg
+    attr_accessor :airline_code, :airline, :depart, :arrive, :stops,
+      :duration, :origin, :cabin, :destination
+    
+    def to_s
+      "#{self.airline_code}:#{self.origin}>#{self.destination}:#{self.depart}:" +
+        "#{self.arrive}:#{self.stops}:#{self.duration}min"
+    end
+  end
+end

data/lib/kayak/search.rb

@@ -0,0 +1,41 @@
+module Kayak
+  class Search
+    class_inheritable_accessor :valid_attributes
+    write_inheritable_attribute :valid_attributes, {}.with_indifferent_access
+    attr_reader :attributes
+    
+    def initialize(attrs = {})
+      # attrs.assert_valid_keys(self.valid_attributes.keys.map(&:to_s))
+      @attributes = attrs.dup.with_indifferent_access
+      @attributes.assert_valid_keys valid_attributes.keys
+      validate!
+    end
+  
+  private
+  
+    def self.attribute(*attrs, &block)
+      options = attrs.extract_options!
+      options[:conversion] = block
+      attrs.each do |attr|
+        valid_attributes[attr] = options
+      end
+    end
+    
+    def validate!
+      attributes.each do |attr,value|
+        options = valid_attributes[attr]
+        attributes[attr] = value = options[:conversion].call(value) if options[:conversion]
+        case options[:value]
+        when Array
+          raise ArgumentError, "#{attr} was expected to be one of #{options[:value].to_sentence(:connector => 'or')}" unless options[:value].include?(value)
+        when Regexp
+          raise "#{attr} is invalid" unless value =~ options[:value]
+        else
+          true
+        end
+      end
+    end
+    
+    
+  end
+end

data/lib/kayak/search_results.rb

@@ -0,0 +1,112 @@
+module Kayak
+  class SearchResults
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$)/ }
+    attr_accessor :id
+    
+    def initialize(session, search_id)
+      @session = session
+      @id = search_id
+      reset!
+    end
+    
+    def load!(count = nil)
+      params = {:searchid => @id, :apimode => 1, :_sid_ => @session.id, :c => count}
+      load_results @session.get("/s/apibasic/flight", params)
+    end
+    
+    def loaded?
+      @loaded
+    end
+    
+    def loaded!
+      @loaded = true
+    end
+    
+    def complete?
+      @complete
+    end
+
+    def reset!
+      @loaded = false
+      @complete = false
+      @results = []
+    end
+
+    def reload!
+      reset!
+      load!
+    end
+
+    def respond_to?(symbol, include_priv = false)
+      @results.respond_to?(symbol, include_priv)
+    end
+    
+    # Explicitly define === because the instance method removal above
+    # doesn't catch it.
+    def ===(other)
+      load!
+      other === @results
+    end
+    
+    def inspect
+      @results.inspect
+    end
+
+  private
+  
+    def method_missing(method, *args, &block)
+      load! unless loaded?
+      @results.send(method, *args, &block)
+    end
+
+    def load_results(xml)
+      @complete = xml.elements['/searchresult/morepending'].text == "false"
+      # @@lastcount = xml.elements['/searchresult/count'].text
+      reset!
+      xml.elements.each("/searchresult/trips/trip") do |e|
+        trip = Trip.new
+        trip.price = e.elements['price'].text
+        trip.url = e.elements['price'].attribute('url').value
+        e.elements.each('legs/leg') do |l|
+          leg = Leg.new
+          leg.airline_code = l.elements['airline'].text
+          leg.airline = l.elements['airline_display'].text
+          leg.origin = l.elements['orig'].text
+          leg.destination = l.elements['dest'].text
+          leg.stops = l.elements['stops'].text.to_i
+          leg.cabin = l.elements['cabin'].text
+          leg.depart = Time.parse(l.elements['depart'].text)
+          leg.arrive = Time.parse(l.elements['arrive'].text)
+          leg.duration = l.elements['duration_minutes'].text.to_i.minutes
+          trip.legs << leg
+        end
+        
+        @results << trip
+      end
+      loaded!
+    end
+
+      #   if (searchtype == 'h')
+      #     xml.elements.each("/searchresult/hotels/hotel") do |e|
+      #       hotel = Hotel.new()
+      #       e.each_element("price") do |t|
+      #         hotel.price = t.text
+      #         hotel.url = t.attribute("url")
+      #       end
+      #       e.each_element("name") { |t| hotel.name = t.text }
+      #       e.each_element("address") { |t| hotel.address = t.text }
+      #       e.each_element("city") { |t| hotel.city = t.text }
+      #       e.each_element("region_code") { |t| hotel.region = t.text_code }
+      #       e.each_element("city") { |t| hotel.city = t.text }
+      #       e.each_element("stars") { |t| hotel.stars = t.text}
+      #       e.each_element("phone") { |t| hotel.phone = t.text}
+      #       e.each_element("pricehistoryhi") { |t| hotel.hiprice = t.text}
+      #       e.each_element("pricehistorylo") { |t| hotel.loprice = t.text}
+      #       @results << hotel
+      #     end # each hotel
+      # 
+      #   end # if hotel search
+      # end
+      # return more
+  end
+end

data/lib/kayak/session.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'rexml/document' 
+require 'open-uri'
+
+module Kayak
+  class TokenError < RuntimeError; end
+  
+  class Session
+    
+    USER_AGENT = "Mozilla/5.0 (compatible; RubyKayak/#{Kayak::VERSION::STRING}; http://kayak.rubyforge.org)"
+    URL = URI.parse('http://www.kayak.com')
+    
+    attr_reader :id, :last_response
+    
+    def initialize(id)
+      @id = id
+    end
+    
+    def self.create(token)
+      response = REXML::Document.new(get('/k/ident/apisession', :token => token))
+      if session_id = response.elements['//sid'].text
+        Session.new session_id
+      else
+        raise TokenError, response.elements['//error'].text
+      end
+    end
+    
+    # def hotel_search(params)
+    #   {:rooms => 1, :guests1 => 1, :minstars => -1}
+    #   params.
+    #   # :action => 'dohotels'
+    #   csc = URI.escape(citystatecountry)
+    #   dep_date = URI.escape(dep_date)
+    #   ret_date = URI.escape(ret_date)
+    #   url = "othercity=#{csc}&checkin_date=#{dep_date}&checkout_date=#{ret_date}&"
+    #   return start_search(url)
+    #   search params.merge()
+    # end
+    
+    def search(s)
+      params = s.to_search_params.merge({:basicmode => true, :apimode => 1, :_sid_ => @id})
+      SearchResults.new(self, get("/s/apisearch", params).elements['//search/searchid'].text)
+    end
+    
+    def get(path, params = {})
+      REXML::Document.new(@last_response = self.class.get(path, params))
+    #   check_error(response)
+    #   return parse_response(response)
+    # rescue OpenURI::HTTPError => e
+    #   check_error(prepare_response(e.io.read))
+    #   raise
+    end
+    
+    def self.get(path, params)
+      make_url(path, params).open('User-Agent' => USER_AGENT).read
+    end
+    
+  private
+  
+    def self.make_url(path, params = {})
+      escaped_params = params.sort_by { |k,v| k.to_s }.map do |k,v|
+        "#{URI.escape k.to_s}=#{URI.escape v.to_s}"
+      end
+
+      url = URL.dup
+      url.path = path
+      url.query = escaped_params.join '&' unless escaped_params.empty?
+      return url
+    end
+  
+  end
+end