woefoo 0.0.6 → 0.0.7

data/lib/woefoo/config.rb

@@ -1,22 +1,20 @@
-module Woefoo
-  module Config
-    # appid is the user's Yahoo app id (http://developer.yahoo.com/geo/placefinder/)
-    attr :appid, true
-    # the number of results to return for each request
-    attr :placefinder_result_count, true
-    # the minimum input quality for a canonical town match
-    attr :min_input_quality, true
+module Woefoo::Config
+  # appid is the user's Yahoo app id (http://developer.yahoo.com/geo/placefinder/)
+  attr :appid, true
+  # the number of results to return for each request
+  attr :placefinder_result_count, true
+  # the minimum input quality for a canonical town match
+  attr :min_input_quality, true
   
-    def placefinder_result_count
-      (@placefinder_result_count &&  @placefinder_result_count > 0) ? @placefinder_result_count : 3
-    end
+  def placefinder_result_count
+    (@placefinder_result_count &&  @placefinder_result_count > 0) ? @placefinder_result_count : 3
+  end
   
-    def min_input_quality
-      (@min_input_quality && @min_input_quality > 0) ? @min_input_quality : 40
-    end
+  def min_input_quality
+    (@min_input_quality && @min_input_quality > 0) ? @min_input_quality : 40
+  end
   
-    def min_result_quality
-      (@min_result_quality && @min_result_quality > 0) ? @min_result_quality : 80
-    end
+  def min_result_quality
+    (@min_result_quality && @min_result_quality > 0) ? @min_result_quality : 80
   end
 end

data/lib/woefoo/geoplanet_adjacency.rb

@@ -1,7 +1,6 @@
-module Woefoo
-  class GeoplanetAdjacency < ActiveRecord::Base
-    set_table_name "geoplanet_adjacencies"
-    belongs_to :place, :class_name => 'GeoplanetPlace', :foreign_key => 'woeid', :primary_key => 'woeid'
-    belongs_to :adjacent_place, :class_name => 'GeoplanetPlace', :foreign_key => 'neighbour_woeid', :primary_key => 'woeid'
-  end
+class Woefoo::GeoplanetAdjacency < ActiveRecord::Base
+  set_table_name "geoplanet_adjacencies"
+  belongs_to :place, :class_name => 'GeoplanetPlace', :foreign_key => 'woeid', :primary_key => 'woeid'
+  belongs_to :adjacent_place, :class_name => 'GeoplanetPlace', :foreign_key => 'neighbour_woeid', :primary_key => 'woeid'
+  
 end

data/lib/woefoo/geoplanet_alias.rb

@@ -1,9 +1,7 @@
-module Woefoo
-  class GeoplanetAlias < ActiveRecord::Base
-    set_table_name "geoplanet_aliases"
-    belongs_to :place,
+class Woefoo::GeoplanetAlias < ActiveRecord::Base
+  set_table_name "geoplanet_aliases"
+  belongs_to :place,
              :class_name => 'GeoplanetPlace',
              :foreign_key => 'woeid',
              :primary_key => 'woeid'
-  end
 end

data/lib/woefoo/geoplanet_place.rb

@@ -1,61 +1,60 @@
-module Woefoo
-  class GeoplanetPlace < ActiveRecord::Base
-    set_table_name "geoplanet_places"
-    set_primary_key 'woeid'
+class Woefoo::GeoplanetPlace < ActiveRecord::Base
+  set_table_name "geoplanet_places"
+  set_primary_key 'woeid'
 
-    has_many :aliases, :class_name => 'GeoplanetAlias', :foreign_key => 'woeid'
-    has_many :adjacencies, :class_name => 'GeoplanetAdjacency', :foreign_key => 'woeid'
-    has_many :adjacent_places, :through => :adjacencies
+  has_many :aliases, :class_name => 'GeoplanetAlias', :foreign_key => 'woeid'
+  has_many :adjacencies, :class_name => 'GeoplanetAdjacency', :foreign_key => 'woeid'
+  has_many :adjacent_places, :through => :adjacencies
 
-    belongs_to :parent,
-      :class_name => "GeoplanetPlace",
-      :foreign_key => 'parent_woeid',
-      :primary_key => 'woeid'
+  belongs_to :parent,
+    :class_name => "GeoplanetPlace",
+    :foreign_key => 'parent_woeid',
+    :primary_key => 'woeid'
 
-    has_ancestry
+  has_ancestry
 
-    def town
-      self.ancestors.find(:first, :conditions => {:place_type => "Town"})
-    end
+  def town
+    self.ancestors.find(:first, :conditions => {:place_type => "Town"})
+  end
 
-    def region
-      self.ancestors.find(:first, :conditions => {:place_type => "State"})
-    end
+  def region
+    self.ancestors.find(:first, :conditions => {:place_type => "State"})
+  end
 
-    def country
-      self.ancestors.find(:first, :conditions => {:place_type => "Country"})
-    end
+  def country
+    self.ancestors.find(:first, :conditions => {:place_type => "Country"})
+  end
 
-    def continent
-      self.ancestors.find(:first, :conditions => {:place_type => "Continent"})
-    end
+  def continent
+    self.ancestors.find(:first, :conditions => {:place_type => "Continent"})
+  end
 
-    def full_name
-      if !@full_name
-        @full_name = self.name
-        @full_name = "#{@full_name}, #{self.region.name}" if self.region
-        @full_name = "#{@full_name}, #{self.country.name}" if self.country
-      end
-  
-      return @full_name
+  def full_name
+    if !@full_name
+      @full_name = self.name
+      @full_name = "#{@full_name}, #{self.region.name}" if self.region
+      @full_name = "#{@full_name}, #{self.country.name}" if self.country
     end
+  
+    return @full_name
+  end
 
-    def full_name_parts
-      ret = {:name => self.name}
-      ret[:region_name] = self.region.name if self.region
-      ret[:country_name] = self.country.name if self.country
-      ret[:continent_name] = self.continent.name if self.continent
-      return ret
-    end
+  def full_name_parts
+    ret = {:name => self.name}
+    ret[:region_name] = self.region.name if self.region
+    ret[:country_name] = self.country.name if self.country
+    ret[:continent_name] = self.continent.name if self.continent
+    return ret
+  end
 
-    def self.build_ancestry_from_parent_ids! parent_id = nil, ancestry = nil
-      parent_id = parent_id || 0
-      self.base_class.all(:conditions => {:parent_woeid => parent_id}).each do |node|
-        node.without_ancestry_callbacks do
-          node.update_attribute ancestry_column, ancestry
-        end
-        build_ancestry_from_parent_ids! node.id, if ancestry.nil? then "#{node.id}" else "#{ancestry}/#{node.id}" end
+  def self.build_ancestry_from_parent_ids! parent_id = nil, ancestry = nil
+    parent_id = parent_id || 0
+    self.base_class.all(:conditions => {:parent_woeid => parent_id}).each do |node|
+      node.without_ancestry_callbacks do
+        node.update_attribute ancestry_column, ancestry
       end
+      build_ancestry_from_parent_ids! node.id, if ancestry.nil? then "#{node.id}" else "#{ancestry}/#{node.id}" end
     end
   end
+
 end

data/lib/woefoo/town_match_validators.rb

@@ -3,38 +3,36 @@
 # and the second proc is the actual validator to run on the place results
 require 'geokit'
 
-module Woefoo
-  module TownMatchValidators
-    extend self
+module Woefoo::TownMatchValidators
+  extend self
   
-    def default_validators
-      [{
-        :conditions => Proc.new {|response|
-           true # If all else fails, use this catch all validator
-        },
-        :validator => Proc.new {|response|
-          best_match=nil
-          if response.input_quality >= min_input_quality
-            response.results.each do |r|
-              if r[:quality] >= response.input_quality && r[:quality] >= min_result_quality
-                place=Woefoo::GeoplanetPlace.find_by_woeid(r[:woeid])
-                if place.place_type=="Town"
-                  # If the query included a country code, make sure the place we're picking is in the same country!
-                  next if (response.query_options.include?(:country_code) && 
-                    response.query_options[:country_code].downcase != place.country_code.downcase)
-                  best_match=r[:woeid] 
-                elsif ["Zip", "Suburb"].include?(place.place_type) && place.town
-                  next if (response.query_options.include?(:country_code) && 
-                    response.query_options[:country_code].downcase != place.country_code.downcase)
-                  best_match=place.town.woeid
-                end
+  def default_validators
+    [{
+      :conditions => Proc.new {|response|
+         true # If all else fails, use this catch all validator
+      },
+      :validator => Proc.new {|response|
+        best_match=nil
+        if response.input_quality >= min_input_quality
+          response.results.each do |r|
+            if r[:quality] >= response.input_quality && r[:quality] >= min_result_quality
+              place=Woefoo::GeoplanetPlace.find_by_woeid(r[:woeid])
+              if place.place_type=="Town"
+                # If the query included a country code, make sure the place we're picking is in the same country!
+                next if (response.query_options.include?(:country_code) && 
+                  response.query_options[:country_code].downcase != place.country_code.downcase)
+                best_match=r[:woeid] 
+              elsif ["Zip", "Suburb"].include?(place.place_type) && place.town
+                next if (response.query_options.include?(:country_code) && 
+                  response.query_options[:country_code].downcase != place.country_code.downcase)
+                best_match=place.town.woeid
               end
-              break if best_match
             end
+            break if best_match
           end
-          best_match
-        }
-      }]
-    end
+        end
+        best_match
+      }
+    }]
   end
 end

data/lib/woefoo/version.rb

@@ -1,3 +1,3 @@
 module Woefoo
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/woefoo.rb

@@ -14,11 +14,25 @@ module Woefoo
   include Woefoo::TownMatchValidators
   extend self
   # Fires a placefinder request to yahoo, returns with suggested places that match the query
-  def lookup(opts={})
+  
+  def lookup_town_woeid(opts={})
     validate!(opts)
-    perform_lookup(opts)
+    woeid=nil
+    # First try the parameterized query, if the user bothered to separate out the fields
+    if opts.length > 1
+      response = perform_parameterized_lookup(opts)
+      woeid = canonical_town_match(response)
+    end
+    
+    if !woeid
+      response = perform_lookup(opts)
+      woeid = canonical_town_match(response)
+    end
+    
+    woeid
   end
 
+  
   # Takes a Woefoo Response, and figures out a Town-level or equivalent
   # woe id that identifies where the queried address is
   def canonical_town_match(response)
@@ -29,8 +43,6 @@ module Woefoo
     end
   end
   
-  private
-  
   def validate!(opts)
     raise "Woefoo.appid is not defined" if !@appid
     if opts.length == 0 || opts.include?(:query) && (opts[:query] == "")
@@ -38,7 +50,8 @@ module Woefoo
     end
   end
   
-  def build_query(opts={})
+  # Build a single query url
+  def build_query_url(opts={})
     s = ""
     if opts.include?(:query)
       s = opts[:query]
@@ -47,12 +60,28 @@ module Woefoo
         s << "#{opts[l]} " if opts.include?(l)
       end
     end
-    ::CGI.escape(s)
+    s = ::CGI.escape(s)
+    "http://where.yahooapis.com/geocode?appid=#{@appid}&count=#{placefinder_result_count}&q=#{s}"
+  end
+  
+  # Build a parameterized query url
+  def build_parameterized_url(opts={})
+    s = ""
+    [:line1, :city, :state, :postal, :country].each do |l|
+      s << "&#{l.to_s}=#{opts[l]} " if opts.include?(l)
+    end
+    s = ::CGI.escape(s)
+    "http://where.yahooapis.com/geocode?appid=#{@appid}&count=#{placefinder_result_count}#{s}"
   end
   
   def perform_lookup(opts)
-    query = build_query(opts)
-    url = "http://where.yahooapis.com/geocode?appid=#{@appid}&count=#{placefinder_result_count}&q=#{query}"
+    url = build_query_url(opts)
+    tr = Typhoeus::Request.get(url)
+    Woefoo::Response.new(opts, tr) if tr
+  end
+  
+  def perform_parameterized_lookup(opts)
+    url = build_parameterized_url(opts)
     tr = Typhoeus::Request.get(url)
     Woefoo::Response.new(opts, tr) if tr
   end

data/test/woefoo_test.rb

@@ -5,7 +5,7 @@ class WoefooTest < Test::Unit::TestCase
     should "throw an exception if appid is not defined" do
       assert_raises RuntimeError do 
         begin
-          Woefoo.lookup(COPTER_WORLD_HQ)
+          Woefoo.lookup_town_woeid(COPTER_WORLD_HQ)
         rescue RuntimeError => ex
           assert_equal ex.message, "Woefoo.appid is not defined"
           raise
@@ -17,7 +17,7 @@ class WoefooTest < Test::Unit::TestCase
       assert_raises RuntimeError do 
         begin
           Woefoo.appid=TEST_APPID
-          Woefoo.lookup
+          Woefoo.lookup_town_woeid
         rescue RuntimeError => ex
           assert ex.message.include?("Invalid query")
           raise
@@ -29,7 +29,7 @@ class WoefooTest < Test::Unit::TestCase
       assert_raises RuntimeError do 
         begin
           Woefoo.appid=TEST_APPID
-          Woefoo.lookup({:query => ""})
+          Woefoo.lookup_town_woeid({:query => ""})
         rescue RuntimeError => ex
           assert ex.message.include?("Invalid query")
           raise
@@ -39,15 +39,7 @@ class WoefooTest < Test::Unit::TestCase
   end
   
   context "lookup url generation" do
-    should "use default placefinder count if none is defined" do
-      typh_resp = Typhoeus::Response.new
-      Woefoo.appid=TEST_APPID
-      url_should_be="#{YAHOO_BASE_URL}?appid=#{TEST_APPID}&count=3&q=#{::CGI.escape(COPTER_WORLD_HQ)}"
-      Typhoeus::Request.expects(:get).with(url_should_be).returns(typh_resp).at_least_once
-      Woefoo::Response.expects(:new).with({:query => COPTER_WORLD_HQ}, typh_resp).at_least_once
-      
-      Woefoo.lookup({:query => COPTER_WORLD_HQ})
-    end
+
   end
   
   context "canonical town matching" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: woefoo
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - smnirven
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 -04:00
-default_executable: 
+date: 2011-11-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: typhoeus
@@ -126,7 +125,6 @@ files:
 - test/test_helper.rb
 - test/woefoo_test.rb
 - woefoo.gemspec
-has_rdoc: true
 homepage: http://smnirven.com
 licenses: []
 
@@ -156,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: woefoo
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Lookup yahoo woe (where on earth) ids