geocoder2 0.1.0

data/lib/geocoder2/models/mongo_base.rb

@@ -0,0 +1,60 @@
+require 'geocoder2'
+
+module Geocoder2
+
+  ##
+  # Methods for invoking Geocoder2 in a model.
+  #
+  module Model
+    module MongoBase
+
+      ##
+      # Set attribute names and include the Geocoder2 module.
+      #
+      def geocoded_by(address_attr, options = {}, &block)
+        geocoder2_init(
+          :geocode       => true,
+          :user_address  => address_attr,
+          :coordinates   => options[:coordinates] || :coordinates,
+          :geocode_block => block,
+          :units         => options[:units],
+          :method        => options[:method],
+          :skip_index    => options[:skip_index] || false
+        )
+      end
+
+      ##
+      # Set attribute names and include the Geocoder2 module.
+      #
+      def reverse_geocoded_by(coordinates_attr, options = {}, &block)
+        geocoder2_init(
+          :reverse_geocode => true,
+          :fetched_address => options[:address] || :address,
+          :coordinates     => coordinates_attr,
+          :reverse_block   => block,
+          :units           => options[:units],
+          :method          => options[:method],
+          :skip_index      => options[:skip_index] || false
+        )
+      end
+
+      private # ----------------------------------------------------------------
+
+      def geocoder2_init(options)
+        unless geocoder2_initialized?
+          @geocoder2_options = { }
+          require "geocoder2/stores/#{geocoder2_file_name}"
+          include Geocoder2::Store.const_get(geocoder2_module_name)
+        end
+        @geocoder2_options.merge! options
+      end
+
+      def geocoder2_initialized?
+        included_modules.include? Geocoder2::Store.const_get(geocoder2_module_name)
+      rescue NameError
+        false
+      end
+    end
+  end
+end
+

data/lib/geocoder2/models/mongo_mapper.rb

@@ -0,0 +1,26 @@
+require 'geocoder2/models/base'
+require 'geocoder2/models/mongo_base'
+
+module Geocoder2
+  module Model
+    module MongoMapper
+      include Base
+      include MongoBase
+
+      def self.included(base); base.extend(self); end
+
+      private # --------------------------------------------------------------
+
+      def geocoder2_file_name;   "mongo_mapper"; end
+      def geocoder2_module_name; "MongoMapper"; end
+
+      def geocoder2_init(options)
+        super(options)
+        if options[:skip_index] == false
+          ensure_index [[ geocoder2_options[:coordinates], Mongo::GEO2D ]],
+            :min => -180, :max => 180 # create 2d index
+        end
+      end
+    end
+  end
+end

data/lib/geocoder2/models/mongoid.rb

@@ -0,0 +1,32 @@
+require 'geocoder2/models/base'
+require 'geocoder2/models/mongo_base'
+
+module Geocoder2
+  module Model
+    module Mongoid
+      include Base
+      include MongoBase
+
+      def self.included(base); base.extend(self); end
+
+      private # --------------------------------------------------------------
+
+      def geocoder2_file_name;   "mongoid"; end
+      def geocoder2_module_name; "Mongoid"; end
+
+      def geocoder2_init(options)
+        super(options)
+        if options[:skip_index] == false
+          # create 2d index
+          if defined?(::Mongoid::VERSION) && ::Mongoid::VERSION >= "3"
+            index({ geocoder2_options[:coordinates].to_sym => '2d' }, 
+                  {:min => -180, :max => 180})
+          else
+            index [[ geocoder2_options[:coordinates], '2d' ]],
+              :min => -180, :max => 180
+          end
+        end
+      end
+    end
+  end
+end

data/lib/geocoder2/query.rb

@@ -0,0 +1,107 @@
+module Geocoder2
+  class Query
+    attr_accessor :text, :options
+
+    def initialize(text, options = {})
+      self.text = text
+      self.options = options
+    end
+
+    def execute
+      lookup.search(text, options)
+    end
+
+    def to_s
+      text
+    end
+
+    def sanitized_text
+      if coordinates?
+        if text.is_a?(Array)
+          text.join(',')
+        else
+          text.split(/\s*,\s*/).join(',')
+        end
+      else
+        text
+      end
+    end
+
+    ##
+    # Get a Lookup object (which communicates with the remote geocoding API)
+    # appropriate to the Query text.
+    #
+    def lookup
+      if ip_address?
+        name = Configuration.ip_lookup || Geocoder2::Lookup.ip_services.first
+      else
+        name = Configuration.lookup || Geocoder2::Lookup.street_services.first
+      end
+      Lookup.get(name)
+    end
+
+    def url
+      lookup.query_url(self)
+    end
+
+    ##
+    # Is the Query blank? (ie, should we not bother searching?)
+    # A query is considered blank if its text is nil or empty string AND
+    # no URL parameters are specified.
+    #
+    def blank?
+      !params_given? and (
+        (text.is_a?(Array) and text.compact.size < 2) or
+        text.to_s.match(/\A\s*\z/)
+      )
+    end
+
+    ##
+    # Does the Query text look like an IP address?
+    #
+    # Does not check for actual validity, just the appearance of four
+    # dot-delimited numbers.
+    #
+    def ip_address?
+      !!text.to_s.match(/\A(::ffff:)?(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\z/)
+    end
+
+    ##
+    # Is the Query text a loopback IP address?
+    #
+    def loopback_ip_address?
+      !!(self.ip_address? and (text == "0.0.0.0" or text.to_s.match(/\A127/)))
+    end
+
+    ##
+    # Does the given string look like latitude/longitude coordinates?
+    #
+    def coordinates?
+      text.is_a?(Array) or (
+        text.is_a?(String) and
+        !!text.to_s.match(/\A-?[0-9\.]+, *-?[0-9\.]+\z/)
+      )
+    end
+
+    ##
+    # Return the latitude/longitude coordinates specified in the query,
+    # or nil if none.
+    #
+    def coordinates
+      sanitized_text.split(',') if coordinates?
+    end
+
+    ##
+    # Should reverse geocoding be performed for this query?
+    #
+    def reverse_geocode?
+      coordinates?
+    end
+
+    private # ----------------------------------------------------------------
+
+    def params_given?
+      !!(options[:params].is_a?(Hash) and options[:params].keys.size > 0)
+    end
+  end
+end

data/lib/geocoder2/railtie.rb

@@ -0,0 +1,26 @@
+require 'geocoder2'
+require 'geocoder2/models/active_record'
+
+module Geocoder2
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'geocoder2.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          Geocoder2::Railtie.insert
+        end
+      end
+      rake_tasks do
+        load "tasks/geocoder2.rake"
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      if defined?(::ActiveRecord)
+        ::ActiveRecord::Base.extend(Model::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/geocoder2/request.rb

@@ -0,0 +1,23 @@
+require 'geocoder2'
+
+module Geocoder2
+  module Request
+
+    def location
+      unless defined?(@location)
+        if env.has_key?('HTTP_X_REAL_IP')
+          @location = Geocoder2.search(env['HTTP_X_REAL_IP']).first
+        elsif env.has_key?('HTTP_X_FORWARDED_FOR')
+          @location = Geocoder2.search(env['HTTP_X_FORWARDED_FOR'].split(/\s*,\s*/)[0]).first
+        else
+          @location = Geocoder2.search(ip).first
+        end
+      end
+      @location
+    end
+  end
+end
+
+if defined?(Rack) and defined?(Rack::Request)
+  Rack::Request.send :include, Geocoder2::Request
+end

data/lib/geocoder2/results/baidu.rb

@@ -0,0 +1,79 @@
+require 'geocoder2/results/base'
+
+module Geocoder2::Result
+  class Baidu < Base
+
+    def coordinates
+      ['lat', 'lng'].map{ |i| @data['location'][i] }
+    end
+
+    def address
+      @data['formatted_address']
+    end
+
+    def state
+      province
+    end
+    
+    def province
+      @data['addressComponent']['province']
+    end
+
+    def city
+      @data['addressComponent']['city']
+    end
+
+    def district
+      @data['addressComponent']['district']
+    end
+
+    def street
+      @data['addressComponent']['street']
+    end
+
+    def street_number
+      @data['addressComponent']['street_number']
+    end
+
+    def formatted_address
+      @data['formatted_address']
+    end
+
+    def address_components
+      @data['addressComponent']
+    end
+
+    def state_code
+      ""
+    end
+
+    def postal_code
+      ""
+    end
+
+    def country
+      "China"
+    end
+
+    def country_code
+      "CN"
+    end
+
+    ##
+    # Get address components of a given type. Valid types are defined in
+    # Baidu's Geocoding API documentation and include (among others):
+    #
+    #   :business
+    #   :cityCode
+    #
+    def self.response_attributes
+      %w[business cityCode]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder2/results/base.rb

@@ -0,0 +1,67 @@
+module Geocoder2
+  module Result
+    class Base
+
+      # data (hash) fetched from geocoding service
+      attr_accessor :data
+
+      # true if result came from cache, false if from request to geocoding
+      # service; nil if cache is not configured
+      attr_accessor :cache_hit
+
+      ##
+      # Takes a hash of data from a parsed geocoding service response.
+      #
+      def initialize(data)
+        @data = data
+        @cache_hit = nil
+      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 state
+        fail
+      end
+
+      def province
+        state
+      end
+
+      def state_code
+        fail
+      end
+
+      def province_code
+        state_code
+      end
+
+      def country
+        fail
+      end
+
+      def country_code
+        fail
+      end
+    end
+  end
+end

data/lib/geocoder2/results/bing.rb

@@ -0,0 +1,48 @@
+require 'geocoder2/results/base'
+
+module Geocoder2::Result
+  class Bing < Base
+
+    def address(format = :full)
+      @data['address']['formattedAddress']
+    end
+
+    def city
+      @data['address']['locality']
+    end
+
+    def state_code
+      @data['address']['adminDistrict']
+    end
+
+    alias_method :state, :state_code
+
+    def country
+      @data['address']['countryRegion']
+    end
+
+    alias_method :country_code, :country
+
+    def postal_code
+      @data['address']['postalCode']
+    end
+
+    def coordinates
+      @data['point']['coordinates']
+    end
+
+    def address_data
+      @data['address']
+    end
+
+    def self.response_attributes
+      %w[bbox name confidence entityType]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder2/results/dstk.rb

@@ -0,0 +1,6 @@
+require 'geocoder2/results/google'
+
+module Geocoder2::Result
+  class Dstk < Google
+  end
+end

data/lib/geocoder2/results/esri.rb

@@ -0,0 +1,51 @@
+require 'geocoder2/results/base'
+
+module Geocoder2::Result
+  class Esri < Base
+
+    def address
+      address = reverse_geocode? ? 'Address' : 'Match_addr'
+      attributes[address]
+    end
+
+    def city
+      attributes['City']
+    end
+
+    def state_code
+      attributes['Region']
+    end
+
+    alias_method :state, :state_code
+
+    def country
+      country = reverse_geocode? ? "CountryCode" : "Country"
+      attributes[country]
+    end
+
+    alias_method :country_code, :country
+
+    def postal_code
+      attributes['Postal']
+    end
+
+    def coordinates
+      [geometry["y"], geometry["x"]]
+    end
+
+    private
+
+    def attributes
+      reverse_geocode? ? @data['address'] : @data['locations'].first['feature']['attributes']
+    end
+
+    def geometry
+      reverse_geocode? ? @data["location"] : @data['locations'].first['feature']["geometry"]
+    end
+
+    def reverse_geocode?
+      @data['locations'].nil?
+    end
+
+  end
+end

data/lib/geocoder2/results/freegeoip.rb

@@ -0,0 +1,45 @@
+require 'geocoder2/results/base'
+
+module Geocoder2::Result
+  class Freegeoip < Base
+
+    def address(format = :full)
+      s = state_code.to_s == "" ? "" : ", #{state_code}"
+      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
+    end
+
+    def city
+      @data['city']
+    end
+
+    def state
+      @data['region_name']
+    end
+
+    def state_code
+      @data['region_code']
+    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[metrocode ip]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder2/results/geocoder_ca.rb

@@ -0,0 +1,60 @@
+require 'geocoder2/results/base'
+
+module Geocoder2::Result
+  class GeocoderCa < Base
+
+    def coordinates
+      [@data['latt'].to_f, @data['longt'].to_f]
+    end
+
+    def address(format = :full)
+      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
+    end
+
+    def street_address
+      "#{@data['stnumber']} #{@data['staddress']}"
+    end
+
+    def city
+      @data['city']
+    end
+
+    def state
+      @data['prov']
+    end
+
+    alias_method :state_code, :state
+
+    def postal_code
+      @data['postal']
+    end
+
+    def country
+      country_code == 'CA' ? 'Canada' : 'United States'
+    end
+
+    def country_code
+      return nil if state.nil? || state == ""
+      canadian_province_abbreviations.include?(state) ? "CA" : "US"
+    end
+
+    def self.response_attributes
+      %w[latt longt inlatt inlongt distance stnumber staddress prov
+        NearRoad NearRoadDistance betweenRoad1 betweenRoad2
+        intersection major_intersection]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+
+
+    private # ----------------------------------------------------------------
+
+    def canadian_province_abbreviations
+      %w[ON QC NS NB MB BC PE SK AB NL]
+    end
+  end
+end

data/lib/geocoder2/results/geocoder_us.rb

@@ -0,0 +1,39 @@
+require 'geocoder2/results/base'
+
+module Geocoder2::Result
+  class GeocoderUs < Base
+    def coordinates
+      [@data[0].to_f, @data[1].to_f]
+    end
+
+    def address(format = :full)
+      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
+    end
+
+    def street_address
+      @data[2]
+    end
+
+    def city
+      @data[3]
+    end
+
+    def state
+      @data[4]
+    end
+
+    alias_method :state_code, :state
+
+    def postal_code
+      @data[5]
+    end
+
+    def country
+      'United States'
+    end
+
+    def country_code
+      'US'
+    end
+  end
+end