geokit 1.8.3 → 1.8.4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.8.4
+
+* Fix math error in ruby 1.8
+* Extract HTTP processing to allow different HTTP clients for caching, etc.
+
 ## 1.8.3
 
 * Fix MultiGeocoder with geocoders that only have one argument

data/geokit.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock' # used in vcr
+  spec.add_development_dependency 'typhoeus' # used in net_adapter
 end

data/lib/geokit/geocoders.rb

@@ -1,4 +1,6 @@
 require 'net/http'
+require 'geokit/net_adapter/net_http'
+require 'geokit/net_adapter/typhoeus'
 require 'ipaddr'
 require 'rexml/document'
 require 'yaml'
@@ -37,6 +39,7 @@ module Geokit
     @@logger=Logger.new(STDOUT)
     @@logger.level=Logger::INFO
     @@domain = nil
+    @@net_adapter = Geokit::NetAdapter::NetHttp
 
     def self.__define_accessors
       class_variables.each do |v|
@@ -141,15 +144,11 @@ module Geokit
 
       # Wraps the geocoder call around a proxy if necessary.
       def self.do_get(url)
-        uri = URI.parse(url)
-        req = Net::HTTP::Get.new(url)
-        req.basic_auth(uri.user, uri.password) if uri.userinfo
-        net_http_args = [uri.host, uri.port]
-        if (proxy_uri_string = Geokit::Geocoders::proxy)
-          proxy_uri = URI.parse(proxy_uri_string)
-          net_http_args += [proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password]
-        end
-        Net::HTTP::new(*net_http_args).start { |http| http.request(req) }
+        net_adapter.do_get(url)
+      end
+
+      def self.net_adapter
+        Geokit::Geocoders::net_adapter
       end
 
       def self.provider_name
@@ -174,7 +173,7 @@ module Geokit
 
       def self.process(format, url, *args)
         res = call_geocoder_service(url)
-        return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
+        return GeoLoc.new unless net_adapter.success?(res)
         parse format, res.body, *args
       end
 

data/lib/geokit/geocoders/bing.rb

@@ -11,7 +11,7 @@ module Geokit
       def self.do_geocode(address)
         url = submit_url(address)
         res = call_geocoder_service(url)
-        return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
+        return GeoLoc.new unless net_adapter.success?(res)
         xml = transcode_to_utf8(res.body)
         parse :xml, xml
       end

data/lib/geokit/geocoders/google.rb

@@ -140,36 +140,41 @@ module Geokit
         loc.lat = ll['lat'].to_f
         loc.lng = ll['lng'].to_f
 
+        set_bounds(loc, addr)
+
+        loc
+      end
+
+      def self.set_bounds(loc, addr)
         viewport = addr['geometry']['viewport']
         ne = Geokit::LatLng.from_json(viewport['northeast'])
         sw = Geokit::LatLng.from_json(viewport['southwest'])
         loc.suggested_bounds = Geokit::Bounds.new(sw, ne)
-
-        loc
       end
 
       def self.set_address_components(loc, addr)
         addr['address_components'].each do |comp|
+          types = comp['types']
           case
-          when comp['types'].include?("subpremise")
+          when types.include?("subpremise")
             loc.sub_premise = comp['short_name']
-          when comp['types'].include?("street_number")
+          when types.include?("street_number")
             loc.street_number = comp['short_name']
-          when comp['types'].include?("route")
+          when types.include?("route")
             loc.street_name = comp['long_name']
-          when comp['types'].include?("locality")
+          when types.include?("locality")
             loc.city = comp['long_name']
-          when comp['types'].include?("administrative_area_level_1")
+          when types.include?("administrative_area_level_1")
             loc.state = comp['short_name']
             loc.province = comp['short_name']
-          when comp['types'].include?("postal_code")
+          when types.include?("postal_code")
             loc.zip = comp['long_name']
-          when comp['types'].include?("country")
+          when types.include?("country")
             loc.country_code = comp['short_name']
             loc.country = comp['long_name']
-          when comp['types'].include?("administrative_area_level_2")
+          when types.include?("administrative_area_level_2")
             loc.district = comp['long_name']
-          when comp['types'].include?('neighborhood')
+          when types.include?('neighborhood')
             loc.neighborhood = comp['short_name']
           end
         end

data/lib/geokit/geocoders/ip.rb

@@ -13,7 +13,7 @@ module Geokit
         return GeoLoc.new unless valid_ip?(ip)
         url = submit_url(ip)
         res = call_geocoder_service(url)
-        return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
+        return GeoLoc.new unless net_adapter.success?(res)
         ensure_utf8_encoding(res)
         body = res.body
         body = body.encode('UTF-8') if body.respond_to? :encode

data/lib/geokit/mappable.rb

@@ -60,12 +60,10 @@ module Geokit
         Math.sqrt(lat_length ** 2 + lng_length ** 2)
       end
 
+      # Ruby 1.9 raises {Math::DomainError}, but it is not defined in Ruby 1.8
       def math_error_classes
-        error_classes = [Errno::EDOM]
-
-        # Ruby 1.9 raises {Math::DomainError}, but it is not defined in Ruby
-        # 1.8. Backwards-compatibly rescue both errors.
-        error_classes << Math::DomainError if defined?(Math::DomainError)
+        return [Errno::EDOM, Math::DomainError] if defined?(Math::DomainError)
+        [Errno::EDOM]
       end
 
       # Returns heading in degrees (0 is north, 90 is east, 180 is south, etc)

data/lib/geokit/net_adapter/net_http.rb

@@ -0,0 +1,21 @@
+module Geokit
+  module NetAdapter
+    class NetHttp
+      def self.do_get(url)
+        uri = URI.parse(url)
+        req = Net::HTTP::Get.new(url)
+        req.basic_auth(uri.user, uri.password) if uri.userinfo
+        net_http_args = [uri.host, uri.port]
+        if (proxy_uri_string = Geokit::Geocoders::proxy)
+          proxy_uri = URI.parse(proxy_uri_string)
+          net_http_args += [proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password]
+        end
+        Net::HTTP::new(*net_http_args).start { |http| http.request(req) }
+      end
+
+      def self.success?(response)
+        response.is_a?(Net::HTTPSuccess)
+      end
+    end
+  end
+end

data/lib/geokit/net_adapter/typhoeus.rb

@@ -0,0 +1,13 @@
+module Geokit
+  module NetAdapter
+    class Typhoeus
+      def self.do_get(url)
+        ::Typhoeus.get(url.to_s)
+      end
+
+      def self.success?(response)
+        response.success?
+      end
+    end
+  end
+end

data/lib/geokit/polygon.rb

@@ -2,42 +2,36 @@ module Geokit
   # A complex polygon made of multiple points.  End point must equal start point to close the poly.
   class Polygon
     
-    attr_accessor :poly_y, :poly_x
+    attr_accessor :points
     
+    # Pass in an array of Geokit::LatLng
     def initialize(points)
-      # Pass in an array of Geokit::LatLng
-      @poly_x = []
-      @poly_y = []
-
-      points.each do |point|
-        @poly_x << point.lng
-        @poly_y << point.lat
-      end
+      @points = points
       
       # A Polygon must be 'closed', the last point equal to the first point
-      if @poly_x[0] != @poly_x[-1] || @poly_y[0] != @poly_y[-1]
-        # Append the first point to the array to close the polygon
-        @poly_x << @poly_x[0]
-        @poly_y << @poly_y[0]
-      end
-      
+      # Append the first point to the array to close the polygon
+      @points << points[0] if points[0] != points[-1]
     end
 
     def contains?(point)
-      j = @poly_x.length - 1
+      last_point = @points[-1]
       oddNodes = false
       x = point.lng
       y = point.lat
 
-      for i in (0..j)
-        if (@poly_y[i] < y && @poly_y[j] >= y ||
-            @poly_y[j] < y && @poly_y[i] >= y)
-          if (@poly_x[i] + (y - @poly_y[i]) / (@poly_y[j] - @poly_y[i]) * (@poly_x[j] - @poly_x[i]) < x)
+      for p in @points
+        yi = p.lat
+        xi = p.lng
+        yj = last_point.lat
+        xj = last_point.lng
+        if (yi < y && yj >= y ||
+            yj < y && yi >= y)
+          if (xi + (y - yi) / (yj - yi) * (xj - xi) < x)
             oddNodes = !oddNodes
           end
         end
  
-        j=i
+        last_point = p
       end
 
       oddNodes

data/lib/geokit/version.rb

@@ -1,3 +1,3 @@
 module Geokit
-  VERSION = '1.8.3'
+  VERSION = '1.8.4'
 end

data/test/helper.rb

@@ -11,7 +11,7 @@ end
 require 'geoip'
 
 if ENV['COVERAGE']
-  COVERAGE_THRESHOLD = 90
+  COVERAGE_THRESHOLD = 91
   require 'simplecov'
   require 'simplecov-rcov'
   require 'coveralls'
@@ -42,6 +42,10 @@ class MockSuccess < Net::HTTPSuccess #:nodoc: all
   def initialize
     @header = {}
   end
+
+  def success? # Typhoeus
+    true
+  end
 end
 
 class MockFailure < Net::HTTPServiceUnavailable #:nodoc: all

data/test/test_mappable.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class MappableTest < Test::Unit::TestCase #:nodoc: all
+
+  def test_math_error_classes
+    error_case = 0.49 * 180
+    from = Geokit::LatLng.new(error_case, error_case)
+    to   = Geokit::LatLng.new(error_case, error_case)
+    assert_equal 0.0, Geokit::LatLng.distance_between_sphere(from, to, :kms)
+  end
+
+end

data/test/test_net_adapter.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+# Base class for testing geocoders.
+class NetAdapterTest < Test::Unit::TestCase #:nodoc: all
+  class Geokit::Geocoders::CachedGeocoder < Geokit::Geocoders::Geocoder
+    def self.parse_json(hash)
+      hash
+    end
+  end
+
+  class SuperSimpleCache
+    def initialize
+      @cache = {}
+    end
+
+    def write(key, value)
+      @cache[key] = value
+    end
+
+    def fetch(key)
+      @cache[key]
+    end
+  end
+
+  RESULT = '{"name":"json"}'
+  RESULT_HASH = {"name" => "json"}
+
+  # Defines common test fixtures.
+  def setup
+    @url = 'http://www.cacheme.com'
+    @address = 'San Francisco, CA'
+  end
+
+  def test_cache
+    old_adapter = Geokit::Geocoders::net_adapter
+    Geokit::Geocoders::net_adapter = Geokit::NetAdapter::Typhoeus
+    Typhoeus::Config.cache = SuperSimpleCache
+    success = MockSuccess.new
+    success.expects(:body).returns(RESULT)
+    url = 'http://www.cacheme.com'
+    Geokit::NetAdapter::Typhoeus.expects(:do_get).with(@url).returns(success)
+    assert_equal RESULT_HASH, Geokit::Geocoders::CachedGeocoder.process(:json, @url)
+    Typhoeus::Config.cache = nil
+    Geokit::Geocoders::net_adapter = old_adapter
+  end
+end

data/test/test_polygon_contains.rb

@@ -93,8 +93,8 @@ class PolygonTest < Test::Unit::TestCase #:nodoc: all
     #puts "\t Does poly_x[0] (#{@open_polygon.poly_x[0]}) == poly_x[-1] (#{@open_polygon.poly_x[-1]}) ?"
     #puts "\t Does poly_y[0] (#{@open_polygon.poly_y[0]}) == poly_y[-1] (#{@open_polygon.poly_y[-1]}) ?"
 
-    assert @open_polygon.poly_x[0] == @open_polygon.poly_x[-1]
-    assert @open_polygon.poly_y[0] == @open_polygon.poly_y[-1]
+    assert @open_polygon.points[0].lng == @open_polygon.points[-1].lng
+    assert @open_polygon.points[0].lat == @open_polygon.points[-1].lat
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geokit
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -158,6 +158,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Geokit provides geocoding and distance calculation in an easy-to-use
   API
 email:
@@ -220,6 +236,8 @@ files:
 - lib/geokit/lat_lng.rb
 - lib/geokit/mappable.rb
 - lib/geokit/multi_geocoder.rb
+- lib/geokit/net_adapter/net_http.rb
+- lib/geokit/net_adapter/typhoeus.rb
 - lib/geokit/polygon.rb
 - lib/geokit/version.rb
 - test/helper.rb
@@ -236,9 +254,11 @@ files:
 - test/test_inflector.rb
 - test/test_ipgeocoder.rb
 - test/test_latlng.rb
+- test/test_mappable.rb
 - test/test_maxmind_geocoder.rb
 - test/test_multi_geocoder.rb
 - test/test_multi_ip_geocoder.rb
+- test/test_net_adapter.rb
 - test/test_openstreetmap_geocoder.rb
 - test/test_polygon_contains.rb
 - test/test_ripe_geocoder.rb
@@ -262,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1638925415436466829
+      hash: -1117828600571501675
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -271,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1638925415436466829
+      hash: -1117828600571501675
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -293,9 +313,11 @@ test_files:
 - test/test_inflector.rb
 - test/test_ipgeocoder.rb
 - test/test_latlng.rb
+- test/test_mappable.rb
 - test/test_maxmind_geocoder.rb
 - test/test_multi_geocoder.rb
 - test/test_multi_ip_geocoder.rb
+- test/test_net_adapter.rb
 - test/test_openstreetmap_geocoder.rb
 - test/test_polygon_contains.rb
 - test/test_ripe_geocoder.rb