geo_magic 0.1.1 → 0.2.0

data/{README.rdoc → README.textile}

@@ -1,4 +1,4 @@
-= Geo Magic
+h1. Geo Magic
 
 This little clever project was the result of me not being satisfied with existing Geo Location and Coding solutions out there to suit my needs.
 Many of the projects did not return quality data (fx when requesting IP or location) and others were tightly bound to Active Record and SQL databases for calculations etc.
@@ -10,17 +10,18 @@ This little gem should get you going...
 
 You can either include the complete library like this:
 
-require 'geo_magic'
+<pre>require 'geo_magic'</pre>
+
 
 Or require only the functionality you need (see usage examples below)
 
-== IP and location data
+h2. IP and location data
 
-Uses freegeoip.net JSON API
+Uses "freegeoip.net":http://freegeoip.net JSON API
 
 RSpec 2 examples of API usage  
 
-require 'geo_magic/remote'
+<pre>require 'geo_magic/remote'
 
 it "should get the remote IP address" do
   ip = GeoMagic::Remote.my_ip    
@@ -36,16 +37,15 @@ it "should get my location" do
   location = GeoMagic::Remote.my_location
   puts location
   puts "location: #{location['city']}"    
-end
-
+end  
+</pre>
 
-== Distance calculation
 
-Uses haversine formula
+h2. Distance calculation
 
 RSpec 2 examples of API usage 
 
-require 'geo_magic/calculate'
+<pre>require 'geo_magic/calculate'
 
 it "calculates distance using array args" do
   dist = GeoMagic::Calculate.distance [@long1, @lat1], [@long2, @lat2]    
@@ -55,9 +55,9 @@ end
 it "calculates distance using Point args" do
   from_point = GeoMagic::Point.new @long1, @lat1    
   to_point = GeoMagic::Point.new @long2, @lat2
-  
+
   puts "from: #{from_point}, to: #{to_point}"
-  
+
   dist = GeoMagic::Calculate.distance from_point, to_point
   puts dist    
 end
@@ -65,17 +65,25 @@ end
 it "calculates distance using Hash args (short)" do
   from_point = GeoMagic::Point.new(@long1, @lat1).to_hash :short
   to_point = GeoMagic::Point.new(@long2, @lat2).to_hash :short
-  
+
   puts "from: #{from_point}, to: #{to_point}"
-  
+
   dist = GeoMagic::Calculate.distance from_point, to_point
   puts dist    
-end
+end  
+</pre>
+
+h2. Extra features
 
-== Meta magic
+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_).
+I have also just created a Geocode adapter for _Geocode_ and _Graticule_ (see: _geocoder_spec.rb_) - This can also easily be configured for Rails.
+
+h2. Meta magic
 
 You can also include the functionality directly into any class like this
 
+<pre>
 class Map
   include GeoMagic::Calculate
 end
@@ -92,10 +100,10 @@ end
 it "calculates distance using array args" do
   dist = MapCalc.distance [@long1, @lat1], [@long2, @lat2]    
   puts dist    
-end
-
+end  
+</pre>
 
-== Contributing to geo_magic
+h2. Contributing to geo_magic
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -105,7 +113,7 @@ end
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+h2. Copyright
 
 Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/geo_magic.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo_magic}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2011-01-13}
+  s.date = %q{2011-01-21}
   s.description = %q{Get IP and location data using freegeoip.net - can also  calculate of distance between map points using haversine supporting multiple distance units}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.textile"
   ]
   s.files = [
     ".document",
@@ -22,13 +22,15 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "geo_magic.gemspec",
     "lib/geo_magic.rb",
     "lib/geo_magic/calculate.rb",
     "lib/geo_magic/distance.rb",
+    "lib/geo_magic/geocode/config.rb",
+    "lib/geo_magic/geocode/geocoder.rb",
     "lib/geo_magic/location.rb",
     "lib/geo_magic/map_point.rb",
     "lib/geo_magic/meta.rb",
@@ -36,7 +38,10 @@ Gem::Specification.new do |s|
     "lib/geo_magic/radius.rb",
     "lib/geo_magic/remote.rb",
     "lib/geo_magic/util.rb",
+    "lib/rails/config.rb",
+    "spec/fixtures/config.yaml",
     "spec/geo_magic/calculate_spec.rb",
+    "spec/geo_magic/geocoder_spec.rb",
     "spec/geo_magic/include_calc_spec.rb",
     "spec/geo_magic/include_remote_spec.rb",
     "spec/geo_magic/plane_dist_spec.rb",
@@ -51,6 +56,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Get your IP and location data and calculate distances on the globe}
   s.test_files = [
     "spec/geo_magic/calculate_spec.rb",
+    "spec/geo_magic/geocoder_spec.rb",
     "spec/geo_magic/include_calc_spec.rb",
     "spec/geo_magic/include_remote_spec.rb",
     "spec/geo_magic/plane_dist_spec.rb",

data/lib/geo_magic.rb

@@ -2,4 +2,5 @@ require 'geo-distance'
 require 'geo_magic/remote'
 require 'geo_magic/calculate'
 require 'geo_magic/distance'
-require 'geo_magic/meta'
+require 'geo_magic/meta'
+require 'geo_magic/geocode/geocoder'

data/lib/geo_magic/geocode/config.rb

@@ -0,0 +1,23 @@
+module GeoMap
+  module ServiceAdapter
+    attr_reader :geo_coder, :config
+
+    def geocode location_str
+      raise 'method #geocode must be implemented by adapter subclass'
+    end
+
+    def reverse_geocode latitude, longitude
+      raise 'method #reverse_geocode should be implemented by adapter subclass'
+    end          
+
+    def configure path, env = :development
+      @config ||= ::YAML.load_file(path)[env.to_s]
+    end
+
+    protected
+  
+    def google_key
+      config['google_key'] 
+    end    
+  end
+end

data/lib/geo_magic/geocode/geocoder.rb

@@ -0,0 +1,135 @@
+require 'geo_magic/geocode/config'
+require 'active_support/inflector'
+require 'geocode'
+require 'graticule'
+
+module GeoMap 
+  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      
+      def country
+        country_api["CountryNameCode"]
+      end
+
+      def country_name
+        country_api["CountryName"]
+      end
+    
+      def state
+        adm_api["AdministrativeAreaName"]
+      end
+    
+      def postal_code
+        subadm_api["Locality"]["PostalCode"]["PostalCodeNumber"]
+      end 
+      alias_method :zip, :postal_code
+    
+      def street
+        subadm_api["Thoroughfare"]["ThoroughfareName"]
+      end
+
+      def city
+        subadm_api["SubAdministrativeAreaName"]
+      end
+
+      def latitude
+        coords[0]
+      end
+
+      def longitude
+        coords[1]
+      end
+    
+      protected
+
+      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
+    end
+
+    def reverse_geocode latitude, longitude
+      geo_coder.reverse_geocode "#{latitude}, #{longitude}"
+    end      
+  end
+
+
+  class << self    
+    def geo_coder options = {:type => :geocode, :service_name => :google}
+      service_name = options[:service_name] || :google
+      type  = options[:type] || :geocode
+      env   = options[:env]
+      "GeoMap::#{type.to_s.classify}Adapter".constantize.new service_name, env
+    end 
+  
+    def geocode location_str
+      geo_coder.geocode location_str
+    end    
+  end
+end

data/lib/geo_magic/location.rb

@@ -5,13 +5,18 @@ module GeoMagic
     attr_accessor :ip
     attr_writer   :city, :region, :country
     
-    def initialize raw_location
+    def create_from_raw raw_location
       raw_location.each_pair do |key, value|
         @city_name = value and next if key == 'city'
         send :"#{key}=", value
       end
     end
 
+    # TODO
+    def initialize arg
+      create_from_raw arg
+    end
+
     def [] key
       send key
     end

data/lib/geo_magic/map_point.rb

@@ -8,9 +8,41 @@ module GeoMagic
       @latitude = latitude
       @longitude = longitude
     end  
+
+    def move_within distance
+      conversion = GeoDistance.radians_ratio(distance.unit)      
+
+      max_radius_rad = dist.distance
+      range = (max_radius_rad * normalize).to_i          
+
+      dlong = (get_random_radiant(range) / normalize)
+      dlat  = (get_random_radiant(range) / normalize)
+      
+      @latitude   += dlat
+      @longitude  += dlong
+    end
+
+    def move_distance radius
+      distance = radius.distance
+      conversion = GeoDistance.radians_ratio(distance.unit)      
+
+      max_radius_rad = distance.distance / conversion
+      range = (max_radius_rad * normalize).to_i     
+
+      dlong = (get_random_radiant(range) / normalize) * conversion
+      dlat  = (get_random_radiant(range) / normalize) * conversion
+      
+      GeoMagic::Point.new dist.latitude + dlat, dist.longitude + dlong      
+    end
     
     def within(distance) 
       GeoMagic::Radius.new self, distance
     end  
+    
+    protected
+    
+    def get_random_radiant(range)
+      GeoMagic::Radius.get_random_radiant(range)
+    end
   end
 end

data/lib/geo_magic/point.rb

@@ -16,7 +16,8 @@ module GeoMagic
       end
     end 
 
-    def to_location      
+    def to_location
+      raise "TODO: Use geocoder!"
     end
     
     def to_s   

data/lib/geo_magic/radius.rb

@@ -1,30 +1,53 @@
 module GeoMagic
   class Radius
     attr_accessor :center, :distance
-
-    RAD_PER_DEG = 0.017453293
-
-    # radius of the great circle in miles
-    # radius in kilometers...some algorithms use 6367
-    def rad
-      {:km => 6371, :miles => 3956, :feet => 20895592, :meters => 6371000}                     
-    end
     
     def initialize center, distance
       @center = center
       @distance = distance
     end  
-    
-    def create_points number
-      conversion = (RAD_PER_DEG * rad[distance.unit])      
 
-      max_radius_rad = distance.distance / conversion
+    # IN BAAAAD !!! need of refactoring and DRYing up!!!
+
+    PI = 3.14159265
+    PI_2 = PI * 2
+
+    def create_point_within mode = :square
+      raise ArgumentError, "mode must be :circle or :square" if ![:circle, :square].include? mode
+      send :"create_point_within_#{mode}"
+    end
+
+    def create_points_in_square number
+      conversion = GeoDistance.radians_ratio(distance.unit)
+
+      max_radius_rad = distance.distance
+      range = normalize max_radius_rad
+
+      number.times.inject([]) do |res, n|
+        dlong = denormalize get_random_radiant(range)
+        dlat  = denormalize get_random_radiant(range)
+
+        point = GeoMagic::Point.new @center.latitude + dlat, @center.longitude + dlong
+        res << point
+        res
+      end
+    end  
+
+    def create_points_in_circle number
+      conversion = GeoDistance.radians_ratio(distance.unit)
 
-      range = (max_radius_rad * normalize).to_i     
+      max_radius_rad = distance.distance
+      range = normalize max_radius_rad
+
+      max_radius_rad = distance.distance
+      range = normalize max_radius_rad
 
       number.times.inject([]) do |res, n|
-        dlong = (get_randowm_radiant(range) / normalize) * conversion
-        dlat  = (get_randowm_radiant(range) / normalize) * conversion
+        q = rand(range) * PI_2
+        r = Math.sqrt(rand(range))
+
+        dlong = denormalize (range * r) * Math.cos(q)
+        dlat  = denormalize (range * r) * Math.sin(q)
 
         point = GeoMagic::Point.new @center.latitude + dlat, @center.longitude + dlong
         res << point
@@ -32,12 +55,47 @@ module GeoMagic
       end
     end  
 
-    def get_randowm_radiant range
-      rand(range) - (range / 2)
+    def create_point_within_square 
+      conversion = GeoDistance.radians_ratio(distance.unit)      
+
+      max_radius_rad = dist.distance
+      range = (max_radius_rad * normalize).to_i          
+
+      dlong = (get_random_radiant(range) / normalize)
+      dlat  = (get_random_radiant(range) / normalize)
+      
+      GeoMagic::Point.new @center.latitude + dlat, @center.longitude + dlong
+    end
+        
+    def create_point_within_circle
+      max_radius_rad = dist.distance
+      range = normalize max_radius_rad
+
+      q = rand(range) * PI_2
+      r = Math.sqrt(rand(range))
+      dlong = denormalize (range * r) * Math.cos(q)
+      dlat = denormalize (range * r) * Math.sin(q)
+      
+      GeoMagic::Point.new @center.latitude + dlat, @center.longitude + dlong      
     end
+
+    def get_random_radiant range
+      self.class.get_random_radiant range
+    end
+
+    def self.get_random_radiant range
+      rand(range * 2) - range
+    end
+
+    NORMALIZER = 100.0
     
-    def normalize
-      1000000.0
+    def normalize n 
+      (n * NORMALIZER).to_i
+    end
+
+    def denormalize n
+      n / NORMALIZER
     end
+
   end
 end

data/lib/geo_magic/util.rb

@@ -20,8 +20,8 @@ module GeoMagic
 end
 
 class Array
-  def as_locations
-    self.extend GeoMagic::LocationsList
+  def as_map_points
+    self.extend GeoMagic::MapPoints
   end
   
   def sort_by_distance
@@ -30,7 +30,7 @@ class Array
 end
 
 module GeoMagic
-  module LocationsList          
+  module MapPoints          
     RAD_PER_DEG = 0.017453293    
     
     def rad

data/lib/rails/config.rb

@@ -0,0 +1,28 @@
+module GeoMap
+  module RailsServiceAdapter
+    attr_reader :geo_coder
+
+    def geocode location_str
+      raise 'method #geocode must be implemented by adapter subclass'
+    end
+
+    def reverse_geocode latitude, longitude
+      raise 'method #reverse_geocode should be implemented by adapter subclass'
+    end          
+
+    protected
+    
+    def env 
+      ENV['HEROKU_SITE'] || ::Rails.env.downcase || 'development'
+    end
+  
+    def config
+      @config ||= ::YAML.load_file("#{::Rails.root}/config/google_map.yml")[env]
+    end
+
+    def google_key
+      config['google_key'] 
+    end    
+  end  
+end
+

data/spec/fixtures/config.yaml

@@ -0,0 +1,2 @@
+development:
+  google_key: "ABQIAAAAUzkItq4p7LYo2YIR_gtjpRTJQa0g3IQ9GZqIMmInSLzwtGDKaBSzEc8_FNxIfQLkpKOh9R4JB87Rig" 

data/spec/geo_magic/geocoder_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'geo_magic'
+
+describe "GeoMagic Geocoder" do
+  before do
+    @geocoder = GeoMap.geo_coder
+    @geocoder.configure File.expand_path('../fixtures/config.yaml', File.dirname(__FILE__)), :development
+  end
+  
+  it "should geocode" do    
+    location = @geocoder.instance.geocode "Mullerstrasse 9, Munich"
+    location.city.should == 'Munich'
+  end
+
+
+  # it "should geocode for rails" do        
+  #   @geocoder = GeoMap.geo_coder :env => :rails    
+  #   location = @geocoder.instance.geocode "Mullerstrasse 9, Munich"
+  #   location.city.should == 'Munich'
+  # end
+end
+

data/spec/geo_magic/select_nearest_spec.rb

@@ -9,21 +9,21 @@ describe "GeoMagic closest" do
 
     @center_point = GeoMagic::Point.new @long1, @lat1    
     @radius = @center_point.within(10.km)
-    @points = @radius.create_points 10
+    @points = @radius.create_points_in_circle 10
   end
     
 
   it "should select the closest 3 points" do
     # puts "radius: #{@radius.inspect}"    
     # puts "points: #{@points.inspect}"        
-    closest = @points.as_locations.get_closest 3, :from => @center_point    
+    closest = @points.as_map_points.get_closest 3, :from => @center_point    
     puts "3 closest points: #{closest.inspect}"        
   end
   
   it "should select all points within 4 km" do
     # puts "radius: #{@radius.inspect}"    
     # puts "points: #{@points.inspect}"        
-    closest = @points.as_locations.get_within 4.km, :from => @center_point    
+    closest = @points.as_map_points.get_within 4.km, :from => @center_point    
     puts "points within 4 km: #{closest.inspect}"        
   end
   

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 +01:00
+date: 2011-01-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -143,20 +143,22 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.textile
 files: 
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - geo_magic.gemspec
 - lib/geo_magic.rb
 - lib/geo_magic/calculate.rb
 - lib/geo_magic/distance.rb
+- lib/geo_magic/geocode/config.rb
+- lib/geo_magic/geocode/geocoder.rb
 - lib/geo_magic/location.rb
 - lib/geo_magic/map_point.rb
 - lib/geo_magic/meta.rb
@@ -164,7 +166,10 @@ files:
 - lib/geo_magic/radius.rb
 - lib/geo_magic/remote.rb
 - lib/geo_magic/util.rb
+- lib/rails/config.rb
+- spec/fixtures/config.yaml
 - spec/geo_magic/calculate_spec.rb
+- spec/geo_magic/geocoder_spec.rb
 - spec/geo_magic/include_calc_spec.rb
 - spec/geo_magic/include_remote_spec.rb
 - spec/geo_magic/plane_dist_spec.rb
@@ -185,7 +190,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4556321129170548695
+      hash: -3345832224946490091
       segments: 
       - 0
       version: "0"
@@ -206,6 +211,7 @@ specification_version: 3
 summary: Get your IP and location data and calculate distances on the globe
 test_files: 
 - spec/geo_magic/calculate_spec.rb
+- spec/geo_magic/geocoder_spec.rb
 - spec/geo_magic/include_calc_spec.rb
 - spec/geo_magic/include_remote_spec.rb
 - spec/geo_magic/plane_dist_spec.rb