rails-geocoder 0.9.8 → 0.9.9

data/lib/geocoder/railtie.rb

@@ -17,52 +17,64 @@ module Geocoder
 
   class Railtie
     def self.insert
-
       return unless defined?(::ActiveRecord)
+      ::ActiveRecord::Base.extend(ModelMethods)
+    end
+  end
 
-      ##
-      # Add methods to ActiveRecord::Base so Geocoder is accessible by models.
-      #
-      ::ActiveRecord::Base.class_eval do
+  ##
+  # Methods available in the model class before Geocoder is invoked.
+  #
+  module ModelMethods
 
-        ##
-        # Set attribute names and include the Geocoder module.
-        #
-        def self.geocoded_by(address_attr, options = {})
-          _geocoder_init(
-            :user_address => address_attr,
-            :latitude  => options[:latitude]  || :latitude,
-            :longitude => options[:longitude] || :longitude
-          )
-        end
+    ##
+    # Set attribute names and include the Geocoder module.
+    #
+    def geocoded_by(address_attr, options = {}, &block)
+      geocoder_init(
+        :geocode       => true,
+        :user_address  => address_attr,
+        :latitude      => options[:latitude]  || :latitude,
+        :longitude     => options[:longitude] || :longitude,
+        :geocode_block => block
+      )
+    end
 
-        ##
-        # Set attribute names and include the Geocoder module.
-        #
-        def self.reverse_geocoded_by(latitude_attr, longitude_attr, options = {})
-          _geocoder_init(
-            :fetched_address => options[:address] || :address,
-            :latitude  => latitude_attr,
-            :longitude => longitude_attr
-          )
-        end
+    ##
+    # Set attribute names and include the Geocoder module.
+    #
+    def reverse_geocoded_by(latitude_attr, longitude_attr, options = {}, &block)
+      geocoder_init(
+        :reverse_geocode => true,
+        :fetched_address => options[:address] || :address,
+        :latitude        => latitude_attr,
+        :longitude       => longitude_attr,
+        :reverse_block   => block
+      )
+    end
 
-        def self._geocoder_init(options)
-          unless _geocoder_initialized?
-            class_inheritable_reader :geocoder_options
-            class_inheritable_hash_writer :geocoder_options
-          end
-          self.geocoder_options = options
-          unless _geocoder_initialized?
-            include Geocoder::ActiveRecord
-          end
-        end
+    def geocoder_options
+      @geocoder_options
+    end
 
-        def self._geocoder_initialized?
-          included_modules.include? Geocoder::ActiveRecord
-        end
+
+    private # ----------------------------------------------------------------
+
+    def geocoder_init(options)
+      unless geocoder_initialized?
+        @geocoder_options = {}
+        require 'geocoder/orms/active_record'
+        include Geocoder::Orm::ActiveRecord
       end
+      @geocoder_options.merge! options
+    end
 
+    def geocoder_initialized?
+      begin
+        included_modules.include? Geocoder::Orm::ActiveRecord
+      rescue NameError
+        false
+      end
     end
   end
 end

data/lib/geocoder/request.rb

@@ -0,0 +1,17 @@
+require 'geocoder'
+
+module Geocoder
+  module Request
+
+    def location
+      unless defined?(@location)
+        @location = Geocoder.search(ip)
+      end
+      @location
+    end
+  end
+end
+
+if defined?(Rack) and defined?(Rack::Request)
+  Rack::Request.send :include, Geocoder::Request
+end

data/lib/geocoder/results/base.rb

@@ -0,0 +1,58 @@
+module Geocoder
+  module Result
+    class Base
+      attr_accessor :data
+
+      ##
+      # Takes a hash of result data from a parsed Google result document.
+      #
+      def initialize(data)
+        @data = data
+      end
+
+      ##
+      # A string in the given format.
+      #
+      def address(format = :full)
+        fail
+      end
+
+      ##
+      # A two-element array: [lat, lon].
+      #
+      def coordinates
+        [@data['latitude'].to_f, @data['longitude'].to_f]
+      end
+
+      def latitude
+        coordinates[0]
+      end
+
+      def longitude
+        coordinates[1]
+      end
+
+      def country
+        fail
+      end
+
+      def country_code
+        fail
+      end
+
+      def [](i)
+        if i == 0
+          warn "DEPRECATION WARNING: You called '[0]' on a Geocoder::Result object. Geocoder.search(...) now returns a single result instead of an array so this is no longer necessary. This warning will be removed and an error will result in geocoder 1.0."
+        elsif i.is_a?(Fixnum)
+          warn "DEPRECATION WARNING: You tried to access a Geocoder result but Geocoder.search(...) now returns a single result instead of an array. This warning will be removed and an error will result in geocoder 1.0."
+        end
+        self
+      end
+
+      def first
+        warn "DEPRECATION WARNING: You called '.first' on a Geocoder::Result object. Geocoder.search(...) now returns a single result instead of an array so this is no longer necessary. This warning will be removed and an error will result in geocoder 1.0."
+        self
+      end
+    end
+  end
+end

data/lib/geocoder/results/freegeoip.rb

@@ -0,0 +1,37 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Freegeoip < Base
+
+    def address(format = :full)
+      "#{city}#{', ' + region_code unless region_code == ''} #{postal_code}, #{country}"
+    end
+
+    def city
+      @data['city']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def country_code
+      @data['country_code']
+    end
+
+    def postal_code
+      @data['zipcode']
+    end
+
+    def self.response_attributes
+      %w[city region_code region_name metrocode
+        zipcode country_name country_code ip]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder/{result.rb → results/google.rb}

@@ -1,12 +1,30 @@
-module Geocoder
-  class Result
-    attr_accessor :data
+require 'geocoder/results/base'
 
-    ##
-    # Takes a hash of result data from a parsed Google result document.
-    #
-    def initialize(data)
-      @data = data
+module Geocoder::Result
+  class Google < Base
+
+    def coordinates
+      ['lat', 'lng'].map{ |i| geometry['location'][i] }
+    end
+
+    def address(format = :full)
+      formatted_address
+    end
+
+    def city
+      address_components_of_type(:locality).first['long_name']
+    end
+
+    def country
+      address_components_of_type(:country).first['long_name']
+    end
+
+    def country_code
+      address_components_of_type(:country).first['short_name']
+    end
+
+    def postal_code
+      address_components_of_type(:postal_code).first['long_name']
     end
 
     def types

data/lib/geocoder/results/yahoo.rb

@@ -0,0 +1,40 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Yahoo < Base
+
+    def address(format = :full)
+      (1..4).to_a.map{ |i| @data["line#{i}"] }.reject{ |i| i.nil? or i == "" }.join(", ")
+    end
+
+    def city
+      @data['city']
+    end
+
+    def country
+      @data['country']
+    end
+
+    def country_code
+      @data['countrycode']
+    end
+
+    def postal_code
+      @data['postal']
+    end
+
+    def self.response_attributes
+      %w[quality offsetlat offsetlon radius boundingbox name
+        line1 line2 line3 line4 cross house street xstreet unittype unit postal
+        neighborhood city county state country countrycode statecode countycode
+        level0 level1 level2 level3 level4 level0code level1code level2code
+        timezone areacode uzip hash woeid woetype]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/tasks/geocoder.rake

@@ -9,7 +9,7 @@ namespace :geocode do
   desc "Geocode all objects without coordinates."
   task :all => :environment do
     klass.not_geocoded.each do |obj|
-      obj.fetch_coordinates!
+      obj.geocode; obj.save
     end
   end
 end

data/rails-geocoder.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = "rails-geocoder"
+  s.version     = File.read(File.join(File.dirname(__FILE__), 'VERSION'))
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alex Reisner"]
+  s.email       = ["alex@alexreisner.com"]
+  s.homepage    = "http://github.com/alexreisner/geocoder"
+  s.date        = Date.today.to_s
+  s.summary     = "Complete geocoding solution for Ruby."
+  s.description = "Provides object geocoding (by street or IP address), reverse geocoding (coordinates to street address), and distance calculations for geocoded objects. Designed for Rails but works with other frameworks too."
+  s.files       = `git ls-files`.split("\n") - %w[geocoder.gemspec Gemfile init.rb]
+  s.require_paths = ["lib"]
+  s.add_dependency 'json', '>= 1.0.0'
+end

data/test/fixtures/freegeoip_74_200_247_59.json

@@ -0,0 +1,12 @@
+{
+  "city": "Plano",
+  "region_code": "TX",
+  "region_name": "Texas",
+  "metrocode": "623",
+  "zipcode": "75093",
+  "longitude": "-96.8134",
+  "country_name": "United States",
+  "country_code": "US",
+  "ip": "74.200.247.59",
+  "latitude": "33.0347"
+}

data/test/fixtures/google_garbage.json

@@ -0,0 +1,456 @@
+{
+  "status": "OK",
+  "results": [ {
+    "types": [ "postal_code" ],
+    "formatted_address": "Hedge End, Southampton, Hampshire SO30 4RT, UK",
+    "address_components": [ {
+      "long_name": "SO30 4RT",
+      "short_name": "SO30 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Hedge End",
+      "short_name": "Hedge End",
+      "types": [ "sublocality", "political" ]
+    }, {
+      "long_name": "Southampton",
+      "short_name": "Southampton",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Hampshire",
+      "short_name": "Hampshire",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "SO30",
+      "short_name": "SO30",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 50.9173897,
+        "lng": -1.3125111
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 50.9142421,
+          "lng": -1.3156587
+        },
+        "northeast": {
+          "lat": 50.9205373,
+          "lng": -1.3093635
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Enfield, London N13 4RT, UK",
+    "address_components": [ {
+      "long_name": "N13 4RT",
+      "short_name": "N13 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "London",
+      "short_name": "London",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Enfield",
+      "short_name": "Enfield",
+      "types": [ "administrative_area_level_3", "political" ]
+    }, {
+      "long_name": "Greater London",
+      "short_name": "Greater London",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "N13",
+      "short_name": "N13",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 51.6329009,
+        "lng": -0.0994552
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 51.6297533,
+          "lng": -0.1026028
+        },
+        "northeast": {
+          "lat": 51.6360485,
+          "lng": -0.0963076
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Cardiff, South Glamorgan CF5 4RT, UK",
+    "address_components": [ {
+      "long_name": "CF5 4RT",
+      "short_name": "CF5 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Caerau",
+      "short_name": "Caerau",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Cardiff",
+      "short_name": "Cardiff",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "South Glamorgan",
+      "short_name": "South Glam",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "Cardiff",
+      "short_name": "Cardiff",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "CF5",
+      "short_name": "CF5",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 51.4675314,
+        "lng": -3.2642245
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 51.4643838,
+          "lng": -3.2673721
+        },
+        "northeast": {
+          "lat": 51.4706790,
+          "lng": -3.2610769
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Monifieth, Dundee, Angus DD5 4RT, UK",
+    "address_components": [ {
+      "long_name": "DD5 4RT",
+      "short_name": "DD5 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Monifieth",
+      "short_name": "Monifieth",
+      "types": [ "sublocality", "political" ]
+    }, {
+      "long_name": "Dundee",
+      "short_name": "Dundee",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Angus",
+      "short_name": "Angus",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "DD5",
+      "short_name": "DD5",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 56.4840193,
+        "lng": -2.8291620
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 56.4808717,
+          "lng": -2.8323096
+        },
+        "northeast": {
+          "lat": 56.4871669,
+          "lng": -2.8260144
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Reading RG30 4RT, UK",
+    "address_components": [ {
+      "long_name": "RG30 4RT",
+      "short_name": "RG30 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Reading",
+      "short_name": "Reading",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Reading",
+      "short_name": "Reading",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "RG30",
+      "short_name": "RG30",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 51.4554901,
+        "lng": -1.0393378
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 51.4523425,
+          "lng": -1.0424854
+        },
+        "northeast": {
+          "lat": 51.4586377,
+          "lng": -1.0361902
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Blyth, Northumberland NE24 4RT, UK",
+    "address_components": [ {
+      "long_name": "NE24 4RT",
+      "short_name": "NE24 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Blyth",
+      "short_name": "Blyth",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Northumberland",
+      "short_name": "Nthumb",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "NE24",
+      "short_name": "NE24",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 55.1314523,
+        "lng": -1.5533331
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 55.1283047,
+          "lng": -1.5564807
+        },
+        "northeast": {
+          "lat": 55.1345999,
+          "lng": -1.5501855
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Glasgow, Glasgow City G44 4RT, UK",
+    "address_components": [ {
+      "long_name": "G44 4RT",
+      "short_name": "G44 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Glasgow",
+      "short_name": "Glasgow",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Glasgow City",
+      "short_name": "Glasgow City",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "G44",
+      "short_name": "G44",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 55.8234812,
+        "lng": -4.2507991
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 55.8203336,
+          "lng": -4.2539467
+        },
+        "northeast": {
+          "lat": 55.8266288,
+          "lng": -4.2476515
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Waltham Forest, London E17 4RT, UK",
+    "address_components": [ {
+      "long_name": "E17 4RT",
+      "short_name": "E17 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "London",
+      "short_name": "London",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Walthamstow",
+      "short_name": "Walthamstow",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Waltham Forest",
+      "short_name": "Waltham Forest",
+      "types": [ "administrative_area_level_3", "political" ]
+    }, {
+      "long_name": "Greater London",
+      "short_name": "Greater London",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "E17",
+      "short_name": "E17",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 51.5853714,
+        "lng": -0.0192463
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 51.5822238,
+          "lng": -0.0223939
+        },
+        "northeast": {
+          "lat": 51.5885190,
+          "lng": -0.0160987
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Dunstable, Central Bedfordshire LU5 4RT, UK",
+    "address_components": [ {
+      "long_name": "LU5 4RT",
+      "short_name": "LU5 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Dunstable",
+      "short_name": "Dunstable",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Central Bedfordshire",
+      "short_name": "Central Bedfordshire",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "LU5",
+      "short_name": "LU5",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 51.8869978,
+        "lng": -0.5175666
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 51.8838502,
+          "lng": -0.5207142
+        },
+        "northeast": {
+          "lat": 51.8901454,
+          "lng": -0.5144190
+        }
+      }
+    },
+    "partial_match": true
+  }, {
+    "types": [ "postal_code" ],
+    "formatted_address": "Newton Aycliffe, County Durham DL5 4RT, UK",
+    "address_components": [ {
+      "long_name": "DL5 4RT",
+      "short_name": "DL5 4RT",
+      "types": [ "postal_code" ]
+    }, {
+      "long_name": "Newton Aycliffe",
+      "short_name": "Newton Aycliffe",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Great Aycliffe",
+      "short_name": "Great Aycliffe",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "Durham",
+      "short_name": "Dur",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "United Kingdom",
+      "short_name": "GB",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "DL5",
+      "short_name": "DL5",
+      "types": [ "postal_code_prefix", "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 54.6323273,
+        "lng": -1.5704658
+      },
+      "location_type": "APPROXIMATE",
+      "viewport": {
+        "southwest": {
+          "lat": 54.6291797,
+          "lng": -1.5736134
+        },
+        "northeast": {
+          "lat": 54.6354749,
+          "lng": -1.5673182
+        }
+      }
+    },
+    "partial_match": true
+  } ]
+}