geokit 1.8.5 → 1.9.0

data/lib/geokit/core_ext.rb

@@ -1,5 +1,5 @@
 unless nil.respond_to?(:try)
-  class Object 
+  class Object
     def try(*a, &b)
       if a.empty? && block_given?
         yield self

data/lib/geokit/geo_loc.rb

@@ -5,8 +5,8 @@ module Geokit
   # the "full address" method for geocoders that do not provide a
   # full address in their results (for example, Yahoo), and the "is_us" method.
   #
-  # Some geocoders can return multple results. Geoloc can capture multiple results through
-  # its "all" method.
+  # Some geocoders can return multple results. Geoloc can capture multiple
+  # results through its "all" method.
   #
   # For the geocoder setting the results, it would look something like this:
   #     geo=GeoLoc.new(first_result)
@@ -20,40 +20,50 @@ module Geokit
   #     puts geo.all.first        # all is just an array or additional geolocs,
   #                                 so do what you want with it
   class GeoLoc < LatLng
-
-    # Location attributes.  Full address is a concatenation of all values.  For example:
+    # Location attributes. Full address is a concatenation of all values.
+    # For example:
     # 100 Spear St, San Francisco, CA, 94101, US
-    # Street number and street name are extracted from the street address attribute if they don't exist
-    attr_accessor :street_number, :street_name, :street_address, :city, :state, :zip, :country_code, :country
-    attr_accessor :full_address, :all, :district, :province, :sub_premise, :neighborhood
-    # Attributes set upon return from geocoding.  Success will be true for successful
-    # geocode lookups.  The provider will be set to the name of the providing geocoder.
-    # Finally, precision is an indicator of the accuracy of the geocoding.
+    # Street number and street name are extracted from the street address
+    # attribute if they don't exist
+    attr_accessor :street_number, :street_name, :street_address, :city, :state,
+                  :state_name, :state_code, :zip, :country_code, :country
+    attr_accessor :full_address, :all, :district, :province, :sub_premise,
+                  :neighborhood
+    # Attributes set upon return from geocoding. Success will be true for
+    # successful geocode lookups. The provider will be set to the name of the
+    # providing geocoder. Finally, precision is an indicator of the accuracy of
+    # the geocoding.
     attr_accessor :success, :provider, :precision, :suggested_bounds
-    # accuracy is set for Yahoo and Google geocoders, it is a numeric value of the
-    # precision. see http://code.google.com/apis/maps/documentation/geocoding/#GeocodingAccuracy
+    # accuracy is set for Yahoo and Google geocoders, it is a numeric value of
+    # the precision. see
+    # http://code.google.com/apis/maps/documentation/geocoding/#GeocodingAccuracy
     attr_accessor :accuracy
     # FCC Attributes
     attr_accessor :district_fips, :state_fips, :block_fips
 
-
     # Constructor expects a hash of symbols to correspond with attributes.
-    def initialize(h={})
+    def initialize(h = {})
       @all = [self]
 
-      @street_address=h[:street_address]
-      @sub_premise=nil
-      @street_number=nil
-      @street_name=nil
-      @city=h[:city]
-      @state=h[:state]
-      @zip=h[:zip]
-      @country_code=h[:country_code]
+      @street_address = h[:street_address]
+      @sub_premise = nil
+      @street_number = nil
+      @street_name = nil
+      @city = h[:city]
+      @state = h[:state]
+      @state_code = h[:state_code]
+      @state_name = h[:state_name]
+      @zip = h[:zip]
+      @country_code = h[:country_code]
       @province = h[:province]
-      @success=false
-      @precision='unknown'
-      @full_address=nil
-      super(h[:lat],h[:lng])
+      @success = false
+      @precision = 'unknown'
+      @full_address = nil
+      super(h[:lat], h[:lng])
+    end
+
+    def state
+      @state || @state_code || @state_name
     end
 
     # Returns true if geocoded to the United States.
@@ -65,9 +75,9 @@ module Geokit
       success == true
     end
 
-    # full_address is provided by google but not by yahoo. It is intended that the google
-    # geocoding method will provide the full address, whereas for yahoo it will be derived
-    # from the parts of the address we do have.
+    # full_address is provided by google but not by yahoo. It is intended that
+    # the google geocoding method will provide the full address, whereas for
+    # yahoo it will be derived from the parts of the address we do have.
     def full_address
       @full_address ? @full_address : to_geocodeable_s
     end
@@ -80,38 +90,41 @@ module Geokit
 
     # Returns the street name portion of the street address where possible
     def street_name
-      @street_name||=street_address[street_number.length, street_address.length].strip if street_address
+      @street_name ||= street_address[street_number.length, street_address.length].strip if street_address
       @street_name
     end
 
     # gives you all the important fields as key-value pairs
     def hash
-      res={}
-      [:success, :lat, :lng, :country_code, :city, :state, :zip, :street_address, :province,
-       :district, :provider, :full_address, :is_us?, :ll, :precision, :district_fips, :state_fips,
-       :block_fips, :sub_premise].each { |s| res[s] = self.send(s.to_s) }
+      res = {}
+      fields = [:success, :lat, :lng, :country_code, :city, :state, :zip,
+       :street_address, :province, :district, :provider, :full_address, :is_us?,
+       :ll, :precision, :district_fips, :state_fips, :block_fips, :sub_premise]
+      fields.each { |s| res[s] = send(s.to_s) }
       res
     end
     alias to_hash hash
 
     # Sets the city after capitalizing each word within the city name.
     def city=(city)
-      @city = Geokit::Inflector::titleize(city) if city
+      @city = Geokit::Inflector.titleize(city) if city
     end
 
-    # Sets the street address after capitalizing each word within the street address.
+    # Sets the street address after capitalizing each word within the street
+    # address.
     def street_address=(address)
       @street_address = if address && provider != 'google'
-        Geokit::Inflector::titleize(address)
+        Geokit::Inflector.titleize(address)
       else
         address
       end
     end
 
-    # Returns a comma-delimited string consisting of the street address, city, state,
-    # zip, and country code.  Only includes those attributes that are non-blank.
+    # Returns a comma-delimited string consisting of the street address, city,
+    # state, zip, and country code.  Only includes those attributes that are
+    # non-blank.
     def to_geocodeable_s
-      a=[street_address, district, city, province, state, zip, country_code].compact
+      a = [street_address, district, city, province, state, zip, country_code].compact
       a.delete_if { |e| !e || e == '' }
       a.join(', ')
     end
@@ -128,7 +141,16 @@ module Geokit
 
     # Returns a string representation of the instance.
     def to_s
-      "Provider: #{provider}\nStreet: #{street_address}\nCity: #{city}\nState: #{state}\nZip: #{zip}\nLatitude: #{lat}\nLongitude: #{lng}\nCountry: #{country_code}\nSuccess: #{success}"
+      ["Provider: #{provider}",
+       "Street: #{street_address}",
+       "City: #{city}",
+       "State: #{state}",
+       "Zip: #{zip}",
+       "Latitude: #{lat}",
+       "Longitude: #{lng}",
+       "Country: #{country_code}",
+       "Success: #{success}"
+      ].join("\n")
     end
   end
 end

data/lib/geokit/geocoders.rb

@@ -34,10 +34,10 @@ module Geokit
   module Geocoders
     @@proxy = nil
     @@request_timeout = nil
-    @@provider_order = [:google,:us]
-    @@ip_provider_order = [:geo_plugin,:ip]
-    @@logger=Logger.new(STDOUT)
-    @@logger.level=Logger::INFO
+    @@provider_order = [:google, :us]
+    @@ip_provider_order = [:geo_plugin, :ip]
+    @@logger = Logger.new(STDOUT)
+    @@logger.level = Logger::INFO
     @@domain = nil
     @@net_adapter = Geokit::NetAdapter::NetHttp
     @@secure = true
@@ -45,7 +45,7 @@ module Geokit
 
     def self.__define_accessors
       class_variables.each do |v|
-        sym = v.to_s.delete("@").to_sym
+        sym = v.to_s.delete('@').to_sym
         unless self.respond_to? sym
           module_eval <<-EOS, __FILE__, __LINE__
             def self.#{sym}
@@ -105,7 +105,7 @@ module Geokit
       protected
 
       def self.logger
-        Geokit::Geocoders::logger
+        Geokit::Geocoders.logger
       end
 
       private
@@ -136,8 +136,8 @@ module Geokit
 
       # Call the geocoder service using the timeout if configured.
       def self.call_geocoder_service(url)
-        Timeout::timeout(Geokit::Geocoders::request_timeout) { return self.do_get(url) } if Geokit::Geocoders::request_timeout
-        self.do_get(url)
+        Timeout.timeout(Geokit::Geocoders.request_timeout) { return do_get(url) } if Geokit::Geocoders.request_timeout
+        do_get(url)
       rescue TimeoutError
         nil
       end
@@ -150,7 +150,7 @@ module Geokit
       end
 
       def self.use_https?
-        self.secure && Geokit::Geocoders.secure
+        secure && Geokit::Geocoders.secure
       end
 
       def self.protocol
@@ -163,7 +163,7 @@ module Geokit
       end
 
       def self.net_adapter
-        Geokit::Geocoders::net_adapter
+        Geokit::Geocoders.net_adapter
       end
 
       def self.provider_name
@@ -175,7 +175,7 @@ module Geokit
         case format
         when :json then parse_json(MultiJson.load(body), *args)
         when :xml  then parse_xml(REXML::Document.new(body), *args)
-        when :yaml then parse_yaml(YAML::load(body), *args)
+        when :yaml then parse_yaml(YAML.load(body), *args)
         when :csv  then parse_csv(body.chomp.split(','), *args)
         end
       end
@@ -195,7 +195,7 @@ module Geokit
       def self.transcode_to_utf8(body)
         require 'iconv' unless String.method_defined?(:encode)
         if String.method_defined?(:encode)
-          body.encode!('UTF-8', 'UTF-8', :invalid => :replace)
+          body.encode!('UTF-8', 'UTF-8', invalid: :replace)
         else
           ic = Iconv.new('UTF-8', 'UTF-8//IGNORE')
           body = ic.iconv(body)
@@ -207,7 +207,7 @@ module Geokit
     # "Regular" Address geocoders
     # -------------------------------------------------------------------------------------------
     require File.join(File.dirname(__FILE__), 'geocoders/base_ip')
-    Dir[File.join(File.dirname(__FILE__), "/geocoders/*.rb")].each {|f| require f}
+    Dir[File.join(File.dirname(__FILE__), '/geocoders/*.rb')].each {|f| require f}
 
     require File.join(File.dirname(__FILE__), 'multi_geocoder')
   end

data/lib/geokit/geocoders/bing.rb

@@ -47,15 +47,15 @@ module Geokit
       end
 
       XML_MAPPINGS = {
-        :street_address => 'Address/AddressLine',
-        :full_address   => 'Address/FormattedAddress',
-        :city           => 'Address/Locality',
-        :state          => 'Address/AdminDistrict',
-        :province       => 'Address/AdminDistrict2',
-        :zip            => 'Address/PostalCode',
-        :country        => 'Address/CountryRegion',
-        :lat            => 'Point/Latitude',
-        :lng            => 'Point/Longitude'
+        street_address: 'Address/AddressLine',
+        full_address:   'Address/FormattedAddress',
+        city:           'Address/Locality',
+        state:          'Address/AdminDistrict',
+        province:       'Address/AdminDistrict2',
+        zip:            'Address/PostalCode',
+        country:        'Address/CountryRegion',
+        lat:            'Point/Latitude',
+        lng:            'Point/Longitude'
       }
 
       def self.set_address_components(loc, xml)

data/lib/geokit/geocoders/ca_geocoder.rb

@@ -10,37 +10,37 @@
 #   <longt>-123.153684</longt>
 # </geodata>
 module Geokit
- module Geocoders
-   class CaGeocoder < Geocoder
-     config :key
+  module Geocoders
+    class CaGeocoder < Geocoder
+      config :key
 
-     private
+      private
 
-     # Template method which does the geocode lookup.
-     def self.do_geocode(loc)
-       raise ArgumentError('Geocoder.ca requires a GeoLoc argument') unless loc.is_a?(GeoLoc)
-       process :xml, submit_url(loc), loc
-    end
+      # Template method which does the geocode lookup.
+      def self.do_geocode(loc)
+        raise ArgumentError('Geocoder.ca requires a GeoLoc argument') unless loc.is_a?(GeoLoc)
+        process :xml, submit_url(loc), loc
+      end
 
-    def self.parse_xml(xml, loc)
-       loc.lat = xml.elements['//latt'].text
-       loc.lng = xml.elements['//longt'].text
-       loc.success = true
-       loc
-     end
+      def self.parse_xml(xml, loc)
+        loc.lat = xml.elements['//latt'].text
+        loc.lng = xml.elements['//longt'].text
+        loc.success = true
+        loc
+      end
 
-     # Formats the request in the format acceptable by the CA geocoder.
-     def self.submit_url(loc)
-       args = []
-       args << "stno=#{loc.street_number}" if loc.street_address
-       args << "addresst=#{Geokit::Inflector::url_escape(loc.street_name)}" if loc.street_address
-       args << "city=#{Geokit::Inflector::url_escape(loc.city)}" if loc.city
-       args << "prov=#{loc.state}" if loc.state
-       args << "postal=#{loc.zip}" if loc.zip
-       args << "auth=#{key}" if key
-       args << "geoit=xml"
-       'http://geocoder.ca/?' + args.join('&')
-     end
-   end
- end
+      # Formats the request in the format acceptable by the CA geocoder.
+      def self.submit_url(loc)
+        args = []
+        args << "stno=#{loc.street_number}" if loc.street_address
+        args << "addresst=#{Geokit::Inflector.url_escape(loc.street_name)}" if loc.street_address
+        args << "city=#{Geokit::Inflector.url_escape(loc.city)}" if loc.city
+        args << "prov=#{loc.state}" if loc.state
+        args << "postal=#{loc.zip}" if loc.zip
+        args << "auth=#{key}" if key
+        args << 'geoit=xml'
+        'http://geocoder.ca/?' + args.join('&')
+      end
+    end
+  end
 end

data/lib/geokit/geocoders/fcc.rb

@@ -4,10 +4,11 @@ module Geokit
       self.secure = true
 
       private
+
       # Template method which does the reverse-geocode lookup.
       def self.do_reverse_geocode(latlng)
-        latlng=LatLng.normalize(latlng)
-        url = "#{protocol}://data.fcc.gov/api/block/find?format=json&latitude=#{Geokit::Inflector::url_escape(latlng.lat.to_s)}&longitude=#{Geokit::Inflector::url_escape(latlng.lng.to_s)}"
+        latlng = LatLng.normalize(latlng)
+        url = "#{protocol}://data.fcc.gov/api/block/find?format=json&latitude=#{Geokit::Inflector.url_escape(latlng.lat.to_s)}&longitude=#{Geokit::Inflector.url_escape(latlng.lng.to_s)}"
         process :json, url
       end
 
@@ -25,7 +26,7 @@ module Geokit
       # "status"=>"OK"}
 
       def self.parse_json(results)
-        if results.has_key?('Err') && results['Err']["msg"] == 'There are no results for this location'
+        if results.has_key?('Err') && results['Err']['msg'] == 'There are no results for this location'
           return GeoLoc.new
         end
         # this should probably be smarter.
@@ -45,6 +46,5 @@ module Geokit
         loc
       end
     end
-
   end
 end

data/lib/geokit/geocoders/free_geo_ip.rb

@@ -13,12 +13,12 @@ module Geokit
       end
 
       XML_MAPPINGS = {
-        :city         => 'City',
-        :state        => 'RegionCode',
-        :zip          => 'ZipCode',
-        :country_code => 'CountryCode',
-        :lat          => 'Latitude',
-        :lng          => 'Longitude'
+        city:         'City',
+        state:        'RegionCode',
+        zip:          'ZipCode',
+        country_code: 'CountryCode',
+        lat:          'Latitude',
+        lng:          'Longitude'
       }
 
       def self.parse_xml(xml)
@@ -28,6 +28,5 @@ module Geokit
         loc
       end
     end
-
   end
 end

data/lib/geokit/geocoders/geo_plugin.rb

@@ -13,11 +13,11 @@ module Geokit
       end
 
       XML_MAPPINGS = {
-        :city         => 'geoplugin_city',
-        :state        => 'geoplugin_region',
-        :country_code => 'geoplugin_countryCode',
-        :lat          => 'geoplugin_latitude',
-        :lng          => 'geoplugin_longitude'
+        city:         'geoplugin_city',
+        state:        'geoplugin_region',
+        country_code: 'geoplugin_countryCode',
+        lat:          'geoplugin_latitude',
+        lng:          'geoplugin_longitude'
       }
 
       def self.parse_xml(xml)
@@ -27,6 +27,5 @@ module Geokit
         loc
       end
     end
-
   end
 end

data/lib/geokit/geocoders/geocodio.rb

@@ -11,7 +11,7 @@ module Geokit
 
       def self.submit_url(address)
         params = [
-          "q=#{Geokit::Inflector::url_escape(address)}",
+          "q=#{Geokit::Inflector.url_escape(address)}",
           "api_key=#{key}"
         ].join('&')
 
@@ -28,7 +28,7 @@ module Geokit
             loc.all.push(create_new_loc(address))
           end
         end
-
+        loc.success = true
         loc
       end