geo_magic 0.2.3.1 → 0.2.4

data/README.textile

@@ -5,8 +5,14 @@ Many of the projects did not return quality data (fx when requesting IP or locat
 
 This little gem should get you going...
 
-* Get IP and location data using freegeoip.net 
-* Calculate of distance between map points using haversine (supports multiple distance units)
+Some of the main features:
+
+* Get IP and location data using freegeoip.net
+* Calculate distance between map points using various algorithms (haversine, spherical, vincenty, straight line)
+* Geocoding and Reverse Geocoding using adapters (currently: Graticule and Geocode gems)
+* Calculate nearest points from a point
+* Find points within a radius (circle or square from center)
+* Calculate points within a bounding box
 
 You can either include the complete library like this:
 
@@ -73,19 +79,52 @@ it "calculates distance using Hash args (short)" do
 end  
 </pre>
 
-h2. Extra features
+h2. Geocoder adapters
+
+The following Geocode adapters are supported 
+
+* Geocode 
+* Graticule
+* GraticuleMulti
+
+Single Geocode Geocoder:
+
+<pre>
+  # Use Graticule Multi geocoder, which tries multiple geocode services in succession!
+  @geocoder = GeoMagic.geo_coder(:type => :geocode)
+  @geocoder.configure File.expand_path('../fixtures/map_api_keys.yaml', File.dirname(__FILE__)), :development
+  location = @geocoder.instance.geocode "Mullerstrasse 9, Munich"
+  location.city
+</pre>
+
+Single Graticule Geocoder:
 
-Lots of extra features has been added recently. For now, please check out the specs to get an idea of the features included.
-Most recently I have added support to filter a list of points for those who are within a radius of another point (see _select_neares_spec.rb_).
+<pre>
+  # Use Graticule Multi geocoder, which tries multiple geocode services in succession!
+  @geocoder = GeoMagic.geo_coder(:type => graticule)
+  @geocoder.configure File.expand_path('../fixtures/map_api_keys.yaml', File.dirname(__FILE__)), :development
+  location = @geocoder.instance.geocode "Mullerstrasse 9, Munich"
+  location.city
+</pre>
 
-h3. Geocoder adapters
+Multi Graticule Geocoder:
 
-I have also just created a Geocode adapter for _Geocode_ and _Graticule_ (see: _geocoder_spec.rb_) - This can also easily be configured for Rails.
+<pre>
+  # Use Graticule Multi geocoder, which tries multiple geocode services in succession!
+  @geocoder = GeoMagic.geo_coder(:type => graticule_multi)
+  ..
+</pre>
 
-I recently discovered that the Geocode adapter didn't work for all addresses, so I made some improvements to make it more "stable". 
-I'm sure there are still corner cases it wont handle, so please join in the effort to fix this!
+Multi Graticule Customization:
 
-Also note that the API has changed a little bit, so that it uses the same GeoMagic namespace as the rest of _geo_magic_.
+<pre>
+  # Use Graticule Multi geocoder, which tries multiple geocode services in succession!
+  @geocoder = GeoMagic.geo_coder(:type => graticule_multi)
+  location = @geocoder.instance(:timeout => 3) do |result|
+    [:address, :street].include?(result.precision)]
+  end
+  ..
+</pre>
 
 h3. Create random points in Radius
 

data/VERSION

@@ -1 +1 @@
-0.2.3.1
+0.2.4

data/geo_magic.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo_magic}
-  s.version = "0.2.3.1"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -30,7 +30,10 @@ Gem::Specification.new do |s|
     "lib/geo_magic/calculate.rb",
     "lib/geo_magic/distance.rb",
     "lib/geo_magic/geocode/config.rb",
+    "lib/geo_magic/geocode/geo_adapter.rb",
+    "lib/geo_magic/geocode/geocode_adapter.rb",
     "lib/geo_magic/geocode/geocoder.rb",
+    "lib/geo_magic/geocode/graticule_adapter.rb",
     "lib/geo_magic/location.rb",
     "lib/geo_magic/map_point.rb",
     "lib/geo_magic/meta.rb",

data/lib/geo_magic/geocode/config.rb

@@ -10,14 +10,22 @@ module GeoMagic
       raise 'method #reverse_geocode should be implemented by adapter subclass'
     end          
 
-    def configure path, env = :development
+    def configure path, env = :development 
       @config ||= ::YAML.load_file(path)[env.to_s]
     end
 
+    def self.services_available
+      [:google, :yahoo]
+    end
+
     protected
-  
-    def google_key
-      config['google_key'] 
-    end    
+
+    services_available.each do |api|
+      class_eval %{
+        def #{api}_key
+          config['#{api}_key'] 
+        end    
+      }
+    end
   end
 end

data/lib/geo_magic/geocode/geo_adapter.rb

@@ -0,0 +1,38 @@
+module GeoMagic 
+  class GeoAdapter
+    attr_accessor :service_name, :environment
+    
+    def initialize services = :google, env = :default
+      setup(env)
+      @service_name = get_service(services)
+      @environment = env
+    end
+
+    def get_service services
+      case services
+      when String, Symbol
+        services
+      when Array
+        services.first        
+      else
+        raise ArgumentError, "service argument is not valid: #{services.inspect}"
+      end
+    end
+
+    def get_key service_name
+      method = "#{service_name}_key"
+      raise ArgumentError, "Invalid map service: #{service_name}, must be one of #{GeoMagic::ServiceAdapter.services_available}" if !respond_to? method
+      send method 
+    end
+
+    def setup env
+      case env
+      when :rails
+        require 'rails/config'
+        self.class.send(:include, RailsServiceAdapter)
+      else
+        self.class.send(:include, ServiceAdapter)
+      end
+    end
+  end
+end

data/lib/geo_magic/geocode/geocode_adapter.rb

@@ -0,0 +1,124 @@
+require 'geocode'
+
+module GeoMagic 
+  class GeocodeAdapter < GeoAdapter
+    def initialize service_name = :google, env = :default
+      super      
+    end
+
+    def instance
+      @geo_coder ||= ::Geocode.new_geocoder service_name, {:google_api_key => google_key}      
+      self
+    end
+  
+    def geocode location_str
+      geo_coder.geocode(location_str).extend GeocodeAPI
+    end
+
+    module GeocodeAPI
+      # Address
+    
+      def street
+        thoroughfare["ThoroughfareName"] ? thoroughfare["ThoroughfareName"] : ""
+      end
+
+      def postal_code
+        locality["PostalCode"] ? locality["PostalCode"]["PostalCodeNumber"] : ""
+      end 
+      alias_method :zip, :postal_code
+  
+      def city
+        subadm_api["SubAdministrativeAreaName"] ? subadm_api["SubAdministrativeAreaName"] : ""
+      end
+
+      def state
+        adm_api["AdministrativeAreaName"] ? adm_api["AdministrativeAreaName"] : ""
+      end
+
+      def country_code
+        country_api["CountryNameCode"] ? country_api["CountryNameCode"] : ""
+      end
+
+      def country_name
+        country_api["CountryName"] ? country_api["CountryName"] : ""
+      end
+      alias_method :country, :country_name
+
+      def address_hash
+        {:street => street, :postal_code => postal_code, :city => city, :state => state, :country => country, :country_code => country_code}
+      end
+  
+      # Location
+  
+      def latitude
+        coords[1]
+      end
+
+      def longitude
+        coords[0]
+      end
+
+      def location_hash
+        {:longitude => longitude, :latitude => latitude}
+      end
+  
+      protected
+
+      def thoroughfare
+        @thoroughfare ||= begin
+          thorough = [:subadm_api, :locality_api, :dependent_locality_api].select do |api|
+            x = send(api)
+            x ? x["Thoroughfare"] : nil
+          end         
+          thorough.empty? ? {} : send(thorough.first)["Thoroughfare"]          
+        end
+      end
+
+      def locality
+        @locality ||= begin
+          loc = [:locality_api, :dependent_locality_api].select do |api|
+            x = send(api)
+            x ? x["PostalCode"] || x["LocalityName"] : nil
+          end
+          loc.empty? ? {} : send(loc.first)          
+        end
+      end
+
+      def api
+        data["Placemark"].first
+      end
+
+      def coords
+        api["Point"]["coordinates"]
+      end
+
+      def adr_api
+        api["AddressDetails"]
+      end 
+
+      def country_api
+        adr_api["Country"]
+      end
+  
+      def adm_api
+        country_api["AdministrativeArea"]        
+      end
+  
+      def subadm_api
+        adm_api["SubAdministrativeArea"]
+      end
+
+      def locality_api
+        subadm_api["Locality"]
+      end
+
+      def dependent_locality_api
+        locality_api["DependentLocality"]
+      end
+    end
+
+    def reverse_geocode latitude, longitude
+      geo_coder.reverse_geocode "#{latitude}, #{longitude}"
+    end      
+  end
+end

data/lib/geo_magic/geocode/geocoder.rb

@@ -1,172 +1,22 @@
 require 'geo_magic/geocode/config'
 require 'active_support/inflector'
-require 'geocode'
-require 'graticule'
-
-module GeoMagic 
-  class GeoAdapter
-    attr_accessor :service_name, :environment
-    
-    def initialize service_name = :google, env = :default
-      setup(env)
-      @service_name = service_name
-      @environment = env
-    end
-
-    def setup env
-      case env
-      when :rails
-        require 'rails/config'
-        self.class.send(:include, RailsServiceAdapter)
-      else
-        self.class.send(:include, ServiceAdapter)
-      end
-    end
-  end
-  
-  class GraticuleAdapter < GeoAdapter
-    def initialize service_name = :google, env = :default
-      super      
-    end
-
-    def instance
-      @geo_coder ||= ::Graticule.service(service_name).new google_key
-      self
-    end
-    
-    def geocode location_str
-      geo_coder.locate location_str
-    end    
-  end
-
-  class GeocodeAdapter < GeoAdapter
-    def initialize service_name = :google, env = :default
-      super      
-    end
-
-    def instance
-      @geo_coder ||= ::Geocode.new_geocoder service_name, {:google_api_key => google_key}      
-      self
-    end
-    
-    def geocode location_str
-      geo_coder.geocode(location_str).extend GeocodeAPI
-    end
-
-    module GeocodeAPI
-      # Address
-      
-      def street
-        thoroughfare["ThoroughfareName"] ? thoroughfare["ThoroughfareName"] : ""
-      end
-
-      def postal_code
-        locality["PostalCode"] ? locality["PostalCode"]["PostalCodeNumber"] : ""
-      end 
-      alias_method :zip, :postal_code
-    
-      def city
-        subadm_api["SubAdministrativeAreaName"] ? subadm_api["SubAdministrativeAreaName"] : ""
-      end
-
-      def state
-        adm_api["AdministrativeAreaName"] ? adm_api["AdministrativeAreaName"] : ""
-      end
-
-      def country_code
-        country_api["CountryNameCode"] ? country_api["CountryNameCode"] : ""
-      end
-
-      def country_name
-        country_api["CountryName"] ? country_api["CountryName"] : ""
-      end
-      alias_method :country, :country_name
-
-      def address_hash
-        {:street => street, :postal_code => postal_code, :city => city, :state => state, :country => country, :country_code => country_code}
-      end
-    
-      # Location
-    
-      def latitude
-        coords[1]
-      end
-
-      def longitude
-        coords[0]
-      end
-
-      def location_hash
-        {:longitude => longitude, :latitude => latitude}
-      end
-    
-      protected
-
-      def thoroughfare
-        @thoroughfare ||= begin
-          thorough = [:subadm_api, :locality_api, :dependent_locality_api].select do |api|
-            x = send(api)
-            x ? x["Thoroughfare"] : nil
-          end         
-          thorough.empty? ? {} : send(thorough.first)["Thoroughfare"]          
-        end
-      end
-
-      def locality
-        @locality ||= begin
-          loc = [:locality_api, :dependent_locality_api].select do |api|
-            x = send(api)
-            x ? x["PostalCode"] || x["LocalityName"] : nil
-          end
-          loc.empty? ? {} : send(loc.first)          
-        end
-      end
-
-      def api
-        data["Placemark"].first
-      end
-
-      def coords
-        api["Point"]["coordinates"]
-      end
-
-      def adr_api
-        api["AddressDetails"]
-      end 
-
-      def country_api
-        adr_api["Country"]
-      end
-    
-      def adm_api
-        country_api["AdministrativeArea"]        
-      end
-    
-      def subadm_api
-        adm_api["SubAdministrativeArea"]
-      end
-
-      def locality_api
-        subadm_api["Locality"]
-      end
-
-      def dependent_locality_api
-        locality_api["DependentLocality"]
-      end
-    end
-
-    def reverse_geocode latitude, longitude
-      geo_coder.reverse_geocode "#{latitude}, #{longitude}"
-    end      
-  end
 
+require 'geo_magic/geocode/geo_adapter'
+require 'geo_magic/geocode/graticule_adapter'
+require 'geo_magic/geocode/geocode_adapter'
 
+module GeoMagic 
   class << self    
-    def geo_coder options = {:type => :geocode, :service_name => :google}
+    def geo_coder options = {:type => :geocode, :service => :google}
       service_name = options[:service_name] || :google
       type  = options[:type] || :geocode
       env   = options[:env]
-      "GeoMagic::#{type.to_s.classify}Adapter".constantize.new service_name, env
+
+      services = options[:services] || options[:service] || :google
+      
+      clazz = "GeoMagic::#{type.to_s.classify}Adapter".constantize
+      
+      clazz.new services, env
     end 
   
     def geocode location_str

data/lib/geo_magic/geocode/graticule_adapter.rb

@@ -0,0 +1,79 @@
+require 'graticule'
+
+module GeoMagic
+  class GraticuleAdapter < GeoAdapter
+    def initialize services = :google, env = :default
+      super      
+    end
+
+    def instance
+      @geo_coder ||= create_graticule_service
+      self
+    end
+
+    def create_graticule_service key_name = nil
+      api_key = get_key(key_name || service_name)
+      gs_service.new api_key
+    end
+  
+    def geocode location_str
+      geo_coder.locate location_str
+    end 
+    
+    def gs_service
+      ::Graticule.service(service_name)
+    end   
+  end
+
+  # The Multi geocoder will try the geocoders in order if a Graticule::AddressError
+  # is raised.  You can customize this behavior by passing in a block to the Multi
+  # geocoder.  For example, to try the geocoders until one returns a result with a
+  # high enough precision:
+  #
+  #   geocoder = Graticule.service(:multi).new(geocoders) do |result|
+  #     [:address, :street].include?(result.precision)
+  #   end
+  #
+  # Geocoders will be tried in order until the block returned true for one of the results
+  #
+  # Use the :timeout option to specify the number of seconds to allow for each
+  # geocoder before raising a Timout::Error (defaults to 10 seconds).
+  #
+  #   Graticule.service(:multi).new(geocoders, :timeout => 3)
+
+  class GraticuleMultiAdapter < GraticuleAdapter
+    attr_accessor :map_services, :geo_coder    
+  
+    def initialize services, env = :default
+      super(:multi, env)
+      @map_services = [services].compact.uniq.flatten
+    end
+
+    def instance options = {}, &block      
+      @geo_coder ||= begin      
+        if block
+          gs_service.new multi_services, options do |result|
+            yield
+          end
+        else
+          gs_service.new multi_services, options do |result|
+            true
+          end          
+        end          
+      end
+      self
+    end
+
+    def geocode location_str
+      geo_coder.locate location_str
+    end    
+
+    def multi_services
+      map_services.map do |service_name|
+        api_key = send :"#{service_name}_key"
+        raise ArgumentError, "API key for service #{service_name} has not been set. Please insert key in your api keys configuration file" if api_key.blank? 
+        Graticule.service(service_name.to_sym).new(api_key)
+      end      
+    end
+  end
+end

data/spec/geo_magic/geocoder_spec.rb

@@ -24,6 +24,23 @@ describe "GeoMagic Geocoder" do
     p location.address_hash
   end        
 
+  it "Graticule adapter" do
+    @geocoder = GeoMagic.geo_coder :type => :graticule, :services => :google
+    @geocoder.configure File.expand_path('../fixtures/map_api_keys.yaml', File.dirname(__FILE__)), :development
+    location = @geocoder.instance.geocode "Pilotystrasse 11, munich, Germany"
+    p location
+    p location.city
+  end        
+
+  it "Graticule Multi adapter" do
+    @geocoder = GeoMagic.geo_coder :type => :graticule_multi, :services => :google
+    @geocoder.configure File.expand_path('../fixtures/map_api_keys.yaml', File.dirname(__FILE__)), :development
+    location = @geocoder.instance.geocode "Pilotystrasse 11, munich, Germany"
+    p location
+    p location.city
+  end        
+
+
   # Geocoder with Rails 3
 
   # Expects map api keys (fx for google maps) to be defined in ROOT/config/map_api_keys.yml

metadata

@@ -5,9 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 3
-  - 1
-  version: 0.2.3.1
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -159,7 +158,10 @@ files:
 - lib/geo_magic/calculate.rb
 - lib/geo_magic/distance.rb
 - lib/geo_magic/geocode/config.rb
+- lib/geo_magic/geocode/geo_adapter.rb
+- lib/geo_magic/geocode/geocode_adapter.rb
 - lib/geo_magic/geocode/geocoder.rb
+- lib/geo_magic/geocode/graticule_adapter.rb
 - lib/geo_magic/location.rb
 - lib/geo_magic/map_point.rb
 - lib/geo_magic/meta.rb
@@ -193,7 +195,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3152749513202391524
+      hash: 1749247139327050469
       segments: 
       - 0
       version: "0"