geokit 1.7.0.rc1 → 1.7.0

data/fixtures/vcr_cassettes/yahoo_city.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://yboss.yahooapis.com/geo/placefinder?flags=J&oauth_consumer_key=dj0yJmk9cXByQVN2WHZmTVhDJmQ9WVdrOVZscG1WVWhOTldrbWNHbzlNakF6TlRJME16UTJNZy0tJnM9Y29uc3VtZXJzZWNyZXQmeD0zNg--&oauth_nonce=731410e6df&oauth_signature=%2Bde/2eYXvMPhoRu5MUdjhPct3xY=&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1384355278&oauth_version=1.0&q=San%20Francisco,%20CA
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 13 Nov 2013 15:08:00 GMT
+      P3p:
+      - policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV
+        TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY
+        ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"bossresponse":{"responsecode":"200","placefinder":{"start":"0","count":"1","request":"flags=J&q=San%20Francisco%2C%20CA","results":[{"quality":"40","latitude":"37.77713","longitude":"-122.41964","offsetlat":"37.77713","offsetlon":"-122.41964","radius":"8800","name":"","line1":"","line2":"San
+        Francisco, CA","line3":"","line4":"United States","house":"","street":"","xstreet":"","unittype":"","unit":"","postal":"","neighborhood":"","city":"San
+        Francisco","county":"San Francisco County","state":"California","country":"United
+        States","countrycode":"US","statecode":"CA","countycode":"","uzip":"94102","hash":"","woeid":"2487956","woetype":"7"}]}}}'
+    http_version: 
+  recorded_at: Wed, 13 Nov 2013 15:07:58 GMT
+recorded_with: VCR 2.7.0

data/fixtures/vcr_cassettes/yahoo_full.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://yboss.yahooapis.com/geo/placefinder?flags=J&oauth_consumer_key=dj0yJmk9cXByQVN2WHZmTVhDJmQ9WVdrOVZscG1WVWhOTldrbWNHbzlNakF6TlRJME16UTJNZy0tJnM9Y29uc3VtZXJzZWNyZXQmeD0zNg--&oauth_nonce=7a0ce94e38&oauth_signature=aTamhmDusxM4xYZXWocDEb5YmyE=&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1384355278&oauth_version=1.0&q=100%20Spear%20St,%20San%20Francisco,%20CA,%2094105-1522,%20US
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 13 Nov 2013 15:08:01 GMT
+      P3p:
+      - policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV
+        TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY
+        ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"bossresponse":{"responsecode":"200","placefinder":{"start":"0","count":"1","request":"flags=J&q=100%20Spear%20St%2C%20San%20Francisco%2C%20CA%2C%2094105-1522%2C%20US","results":[{"quality":"87","latitude":"37.792332","longitude":"-122.393791","offsetlat":"37.792198","offsetlon":"-122.393898","radius":"400","name":"","line1":"100
+        Spear St","line2":"San Francisco, CA 94105-1578","line3":"","line4":"United
+        States","house":"100","street":"Spear St","xstreet":"","unittype":"","unit":"","postal":"94105-1578","neighborhood":"","city":"San
+        Francisco","county":"San Francisco County","state":"California","country":"United
+        States","countrycode":"US","statecode":"CA","countycode":"","uzip":"94105","hash":"0FA06819B5F53E75","woeid":"12797156","woetype":"11"}]}}}'
+    http_version: 
+  recorded_at: Wed, 13 Nov 2013 15:07:59 GMT
+recorded_with: VCR 2.7.0

data/fixtures/vcr_cassettes/yahoo_no_results.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://yboss.yahooapis.com/geo/placefinder?flags=J&oauth_consumer_key=dj0yJmk9cXByQVN2WHZmTVhDJmQ9WVdrOVZscG1WVWhOTldrbWNHbzlNakF6TlRJME16UTJNZy0tJnM9Y29uc3VtZXJzZWNyZXQmeD0zNg--&oauth_nonce=2c5ad2f846&oauth_signature=h2eR3b0GSWsgqU2nJhd1jPP8ihI=&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1384355895&oauth_version=1.0&q=ZZ,%20ZZ,%20ZZ
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 13 Nov 2013 15:18:19 GMT
+      P3p:
+      - policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV
+        TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY
+        ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"bossresponse":{"responsecode":"200","placefinder":{"start":"0","count":"0","request":"flags=J&q=ZZ%2C%20ZZ%2C%20ZZ"}}}'
+    http_version: 
+  recorded_at: Wed, 13 Nov 2013 15:18:16 GMT
+recorded_with: VCR 2.7.0

data/geokit.gemspec

@@ -10,13 +10,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["michael+geokit@noack.com.au"]
   spec.description   = %q{Geokit provides geocoding and distance calculation in an easy-to-use API}
   spec.summary       = %q{Geokit: encoding and distance calculation gem}
-  spec.homepage      = "http://geokit.org"
+  spec.homepage      = "http://github.com/geokit/geokit"
   spec.license       = "MIT"
 
   spec.has_rdoc = true
   spec.rdoc_options = ["--main", "README.markdown"]
   spec.extra_rdoc_files = ["README.markdown"]
-  spec.extensions = 'ext/mkrf_conf.rb'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -29,5 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov-rcov"
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock' # used in vcr
 end
-

data/lib/geokit/geocoders.rb

@@ -38,7 +38,9 @@ module Geokit
     @@proxy_user = nil
     @@proxy_pass = nil
     @@request_timeout = nil
-    @@yahoo = 'REPLACE_WITH_YOUR_YAHOO_KEY'
+    @@yahoo_consumer_key = 'REPLACE_WITH_YOUR_YAHOO_BOSS_OAUTH_CONSUMER_KEY'
+    @@yahoo_consumer_secret = 'REPLACE_WITH_YOUR_YAHOO_BOSS_OAUTH_CONSUMER_SECRET'
+    @@yandex = 'REPLACE_WITH_YOUR_YANDEX_KEY'
     @@google = 'REPLACE_WITH_YOUR_GOOGLE_KEY'
     @@google_client_id = nil
     @@google_cryptographic_key = nil
@@ -133,10 +135,11 @@ module Geokit
         uri = URI.parse(url)
         req = Net::HTTP::Get.new(url)
         req.basic_auth(uri.user, uri.password) if uri.userinfo
-        res = Net::HTTP::Proxy(GeoKit::Geocoders::proxy_addr,
+        res = Net::HTTP::new(uri.host, uri.port,
+                GeoKit::Geocoders::proxy_addr,
                 GeoKit::Geocoders::proxy_port,
                 GeoKit::Geocoders::proxy_user,
-                GeoKit::Geocoders::proxy_pass).start(uri.host, uri.port) { |http| http.get(uri.path + "?" + uri.query) }
+                GeoKit::Geocoders::proxy_pass).start { |http| http.request(req) }
         return res
       end
 

data/lib/geokit/mappable.rb

@@ -237,11 +237,6 @@ module Geokit
       @lng=lng.to_f if lng
     end
 
-    def ll=(hash)
-      self.lat = hash['lat']
-      self.lng = hash['lng']
-    end
-
     # Returns the lat and lng attributes as a comma-separated string.
     def ll
       "#{lat},#{lng}"

data/lib/geokit/services/google3.rb

@@ -10,7 +10,7 @@ module Geokit
         res = self.call_geocoder_service(submit_url)
         return GeoLoc.new unless (res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPOK))
         json = res.body
-        logger.debug "Google reverse-geocoding. LL: #{latlng}. Result: #{json}"
+        logger.debug "Google reverse-geocoding. LL: #{latlng}. Result: #{CGI.escape(json)}"
         return self.json2GeoLoc(json)
       end
 
@@ -41,14 +41,15 @@ module Geokit
       # Geokit::Geocoders::GoogleGeocoder.geocode('Winnetka', :bias => bounds).state # => 'CA'
       def self.do_geocode(address, options = {})
         bias_str = options[:bias] ? construct_bias_string_from_options(options[:bias]) : ''
+        language_str = options[:language] ? "&language=#{options[:language]}" : ''
         address_str = address.is_a?(GeoLoc) ? address.to_geocodeable_s : address
-        submit_url = submit_url("/maps/api/geocode/json?sensor=false&address=#{Geokit::Inflector::url_escape(address_str)}#{bias_str}")
+        submit_url = submit_url("/maps/api/geocode/json?sensor=false&address=#{Geokit::Inflector::url_escape(address_str)}#{bias_str}#{language_str}")
 
         res = self.call_geocoder_service(submit_url)
         return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
 
         json = res.body
-        logger.debug "Google geocoding. Address: #{address}. Result: #{json}"
+        logger.debug "Google geocoding. Address: #{address}. Result: #{CGI.escape(json)}"
 
         return self.json2GeoLoc(json, address)
       end
@@ -85,7 +86,8 @@ module Geokit
           "&region=#{bias.to_s.downcase}"
         when Bounds
           # viewport biasing
-          Geokit::Inflector::url_escape("&bounds=#{bias.sw.to_s}|#{bias.ne.to_s}")
+          url_escaped_string = Geokit::Inflector::url_escape("#{bias.sw.to_s}|#{bias.ne.to_s}")
+          "&bounds=#{url_escaped_string}"
         end
       end
 
@@ -180,12 +182,17 @@ module Geokit
           res.accuracy = 7
         end
 
-        res.ll = addr['geometry']['location']
-
-        ne = Geokit::LatLng.new
-        ne.ll = addr['geometry']['viewport']['northeast']
-        sw = Geokit::LatLng.new
-        sw.ll = addr['geometry']['viewport']['southwest']
+        res.lat=addr['geometry']['location']['lat'].to_f
+        res.lng=addr['geometry']['location']['lng'].to_f
+
+        ne=Geokit::LatLng.new(
+          addr['geometry']['viewport']['northeast']['lat'].to_f,
+          addr['geometry']['viewport']['northeast']['lng'].to_f
+        )
+        sw=Geokit::LatLng.new(
+          addr['geometry']['viewport']['southwest']['lat'].to_f,
+          addr['geometry']['viewport']['southwest']['lng'].to_f
+        )
         res.suggested_bounds = Geokit::Bounds.new(sw,ne)
 
         res

data/lib/geokit/services/ip.rb

@@ -57,7 +57,7 @@ module Geokit
         res = GeoLoc.new
         res.provider = 'hostip'
         res.city, res.state = yaml['City'].split(', ')
-        country, res.country_code = yaml['Country'].split(' (')
+        res.country, res.country_code = yaml['Country'].split(' (')
         res.lat = yaml['Latitude']
         res.lng = yaml['Longitude']
         res.country_code.chop!

data/lib/geokit/services/maxmind.rb

@@ -0,0 +1,41 @@
+require "geoip"
+
+module Geokit
+  module Geocoders
+
+  @@geoip_data_path = File.expand_path(File.join(File.dirname(__FILE__),'../../..','data','GeoLiteCity.dat')) 
+  __define_accessors
+
+    # Provides geocoding based upon an IP address.  The underlying web service is MaxMind
+    class MaxmindGeocoder < Geocoder
+      private
+
+      def self.do_geocode(ip, options = {})
+        # return GeoLoc.new unless /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(ip)
+        return maxmind(ip)
+      rescue
+        logger.error "Caught an error during MaxMind geocoding call: " + $!.to_s
+        return GeoLoc.new
+      end
+
+
+      def self.maxmind(ip)
+        res = GeoIP.new(Geokit::Geocoders::geoip_data_path).city(ip)
+
+        loc = GeoLoc.new(
+          :provider => 'maxmind_city',
+          :lat      => res.latitude,
+          :lng      => res.longitude,
+          :city     => res.city_name,
+          :state    => res.region_name,
+          :zip      => res.postal_code,
+          :country_code => res.country_code3
+        )
+
+        # loc.success = res.city_name && res.city_name != ''
+        loc.success = (res.longitude > 0 && res.latitude > 0)
+        return loc
+      end
+    end
+  end
+end

data/lib/geokit/services/ripe.rb

@@ -0,0 +1,32 @@
+module Geokit
+  module Geocoders
+    # Provides geocoding based upon an IP address.  The underlying web service is geoplugin.net
+    class RipeGeocoder < Geocoder
+      private
+
+      def self.do_geocode(ip, options = {})
+        return GeoLoc.new unless /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(ip)
+        response = self.call_geocoder_service("http://stat.ripe.net/data/geoloc/data.json?resource=#{ip}")
+        return response.is_a?(Net::HTTPSuccess) ? parse_json(response.body) : GeoLoc.new
+      rescue
+        logger.error "Caught an error during GeoPluginGeocoder geocoding call: #{$!}"
+        return GeoLoc.new
+      end
+
+      def self.parse_json(json)
+        json = MultiJson.load(json)
+        geo = GeoLoc.new
+        data = json['data']['locations'][0]
+
+        geo.provider='RIPE'
+        geo.city = data['city']
+        geo.country_code = data['country']
+        geo.lat = data['latitude']
+        geo.lng = data['longitude']
+        geo.success = (data['status_code'] == 200)
+        return geo
+      end
+    end
+
+  end
+end

data/lib/geokit/services/yahoo.rb

@@ -5,12 +5,21 @@ module Geokit
     class YahooGeocoder < Geocoder
 
       private
+      def self.submit_url(query_string)
+        o = OauthUtil.new
+        o.consumer_key = Geocoders::yahoo_consumer_key
+        o.consumer_secret = Geocoders::yahoo_consumer_secret
+        base = "http://yboss.yahooapis.com/geo/placefinder"
+        parsed_url = URI.parse("#{base}#{query_string}")
+        "http://yboss.yahooapis.com/geo/placefinder?#{o.sign(parsed_url).query_string}"
+      end
 
       # Template method which does the geocode lookup.
       def self.do_geocode(address, options = {})
         address_str = address.is_a?(GeoLoc) ? address.to_geocodeable_s : address
-        url="http://where.yahooapis.com/geocode?flags=J&appid=#{Geokit::Geocoders::yahoo}&q=#{Geokit::Inflector::url_escape(address_str)}"
-        res = self.call_geocoder_service(url)
+        submit_url = submit_url("?q=#{Geokit::Inflector::url_escape(address_str)}&flags=J")
+
+        res = self.call_geocoder_service(submit_url)
         return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
         json = res.body
         logger.debug "Yahoo geocoding. Address: #{address}. Result: #{json}"
@@ -20,9 +29,9 @@ module Geokit
       def self.json2GeoLoc(json, address)
         results = MultiJson.load(json)
 
-        if results['ResultSet']['Error'] == 0 && results['ResultSet']['Results'] != nil && results['ResultSet']['Results'].first != nil
+        if results && results['bossresponse'] && results['bossresponse']['placefinder'] && results['bossresponse']['placefinder']['results'] && results['bossresponse']['placefinder']['results'].first != nil
           geoloc = nil
-          results['ResultSet']['Results'].each do |result|
+          results['bossresponse']['placefinder']['results'].each do |result|
             extracted_geoloc = extract_geoloc(result)
             if geoloc.nil?
               geoloc = extracted_geoloc
@@ -52,7 +61,7 @@ module Geokit
         geoloc.state          = geoloc.is_us? ? result_json['statecode'] : result_json['state']
         geoloc.zip            = result_json['postal']
 
-        geoloc.precision = case result_json['quality']
+        geoloc.precision = case result_json['quality'].to_i
                            when 9,10         then 'country'
                            when 19..30       then 'state'
                            when 39,40        then 'city'
@@ -73,3 +82,114 @@ module Geokit
     end
   end
 end
+
+# Oauth Util
+# from gist: https://gist.github.com/erikeldridge/383159
+# A utility for signing an url using OAuth in a way that's convenient for debugging
+# Note: the standard Ruby OAuth lib is here http://github.com/mojodna/oauth
+# License: http://gist.github.com/375593
+# Usage: see example.rb below
+ 
+require 'uri'
+require 'cgi'
+require 'openssl'
+require 'base64'
+ 
+class OauthUtil
+  
+  attr_accessor :consumer_key, :consumer_secret, :token, :token_secret, :req_method, 
+                :sig_method, :oauth_version, :callback_url, :params, :req_url, :base_str
+  
+  def initialize
+    @consumer_key = ''
+    @consumer_secret = ''
+    @token = ''
+    @token_secret = ''
+    @req_method = 'GET'
+    @sig_method = 'HMAC-SHA1'
+    @oauth_version = '1.0'
+    @callback_url = ''
+  end
+  
+  # openssl::random_bytes returns non-word chars, which need to be removed. using alt method to get length
+  # ref http://snippets.dzone.com/posts/show/491
+  def nonce
+    Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first
+  end
+  
+  def percent_encode( string )
+    
+    # ref http://snippets.dzone.com/posts/show/1260
+    return URI.escape( string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]") ).gsub('*', '%2A')
+  end
+  
+  # @ref http://oauth.net/core/1.0/#rfc.section.9.2
+  def signature
+    key = percent_encode( @consumer_secret ) + '&' + percent_encode( @token_secret )
+    
+    # ref: http://blog.nathanielbibler.com/post/63031273/openssl-hmac-vs-ruby-hmac-benchmarks
+    digest = OpenSSL::Digest::Digest.new( 'sha1' )
+    hmac = OpenSSL::HMAC.digest( digest, key, @base_str )
+    
+    # ref http://groups.google.com/group/oauth-ruby/browse_thread/thread/9110ed8c8f3cae81
+    Base64.encode64( hmac ).chomp.gsub( /\n/, '' )
+  end
+  
+  # sort (very important as it affects the signature), concat, and percent encode
+  # @ref http://oauth.net/core/1.0/#rfc.section.9.1.1
+  # @ref http://oauth.net/core/1.0/#9.2.1
+  # @ref http://oauth.net/core/1.0/#rfc.section.A.5.1
+  def query_string
+    pairs = []
+    @params.sort.each { | key, val | 
+      pairs.push( "#{ percent_encode( key ) }=#{ percent_encode( val.to_s ) }" )
+    }
+    pairs.join '&'
+  end
+
+  def timestamp
+    Time.now.to_i.to_s
+  end
+  
+  # organize params & create signature
+  def sign( parsed_url )
+    
+    @params = {
+      'oauth_consumer_key' => @consumer_key,
+      'oauth_nonce' => nonce,
+      'oauth_signature_method' => @sig_method,
+      'oauth_timestamp' => timestamp,
+      'oauth_version' => @oauth_version
+    }
+ 
+    # if url has query, merge key/values into params obj overwriting defaults
+    if parsed_url.query
+      CGI.parse( parsed_url.query ).each do |k,v|
+        if v.is_a?(Array) && v.count == 1
+          @params[k] = v.first
+        else
+          @params[k] = v
+        end
+      end
+    end
+    
+    # @ref http://oauth.net/core/1.0/#rfc.section.9.1.2
+    @req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path
+    
+    # create base str. make it an object attr for ez debugging
+    # ref http://oauth.net/core/1.0/#anchor14
+    @base_str = [ 
+      @req_method, 
+      percent_encode( req_url ), 
+      
+      # normalization is just x-www-form-urlencoded
+      percent_encode( query_string ) 
+      
+    ].join( '&' )
+ 
+    # add signature
+    @params[ 'oauth_signature' ] = signature
+    
+    return self
+  end
+end